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