[mirror_ubuntu-bionic-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/idr.h>
#include <linux/sunrpc/svc_xprt.h>
#include "nfsfh.h"

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

typedef struct {
	clientid_t	so_clid;
	u32		so_id;
} stateid_opaque_t;

typedef struct {
	u32                     si_generation;
	stateid_opaque_t        si_opaque;
} stateid_t;

#define STATEID_FMT	"(%08x/%08x/%08x/%08x)"
#define STATEID_VAL(s) \
	(s)->si_opaque.so_clid.cl_boot, \
	(s)->si_opaque.so_clid.cl_id, \
	(s)->si_opaque.so_id, \
	(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
/* For an open stateid kept around *only* to process close replays: */
#define NFS4_CLOSED_STID 8
/* For a deleg stateid kept around only to process free_stateid's: */
#define NFS4_REVOKED_DELEG_STID 16
	unsigned char sc_type;
	stateid_t sc_stateid;
	struct nfs4_client *sc_client;
};

struct nfs4_delegation {
	struct nfs4_stid	dl_stid; /* must be first field */
	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_file	*dl_file;
	u32			dl_type;
	time_t			dl_time;
/* For recall: */
	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 */
};

static inline struct nfs4_delegation *delegstateid(struct nfs4_stid *s)
{
	return container_of(s, struct nfs4_delegation, dl_stid);
}

/* 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		2048
/* 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 {
	u32	sl_seqid;
	__be32	sl_status;
	u32	sl_datalen;
	u16	sl_opcnt;
#define NFSD4_SLOT_INUSE	(1 << 0)
#define NFSD4_SLOT_CACHETHIS	(1 << 1)
#define NFSD4_SLOT_INITIALIZED	(1 << 2)
	u8	sl_flags;
	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_cb_sec {
	u32	flavor; /* (u32)(-1) used to mean "no valid flavor" */
	kuid_t	uid;
	kgid_t	gid;
};

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;
	struct nfsd4_cb_sec		cb_sec;
};

struct nfsd4_backchannel_ctl {
	u32	bc_cb_program;
	struct nfsd4_cb_sec		bc_cb_sec;
};

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 {
	atomic_t		se_ref;
	struct list_head	se_hash;	/* hash by sessionid */
	struct list_head	se_perclnt;
/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
#define NFS4_SESSION_DEAD	0x010
	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 nfsd4_cb_sec	se_cb_sec;
	struct list_head	se_conns;
	u32			se_cb_prog;
	u32			se_cb_seq_nr;
	struct nfsd4_slot	*se_slots[];	/* forward channel slots */
};

/* 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 rb_node		cl_namenode;	/* link into by-name trees */
	struct list_head	cl_openowners;
	struct idr		cl_stateids;	/* stateid lookup */
	struct list_head	cl_delegations;
	struct list_head	cl_revoked;	/* unacknowledged, revoked 4.1 state */
	struct list_head        cl_lru;         /* tail queue */
	struct xdr_netobj	cl_name; 	/* id generated by client */
	nfs4_verifier		cl_verifier; 	/* generated by client */
	time_t                  cl_time;        /* time of last lease renewal */
	struct sockaddr_storage	cl_addr; 	/* client ipaddress */
	bool			cl_mach_cred;	/* SP4_MACH_CRED in force */
	struct svc_cred		cl_cred; 	/* setclientid principal */
	clientid_t		cl_clientid;	/* generated by server */
	nfs4_verifier		cl_confirm;	/* generated by server */
	u32			cl_minorversion;

	/* for v4.0 and v4.1 callbacks: */
	struct nfs4_cb_conn	cl_cb_conn;
#define NFSD4_CLIENT_CB_UPDATE		(0)
#define NFSD4_CLIENT_CB_KILL		(1)
#define NFSD4_CLIENT_STABLE		(2)	/* client on stable storage */
#define NFSD4_CLIENT_RECLAIM_COMPLETE	(3)	/* reclaim_complete done */
#define NFSD4_CLIENT_CONFIRMED		(4)	/* client is confirmed */
#define NFSD4_CLIENT_CB_FLAG_MASK	(1 << NFSD4_CLIENT_CB_UPDATE | \
					 1 << NFSD4_CLIENT_CB_KILL)
	unsigned long		cl_flags;
	struct rpc_cred		*cl_cb_cred;
	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
