[mirror_ubuntu-artful-kernel.git] / fs / nfsd / state.h

/*
 *  Copyright (c) 2001 The Regents of the University of Michigan.
 *  All rights reserved.
 *
 *  Kendrick Smith <kmsmith@umich.edu>
 *  Andy Adamson <andros@umich.edu>
 *  
 *  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/sunrpc/svc_xprt.h>
#include <linux/nfsd/nfsfh.h>
#include "nfsfh.h"

typedef struct {
	u32             cl_boot;
	u32             cl_id;
} clientid_t;

typedef struct {
	u32             so_boot;
	u32             so_stateownerid;
	u32             so_fileid;
} stateid_opaque_t;

typedef struct {
	u32                     si_generation;
	stateid_opaque_t        si_opaque;
} stateid_t;
#define si_boot           si_opaque.so_boot
#define si_stateownerid   si_opaque.so_stateownerid
#define si_fileid         si_opaque.so_fileid

#define STATEID_FMT	"(%08x/%08x/%08x/%08x)"
#define STATEID_VAL(s) \
	(s)->si_boot, \
	(s)->si_stateownerid, \
	(s)->si_fileid, \
	(s)->si_generation

struct nfsd4_callback {
	void *cb_op;
	struct nfs4_client *cb_clp;
	struct list_head cb_per_client;
	u32 cb_minorversion;
	struct rpc_message cb_msg;
	const struct rpc_call_ops *cb_ops;
	struct work_struct cb_work;
	bool cb_done;
};

struct nfs4_stid {
#define NFS4_OPEN_STID 1
#define NFS4_LOCK_STID 2
#define NFS4_DELEG_STID 4
	char sc_type;
	struct list_head sc_hash;
	stateid_t sc_stateid;
};

struct nfs4_delegation {
	struct list_head	dl_perfile;
	struct list_head	dl_perclnt;
	struct list_head	dl_recall_lru;  /* delegation recalled */
	atomic_t		dl_count;       /* ref count */
	struct nfs4_client	*dl_client;
	struct nfs4_file	*dl_file;
	u32			dl_type;
	time_t			dl_time;
/* For recall: */
	struct nfs4_stid	dl_stid;
	struct knfsd_fh		dl_fh;
	int			dl_retries;
	struct nfsd4_callback	dl_recall;
};

/* client delegation callback info */
struct nfs4_cb_conn {
	/* SETCLIENTID info */
	struct sockaddr_storage	cb_addr;
	struct sockaddr_storage	cb_saddr;
	size_t			cb_addrlen;
	u32                     cb_prog; /* used only in 4.0 case;
					    per-session otherwise */
	u32                     cb_ident;	/* minorversion 0 only */
	struct svc_xprt		*cb_xprt;	/* minorversion 1 only */
};

/* Maximum number of slots per session. 160 is useful for long haul TCP */
#define NFSD_MAX_SLOTS_PER_SESSION     160
/* Maximum number of operations per session compound */
#define NFSD_MAX_OPS_PER_COMPOUND	16
/* Maximum  session per slot cache size */
#define NFSD_SLOT_CACHE_SIZE		1024
/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION	32
#define NFSD_MAX_MEM_PER_SESSION  \
		(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)

struct nfsd4_slot {
	bool	sl_inuse;
	bool	sl_cachethis;
	u16	sl_opcnt;
	u32	sl_seqid;
	__be32	sl_status;
	u32	sl_datalen;
	char	sl_data[];
};

struct nfsd4_channel_attrs {
	u32		headerpadsz;
	u32		maxreq_sz;
	u32		maxresp_sz;
	u32		maxresp_cached;
	u32		maxops;
	u32		maxreqs;
	u32		nr_rdma_attrs;
	u32		rdma_attrs;
};

struct nfsd4_create_session {
	clientid_t			clientid;
	struct nfs4_sessionid		sessionid;
	u32				seqid;
	u32				flags;
	struct nfsd4_channel_attrs	fore_channel;
	struct nfsd4_channel_attrs	back_channel;
	u32				callback_prog;
	u32				uid;
	u32				gid;
};

struct nfsd4_bind_conn_to_session {
	struct nfs4_sessionid		sessionid;
	u32				dir;
};

/* The single slot clientid cache structure */
struct nfsd4_clid_slot {
	u32				sl_seqid;
	__be32				sl_status;
	struct nfsd4_create_session	sl_cr_ses;
};

struct nfsd4_conn {
	struct list_head cn_persession;
	struct svc_xprt *cn_xprt;
	struct svc_xpt_user cn_xpt_user;
	struct nfsd4_session *cn_session;
/* CDFC4_FORE, CDFC4_BACK: */
	unsigned char cn_flags;
};

struct nfsd4_session {
	struct kref		se_ref;
	struct list_head	se_hash;	/* hash by sessionid */
	struct list_head	se_perclnt;
	u32			se_flags;
	struct nfs4_client	*se_client;
	struct nfs4_sessionid	se_sessionid;
	struct nfsd4_channel_attrs se_fchannel;
	struct nfsd4_channel_attrs se_bchannel;
	struct list_head	se_conns;
	u32			se_cb_prog;
	u32			se_cb_seq_nr;
	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
};

