Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nfs_fs_sb.h
Go to the documentation of this file.
1 #ifndef _NFS_FS_SB
2 #define _NFS_FS_SB
3 
4 #include <linux/list.h>
5 #include <linux/backing-dev.h>
6 #include <linux/idr.h>
7 #include <linux/wait.h>
8 #include <linux/nfs_xdr.h>
9 #include <linux/sunrpc/xprt.h>
10 
11 #include <linux/atomic.h>
12 
13 struct nfs4_session;
14 struct nfs_iostats;
15 struct nlm_host;
16 struct nfs4_sequence_args;
17 struct nfs4_sequence_res;
18 struct nfs_server;
19 struct nfs4_minor_version_ops;
20 struct nfs41_server_scope;
21 struct nfs41_impl_id;
22 
23 /*
24  * The nfs_client identifies our client state to the server.
25  */
26 struct nfs_client {
29  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 */
32 #define NFS_CS_SESSION_INITING 2 /* busy initialising session */
33  unsigned long cl_res_state; /* NFS resources state */
34 #define NFS_CS_CALLBACK 1 /* - callback started */
35 #define NFS_CS_IDMAP 2 /* - idmap started */
36 #define NFS_CS_RENEWD 3 /* - renewd started */
37 #define NFS_CS_STOP_RENEW 4 /* no more state to renew */
38 #define NFS_CS_CHECK_LEASE_TIME 5 /* need to check lease time */
39  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 */
42 #define NFS_CS_MIGRATION 2 /* - transparent state migr */
43  struct sockaddr_storage cl_addr; /* server identifier */
44  size_t cl_addrlen;
45  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 
50  const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
51  int cl_proto; /* Network transport protocol */
52  struct nfs_subversion * cl_nfs_mod; /* pointer to nfs version module */
53 
54  u32 cl_minorversion;/* NFSv4 minorversion */
55  struct rpc_cred *cl_machine_cred;
56 
57 #if IS_ENABLED(CONFIG_NFS_V4)
58  u64 cl_clientid; /* constant */
59  nfs4_verifier cl_confirm; /* Clientid verifier */
60  unsigned long cl_state;
61 
62  spinlock_t cl_lock;
63 
64  unsigned long cl_lease_time;
65  unsigned long cl_last_renewal;
66  struct delayed_work cl_renewd;
67 
68  struct rpc_wait_queue cl_rpcwaitq;
69 
70  /* idmapper */
71  struct idmap * cl_idmap;
72 
73  /* Our own IP address, as a null-terminated string.
74  * This is used to generate the mv0 callback address.
75  */
76  char cl_ipaddr[48];
77  u32 cl_cb_ident; /* v4.0 callback identifier */
78  const struct nfs4_minor_version_ops *cl_mvops;
79 
80  /* 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;
84  struct nfs4_session *cl_session; /* shared session */
85  bool cl_preserve_clid;
86  struct nfs41_server_owner *cl_serverowner;
87  struct nfs41_server_scope *cl_serverscope;
88  struct nfs41_impl_id *cl_implid;
89 #endif /* CONFIG_NFS_V4 */
90 
91 #ifdef CONFIG_NFS_FSCACHE
92  struct fscache_cookie *fscache; /* client index cache cookie */
93 #endif
94 
95  struct net *cl_net;
96 };
97 
98 /*
99  * NFS client parameters stored in the superblock.
100  */
101 struct nfs_server {
102  struct nfs_client * nfs_client; /* shared client and NFS4 state */
103  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 */
107  struct rpc_clnt * client; /* RPC client handle */
108  struct rpc_clnt * client_acl; /* ACL RPC client handle */
109  struct nlm_host *nlm_host; /* NLM client handle */
110  struct nfs_iostats __percpu *io_stats; /* I/O statistics */
112  atomic_long_t writeback; /* number of writeback pages */
113  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 */
121  unsigned short port; /* "port=" setting */
122  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;
127  unsigned int namelen;
128  unsigned int options; /* extra options enabled by mount */
129 #define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
130 #define NFS_OPTION_MIGRATION 0x00000002 /* - NFSv4 migration enabled */
131 
132  struct nfs_fsid fsid;
133  __u64 maxfilesize; /* maximum file size */
134  struct timespec time_delta; /* smallest time granularity */
135  unsigned long mount_time; /* when this fs was mounted */
136  dev_t s_dev; /* superblock dev numbers */
137 
138 #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 
143  u32 pnfs_blksize; /* layout_blksize attr */
144 #if IS_ENABLED(CONFIG_NFS_V4)
145  u32 attr_bitmask[3];/* V4 bitmask representing the set
146  of attributes supported on this
147  filesystem */
148  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 */
153  u32 acl_bitmask; /* V4 bitmask representing the ACEs
154  that are supported on this
155  filesystem */
156  u32 fh_expire_type; /* V4 bitmask representing file
157  handle volatility type for
158  this filesystem */
159  struct pnfs_layoutdriver_type *pnfs_curr_ld; /* Active layout driver */
160  struct rpc_wait_queue roc_rpcwaitq;
161  void *pnfs_ld_data; /* per mount point data */
162 
163  /* the following fields are protected by nfs_client->cl_lock */
164  struct rb_root state_owners;
165 #endif
171  void (*destroy)(struct nfs_server *);
172 
173  atomic_t active; /* Keep trace of any activity to this server */
174 
175  /* mountd-related mount options */
179  unsigned short mountd_port;
180  unsigned short mountd_protocol;
181 };
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)
189 #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)
198 #define NFS_CAP_POSIX_LOCK (1U << 14)
199 #define NFS_CAP_UIDGID_NOMAP (1U << 15)
200 
201 
202 /* maximum number of slots to use */
203 #define NFS4_DEF_SLOT_TABLE_SIZE (16U)
204 #define NFS4_MAX_SLOT_TABLE (256U)
205 #define NFS4_NO_SLOT ((u32)-1)
206 
207 #if IS_ENABLED(CONFIG_NFS_V4)
208 
209 /* Sessions */
210 #define SLOT_TABLE_SZ DIV_ROUND_UP(NFS4_MAX_SLOT_TABLE, 8*sizeof(long))
211 struct 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 */
216  u32 max_slots; /* # slots in table */
217  u32 highest_used_slotid; /* sent to server on each SEQ.
218  * op for dynamic resizing */
219  u32 target_max_slots; /* Set by CB_RECALL_SLOT as
220  * the new max_slots */
221  struct completion complete;
222 };
223 
224 static 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  */
232 struct 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;
243  struct nfs4_slot_table bc_slot_table;
244  struct nfs_client *clp;
245 };
246 
247 #endif /* CONFIG_NFS_V4 */
248 #endif