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 struct rcu_head rcu;
128 };
129
130 /*
131 * NFS client parameters stored in the superblock.
132 */
133 struct nfs_server {
134 struct nfs_client * nfs_client; /* shared client and NFS4 state */
135 struct list_head client_link; /* List of other nfs_server structs
136 * that share the same client
137 */
138 struct list_head master_link; /* link in master servers list */
139 struct rpc_clnt * client; /* RPC client handle */
140 struct rpc_clnt * client_acl; /* ACL RPC client handle */
141 struct nlm_host *nlm_host; /* NLM client handle */
142 struct nfs_iostats __percpu *io_stats; /* I/O statistics */
143 wait_queue_head_t write_congestion_wait; /* wait until write congestion eases */
144 atomic_long_t writeback; /* number of writeback pages */
145 unsigned int write_congested;/* flag set when writeback gets too high */
146 unsigned int flags; /* various flags */
147
148 /* The following are for internal use only. Also see uapi/linux/nfs_mount.h */
149 #define NFS_MOUNT_LOOKUP_CACHE_NONEG 0x10000
150 #define NFS_MOUNT_LOOKUP_CACHE_NONE 0x20000
151 #define NFS_MOUNT_NORESVPORT 0x40000
152 #define NFS_MOUNT_LEGACY_INTERFACE 0x80000
153 #define NFS_MOUNT_LOCAL_FLOCK 0x100000
154 #define NFS_MOUNT_LOCAL_FCNTL 0x200000
155 #define NFS_MOUNT_SOFTERR 0x400000
156 #define NFS_MOUNT_SOFTREVAL 0x800000
157 #define NFS_MOUNT_WRITE_EAGER 0x01000000
158 #define NFS_MOUNT_WRITE_WAIT 0x02000000
159 #define NFS_MOUNT_TRUNK_DISCOVERY 0x04000000
160 #define NFS_MOUNT_SHUTDOWN 0x08000000
161
162 unsigned int fattr_valid; /* Valid attributes */
163 unsigned int caps; /* server capabilities */
164 unsigned int rsize; /* read size */
165 unsigned int rpages; /* read size (in pages) */
166 unsigned int wsize; /* write size */
167 unsigned int wpages; /* write size (in pages) */
168 unsigned int wtmult; /* server disk block size */
169 unsigned int dtsize; /* readdir size */
170 unsigned short port; /* "port=" setting */
171 unsigned int bsize; /* server block size */
172 #ifdef CONFIG_NFS_V4_2
173 unsigned int gxasize; /* getxattr size */
174 unsigned int sxasize; /* setxattr size */
175 unsigned int lxasize; /* listxattr size */
176 #endif
177 unsigned int acregmin; /* attr cache timeouts */
178 unsigned int acregmax;
179 unsigned int acdirmin;
180 unsigned int acdirmax;
181 unsigned int namelen;
182 unsigned int options; /* extra options enabled by mount */
183 unsigned int clone_blksize; /* granularity of a CLONE operation */
184 #define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
185 #define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
186
187 enum nfs4_change_attr_type
188 change_attr_type;/* Description of change attribute */
189
190 struct nfs_fsid fsid;
191 int s_sysfs_id; /* sysfs dentry index */
192 __u64 maxfilesize; /* maximum file size */
193 struct timespec64 time_delta; /* smallest time granularity */
194 unsigned long mount_time; /* when this fs was mounted */
195 struct super_block *super; /* VFS super block */
196 dev_t s_dev; /* superblock dev numbers */
197 struct nfs_auth_info auth_info; /* parsed auth flavors */
198
199 #ifdef CONFIG_NFS_FSCACHE
200 struct fscache_volume *fscache; /* superblock cookie */
201 char *fscache_uniq; /* Uniquifier (or NULL) */
202 #endif
203
204 u32 pnfs_blksize; /* layout_blksize attr */
205 #if IS_ENABLED(CONFIG_NFS_V4)
206 u32 attr_bitmask[3];/* V4 bitmask representing the set
207 of attributes supported on this
208 filesystem */
209 u32 attr_bitmask_nl[3];
210 /* V4 bitmask representing the
211 set of attributes supported
212 on this filesystem excluding
213 the label support bit. */
214 u32 exclcreat_bitmask[3];
215 /* V4 bitmask representing the
216 set of attributes supported
217 on this filesystem for the
218 exclusive create. */
219 u32 cache_consistency_bitmask[3];
220 /* V4 bitmask representing the subset
221 of change attribute, size, ctime
222 and mtime attributes supported by
223 the server */
224 u32 acl_bitmask; /* V4 bitmask representing the ACEs
225 that are supported on this
226 filesystem */
227 u32 fh_expire_type; /* V4 bitmask representing file
228 handle volatility type for
229 this filesystem */
230 struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
231 struct rpc_wait_queue roc_rpcwaitq;
232 void *pnfs_ld_data; /* per mount point data */
233
234 /* the following fields are protected by nfs_client->cl_lock */
235 struct rb_root state_owners;
236 #endif
237 struct ida openowner_id;
238 struct ida lockowner_id;
239 struct list_head state_owners_lru;
240 struct list_head layouts;
241 struct list_head delegations;
242 struct list_head ss_copies;
243 struct list_head ss_src_copies;
244
245 unsigned long delegation_gen;
246 unsigned long mig_gen;
247 unsigned long mig_status;
248 #define NFS_MIG_IN_TRANSITION (1)
249 #define NFS_MIG_FAILED (2)
250 #define NFS_MIG_TSM_POSSIBLE (3)
251
252 void (*destroy)(struct nfs_server *);
253
254 atomic_t active; /* Keep trace of any activity to this server */
255
256 /* mountd-related mount options */
257 struct sockaddr_storage mountd_address;
258 size_t mountd_addrlen;
259 u32 mountd_version;
260 unsigned short mountd_port;
261 unsigned short mountd_protocol;
262 struct rpc_wait_queue uoc_rpcwaitq;
263
264 /* XDR related information */
265 unsigned int read_hdrsize;
266
267 /* User namespace info */
268 const struct cred *cred;
269 bool has_sec_mnt_opts;
270 struct kobject kobj;
271 struct rcu_head rcu;
272 };
273
274 /* Server capabilities */
275 #define NFS_CAP_READDIRPLUS (1U << 0)
276 #define NFS_CAP_HARDLINKS (1U << 1)
277 #define NFS_CAP_SYMLINKS (1U << 2)
278 #define NFS_CAP_ACLS (1U << 3)
279 #define NFS_CAP_ATOMIC_OPEN (1U << 4)
280 #define NFS_CAP_LGOPEN (1U << 5)
281 #define NFS_CAP_CASE_INSENSITIVE (1U << 6)
282 #define NFS_CAP_CASE_PRESERVING (1U << 7)
283 #define NFS_CAP_REBOOT_LAYOUTRETURN (1U << 8)
284 #define NFS_CAP_OPEN_XOR (1U << 12)
285 #define NFS_CAP_DELEGTIME (1U << 13)
286 #define NFS_CAP_POSIX_LOCK (1U << 14)
287 #define NFS_CAP_UIDGID_NOMAP (1U << 15)
288 #define NFS_CAP_STATEID_NFSV41 (1U << 16)
289 #define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
290 #define NFS_CAP_SECURITY_LABEL (1U << 18)
291 #define NFS_CAP_SEEK (1U << 19)
292 #define NFS_CAP_ALLOCATE (1U << 20)
293 #define NFS_CAP_DEALLOCATE (1U << 21)
294 #define NFS_CAP_LAYOUTSTATS (1U << 22)
295 #define NFS_CAP_CLONE (1U << 23)
296 #define NFS_CAP_COPY (1U << 24)
297 #define NFS_CAP_OFFLOAD_CANCEL (1U << 25)
298 #define NFS_CAP_LAYOUTERROR (1U << 26)
299 #define NFS_CAP_COPY_NOTIFY (1U << 27)
300 #define NFS_CAP_XATTR (1U << 28)
301 #define NFS_CAP_READ_PLUS (1U << 29)
302 #define NFS_CAP_FS_LOCATIONS (1U << 30)
303 #define NFS_CAP_MOVEABLE (1U << 31)
304 #endif
305
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.