#define NFSD4_CB_FAULT		3
	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 */
	struct net		*net;
};

/* 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 */
	struct nfs4_client	*cr_clp;	/* pointer to associated clp */
	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];
};

struct nfs4_stateowner {
	struct list_head        so_strhash;   /* hash by op_name */
	struct list_head        so_stateids;
	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;
	bool			so_is_open_owner;
};

struct nfs4_openowner {
	struct nfs4_stateowner	oo_owner; /* must be first field */
	struct list_head        oo_perclient;
	/*
	 * We keep around openowners a little while after last close,
	 * which saves clients from having to confirm, and allows us to
	 * handle close replays if they come soon enough.  The close_lru
	 * is a list of such openowners, to be reaped by the laundromat
	 * thread eventually if they remain unused:
	 */
	struct list_head	oo_close_lru;
	struct nfs4_ol_stateid *oo_last_closed_stid;
	time_t			oo_time; /* time of placement on so_close_lru */
#define NFS4_OO_CONFIRMED   1
#define NFS4_OO_NEW         4
	unsigned char		oo_flags;
};

struct nfs4_lockowner {
	struct nfs4_stateowner	lo_owner; /* must be first element */
};

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. */
struct nfs4_file {
	atomic_t		fi_ref;
	struct hlist_node       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 0-4 to the counts
	 * below depending on which bits are set in st_access_bitmap:
	 *     1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
	 *   + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
	 *   + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
	 */
	atomic_t		fi_access[2];
	struct file		*fi_deleg_file;
	struct file_lock	*fi_lease;
	atomic_t		fi_delegees;
	struct inode		*fi_inode;
	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];
}

/* "ol" stands for "Open or Lock".  Better suggestions welcome. */
struct nfs4_ol_stateid {
	struct nfs4_stid    st_stid; /* must be first field */
	struct list_head              st_perfile;
	struct list_head              st_perstateowner;
	struct list_head              st_locks;
	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;
struct nfsd_net;

extern __be32 nfs4_preprocess_stateid_op(struct net *net,
		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);
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(const char *recdir,
							struct nfsd_net *nn);
extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
		struct nfsd4_compound_state *cstate, struct nfsd_net *nn);
extern int set_callback_cred(void);
extern void nfsd4_init_callback(struct nfsd4_callback *);
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_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 struct nfs4_client_reclaim *nfs4_client_to_reclaim(const char *name,
							struct nfsd_net *nn);
extern bool nfs4_has_reclaimed_state(const char *name, 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, time_t boot_time);

/* nfs fault injection functions */
#ifdef CONFIG_NFSD_FAULT_INJECTION
int nfsd_fault_inject_init(void);
void nfsd_fault_inject_cleanup(void);
u64 nfsd_for_n_state(u64, u64 (*)(struct nfs4_client *, u64));
struct nfs4_client *nfsd_find_client(struct sockaddr_storage *, size_t);

u64 nfsd_forget_client(struct nfs4_client *, u64);
u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);

u64 nfsd_print_client(struct nfs4_client *, u64);
u64 nfsd_print_client_locks(struct nfs4_client *, u64);
u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
#else /* CONFIG_NFSD_FAULT_INJECTION */
static inline int nfsd_fault_inject_init(void) { return 0; }
static inline void nfsd_fault_inject_cleanup(void) {}
#endif /* CONFIG_NFSD_FAULT_INJECTION */

#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
38c2f4b1	38	#include <linux/idr.h>
19cf5c02	39	#include <linux/sunrpc/svc_xprt.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 {
d3b313a4 BF	48	clientid_t so_clid;
d3b313a4 BF	49	u32 so_id;
1da177e4 LT	50	} stateid_opaque_t;
	51
	52	typedef struct {
	53	u32 si_generation;
	54	stateid_opaque_t si_opaque;
	55	} stateid_t;
1da177e4	56
8c10cbdb BH	57	#define STATEID_FMT "(%08x/%08x/%08x/%08x)"
8c10cbdb BH	58	#define STATEID_VAL(s) \
d3b313a4 BF	59	(s)->si_opaque.so_clid.cl_boot, \
	60	(s)->si_opaque.so_clid.cl_id, \
	61	(s)->si_opaque.so_id, \
