mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
synced 2024-08-21 16:29:59 +00:00
![David Howells](/assets/img/avatar_default.png)
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
146 lines
4.3 KiB
C
146 lines
4.3 KiB
C
/* 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 uint16_t fscache_fsdef_netfs_get_key(const void *cookie_netfs_data,
|
|
void *buffer, uint16_t bufmax);
|
|
|
|
static uint16_t fscache_fsdef_netfs_get_aux(const void *cookie_netfs_data,
|
|
void *buffer, uint16_t bufmax);
|
|
|
|
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),
|
|
.n_active = ATOMIC_INIT(1),
|
|
.lock = __SPIN_LOCK_UNLOCKED(fscache_fsdef_index.lock),
|
|
.backing_objects = HLIST_HEAD_INIT,
|
|
.def = &fscache_fsdef_index_def,
|
|
.flags = 1 << FSCACHE_COOKIE_ENABLED,
|
|
};
|
|
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,
|
|
.get_key = fscache_fsdef_netfs_get_key,
|
|
.get_aux = fscache_fsdef_netfs_get_aux,
|
|
.check_aux = fscache_fsdef_netfs_check_aux,
|
|
};
|
|
|
|
/*
|
|
* get the key data for an FSDEF index record - this is the name of the netfs
|
|
* for which this entry is created
|
|
*/
|
|
static uint16_t fscache_fsdef_netfs_get_key(const void *cookie_netfs_data,
|
|
void *buffer, uint16_t bufmax)
|
|
{
|
|
const struct fscache_netfs *netfs = cookie_netfs_data;
|
|
unsigned klen;
|
|
|
|
_enter("{%s.%u},", netfs->name, netfs->version);
|
|
|
|
klen = strlen(netfs->name);
|
|
if (klen > bufmax)
|
|
return 0;
|
|
|
|
memcpy(buffer, netfs->name, klen);
|
|
return klen;
|
|
}
|
|
|
|
/*
|
|
* get the auxiliary data for an FSDEF index record - this is the index
|
|
* structure version number of the netfs for which this version is created
|
|
*/
|
|
static uint16_t fscache_fsdef_netfs_get_aux(const void *cookie_netfs_data,
|
|
void *buffer, uint16_t bufmax)
|
|
{
|
|
const struct fscache_netfs *netfs = cookie_netfs_data;
|
|
unsigned dlen;
|
|
|
|
_enter("{%s.%u},", netfs->name, netfs->version);
|
|
|
|
dlen = sizeof(uint32_t);
|
|
if (dlen > bufmax)
|
|
return 0;
|
|
|
|
memcpy(buffer, &netfs->version, dlen);
|
|
return dlen;
|
|
}
|
|
|
|
/*
|
|
* 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;
|
|
}
|