xref: /linux-6.15/include/linux/nfs_fs_sb.h (revision ef264cf0)
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 #define NFS_CS_MIGRATION	2		/* - transparent state migr */
43 #define NFS_CS_INFINITE_SLOTS	3		/* - don't limit TCP slots */
44 #define NFS_CS_NO_RETRANS_TIMEOUT	4	/* - Disable retransmit timeouts */
45 	struct sockaddr_storage	cl_addr;	/* server identifier */
46 	size_t			cl_addrlen;
47 	char *			cl_hostname;	/* hostname of server */
48 	struct list_head	cl_share_link;	/* link in global client list */
49 	struct list_head	cl_superblocks;	/* List of nfs_server structs */
50 
51 	struct rpc_clnt *	cl_rpcclient;
52 	const struct nfs_rpc_ops *rpc_ops;	/* NFS protocol vector */
53 	int			cl_proto;	/* Network transport protocol */
54 	struct nfs_subversion *	cl_nfs_mod;	/* pointer to nfs version module */
55 
56 	u32			cl_minorversion;/* NFSv4 minorversion */
57 	struct rpc_cred		*cl_machine_cred;
58 
59 #if IS_ENABLED(CONFIG_NFS_V4)
60 	struct list_head	cl_ds_clients; /* auth flavor data servers */
61 	u64			cl_clientid;	/* constant */
62 	nfs4_verifier		cl_confirm;	/* Clientid verifier */
63 	unsigned long		cl_state;
64 
65 	spinlock_t		cl_lock;
66 
67 	unsigned long		cl_lease_time;
68 	unsigned long		cl_last_renewal;
69 	struct delayed_work	cl_renewd;
70 
71 	struct rpc_wait_queue	cl_rpcwaitq;
72 
73 	/* idmapper */
74 	struct idmap *		cl_idmap;
75 
76 	/* Our own IP address, as a null-terminated string.
77 	 * This is used to generate the mv0 callback address.
78 	 */
79 	char			cl_ipaddr[48];
80 	u32			cl_cb_ident;	/* v4.0 callback identifier */
81 	const struct nfs4_minor_version_ops *cl_mvops;
82 	unsigned long		cl_mig_gen;
83 
84 	/* NFSv4.0 transport blocking */
85 	struct nfs4_slot_table	*cl_slot_tbl;
86 
87 	/* The sequence id to use for the next CREATE_SESSION */
88 	u32			cl_seqid;
89 	/* The flags used for obtaining the clientid during EXCHANGE_ID */
90 	u32			cl_exchange_flags;
91 	struct nfs4_session	*cl_session;	/* shared session */
92 	bool			cl_preserve_clid;
93 	struct nfs41_server_owner *cl_serverowner;
94 	struct nfs41_server_scope *cl_serverscope;
95 	struct nfs41_impl_id	*cl_implid;
96 	/* nfs 4.1+ state protection modes: */
97 	unsigned long		cl_sp4_flags;
98 #define NFS_SP4_MACH_CRED_MINIMAL  1	/* Minimal sp4_mach_cred - state ops
99 					 * must use machine cred */
100 #define NFS_SP4_MACH_CRED_CLEANUP  2	/* CLOSE and LOCKU */
101 #define NFS_SP4_MACH_CRED_SECINFO  3	/* SECINFO and SECINFO_NO_NAME */
102 #define NFS_SP4_MACH_CRED_STATEID  4	/* TEST_STATEID and FREE_STATEID */
103 #define NFS_SP4_MACH_CRED_WRITE    5	/* WRITE */
104 #define NFS_SP4_MACH_CRED_COMMIT   6	/* COMMIT */
105 #endif /* CONFIG_NFS_V4 */
106 
107 #ifdef CONFIG_NFS_FSCACHE
108 	struct fscache_cookie	*fscache;	/* client index cache cookie */
109 #endif
110 
111 	struct net		*cl_net;
112 };
113 
114 /*
115  * NFS client parameters stored in the superblock.
116  */
117 struct nfs_server {
118 	struct nfs_client *	nfs_client;	/* shared client and NFS4 state */
119 	struct list_head	client_link;	/* List of other nfs_server structs
120 						 * that share the same client
121 						 */
122 	struct list_head	master_link;	/* link in master servers list */
123 	struct rpc_clnt *	client;		/* RPC client handle */
124 	struct rpc_clnt *	client_acl;	/* ACL RPC client handle */
125 	struct nlm_host		*nlm_host;	/* NLM client handle */
126 	struct nfs_iostats __percpu *io_stats;	/* I/O statistics */
127 	struct backing_dev_info	backing_dev_info;
128 	atomic_long_t		writeback;	/* number of writeback pages */
129 	int			flags;		/* various flags */
130 	unsigned int		caps;		/* server capabilities */
131 	unsigned int		rsize;		/* read size */
132 	unsigned int		rpages;		/* read size (in pages) */
133 	unsigned int		wsize;		/* write size */
134 	unsigned int		wpages;		/* write size (in pages) */
135 	unsigned int		wtmult;		/* server disk block size */
136 	unsigned int		dtsize;		/* readdir size */
137 	unsigned short		port;		/* "port=" setting */
138 	unsigned int		bsize;		/* server block size */
139 	unsigned int		acregmin;	/* attr cache timeouts */
140 	unsigned int		acregmax;
141 	unsigned int		acdirmin;
142 	unsigned int		acdirmax;
143 	unsigned int		namelen;
144 	unsigned int		options;	/* extra options enabled by mount */
145 #define NFS_OPTION_FSCACHE	0x00000001	/* - local caching enabled */
146 #define NFS_OPTION_MIGRATION	0x00000002	/* - NFSv4 migration enabled */
147 
148 	struct nfs_fsid		fsid;
149 	__u64			maxfilesize;	/* maximum file size */
150 	struct timespec		time_delta;	/* smallest time granularity */
151 	unsigned long		mount_time;	/* when this fs was mounted */
152 	struct super_block	*super;		/* VFS super block */
153 	dev_t			s_dev;		/* superblock dev numbers */
154 	struct nfs_auth_info	auth_info;	/* parsed auth flavors */
155 
156 #ifdef CONFIG_NFS_FSCACHE
157 	struct nfs_fscache_key	*fscache_key;	/* unique key for superblock */
158 	struct fscache_cookie	*fscache;	/* superblock cookie */
159 #endif
160 
161 	u32			pnfs_blksize;	/* layout_blksize attr */
162 #if IS_ENABLED(CONFIG_NFS_V4)
163 	u32			attr_bitmask[3];/* V4 bitmask representing the set
164 						   of attributes supported on this
165 						   filesystem */
166 	u32			attr_bitmask_nl[3];
167 						/* V4 bitmask representing the
168 						   set of attributes supported
169 						   on this filesystem excluding
170 						   the label support bit. */
171 	u32			cache_consistency_bitmask[3];
172 						/* V4 bitmask representing the subset
173 						   of change attribute, size, ctime
174 						   and mtime attributes supported by
175 						   the server */
176 	u32			acl_bitmask;	/* V4 bitmask representing the ACEs
177 						   that are supported on this
178 						   filesystem */
179 	u32			fh_expire_type;	/* V4 bitmask representing file
180 						   handle volatility type for
181 						   this filesystem */
182 	struct pnfs_layoutdriver_type  *pnfs_curr_ld; /* Active layout driver */
183 	struct rpc_wait_queue	roc_rpcwaitq;
184 	void			*pnfs_ld_data;	/* per mount point data */
185 
186 	/* the following fields are protected by nfs_client->cl_lock */
187 	struct rb_root		state_owners;
188 #endif
189 	struct ida		openowner_id;
190 	struct ida		lockowner_id;
191 	struct list_head	state_owners_lru;
192 	struct list_head	layouts;
193 	struct list_head	delegations;
194 
195 	unsigned long		mig_gen;
196 	unsigned long		mig_status;
197 #define NFS_MIG_IN_TRANSITION		(1)
198 #define NFS_MIG_FAILED			(2)
199 
200 	void (*destroy)(struct nfs_server *);
201 
202 	atomic_t active; /* Keep trace of any activity to this server */
203 
204 	/* mountd-related mount options */
205 	struct sockaddr_storage	mountd_address;
206 	size_t			mountd_addrlen;
207 	u32			mountd_version;
208 	unsigned short		mountd_port;
209 	unsigned short		mountd_protocol;
210 };
211 
212 /* Server capabilities */
213 #define NFS_CAP_READDIRPLUS	(1U << 0)
214 #define NFS_CAP_HARDLINKS	(1U << 1)
215 #define NFS_CAP_SYMLINKS	(1U << 2)
216 #define NFS_CAP_ACLS		(1U << 3)
217 #define NFS_CAP_ATOMIC_OPEN	(1U << 4)
218 #define NFS_CAP_CHANGE_ATTR	(1U << 5)
219 #define NFS_CAP_FILEID		(1U << 6)
220 #define NFS_CAP_MODE		(1U << 7)
221 #define NFS_CAP_NLINK		(1U << 8)
222 #define NFS_CAP_OWNER		(1U << 9)
223 #define NFS_CAP_OWNER_GROUP	(1U << 10)
224 #define NFS_CAP_ATIME		(1U << 11)
225 #define NFS_CAP_CTIME		(1U << 12)
226 #define NFS_CAP_MTIME		(1U << 13)
227 #define NFS_CAP_POSIX_LOCK	(1U << 14)
228 #define NFS_CAP_UIDGID_NOMAP	(1U << 15)
229 #define NFS_CAP_STATEID_NFSV41	(1U << 16)
230 #define NFS_CAP_ATOMIC_OPEN_V1	(1U << 17)
231 #define NFS_CAP_SECURITY_LABEL	(1U << 18)
232 
233 #endif
234