2009-04-03 15:42:37 +00:00
|
|
|
/* Filesystem index definition
|
|
|
|
*
|
|
|
|
* Copyright (C) 2004-2007 Red Hat, Inc. All Rights Reserved.
|
|
|
|
* Written by David Howells (dhowells@redhat.com)
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version
|
|
|
|
* 2 of the License, or (at your option) any later version.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#define FSCACHE_DEBUG_LEVEL CACHE
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include "internal.h"
|
|
|
|
|
|
|
|
static
|
|
|
|
enum fscache_checkaux fscache_fsdef_netfs_check_aux(void *cookie_netfs_data,
|
|
|
|
const void *data,
|
|
|
|
uint16_t datalen);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* The root index is owned by FS-Cache itself.
|
|
|
|
*
|
|
|
|
* When a netfs requests caching facilities, FS-Cache will, if one doesn't
|
|
|
|
* already exist, create an entry in the root index with the key being the name
|
|
|
|
* of the netfs ("AFS" for example), and the auxiliary data holding the index
|
|
|
|
* structure version supplied by the netfs:
|
|
|
|
*
|
|
|
|
* FSDEF
|
|
|
|
* |
|
|
|
|
* +-----------+
|
|
|
|
* | |
|
|
|
|
* NFS AFS
|
|
|
|
* [v=1] [v=1]
|
|
|
|
*
|
|
|
|
* If an entry with the appropriate name does already exist, the version is
|
|
|
|
* compared. If the version is different, the entire subtree from that entry
|
|
|
|
* will be discarded and a new entry created.
|
|
|
|
*
|
|
|
|
* The new entry will be an index, and a cookie referring to it will be passed
|
|
|
|
* to the netfs. This is then the root handle by which the netfs accesses the
|
|
|
|
* cache. It can create whatever objects it likes in that index, including
|
|
|
|
* further indices.
|
|
|
|
*/
|
|
|
|
static struct fscache_cookie_def fscache_fsdef_index_def = {
|
|
|
|
.name = ".FS-Cache",
|
|
|
|
.type = FSCACHE_COOKIE_TYPE_INDEX,
|
|
|
|
};
|
|
|
|
|
|
|
|
struct fscache_cookie fscache_fsdef_index = {
|
|
|
|
.usage = ATOMIC_INIT(1),
|
FS-Cache: Simplify cookie retention for fscache_objects, fixing oops
Simplify the way fscache cache objects retain their cookie. The way I
implemented the cookie storage handling made synchronisation a pain (ie. the
object state machine can't rely on the cookie actually still being there).
Instead of the the object being detached from the cookie and the cookie being
freed in __fscache_relinquish_cookie(), we defer both operations:
(*) The detachment of the object from the list in the cookie now takes place
in fscache_drop_object() and is thus governed by the object state machine
(fscache_detach_from_cookie() has been removed).
(*) The release of the cookie is now in fscache_object_destroy() - which is
called by the cache backend just before it frees the object.
This means that the fscache_cookie struct is now available to the cache all the
way through from ->alloc_object() to ->drop_object() and ->put_object() -
meaning that it's no longer necessary to take object->lock to guarantee access.
However, __fscache_relinquish_cookie() doesn't wait for the object to go all
the way through to destruction before letting the netfs proceed. That would
massively slow down the netfs. Since __fscache_relinquish_cookie() leaves the
cookie around, in must therefore break all attachments to the netfs - which
includes ->def, ->netfs_data and any outstanding page read/writes.
To handle this, struct fscache_cookie now has an n_active counter:
(1) This starts off initialised to 1.
(2) Any time the cache needs to get at the netfs data, it calls
fscache_use_cookie() to increment it - if it is not zero. If it was zero,
then access is not permitted.
(3) When the cache has finished with the data, it calls fscache_unuse_cookie()
to decrement it. This does a wake-up on it if it reaches 0.
(4) __fscache_relinquish_cookie() decrements n_active and then waits for it to
reach 0. The initialisation to 1 in step (1) ensures that we only get
wake ups when we're trying to get rid of the cookie.
This leaves __fscache_relinquish_cookie() a lot simpler.
***
This fixes a problem in the current code whereby if fscache_invalidate() is
followed sufficiently quickly by fscache_relinquish_cookie() then it is
possible for __fscache_relinquish_cookie() to have detached the cookie from the
object and cleared the pointer before a thread is dispatched to process the
invalidation state in the object state machine.
Since the pending write clearance was deferred to the invalidation state to
make it asynchronous, we need to either wait in relinquishment for the stores
tree to be cleared in the invalidation state or we need to handle the clearance
in relinquishment.
Further, if the relinquishment code does clear the tree, then the invalidation
state need to make the clearance contingent on still having the cookie to hand
(since that's where the tree is rooted) and we have to prevent the cookie from
disappearing for the duration.
This can lead to an oops like the following:
BUG: unable to handle kernel NULL pointer dereference at 000000000000000c
...
RIP: 0010:[<ffffffff8151023e>] _spin_lock+0xe/0x30
...
CR2: 000000000000000c ...
...
Process kslowd002 (...)
....
Call Trace:
[<ffffffffa01c3278>] fscache_invalidate_writes+0x38/0xd0 [fscache]
[<ffffffff810096f0>] ? __switch_to+0xd0/0x320
[<ffffffff8105e759>] ? find_busiest_queue+0x69/0x150
[<ffffffff8110ddd4>] ? slow_work_enqueue+0x104/0x180
[<ffffffffa01c1303>] fscache_object_slow_work_execute+0x5e3/0x9d0 [fscache]
[<ffffffff81096b67>] ? bit_waitqueue+0x17/0xd0
[<ffffffff8110e233>] slow_work_execute+0x233/0x310
[<ffffffff8110e515>] slow_work_thread+0x205/0x360
[<ffffffff81096ca0>] ? autoremove_wake_function+0x0/0x40
[<ffffffff8110e310>] ? slow_work_thread+0x0/0x360
[<ffffffff81096936>] kthread+0x96/0xa0
[<ffffffff8100c0ca>] child_rip+0xa/0x20
[<ffffffff810968a0>] ? kthread+0x0/0xa0
[<ffffffff8100c0c0>] ? child_rip+0x0/0x20
The parameter to fscache_invalidate_writes() was object->cookie which is NULL.
Signed-off-by: David Howells <dhowells@redhat.com>
Tested-By: Milosz Tanski <milosz@adfin.com>
Acked-by: Jeff Layton <jlayton@redhat.com>
2013-05-10 18:50:26 +00:00
|
|
|
.n_active = ATOMIC_INIT(1),
|
2009-04-03 15:42:37 +00:00
|
|
|
.lock = __SPIN_LOCK_UNLOCKED(fscache_fsdef_index.lock),
|
|
|
|
.backing_objects = HLIST_HEAD_INIT,
|
|
|
|
.def = &fscache_fsdef_index_def,
|
FS-Cache: Provide the ability to enable/disable cookies
Provide the ability to enable and disable fscache cookies. A disabled cookie
will reject or ignore further requests to:
Acquire a child cookie
Invalidate and update backing objects
Check the consistency of a backing object
Allocate storage for backing page
Read backing pages
Write to backing pages
but still allows:
Checks/waits on the completion of already in-progress objects
Uncaching of pages
Relinquishment of cookies
Two new operations are provided:
(1) Disable a cookie:
void fscache_disable_cookie(struct fscache_cookie *cookie,
bool invalidate);
If the cookie is not already disabled, this locks the cookie against other
dis/enablement ops, marks the cookie as being disabled, discards or
invalidates any backing objects and waits for cessation of activity on any
associated object.
This is a wrapper around a chunk split out of fscache_relinquish_cookie(),
but it reinitialises the cookie such that it can be reenabled.
All possible failures are handled internally. The caller should consider
calling fscache_uncache_all_inode_pages() afterwards to make sure all page
markings are cleared up.
(2) Enable a cookie:
void fscache_enable_cookie(struct fscache_cookie *cookie,
bool (*can_enable)(void *data),
void *data)
If the cookie is not already enabled, this locks the cookie against other
dis/enablement ops, invokes can_enable() and, if the cookie is not an
index cookie, will begin the procedure of acquiring backing objects.
The optional can_enable() function is passed the data argument and returns
a ruling as to whether or not enablement should actually be permitted to
begin.
All possible failures are handled internally. The cookie will only be
marked as enabled if provisional backing objects are allocated.
A later patch will introduce these to NFS. Cookie enablement during nfs_open()
is then contingent on i_writecount <= 0. can_enable() checks for a race
between open(O_RDONLY) and open(O_WRONLY/O_RDWR). This simplifies NFS's cookie
handling and allows us to get rid of open(O_RDONLY) accidentally introducing
caching to an inode that's open for writing already.
One operation has its API modified:
(3) Acquire a cookie.
struct fscache_cookie *fscache_acquire_cookie(
struct fscache_cookie *parent,
const struct fscache_cookie_def *def,
void *netfs_data,
bool enable);
This now has an additional argument that indicates whether the requested
cookie should be enabled by default. It doesn't need the can_enable()
function because the caller must prevent multiple calls for the same netfs
object and it doesn't need to take the enablement lock because no one else
can get at the cookie before this returns.
Signed-off-by: David Howells <dhowells@redhat.com
2013-09-20 23:09:31 +00:00
|
|
|
.flags = 1 << FSCACHE_COOKIE_ENABLED,
|
2018-04-04 12:41:28 +00:00
|
|
|
.type = FSCACHE_COOKIE_TYPE_INDEX,
|
2009-04-03 15:42:37 +00:00
|
|
|
};
|
|
|
|
EXPORT_SYMBOL(fscache_fsdef_index);
|
|
|
|
|
|
|
|
/*
|
|
|
|
* Definition of an entry in the root index. Each entry is an index, keyed to
|
|
|
|
* a specific netfs and only applicable to a particular version of the index
|
|
|
|
* structure used by that netfs.
|
|
|
|
*/
|
|
|
|
struct fscache_cookie_def fscache_fsdef_netfs_def = {
|
|
|
|
.name = "FSDEF.netfs",
|
|
|
|
.type = FSCACHE_COOKIE_TYPE_INDEX,
|
|
|
|
.check_aux = fscache_fsdef_netfs_check_aux,
|
|
|
|
};
|
|
|
|
|
|
|
|
/*
|
|
|
|
* check that the index structure version number stored in the auxiliary data
|
|
|
|
* matches the one the netfs gave us
|
|
|
|
*/
|
|
|
|
static enum fscache_checkaux fscache_fsdef_netfs_check_aux(
|
|
|
|
void *cookie_netfs_data,
|
|
|
|
const void *data,
|
|
|
|
uint16_t datalen)
|
|
|
|
{
|
|
|
|
struct fscache_netfs *netfs = cookie_netfs_data;
|
|
|
|
uint32_t version;
|
|
|
|
|
|
|
|
_enter("{%s},,%hu", netfs->name, datalen);
|
|
|
|
|
|
|
|
if (datalen != sizeof(version)) {
|
|
|
|
_leave(" = OBSOLETE [dl=%d v=%zu]", datalen, sizeof(version));
|
|
|
|
return FSCACHE_CHECKAUX_OBSOLETE;
|
|
|
|
}
|
|
|
|
|
|
|
|
memcpy(&version, data, sizeof(version));
|
|
|
|
if (version != netfs->version) {
|
|
|
|
_leave(" = OBSOLETE [ver=%x net=%x]", version, netfs->version);
|
|
|
|
return FSCACHE_CHECKAUX_OBSOLETE;
|
|
|
|
}
|
|
|
|
|
|
|
|
_leave(" = OKAY");
|
|
|
|
return FSCACHE_CHECKAUX_OKAY;
|
|
|
|
}
|