nfs: remove unneeded null check in nfs_fill_super()
[linux-2.6-block.git] / include / linux / nfs_fs_sb.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2#ifndef _NFS_FS_SB
3#define _NFS_FS_SB
4
5#include <linux/list.h>
6#include <linux/backing-dev.h>
9157c31d 7#include <linux/idr.h>
ef818a28 8#include <linux/wait.h>
557134a3
AA
9#include <linux/nfs_xdr.h>
10#include <linux/sunrpc/xprt.h>
ef818a28 11
60063497 12#include <linux/atomic.h>
212bf41d 13#include <linux/refcount.h>
1da177e4 14
557134a3 15struct nfs4_session;
d9ef5a8c 16struct nfs_iostats;
9289e7f9 17struct nlm_host;
cccef3b9
AA
18struct nfs4_sequence_args;
19struct nfs4_sequence_res;
20struct nfs_server;
97dc1359 21struct nfs4_minor_version_ops;
79d4e1f0 22struct nfs41_server_scope;
7d2ed9ac 23struct nfs41_impl_id;
d9ef5a8c 24
24c8dbbb
DH
25/*
26 * The nfs_client identifies our client state to the server.
27 */
28struct nfs_client {
212bf41d 29 refcount_t cl_count;
2a4c8994 30 atomic_t cl_mds_count;
24c8dbbb
DH
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 */
76db6d95 34#define NFS_CS_SESSION_INITING 2 /* busy initialising session */
24c8dbbb 35 unsigned long cl_res_state; /* NFS resources state */
24c8dbbb
DH
36#define NFS_CS_CALLBACK 1 /* - callback started */
37#define NFS_CS_IDMAP 2 /* - idmap started */
5dd3177a 38#define NFS_CS_RENEWD 3 /* - renewd started */
d3b4c9d7 39#define NFS_CS_STOP_RENEW 4 /* no more state to renew */
d6fb79d4 40#define NFS_CS_CHECK_LEASE_TIME 5 /* need to check lease time */
4bf590e0
CL
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 */
89652617 44#define NFS_CS_MIGRATION 2 /* - transparent state migr */
98f98cf5 45#define NFS_CS_INFINITE_SLOTS 3 /* - don't limit TCP slots */
99875249 46#define NFS_CS_NO_RETRANS_TIMEOUT 4 /* - Disable retransmit timeouts */
8dcbec6d 47#define NFS_CS_TSM_POSSIBLE 5 /* - Maybe state migration */
4b1b69ce 48#define NFS_CS_NOPING 6 /* - don't ping on connect */
52f98f1a 49#define NFS_CS_DS 7 /* - Server is a DS */
e6237b6f 50#define NFS_CS_REUSEPORT 8 /* - reuse src port on reconnect */
6e4cffd7
CL
51 struct sockaddr_storage cl_addr; /* server identifier */
52 size_t cl_addrlen;
24c8dbbb 53 char * cl_hostname; /* hostname of server */
f11b2a1c 54 char * cl_acceptor; /* GSSAPI acceptor name */
24c8dbbb
DH
55 struct list_head cl_share_link; /* link in global client list */
56 struct list_head cl_superblocks; /* List of nfs_server structs */
57
58 struct rpc_clnt * cl_rpcclient;
8fa5c000 59 const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
59dca3b2 60 int cl_proto; /* Network transport protocol */
ab7017a3 61 struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
24c8dbbb 62
94a417f3 63 u32 cl_minorversion;/* NFSv4 minorversion */
6619079d 64 unsigned int cl_nconnect; /* Number of connections */
5e16923b 65 const char * cl_principal; /* used for machine cred */
7c67db3a 66
89d77c8f 67#if IS_ENABLED(CONFIG_NFS_V4)
0e20162e 68 struct list_head cl_ds_clients; /* auth flavor data servers */
24c8dbbb 69 u64 cl_clientid; /* constant */
fd954ae1 70 nfs4_verifier cl_confirm; /* Clientid verifier */
24c8dbbb
DH
71 unsigned long cl_state;
72
24c8dbbb
DH
73 spinlock_t cl_lock;
74
75 unsigned long cl_lease_time;
76 unsigned long cl_last_renewal;
52bad64d 77 struct delayed_work cl_renewd;
24c8dbbb
DH
78
79 struct rpc_wait_queue cl_rpcwaitq;
80
24c8dbbb
DH
81 /* idmapper */
82 struct idmap * cl_idmap;
83
ceb3a16c
TM
84 /* Client owner identifier */
85 const char * cl_owner_id;
86
f4eecd5d 87 u32 cl_cb_ident; /* v4.0 callback identifier */
97dc1359 88 const struct nfs4_minor_version_ops *cl_mvops;
c9fdeb28 89 unsigned long cl_mig_gen;
14727281 90
abf79bb3
CL
91 /* NFSv4.0 transport blocking */
92 struct nfs4_slot_table *cl_slot_tbl;
93
99fe60d0
BH
94 /* The sequence id to use for the next CREATE_SESSION */
95 u32 cl_seqid;
96 /* The flags used for obtaining the clientid during EXCHANGE_ID */
97 u32 cl_exchange_flags;
722baafc 98 struct nfs4_session *cl_session; /* shared session */
05f4c350 99 bool cl_preserve_clid;
acdeb69d 100 struct nfs41_server_owner *cl_serverowner;
79d4e1f0 101 struct nfs41_server_scope *cl_serverscope;
59155546 102 struct nfs41_impl_id *cl_implid;
2031cd1a
WAA
103 /* nfs 4.1+ state protection modes: */
104 unsigned long cl_sp4_flags;
105#define NFS_SP4_MACH_CRED_MINIMAL 1 /* Minimal sp4_mach_cred - state ops
106 * must use machine cred */
fa940720 107#define NFS_SP4_MACH_CRED_CLEANUP 2 /* CLOSE and LOCKU */
8b5bee2e 108#define NFS_SP4_MACH_CRED_SECINFO 3 /* SECINFO and SECINFO_NO_NAME */
3787d506 109#define NFS_SP4_MACH_CRED_STATEID 4 /* TEST_STATEID and FREE_STATEID */
8c21c62c
WAA
110#define NFS_SP4_MACH_CRED_WRITE 5 /* WRITE */
111#define NFS_SP4_MACH_CRED_COMMIT 6 /* COMMIT */
99ade3c7 112#define NFS_SP4_MACH_CRED_PNFS_CLEANUP 7 /* LAYOUTRETURN */
a1d617d8
JL
113#if IS_ENABLED(CONFIG_NFS_V4_1)
114 wait_queue_head_t cl_lock_waitq;
115#endif /* CONFIG_NFS_V4_1 */
0400a6b0 116#endif /* CONFIG_NFS_V4 */
557134a3 117
1a04c6e1
PT
118 /* Our own IP address, as a null-terminated string.
119 * This is used to generate the mv0 callback address.
120 */
121 char cl_ipaddr[48];
122
14727281
DH
123#ifdef CONFIG_NFS_FSCACHE
124 struct fscache_cookie *fscache; /* client index cache cookie */
125#endif
78fe0f41 126
73ea666c 127 struct net *cl_net;
bc0c9079 128 struct list_head pending_cb_stateids;
24c8dbbb
DH
129};
130
1da177e4
LT
131/*
132 * NFS client parameters stored in the superblock.
133 */
134struct nfs_server {
27951bd2 135 struct nfs_client * nfs_client; /* shared client and NFS4 state */
54ceac45
DH
136 struct list_head client_link; /* List of other nfs_server structs
137 * that share the same client
138 */
139 struct list_head master_link; /* link in master servers list */
1da177e4 140 struct rpc_clnt * client; /* RPC client handle */
b7fa0554 141 struct rpc_clnt * client_acl; /* ACL RPC client handle */
9289e7f9 142 struct nlm_host *nlm_host; /* NLM client handle */
003cb608 143 struct nfs_iostats __percpu *io_stats; /* I/O statistics */
277866a0 144 atomic_long_t writeback; /* number of writeback pages */
75cfb200 145 unsigned int flags; /* various flags */
7b1355b6
TM
146
147/* The following are for internal use only. Also see uapi/linux/nfs_mount.h */
148#define NFS_MOUNT_LOOKUP_CACHE_NONEG 0x10000
149#define NFS_MOUNT_LOOKUP_CACHE_NONE 0x20000
150#define NFS_MOUNT_NORESVPORT 0x40000
151#define NFS_MOUNT_LEGACY_INTERFACE 0x80000
152#define NFS_MOUNT_LOCAL_FLOCK 0x100000
153#define NFS_MOUNT_LOCAL_FCNTL 0x200000
91a575e1 154#define NFS_MOUNT_SOFTERR 0x400000
c74dfe97 155#define NFS_MOUNT_SOFTREVAL 0x800000
ed7bcdb3
TM
156#define NFS_MOUNT_WRITE_EAGER 0x01000000
157#define NFS_MOUNT_WRITE_WAIT 0x02000000
7b1355b6 158
1da177e4
LT
159 unsigned int caps; /* server capabilities */
160 unsigned int rsize; /* read size */
161 unsigned int rpages; /* read size (in pages) */
162 unsigned int wsize; /* write size */
163 unsigned int wpages; /* write size (in pages) */
164 unsigned int wtmult; /* server disk block size */
165 unsigned int dtsize; /* readdir size */
f22d6d79 166 unsigned short port; /* "port=" setting */
1da177e4 167 unsigned int bsize; /* server block size */
04a5da69
FL
168#ifdef CONFIG_NFS_V4_2
169 unsigned int gxasize; /* getxattr size */
170 unsigned int sxasize; /* setxattr size */
171 unsigned int lxasize; /* listxattr size */
172#endif
1da177e4
LT
173 unsigned int acregmin; /* attr cache timeouts */
174 unsigned int acregmax;
175 unsigned int acdirmin;
176 unsigned int acdirmax;
177 unsigned int namelen;
c6a6f19e 178 unsigned int options; /* extra options enabled by mount */
2a92ee92 179 unsigned int clone_blksize; /* granularity of a CLONE operation */
c6a6f19e 180#define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
89652617 181#define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
54ceac45 182
8b4bdcf8 183 struct nfs_fsid fsid;
54ceac45 184 __u64 maxfilesize; /* maximum file size */
e86d5a02 185 struct timespec64 time_delta; /* smallest time granularity */
67ec9f46 186 unsigned long mount_time; /* when this fs was mounted */
ce6cda18 187 struct super_block *super; /* VFS super block */
54ceac45 188 dev_t s_dev; /* superblock dev numbers */
0f5f49b8 189 struct nfs_auth_info auth_info; /* parsed auth flavors */
54ceac45 190
08734048
DH
191#ifdef CONFIG_NFS_FSCACHE
192 struct nfs_fscache_key *fscache_key; /* unique key for superblock */
193 struct fscache_cookie *fscache; /* superblock cookie */
194#endif
195
a00ed25c 196 u32 pnfs_blksize; /* layout_blksize attr */
89d77c8f 197#if IS_ENABLED(CONFIG_NFS_V4)
dae100c2 198 u32 attr_bitmask[3];/* V4 bitmask representing the set
1da177e4
LT
199 of attributes supported on this
200 filesystem */
aa9c2669
DQ
201 u32 attr_bitmask_nl[3];
202 /* V4 bitmask representing the
203 set of attributes supported
204 on this filesystem excluding
205 the label support bit. */
8c61282f
KM
206 u32 exclcreat_bitmask[3];
207 /* V4 bitmask representing the
208 set of attributes supported
209 on this filesystem for the
210 exclusive create. */
a09df2ca 211 u32 cache_consistency_bitmask[3];
a65318bf
TM
212 /* V4 bitmask representing the subset
213 of change attribute, size, ctime
214 and mtime attributes supported by
215 the server */
1da177e4
LT
216 u32 acl_bitmask; /* V4 bitmask representing the ACEs
217 that are supported on this
218 filesystem */
264e6351
CL
219 u32 fh_expire_type; /* V4 bitmask representing file
220 handle volatility type for
221 this filesystem */
85e174ba 222 struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
f7e8917a 223 struct rpc_wait_queue roc_rpcwaitq;
2f9fd182 224 void *pnfs_ld_data; /* per mount point data */
24d292b8
CL
225
226 /* the following fields are protected by nfs_client->cl_lock */
227 struct rb_root state_owners;
1da177e4 228#endif
9157c31d 229 struct ida openowner_id;
d2d7ce28 230 struct ida lockowner_id;
0aaaf5c4 231 struct list_head state_owners_lru;
6382a441 232 struct list_head layouts;
d3978bb3 233 struct list_head delegations;
62164f31 234 struct list_head ss_copies;
c9fdeb28
CL
235
236 unsigned long mig_gen;
237 unsigned long mig_status;
238#define NFS_MIG_IN_TRANSITION (1)
239#define NFS_MIG_FAILED (2)
8dcbec6d 240#define NFS_MIG_TSM_POSSIBLE (3)
c9fdeb28 241
54ceac45 242 void (*destroy)(struct nfs_server *);
ef818a28
SD
243
244 atomic_t active; /* Keep trace of any activity to this server */
3f8400d1
CL
245
246 /* mountd-related mount options */
247 struct sockaddr_storage mountd_address;
248 size_t mountd_addrlen;
249 u32 mountd_version;
250 unsigned short mountd_port;
251 unsigned short mountd_protocol;
7d6ddf88 252 struct rpc_wait_queue uoc_rpcwaitq;
8d8928d8
TM
253
254 /* XDR related information */
255 unsigned int read_hdrsize;
1a58e8a0
TM
256
257 /* User namespace info */
258 const struct cred *cred;
1da177e4
LT
259};
260
261/* Server capabilities */
262#define NFS_CAP_READDIRPLUS (1U << 0)
263#define NFS_CAP_HARDLINKS (1U << 1)
264#define NFS_CAP_SYMLINKS (1U << 2)
265#define NFS_CAP_ACLS (1U << 3)
266#define NFS_CAP_ATOMIC_OPEN (1U << 4)
cd812599 267/* #define NFS_CAP_CHANGE_ATTR (1U << 5) */
6e01260c 268#define NFS_CAP_LGOPEN (1U << 5)
62ab460c
TM
269#define NFS_CAP_FILEID (1U << 6)
270#define NFS_CAP_MODE (1U << 7)
271#define NFS_CAP_NLINK (1U << 8)
272#define NFS_CAP_OWNER (1U << 9)
273#define NFS_CAP_OWNER_GROUP (1U << 10)
274#define NFS_CAP_ATIME (1U << 11)
275#define NFS_CAP_CTIME (1U << 12)
276#define NFS_CAP_MTIME (1U << 13)
0df5dd4a 277#define NFS_CAP_POSIX_LOCK (1U << 14)
b064eca2 278#define NFS_CAP_UIDGID_NOMAP (1U << 15)
3b66486c 279#define NFS_CAP_STATEID_NFSV41 (1U << 16)
49f9a0fa 280#define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
e64a4210 281#define NFS_CAP_SECURITY_LABEL (1U << 18)
1c6dcbe5 282#define NFS_CAP_SEEK (1U << 19)
f4ac1674 283#define NFS_CAP_ALLOCATE (1U << 20)
624bd5b7 284#define NFS_CAP_DEALLOCATE (1U << 21)
6c5a0d89 285#define NFS_CAP_LAYOUTSTATS (1U << 22)
e5341f3a 286#define NFS_CAP_CLONE (1U << 23)
2e72448b 287#define NFS_CAP_COPY (1U << 24)
cb95deea 288#define NFS_CAP_OFFLOAD_CANCEL (1U << 25)
3eb86093 289#define NFS_CAP_LAYOUTERROR (1U << 26)
0491567b 290#define NFS_CAP_COPY_NOTIFY (1U << 27)
b78ef845 291#define NFS_CAP_XATTR (1U << 28)
c5675526 292#define NFS_CAP_READ_PLUS (1U << 29)
1da177e4
LT
293
294#endif