static inline void
nfsd4_put_session(struct nfsd4_session *ses)
{
	extern void free_session(struct kref *kref);
	kref_put(&ses->se_ref, free_session);
}

static inline void
nfsd4_get_session(struct nfsd4_session *ses)
{
	kref_get(&ses->se_ref);
}

/* formatted contents of nfs4_sessionid */
struct nfsd4_sessionid {
	clientid_t	clientid;
	u32		sequence;
	u32		reserved;
};

#define HEXDIR_LEN     33 /* hex version of 16 byte md5 of cl_name plus '\0' */

/*
 * struct nfs4_client - one per client.  Clientids live here.
 * 	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 list_head	cl_idhash; 	/* hash by cl_clientid.id */
	struct list_head	cl_strhash; 	/* hash by cl_name */
	struct list_head	cl_openowners;
	struct list_head	cl_delegations;
	struct list_head        cl_lru;         /* tail queue */
	struct xdr_netobj	cl_name; 	/* id generated by client */
	char                    cl_recdir[HEXDIR_LEN]; /* recovery dir */
	nfs4_verifier		cl_verifier; 	/* generated by client */
	time_t                  cl_time;        /* time of last lease renewal */
	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
	u32			cl_flavor;	/* setclientid pseudoflavor */
	char			*cl_principal;	/* setclientid principal name */
	struct svc_cred		cl_cred; 	/* setclientid principal */
	clientid_t		cl_clientid;	/* generated by server */
	nfs4_verifier		cl_confirm;	/* generated by server */
	u32			cl_firststate;	/* recovery dir creation */
	u32			cl_minorversion;

	/* for v4.0 and v4.1 callbacks: */
	struct nfs4_cb_conn	cl_cb_conn;
#define NFSD4_CLIENT_CB_UPDATE	1
#define NFSD4_CLIENT_KILL	2
	unsigned long		cl_cb_flags;
	struct rpc_clnt		*cl_cb_client;
	u32			cl_cb_ident;
#define NFSD4_CB_UP		0
#define NFSD4_CB_UNKNOWN	1
#define NFSD4_CB_DOWN		2
	int			cl_cb_state;
	struct nfsd4_callback	cl_cb_null;
	struct nfsd4_session	*cl_cb_session;
	struct list_head	cl_callbacks; /* list of in-progress callbacks */

	/* for all client information that callback code might need: */
	spinlock_t		cl_lock;

	/* for nfs41 */
	struct list_head	cl_sessions;
	struct nfsd4_clid_slot	cl_cs_slot;	/* create_session slot */
	u32			cl_exchange_flags;
	/* number of rpc's in progress over an associated session: */
	atomic_t		cl_refcount;

	/* for nfs41 callbacks */
	/* We currently support a single back channel with a single slot */
	unsigned long		cl_cb_slot_busy;
	struct rpc_wait_queue	cl_cb_waitq;	/* backchannel callers may */
						/* wait here for slots */
};

static inline void
mark_client_expired(struct nfs4_client *clp)
{
	clp->cl_time = 0;
}

static inline bool
is_client_expired(struct nfs4_client *clp)
{
	return clp->cl_time == 0;
}

/* 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 {
	struct list_head	cr_strhash;	/* hash by cr_name */
	char			cr_recdir[HEXDIR_LEN]; /* recover dir */
};

static inline void
update_stateid(stateid_t *stateid)
{
	stateid->si_generation++;
	/* Wraparound recommendation from 3530bis-13 9.1.3.2: */
	if (stateid->si_generation == 0)
		stateid->si_generation = 1;
}

/* 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       112 

/*
 * Replay buffer, where the result of the last seqid-mutating operation 
 * is cached. 
 */
struct nfs4_replay {
	__be32			rp_status;
	unsigned int		rp_buflen;
	char			*rp_buf;
	struct knfsd_fh		rp_openfh;
	char			rp_ibuf[NFSD4_REPLAY_ISIZE];
};

/*
* nfs4_stateowner can either be an open_owner, or a lock_owner
*
*    so_idhash:  stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
*         for lock_owner
*    so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
*         for lock_owner
*    so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
*         struct is reaped.
*    so_perfilestate: heads the list of nfs4_ol_stateid (either open or lock) 
*         and is used to ensure no dangling nfs4_ol_stateid references when we 
*         release a stateowner.
*    so_perlockowner: (open) nfs4_ol_stateid->st_perlockowner entry - used when
*         close is called to reap associated byte-range locks
*    so_close_lru: (open) stateowner is placed on this list instead of being
*         reaped (when so_perfilestate is empty) to hold the last close replay.
*         reaped by laundramat thread after lease period.
*/

