/* * Copyright (c) 2001 The Regents of the University of Michigan. * All rights reserved. * * Kendrick Smith <[email protected]> * Andy Adamson <[email protected]> * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the University nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * */ #ifndef _NFSD4_STATE_H #define _NFSD4_STATE_H #include <linux/idr.h> #include <linux/refcount.h> #include <linux/sunrpc/svc_xprt.h> #include "nfsfh.h" #include "nfsd.h" clientid_t; stateid_opaque_t; stateid_t; copy_stateid_t; struct nfsd4_callback { … }; struct nfsd4_callback_ops { … }; /* * A core object that represents a "common" stateid. These are generally * embedded within the different (more specific) stateid objects and contain * fields that are of general use to any stateid. */ struct nfs4_stid { … }; /* Keep a list of stateids issued by the COPY_NOTIFY, associate it with the * parent OPEN/LOCK/DELEG stateid. */ struct nfs4_cpntf_state { … }; struct nfs4_cb_fattr { … }; /* bits for ncf_cb_flags */ #define CB_GETATTR_BUSY … /* * Represents a delegation stateid. The nfs4_client holds references to these * and they are put when it is being destroyed or when the delegation is * returned by the client: * * o 1 reference as long as a delegation is still in force (taken when it's * alloc'd, put when it's returned or revoked) * * o 1 reference as long as a recall rpc is in progress (taken when the lease * is broken, put when the rpc exits) * * o 1 more ephemeral reference for each nfsd thread currently doing something * with that delegation without holding the cl_lock * * If the server attempts to recall a delegation and the client doesn't do so * before a timeout, the server may also revoke the delegation. In that case, * the object will either be destroyed (v4.0) or moved to a per-client list of * revoked delegations (v4.1+). * * This object is a superset of the nfs4_stid. */ struct nfs4_delegation { … }; #define cb_to_delegation(cb) … /* client delegation callback info */ struct nfs4_cb_conn { … }; static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s) { … } /* Maximum number of slots per session. 160 is useful for long haul TCP */ #define NFSD_MAX_SLOTS_PER_SESSION … /* Maximum session per slot cache size */ #define NFSD_SLOT_CACHE_SIZE … /* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */ #define NFSD_CACHE_SIZE_SLOTS_PER_SESSION … #define NFSD_MAX_MEM_PER_SESSION … struct nfsd4_slot { … }; struct nfsd4_channel_attrs { … }; struct nfsd4_cb_sec { … }; struct nfsd4_create_session { … }; struct nfsd4_backchannel_ctl { … }; struct nfsd4_bind_conn_to_session { … }; /* The single slot clientid cache structure */ struct nfsd4_clid_slot { … }; struct nfsd4_conn { … }; /* * Representation of a v4.1+ session. These are refcounted in a similar fashion * to the nfs4_client. References are only taken when the server is actively * working on the object (primarily during the processing of compounds). */ struct nfsd4_session { … }; /* formatted contents of nfs4_sessionid */ struct nfsd4_sessionid { … }; #define HEXDIR_LEN … /* * State Meaning Where set * -------------------------------------------------------------------------- * | NFSD4_ACTIVE | Confirmed, active | Default | * |------------------- ----------------------------------------------------| * | NFSD4_COURTESY | Courtesy state. | nfs4_get_client_reaplist | * | | Lease/lock/share | | * | | reservation conflict | | * | | can cause Courtesy | | * | | client to be expired | | * |------------------------------------------------------------------------| * | NFSD4_EXPIRABLE | Courtesy client to be| nfs4_laundromat | * | | expired by Laundromat| try_to_expire_client | * | | due to conflict | | * |------------------------------------------------------------------------| */ enum { … }; /* * struct nfs4_client - one per client. Clientids live here. * * The initial object created by an NFS client using SETCLIENTID (for NFSv4.0) * or EXCHANGE_ID (for NFSv4.1+). These objects are refcounted and timestamped. * Each nfsd_net_ns object contains a set of these and they are tracked via * short and long form clientid. They are hashed and searched for under the * per-nfsd_net client_lock spinlock. * * References to it are only held during the processing of compounds, and in * certain other operations. In their "resting state" they have a refcount of * 0. If they are not renewed within a lease period, they become eligible for * destruction by the laundromat. * * These objects can also be destroyed if the client sends certain forms of * SETCLIENTID or EXCHANGE_ID operations. * * Care is taken *not* to do this however when the objects have an elevated * refcount. * * o Each nfs4_client is hashed by clientid * * o Each nfs4_clients is also hashed by name (the opaque quantity initially * sent by the client to identify itself). * * o cl_perclient list is used to ensure no dangling stateowner references * when we expire the nfs4_client */ struct nfs4_client { … }; /* struct nfs4_client_reset * one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl * upon lease reset, or from upcall to state_daemon (to read in state * from non-volitile storage) upon reboot. */ struct nfs4_client_reclaim { … }; /* A reasonable value for REPLAY_ISIZE was estimated as follows: * The OPEN response, typically the largest, requires * 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) + * 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) + * 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes */ #define NFSD4_REPLAY_ISIZE … /* * Replay buffer, where the result of the last seqid-mutating operation * is cached. */ struct nfs4_replay { … }; struct nfs4_stateowner; struct nfs4_stateowner_operations { … }; /* * A core object that represents either an open or lock owner. The object and * lock owner objects have one of these embedded within them. Refcounts and * other fields common to both owner types are contained within these * structures. */ struct nfs4_stateowner { … }; /* * When a file is opened, the client provides an open state owner opaque string * that indicates the "owner" of that open. These objects are refcounted. * References to it are held by each open state associated with it. This object * is a superset of the nfs4_stateowner struct. */ struct nfs4_openowner { … }; /* * Represents a generic "lockowner". Similar to an openowner. References to it * are held by the lock stateids that are created on its behalf. This object is * a superset of the nfs4_stateowner struct. */ struct nfs4_lockowner { … }; static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so) { … } static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so) { … } /* * Per-client state indicating no. of opens and outstanding delegations * on a file from a particular client.'od' stands for 'open & delegation' */ struct nfs4_clnt_odstate { … }; /* * nfs4_file: a file opened by some number of (open) nfs4_stateowners. * * These objects are global. nfsd keeps one instance of a nfs4_file per * filehandle (though it may keep multiple file descriptors for each). Each * inode can have multiple filehandles associated with it, so there is * (potentially) a many to one relationship between this struct and struct * inode. */ struct nfs4_file { … }; /* * A generic struct representing either a open or lock stateid. The nfs4_client * holds a reference to each of these objects, and they in turn hold a * reference to their respective stateowners. The client's reference is * released in response to a close or unlock (depending on whether it's an open * or lock stateid) or when the client is being destroyed. * * In the case of v4.0 open stateids, these objects are preserved for a little * while after close in order to handle CLOSE replays. Those are eventually * reclaimed via a LRU scheme by the laundromat. * * This object is a superset of the nfs4_stid. "ol" stands for "Open or Lock". * Better suggestions welcome. */ struct nfs4_ol_stateid { … }; static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s) { … } struct nfs4_layout_stateid { … }; static inline struct nfs4_layout_stateid *layoutstateid(struct nfs4_stid *s) { … } /* flags for preprocess_seqid_op() */ #define RD_STATE … #define WR_STATE … enum nfsd4_cb_op { … }; /* Returns true iff a is later than b: */ static inline bool nfsd4_stateid_generation_after(stateid_t *a, stateid_t *b) { … } /* * When a client tries to get a lock on a file, we set one of these objects * on the blocking lock. When the lock becomes free, we can then issue a * CB_NOTIFY_LOCK to the server. */ struct nfsd4_blocked_lock { … }; struct nfsd4_compound_state; struct nfsd_net; struct nfsd4_copy; extern __be32 nfs4_preprocess_stateid_op(struct svc_rqst *rqstp, struct nfsd4_compound_state *cstate, struct svc_fh *fhp, stateid_t *stateid, int flags, struct nfsd_file **filp, struct nfs4_stid **cstid); __be32 nfsd4_lookup_stateid(struct nfsd4_compound_state *cstate, stateid_t *stateid, unsigned short typemask, unsigned short statusmask, struct nfs4_stid **s, struct nfsd_net *nn); struct nfs4_stid *nfs4_alloc_stid(struct nfs4_client *cl, struct kmem_cache *slab, void (*sc_free)(struct nfs4_stid *)); int nfs4_init_copy_state(struct nfsd_net *nn, struct nfsd4_copy *copy); void nfs4_free_copy_state(struct nfsd4_copy *copy); struct nfs4_cpntf_state *nfs4_alloc_init_cpntf_state(struct nfsd_net *nn, struct nfs4_stid *p_stid); void nfs4_put_stid(struct nfs4_stid *s); void nfs4_inc_and_copy_stateid(stateid_t *dst, struct nfs4_stid *stid); void nfs4_remove_reclaim_record(struct nfs4_client_reclaim *, struct nfsd_net *); extern void nfs4_release_reclaim(struct nfsd_net *); extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct xdr_netobj name, struct nfsd_net *nn); extern __be32 nfs4_check_open_reclaim(struct nfs4_client *); extern void nfsd4_probe_callback(struct nfs4_client *clp); extern void nfsd4_probe_callback_sync(struct nfs4_client *clp); extern void nfsd4_change_callback(struct nfs4_client *clp, struct nfs4_cb_conn *); extern void nfsd4_init_cb(struct nfsd4_callback *cb, struct nfs4_client *clp, const struct nfsd4_callback_ops *ops, enum nfsd4_cb_op op); extern bool nfsd4_run_cb(struct nfsd4_callback *cb); extern void nfsd4_shutdown_callback(struct nfs4_client *); extern void nfsd4_shutdown_copy(struct nfs4_client *clp); extern struct nfs4_client_reclaim *nfs4_client_to_reclaim(struct xdr_netobj name, struct xdr_netobj princhash, struct nfsd_net *nn); extern bool nfs4_has_reclaimed_state(struct xdr_netobj name, struct nfsd_net *nn); void put_nfs4_file(struct nfs4_file *fi); extern void nfs4_put_cpntf_state(struct nfsd_net *nn, struct nfs4_cpntf_state *cps); extern __be32 manage_cpntf_state(struct nfsd_net *nn, stateid_t *st, struct nfs4_client *clp, struct nfs4_cpntf_state **cps); static inline void get_nfs4_file(struct nfs4_file *fi) { … } struct nfsd_file *find_any_file(struct nfs4_file *f); #ifdef CONFIG_NFSD_V4 void nfsd4_revoke_states(struct net *net, struct super_block *sb); #else static inline void nfsd4_revoke_states(struct net *net, struct super_block *sb) { } #endif /* grace period management */ void nfsd4_end_grace(struct nfsd_net *nn); /* nfs4recover operations */ extern int nfsd4_client_tracking_init(struct net *net); extern void nfsd4_client_tracking_exit(struct net *net); extern void nfsd4_client_record_create(struct nfs4_client *clp); extern void nfsd4_client_record_remove(struct nfs4_client *clp); extern int nfsd4_client_record_check(struct nfs4_client *clp); extern void nfsd4_record_grace_done(struct nfsd_net *nn); static inline bool try_to_expire_client(struct nfs4_client *clp) { … } extern __be32 nfsd4_deleg_getattr_conflict(struct svc_rqst *rqstp, struct dentry *dentry, bool *file_modified, u64 *size); #endif /* NFSD4_STATE_H */
Codebase Browser
linux