8c10cbdb BH	62	(s)->si_generation
8c10cbdb BH	63
227f98d9	64	struct nfsd4_callback {
fb003923 BF	65	void *cb_op;
fb003923 BF	66	struct nfs4_client *cb_clp;
5ce8ba25	67	struct list_head cb_per_client;
fb003923	68	u32 cb_minorversion;
5878453d BF	69	struct rpc_message cb_msg;
5878453d BF	70	const struct rpc_call_ops *cb_ops;
b5a1a81e	71	struct work_struct cb_work;
5ce8ba25	72	bool cb_done;
227f98d9 BF	73	};
227f98d9 BF	74
d5477a8d BF	75	struct nfs4_stid {
	76	#define NFS4_OPEN_STID 1
	77	#define NFS4_LOCK_STID 2
	78	#define NFS4_DELEG_STID 4
f7a4d872 BF	79	/* For an open stateid kept around only to process close replays: */
f7a4d872 BF	80	#define NFS4_CLOSED_STID 8
3bd64a5b BF	81	/* For a deleg stateid kept around only to process free_stateid's: */
3bd64a5b BF	82	#define NFS4_REVOKED_DELEG_STID 16
f7a4d872	83	unsigned char sc_type;
d5477a8d	84	stateid_t sc_stateid;
2a74aba7	85	struct nfs4_client *sc_client;
d5477a8d BF	86	};
d5477a8d BF	87
1da177e4	88	struct nfs4_delegation {
996e0938	89	struct nfs4_stid dl_stid; /* must be first field */
ea1da636 N	90	struct list_head dl_perfile;
ea1da636 N	91	struct list_head dl_perclnt;
1da177e4 LT	92	struct list_head dl_recall_lru; /* delegation recalled */
1da177e4 LT	93	atomic_t dl_count; /* ref count */
1da177e4	94	struct nfs4_file *dl_file;
1da177e4 LT	95	u32 dl_type;
1da177e4 LT	96	time_t dl_time;
b53d40c5	97	/* For recall: */
b53d40c5	98	struct knfsd_fh dl_fh;
3aea09dc	99	int dl_retries;
227f98d9	100	struct nfsd4_callback dl_recall;
1da177e4 LT	101	};
1da177e4 LT	102
1da177e4	103	/* client delegation callback info */
c237dc03	104	struct nfs4_cb_conn {
1da177e4	105	/* SETCLIENTID info */
aa9a4ec7	106	struct sockaddr_storage cb_addr;
6f3d772f	107	struct sockaddr_storage cb_saddr;
aa9a4ec7	108	size_t cb_addrlen;
8b5ce5cd BF	109	u32 cb_prog; /* used only in 4.0 case;
8b5ce5cd BF	110	per-session otherwise */
ab52ae6d	111	u32 cb_ident; /* minorversion 0 only */
2bf23875	112	struct svc_xprt cb_xprt; / minorversion 1 only */
1da177e4 LT	113	};
1da177e4 LT	114
f459e453 BF	115	static inline struct nfs4_delegation delegstateid(struct nfs4_stid s)
	116	{
	117	return container_of(s, struct nfs4_delegation, dl_stid);
	118	}
	119
a649637c AA	120	/* Maximum number of slots per session. 160 is useful for long haul TCP */
a649637c AA	121	#define NFSD_MAX_SLOTS_PER_SESSION 160
ec6b5d7b AA	122	/* Maximum number of operations per session compound */
ec6b5d7b AA	123	#define NFSD_MAX_OPS_PER_COMPOUND 16
557ce264	124	/* Maximum session per slot cache size */
24906f32	125	#define NFSD_SLOT_CACHE_SIZE 2048
a649637c AA	126	/* Maximum number of NFSD_SLOT_CACHE_SIZE slots per session */
	127	#define NFSD_CACHE_SIZE_SLOTS_PER_SESSION 32
	128	#define NFSD_MAX_MEM_PER_SESSION \
	129	(NFSD_CACHE_SIZE_SLOTS_PER_SESSION * NFSD_SLOT_CACHE_SIZE)
