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>
13 #include <linux/refcount.h>
18 struct nfs4_sequence_args;
19 struct nfs4_sequence_res;
21 struct nfs4_minor_version_ops;
22 struct nfs41_server_scope;
26 * The nfs_client identifies our client state to the server.
30 atomic_t cl_mds_count;
31 seqcount_t cl_callback_count;
32 int cl_cons_state; /* current construction state (-ve: init error) */
33 #define NFS_CS_READY 0 /* ready to be used */
34 #define NFS_CS_INITING 1 /* busy initialising */
35 #define NFS_CS_SESSION_INITING 2 /* busy initialising session */
36 unsigned long cl_res_state; /* NFS resources state */
37 #define NFS_CS_CALLBACK 1 /* - callback started */
38 #define NFS_CS_IDMAP 2 /* - idmap started */
39 #define NFS_CS_RENEWD 3 /* - renewd started */
40 #define NFS_CS_STOP_RENEW 4 /* no more state to renew */
41 #define NFS_CS_CHECK_LEASE_TIME 5 /* need to check lease time */
42 unsigned long cl_flags; /* behavior switches */
43 #define NFS_CS_NORESVPORT 0 /* - use ephemeral src port */
44 #define NFS_CS_DISCRTRY 1 /* - disconnect on RPC retry */
45 #define NFS_CS_MIGRATION 2 /* - transparent state migr */
46 #define NFS_CS_INFINITE_SLOTS 3 /* - don't limit TCP slots */
47 #define NFS_CS_NO_RETRANS_TIMEOUT 4 /* - Disable retransmit timeouts */
48 #define NFS_CS_TSM_POSSIBLE 5 /* - Maybe state migration */
49 struct sockaddr_storage cl_addr; /* server identifier */
51 char * cl_hostname; /* hostname of server */
52 char * cl_acceptor; /* GSSAPI acceptor name */
53 struct list_head cl_share_link; /* link in global client list */
54 struct list_head cl_superblocks; /* List of nfs_server structs */
56 struct rpc_clnt * cl_rpcclient;
57 const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
58 int cl_proto; /* Network transport protocol */
59 struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
61 u32 cl_minorversion;/* NFSv4 minorversion */
62 struct rpc_cred *cl_machine_cred;
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;
72 unsigned long cl_lease_time;
73 unsigned long cl_last_renewal;
74 struct delayed_work cl_renewd;
76 struct rpc_wait_queue cl_rpcwaitq;
79 struct idmap * cl_idmap;
81 /* Client owner identifier */
82 const char * cl_owner_id;
84 u32 cl_cb_ident; /* v4.0 callback identifier */
85 const struct nfs4_minor_version_ops *cl_mvops;
86 unsigned long cl_mig_gen;
88 /* NFSv4.0 transport blocking */
89 struct nfs4_slot_table *cl_slot_tbl;
91 /* The sequence id to use for the next CREATE_SESSION */
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 */
115 /* Our own IP address, as a null-terminated string.
116 * This is used to generate the mv0 callback address.
120 #ifdef CONFIG_NFS_FSCACHE
121 struct fscache_cookie *fscache; /* client index cache cookie */
128 * NFS client parameters stored in the superblock.
131 struct nfs_client * nfs_client; /* shared client and NFS4 state */
132 struct list_head client_link; /* List of other nfs_server structs
133 * that share the same client
135 struct list_head master_link; /* link in master servers list */
136 struct rpc_clnt * client; /* RPC client handle */
137 struct rpc_clnt * client_acl; /* ACL RPC client handle */
138 struct nlm_host *nlm_host; /* NLM client handle */
139 struct nfs_iostats __percpu *io_stats; /* I/O statistics */
140 atomic_long_t writeback; /* number of writeback pages */
141 int flags; /* various flags */
142 unsigned int caps; /* server capabilities */
143 unsigned int rsize; /* read size */
144 unsigned int rpages; /* read size (in pages) */
145 unsigned int wsize; /* write size */
146 unsigned int wpages; /* write size (in pages) */
147 unsigned int wtmult; /* server disk block size */
148 unsigned int dtsize; /* readdir size */
149 unsigned short port; /* "port=" setting */
150 unsigned int bsize; /* server block size */
151 unsigned int acregmin; /* attr cache timeouts */
152 unsigned int acregmax;
153 unsigned int acdirmin;
154 unsigned int acdirmax;
155 unsigned int namelen;
156 unsigned int options; /* extra options enabled by mount */
157 unsigned int clone_blksize; /* granularity of a CLONE operation */
158 #define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
159 #define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
161 struct nfs_fsid fsid;
162 __u64 maxfilesize; /* maximum file size */
163 struct timespec time_delta; /* smallest time granularity */
164 unsigned long mount_time; /* when this fs was mounted */
165 struct super_block *super; /* VFS super block */
166 dev_t s_dev; /* superblock dev numbers */
167 struct nfs_auth_info auth_info; /* parsed auth flavors */
169 #ifdef CONFIG_NFS_FSCACHE
170 struct nfs_fscache_key *fscache_key; /* unique key for superblock */
171 struct fscache_cookie *fscache; /* superblock cookie */
174 u32 pnfs_blksize; /* layout_blksize attr */
175 #if IS_ENABLED(CONFIG_NFS_V4)
176 u32 attr_bitmask[3];/* V4 bitmask representing the set
177 of attributes supported on this
179 u32 attr_bitmask_nl[3];
180 /* V4 bitmask representing the
181 set of attributes supported
182 on this filesystem excluding
183 the label support bit. */
184 u32 exclcreat_bitmask[3];
185 /* V4 bitmask representing the
186 set of attributes supported
187 on this filesystem for the
189 u32 cache_consistency_bitmask[3];
190 /* V4 bitmask representing the subset
191 of change attribute, size, ctime
192 and mtime attributes supported by
194 u32 acl_bitmask; /* V4 bitmask representing the ACEs
195 that are supported on this
197 u32 fh_expire_type; /* V4 bitmask representing file
198 handle volatility type for
200 struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
201 struct rpc_wait_queue roc_rpcwaitq;
202 void *pnfs_ld_data; /* per mount point data */
204 /* the following fields are protected by nfs_client->cl_lock */
205 struct rb_root state_owners;
207 struct ida openowner_id;
208 struct ida lockowner_id;
209 struct list_head state_owners_lru;
210 struct list_head layouts;
211 struct list_head delegations;
213 unsigned long mig_gen;
214 unsigned long mig_status;
215 #define NFS_MIG_IN_TRANSITION (1)
216 #define NFS_MIG_FAILED (2)
217 #define NFS_MIG_TSM_POSSIBLE (3)
219 void (*destroy)(struct nfs_server *);
221 atomic_t active; /* Keep trace of any activity to this server */
223 /* mountd-related mount options */
224 struct sockaddr_storage mountd_address;
225 size_t mountd_addrlen;
227 unsigned short mountd_port;
228 unsigned short mountd_protocol;
229 struct rpc_wait_queue uoc_rpcwaitq;
232 /* Server capabilities */
233 #define NFS_CAP_READDIRPLUS (1U << 0)
234 #define NFS_CAP_HARDLINKS (1U << 1)
235 #define NFS_CAP_SYMLINKS (1U << 2)
236 #define NFS_CAP_ACLS (1U << 3)
237 #define NFS_CAP_ATOMIC_OPEN (1U << 4)
238 /* #define NFS_CAP_CHANGE_ATTR (1U << 5) */
239 #define NFS_CAP_LGOPEN (1U << 5)
240 #define NFS_CAP_FILEID (1U << 6)
241 #define NFS_CAP_MODE (1U << 7)
242 #define NFS_CAP_NLINK (1U << 8)
243 #define NFS_CAP_OWNER (1U << 9)
244 #define NFS_CAP_OWNER_GROUP (1U << 10)
245 #define NFS_CAP_ATIME (1U << 11)
246 #define NFS_CAP_CTIME (1U << 12)
247 #define NFS_CAP_MTIME (1U << 13)
248 #define NFS_CAP_POSIX_LOCK (1U << 14)
249 #define NFS_CAP_UIDGID_NOMAP (1U << 15)
250 #define NFS_CAP_STATEID_NFSV41 (1U << 16)
251 #define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
252 #define NFS_CAP_SECURITY_LABEL (1U << 18)
253 #define NFS_CAP_SEEK (1U << 19)
254 #define NFS_CAP_ALLOCATE (1U << 20)
255 #define NFS_CAP_DEALLOCATE (1U << 21)
256 #define NFS_CAP_LAYOUTSTATS (1U << 22)
257 #define NFS_CAP_CLONE (1U << 23)
258 #define NFS_CAP_COPY (1U << 24)