Merge branch 'docs-next' of git://git.lwn.net/linux-2.6
[linux-2.6/next.git] / include / linux / nfs_fs_sb.h
blob320569eabe3bcc88dea530ac8634d59223a80409
1 #ifndef _NFS_FS_SB
2 #define _NFS_FS_SB
4 #include <linux/list.h>
5 #include <linux/backing-dev.h>
6 #include <linux/wait.h>
7 #include <linux/nfs_xdr.h>
8 #include <linux/sunrpc/xprt.h>
10 #include <asm/atomic.h>
12 struct nfs4_session;
13 struct nfs_iostats;
14 struct nlm_host;
15 struct nfs4_sequence_args;
16 struct nfs4_sequence_res;
17 struct nfs_server;
20 * The nfs_client identifies our client state to the server.
22 struct nfs_client {
23 atomic_t cl_count;
24 int cl_cons_state; /* current construction state (-ve: init error) */
25 #define NFS_CS_READY 0 /* ready to be used */
26 #define NFS_CS_INITING 1 /* busy initialising */
27 #define NFS_CS_SESSION_INITING 2 /* busy initialising session */
28 unsigned long cl_res_state; /* NFS resources state */
29 #define NFS_CS_CALLBACK 1 /* - callback started */
30 #define NFS_CS_IDMAP 2 /* - idmap started */
31 #define NFS_CS_RENEWD 3 /* - renewd started */
32 struct sockaddr_storage cl_addr; /* server identifier */
33 size_t cl_addrlen;
34 char * cl_hostname; /* hostname of server */
35 struct list_head cl_share_link; /* link in global client list */
36 struct list_head cl_superblocks; /* List of nfs_server structs */
38 struct rpc_clnt * cl_rpcclient;
39 const struct nfs_rpc_ops *rpc_ops; /* NFS protocol vector */
40 int cl_proto; /* Network transport protocol */
42 u32 cl_minorversion;/* NFSv4 minorversion */
43 struct rpc_cred *cl_machine_cred;
45 #ifdef CONFIG_NFS_V4
46 u64 cl_clientid; /* constant */
47 nfs4_verifier cl_confirm;
48 unsigned long cl_state;
50 struct rb_root cl_openowner_id;
51 struct rb_root cl_lockowner_id;
53 struct list_head cl_delegations;
54 struct rb_root cl_state_owners;
55 spinlock_t cl_lock;
57 unsigned long cl_lease_time;
58 unsigned long cl_last_renewal;
59 struct delayed_work cl_renewd;
61 struct rpc_wait_queue cl_rpcwaitq;
63 /* used for the setclientid verifier */
64 struct timespec cl_boot_time;
66 /* idmapper */
67 struct idmap * cl_idmap;
69 /* Our own IP address, as a null-terminated string.
70 * This is used to generate the clientid, and the callback address.
72 char cl_ipaddr[48];
73 unsigned char cl_id_uniquifier;
74 int (* cl_call_sync)(struct nfs_server *server,
75 struct rpc_message *msg,
76 struct nfs4_sequence_args *args,
77 struct nfs4_sequence_res *res,
78 int cache_reply);
79 #endif /* CONFIG_NFS_V4 */
81 #ifdef CONFIG_NFS_V4_1
82 /* clientid returned from EXCHANGE_ID, used by session operations */
83 u64 cl_ex_clid;
84 /* The sequence id to use for the next CREATE_SESSION */
85 u32 cl_seqid;
86 /* The flags used for obtaining the clientid during EXCHANGE_ID */
87 u32 cl_exchange_flags;
88 struct nfs4_session *cl_session; /* sharred session */
89 #endif /* CONFIG_NFS_V4_1 */
91 #ifdef CONFIG_NFS_FSCACHE
92 struct fscache_cookie *fscache; /* client index cache cookie */
93 #endif
97 * NFS client parameters stored in the superblock.
99 struct nfs_server {
100 struct nfs_client * nfs_client; /* shared client and NFS4 state */
101 struct list_head client_link; /* List of other nfs_server structs
102 * that share the same client
104 struct list_head master_link; /* link in master servers list */
105 struct rpc_clnt * client; /* RPC client handle */
106 struct rpc_clnt * client_acl; /* ACL RPC client handle */
107 struct nlm_host *nlm_host; /* NLM client handle */
108 struct nfs_iostats * io_stats; /* I/O statistics */
109 struct backing_dev_info backing_dev_info;
110 atomic_long_t writeback; /* number of writeback pages */
111 int flags; /* various flags */
112 unsigned int caps; /* server capabilities */
113 unsigned int rsize; /* read size */
114 unsigned int rpages; /* read size (in pages) */
115 unsigned int wsize; /* write size */
116 unsigned int wpages; /* write size (in pages) */
117 unsigned int wtmult; /* server disk block size */
118 unsigned int dtsize; /* readdir size */
119 unsigned short port; /* "port=" setting */
120 unsigned int bsize; /* server block size */
121 unsigned int acregmin; /* attr cache timeouts */
122 unsigned int acregmax;
123 unsigned int acdirmin;
124 unsigned int acdirmax;
125 unsigned int namelen;
126 unsigned int options; /* extra options enabled by mount */
127 #define NFS_OPTION_FSCACHE 0x00000001 /* - local caching enabled */
129 struct nfs_fsid fsid;
130 __u64 maxfilesize; /* maximum file size */
131 unsigned long mount_time; /* when this fs was mounted */
132 dev_t s_dev; /* superblock dev numbers */
134 #ifdef CONFIG_NFS_FSCACHE
135 struct nfs_fscache_key *fscache_key; /* unique key for superblock */
136 struct fscache_cookie *fscache; /* superblock cookie */
137 #endif
139 #ifdef CONFIG_NFS_V4
140 u32 attr_bitmask[2];/* V4 bitmask representing the set
141 of attributes supported on this
142 filesystem */
143 u32 cache_consistency_bitmask[2];
144 /* V4 bitmask representing the subset
145 of change attribute, size, ctime
146 and mtime attributes supported by
147 the server */
148 u32 acl_bitmask; /* V4 bitmask representing the ACEs
149 that are supported on this
150 filesystem */
151 #endif
152 void (*destroy)(struct nfs_server *);
154 atomic_t active; /* Keep trace of any activity to this server */
156 /* mountd-related mount options */
157 struct sockaddr_storage mountd_address;
158 size_t mountd_addrlen;
159 u32 mountd_version;
160 unsigned short mountd_port;
161 unsigned short mountd_protocol;
164 /* Server capabilities */
165 #define NFS_CAP_READDIRPLUS (1U << 0)
166 #define NFS_CAP_HARDLINKS (1U << 1)
167 #define NFS_CAP_SYMLINKS (1U << 2)
168 #define NFS_CAP_ACLS (1U << 3)
169 #define NFS_CAP_ATOMIC_OPEN (1U << 4)
170 #define NFS_CAP_CHANGE_ATTR (1U << 5)
171 #define NFS_CAP_FILEID (1U << 6)
172 #define NFS_CAP_MODE (1U << 7)
173 #define NFS_CAP_NLINK (1U << 8)
174 #define NFS_CAP_OWNER (1U << 9)
175 #define NFS_CAP_OWNER_GROUP (1U << 10)
176 #define NFS_CAP_ATIME (1U << 11)
177 #define NFS_CAP_CTIME (1U << 12)
178 #define NFS_CAP_MTIME (1U << 13)
181 /* maximum number of slots to use */
182 #define NFS4_MAX_SLOT_TABLE RPC_MAX_SLOT_TABLE
184 #if defined(CONFIG_NFS_V4_1)
186 /* Sessions */
187 #define SLOT_TABLE_SZ (NFS4_MAX_SLOT_TABLE/(8*sizeof(long)))
188 struct nfs4_slot_table {
189 struct nfs4_slot *slots; /* seqid per slot */
190 unsigned long used_slots[SLOT_TABLE_SZ]; /* used/unused bitmap */
191 spinlock_t slot_tbl_lock;
192 struct rpc_wait_queue slot_tbl_waitq; /* allocators may wait here */
193 int max_slots; /* # slots in table */
194 int highest_used_slotid; /* sent to server on each SEQ.
195 * op for dynamic resizing */
198 static inline int slot_idx(struct nfs4_slot_table *tbl, struct nfs4_slot *sp)
200 return sp - tbl->slots;
204 * Session related parameters
206 struct nfs4_session {
207 struct nfs4_sessionid sess_id;
208 u32 flags;
209 unsigned long session_state;
210 u32 hash_alg;
211 u32 ssv_len;
213 /* The fore and back channel */
214 struct nfs4_channel_attrs fc_attrs;
215 struct nfs4_slot_table fc_slot_table;
216 struct nfs4_channel_attrs bc_attrs;
217 struct nfs4_slot_table bc_slot_table;
218 struct nfs_client *clp;
221 #endif /* CONFIG_NFS_V4_1 */
222 #endif