074fe897	130
7116ed6b	131	struct nfsd4_slot {
557ce264 AA	132	u32 sl_seqid;
	133	__be32 sl_status;
	134	u32 sl_datalen;
73e79482 BF	135	u16 sl_opcnt;
	136	#define NFSD4_SLOT_INUSE (1 << 0)
	137	#define NFSD4_SLOT_CACHETHIS (1 << 1)
bf5c43c8	138	#define NFSD4_SLOT_INITIALIZED (1 << 2)
73e79482	139	u8 sl_flags;
557ce264	140	char sl_data[];
7116ed6b AA	141	};
7116ed6b AA	142
6c18ba9f AB	143	struct nfsd4_channel_attrs {
	144	u32 headerpadsz;
	145	u32 maxreq_sz;
	146	u32 maxresp_sz;
	147	u32 maxresp_cached;
	148	u32 maxops;
	149	u32 maxreqs;
	150	u32 nr_rdma_attrs;
	151	u32 rdma_attrs;
	152	};
	153
acb2887e	154	struct nfsd4_cb_sec {
12fc3e92	155	u32 flavor; /* (u32)(-1) used to mean "no valid flavor" */
03bc6d1c EB	156	kuid_t uid;
03bc6d1c EB	157	kgid_t gid;
acb2887e BF	158	};
acb2887e BF	159
49557cc7 AA	160	struct nfsd4_create_session {
	161	clientid_t clientid;
	162	struct nfs4_sessionid sessionid;
	163	u32 seqid;
	164	u32 flags;
	165	struct nfsd4_channel_attrs fore_channel;
	166	struct nfsd4_channel_attrs back_channel;
	167	u32 callback_prog;
acb2887e	168	struct nfsd4_cb_sec cb_sec;
49557cc7 AA	169	};
49557cc7 AA	170
cb73a9f4 BF	171	struct nfsd4_backchannel_ctl {
	172	u32 bc_cb_program;
	173	struct nfsd4_cb_sec bc_cb_sec;
	174	};
	175
1d1bc8f2 BF	176	struct nfsd4_bind_conn_to_session {
	177	struct nfs4_sessionid sessionid;
	178	u32 dir;
	179	};
	180
49557cc7 AA	181	/* The single slot clientid cache structure */
	182	struct nfsd4_clid_slot {
	183	u32 sl_seqid;
	184	__be32 sl_status;
	185	struct nfsd4_create_session sl_cr_ses;
	186	};
	187
c7662518 BF	188	struct nfsd4_conn {
	189	struct list_head cn_persession;
	190	struct svc_xprt *cn_xprt;
19cf5c02 BF	191	struct svc_xpt_user cn_xpt_user;
19cf5c02 BF	192	struct nfsd4_session *cn_session;
c7662518 BF	193	/* CDFC4_FORE, CDFC4_BACK: */
	194	unsigned char cn_flags;
	195	};
	196
7116ed6b	197	struct nfsd4_session {
66b2b9b2	198	atomic_t se_ref;
7116ed6b AA	199	struct list_head se_hash; /* hash by sessionid */
7116ed6b AA	200	struct list_head se_perclnt;
66b2b9b2 BF	201	/* See SESSION4_PERSIST, etc. for standard flags; this is internal-only: */
66b2b9b2 BF	202	#define NFS4_SESSION_DEAD 0x010
7116ed6b	203	u32 se_flags;
07cd4909	204	struct nfs4_client *se_client;
7116ed6b	205	struct nfs4_sessionid se_sessionid;
6c18ba9f AB	206	struct nfsd4_channel_attrs se_fchannel;
6c18ba9f AB	207	struct nfsd4_channel_attrs se_bchannel;
acb2887e	208	struct nfsd4_cb_sec se_cb_sec;
c7662518	209	struct list_head se_conns;
8b5ce5cd	210	u32 se_cb_prog;
ac7c46f2	211	u32 se_cb_seq_nr;
557ce264	212	struct nfsd4_slot se_slots[]; / forward channel slots */
7116ed6b AA	213	};
7116ed6b AA	214
5282fd72 ME	215	/* formatted contents of nfs4_sessionid */
	216	struct nfsd4_sessionid {
	217	clientid_t clientid;
	218	u32 sequence;
	219	u32 reserved;
	220	};
	221