struct nfs4_stateowner {
	struct list_head        so_idhash;   /* hash by so_id */
	struct list_head        so_strhash;   /* hash by op_name */
	struct list_head        so_stateids;
	int			so_is_open_owner; /* 1=openowner,0=lockowner */
	u32                     so_id;
	struct nfs4_client *    so_client;
	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
	 * sequence id expected from the client: */
	u32                     so_seqid;
	struct xdr_netobj       so_owner;     /* open owner name */
	struct nfs4_replay	so_replay;
};

struct nfs4_openowner {
	struct nfs4_stateowner	oo_owner; /* must be first field */
	struct list_head        oo_perclient;
	struct list_head	oo_close_lru; /* tail queue */
	time_t			oo_time; /* time of placement on so_close_lru */
	int                     oo_confirmed; /* successful OPEN_CONFIRM? */
};

struct nfs4_lockowner {
	struct nfs4_stateowner	lo_owner; /* must be first element */
	struct list_head        lo_perstateid; /* for lockowners only */
	struct list_head	lo_list; /* for temporary uses */
};

static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
{
	return container_of(so, struct nfs4_openowner, oo_owner);
}

static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
{
	return container_of(so, struct nfs4_lockowner, lo_owner);
}

/*
*  nfs4_file: a file opened by some number of (open) nfs4_stateowners.
*    o fi_perfile list is used to search for conflicting 
*      share_acces, share_deny on the file.
*/
struct nfs4_file {
	atomic_t		fi_ref;
	struct list_head        fi_hash;    /* hash by "struct inode *" */
	struct list_head        fi_stateids;
	struct list_head	fi_delegations;
	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
	struct file *		fi_fds[3];
	/*
	 * Each open or lock stateid contributes 1 to either
	 * fi_access[O_RDONLY], fi_access[O_WRONLY], or both, depending
	 * on open or lock mode:
	 */
	atomic_t		fi_access[2];
	struct file		*fi_deleg_file;
	struct file_lock	*fi_lease;
	atomic_t		fi_delegees;
	struct inode		*fi_inode;
	u32                     fi_id;      /* used with stateowner->so_id 
					     * for stateid_hashtbl hash */
	bool			fi_had_conflict;
};

/* XXX: for first cut may fall back on returning file that doesn't work
 * at all? */
static inline struct file *find_writeable_file(struct nfs4_file *f)
{
	if (f->fi_fds[O_WRONLY])
		return f->fi_fds[O_WRONLY];
	return f->fi_fds[O_RDWR];
}

static inline struct file *find_readable_file(struct nfs4_file *f)
{
	if (f->fi_fds[O_RDONLY])
		return f->fi_fds[O_RDONLY];
	return f->fi_fds[O_RDWR];
}

static inline struct file *find_any_file(struct nfs4_file *f)
{
	if (f->fi_fds[O_RDWR])
		return f->fi_fds[O_RDWR];
	else if (f->fi_fds[O_WRONLY])
		return f->fi_fds[O_WRONLY];
	else
		return f->fi_fds[O_RDONLY];
}

/*
* nfs4_ol_stateid can either be an open stateid or (eventually) a lock stateid
*
* (open)nfs4_ol_stateid: one per (open)nfs4_stateowner, nfs4_file
*
* 	st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
* 	st_perfile: file_hashtbl[] entry.
* 	st_perfile_state: nfs4_stateowner->so_perfilestate
*       st_perlockowner: (open stateid) list of lock nfs4_stateowners
* 	st_access_bmap: used only for open stateid
* 	st_deny_bmap: used only for open stateid
*	st_openstp: open stateid lock stateid was derived from
*
* XXX: open stateids and lock stateids have diverged sufficiently that
* we should consider defining separate structs for the two cases.
*/

/* "ol" stands for "Open or Lock".  Better suggestions welcome. */
struct nfs4_ol_stateid {
	struct nfs4_stid    st_stid;
	struct list_head              st_perfile;
	struct list_head              st_perstateowner;
	struct list_head              st_lockowners;
	struct nfs4_stateowner      * st_stateowner;
	struct nfs4_file            * st_file;
	unsigned long                 st_access_bmap;
	unsigned long                 st_deny_bmap;
	struct nfs4_ol_stateid         * st_openstp;
};

static inline struct nfs4_ol_stateid *openlockstateid(struct nfs4_stid *s)
{
	return container_of(s, struct nfs4_ol_stateid, st_stid);
}

/* flags for preprocess_seqid_op() */
#define RD_STATE	        0x00000010
#define WR_STATE	        0x00000020

struct nfsd4_compound_state;

extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
		stateid_t *stateid, int flags, struct file **filp);
