Merge tag 'x86-asm-2024-03-11' of git://git.kernel.org/pub/scm/linux/kernel/git/tip/tip
[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 */
806a3bc4 51#define NFS_CS_PNFS 9 /* - Server used for pnfs */
6e4cffd7
CL
52 struct sockaddr_storage cl_addr; /* server identifier */
53 size_t cl_addrlen;
24c8dbbb 54 char * cl_hostname; /* hostname of server */
f11b2a1c 55 char * cl_acceptor; /* GSSAPI acceptor name */
24c8dbbb
DH
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;
8fa5c000 60 const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
59dca3b2 61 int cl_proto; /* Network transport protocol */
ab7017a3 62 struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
24c8dbbb 63
94a417f3 64 u32 cl_minorversion;/* NFSv4 minorversion */
6619079d 65 unsigned int cl_nconnect; /* Number of connections */
7e134205 66 unsigned int cl_max_connect; /* max number of xprts allowed */
6c0a8c5f
CL
67 const char * cl_principal; /* used for machine cred */
68 struct xprtsec_parms cl_xprtsec; /* xprt security policy */
7c67db3a 69
89d77c8f 70#if IS_ENABLED(CONFIG_NFS_V4)
0e20162e 71 struct list_head cl_ds_clients; /* auth flavor data servers */
24c8dbbb 72 u64 cl_clientid; /* constant */
fd954ae1 73 nfs4_verifier cl_confirm; /* Clientid verifier */
24c8dbbb
DH
74 unsigned long cl_state;
75
24c8dbbb
DH
76 spinlock_t cl_lock;
77
78 unsigned long cl_lease_time;
79 unsigned long cl_last_renewal;
52bad64d 80 struct delayed_work cl_renewd;
24c8dbbb
DH
81
82 struct rpc_wait_queue cl_rpcwaitq;
83
24c8dbbb
DH
84 /* idmapper */
85 struct idmap * cl_idmap;
86
ceb3a16c
TM
87 /* Client owner identifier */
88 const char * cl_owner_id;
89
f4eecd5d 90 u32 cl_cb_ident; /* v4.0 callback identifier */
97dc1359 91 const struct nfs4_minor_version_ops *cl_mvops;
c9fdeb28 92 unsigned long cl_mig_gen;
14727281 93
abf79bb3
CL
94 /* NFSv4.0 transport blocking */
95 struct nfs4_slot_table *cl_slot_tbl;
96
99fe60d0
BH
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;
722baafc 101 struct nfs4_session *cl_session; /* shared session */
05f4c350 102 bool cl_preserve_clid;
acdeb69d 103 struct nfs41_server_owner *cl_serverowner;
79d4e1f0 104 struct nfs41_server_scope *cl_serverscope;
59155546 105 struct nfs41_impl_id *cl_implid;
2031cd1a
WAA
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 */
fa940720 110#define NFS_SP4_MACH_CRED_CLEANUP 2 /* CLOSE and LOCKU */
8b5bee2e 111#define NFS_SP4_MACH_CRED_SECINFO 3 /* SECINFO and SECINFO_NO_NAME */
3787d506 112#define NFS_SP4_MACH_CRED_STATEID 4 /* TEST_STATEID and FREE_STATEID */
8c21c62c
WAA
113#define NFS_SP4_MACH_CRED_WRITE 5 /* WRITE */
114#define NFS_SP4_MACH_CRED_COMMIT 6 /* COMMIT */
99ade3c7 115#define NFS_SP4_MACH_CRED_PNFS_CLEANUP 7 /* LAYOUTRETURN */
a1d617d8
JL
116#if IS_ENABLED(CONFIG_NFS_V4_1)
117 wait_queue_head_t cl_lock_waitq;
118#endif /* CONFIG_NFS_V4_1 */
0400a6b0 119#endif /* CONFIG_NFS_V4 */
557134a3 120
1a04c6e1
PT
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];
73ea666c 125 struct net *cl_net;
bc0c9079 126 struct list_head pending_cb_stateids;
c1b967d0 127 struct rcu_head rcu;
24c8dbbb
DH
128};
129
1da177e4
LT
130/*
131 * NFS client parameters stored in the superblock.
132 */
133struct nfs_server {
27951bd2 134 struct nfs_client * nfs_client; /* shared client and NFS4 state */
54ceac45
DH
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 */
1da177e4 139 struct rpc_clnt * client; /* RPC client handle */
b7fa0554 140 struct rpc_clnt * client_acl; /* ACL RPC client handle */
9289e7f9 141 struct nlm_host *nlm_host; /* NLM client handle */
003cb608 142 struct nfs_iostats __percpu *io_stats; /* I/O statistics */
277866a0 143 atomic_long_t writeback; /* number of writeback pages */
6df25e58 144 unsigned int write_congested;/* flag set when writeback gets too high */
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
a43bf604 158#define NFS_MOUNT_TRUNK_DISCOVERY 0x04000000
d9615d16 159#define NFS_MOUNT_SHUTDOWN 0x08000000
7b1355b6 160
d99f2487 161 unsigned int fattr_valid; /* Valid attributes */
1da177e4
LT
162 unsigned int caps; /* server capabilities */
163 unsigned int rsize; /* read size */
164 unsigned int rpages; /* read size (in pages) */
165 unsigned int wsize; /* write size */
166 unsigned int wpages; /* write size (in pages) */
167 unsigned int wtmult; /* server disk block size */
168 unsigned int dtsize; /* readdir size */
f22d6d79 169 unsigned short port; /* "port=" setting */
1da177e4 170 unsigned int bsize; /* server block size */
04a5da69
FL
171#ifdef CONFIG_NFS_V4_2
172 unsigned int gxasize; /* getxattr size */
173 unsigned int sxasize; /* setxattr size */
174 unsigned int lxasize; /* listxattr size */
175#endif
1da177e4
LT
176 unsigned int acregmin; /* attr cache timeouts */
177 unsigned int acregmax;
178 unsigned int acdirmin;
179 unsigned int acdirmax;
180 unsigned int namelen;
c6a6f19e 181 unsigned int options; /* extra options enabled by mount */
2a92ee92 182 unsigned int clone_blksize; /* granularity of a CLONE operation */
c6a6f19e 183#define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
89652617 184#define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
54ceac45 185
7f08a335
TM
186 enum nfs4_change_attr_type
187 change_attr_type;/* Description of change attribute */
188
8b4bdcf8 189 struct nfs_fsid fsid;
1c725118 190 int s_sysfs_id; /* sysfs dentry index */
54ceac45 191 __u64 maxfilesize; /* maximum file size */
e86d5a02 192 struct timespec64 time_delta; /* smallest time granularity */
67ec9f46 193 unsigned long mount_time; /* when this fs was mounted */
ce6cda18 194 struct super_block *super; /* VFS super block */
54ceac45 195 dev_t s_dev; /* superblock dev numbers */
0f5f49b8 196 struct nfs_auth_info auth_info; /* parsed auth flavors */
54ceac45 197
08734048 198#ifdef CONFIG_NFS_FSCACHE
a6b5a28e
DW
199 struct fscache_volume *fscache; /* superblock cookie */
200 char *fscache_uniq; /* Uniquifier (or NULL) */
08734048
DH
201#endif
202
a00ed25c 203 u32 pnfs_blksize; /* layout_blksize attr */
89d77c8f 204#if IS_ENABLED(CONFIG_NFS_V4)
dae100c2 205 u32 attr_bitmask[3];/* V4 bitmask representing the set
1da177e4
LT
206 of attributes supported on this
207 filesystem */
aa9c2669
DQ
208 u32 attr_bitmask_nl[3];
209 /* V4 bitmask representing the
210 set of attributes supported
211 on this filesystem excluding
212 the label support bit. */
8c61282f
KM
213 u32 exclcreat_bitmask[3];
214 /* V4 bitmask representing the
215 set of attributes supported
216 on this filesystem for the
217 exclusive create. */
a09df2ca 218 u32 cache_consistency_bitmask[3];
a65318bf
TM
219 /* V4 bitmask representing the subset
220 of change attribute, size, ctime
221 and mtime attributes supported by
222 the server */
1da177e4
LT
223 u32 acl_bitmask; /* V4 bitmask representing the ACEs
224 that are supported on this
225 filesystem */
264e6351
CL
226 u32 fh_expire_type; /* V4 bitmask representing file
227 handle volatility type for
228 this filesystem */
85e174ba 229 struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
f7e8917a 230 struct rpc_wait_queue roc_rpcwaitq;
2f9fd182 231 void *pnfs_ld_data; /* per mount point data */
24d292b8
CL
232
233 /* the following fields are protected by nfs_client->cl_lock */
234 struct rb_root state_owners;
1da177e4 235#endif
9157c31d 236 struct ida openowner_id;
d2d7ce28 237 struct ida lockowner_id;
0aaaf5c4 238 struct list_head state_owners_lru;
6382a441 239 struct list_head layouts;
d3978bb3 240 struct list_head delegations;
62164f31 241 struct list_head ss_copies;
c9fdeb28 242
a9b8d90f 243 unsigned long delegation_gen;
c9fdeb28
CL
244 unsigned long mig_gen;
245 unsigned long mig_status;
246#define NFS_MIG_IN_TRANSITION (1)
247#define NFS_MIG_FAILED (2)
8dcbec6d 248#define NFS_MIG_TSM_POSSIBLE (3)
c9fdeb28 249
54ceac45 250 void (*destroy)(struct nfs_server *);
ef818a28
SD
251
252 atomic_t active; /* Keep trace of any activity to this server */
3f8400d1
CL
253
254 /* mountd-related mount options */
255 struct sockaddr_storage mountd_address;
256 size_t mountd_addrlen;
257 u32 mountd_version;
258 unsigned short mountd_port;
259 unsigned short mountd_protocol;
7d6ddf88 260 struct rpc_wait_queue uoc_rpcwaitq;
8d8928d8
TM
261
262 /* XDR related information */
263 unsigned int read_hdrsize;
1a58e8a0
TM
264
265 /* User namespace info */
266 const struct cred *cred;
ec1ade6a 267 bool has_sec_mnt_opts;
1c725118 268 struct kobject kobj;
c1b967d0 269 struct rcu_head rcu;
1da177e4
LT
270};
271
272/* Server capabilities */
273#define NFS_CAP_READDIRPLUS (1U << 0)
274#define NFS_CAP_HARDLINKS (1U << 1)
275#define NFS_CAP_SYMLINKS (1U << 2)
276#define NFS_CAP_ACLS (1U << 3)
277#define NFS_CAP_ATOMIC_OPEN (1U << 4)
6e01260c 278#define NFS_CAP_LGOPEN (1U << 5)
1ab5be4a
TM
279#define NFS_CAP_CASE_INSENSITIVE (1U << 6)
280#define NFS_CAP_CASE_PRESERVING (1U << 7)
0df5dd4a 281#define NFS_CAP_POSIX_LOCK (1U << 14)
b064eca2 282#define NFS_CAP_UIDGID_NOMAP (1U << 15)
3b66486c 283#define NFS_CAP_STATEID_NFSV41 (1U << 16)
49f9a0fa 284#define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
e64a4210 285#define NFS_CAP_SECURITY_LABEL (1U << 18)
1c6dcbe5 286#define NFS_CAP_SEEK (1U << 19)
f4ac1674 287#define NFS_CAP_ALLOCATE (1U << 20)
624bd5b7 288#define NFS_CAP_DEALLOCATE (1U << 21)
6c5a0d89 289#define NFS_CAP_LAYOUTSTATS (1U << 22)
e5341f3a 290#define NFS_CAP_CLONE (1U << 23)
2e72448b 291#define NFS_CAP_COPY (1U << 24)
cb95deea 292#define NFS_CAP_OFFLOAD_CANCEL (1U << 25)
3eb86093 293#define NFS_CAP_LAYOUTERROR (1U << 26)
0491567b 294#define NFS_CAP_COPY_NOTIFY (1U << 27)
b78ef845 295#define NFS_CAP_XATTR (1U << 28)
c5675526 296#define NFS_CAP_READ_PLUS (1U << 29)
8a59bb93 297#define NFS_CAP_FS_LOCATIONS (1U << 30)
118f09ed 298#define NFS_CAP_MOVEABLE (1U << 31)
1da177e4 299#endif