1 /* SPDX-License-Identifier: GPL-2.0 */
5 #include <linux/list.h>
6 #include <linux/backing-dev.h>
8 #include <linux/wait.h>
9 #include <linux/nfs_xdr.h>
10 #include <linux/sunrpc/xprt.h>
12 #include <linux/atomic.h>
17 struct nfs4_sequence_args;
18 struct nfs4_sequence_res;
20 struct nfs4_minor_version_ops;
21 struct nfs41_server_scope;
25 * The nfs_client identifies our client state to the server.
29 atomic_t cl_mds_count;
30 int cl_cons_state; /* current construction state (-ve: init error) */
31 #define NFS_CS_READY 0 /* ready to be used */
32 #define NFS_CS_INITING 1 /* busy initialising */
33 #define NFS_CS_SESSION_INITING 2 /* busy initialising session */
34 unsigned long cl_res_state; /* NFS resources state */
35 #define NFS_CS_CALLBACK 1 /* - callback started */
36 #define NFS_CS_IDMAP 2 /* - idmap started */
37 #define NFS_CS_RENEWD 3 /* - renewd started */
38 #define NFS_CS_STOP_RENEW 4 /* no more state to renew */
39 #define NFS_CS_CHECK_LEASE_TIME 5 /* need to check lease time */
40 unsigned long cl_flags; /* behavior switches */
41 #define NFS_CS_NORESVPORT 0 /* - use ephemeral src port */
42 #define NFS_CS_DISCRTRY 1 /* - disconnect on RPC retry */
43 #define NFS_CS_MIGRATION 2 /* - transparent state migr */
44 #define NFS_CS_INFINITE_SLOTS 3 /* - don't limit TCP slots */
45 #define NFS_CS_NO_RETRANS_TIMEOUT 4 /* - Disable retransmit timeouts */
46 #define NFS_CS_TSM_POSSIBLE 5 /* - Maybe state migration */
47 struct sockaddr_storage cl_addr; /* server identifier */
49 char * cl_hostname; /* hostname of server */
50 char * cl_acceptor; /* GSSAPI acceptor name */
51 struct list_head cl_share_link; /* link in global client list */
52 struct list_head cl_superblocks; /* List of nfs_server structs */
54 struct rpc_clnt * cl_rpcclient;
55 const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
56 int cl_proto; /* Network transport protocol */
57 struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
59 u32 cl_minorversion;/* NFSv4 minorversion */
60 struct rpc_cred *cl_machine_cred;
62 #if IS_ENABLED(CONFIG_NFS_V4)
63 struct list_head cl_ds_clients; /* auth flavor data servers */
64 u64 cl_clientid; /* constant */
65 nfs4_verifier cl_confirm; /* Clientid verifier */
66 unsigned long cl_state;
70 unsigned long cl_lease_time;
71 unsigned long cl_last_renewal;
72 struct delayed_work cl_renewd;
74 struct rpc_wait_queue cl_rpcwaitq;
77 struct idmap * cl_idmap;
79 /* Client owner identifier */
80 const char * cl_owner_id;
82 u32 cl_cb_ident; /* v4.0 callback identifier */
83 const struct nfs4_minor_version_ops *cl_mvops;
84 unsigned long cl_mig_gen;
86 /* NFSv4.0 transport blocking */
87 struct nfs4_slot_table *cl_slot_tbl;
89 /* The sequence id to use for the next CREATE_SESSION */
91 /* The flags used for obtaining the clientid during EXCHANGE_ID */
92 u32 cl_exchange_flags;
93 struct nfs4_session *cl_session; /* shared session */
94 bool cl_preserve_clid;
95 struct nfs41_server_owner *cl_serverowner;
96 struct nfs41_server_scope *cl_serverscope;
97 struct nfs41_impl_id *cl_implid;
98 /* nfs 4.1+ state protection modes: */
99 unsigned long cl_sp4_flags;
100 #define NFS_SP4_MACH_CRED_MINIMAL 1 /* Minimal sp4_mach_cred - state ops
101 * must use machine cred */
102 #define NFS_SP4_MACH_CRED_CLEANUP 2 /* CLOSE and LOCKU */
103 #define NFS_SP4_MACH_CRED_SECINFO 3 /* SECINFO and SECINFO_NO_NAME */
104 #define NFS_SP4_MACH_CRED_STATEID 4 /* TEST_STATEID and FREE_STATEID */
105 #define NFS_SP4_MACH_CRED_WRITE 5 /* WRITE */
106 #define NFS_SP4_MACH_CRED_COMMIT 6 /* COMMIT */
107 #define NFS_SP4_MACH_CRED_PNFS_CLEANUP 7 /* LAYOUTRETURN */
108 #if IS_ENABLED(CONFIG_NFS_V4_1)
109 wait_queue_head_t cl_lock_waitq;
110 #endif /* CONFIG_NFS_V4_1 */
111 #endif /* CONFIG_NFS_V4 */
113 /* Our own IP address, as a null-terminated string.
114 * This is used to generate the mv0 callback address.
118 #ifdef CONFIG_NFS_FSCACHE
119 struct fscache_cookie *fscache; /* client index cache cookie */
126 * NFS client parameters stored in the superblock.
129 struct nfs_client * nfs_client; /* shared client and NFS4 state */
130 struct list_head client_link; /* List of other nfs_server structs
131 * that share the same client
133 struct list_head master_link; /* link in master servers list */
134 struct rpc_clnt * client; /* RPC client handle */
135 struct rpc_clnt * client_acl; /* ACL RPC client handle */
136 struct nlm_host *nlm_host; /* NLM client handle */
137 struct nfs_iostats __percpu *io_stats; /* I/O statistics */
138 atomic_long_t writeback; /* number of writeback pages */
139 int flags; /* various flags */
140 unsigned int caps; /* server capabilities */
141 unsigned int rsize; /* read size */
142 unsigned int rpages; /* read size (in pages) */
143 unsigned int wsize; /* write size */
144 unsigned int wpages; /* write size (in pages) */
145 unsigned int wtmult; /* server disk block size */
146 unsigned int dtsize; /* readdir size */
147 unsigned short port; /* "port=" setting */
148 unsigned int bsize; /* server block size */
149 unsigned int acregmin; /* attr cache timeouts */
150 unsigned int acregmax;
151 unsigned int acdirmin;
152 unsigned int acdirmax;
153 unsigned int namelen;
154 unsigned int options; /* extra options enabled by mount */
155 unsigned int clone_blksize; /* granularity of a CLONE operation */
156 #define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
157 #define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
159 struct nfs_fsid fsid;
160 __u64 maxfilesize; /* maximum file size */
161 struct timespec time_delta; /* smallest time granularity */
162 unsigned long mount_time; /* when this fs was mounted */
163 struct super_block *super; /* VFS super block */
164 dev_t s_dev; /* superblock dev numbers */
165 struct nfs_auth_info auth_info; /* parsed auth flavors */
167 #ifdef CONFIG_NFS_FSCACHE
168 struct nfs_fscache_key *fscache_key; /* unique key for superblock */
169 struct fscache_cookie *fscache; /* superblock cookie */
172 u32 pnfs_blksize; /* layout_blksize attr */
173 #if IS_ENABLED(CONFIG_NFS_V4)
174 u32 attr_bitmask[3];/* V4 bitmask representing the set
175 of attributes supported on this
177 u32 attr_bitmask_nl[3];
178 /* V4 bitmask representing the
179 set of attributes supported
180 on this filesystem excluding
181 the label support bit. */
182 u32 exclcreat_bitmask[3];
183 /* V4 bitmask representing the
184 set of attributes supported
185 on this filesystem for the
187 u32 cache_consistency_bitmask[3];
188 /* V4 bitmask representing the subset
189 of change attribute, size, ctime
190 and mtime attributes supported by
192 u32 acl_bitmask; /* V4 bitmask representing the ACEs
193 that are supported on this
195 u32 fh_expire_type; /* V4 bitmask representing file
196 handle volatility type for
198 struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
199 struct rpc_wait_queue roc_rpcwaitq;
200 void *pnfs_ld_data; /* per mount point data */
202 /* the following fields are protected by nfs_client->cl_lock */
203 struct rb_root state_owners;
205 struct ida openowner_id;
206 struct ida lockowner_id;
207 struct list_head state_owners_lru;
208 struct list_head layouts;
209 struct list_head delegations;
211 unsigned long mig_gen;
212 unsigned long mig_status;
213 #define NFS_MIG_IN_TRANSITION (1)
214 #define NFS_MIG_FAILED (2)
215 #define NFS_MIG_TSM_POSSIBLE (3)
217 void (*destroy)(struct nfs_server *);
219 atomic_t active; /* Keep trace of any activity to this server */
221 /* mountd-related mount options */
222 struct sockaddr_storage mountd_address;
223 size_t mountd_addrlen;
225 unsigned short mountd_port;
226 unsigned short mountd_protocol;
227 struct rpc_wait_queue uoc_rpcwaitq;
230 /* Server capabilities */
231 #define NFS_CAP_READDIRPLUS (1U << 0)
232 #define NFS_CAP_HARDLINKS (1U << 1)
233 #define NFS_CAP_SYMLINKS (1U << 2)
234 #define NFS_CAP_ACLS (1U << 3)
235 #define NFS_CAP_ATOMIC_OPEN (1U << 4)
236 /* #define NFS_CAP_CHANGE_ATTR (1U << 5) */
237 #define NFS_CAP_FILEID (1U << 6)
238 #define NFS_CAP_MODE (1U << 7)
239 #define NFS_CAP_NLINK (1U << 8)
240 #define NFS_CAP_OWNER (1U << 9)
241 #define NFS_CAP_OWNER_GROUP (1U << 10)
242 #define NFS_CAP_ATIME (1U << 11)
243 #define NFS_CAP_CTIME (1U << 12)
244 #define NFS_CAP_MTIME (1U << 13)
245 #define NFS_CAP_POSIX_LOCK (1U << 14)
246 #define NFS_CAP_UIDGID_NOMAP (1U << 15)
247 #define NFS_CAP_STATEID_NFSV41 (1U << 16)
248 #define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
249 #define NFS_CAP_SECURITY_LABEL (1U << 18)
250 #define NFS_CAP_SEEK (1U << 19)
251 #define NFS_CAP_ALLOCATE (1U << 20)
252 #define NFS_CAP_DEALLOCATE (1U << 21)
253 #define NFS_CAP_LAYOUTSTATS (1U << 22)
254 #define NFS_CAP_CLONE (1U << 23)
255 #define NFS_CAP_COPY (1U << 24)