1 #ifndef _NFS_FS_SB
2 #define _NFS_FS_SB
3 
4 #include <linux/list.h>
5 #include <linux/backing-dev.h>
6 #include <linux/idr.h>
7 #include <linux/wait.h>
8 #include <linux/nfs_xdr.h>
9 #include <linux/sunrpc/xprt.h>
10 
11 #include <linux/atomic.h>
12 
13 struct nfs4_session;
14 struct nfs_iostats;
15 struct nlm_host;
16 struct nfs4_sequence_args;
17 struct nfs4_sequence_res;
18 struct nfs_server;
19 struct nfs4_minor_version_ops;
20 struct server_scope;
21 struct nfs41_impl_id;
22 
23 /*
24  * The nfs_client identifies our client state to the server.
25  */
26 struct nfs_client {
27 	atomic_t		cl_count;
28 	int			cl_cons_state;	/* current construction state (-ve: init error) */
29 #define NFS_CS_READY		0		/* ready to be used */
30 #define NFS_CS_INITING		1		/* busy initialising */
31 #define NFS_CS_SESSION_INITING	2		/* busy initialising  session */
32 	unsigned long		cl_res_state;	/* NFS resources state */
33 #define NFS_CS_CALLBACK		1		/* - callback started */
34 #define NFS_CS_IDMAP		2		/* - idmap started */
35 #define NFS_CS_RENEWD		3		/* - renewd started */
36 #define NFS_CS_STOP_RENEW	4		/* no more state to renew */
37 #define NFS_CS_CHECK_LEASE_TIME	5		/* need to check lease time */
38 	struct sockaddr_storage	cl_addr;	/* server identifier */
39 	size_t			cl_addrlen;
40 	char *			cl_hostname;	/* hostname of server */
41 	struct list_head	cl_share_link;	/* link in global client list */
42 	struct list_head	cl_superblocks;	/* List of nfs_server structs */
43 
44 	struct rpc_clnt *	cl_rpcclient;
45 	const struct nfs_rpc_ops *rpc_ops;	/* NFS protocol vector */
46 	int			cl_proto;	/* Network transport protocol */
47 
48 	u32			cl_minorversion;/* NFSv4 minorversion */
49 	struct rpc_cred		*cl_machine_cred;
50 
51 #ifdef CONFIG_NFS_V4
52 	u64			cl_clientid;	/* constant */
53 	nfs4_verifier		cl_confirm;	/* Clientid verifier */
54 	unsigned long		cl_state;
55 
56 	spinlock_t		cl_lock;
57 
58 	unsigned long		cl_lease_time;
59 	unsigned long		cl_last_renewal;
60 	struct delayed_work	cl_renewd;
61 
62 	struct rpc_wait_queue	cl_rpcwaitq;
63 
64 	/* used for the setclientid verifier */
65 	struct timespec		cl_boot_time;
66 
67 	/* idmapper */
68 	struct idmap *		cl_idmap;
69 
70 	/* Our own IP address, as a null-terminated string.
71 	 * This is used to generate the clientid, and the callback address.
72 	 */
73 	char			cl_ipaddr[48];
74 	unsigned char		cl_id_uniquifier;
75 	u32			cl_cb_ident;	/* v4.0 callback identifier */
76 	const struct nfs4_minor_version_ops *cl_mvops;
77 
78 	/* The sequence id to use for the next CREATE_SESSION */
79 	u32			cl_seqid;
80 	/* The flags used for obtaining the clientid during EXCHANGE_ID */
81 	u32			cl_exchange_flags;
82 	struct nfs4_session	*cl_session; 	/* sharred session */
83 #endif /* CONFIG_NFS_V4 */
84 
85 #ifdef CONFIG_NFS_FSCACHE
86 	struct fscache_cookie	*fscache;	/* client index cache cookie */
87 #endif
88 
89 	struct server_scope	*server_scope;	/* from exchange_id */
90 	struct nfs41_impl_id	*impl_id;	/* from exchange_id */
91 	struct net		*net;
92 };
93 
94 /*
95  * NFS client parameters stored in the superblock.
96  */
97 struct nfs_server {
98 	struct nfs_client *	nfs_client;	/* shared client and NFS4 state */
99 	struct list_head	client_link;	/* List of other nfs_server structs
100 						 * that share the same client
101 						 */
102 	struct list_head	master_link;	/* link in master servers list */
103 	struct rpc_clnt *	client;		/* RPC client handle */
104 	struct rpc_clnt *	client_acl;	/* ACL RPC client handle */
105 	struct nlm_host		*nlm_host;	/* NLM client handle */
106 	struct nfs_iostats __percpu *io_stats;	/* I/O statistics */
107 	struct backing_dev_info	backing_dev_info;
108 	atomic_long_t		writeback;	/* number of writeback pages */
109 	int			flags;		/* various flags */
110 	unsigned int		caps;		/* server capabilities */
111 	unsigned int		rsize;		/* read size */
112 	unsigned int		rpages;		/* read size (in pages) */
113 	unsigned int		wsize;		/* write size */
114 	unsigned int		wpages;		/* write size (in pages) */
115 	unsigned int		wtmult;		/* server disk block size */
116 	unsigned int		dtsize;		/* readdir size */
117 	unsigned short		port;		/* "port=" setting */
118 	unsigned int		bsize;		/* server block size */
119 	unsigned int		acregmin;	/* attr cache timeouts */
120 	unsigned int		acregmax;
121 	unsigned int		acdirmin;
122 	unsigned int		acdirmax;
123 	unsigned int		namelen;
124 	unsigned int		options;	/* extra options enabled by mount */
125 #define NFS_OPTION_FSCACHE	0x00000001	/* - local caching enabled */
126 
127 	struct nfs_fsid		fsid;
128 	__u64			maxfilesize;	/* maximum file size */
129 	struct timespec		time_delta;	/* smallest time granularity */
130 	unsigned long		mount_time;	/* when this fs was mounted */
131 	dev_t			s_dev;		/* superblock dev numbers */
132 
133 #ifdef CONFIG_NFS_FSCACHE
134 	struct nfs_fscache_key	*fscache_key;	/* unique key for superblock */
135 	struct fscache_cookie	*fscache;	/* superblock cookie */
136 #endif
137 
138 	u32			pnfs_blksize;	/* layout_blksize attr */
139 #ifdef CONFIG_NFS_V4
140 	u32			attr_bitmask[3];/* V4 bitmask representing the set
141 						   of attributes supported on this
142 						   filesystem */
143 	u32			cache_consistency_bitmask[2];
144 						/* V4 bitmask representing the subset
145 						   of change attribute, size, ctime
146 						   and mtime attributes supported by
147 						   the server */
148 	u32			acl_bitmask;	/* V4 bitmask representing the ACEs
149 						   that are supported on this
150 						   filesystem */
151 	u32			fh_expire_type;	/* V4 bitmask representing file
152 						   handle volatility type for
153 						   this filesystem */
154 	struct pnfs_layoutdriver_type  *pnfs_curr_ld; /* Active layout driver */
155 	struct rpc_wait_queue	roc_rpcwaitq;
156 	void			*pnfs_ld_data;	/* per mount point data */
157 
158 	/* the following fields are protected by nfs_client->cl_lock */
159 	struct rb_root		state_owners;
160 #endif
161 	struct ida		openowner_id;
162 	struct ida		lockowner_id;
163 	struct list_head	state_owners_lru;
164 	struct list_head	layouts;
165 	struct list_head	delegations;
166 	void (*destroy)(struct nfs_server *);
167 
168 	atomic_t active; /* Keep trace of any activity to this server */
169 
170 	/* mountd-related mount options */
171 	struct sockaddr_storage	mountd_address;
172 	size_t			mountd_addrlen;
173 	u32			mountd_version;
174 	unsigned short		mountd_port;
175 	unsigned short		mountd_protocol;
176 };
177 
178 /* Server capabilities */
179 #define NFS_CAP_READDIRPLUS	(1U << 0)
180 #define NFS_CAP_HARDLINKS	(1U << 1)
181 #define NFS_CAP_SYMLINKS	(1U << 2)
182 #define NFS_CAP_ACLS		(1U << 3)
183 #define NFS_CAP_ATOMIC_OPEN	(1U << 4)
184 #define NFS_CAP_CHANGE_ATTR	(1U << 5)
185 #define NFS_CAP_FILEID		(1U << 6)
186 #define NFS_CAP_MODE		(1U << 7)
187 #define NFS_CAP_NLINK		(1U << 8)
188 #define NFS_CAP_OWNER		(1U << 9)
189 #define NFS_CAP_OWNER_GROUP	(1U << 10)
190 #define NFS_CAP_ATIME		(1U << 11)
191 #define NFS_CAP_CTIME		(1U << 12)
192 #define NFS_CAP_MTIME		(1U << 13)
193 #define NFS_CAP_POSIX_LOCK	(1U << 14)
194 #define NFS_CAP_UIDGID_NOMAP	(1U << 15)
195 
196 
197 /* maximum number of slots to use */
198 #define NFS4_DEF_SLOT_TABLE_SIZE (16U)
199 #define NFS4_MAX_SLOT_TABLE (256U)
200 #define NFS4_NO_SLOT ((u32)-1)
201 
202 #if defined(CONFIG_NFS_V4)
203 
204 /* Sessions */
205 #define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
206 struct nfs4_slot_table {
207 	struct nfs4_slot *slots;		/* seqid per slot */
208 	unsigned long   used_slots[SLOT_TABLE_SZ]; /* used/unused bitmap */
209 	spinlock_t	slot_tbl_lock;
210 	struct rpc_wait_queue	slot_tbl_waitq;	/* allocators may wait here */
211 	u32		max_slots;		/* # slots in table */
212 	u32		highest_used_slotid;	/* sent to server on each SEQ.
213 						 * op for dynamic resizing */
214 	u32		target_max_slots;	/* Set by CB_RECALL_SLOT as
215 						 * the new max_slots */
216 	struct completion complete;
217 };
218 
slot_idx(struct nfs4_slot_table * tbl,struct nfs4_slot * sp)219 static inline int slot_idx(struct nfs4_slot_table *tbl, struct nfs4_slot *sp)
220 {
221 	return sp - tbl->slots;
222 }
223 
224 /*
225  * Session related parameters
226  */
227 struct nfs4_session {
228 	struct nfs4_sessionid		sess_id;
229 	u32				flags;
230 	unsigned long			session_state;
231 	u32				hash_alg;
232 	u32				ssv_len;
233 
234 	/* The fore and back channel */
235 	struct nfs4_channel_attrs	fc_attrs;
236 	struct nfs4_slot_table		fc_slot_table;
237 	struct nfs4_channel_attrs	bc_attrs;
238 	struct nfs4_slot_table		bc_slot_table;
239 	struct nfs_client		*clp;
240 };
241 
242 #endif /* CONFIG_NFS_V4 */
243 #endif
244