a55370a3 N	222	#define HEXDIR_LEN 33 /* hex version of 16 byte md5 of cl_name plus '\0' */
a55370a3 N	223
1da177e4 LT	224	/*
	225	* struct nfs4_client - one per client. Clientids live here.
	226	* o Each nfs4_client is hashed by clientid.
	227	*
	228	* o Each nfs4_clients is also hashed by name
	229	* (the opaque quantity initially sent by the client to identify itself).
	230	*
	231	* o cl_perclient list is used to ensure no dangling stateowner references
	232	* when we expire the nfs4_client
	233	*/
	234	struct nfs4_client {
	235	struct list_head cl_idhash; /* hash by cl_clientid.id */
ac55fdc4	236	struct rb_node cl_namenode; /* link into by-name trees */
ea1da636	237	struct list_head cl_openowners;
38c2f4b1	238	struct idr cl_stateids; /* stateid lookup */
ea1da636	239	struct list_head cl_delegations;
3bd64a5b	240	struct list_head cl_revoked; /* unacknowledged, revoked 4.1 state */
1da177e4 LT	241	struct list_head cl_lru; /* tail queue */
	242	struct xdr_netobj cl_name; /* id generated by client */
	243	nfs4_verifier cl_verifier; /* generated by client */
	244	time_t cl_time; /* time of last lease renewal */
363168b4	245	struct sockaddr_storage cl_addr; /* client ipaddress */
57266a6e	246	bool cl_mach_cred; /* SP4_MACH_CRED in force */
1da177e4 LT	247	struct svc_cred cl_cred; /* setclientid principal */
	248	clientid_t cl_clientid; /* generated by server */
	249	nfs4_verifier cl_confirm; /* generated by server */
8323c3b2	250	u32 cl_minorversion;
9fb87070	251
2bf23875 BF	252	/* for v4.0 and v4.1 callbacks: */
2bf23875 BF	253	struct nfs4_cb_conn cl_cb_conn;
a52d726b JL	254	#define NFSD4_CLIENT_CB_UPDATE (0)
	255	#define NFSD4_CLIENT_CB_KILL (1)
	256	#define NFSD4_CLIENT_STABLE (2) /* client on stable storage */
	257	#define NFSD4_CLIENT_RECLAIM_COMPLETE (3) /* reclaim_complete done */
ac55fdc4	258	#define NFSD4_CLIENT_CONFIRMED (4) /* client is confirmed */
a52d726b JL	259	#define NFSD4_CLIENT_CB_FLAG_MASK (1 << NFSD4_CLIENT_CB_UPDATE \| \
	260	1 << NFSD4_CLIENT_CB_KILL)
	261	unsigned long cl_flags;
c6bb3ca2	262	struct rpc_cred *cl_cb_cred;
2bf23875	263	struct rpc_clnt *cl_cb_client;
6ff8da08	264	u32 cl_cb_ident;
77a3569d BF	265	#define NFSD4_CB_UP 0
	266	#define NFSD4_CB_UNKNOWN 1
	267	#define NFSD4_CB_DOWN 2
5423732a	268	#define NFSD4_CB_FAULT 3
77a3569d	269	int cl_cb_state;
cee277d9	270	struct nfsd4_callback cl_cb_null;
edd76786	271	struct nfsd4_session *cl_cb_session;
5ce8ba25	272	struct list_head cl_callbacks; /* list of in-progress callbacks */
2bf23875	273
6ff8da08 BF	274	/* for all client information that callback code might need: */
	275	spinlock_t cl_lock;
	276
