Merge branch 'work.aio' of git://git.kernel.org/pub/scm/linux/kernel/git/viro/vfs
[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>
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;
c49b5209 31 seqcount_t cl_callback_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 */
6e4cffd7
CL
49 struct sockaddr_storage cl_addr; /* server identifier */
50 size_t cl_addrlen;
24c8dbbb 51 char * cl_hostname; /* hostname of server */
f11b2a1c 52 char * cl_acceptor; /* GSSAPI acceptor name */
24c8dbbb
DH
53 struct list_head cl_share_link; /* link in global client list */
54 struct list_head cl_superblocks; /* List of nfs_server structs */
55
56 struct rpc_clnt * cl_rpcclient;
8fa5c000 57 const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
59dca3b2 58 int cl_proto; /* Network transport protocol */
ab7017a3 59 struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
24c8dbbb 60
94a417f3 61 u32 cl_minorversion;/* NFSv4 minorversion */
7c67db3a
TM
62 struct rpc_cred *cl_machine_cred;
63
89d77c8f 64#if IS_ENABLED(CONFIG_NFS_V4)
0e20162e 65 struct list_head cl_ds_clients; /* auth flavor data servers */
24c8dbbb 66 u64 cl_clientid; /* constant */
fd954ae1 67 nfs4_verifier cl_confirm; /* Clientid verifier */
24c8dbbb
DH
68 unsigned long cl_state;
69
24c8dbbb
DH
70 spinlock_t cl_lock;
71
72 unsigned long cl_lease_time;
73 unsigned long cl_last_renewal;
52bad64d 74 struct delayed_work cl_renewd;
24c8dbbb
DH
75
76 struct rpc_wait_queue cl_rpcwaitq;
77
24c8dbbb
DH
78 /* idmapper */
79 struct idmap * cl_idmap;
80
ceb3a16c
TM
81 /* Client owner identifier */
82 const char * cl_owner_id;
83
f4eecd5d 84 u32 cl_cb_ident; /* v4.0 callback identifier */
97dc1359 85 const struct nfs4_minor_version_ops *cl_mvops;
c9fdeb28 86 unsigned long cl_mig_gen;
14727281 87
abf79bb3
CL
88 /* NFSv4.0 transport blocking */
89 struct nfs4_slot_table *cl_slot_tbl;
90
99fe60d0
BH
91 /* The sequence id to use for the next CREATE_SESSION */
92 u32 cl_seqid;
93 /* The flags used for obtaining the clientid during EXCHANGE_ID */
94 u32 cl_exchange_flags;
722baafc 95 struct nfs4_session *cl_session; /* shared session */
05f4c350 96 bool cl_preserve_clid;
acdeb69d 97 struct nfs41_server_owner *cl_serverowner;
79d4e1f0 98 struct nfs41_server_scope *cl_serverscope;
59155546 99 struct nfs41_impl_id *cl_implid;
2031cd1a
WAA
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 */
fa940720 104#define NFS_SP4_MACH_CRED_CLEANUP 2 /* CLOSE and LOCKU */
8b5bee2e 105#define NFS_SP4_MACH_CRED_SECINFO 3 /* SECINFO and SECINFO_NO_NAME */
3787d506 106#define NFS_SP4_MACH_CRED_STATEID 4 /* TEST_STATEID and FREE_STATEID */
8c21c62c
WAA
107#define NFS_SP4_MACH_CRED_WRITE 5 /* WRITE */
108#define NFS_SP4_MACH_CRED_COMMIT 6 /* COMMIT */
99ade3c7 109#define NFS_SP4_MACH_CRED_PNFS_CLEANUP 7 /* LAYOUTRETURN */
a1d617d8
JL
110#if IS_ENABLED(CONFIG_NFS_V4_1)
111 wait_queue_head_t cl_lock_waitq;
112#endif /* CONFIG_NFS_V4_1 */
0400a6b0 113#endif /* CONFIG_NFS_V4 */
557134a3 114
1a04c6e1
PT
115 /* Our own IP address, as a null-terminated string.
116 * This is used to generate the mv0 callback address.
117 */
118 char cl_ipaddr[48];
119
14727281
DH
120#ifdef CONFIG_NFS_FSCACHE
121 struct fscache_cookie *fscache; /* client index cache cookie */
122#endif
78fe0f41 123
73ea666c 124 struct net *cl_net;
24c8dbbb
DH
125};
126
1da177e4
LT
127/*
128 * NFS client parameters stored in the superblock.
129 */
130struct nfs_server {
27951bd2 131 struct nfs_client * nfs_client; /* shared client and NFS4 state */
54ceac45
DH
132 struct list_head client_link; /* List of other nfs_server structs
133 * that share the same client
134 */
135 struct list_head master_link; /* link in master servers list */
1da177e4 136 struct rpc_clnt * client; /* RPC client handle */
b7fa0554 137 struct rpc_clnt * client_acl; /* ACL RPC client handle */
9289e7f9 138 struct nlm_host *nlm_host; /* NLM client handle */
003cb608 139 struct nfs_iostats __percpu *io_stats; /* I/O statistics */
277866a0 140 atomic_long_t writeback; /* number of writeback pages */
1da177e4
LT
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 */
f22d6d79 149 unsigned short port; /* "port=" setting */
1da177e4
LT
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;
c6a6f19e 156 unsigned int options; /* extra options enabled by mount */
2a92ee92 157 unsigned int clone_blksize; /* granularity of a CLONE operation */
c6a6f19e 158#define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
89652617 159#define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
54ceac45 160
8b4bdcf8 161 struct nfs_fsid fsid;
54ceac45 162 __u64 maxfilesize; /* maximum file size */
6b96724e 163 struct timespec time_delta; /* smallest time granularity */
67ec9f46 164 unsigned long mount_time; /* when this fs was mounted */
ce6cda18 165 struct super_block *super; /* VFS super block */
54ceac45 166 dev_t s_dev; /* superblock dev numbers */
0f5f49b8 167 struct nfs_auth_info auth_info; /* parsed auth flavors */
54ceac45 168
08734048
DH
169#ifdef CONFIG_NFS_FSCACHE
170 struct nfs_fscache_key *fscache_key; /* unique key for superblock */
171 struct fscache_cookie *fscache; /* superblock cookie */
172#endif
173
a00ed25c 174 u32 pnfs_blksize; /* layout_blksize attr */
89d77c8f 175#if IS_ENABLED(CONFIG_NFS_V4)
dae100c2 176 u32 attr_bitmask[3];/* V4 bitmask representing the set
1da177e4
LT
177 of attributes supported on this
178 filesystem */
aa9c2669
DQ
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. */
8c61282f
KM
184 u32 exclcreat_bitmask[3];
185 /* V4 bitmask representing the
186 set of attributes supported
187 on this filesystem for the
188 exclusive create. */
a09df2ca 189 u32 cache_consistency_bitmask[3];
a65318bf
TM
190 /* V4 bitmask representing the subset
191 of change attribute, size, ctime
192 and mtime attributes supported by
193 the server */
1da177e4
LT
194 u32 acl_bitmask; /* V4 bitmask representing the ACEs
195 that are supported on this
196 filesystem */
264e6351
CL
197 u32 fh_expire_type; /* V4 bitmask representing file
198 handle volatility type for
199 this filesystem */
85e174ba 200 struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
f7e8917a 201 struct rpc_wait_queue roc_rpcwaitq;
2f9fd182 202 void *pnfs_ld_data; /* per mount point data */
24d292b8
CL
203
204 /* the following fields are protected by nfs_client->cl_lock */
205 struct rb_root state_owners;
1da177e4 206#endif
9157c31d 207 struct ida openowner_id;
d2d7ce28 208 struct ida lockowner_id;
0aaaf5c4 209 struct list_head state_owners_lru;
6382a441 210 struct list_head layouts;
d3978bb3 211 struct list_head delegations;
c9fdeb28
CL
212
213 unsigned long mig_gen;
214 unsigned long mig_status;
215#define NFS_MIG_IN_TRANSITION (1)
216#define NFS_MIG_FAILED (2)
8dcbec6d 217#define NFS_MIG_TSM_POSSIBLE (3)
c9fdeb28 218
54ceac45 219 void (*destroy)(struct nfs_server *);
ef818a28
SD
220
221 atomic_t active; /* Keep trace of any activity to this server */
3f8400d1
CL
222
223 /* mountd-related mount options */
224 struct sockaddr_storage mountd_address;
225 size_t mountd_addrlen;
226 u32 mountd_version;
227 unsigned short mountd_port;
228 unsigned short mountd_protocol;
7d6ddf88 229 struct rpc_wait_queue uoc_rpcwaitq;
1da177e4
LT
230};
231
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)
cd812599 238/* #define NFS_CAP_CHANGE_ATTR (1U << 5) */
6e01260c 239#define NFS_CAP_LGOPEN (1U << 5)
62ab460c
TM
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)
0df5dd4a 248#define NFS_CAP_POSIX_LOCK (1U << 14)
b064eca2 249#define NFS_CAP_UIDGID_NOMAP (1U << 15)
3b66486c 250#define NFS_CAP_STATEID_NFSV41 (1U << 16)
49f9a0fa 251#define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
e64a4210 252#define NFS_CAP_SECURITY_LABEL (1U << 18)
1c6dcbe5 253#define NFS_CAP_SEEK (1U << 19)
f4ac1674 254#define NFS_CAP_ALLOCATE (1U << 20)
624bd5b7 255#define NFS_CAP_DEALLOCATE (1U << 21)
6c5a0d89 256#define NFS_CAP_LAYOUTSTATS (1U << 22)
e5341f3a 257#define NFS_CAP_CLONE (1U << 23)
2e72448b 258#define NFS_CAP_COPY (1U << 24)
1da177e4
LT
259
260#endif