1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _NFS_FS_SB
3 #define _NFS_FS_SB
4 
5 #include <linux/list.h>
6 #include <linux/backing-dev.h>
7 #include <linux/idr.h>
8 #include <linux/wait.h>
9 #include <linux/nfs_xdr.h>
10 #include <linux/sunrpc/xprt.h>
11 
12 #include <linux/atomic.h>
13 #include <linux/refcount.h>
14 
15 struct nfs4_session;
16 struct nfs_iostats;
17 struct nlm_host;
18 struct nfs4_sequence_args;
19 struct nfs4_sequence_res;
20 struct nfs_server;
21 struct nfs4_minor_version_ops;
22 struct nfs41_server_scope;
23 struct nfs41_impl_id;
24 
25 /*
26  * The nfs_client identifies our client state to the server.
27  */
28 struct nfs_client {
29 	refcount_t		cl_count;
30 	atomic_t		cl_mds_count;
31 	int			cl_cons_state;	/* current construction state (-ve: init error) */
32 #define NFS_CS_READY		0		/* ready to be used */
33 #define NFS_CS_INITING		1		/* busy initialising */
34 #define NFS_CS_SESSION_INITING	2		/* busy initialising  session */
35 	unsigned long		cl_res_state;	/* NFS resources state */
36 #define NFS_CS_CALLBACK		1		/* - callback started */
37 #define NFS_CS_IDMAP		2		/* - idmap started */
38 #define NFS_CS_RENEWD		3		/* - renewd started */
39 #define NFS_CS_STOP_RENEW	4		/* no more state to renew */
40 #define NFS_CS_CHECK_LEASE_TIME	5		/* need to check lease time */
41 	unsigned long		cl_flags;	/* behavior switches */
42 #define NFS_CS_NORESVPORT	0		/* - use ephemeral src port */
43 #define NFS_CS_DISCRTRY		1		/* - disconnect on RPC retry */
44 #define NFS_CS_MIGRATION	2		/* - transparent state migr */
45 #define NFS_CS_INFINITE_SLOTS	3		/* - don't limit TCP slots */
46 #define NFS_CS_NO_RETRANS_TIMEOUT	4	/* - Disable retransmit timeouts */
47 #define NFS_CS_TSM_POSSIBLE	5		/* - Maybe state migration */
48 #define NFS_CS_NOPING		6		/* - don't ping on connect */
49 #define NFS_CS_DS		7		/* - Server is a DS */
50 #define NFS_CS_REUSEPORT	8		/* - reuse src port on reconnect */
51 #define NFS_CS_PNFS		9		/* - Server used for pnfs */
52 	struct sockaddr_storage	cl_addr;	/* server identifier */
53 	size_t			cl_addrlen;
54 	char *			cl_hostname;	/* hostname of server */
55 	char *			cl_acceptor;	/* GSSAPI acceptor name */
56 	struct list_head	cl_share_link;	/* link in global client list */
57 	struct list_head	cl_superblocks;	/* List of nfs_server structs */
58 
59 	struct rpc_clnt *	cl_rpcclient;
60 	const struct nfs_rpc_ops *rpc_ops;	/* NFS protocol vector */
61 	int			cl_proto;	/* Network transport protocol */
62 	struct nfs_subversion *	cl_nfs_mod;	/* pointer to nfs version module */
63 
64 	u32			cl_minorversion;/* NFSv4 minorversion */
65 	unsigned int		cl_nconnect;	/* Number of connections */
66 	unsigned int		cl_max_connect; /* max number of xprts allowed */
67 	const char *		cl_principal;	/* used for machine cred */
68 	struct xprtsec_parms	cl_xprtsec;	/* xprt security policy */
69 
70 #if IS_ENABLED(CONFIG_NFS_V4)
71 	struct list_head	cl_ds_clients; /* auth flavor data servers */
72 	u64			cl_clientid;	/* constant */
73 	nfs4_verifier		cl_confirm;	/* Clientid verifier */
74 	unsigned long		cl_state;
75 
76 	spinlock_t		cl_lock;
77 
78 	unsigned long		cl_lease_time;
79 	unsigned long		cl_last_renewal;
80 	struct delayed_work	cl_renewd;
81 
82 	struct rpc_wait_queue	cl_rpcwaitq;
83 
84 	/* idmapper */
85 	struct idmap *		cl_idmap;
86 
87 	/* Client owner identifier */
88 	const char *		cl_owner_id;
89 
90 	u32			cl_cb_ident;	/* v4.0 callback identifier */
91 	const struct nfs4_minor_version_ops *cl_mvops;
92 	unsigned long		cl_mig_gen;
93 
94 	/* NFSv4.0 transport blocking */
95 	struct nfs4_slot_table	*cl_slot_tbl;
96 
97 	/* The sequence id to use for the next CREATE_SESSION */
98 	u32			cl_seqid;
99 	/* The flags used for obtaining the clientid during EXCHANGE_ID */
100 	u32			cl_exchange_flags;
101 	struct nfs4_session	*cl_session;	/* shared session */
102 	bool			cl_preserve_clid;
103 	struct nfs41_server_owner *cl_serverowner;
104 	struct nfs41_server_scope *cl_serverscope;
105 	struct nfs41_impl_id	*cl_implid;
106 	/* nfs 4.1+ state protection modes: */
107 	unsigned long		cl_sp4_flags;
108 #define NFS_SP4_MACH_CRED_MINIMAL  1	/* Minimal sp4_mach_cred - state ops
109 					 * must use machine cred */
110 #define NFS_SP4_MACH_CRED_CLEANUP  2	/* CLOSE and LOCKU */
111 #define NFS_SP4_MACH_CRED_SECINFO  3	/* SECINFO and SECINFO_NO_NAME */
112 #define NFS_SP4_MACH_CRED_STATEID  4	/* TEST_STATEID and FREE_STATEID */
113 #define NFS_SP4_MACH_CRED_WRITE    5	/* WRITE */
114 #define NFS_SP4_MACH_CRED_COMMIT   6	/* COMMIT */
115 #define NFS_SP4_MACH_CRED_PNFS_CLEANUP  7 /* LAYOUTRETURN */
116 #if IS_ENABLED(CONFIG_NFS_V4_1)
117 	wait_queue_head_t	cl_lock_waitq;
118 #endif /* CONFIG_NFS_V4_1 */
119 #endif /* CONFIG_NFS_V4 */
120 
121 	/* Our own IP address, as a null-terminated string.
122 	 * This is used to generate the mv0 callback address.
123 	 */
124 	char			cl_ipaddr[48];
125 	struct net		*cl_net;
126 	struct list_head	pending_cb_stateids;
127 };
128 
129 /*
130  * NFS client parameters stored in the superblock.
131  */
132 struct nfs_server {
133 	struct nfs_client *	nfs_client;	/* shared client and NFS4 state */
134 	struct list_head	client_link;	/* List of other nfs_server structs
135 						 * that share the same client
136 						 */
137 	struct list_head	master_link;	/* link in master servers list */
138 	struct rpc_clnt *	client;		/* RPC client handle */
139 	struct rpc_clnt *	client_acl;	/* ACL RPC client handle */
140 	struct nlm_host		*nlm_host;	/* NLM client handle */
141 	struct nfs_iostats __percpu *io_stats;	/* I/O statistics */
142 	atomic_long_t		writeback;	/* number of writeback pages */
143 	unsigned int		write_congested;/* flag set when writeback gets too high */
144 	unsigned int		flags;		/* various flags */
145 
146 /* The following are for internal use only. Also see uapi/linux/nfs_mount.h */
147 #define NFS_MOUNT_LOOKUP_CACHE_NONEG	0x10000
148 #define NFS_MOUNT_LOOKUP_CACHE_NONE	0x20000
149 #define NFS_MOUNT_NORESVPORT		0x40000
150 #define NFS_MOUNT_LEGACY_INTERFACE	0x80000
151 #define NFS_MOUNT_LOCAL_FLOCK		0x100000
152 #define NFS_MOUNT_LOCAL_FCNTL		0x200000
153 #define NFS_MOUNT_SOFTERR		0x400000
154 #define NFS_MOUNT_SOFTREVAL		0x800000
155 #define NFS_MOUNT_WRITE_EAGER		0x01000000
156 #define NFS_MOUNT_WRITE_WAIT		0x02000000
157 #define NFS_MOUNT_TRUNK_DISCOVERY	0x04000000
158 #define NFS_MOUNT_SHUTDOWN			0x08000000
159 
160 	unsigned int		fattr_valid;	/* Valid attributes */
161 	unsigned int		caps;		/* server capabilities */
162 	unsigned int		rsize;		/* read size */
163 	unsigned int		rpages;		/* read size (in pages) */
164 	unsigned int		wsize;		/* write size */
165 	unsigned int		wpages;		/* write size (in pages) */
166 	unsigned int		wtmult;		/* server disk block size */
167 	unsigned int		dtsize;		/* readdir size */
168 	unsigned short		port;		/* "port=" setting */
169 	unsigned int		bsize;		/* server block size */
170 #ifdef CONFIG_NFS_V4_2
171 	unsigned int		gxasize;	/* getxattr size */
172 	unsigned int		sxasize;	/* setxattr size */
173 	unsigned int		lxasize;	/* listxattr size */
174 #endif
175 	unsigned int		acregmin;	/* attr cache timeouts */
176 	unsigned int		acregmax;
177 	unsigned int		acdirmin;
178 	unsigned int		acdirmax;
179 	unsigned int		namelen;
180 	unsigned int		options;	/* extra options enabled by mount */
181 	unsigned int		clone_blksize;	/* granularity of a CLONE operation */
182 #define NFS_OPTION_FSCACHE	0x00000001	/* - local caching enabled */
183 #define NFS_OPTION_MIGRATION	0x00000002	/* - NFSv4 migration enabled */
184 
185 	enum nfs4_change_attr_type
186 				change_attr_type;/* Description of change attribute */
187 
188 	struct nfs_fsid		fsid;
189 	int			s_sysfs_id;	/* sysfs dentry index */
190 	__u64			maxfilesize;	/* maximum file size */
191 	struct timespec64	time_delta;	/* smallest time granularity */
192 	unsigned long		mount_time;	/* when this fs was mounted */
193 	struct super_block	*super;		/* VFS super block */
194 	dev_t			s_dev;		/* superblock dev numbers */
195 	struct nfs_auth_info	auth_info;	/* parsed auth flavors */
196 
197 #ifdef CONFIG_NFS_FSCACHE
198 	struct fscache_volume	*fscache;	/* superblock cookie */
199 	char			*fscache_uniq;	/* Uniquifier (or NULL) */
200 #endif
201 
202 	u32			pnfs_blksize;	/* layout_blksize attr */
203 #if IS_ENABLED(CONFIG_NFS_V4)
204 	u32			attr_bitmask[3];/* V4 bitmask representing the set
205 						   of attributes supported on this
206 						   filesystem */
207 	u32			attr_bitmask_nl[3];
208 						/* V4 bitmask representing the
209 						   set of attributes supported
210 						   on this filesystem excluding
211 						   the label support bit. */
212 	u32			exclcreat_bitmask[3];
213 						/* V4 bitmask representing the
214 						   set of attributes supported
215 						   on this filesystem for the
216 						   exclusive create. */
217 	u32			cache_consistency_bitmask[3];
218 						/* V4 bitmask representing the subset
219 						   of change attribute, size, ctime
220 						   and mtime attributes supported by
221 						   the server */
222 	u32			acl_bitmask;	/* V4 bitmask representing the ACEs
223 						   that are supported on this
224 						   filesystem */
225 	u32			fh_expire_type;	/* V4 bitmask representing file
226 						   handle volatility type for
227 						   this filesystem */
228 	struct pnfs_layoutdriver_type  *pnfs_curr_ld; /* Active layout driver */
229 	struct rpc_wait_queue	roc_rpcwaitq;
230 	void			*pnfs_ld_data;	/* per mount point data */
231 
232 	/* the following fields are protected by nfs_client->cl_lock */
233 	struct rb_root		state_owners;
234 #endif
235 	struct ida		openowner_id;
236 	struct ida		lockowner_id;
237 	struct list_head	state_owners_lru;
238 	struct list_head	layouts;
239 	struct list_head	delegations;
240 	struct list_head	ss_copies;
241 
242 	unsigned long		mig_gen;
243 	unsigned long		mig_status;
244 #define NFS_MIG_IN_TRANSITION		(1)
245 #define NFS_MIG_FAILED			(2)
246 #define NFS_MIG_TSM_POSSIBLE		(3)
247 
248 	void (*destroy)(struct nfs_server *);
249 
250 	atomic_t active; /* Keep trace of any activity to this server */
251 
252 	/* mountd-related mount options */
253 	struct sockaddr_storage	mountd_address;
254 	size_t			mountd_addrlen;
255 	u32			mountd_version;
256 	unsigned short		mountd_port;
257 	unsigned short		mountd_protocol;
258 	struct rpc_wait_queue	uoc_rpcwaitq;
259 
260 	/* XDR related information */
261 	unsigned int		read_hdrsize;
262 
263 	/* User namespace info */
264 	const struct cred	*cred;
265 	bool			has_sec_mnt_opts;
266 	struct kobject		kobj;
267 };
268 
269 /* Server capabilities */
270 #define NFS_CAP_READDIRPLUS	(1U << 0)
271 #define NFS_CAP_HARDLINKS	(1U << 1)
272 #define NFS_CAP_SYMLINKS	(1U << 2)
273 #define NFS_CAP_ACLS		(1U << 3)
274 #define NFS_CAP_ATOMIC_OPEN	(1U << 4)
275 #define NFS_CAP_LGOPEN		(1U << 5)
276 #define NFS_CAP_CASE_INSENSITIVE	(1U << 6)
277 #define NFS_CAP_CASE_PRESERVING	(1U << 7)
278 #define NFS_CAP_POSIX_LOCK	(1U << 14)
279 #define NFS_CAP_UIDGID_NOMAP	(1U << 15)
280 #define NFS_CAP_STATEID_NFSV41	(1U << 16)
281 #define NFS_CAP_ATOMIC_OPEN_V1	(1U << 17)
282 #define NFS_CAP_SECURITY_LABEL	(1U << 18)
283 #define NFS_CAP_SEEK		(1U << 19)
284 #define NFS_CAP_ALLOCATE	(1U << 20)
285 #define NFS_CAP_DEALLOCATE	(1U << 21)
286 #define NFS_CAP_LAYOUTSTATS	(1U << 22)
287 #define NFS_CAP_CLONE		(1U << 23)
288 #define NFS_CAP_COPY		(1U << 24)
289 #define NFS_CAP_OFFLOAD_CANCEL	(1U << 25)
290 #define NFS_CAP_LAYOUTERROR	(1U << 26)
291 #define NFS_CAP_COPY_NOTIFY	(1U << 27)
292 #define NFS_CAP_XATTR		(1U << 28)
293 #define NFS_CAP_READ_PLUS	(1U << 29)
294 #define NFS_CAP_FS_LOCATIONS	(1U << 30)
295 #define NFS_CAP_MOVEABLE	(1U << 31)
296 #endif
297