blob: 29d7feb62cf7a5784a3828d9e6b19db4c30ceb01 [file] [log] [blame]
David Howells955d00912009-04-03 16:42:38 +01001/* netfs cookie management
2 *
3 * Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
4 * Written by David Howells (dhowells@redhat.com)
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version
9 * 2 of the License, or (at your option) any later version.
David Howellsccc4fc32009-04-03 16:42:38 +010010 *
11 * See Documentation/filesystems/caching/netfs-api.txt for more information on
12 * the netfs API.
David Howells955d00912009-04-03 16:42:38 +010013 */
14
15#define FSCACHE_DEBUG_LEVEL COOKIE
16#include <linux/module.h>
17#include <linux/slab.h>
18#include "internal.h"
19
20struct kmem_cache *fscache_cookie_jar;
21
David Howellsccc4fc32009-04-03 16:42:38 +010022static atomic_t fscache_object_debug_id = ATOMIC_INIT(0);
23
24static int fscache_acquire_non_index_cookie(struct fscache_cookie *cookie);
25static int fscache_alloc_object(struct fscache_cache *cache,
26 struct fscache_cookie *cookie);
27static int fscache_attach_object(struct fscache_cookie *cookie,
28 struct fscache_object *object);
29
David Howells955d00912009-04-03 16:42:38 +010030/*
31 * initialise an cookie jar slab element prior to any use
32 */
33void fscache_cookie_init_once(void *_cookie)
34{
35 struct fscache_cookie *cookie = _cookie;
36
37 memset(cookie, 0, sizeof(*cookie));
38 spin_lock_init(&cookie->lock);
David Howells1bccf512009-11-19 18:11:25 +000039 spin_lock_init(&cookie->stores_lock);
David Howells955d00912009-04-03 16:42:38 +010040 INIT_HLIST_HEAD(&cookie->backing_objects);
41}
42
43/*
David Howellsccc4fc32009-04-03 16:42:38 +010044 * request a cookie to represent an object (index, datafile, xattr, etc)
45 * - parent specifies the parent object
46 * - the top level index cookie for each netfs is stored in the fscache_netfs
47 * struct upon registration
48 * - def points to the definition
49 * - the netfs_data will be passed to the functions pointed to in *def
50 * - all attached caches will be searched to see if they contain this object
51 * - index objects aren't stored on disk until there's a dependent file that
52 * needs storing
53 * - other objects are stored in a selected cache immediately, and all the
54 * indices forming the path to it are instantiated if necessary
55 * - we never let on to the netfs about errors
56 * - we may set a negative cookie pointer, but that's okay
57 */
58struct fscache_cookie *__fscache_acquire_cookie(
59 struct fscache_cookie *parent,
60 const struct fscache_cookie_def *def,
David Howells94d30ae2013-09-21 00:09:31 +010061 void *netfs_data,
62 bool enable)
David Howellsccc4fc32009-04-03 16:42:38 +010063{
64 struct fscache_cookie *cookie;
65
66 BUG_ON(!def);
67
David Howells94d30ae2013-09-21 00:09:31 +010068 _enter("{%s},{%s},%p,%u",
David Howellsccc4fc32009-04-03 16:42:38 +010069 parent ? (char *) parent->def->name : "<no-parent>",
David Howells94d30ae2013-09-21 00:09:31 +010070 def->name, netfs_data, enable);
David Howellsccc4fc32009-04-03 16:42:38 +010071
72 fscache_stat(&fscache_n_acquires);
73
74 /* if there's no parent cookie, then we don't create one here either */
75 if (!parent) {
76 fscache_stat(&fscache_n_acquires_null);
77 _leave(" [no parent]");
78 return NULL;
79 }
80
81 /* validate the definition */
82 BUG_ON(!def->get_key);
83 BUG_ON(!def->name[0]);
84
85 BUG_ON(def->type == FSCACHE_COOKIE_TYPE_INDEX &&
86 parent->def->type != FSCACHE_COOKIE_TYPE_INDEX);
87
88 /* allocate and initialise a cookie */
89 cookie = kmem_cache_alloc(fscache_cookie_jar, GFP_KERNEL);
90 if (!cookie) {
91 fscache_stat(&fscache_n_acquires_oom);
92 _leave(" [ENOMEM]");
93 return NULL;
94 }
95
96 atomic_set(&cookie->usage, 1);
97 atomic_set(&cookie->n_children, 0);
98
David Howells13627292013-05-10 19:50:26 +010099 /* We keep the active count elevated until relinquishment to prevent an
100 * attempt to wake up every time the object operations queue quiesces.
101 */
102 atomic_set(&cookie->n_active, 1);
103
David Howellsccc4fc32009-04-03 16:42:38 +0100104 atomic_inc(&parent->usage);
105 atomic_inc(&parent->n_children);
106
107 cookie->def = def;
108 cookie->parent = parent;
109 cookie->netfs_data = netfs_data;
David Howells94d30ae2013-09-21 00:09:31 +0100110 cookie->flags = (1 << FSCACHE_COOKIE_NO_DATA_YET);
David Howellsccc4fc32009-04-03 16:42:38 +0100111
David Howellsb34df792009-11-19 18:11:14 +0000112 /* radix tree insertion won't use the preallocation pool unless it's
113 * told it may not wait */
114 INIT_RADIX_TREE(&cookie->stores, GFP_NOFS & ~__GFP_WAIT);
David Howellsccc4fc32009-04-03 16:42:38 +0100115
116 switch (cookie->def->type) {
117 case FSCACHE_COOKIE_TYPE_INDEX:
118 fscache_stat(&fscache_n_cookie_index);
119 break;
120 case FSCACHE_COOKIE_TYPE_DATAFILE:
121 fscache_stat(&fscache_n_cookie_data);
122 break;
123 default:
124 fscache_stat(&fscache_n_cookie_special);
125 break;
126 }
127
David Howells94d30ae2013-09-21 00:09:31 +0100128 if (enable) {
129 /* if the object is an index then we need do nothing more here
130 * - we create indices on disk when we need them as an index
131 * may exist in multiple caches */
132 if (cookie->def->type != FSCACHE_COOKIE_TYPE_INDEX) {
133 if (fscache_acquire_non_index_cookie(cookie) == 0) {
134 set_bit(FSCACHE_COOKIE_ENABLED, &cookie->flags);
135 } else {
136 atomic_dec(&parent->n_children);
137 __fscache_cookie_put(cookie);
138 fscache_stat(&fscache_n_acquires_nobufs);
139 _leave(" = NULL");
140 return NULL;
141 }
142 } else {
143 set_bit(FSCACHE_COOKIE_ENABLED, &cookie->flags);
David Howellsccc4fc32009-04-03 16:42:38 +0100144 }
145 }
146
147 fscache_stat(&fscache_n_acquires_ok);
148 _leave(" = %p", cookie);
149 return cookie;
150}
151EXPORT_SYMBOL(__fscache_acquire_cookie);
152
153/*
David Howells94d30ae2013-09-21 00:09:31 +0100154 * Enable a cookie to permit it to accept new operations.
155 */
156void __fscache_enable_cookie(struct fscache_cookie *cookie,
157 bool (*can_enable)(void *data),
158 void *data)
159{
160 _enter("%p", cookie);
161
162 wait_on_bit_lock(&cookie->flags, FSCACHE_COOKIE_ENABLEMENT_LOCK,
163 fscache_wait_bit, TASK_UNINTERRUPTIBLE);
164
165 if (test_bit(FSCACHE_COOKIE_ENABLED, &cookie->flags))
166 goto out_unlock;
167
168 if (can_enable && !can_enable(data)) {
169 /* The netfs decided it didn't want to enable after all */
170 } else if (cookie->def->type != FSCACHE_COOKIE_TYPE_INDEX) {
171 /* Wait for outstanding disablement to complete */
172 __fscache_wait_on_invalidate(cookie);
173
174 if (fscache_acquire_non_index_cookie(cookie) == 0)
175 set_bit(FSCACHE_COOKIE_ENABLED, &cookie->flags);
176 } else {
177 set_bit(FSCACHE_COOKIE_ENABLED, &cookie->flags);
178 }
179
180out_unlock:
181 clear_bit_unlock(FSCACHE_COOKIE_ENABLEMENT_LOCK, &cookie->flags);
182 wake_up_bit(&cookie->flags, FSCACHE_COOKIE_ENABLEMENT_LOCK);
183}
184EXPORT_SYMBOL(__fscache_enable_cookie);
185
186/*
David Howellsccc4fc32009-04-03 16:42:38 +0100187 * acquire a non-index cookie
188 * - this must make sure the index chain is instantiated and instantiate the
189 * object representation too
190 */
191static int fscache_acquire_non_index_cookie(struct fscache_cookie *cookie)
192{
193 struct fscache_object *object;
194 struct fscache_cache *cache;
195 uint64_t i_size;
196 int ret;
197
198 _enter("");
199
David Howells94d30ae2013-09-21 00:09:31 +0100200 set_bit(FSCACHE_COOKIE_UNAVAILABLE, &cookie->flags);
David Howellsccc4fc32009-04-03 16:42:38 +0100201
202 /* now we need to see whether the backing objects for this cookie yet
203 * exist, if not there'll be nothing to search */
204 down_read(&fscache_addremove_sem);
205
206 if (list_empty(&fscache_cache_list)) {
207 up_read(&fscache_addremove_sem);
208 _leave(" = 0 [no caches]");
209 return 0;
210 }
211
212 /* select a cache in which to store the object */
213 cache = fscache_select_cache_for_object(cookie->parent);
214 if (!cache) {
215 up_read(&fscache_addremove_sem);
216 fscache_stat(&fscache_n_acquires_no_cache);
217 _leave(" = -ENOMEDIUM [no cache]");
218 return -ENOMEDIUM;
219 }
220
221 _debug("cache %s", cache->tag->name);
222
David Howells94d30ae2013-09-21 00:09:31 +0100223 set_bit(FSCACHE_COOKIE_LOOKING_UP, &cookie->flags);
David Howellsccc4fc32009-04-03 16:42:38 +0100224
225 /* ask the cache to allocate objects for this cookie and its parent
226 * chain */
227 ret = fscache_alloc_object(cache, cookie);
228 if (ret < 0) {
229 up_read(&fscache_addremove_sem);
230 _leave(" = %d", ret);
231 return ret;
232 }
233
234 /* pass on how big the object we're caching is supposed to be */
235 cookie->def->get_attr(cookie->netfs_data, &i_size);
236
237 spin_lock(&cookie->lock);
238 if (hlist_empty(&cookie->backing_objects)) {
239 spin_unlock(&cookie->lock);
240 goto unavailable;
241 }
242
243 object = hlist_entry(cookie->backing_objects.first,
244 struct fscache_object, cookie_link);
245
246 fscache_set_store_limit(object, i_size);
247
248 /* initiate the process of looking up all the objects in the chain
249 * (done by fscache_initialise_object()) */
David Howellscaaef692013-05-10 19:50:26 +0100250 fscache_raise_event(object, FSCACHE_OBJECT_EV_NEW_CHILD);
David Howellsccc4fc32009-04-03 16:42:38 +0100251
252 spin_unlock(&cookie->lock);
253
254 /* we may be required to wait for lookup to complete at this point */
255 if (!fscache_defer_lookup) {
256 _debug("non-deferred lookup %p", &cookie->flags);
257 wait_on_bit(&cookie->flags, FSCACHE_COOKIE_LOOKING_UP,
258 fscache_wait_bit, TASK_UNINTERRUPTIBLE);
259 _debug("complete");
260 if (test_bit(FSCACHE_COOKIE_UNAVAILABLE, &cookie->flags))
261 goto unavailable;
262 }
263
264 up_read(&fscache_addremove_sem);
265 _leave(" = 0 [deferred]");
266 return 0;
267
268unavailable:
269 up_read(&fscache_addremove_sem);
270 _leave(" = -ENOBUFS");
271 return -ENOBUFS;
272}
273
274/*
275 * recursively allocate cache object records for a cookie/cache combination
276 * - caller must be holding the addremove sem
277 */
278static int fscache_alloc_object(struct fscache_cache *cache,
279 struct fscache_cookie *cookie)
280{
281 struct fscache_object *object;
David Howellsccc4fc32009-04-03 16:42:38 +0100282 int ret;
283
284 _enter("%p,%p{%s}", cache, cookie, cookie->def->name);
285
286 spin_lock(&cookie->lock);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800287 hlist_for_each_entry(object, &cookie->backing_objects,
David Howellsccc4fc32009-04-03 16:42:38 +0100288 cookie_link) {
289 if (object->cache == cache)
290 goto object_already_extant;
291 }
292 spin_unlock(&cookie->lock);
293
294 /* ask the cache to allocate an object (we may end up with duplicate
295 * objects at this stage, but we sort that out later) */
David Howells52bd75f2009-11-19 18:11:08 +0000296 fscache_stat(&fscache_n_cop_alloc_object);
David Howellsccc4fc32009-04-03 16:42:38 +0100297 object = cache->ops->alloc_object(cache, cookie);
David Howells52bd75f2009-11-19 18:11:08 +0000298 fscache_stat_d(&fscache_n_cop_alloc_object);
David Howellsccc4fc32009-04-03 16:42:38 +0100299 if (IS_ERR(object)) {
300 fscache_stat(&fscache_n_object_no_alloc);
301 ret = PTR_ERR(object);
302 goto error;
303 }
304
305 fscache_stat(&fscache_n_object_alloc);
306
307 object->debug_id = atomic_inc_return(&fscache_object_debug_id);
308
309 _debug("ALLOC OBJ%x: %s {%lx}",
310 object->debug_id, cookie->def->name, object->events);
311
312 ret = fscache_alloc_object(cache, cookie->parent);
313 if (ret < 0)
314 goto error_put;
315
316 /* only attach if we managed to allocate all we needed, otherwise
317 * discard the object we just allocated and instead use the one
318 * attached to the cookie */
David Howells52bd75f2009-11-19 18:11:08 +0000319 if (fscache_attach_object(cookie, object) < 0) {
320 fscache_stat(&fscache_n_cop_put_object);
David Howellsccc4fc32009-04-03 16:42:38 +0100321 cache->ops->put_object(object);
David Howells52bd75f2009-11-19 18:11:08 +0000322 fscache_stat_d(&fscache_n_cop_put_object);
323 }
David Howellsccc4fc32009-04-03 16:42:38 +0100324
325 _leave(" = 0");
326 return 0;
327
328object_already_extant:
329 ret = -ENOBUFS;
David Howells493f7bc2013-05-10 19:50:26 +0100330 if (fscache_object_is_dead(object)) {
David Howellsccc4fc32009-04-03 16:42:38 +0100331 spin_unlock(&cookie->lock);
332 goto error;
333 }
334 spin_unlock(&cookie->lock);
335 _leave(" = 0 [found]");
336 return 0;
337
338error_put:
David Howells52bd75f2009-11-19 18:11:08 +0000339 fscache_stat(&fscache_n_cop_put_object);
David Howellsccc4fc32009-04-03 16:42:38 +0100340 cache->ops->put_object(object);
David Howells52bd75f2009-11-19 18:11:08 +0000341 fscache_stat_d(&fscache_n_cop_put_object);
David Howellsccc4fc32009-04-03 16:42:38 +0100342error:
343 _leave(" = %d", ret);
344 return ret;
345}
346
347/*
348 * attach a cache object to a cookie
349 */
350static int fscache_attach_object(struct fscache_cookie *cookie,
351 struct fscache_object *object)
352{
353 struct fscache_object *p;
354 struct fscache_cache *cache = object->cache;
David Howellsccc4fc32009-04-03 16:42:38 +0100355 int ret;
356
357 _enter("{%s},{OBJ%x}", cookie->def->name, object->debug_id);
358
359 spin_lock(&cookie->lock);
360
361 /* there may be multiple initial creations of this object, but we only
362 * want one */
363 ret = -EEXIST;
Sasha Levinb67bfe02013-02-27 17:06:00 -0800364 hlist_for_each_entry(p, &cookie->backing_objects, cookie_link) {
David Howellsccc4fc32009-04-03 16:42:38 +0100365 if (p->cache == object->cache) {
David Howells493f7bc2013-05-10 19:50:26 +0100366 if (fscache_object_is_dying(p))
David Howellsccc4fc32009-04-03 16:42:38 +0100367 ret = -ENOBUFS;
368 goto cant_attach_object;
369 }
370 }
371
372 /* pin the parent object */
373 spin_lock_nested(&cookie->parent->lock, 1);
Sasha Levinb67bfe02013-02-27 17:06:00 -0800374 hlist_for_each_entry(p, &cookie->parent->backing_objects,
David Howellsccc4fc32009-04-03 16:42:38 +0100375 cookie_link) {
376 if (p->cache == object->cache) {
David Howells493f7bc2013-05-10 19:50:26 +0100377 if (fscache_object_is_dying(p)) {
David Howellsccc4fc32009-04-03 16:42:38 +0100378 ret = -ENOBUFS;
379 spin_unlock(&cookie->parent->lock);
380 goto cant_attach_object;
381 }
382 object->parent = p;
383 spin_lock(&p->lock);
384 p->n_children++;
385 spin_unlock(&p->lock);
386 break;
387 }
388 }
389 spin_unlock(&cookie->parent->lock);
390
391 /* attach to the cache's object list */
392 if (list_empty(&object->cache_link)) {
393 spin_lock(&cache->object_list_lock);
394 list_add(&object->cache_link, &cache->object_list);
395 spin_unlock(&cache->object_list_lock);
396 }
397
398 /* attach to the cookie */
399 object->cookie = cookie;
400 atomic_inc(&cookie->usage);
401 hlist_add_head(&object->cookie_link, &cookie->backing_objects);
David Howells4fbf4292009-11-19 18:11:04 +0000402
403 fscache_objlist_add(object);
David Howellsccc4fc32009-04-03 16:42:38 +0100404 ret = 0;
405
406cant_attach_object:
407 spin_unlock(&cookie->lock);
408 _leave(" = %d", ret);
409 return ret;
410}
411
412/*
David Howellsef778e72012-12-20 21:52:36 +0000413 * Invalidate an object. Callable with spinlocks held.
414 */
415void __fscache_invalidate(struct fscache_cookie *cookie)
416{
417 struct fscache_object *object;
418
419 _enter("{%s}", cookie->def->name);
420
421 fscache_stat(&fscache_n_invalidates);
422
423 /* Only permit invalidation of data files. Invalidating an index will
424 * require the caller to release all its attachments to the tree rooted
425 * there, and if it's doing that, it may as well just retire the
426 * cookie.
427 */
428 ASSERTCMP(cookie->def->type, ==, FSCACHE_COOKIE_TYPE_DATAFILE);
429
430 /* We will be updating the cookie too. */
431 BUG_ON(!cookie->def->get_aux);
432
433 /* If there's an object, we tell the object state machine to handle the
434 * invalidation on our behalf, otherwise there's nothing to do.
435 */
436 if (!hlist_empty(&cookie->backing_objects)) {
437 spin_lock(&cookie->lock);
438
David Howells94d30ae2013-09-21 00:09:31 +0100439 if (fscache_cookie_enabled(cookie) &&
440 !hlist_empty(&cookie->backing_objects) &&
David Howellsef778e72012-12-20 21:52:36 +0000441 !test_and_set_bit(FSCACHE_COOKIE_INVALIDATING,
442 &cookie->flags)) {
443 object = hlist_entry(cookie->backing_objects.first,
444 struct fscache_object,
445 cookie_link);
David Howells493f7bc2013-05-10 19:50:26 +0100446 if (fscache_object_is_live(object))
David Howellsef778e72012-12-20 21:52:36 +0000447 fscache_raise_event(
448 object, FSCACHE_OBJECT_EV_INVALIDATE);
449 }
450
451 spin_unlock(&cookie->lock);
452 }
453
454 _leave("");
455}
456EXPORT_SYMBOL(__fscache_invalidate);
457
458/*
459 * Wait for object invalidation to complete.
460 */
461void __fscache_wait_on_invalidate(struct fscache_cookie *cookie)
462{
463 _enter("%p", cookie);
464
465 wait_on_bit(&cookie->flags, FSCACHE_COOKIE_INVALIDATING,
466 fscache_wait_bit_interruptible,
467 TASK_UNINTERRUPTIBLE);
468
469 _leave("");
470}
471EXPORT_SYMBOL(__fscache_wait_on_invalidate);
472
473/*
David Howellsccc4fc32009-04-03 16:42:38 +0100474 * update the index entries backing a cookie
475 */
476void __fscache_update_cookie(struct fscache_cookie *cookie)
477{
478 struct fscache_object *object;
David Howellsccc4fc32009-04-03 16:42:38 +0100479
480 fscache_stat(&fscache_n_updates);
481
482 if (!cookie) {
483 fscache_stat(&fscache_n_updates_null);
484 _leave(" [no cookie]");
485 return;
486 }
487
488 _enter("{%s}", cookie->def->name);
489
490 BUG_ON(!cookie->def->get_aux);
491
492 spin_lock(&cookie->lock);
493
David Howells94d30ae2013-09-21 00:09:31 +0100494 if (fscache_cookie_enabled(cookie)) {
495 /* update the index entry on disk in each cache backing this
496 * cookie.
497 */
498 hlist_for_each_entry(object,
499 &cookie->backing_objects, cookie_link) {
500 fscache_raise_event(object, FSCACHE_OBJECT_EV_UPDATE);
501 }
David Howellsccc4fc32009-04-03 16:42:38 +0100502 }
503
504 spin_unlock(&cookie->lock);
505 _leave("");
506}
507EXPORT_SYMBOL(__fscache_update_cookie);
508
509/*
David Howells94d30ae2013-09-21 00:09:31 +0100510 * Disable a cookie to stop it from accepting new requests from the netfs.
511 */
512void __fscache_disable_cookie(struct fscache_cookie *cookie, bool invalidate)
513{
514 struct fscache_object *object;
515 bool awaken = false;
516
517 _enter("%p,%u", cookie, invalidate);
518
519 ASSERTCMP(atomic_read(&cookie->n_active), >, 0);
520
521 if (atomic_read(&cookie->n_children) != 0) {
522 printk(KERN_ERR "FS-Cache: Cookie '%s' still has children\n",
523 cookie->def->name);
524 BUG();
525 }
526
527 wait_on_bit_lock(&cookie->flags, FSCACHE_COOKIE_ENABLEMENT_LOCK,
528 fscache_wait_bit, TASK_UNINTERRUPTIBLE);
529 if (!test_and_clear_bit(FSCACHE_COOKIE_ENABLED, &cookie->flags))
530 goto out_unlock_enable;
531
532 /* If the cookie is being invalidated, wait for that to complete first
533 * so that we can reuse the flag.
534 */
535 __fscache_wait_on_invalidate(cookie);
536
537 /* Dispose of the backing objects */
538 set_bit(FSCACHE_COOKIE_INVALIDATING, &cookie->flags);
539
540 spin_lock(&cookie->lock);
541 if (!hlist_empty(&cookie->backing_objects)) {
542 hlist_for_each_entry(object, &cookie->backing_objects, cookie_link) {
543 if (invalidate)
544 set_bit(FSCACHE_OBJECT_RETIRED, &object->flags);
545 fscache_raise_event(object, FSCACHE_OBJECT_EV_KILL);
546 }
547 } else {
548 if (test_and_clear_bit(FSCACHE_COOKIE_INVALIDATING, &cookie->flags))
549 awaken = true;
550 }
551 spin_unlock(&cookie->lock);
552 if (awaken)
553 wake_up_bit(&cookie->flags, FSCACHE_COOKIE_INVALIDATING);
554
555 /* Wait for cessation of activity requiring access to the netfs (when
556 * n_active reaches 0). This makes sure outstanding reads and writes
557 * have completed.
558 */
559 if (!atomic_dec_and_test(&cookie->n_active))
560 wait_on_atomic_t(&cookie->n_active, fscache_wait_atomic_t,
561 TASK_UNINTERRUPTIBLE);
562
563 /* Reset the cookie state if it wasn't relinquished */
564 if (!test_bit(FSCACHE_COOKIE_RELINQUISHED, &cookie->flags)) {
565 atomic_inc(&cookie->n_active);
566 set_bit(FSCACHE_COOKIE_NO_DATA_YET, &cookie->flags);
567 }
568
569out_unlock_enable:
570 clear_bit_unlock(FSCACHE_COOKIE_ENABLEMENT_LOCK, &cookie->flags);
571 wake_up_bit(&cookie->flags, FSCACHE_COOKIE_ENABLEMENT_LOCK);
572 _leave("");
573}
574EXPORT_SYMBOL(__fscache_disable_cookie);
575
576/*
David Howellsccc4fc32009-04-03 16:42:38 +0100577 * release a cookie back to the cache
578 * - the object will be marked as recyclable on disk if retire is true
579 * - all dependents of this cookie must have already been unregistered
580 * (indices/files/pages)
581 */
David Howells94d30ae2013-09-21 00:09:31 +0100582void __fscache_relinquish_cookie(struct fscache_cookie *cookie, bool retire)
David Howellsccc4fc32009-04-03 16:42:38 +0100583{
David Howellsccc4fc32009-04-03 16:42:38 +0100584 fscache_stat(&fscache_n_relinquishes);
David Howells2175bb02009-11-19 18:11:38 +0000585 if (retire)
586 fscache_stat(&fscache_n_relinquishes_retire);
David Howellsccc4fc32009-04-03 16:42:38 +0100587
588 if (!cookie) {
589 fscache_stat(&fscache_n_relinquishes_null);
590 _leave(" [no cookie]");
591 return;
592 }
593
David Howells13627292013-05-10 19:50:26 +0100594 _enter("%p{%s,%p,%d},%d",
595 cookie, cookie->def->name, cookie->netfs_data,
596 atomic_read(&cookie->n_active), retire);
597
David Howells13627292013-05-10 19:50:26 +0100598 /* No further netfs-accessing operations on this cookie permitted */
599 set_bit(FSCACHE_COOKIE_RELINQUISHED, &cookie->flags);
David Howellsccc4fc32009-04-03 16:42:38 +0100600
David Howells94d30ae2013-09-21 00:09:31 +0100601 __fscache_disable_cookie(cookie, retire);
David Howells13627292013-05-10 19:50:26 +0100602
603 /* Clear pointers back to the netfs */
David Howells7e311a22009-11-19 18:11:11 +0000604 cookie->netfs_data = NULL;
605 cookie->def = NULL;
David Howells13627292013-05-10 19:50:26 +0100606 BUG_ON(cookie->stores.rnode);
David Howellsccc4fc32009-04-03 16:42:38 +0100607
608 if (cookie->parent) {
609 ASSERTCMP(atomic_read(&cookie->parent->usage), >, 0);
610 ASSERTCMP(atomic_read(&cookie->parent->n_children), >, 0);
611 atomic_dec(&cookie->parent->n_children);
612 }
613
David Howells13627292013-05-10 19:50:26 +0100614 /* Dispose of the netfs's link to the cookie */
David Howellsccc4fc32009-04-03 16:42:38 +0100615 ASSERTCMP(atomic_read(&cookie->usage), >, 0);
616 fscache_cookie_put(cookie);
617
618 _leave("");
619}
620EXPORT_SYMBOL(__fscache_relinquish_cookie);
621
622/*
David Howells955d00912009-04-03 16:42:38 +0100623 * destroy a cookie
624 */
625void __fscache_cookie_put(struct fscache_cookie *cookie)
626{
627 struct fscache_cookie *parent;
628
629 _enter("%p", cookie);
630
631 for (;;) {
632 _debug("FREE COOKIE %p", cookie);
633 parent = cookie->parent;
634 BUG_ON(!hlist_empty(&cookie->backing_objects));
635 kmem_cache_free(fscache_cookie_jar, cookie);
636
637 if (!parent)
638 break;
639
640 cookie = parent;
641 BUG_ON(atomic_read(&cookie->usage) <= 0);
642 if (!atomic_dec_and_test(&cookie->usage))
643 break;
644 }
645
646 _leave("");
647}
David Howellsda9803b2013-08-21 17:29:38 -0400648
649/*
650 * check the consistency between the netfs inode and the backing cache
651 *
652 * NOTE: it only serves no-index type
653 */
654int __fscache_check_consistency(struct fscache_cookie *cookie)
655{
656 struct fscache_operation *op;
657 struct fscache_object *object;
David Howells8fb883f2013-09-21 00:09:31 +0100658 bool wake_cookie = false;
David Howellsda9803b2013-08-21 17:29:38 -0400659 int ret;
660
661 _enter("%p,", cookie);
662
663 ASSERTCMP(cookie->def->type, ==, FSCACHE_COOKIE_TYPE_DATAFILE);
664
665 if (fscache_wait_for_deferred_lookup(cookie) < 0)
666 return -ERESTARTSYS;
667
668 if (hlist_empty(&cookie->backing_objects))
669 return 0;
670
671 op = kzalloc(sizeof(*op), GFP_NOIO | __GFP_NOMEMALLOC | __GFP_NORETRY);
672 if (!op)
673 return -ENOMEM;
674
675 fscache_operation_init(op, NULL, NULL);
676 op->flags = FSCACHE_OP_MYTHREAD |
Milosz Tanski9c89d622013-09-09 14:28:57 -0400677 (1 << FSCACHE_OP_WAITING) |
678 (1 << FSCACHE_OP_UNUSE_COOKIE);
David Howellsda9803b2013-08-21 17:29:38 -0400679
680 spin_lock(&cookie->lock);
681
David Howells94d30ae2013-09-21 00:09:31 +0100682 if (!fscache_cookie_enabled(cookie) ||
683 hlist_empty(&cookie->backing_objects))
David Howellsda9803b2013-08-21 17:29:38 -0400684 goto inconsistent;
685 object = hlist_entry(cookie->backing_objects.first,
686 struct fscache_object, cookie_link);
687 if (test_bit(FSCACHE_IOERROR, &object->cache->flags))
688 goto inconsistent;
689
690 op->debug_id = atomic_inc_return(&fscache_op_debug_id);
691
David Howells8fb883f2013-09-21 00:09:31 +0100692 __fscache_use_cookie(cookie);
David Howellsda9803b2013-08-21 17:29:38 -0400693 if (fscache_submit_op(object, op) < 0)
694 goto submit_failed;
695
696 /* the work queue now carries its own ref on the object */
697 spin_unlock(&cookie->lock);
698
699 ret = fscache_wait_for_operation_activation(object, op,
700 NULL, NULL, NULL);
701 if (ret == 0) {
702 /* ask the cache to honour the operation */
703 ret = object->cache->ops->check_consistency(op);
704 fscache_op_complete(op, false);
705 } else if (ret == -ENOBUFS) {
706 ret = 0;
707 }
708
709 fscache_put_operation(op);
710 _leave(" = %d", ret);
711 return ret;
712
713submit_failed:
David Howells8fb883f2013-09-21 00:09:31 +0100714 wake_cookie = __fscache_unuse_cookie(cookie);
David Howellsda9803b2013-08-21 17:29:38 -0400715inconsistent:
716 spin_unlock(&cookie->lock);
David Howells8fb883f2013-09-21 00:09:31 +0100717 if (wake_cookie)
718 __fscache_wake_unused_cookie(cookie);
David Howellsda9803b2013-08-21 17:29:38 -0400719 kfree(op);
720 _leave(" = -ESTALE");
721 return -ESTALE;
722}
723EXPORT_SYMBOL(__fscache_check_consistency);