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