[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 <linux/nfsd/nfsfh.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
	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		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 {
	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	uid;
	u32	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_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 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 */
};

extern void nfsd4_put_session(struct nfsd4_session *ses);

/* 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 idr		cl_stateids;	/* stateid lookup */
	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 */
	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_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 */
};

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];
};

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_PURGE_CLOSE 2
#define NFS4_OO_NEW         4
	unsigned char		oo_flags;
};

struct nfs4_lockowner {
	struct nfs4_stateowner	lo_owner; /* must be first element */
	struct list_head	lo_owner_ino_hash; /* hash by owner,file */
	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. */
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 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_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;
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);
extern int nfs4_in_grace(void);
extern void nfs4_release_reclaim(void);
extern struct nfs4_client_reclaim *nfsd4_find_reclaim_client(struct nfs4_client *crp);
extern __be32 nfs4_check_open_reclaim(clientid_t *clid, bool sessions);
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 int nfs4_client_to_reclaim(const char *name);
extern int nfs4_has_reclaimed_state(const char *name, bool use_exchange_id);
extern void release_session_client(struct nfsd4_session *);
extern void nfsd4_purge_closed_stateid(struct nfs4_stateowner *);

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