extern void nfs4_lock_state(void);
extern void nfs4_unlock_state(void);
extern int nfs4_in_grace(void);
extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
extern void nfs4_free_openowner(struct nfs4_openowner *);
extern void nfs4_free_lockowner(struct nfs4_lockowner *);
extern int set_callback_cred(void);
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_do_callback_rpc(struct work_struct *);
extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
extern int nfsd4_create_callback_queue(void);
extern void nfsd4_destroy_callback_queue(void);
extern void nfsd4_shutdown_callback(struct nfs4_client *);
extern void nfs4_put_delegation(struct nfs4_delegation *dp);
extern __be32 nfs4_make_rec_clidname(char *clidname, struct xdr_netobj *clname);
extern void nfsd4_init_recdir(void);
extern int nfsd4_recdir_load(void);
extern void nfsd4_shutdown_recdir(void);
extern int nfs4_client_to_reclaim(const char *name);
extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
extern void nfsd4_recdir_purge_old(void);
extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
extern void release_session_client(struct nfsd4_session *);
extern __be32 nfs4_validate_stateid(stateid_t *, bool);

#endif   /* NFSD4_STATE_H */
Commit	Line	Data
1da177e4	1	/*
1da177e4 LT	2	* Copyright (c) 2001 The Regents of the University of Michigan.
	3	* All rights reserved.
	4	*
	5	* Kendrick Smith <kmsmith@umich.edu>
	6	* Andy Adamson <andros@umich.edu>
	7	*
	8	* Redistribution and use in source and binary forms, with or without
	9	* modification, are permitted provided that the following conditions
	10	* are met:
	11	*
	12	* 1. Redistributions of source code must retain the above copyright
	13	* notice, this list of conditions and the following disclaimer.
	14	* 2. Redistributions in binary form must reproduce the above copyright
	15	* notice, this list of conditions and the following disclaimer in the
	16	* documentation and/or other materials provided with the distribution.
	17	* 3. Neither the name of the University nor the names of its
	18	* contributors may be used to endorse or promote products derived
	19	* from this software without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED
	22	* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
	23	* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
	24	* DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	25	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
	26	* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
	27	* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
	28	* BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
	29	* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
	30	* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
	31	* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
	32	*
	33	*/
	34
	35	#ifndef _NFSD4_STATE_H
	36	#define _NFSD4_STATE_H
	37
19cf5c02	38	#include <linux/sunrpc/svc_xprt.h>
72579ac9	39	#include <linux/nfsd/nfsfh.h>
1557aca7	40	#include "nfsfh.h"
1da177e4	41
1da177e4 LT	42	typedef struct {
	43	u32 cl_boot;
	44	u32 cl_id;
	45	} clientid_t;
	46
	47	typedef struct {
	48	u32 so_boot;
	49	u32 so_stateownerid;
	50	u32 so_fileid;
	51	} stateid_opaque_t;
	52
	53	typedef struct {
	54	u32 si_generation;
	55	stateid_opaque_t si_opaque;
	56	} stateid_t;
	57	#define si_boot si_opaque.so_boot
	58	#define si_stateownerid si_opaque.so_stateownerid
	59	#define si_fileid si_opaque.so_fileid
	60
8c10cbdb BH	61	#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
	62	#define STATEID_VAL(s) \
	63	(s)->si_boot, \
	64	(s)->si_stateownerid, \
	65	(s)->si_fileid, \
	66	(s)->si_generation
	67
227f98d9	68	struct nfsd4_callback {
fb003923 BF	69	void *cb_op;
fb003923 BF	70	struct nfs4_client *cb_clp;
5ce8ba25	71	struct list_head cb_per_client;
fb003923	72	u32 cb_minorversion;
5878453d BF	73	struct rpc_message cb_msg;
5878453d BF	74	const struct rpc_call_ops *cb_ops;
b5a1a81e	75	struct work_struct cb_work;
5ce8ba25	76	bool cb_done;
227f98d9 BF	77	};
227f98d9 BF	78
d5477a8d BF	79	struct nfs4_stid {
	80	#define NFS4_OPEN_STID 1
	81	#define NFS4_LOCK_STID 2
	82	#define NFS4_DELEG_STID 4
	83	char sc_type;
	84	struct list_head sc_hash;
	85	stateid_t sc_stateid;
	86	};
	87
