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