9fb87070 ME	277	/* for nfs41 */
9fb87070 ME	278	struct list_head cl_sessions;
49557cc7	279	struct nfsd4_clid_slot cl_cs_slot; /* create_session slot */
0733d213	280	u32 cl_exchange_flags;
46583e25 BH	281	/* number of rpc's in progress over an associated session: */
46583e25 BH	282	atomic_t cl_refcount;
38524ab3 AA	283
38524ab3 AA	284	/* for nfs41 callbacks */
199ff35e RL	285	/* We currently support a single back channel with a single slot */
199ff35e RL	286	unsigned long cl_cb_slot_busy;
199ff35e RL	287	struct rpc_wait_queue cl_cb_waitq; /* backchannel callers may */
199ff35e RL	288	/* wait here for slots */
c212cecf	289	struct net *net;
1da177e4 LT	290	};
	291
	292	/* struct nfs4_client_reset
	293	* one per old client. Populates reset_str_hashtbl. Filled from conf_id_hashtbl
	294	* upon lease reset, or from upcall to state_daemon (to read in state
	295	* from non-volitile storage) upon reboot.
	296	*/
	297	struct nfs4_client_reclaim {
	298	struct list_head cr_strhash; /* hash by cr_name */
0ce0c2b5	299	struct nfs4_client cr_clp; / pointer to associated clp */
a55370a3	300	char cr_recdir[HEXDIR_LEN]; /* recover dir */
1da177e4 LT	301	};
	302
	303	static inline void
	304	update_stateid(stateid_t *stateid)
	305	{
	306	stateid->si_generation++;
81b82965 BF	307	/* Wraparound recommendation from 3530bis-13 9.1.3.2: */
	308	if (stateid->si_generation == 0)
	309	stateid->si_generation = 1;
1da177e4 LT	310	}
	311
	312	/* A reasonable value for REPLAY_ISIZE was estimated as follows:
	313	* The OPEN response, typically the largest, requires
	314	* 4(status) + 8(stateid) + 20(changeinfo) + 4(rflags) + 8(verifier) +
	315	* 4(deleg. type) + 8(deleg. stateid) + 4(deleg. recall flag) +
	316	* 20(deleg. space limit) + ~32(deleg. ace) = 112 bytes
	317	*/
	318
	319	#define NFSD4_REPLAY_ISIZE 112
	320
	321	/*
	322	* Replay buffer, where the result of the last seqid-mutating operation
	323	* is cached.
	324	*/
	325	struct nfs4_replay {
b37ad28b	326	__be32 rp_status;
1da177e4 LT	327	unsigned int rp_buflen;
1da177e4 LT	328	char *rp_buf;
a4773c08	329	struct knfsd_fh rp_openfh;
1da177e4 LT	330	char rp_ibuf[NFSD4_REPLAY_ISIZE];
	331	};
	332
1da177e4	333	struct nfs4_stateowner {
1da177e4	334	struct list_head so_strhash; /* hash by op_name */
ea1da636	335	struct list_head so_stateids;
1da177e4	336	struct nfs4_client * so_client;
7fb64cee N	337	/* after increment in ENCODE_SEQID_OP_TAIL, represents the next
	338	* sequence id expected from the client: */
	339	u32 so_seqid;
1da177e4	340	struct xdr_netobj so_owner; /* open owner name */
1da177e4	341	struct nfs4_replay so_replay;
3557e43b	342	bool so_is_open_owner;
1da177e4 LT	343	};
1da177e4 LT	344
fe0750e5 BF	345	struct nfs4_openowner {
	346	struct nfs4_stateowner oo_owner; /* must be first field */
	347	struct list_head oo_perclient;
b31b30e5 BF	348	/*
	349	* We keep around openowners a little while after last close,
	350	* which saves clients from having to confirm, and allows us to
	351	* handle close replays if they come soon enough. The close_lru
	352	* is a list of such openowners, to be reaped by the laundromat
	353	* thread eventually if they remain unused:
	354	*/
	355	struct list_head oo_close_lru;
38c387b5	356	struct nfs4_ol_stateid *oo_last_closed_stid;
fe0750e5	357	time_t oo_time; /* time of placement on so_close_lru */
dad1c067	358	#define NFS4_OO_CONFIRMED 1
d29b20cd	359	#define NFS4_OO_NEW 4
dad1c067	360	unsigned char oo_flags;
fe0750e5 BF	361	};
	362
	363	struct nfs4_lockowner {
	364	struct nfs4_stateowner lo_owner; /* must be first element */
fe0750e5 BF	365	};
	366
	367	static inline struct nfs4_openowner * openowner(struct nfs4_stateowner *so)
	368	{
	369	return container_of(so, struct nfs4_openowner, oo_owner);
	370	}
	371
	372	static inline struct nfs4_lockowner * lockowner(struct nfs4_stateowner *so)
	373	{
	374	return container_of(so, struct nfs4_lockowner, lo_owner);
	375	}
	376
