blob: a9e76ee1adcae3c28c4823ae5cf7eb472bd05a03 [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 */
Chuck Lever6e4cffd2007-12-10 14:58:15 -050043 struct sockaddr_storage cl_addr; /* server identifier */
44 size_t cl_addrlen;
David Howells24c8dbb2006-08-22 20:06:10 -040045 char * cl_hostname; /* hostname of server */
46 struct list_head cl_share_link; /* link in global client list */
47 struct list_head cl_superblocks; /* List of nfs_server structs */
48
49 struct rpc_clnt * cl_rpcclient;
David Howells8fa5c002006-08-22 20:06:12 -040050 const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
Trond Myklebust59dca3b2008-01-03 16:29:06 -050051 int cl_proto; /* Network transport protocol */
Bryan Schumakerab7017a2012-07-30 16:05:16 -040052 struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
David Howells24c8dbb2006-08-22 20:06:10 -040053
Benny Halevy94a417f2009-04-01 09:21:49 -040054 u32 cl_minorversion;/* NFSv4 minorversion */
Trond Myklebust7c67db32008-04-07 20:50:11 -040055 struct rpc_cred *cl_machine_cred;
56
Bryan Schumaker89d77c82012-07-30 16:05:25 -040057#if IS_ENABLED(CONFIG_NFS_V4)
David Howells24c8dbb2006-08-22 20:06:10 -040058 u64 cl_clientid; /* constant */
Trond Myklebustfd954ae2011-04-24 14:28:18 -040059 nfs4_verifier cl_confirm; /* Clientid verifier */
David Howells24c8dbb2006-08-22 20:06:10 -040060 unsigned long cl_state;
61
David Howells24c8dbb2006-08-22 20:06:10 -040062 spinlock_t cl_lock;
63
64 unsigned long cl_lease_time;
65 unsigned long cl_last_renewal;
David Howells52bad642006-11-22 14:54:01 +000066 struct delayed_work cl_renewd;
David Howells24c8dbb2006-08-22 20:06:10 -040067
68 struct rpc_wait_queue cl_rpcwaitq;
69
David Howells24c8dbb2006-08-22 20:06:10 -040070 /* idmapper */
71 struct idmap * cl_idmap;
72
73 /* Our own IP address, as a null-terminated string.
Chuck Leverde734832012-07-11 16:30:50 -040074 * This is used to generate the mv0 callback address.
David Howells24c8dbb2006-08-22 20:06:10 -040075 */
Chuck Lever4392f252007-12-10 14:57:01 -050076 char cl_ipaddr[48];
Andy Adamsonf4eecd52011-01-06 02:04:30 +000077 u32 cl_cb_ident; /* v4.0 callback identifier */
Trond Myklebust97dc1352010-06-16 09:52:26 -040078 const struct nfs4_minor_version_ops *cl_mvops;
David Howells14727282009-04-03 16:42:42 +010079
Benny Halevy99fe60d2009-04-01 09:22:29 -040080 /* The sequence id to use for the next CREATE_SESSION */
81 u32 cl_seqid;
82 /* The flags used for obtaining the clientid during EXCHANGE_ID */
83 u32 cl_exchange_flags;
Chuck Lever722baaf2012-05-21 22:44:22 -040084 struct nfs4_session *cl_session; /* shared session */
Chuck Lever05f4c352012-09-14 17:24:32 -040085 bool cl_preserve_clid;
Chuck Leveracdeb692012-05-21 22:46:16 -040086 struct nfs41_server_owner *cl_serverowner;
Chuck Lever79d4e1f2012-05-21 22:44:31 -040087 struct nfs41_server_scope *cl_serverscope;
Chuck Lever59155542012-05-21 22:44:41 -040088 struct nfs41_impl_id *cl_implid;
Trond Myklebust0400a6b2011-03-09 16:00:53 -050089#endif /* CONFIG_NFS_V4 */
Andy Adamson557134a2009-04-01 09:21:53 -040090
David Howells14727282009-04-03 16:42:42 +010091#ifdef CONFIG_NFS_FSCACHE
92 struct fscache_cookie *fscache; /* client index cache cookie */
93#endif
Weston Andros Adamson78fe0f42011-05-31 19:05:47 -040094
Chuck Lever73ea6662012-05-21 22:44:50 -040095 struct net *cl_net;
David Howells24c8dbb2006-08-22 20:06:10 -040096};
97
98/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 * NFS client parameters stored in the superblock.
100 */
101struct nfs_server {
David Howells27951bd2006-08-22 20:06:11 -0400102 struct nfs_client * nfs_client; /* shared client and NFS4 state */
David Howells54ceac42006-08-22 20:06:13 -0400103 struct list_head client_link; /* List of other nfs_server structs
104 * that share the same client
105 */
106 struct list_head master_link; /* link in master servers list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 struct rpc_clnt * client; /* RPC client handle */
Andreas Gruenbacherb7fa0552005-06-22 17:16:27 +0000108 struct rpc_clnt * client_acl; /* ACL RPC client handle */
Chuck Lever9289e7f2008-01-11 17:09:52 -0500109 struct nlm_host *nlm_host; /* NLM client handle */
Tejun Heo003cb602010-02-02 14:39:01 +0900110 struct nfs_iostats __percpu *io_stats; /* I/O statistics */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 struct backing_dev_info backing_dev_info;
Peter Zijlstra277866a2007-05-08 00:35:12 -0700112 atomic_long_t writeback; /* number of writeback pages */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 int flags; /* various flags */
114 unsigned int caps; /* server capabilities */
115 unsigned int rsize; /* read size */
116 unsigned int rpages; /* read size (in pages) */
117 unsigned int wsize; /* write size */
118 unsigned int wpages; /* write size (in pages) */
119 unsigned int wtmult; /* server disk block size */
120 unsigned int dtsize; /* readdir size */
Chuck Leverf22d6d72008-03-14 14:10:22 -0400121 unsigned short port; /* "port=" setting */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 unsigned int bsize; /* server block size */
123 unsigned int acregmin; /* attr cache timeouts */
124 unsigned int acregmax;
125 unsigned int acdirmin;
126 unsigned int acdirmax;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 unsigned int namelen;
David Howellsc6a6f192009-04-03 16:42:42 +0100128 unsigned int options; /* extra options enabled by mount */
129#define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
Chuck Lever89652612012-09-14 17:24:11 -0400130#define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
David Howells54ceac42006-08-22 20:06:13 -0400131
Trond Myklebust8b4bdcf2006-06-09 09:34:19 -0400132 struct nfs_fsid fsid;
David Howells54ceac42006-08-22 20:06:13 -0400133 __u64 maxfilesize; /* maximum file size */
Ricardo Labiaga6b967242010-10-12 16:30:05 -0700134 struct timespec time_delta; /* smallest time granularity */
Chuck Lever67ec9f42006-03-20 13:44:15 -0500135 unsigned long mount_time; /* when this fs was mounted */
David Howells54ceac42006-08-22 20:06:13 -0400136 dev_t s_dev; /* superblock dev numbers */
137
David Howells08734042009-04-03 16:42:42 +0100138#ifdef CONFIG_NFS_FSCACHE
139 struct nfs_fscache_key *fscache_key; /* unique key for superblock */
140 struct fscache_cookie *fscache; /* superblock cookie */
141#endif
142
Trond Myklebusta00ed252011-07-31 16:39:04 -0400143 u32 pnfs_blksize; /* layout_blksize attr */
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400144#if IS_ENABLED(CONFIG_NFS_V4)
Fred Isamandae100c2011-07-30 20:52:37 -0400145 u32 attr_bitmask[3];/* V4 bitmask representing the set
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 of attributes supported on this
147 filesystem */
Trond Myklebusta65318b2009-03-11 14:10:28 -0400148 u32 cache_consistency_bitmask[2];
149 /* V4 bitmask representing the subset
150 of change attribute, size, ctime
151 and mtime attributes supported by
152 the server */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 u32 acl_bitmask; /* V4 bitmask representing the ACEs
154 that are supported on this
155 filesystem */
Chuck Lever264e6352012-03-01 17:02:05 -0500156 u32 fh_expire_type; /* V4 bitmask representing file
157 handle volatility type for
158 this filesystem */
Ricardo Labiaga85e174b2010-10-20 00:17:58 -0400159 struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
Fred Isamanf7e89172011-01-06 11:36:32 +0000160 struct rpc_wait_queue roc_rpcwaitq;
Fred Isaman2f9fd182011-07-30 20:52:46 -0400161 void *pnfs_ld_data; /* per mount point data */
Chuck Lever24d292b2010-12-24 01:32:43 +0000162
163 /* the following fields are protected by nfs_client->cl_lock */
164 struct rb_root state_owners;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165#endif
Trond Myklebust9157c312012-01-17 22:04:24 -0500166 struct ida openowner_id;
Trond Myklebustd2d7ce22012-01-17 22:04:25 -0500167 struct ida lockowner_id;
Chuck Lever0aaaf5c2011-12-06 16:13:48 -0500168 struct list_head state_owners_lru;
Weston Andros Adamson6382a442011-06-01 16:44:44 -0400169 struct list_head layouts;
Chuck Leverd3978bb2010-12-24 01:33:04 +0000170 struct list_head delegations;
David Howells54ceac42006-08-22 20:06:13 -0400171 void (*destroy)(struct nfs_server *);
Steve Dicksonef818a22007-11-08 04:05:04 -0500172
173 atomic_t active; /* Keep trace of any activity to this server */
Chuck Lever3f8400d2008-03-14 14:10:30 -0400174
175 /* mountd-related mount options */
176 struct sockaddr_storage mountd_address;
177 size_t mountd_addrlen;
178 u32 mountd_version;
179 unsigned short mountd_port;
180 unsigned short mountd_protocol;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181};
182
183/* Server capabilities */
184#define NFS_CAP_READDIRPLUS (1U << 0)
185#define NFS_CAP_HARDLINKS (1U << 1)
186#define NFS_CAP_SYMLINKS (1U << 2)
187#define NFS_CAP_ACLS (1U << 3)
188#define NFS_CAP_ATOMIC_OPEN (1U << 4)
Trond Myklebust62ab460c2009-08-09 15:06:19 -0400189#define NFS_CAP_CHANGE_ATTR (1U << 5)
190#define NFS_CAP_FILEID (1U << 6)
191#define NFS_CAP_MODE (1U << 7)
192#define NFS_CAP_NLINK (1U << 8)
193#define NFS_CAP_OWNER (1U << 9)
194#define NFS_CAP_OWNER_GROUP (1U << 10)
195#define NFS_CAP_ATIME (1U << 11)
196#define NFS_CAP_CTIME (1U << 12)
197#define NFS_CAP_MTIME (1U << 13)
Trond Myklebust0df5dd42010-04-11 16:48:44 -0400198#define NFS_CAP_POSIX_LOCK (1U << 14)
Trond Myklebustb064eca22011-02-22 15:44:32 -0800199#define NFS_CAP_UIDGID_NOMAP (1U << 15)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200
Andy Adamson557134a2009-04-01 09:21:53 -0400201
202/* maximum number of slots to use */
Trond Myklebustef159e92012-02-06 19:50:40 -0500203#define NFS4_DEF_SLOT_TABLE_SIZE (16U)
204#define NFS4_MAX_SLOT_TABLE (256U)
Trond Myklebust45d43c22012-02-06 19:38:51 -0500205#define NFS4_NO_SLOT ((u32)-1)
Andy Adamson557134a2009-04-01 09:21:53 -0400206
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400207#if IS_ENABLED(CONFIG_NFS_V4)
Andy Adamson557134a2009-04-01 09:21:53 -0400208
209/* Sessions */
Trond Myklebustef159e92012-02-06 19:50:40 -0500210#define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
Andy Adamson557134a2009-04-01 09:21:53 -0400211struct nfs4_slot_table {
212 struct nfs4_slot *slots; /* seqid per slot */
213 unsigned long used_slots[SLOT_TABLE_SZ]; /* used/unused bitmap */
214 spinlock_t slot_tbl_lock;
215 struct rpc_wait_queue slot_tbl_waitq; /* allocators may wait here */
Trond Myklebust45d43c22012-02-06 19:38:51 -0500216 u32 max_slots; /* # slots in table */
217 u32 highest_used_slotid; /* sent to server on each SEQ.
Andy Adamson557134a2009-04-01 09:21:53 -0400218 * op for dynamic resizing */
Trond Myklebust45d43c22012-02-06 19:38:51 -0500219 u32 target_max_slots; /* Set by CB_RECALL_SLOT as
Andy Adamsonb9efa1b2010-01-20 16:06:27 -0500220 * the new max_slots */
Andy Adamson42acd022011-01-06 02:04:34 +0000221 struct completion complete;
Andy Adamson557134a2009-04-01 09:21:53 -0400222};
223
224static inline int slot_idx(struct nfs4_slot_table *tbl, struct nfs4_slot *sp)
225{
226 return sp - tbl->slots;
227}
228
229/*
230 * Session related parameters
231 */
232struct nfs4_session {
233 struct nfs4_sessionid sess_id;
234 u32 flags;
235 unsigned long session_state;
236 u32 hash_alg;
237 u32 ssv_len;
238
239 /* The fore and back channel */
240 struct nfs4_channel_attrs fc_attrs;
241 struct nfs4_slot_table fc_slot_table;
242 struct nfs4_channel_attrs bc_attrs;
Ricardo Labiagaf8625a62009-04-01 09:23:33 -0400243 struct nfs4_slot_table bc_slot_table;
Andy Adamson557134a2009-04-01 09:21:53 -0400244 struct nfs_client *clp;
245};
246
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500247#endif /* CONFIG_NFS_V4 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248#endif