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