1696c47c	377	/* nfs4_file: a file opened by some number of (open) nfs4_stateowners. */
1da177e4	378	struct nfs4_file {
8b671b80	379	atomic_t fi_ref;
89876f8c	380	struct hlist_node fi_hash; /* hash by "struct inode " /
8beefa24 N	381	struct list_head fi_stateids;
8beefa24 N	382	struct list_head fi_delegations;
f9d7562f BF	383	/* One each for O_RDONLY, O_WRONLY, O_RDWR: */
f9d7562f BF	384	struct file * fi_fds[3];
f9d7562f	385	/*
6409a5a6 BF	386	* Each open or lock stateid contributes 0-4 to the counts
	387	* below depending on which bits are set in st_access_bitmap:
	388	* 1 to fi_access[O_RDONLY] if NFS4_SHARE_ACCES_READ is set
	389	* + 1 to fi_access[O_WRONLY] if NFS4_SHARE_ACCESS_WRITE is set
	390	* + 1 to both of the above if NFS4_SHARE_ACCESS_BOTH is set.
f9d7562f	391	*/
9ae78bcc	392	atomic_t fi_access[2];
acfdf5c3 BF	393	struct file *fi_deleg_file;
	394	struct file_lock *fi_lease;
	395	atomic_t fi_delegees;
1da177e4	396	struct inode *fi_inode;
47f9940c	397	bool fi_had_conflict;
1da177e4 LT	398	};
1da177e4 LT	399
f9d7562f BF	400	/* XXX: for first cut may fall back on returning file that doesn't work
	401	* at all? */
	402	static inline struct file find_writeable_file(struct nfs4_file f)
	403	{
7d947842 BF	404	if (f->fi_fds[O_WRONLY])
	405	return f->fi_fds[O_WRONLY];
	406	return f->fi_fds[O_RDWR];
f9d7562f BF	407	}
	408
	409	static inline struct file find_readable_file(struct nfs4_file f)
	410	{
7d947842 BF	411	if (f->fi_fds[O_RDONLY])
	412	return f->fi_fds[O_RDONLY];
	413	return f->fi_fds[O_RDWR];
f9d7562f BF	414	}
	415
	416	static inline struct file find_any_file(struct nfs4_file f)
	417	{
	418	if (f->fi_fds[O_RDWR])
	419	return f->fi_fds[O_RDWR];
18608ad4	420	else if (f->fi_fds[O_WRONLY])
f9d7562f BF	421	return f->fi_fds[O_WRONLY];
	422	else
	423	return f->fi_fds[O_RDONLY];
	424	}
	425
d5477a8d	426	/* "ol" stands for "Open or Lock". Better suggestions welcome. */
dcef0413	427	struct nfs4_ol_stateid {
996e0938	428	struct nfs4_stid st_stid; /* must be first field */
1da177e4	429	struct list_head st_perfile;
ea1da636	430	struct list_head st_perstateowner;
3c87b9b7	431	struct list_head st_locks;
1da177e4 LT	432	struct nfs4_stateowner * st_stateowner;
1da177e4 LT	433	struct nfs4_file * st_file;
1da177e4 LT	434	unsigned long st_access_bmap;
1da177e4 LT	435	unsigned long st_deny_bmap;
dcef0413	436	struct nfs4_ol_stateid * st_openstp;
1da177e4 LT	437	};
1da177e4 LT	438
dcef0413 BF	439	static inline struct nfs4_ol_stateid openlockstateid(struct nfs4_stid s)
	440	{
	441	return container_of(s, struct nfs4_ol_stateid, st_stid);
	442	}
	443
