blob: 14a762d2734d91fff13fd17ebcf76978eb9feb2a [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _NFS_FS_SB
2#define _NFS_FS_SB
3
4#include <linux/list.h>
5#include <linux/backing-dev.h>
Trond Myklebust9157c312012-01-17 22:04:24 -05006#include <linux/idr.h>
Steve Dicksonef818a22007-11-08 04:05:04 -05007#include <linux/wait.h>
Andy Adamson557134a2009-04-01 09:21:53 -04008#include <linux/nfs_xdr.h>
9#include <linux/sunrpc/xprt.h>
Steve Dicksonef818a22007-11-08 04:05:04 -050010
Arun Sharma600634972011-07-26 16:09:06 -070011#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012
Andy Adamson557134a2009-04-01 09:21:53 -040013struct nfs4_session;
Chuck Leverd9ef5a82006-03-20 13:44:13 -050014struct nfs_iostats;
Chuck Lever9289e7f2008-01-11 17:09:52 -050015struct nlm_host;
Andy Adamsoncccef3b2009-04-01 09:22:03 -040016struct nfs4_sequence_args;
17struct nfs4_sequence_res;
18struct nfs_server;
Trond Myklebust97dc1352010-06-16 09:52:26 -040019struct nfs4_minor_version_ops;
Chuck Lever79d4e1f2012-05-21 22:44:31 -040020struct nfs41_server_scope;
Weston Andros Adamson7d2ed9a2012-02-17 15:20:26 -050021struct nfs41_impl_id;
Chuck Leverd9ef5a82006-03-20 13:44:13 -050022
Linus Torvalds1da177e2005-04-16 15:20:36 -070023/*
David Howells24c8dbb2006-08-22 20:06:10 -040024 * The nfs_client identifies our client state to the server.
25 */
26struct nfs_client {
27 atomic_t cl_count;
Trond Myklebust2a4c8992012-06-14 13:08:38 -040028 atomic_t cl_mds_count;
David Howells24c8dbb2006-08-22 20:06:10 -040029 int cl_cons_state; /* current construction state (-ve: init error) */
30#define NFS_CS_READY 0 /* ready to be used */
31#define NFS_CS_INITING 1 /* busy initialising */
Andy Adamson76db6d92009-04-01 09:22:38 -040032#define NFS_CS_SESSION_INITING 2 /* busy initialising session */
David Howells24c8dbb2006-08-22 20:06:10 -040033 unsigned long cl_res_state; /* NFS resources state */
David Howells24c8dbb2006-08-22 20:06:10 -040034#define NFS_CS_CALLBACK 1 /* - callback started */
35#define NFS_CS_IDMAP 2 /* - idmap started */
Trond Myklebust5dd31772006-08-24 01:03:05 -040036#define NFS_CS_RENEWD 3 /* - renewd started */
Andy Adamsond3b4c9d2011-03-01 01:34:10 +000037#define NFS_CS_STOP_RENEW 4 /* no more state to renew */
Andy Adamsond6fb79d2011-03-01 01:34:11 +000038#define NFS_CS_CHECK_LEASE_TIME 5 /* need to check lease time */
Chuck Lever4bf590e2012-05-21 22:46:07 -040039 unsigned long cl_flags; /* behavior switches */
40#define NFS_CS_NORESVPORT 0 /* - use ephemeral src port */
41#define NFS_CS_DISCRTRY 1 /* - disconnect on RPC retry */
Chuck Lever89652612012-09-14 17:24:11 -040042#define NFS_CS_MIGRATION 2 /* - transparent state migr */
Trond Myklebust98f98cf2013-04-14 11:49:51 -040043#define NFS_CS_INFINITE_SLOTS 3 /* - don't limit TCP slots */
Trond Myklebust99875242013-09-24 12:06:07 -040044#define NFS_CS_NO_RETRANS_TIMEOUT 4 /* - Disable retransmit timeouts */
Chuck Lever6e4cffd2007-12-10 14:58:15 -050045 struct sockaddr_storage cl_addr; /* server identifier */
46 size_t cl_addrlen;
David Howells24c8dbb2006-08-22 20:06:10 -040047 char * cl_hostname; /* hostname of server */
Jeff Laytonf11b2a12014-06-21 20:52:17 -040048 char * cl_acceptor; /* GSSAPI acceptor name */
David Howells24c8dbb2006-08-22 20:06:10 -040049 struct list_head cl_share_link; /* link in global client list */
50 struct list_head cl_superblocks; /* List of nfs_server structs */
51
52 struct rpc_clnt * cl_rpcclient;
David Howells8fa5c002006-08-22 20:06:12 -040053 const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
Trond Myklebust59dca3b2008-01-03 16:29:06 -050054 int cl_proto; /* Network transport protocol */
Bryan Schumakerab7017a2012-07-30 16:05:16 -040055 struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
David Howells24c8dbb2006-08-22 20:06:10 -040056
Benny Halevy94a417f2009-04-01 09:21:49 -040057 u32 cl_minorversion;/* NFSv4 minorversion */
Trond Myklebust7c67db32008-04-07 20:50:11 -040058 struct rpc_cred *cl_machine_cred;
59
Bryan Schumaker89d77c82012-07-30 16:05:25 -040060#if IS_ENABLED(CONFIG_NFS_V4)
Andy Adamson0e201622013-09-06 14:14:00 -040061 struct list_head cl_ds_clients; /* auth flavor data servers */
David Howells24c8dbb2006-08-22 20:06:10 -040062 u64 cl_clientid; /* constant */
Trond Myklebustfd954ae2011-04-24 14:28:18 -040063 nfs4_verifier cl_confirm; /* Clientid verifier */
David Howells24c8dbb2006-08-22 20:06:10 -040064 unsigned long cl_state;
65
David Howells24c8dbb2006-08-22 20:06:10 -040066 spinlock_t cl_lock;
67
68 unsigned long cl_lease_time;
69 unsigned long cl_last_renewal;
David Howells52bad642006-11-22 14:54:01 +000070 struct delayed_work cl_renewd;
David Howells24c8dbb2006-08-22 20:06:10 -040071
72 struct rpc_wait_queue cl_rpcwaitq;
73
David Howells24c8dbb2006-08-22 20:06:10 -040074 /* idmapper */
75 struct idmap * cl_idmap;
76
Trond Myklebustceb3a162015-01-03 15:16:04 -050077 /* Client owner identifier */
78 const char * cl_owner_id;
79
Andy Adamsonf4eecd52011-01-06 02:04:30 +000080 u32 cl_cb_ident; /* v4.0 callback identifier */
Trond Myklebust97dc1352010-06-16 09:52:26 -040081 const struct nfs4_minor_version_ops *cl_mvops;
Chuck Leverc9fdeb22013-10-17 14:13:02 -040082 unsigned long cl_mig_gen;
David Howells14727282009-04-03 16:42:42 +010083
Chuck Leverabf79bb2013-08-09 12:49:11 -040084 /* NFSv4.0 transport blocking */
85 struct nfs4_slot_table *cl_slot_tbl;
86
Benny Halevy99fe60d2009-04-01 09:22:29 -040087 /* The sequence id to use for the next CREATE_SESSION */
88 u32 cl_seqid;
89 /* The flags used for obtaining the clientid during EXCHANGE_ID */
90 u32 cl_exchange_flags;
Chuck Lever722baaf2012-05-21 22:44:22 -040091 struct nfs4_session *cl_session; /* shared session */
Chuck Lever05f4c352012-09-14 17:24:32 -040092 bool cl_preserve_clid;
Chuck Leveracdeb692012-05-21 22:46:16 -040093 struct nfs41_server_owner *cl_serverowner;
Chuck Lever79d4e1f2012-05-21 22:44:31 -040094 struct nfs41_server_scope *cl_serverscope;
Chuck Lever59155542012-05-21 22:44:41 -040095 struct nfs41_impl_id *cl_implid;
Weston Andros Adamson2031cd12013-08-13 16:37:32 -040096 /* nfs 4.1+ state protection modes: */
97 unsigned long cl_sp4_flags;
98#define NFS_SP4_MACH_CRED_MINIMAL 1 /* Minimal sp4_mach_cred - state ops
99 * must use machine cred */
Weston Andros Adamsonfa940722013-08-13 16:37:34 -0400100#define NFS_SP4_MACH_CRED_CLEANUP 2 /* CLOSE and LOCKU */
Weston Andros Adamson8b5bee22013-08-13 16:37:35 -0400101#define NFS_SP4_MACH_CRED_SECINFO 3 /* SECINFO and SECINFO_NO_NAME */
Weston Andros Adamson3787d502013-08-13 16:37:36 -0400102#define NFS_SP4_MACH_CRED_STATEID 4 /* TEST_STATEID and FREE_STATEID */
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400103#define NFS_SP4_MACH_CRED_WRITE 5 /* WRITE */
104#define NFS_SP4_MACH_CRED_COMMIT 6 /* COMMIT */
Andrew Elble99ade3c2015-12-02 09:39:51 -0500105#define NFS_SP4_MACH_CRED_PNFS_CLEANUP 7 /* LAYOUTRETURN */
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500106#endif /* CONFIG_NFS_V4 */
Andy Adamson557134a2009-04-01 09:21:53 -0400107
Peng Tao1a04c6e2014-05-30 18:15:57 +0800108 /* Our own IP address, as a null-terminated string.
109 * This is used to generate the mv0 callback address.
110 */
111 char cl_ipaddr[48];
112
David Howells14727282009-04-03 16:42:42 +0100113#ifdef CONFIG_NFS_FSCACHE
114 struct fscache_cookie *fscache; /* client index cache cookie */
115#endif
Weston Andros Adamson78fe0f42011-05-31 19:05:47 -0400116
Chuck Lever73ea6662012-05-21 22:44:50 -0400117 struct net *cl_net;
David Howells24c8dbb2006-08-22 20:06:10 -0400118};
119
120/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 * NFS client parameters stored in the superblock.
122 */
123struct nfs_server {
David Howells27951bd2006-08-22 20:06:11 -0400124 struct nfs_client * nfs_client; /* shared client and NFS4 state */
David Howells54ceac42006-08-22 20:06:13 -0400125 struct list_head client_link; /* List of other nfs_server structs
126 * that share the same client
127 */
128 struct list_head master_link; /* link in master servers list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 struct rpc_clnt * client; /* RPC client handle */
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000130 struct rpc_clnt * client_acl; /* ACL RPC client handle */
Chuck Lever9289e7f2008-01-11 17:09:52 -0500131 struct nlm_host *nlm_host; /* NLM client handle */
Tejun Heo003cb602010-02-02 14:39:01 +0900132 struct nfs_iostats __percpu *io_stats; /* I/O statistics */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133 struct backing_dev_info backing_dev_info;
Peter Zijlstra277866a2007-05-08 00:35:12 -0700134 atomic_long_t writeback; /* number of writeback pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 int flags; /* various flags */
136 unsigned int caps; /* server capabilities */
137 unsigned int rsize; /* read size */
138 unsigned int rpages; /* read size (in pages) */
139 unsigned int wsize; /* write size */
140 unsigned int wpages; /* write size (in pages) */
141 unsigned int wtmult; /* server disk block size */
142 unsigned int dtsize; /* readdir size */
Chuck Leverf22d6d72008-03-14 14:10:22 -0400143 unsigned short port; /* "port=" setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 unsigned int bsize; /* server block size */
145 unsigned int acregmin; /* attr cache timeouts */
146 unsigned int acregmax;
147 unsigned int acdirmin;
148 unsigned int acdirmax;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 unsigned int namelen;
David Howellsc6a6f192009-04-03 16:42:42 +0100150 unsigned int options; /* extra options enabled by mount */
Peng Tao2a92ee92015-09-26 02:24:37 +0800151 unsigned int clone_blksize; /* granularity of a CLONE operation */
David Howellsc6a6f192009-04-03 16:42:42 +0100152#define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
Chuck Lever89652612012-09-14 17:24:11 -0400153#define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
David Howells54ceac42006-08-22 20:06:13 -0400154
Trond Myklebust8b4bdcf2006-06-09 09:34:19 -0400155 struct nfs_fsid fsid;
David Howells54ceac42006-08-22 20:06:13 -0400156 __u64 maxfilesize; /* maximum file size */
Ricardo Labiaga6b967242010-10-12 16:30:05 -0700157 struct timespec time_delta; /* smallest time granularity */
Chuck Lever67ec9f42006-03-20 13:44:15 -0500158 unsigned long mount_time; /* when this fs was mounted */
Chuck Leverce6cda12013-10-17 14:12:56 -0400159 struct super_block *super; /* VFS super block */
David Howells54ceac42006-08-22 20:06:13 -0400160 dev_t s_dev; /* superblock dev numbers */
Weston Andros Adamson0f5f49b2013-10-18 15:15:17 -0400161 struct nfs_auth_info auth_info; /* parsed auth flavors */
David Howells54ceac42006-08-22 20:06:13 -0400162
David Howells08734042009-04-03 16:42:42 +0100163#ifdef CONFIG_NFS_FSCACHE
164 struct nfs_fscache_key *fscache_key; /* unique key for superblock */
165 struct fscache_cookie *fscache; /* superblock cookie */
166#endif
167
Trond Myklebusta00ed252011-07-31 16:39:04 -0400168 u32 pnfs_blksize; /* layout_blksize attr */
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400169#if IS_ENABLED(CONFIG_NFS_V4)
Fred Isamandae100c2011-07-30 20:52:37 -0400170 u32 attr_bitmask[3];/* V4 bitmask representing the set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 of attributes supported on this
172 filesystem */
David Quigleyaa9c2662013-05-22 12:50:44 -0400173 u32 attr_bitmask_nl[3];
174 /* V4 bitmask representing the
175 set of attributes supported
176 on this filesystem excluding
177 the label support bit. */
Kinglong Mee8c612822015-08-26 21:12:58 +0800178 u32 exclcreat_bitmask[3];
179 /* V4 bitmask representing the
180 set of attributes supported
181 on this filesystem for the
182 exclusive create. */
David Quigleya09df2c2013-05-22 12:50:41 -0400183 u32 cache_consistency_bitmask[3];
Trond Myklebusta65318b2009-03-11 14:10:28 -0400184 /* V4 bitmask representing the subset
185 of change attribute, size, ctime
186 and mtime attributes supported by
187 the server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 u32 acl_bitmask; /* V4 bitmask representing the ACEs
189 that are supported on this
190 filesystem */
Chuck Lever264e6352012-03-01 17:02:05 -0500191 u32 fh_expire_type; /* V4 bitmask representing file
192 handle volatility type for
193 this filesystem */
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400194 struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
Fred Isamanf7e89172011-01-06 11:36:32 +0000195 struct rpc_wait_queue roc_rpcwaitq;
Fred Isaman2f9fd182011-07-30 20:52:46 -0400196 void *pnfs_ld_data; /* per mount point data */
Chuck Lever24d292b2010-12-24 01:32:43 +0000197
198 /* the following fields are protected by nfs_client->cl_lock */
199 struct rb_root state_owners;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200#endif
Trond Myklebust9157c312012-01-17 22:04:24 -0500201 struct ida openowner_id;
Trond Myklebustd2d7ce22012-01-17 22:04:25 -0500202 struct ida lockowner_id;
Chuck Lever0aaaf5c2011-12-06 16:13:48 -0500203 struct list_head state_owners_lru;
Weston Andros Adamson6382a442011-06-01 16:44:44 -0400204 struct list_head layouts;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000205 struct list_head delegations;
Chuck Leverc9fdeb22013-10-17 14:13:02 -0400206
207 unsigned long mig_gen;
208 unsigned long mig_status;
209#define NFS_MIG_IN_TRANSITION (1)
210#define NFS_MIG_FAILED (2)
211
David Howells54ceac42006-08-22 20:06:13 -0400212 void (*destroy)(struct nfs_server *);
Steve Dicksonef818a22007-11-08 04:05:04 -0500213
214 atomic_t active; /* Keep trace of any activity to this server */
Chuck Lever3f8400d2008-03-14 14:10:30 -0400215
216 /* mountd-related mount options */
217 struct sockaddr_storage mountd_address;
218 size_t mountd_addrlen;
219 u32 mountd_version;
220 unsigned short mountd_port;
221 unsigned short mountd_protocol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222};
223
224/* Server capabilities */
225#define NFS_CAP_READDIRPLUS (1U << 0)
226#define NFS_CAP_HARDLINKS (1U << 1)
227#define NFS_CAP_SYMLINKS (1U << 2)
228#define NFS_CAP_ACLS (1U << 3)
229#define NFS_CAP_ATOMIC_OPEN (1U << 4)
Trond Myklebustcd812592015-07-05 11:12:07 -0400230/* #define NFS_CAP_CHANGE_ATTR (1U << 5) */
Trond Myklebust62ab460c2009-08-09 15:06:19 -0400231#define NFS_CAP_FILEID (1U << 6)
232#define NFS_CAP_MODE (1U << 7)
233#define NFS_CAP_NLINK (1U << 8)
234#define NFS_CAP_OWNER (1U << 9)
235#define NFS_CAP_OWNER_GROUP (1U << 10)
236#define NFS_CAP_ATIME (1U << 11)
237#define NFS_CAP_CTIME (1U << 12)
238#define NFS_CAP_MTIME (1U << 13)
Trond Myklebust0df5dd42010-04-11 16:48:44 -0400239#define NFS_CAP_POSIX_LOCK (1U << 14)
Trond Myklebustb064eca22011-02-22 15:44:32 -0800240#define NFS_CAP_UIDGID_NOMAP (1U << 15)
Trond Myklebust3b664862013-03-17 15:31:15 -0400241#define NFS_CAP_STATEID_NFSV41 (1U << 16)
Trond Myklebust49f9a0f2013-03-15 16:44:28 -0400242#define NFS_CAP_ATOMIC_OPEN_V1 (1U << 17)
David Quigleye64a4212013-05-22 12:50:39 -0400243#define NFS_CAP_SECURITY_LABEL (1U << 18)
Anna Schumaker1c6dcbe2014-09-26 13:58:48 -0400244#define NFS_CAP_SEEK (1U << 19)
Anna Schumakerf4ac1672014-11-25 13:18:15 -0500245#define NFS_CAP_ALLOCATE (1U << 20)
Anna Schumaker624bd5b2014-11-25 13:18:16 -0500246#define NFS_CAP_DEALLOCATE (1U << 21)
Trond Myklebust6c5a0d82015-06-27 11:45:46 -0400247#define NFS_CAP_LAYOUTSTATS (1U << 22)
Peng Taoe5341f32015-09-26 02:24:35 +0800248#define NFS_CAP_CLONE (1U << 23)
Anna Schumaker2e724482013-05-21 16:53:03 -0400249#define NFS_CAP_COPY (1U << 24)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251#endif