1da177e4	88	struct nfs4_delegation {
ea1da636 N	89	struct list_head dl_perfile;
ea1da636 N	90	struct list_head dl_perclnt;
1da177e4 LT	91	struct list_head dl_recall_lru; /* delegation recalled */
	92	atomic_t dl_count; /* ref count */
	93	struct nfs4_client *dl_client;
	94	struct nfs4_file *dl_file;
1da177e4 LT	95	u32 dl_type;
1da177e4 LT	96	time_t dl_time;
b53d40c5	97	/* For recall: */
d5477a8d	98	struct nfs4_stid dl_stid;
b53d40c5	99	struct knfsd_fh dl_fh;
3aea09dc	100	int dl_retries;
227f98d9	101	struct nfsd4_callback dl_recall;
1da177e4 LT	102	};
1da177e4 LT	103
1da177e4	104	/* client delegation callback info */
c237dc03	105	struct nfs4_cb_conn {
1da177e4	106	/* SETCLIENTID info */
aa9a4ec7	107	struct sockaddr_storage cb_addr;
6f3d772f	108	struct sockaddr_storage cb_saddr;
aa9a4ec7	109	size_t cb_addrlen;
8b5ce5cd BF	110	u32 cb_prog; /* used only in 4.0 case;
8b5ce5cd BF	111	per-session otherwise */
ab52ae6d	112	u32 cb_ident; /* minorversion 0 only */
2bf23875	113	struct svc_xprt cb_xprt; / minorversion 1 only */
1da177e4 LT	114	};
1da177e4 LT	115
a649637c AA	116	/* Maximum number of slots per session. 160 is useful for long haul TCP */
a649637c AA	117	#define NFSD_MAX_SLOTS_PER_SESSION 160
ec6b5d7b AA	118	/* Maximum number of operations per session compound */
ec6b5d7b AA	119	#define NFSD_MAX_OPS_PER_COMPOUND 16
557ce264 AA	120	/* Maximum session per slot cache size */
557ce264 AA	121	#define NFSD_SLOT_CACHE_SIZE 1024
a649637c AA	122	/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
	123	#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
	124	#define NFSD_MAX_MEM_PER_SESSION \
	125	(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
074fe897	126
7116ed6b	127	struct nfsd4_slot {
557ce264 AA	128	bool sl_inuse;
	129	bool sl_cachethis;
	130	u16 sl_opcnt;
	131	u32 sl_seqid;
	132	__be32 sl_status;
	133	u32 sl_datalen;
	134	char sl_data[];
7116ed6b AA	135	};
7116ed6b AA	136
6c18ba9f AB	137	struct nfsd4_channel_attrs {
	138	u32 headerpadsz;
	139	u32 maxreq_sz;
	140	u32 maxresp_sz;
	141	u32 maxresp_cached;
	142	u32 maxops;
	143	u32 maxreqs;
	144	u32 nr_rdma_attrs;
	145	u32 rdma_attrs;
	146	};
	147
49557cc7 AA	148	struct nfsd4_create_session {
	149	clientid_t clientid;
	150	struct nfs4_sessionid sessionid;
	151	u32 seqid;
	152	u32 flags;
	153	struct nfsd4_channel_attrs fore_channel;
	154	struct nfsd4_channel_attrs back_channel;
	155	u32 callback_prog;
	156	u32 uid;
	157	u32 gid;
	158	};
	159
1d1bc8f2 BF	160	struct nfsd4_bind_conn_to_session {
	161	struct nfs4_sessionid sessionid;
	162	u32 dir;
	163	};
	164
49557cc7 AA	165	/* The single slot clientid cache structure */
	166	struct nfsd4_clid_slot {
	167	u32 sl_seqid;
	168	__be32 sl_status;
	169	struct nfsd4_create_session sl_cr_ses;
	170	};
	171
c7662518 BF	172	struct nfsd4_conn {
	173	struct list_head cn_persession;
	174	struct svc_xprt *cn_xprt;
19cf5c02 BF	175	struct svc_xpt_user cn_xpt_user;
19cf5c02 BF	176	struct nfsd4_session *cn_session;
c7662518 BF	177	/* CDFC4_FORE, CDFC4_BACK: */
	178	unsigned char cn_flags;
	179	};
	180
7116ed6b AA	181	struct nfsd4_session {
	182	struct kref se_ref;
	183	struct list_head se_hash; /* hash by sessionid */
	184	struct list_head se_perclnt;
	185	u32 se_flags;
07cd4909	186	struct nfs4_client *se_client;
7116ed6b	187	struct nfs4_sessionid se_sessionid;
6c18ba9f AB	188	struct nfsd4_channel_attrs se_fchannel;
6c18ba9f AB	189	struct nfsd4_channel_attrs se_bchannel;
c7662518	190	struct list_head se_conns;
8b5ce5cd	191	u32 se_cb_prog;
ac7c46f2	192	u32 se_cb_seq_nr;
557ce264	193	struct nfsd4_slot se_slots[]; / forward channel slots */
7116ed6b AA	194	};
	195
	196	static inline void
	197	nfsd4_put_session(struct nfsd4_session *ses)
	198	{
	199	extern void free_session(struct kref *kref);
	200	kref_put(&ses->se_ref, free_session);
	201	}
	202
	203	static inline void
	204	nfsd4_get_session(struct nfsd4_session *ses)
	205	{
	206	kref_get(&ses->se_ref);
	207	}
	208
5282fd72 ME	209	/* formatted contents of nfs4_sessionid */
	210	struct nfsd4_sessionid {
	211	clientid_t clientid;
	212	u32 sequence;
	213	u32 reserved;
	214	};
	215
a55370a3 N	216	#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
a55370a3 N	217
1da177e4 LT	218	/*
	219	* struct nfs4_client - one per client. Clientids live here.
	220	* o Each nfs4_client is hashed by clientid.
	221	*
	222	* o Each nfs4_clients is also hashed by name
	223	* (the opaque quantity initially sent by the client to identify itself).
	224	*
	225	* o cl_perclient list is used to ensure no dangling stateowner references
	226	* when we expire the nfs4_client
	227	*/
	228	struct nfs4_client {
	229	struct list_head cl_idhash; /* hash by cl_clientid.id */
	230	struct list_head cl_strhash; /* hash by cl_name */
ea1da636 N	231	struct list_head cl_openowners;
ea1da636 N	232	struct list_head cl_delegations;
1da177e4 LT	233	struct list_head cl_lru; /* tail queue */
1da177e4 LT	234	struct xdr_netobj cl_name; /* id generated by client */
a55370a3	235	char cl_recdir[HEXDIR_LEN]; /* recovery dir */
1da177e4 LT	236	nfs4_verifier cl_verifier; /* generated by client */
1da177e4 LT	237	time_t cl_time; /* time of last lease renewal */
363168b4	238	struct sockaddr_storage cl_addr; /* client ipaddress */
61054b14	239	u32 cl_flavor; /* setclientid pseudoflavor */
68e76ad0	240	char cl_principal; / setclientid principal name */
1da177e4 LT	241	struct svc_cred cl_cred; /* setclientid principal */
	242	clientid_t cl_clientid; /* generated by server */
	243	nfs4_verifier cl_confirm; /* generated by server */
c7b9a459	244	u32 cl_firststate; /* recovery dir creation */
8323c3b2	245	u32 cl_minorversion;
9fb87070	246
2bf23875 BF	247	/* for v4.0 and v4.1 callbacks: */
2bf23875 BF	248	struct nfs4_cb_conn cl_cb_conn;
6ff8da08 BF	249	#define NFSD4_CLIENT_CB_UPDATE 1
	250	#define NFSD4_CLIENT_KILL 2
	251	unsigned long cl_cb_flags;
2bf23875	252	struct rpc_clnt *cl_cb_client;
6ff8da08	253	u32 cl_cb_ident;
77a3569d BF	254	#define NFSD4_CB_UP 0
	255	#define NFSD4_CB_UNKNOWN 1
	256	#define NFSD4_CB_DOWN 2
	257	int cl_cb_state;
cee277d9	258	struct nfsd4_callback cl_cb_null;
edd76786	259	struct nfsd4_session *cl_cb_session;
5ce8ba25	260	struct list_head cl_callbacks; /* list of in-progress callbacks */
2bf23875	261
6ff8da08 BF	262	/* for all client information that callback code might need: */
	263	spinlock_t cl_lock;
	264
9fb87070 ME	265	/* for nfs41 */
9fb87070 ME	266	struct list_head cl_sessions;
49557cc7	267	struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
0733d213	268	u32 cl_exchange_flags;
46583e25 BH	269	/* number of rpc's in progress over an associated session: */
46583e25 BH	270	atomic_t cl_refcount;
38524ab3 AA	271
38524ab3 AA	272	/* for nfs41 callbacks */
199ff35e RL	273	/* We currently support a single back channel with a single slot */
199ff35e RL	274	unsigned long cl_cb_slot_busy;
199ff35e RL	275	struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
199ff35e RL	276	/* wait here for slots */
1da177e4 LT	277	};
1da177e4 LT	278
07cd4909 BH	279	static inline void
	280	mark_client_expired(struct nfs4_client *clp)
	281	{
	282	clp->cl_time = 0;
	283	}
	284
	285	static inline bool
	286	is_client_expired(struct nfs4_client *clp)
	287	{
	288	return clp->cl_time == 0;
	289	}
	290
1da177e4 LT	291	/* struct nfs4_client_reset
	292	* one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
	293	* upon lease reset, or from upcall to state_daemon (to read in state
	294	* from non-volitile storage) upon reboot.
	295	*/
	296	struct nfs4_client_reclaim {
	297	struct list_head cr_strhash; /* hash by cr_name */
a55370a3	298	char cr_recdir[HEXDIR_LEN]; /* recover dir */
1da177e4 LT	299	};
	300
	301	static inline void
	302	update_stateid(stateid_t *stateid)
	303	{
	304	stateid->si_generation++;
81b82965 BF	305	/* Wraparound recommendation from 3530bis-13 9.1.3.2: */
	306	if (stateid->si_generation == 0)
	307	stateid->si_generation = 1;
1da177e4 LT	308	}
	309
	310	/* A reasonable value for REPLAY_ISIZE was estimated as follows:
	311	* The OPEN response, typically the largest, requires
	312	* 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
	313	* 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
	314	* 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
	315	*/
	316
	317	#define NFSD4_REPLAY_ISIZE 112
	318
	319	/*
	320	* Replay buffer, where the result of the last seqid-mutating operation
	321	* is cached.
	322	*/
	323	struct nfs4_replay {
b37ad28b	324	__be32 rp_status;
1da177e4 LT	325	unsigned int rp_buflen;
1da177e4 LT	326	char *rp_buf;
a4773c08	327	struct knfsd_fh rp_openfh;
1da177e4 LT	328	char rp_ibuf[NFSD4_REPLAY_ISIZE];
	329	};
	330
	331	/*
	332	* nfs4_stateowner can either be an open_owner, or a lock_owner
	333	*
	334	* so_idhash: stateid_hashtbl[] for open owner, lockstateid_hashtbl[]
	335	* for lock_owner
	336	* so_strhash: ownerstr_hashtbl[] for open_owner, lock_ownerstr_hashtbl[]
	337	* for lock_owner
	338	* so_perclient: nfs4_client->cl_perclient entry - used when nfs4_client
	339	* struct is reaped.
dcef0413 BF	340	* so_perfilestate: heads the list of nfs4_ol_stateid (either open or lock)
dcef0413 BF	341	* and is used to ensure no dangling nfs4_ol_stateid references when we
1da177e4	342	* release a stateowner.
dcef0413	343	* so_perlockowner: (open) nfs4_ol_stateid->st_perlockowner entry - used when
1da177e4 LT	344	* close is called to reap associated byte-range locks
	345	* so_close_lru: (open) stateowner is placed on this list instead of being
	346	* reaped (when so_perfilestate is empty) to hold the last close replay.
	347	* reaped by laundramat thread after lease period.
	348	*/
fe0750e5	349
1da177e4	350	struct nfs4_stateowner {
1da177e4 LT	351	struct list_head so_idhash; /* hash by so_id */
1da177e4 LT	352	struct list_head so_strhash; /* hash by op_name */
ea1da636	353	struct list_head so_stateids;
1da177e4 LT	354	int so_is_open_owner; /* 1=openowner,0=lockowner */
	355	u32 so_id;
	356	struct nfs4_client * so_client;
7fb64cee N	357	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
	358	* sequence id expected from the client: */
	359	u32 so_seqid;
1da177e4	360	struct xdr_netobj so_owner; /* open owner name */
1da177e4 LT	361	struct nfs4_replay so_replay;
	362	};
	363
fe0750e5 BF	364	struct nfs4_openowner {
	365	struct nfs4_stateowner oo_owner; /* must be first field */
	366	struct list_head oo_perclient;
	367	struct list_head oo_close_lru; /* tail queue */
	368	time_t oo_time; /* time of placement on so_close_lru */
	369	int oo_confirmed; /* successful OPEN_CONFIRM? */
	370	};
	371
	372	struct nfs4_lockowner {
	373	struct nfs4_stateowner lo_owner; /* must be first element */
	374	struct list_head lo_perstateid; /* for lockowners only */
	375	struct list_head lo_list; /* for temporary uses */
	376	};
	377
	378	static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
	379	{
	380	return container_of(so, struct nfs4_openowner, oo_owner);
	381	}
	382
	383	static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
	384	{
	385	return container_of(so, struct nfs4_lockowner, lo_owner);
	386	}
	387
1da177e4 LT	388	/*
	389	* nfs4_file: a file opened by some number of (open) nfs4_stateowners.
	390	* o fi_perfile list is used to search for conflicting
	391	* share_acces, share_deny on the file.
	392	*/
	393	struct nfs4_file {
8b671b80	394	atomic_t fi_ref;
1da177e4	395	struct list_head fi_hash; /* hash by "struct inode " /
8beefa24 N	396	struct list_head fi_stateids;
8beefa24 N	397	struct list_head fi_delegations;
f9d7562f BF	398	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
f9d7562f BF	399	struct file * fi_fds[3];
f9d7562f	400	/*
9ae78bcc BF	401	* Each open or lock stateid contributes 1 to either
	402	* fi_access[O_RDONLY], fi_access[O_WRONLY], or both, depending
	403	* on open or lock mode:
f9d7562f	404	*/
9ae78bcc	405	atomic_t fi_access[2];
acfdf5c3 BF	406	struct file *fi_deleg_file;
	407	struct file_lock *fi_lease;
	408	atomic_t fi_delegees;
1da177e4 LT	409	struct inode *fi_inode;
	410	u32 fi_id; /* used with stateowner->so_id
	411	* for stateid_hashtbl hash */
47f9940c	412	bool fi_had_conflict;
1da177e4 LT	413	};
1da177e4 LT	414
f9d7562f BF	415	/* XXX: for first cut may fall back on returning file that doesn't work
	416	* at all? */
	417	static inline struct file find_writeable_file(struct nfs4_file f)
	418	{
7d947842 BF	419	if (f->fi_fds[O_WRONLY])
	420	return f->fi_fds[O_WRONLY];
	421	return f->fi_fds[O_RDWR];
f9d7562f BF	422	}
	423
	424	static inline struct file find_readable_file(struct nfs4_file f)
	425	{
7d947842 BF	426	if (f->fi_fds[O_RDONLY])
	427	return f->fi_fds[O_RDONLY];
	428	return f->fi_fds[O_RDWR];
f9d7562f BF	429	}
	430
	431	static inline struct file find_any_file(struct nfs4_file f)
	432	{
	433	if (f->fi_fds[O_RDWR])
	434	return f->fi_fds[O_RDWR];
18608ad4	435	else if (f->fi_fds[O_WRONLY])
f9d7562f BF	436	return f->fi_fds[O_WRONLY];
	437	else
	438	return f->fi_fds[O_RDONLY];
	439	}
	440
1da177e4	441	/*
dcef0413	442	* nfs4_ol_stateid can either be an open stateid or (eventually) a lock stateid
1da177e4	443	*
dcef0413	444	* (open)nfs4_ol_stateid: one per (open)nfs4_stateowner, nfs4_file
1da177e4 LT	445	*
	446	* st_hash: stateid_hashtbl[] entry or lockstateid_hashtbl entry
	447	* st_perfile: file_hashtbl[] entry.
	448	* st_perfile_state: nfs4_stateowner->so_perfilestate
	449	* st_perlockowner: (open stateid) list of lock nfs4_stateowners
	450	* st_access_bmap: used only for open stateid
	451	* st_deny_bmap: used only for open stateid
4c4cd222 N	452	* st_openstp: open stateid lock stateid was derived from
	453	*
	454	* XXX: open stateids and lock stateids have diverged sufficiently that
	455	* we should consider defining separate structs for the two cases.
1da177e4 LT	456	*/
1da177e4 LT	457
d5477a8d	458	/* "ol" stands for "Open or Lock". Better suggestions welcome. */
dcef0413 BF	459	struct nfs4_ol_stateid {
dcef0413 BF	460	struct nfs4_stid st_stid;
1da177e4	461	struct list_head st_perfile;
ea1da636 N	462	struct list_head st_perstateowner;
ea1da636 N	463	struct list_head st_lockowners;
1da177e4 LT	464	struct nfs4_stateowner * st_stateowner;
1da177e4 LT	465	struct nfs4_file * st_file;
1da177e4 LT	466	unsigned long st_access_bmap;
1da177e4 LT	467	unsigned long st_deny_bmap;
dcef0413	468	struct nfs4_ol_stateid * st_openstp;
1da177e4 LT	469	};
1da177e4 LT	470
dcef0413 BF	471	static inline struct nfs4_ol_stateid openlockstateid(struct nfs4_stid s)
	472	{
	473	return container_of(s, struct nfs4_ol_stateid, st_stid);
	474	}
	475
1da177e4	476	/* flags for preprocess_seqid_op() */
1da177e4 LT	477	#define RD_STATE 0x00000010
1da177e4 LT	478	#define WR_STATE 0x00000020
1da177e4	479
dd453dfd BH	480	struct nfsd4_compound_state;
	481
	482	extern __be32 nfs4_preprocess_stateid_op(struct nfsd4_compound_state *cstate,
1da177e4	483	stateid_t stateid, int flags, struct file *filp);
1da177e4 LT	484	extern void nfs4_lock_state(void);
	485	extern void nfs4_unlock_state(void);
	486	extern int nfs4_in_grace(void);
b37ad28b	487	extern __be32 nfs4_check_open_reclaim(clientid_t *clid);
fe0750e5 BF	488	extern void nfs4_free_openowner(struct nfs4_openowner *);
fe0750e5 BF	489	extern void nfs4_free_lockowner(struct nfs4_lockowner *);
80fc015b	490	extern int set_callback_cred(void);
5a3c9d71	491	extern void nfsd4_probe_callback(struct nfs4_client *clp);
84f5f7cc	492	extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
5a3c9d71	493	extern void nfsd4_change_callback(struct nfs4_client clp, struct nfs4_cb_conn );
b5a1a81e	494	extern void nfsd4_do_callback_rpc(struct work_struct *);
1da177e4	495	extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
b5a1a81e BF	496	extern int nfsd4_create_callback_queue(void);
b5a1a81e BF	497	extern void nfsd4_destroy_callback_queue(void);
6ff8da08	498	extern void nfsd4_shutdown_callback(struct nfs4_client *);
1da177e4	499	extern void nfs4_put_delegation(struct nfs4_delegation *dp);
b37ad28b	500	extern __be32 nfs4_make_rec_clidname(char clidname, struct xdr_netobj clname);
48483bf2	501	extern void nfsd4_init_recdir(void);
190e4fbf N	502	extern int nfsd4_recdir_load(void);
	503	extern void nfsd4_shutdown_recdir(void);
	504	extern int nfs4_client_to_reclaim(const char *name);
a1bcecd2	505	extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
c7b9a459 N	506	extern void nfsd4_recdir_purge_old(void);
	507	extern int nfsd4_create_clid_dir(struct nfs4_client *clp);
	508	extern void nfsd4_remove_clid_dir(struct nfs4_client *clp);
d7682988	509	extern void release_session_client(struct nfsd4_session *);
28dde241	510	extern __be32 nfs4_validate_stateid(stateid_t *, bool);
1da177e4	511
1da177e4	512	#endif /* NFSD4_STATE_H */