1da177e4	444	/* flags for preprocess_seqid_op() */
1da177e4 LT	445	#define RD_STATE 0x00000010
1da177e4 LT	446	#define WR_STATE 0x00000020
1da177e4	447
dd453dfd	448	struct nfsd4_compound_state;
2c142baa	449	struct nfsd_net;
dd453dfd	450
5ccb0066 SK	451	extern __be32 nfs4_preprocess_stateid_op(struct net *net,
5ccb0066 SK	452	struct nfsd4_compound_state *cstate,
1da177e4	453	stateid_t stateid, int flags, struct file *filp);
1da177e4 LT	454	extern void nfs4_lock_state(void);
1da177e4 LT	455	extern void nfs4_unlock_state(void);
52e19c09 SK	456	void nfs4_remove_reclaim_record(struct nfs4_client_reclaim , struct nfsd_net );
	457	extern void nfs4_release_reclaim(struct nfsd_net *);
	458	extern struct nfs4_client_reclaim nfsd4_find_reclaim_client(const char recdir,
	459	struct nfsd_net *nn);
0fe492db TM	460	extern __be32 nfs4_check_open_reclaim(clientid_t *clid,
0fe492db TM	461	struct nfsd4_compound_state cstate, struct nfsd_net nn);
80fc015b	462	extern int set_callback_cred(void);
57725155	463	extern void nfsd4_init_callback(struct nfsd4_callback *);
5a3c9d71	464	extern void nfsd4_probe_callback(struct nfs4_client *clp);
84f5f7cc	465	extern void nfsd4_probe_callback_sync(struct nfs4_client *clp);
5a3c9d71	466	extern void nfsd4_change_callback(struct nfs4_client clp, struct nfs4_cb_conn );
1da177e4	467	extern void nfsd4_cb_recall(struct nfs4_delegation *dp);
b5a1a81e BF	468	extern int nfsd4_create_callback_queue(void);
b5a1a81e BF	469	extern void nfsd4_destroy_callback_queue(void);
6ff8da08	470	extern void nfsd4_shutdown_callback(struct nfs4_client *);
1da177e4	471	extern void nfs4_put_delegation(struct nfs4_delegation *dp);
52e19c09 SK	472	extern struct nfs4_client_reclaim nfs4_client_to_reclaim(const char name,
	473	struct nfsd_net *nn);
	474	extern bool nfs4_has_reclaimed_state(const char name, struct nfsd_net nn);
1da177e4	475
2a4317c5 JL	476	/* nfs4recover operations */
	477	extern int nfsd4_client_tracking_init(struct net *net);
	478	extern void nfsd4_client_tracking_exit(struct net *net);
	479	extern void nfsd4_client_record_create(struct nfs4_client *clp);
	480	extern void nfsd4_client_record_remove(struct nfs4_client *clp);
	481	extern int nfsd4_client_record_check(struct nfs4_client *clp);
12760c66	482	extern void nfsd4_record_grace_done(struct nfsd_net *nn, time_t boot_time);
f3c7521f BS	483
	484	/* nfs fault injection functions */
	485	#ifdef CONFIG_NFSD_FAULT_INJECTION
	486	int nfsd_fault_inject_init(void);
	487	void nfsd_fault_inject_cleanup(void);
8ce54e0d	488	u64 nfsd_for_n_state(u64, u64 ()(struct nfs4_client , u64));
6c1e82a4	489	struct nfs4_client nfsd_find_client(struct sockaddr_storage , size_t);
8ce54e0d BS	490
	491	u64 nfsd_forget_client(struct nfs4_client *, u64);
	492	u64 nfsd_forget_client_locks(struct nfs4_client*, u64);
	493	u64 nfsd_forget_client_openowners(struct nfs4_client *, u64);
	494	u64 nfsd_forget_client_delegations(struct nfs4_client *, u64);
	495	u64 nfsd_recall_client_delegations(struct nfs4_client *, u64);
184c1847 BS	496
	497	u64 nfsd_print_client(struct nfs4_client *, u64);
	498	u64 nfsd_print_client_locks(struct nfs4_client *, u64);
	499	u64 nfsd_print_client_openowners(struct nfs4_client *, u64);
	500	u64 nfsd_print_client_delegations(struct nfs4_client *, u64);
f3c7521f BS	501	#else /* CONFIG_NFSD_FAULT_INJECTION */
	502	static inline int nfsd_fault_inject_init(void) { return 0; }
	503	static inline void nfsd_fault_inject_cleanup(void) {}
	504	#endif /* CONFIG_NFSD_FAULT_INJECTION */
	505
1da177e4	506	#endif /* NFSD4_STATE_H */