Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
nfs4_fs.h
Go to the documentation of this file.
1 /*
2  * linux/fs/nfs/nfs4_fs.h
3  *
4  * Copyright (C) 2005 Trond Myklebust
5  *
6  * NFSv4-specific filesystem definitions and declarations
7  */
8 
9 #ifndef __LINUX_FS_NFS_NFS4_FS_H
10 #define __LINUX_FS_NFS_NFS4_FS_H
11 
12 #if IS_ENABLED(CONFIG_NFS_V4)
13 
14 struct idmap;
15 
16 enum nfs4_client_state {
17  NFS4CLNT_MANAGER_RUNNING = 0,
18  NFS4CLNT_CHECK_LEASE,
19  NFS4CLNT_LEASE_EXPIRED,
20  NFS4CLNT_RECLAIM_REBOOT,
21  NFS4CLNT_RECLAIM_NOGRACE,
22  NFS4CLNT_DELEGRETURN,
23  NFS4CLNT_SESSION_RESET,
24  NFS4CLNT_RECALL_SLOT,
25  NFS4CLNT_LEASE_CONFIRM,
26  NFS4CLNT_SERVER_SCOPE_MISMATCH,
27  NFS4CLNT_PURGE_STATE,
28  NFS4CLNT_BIND_CONN_TO_SESSION,
29 };
30 
31 enum nfs4_session_state {
32  NFS4_SESSION_INITING,
33  NFS4_SESSION_DRAINING,
34 };
35 
36 #define NFS4_RENEW_TIMEOUT 0x01
37 #define NFS4_RENEW_DELEGATION_CB 0x02
38 
39 struct nfs4_minor_version_ops {
40  u32 minor_version;
41 
42  int (*call_sync)(struct rpc_clnt *clnt,
43  struct nfs_server *server,
44  struct rpc_message *msg,
45  struct nfs4_sequence_args *args,
46  struct nfs4_sequence_res *res,
47  int cache_reply);
48  bool (*match_stateid)(const nfs4_stateid *,
49  const nfs4_stateid *);
50  int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
51  struct nfs_fsinfo *);
52  const struct nfs4_state_recovery_ops *reboot_recovery_ops;
53  const struct nfs4_state_recovery_ops *nograce_recovery_ops;
54  const struct nfs4_state_maintenance_ops *state_renewal_ops;
55 };
56 
57 #define NFS_SEQID_CONFIRMED 1
58 struct nfs_seqid_counter {
59  ktime_t create_time;
60  int owner_id;
61  int flags;
62  u32 counter;
63  spinlock_t lock; /* Protects the list */
64  struct list_head list; /* Defines sequence of RPC calls */
65  struct rpc_wait_queue wait; /* RPC call delay queue */
66 };
67 
68 struct nfs_seqid {
69  struct nfs_seqid_counter *sequence;
70  struct list_head list;
71  struct rpc_task *task;
72 };
73 
74 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
75 {
76  if (seqid_mutating_err(-status))
77  seqid->flags |= NFS_SEQID_CONFIRMED;
78 }
79 
80 /*
81  * NFS4 state_owners and lock_owners are simply labels for ordered
82  * sequences of RPC calls. Their sole purpose is to provide once-only
83  * semantics by allowing the server to identify replayed requests.
84  */
85 struct nfs4_state_owner {
86  struct nfs_server *so_server;
87  struct list_head so_lru;
88  unsigned long so_expires;
89  struct rb_node so_server_node;
90 
91  struct rpc_cred *so_cred; /* Associated cred */
92 
93  spinlock_t so_lock;
94  atomic_t so_count;
95  unsigned long so_flags;
96  struct list_head so_states;
97  struct nfs_seqid_counter so_seqid;
98 };
99 
100 enum {
101  NFS_OWNER_RECLAIM_REBOOT,
102  NFS_OWNER_RECLAIM_NOGRACE
103 };
104 
105 #define NFS_LOCK_NEW 0
106 #define NFS_LOCK_RECLAIM 1
107 #define NFS_LOCK_EXPIRED 2
108 
109 /*
110  * struct nfs4_state maintains the client-side state for a given
111  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
112  *
113  * OPEN:
114  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
115  * we need to know how many files are open for reading or writing on a
116  * given inode. This information too is stored here.
117  *
118  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
119  */
120 
121 struct nfs4_lock_owner {
122  unsigned int lo_type;
123 #define NFS4_ANY_LOCK_TYPE (0U)
124 #define NFS4_FLOCK_LOCK_TYPE (1U << 0)
125 #define NFS4_POSIX_LOCK_TYPE (1U << 1)
126  union {
127  fl_owner_t posix_owner;
128  pid_t flock_owner;
129  } lo_u;
130 };
131 
132 struct nfs4_lock_state {
133  struct list_head ls_locks; /* Other lock stateids */
134  struct nfs4_state * ls_state; /* Pointer to open state */
135 #define NFS_LOCK_INITIALIZED 0
136  unsigned long ls_flags;
137  struct nfs_seqid_counter ls_seqid;
138  nfs4_stateid ls_stateid;
139  atomic_t ls_count;
140  struct nfs4_lock_owner ls_owner;
141 };
142 
143 /* bits for nfs4_state->flags */
144 enum {
145  LK_STATE_IN_USE,
146  NFS_DELEGATED_STATE, /* Current stateid is delegation */
147  NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
148  NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
149  NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
150  NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
151  NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
152  NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
153 };
154 
155 struct nfs4_state {
156  struct list_head open_states; /* List of states for the same state_owner */
157  struct list_head inode_states; /* List of states for the same inode */
158  struct list_head lock_states; /* List of subservient lock stateids */
159 
160  struct nfs4_state_owner *owner; /* Pointer to the open owner */
161  struct inode *inode; /* Pointer to the inode */
162 
163  unsigned long flags; /* Do we hold any locks? */
164  spinlock_t state_lock; /* Protects the lock_states list */
165 
166  seqlock_t seqlock; /* Protects the stateid/open_stateid */
167  nfs4_stateid stateid; /* Current stateid: may be delegation */
168  nfs4_stateid open_stateid; /* OPEN stateid */
169 
170  /* The following 3 fields are protected by owner->so_lock */
171  unsigned int n_rdonly; /* Number of read-only references */
172  unsigned int n_wronly; /* Number of write-only references */
173  unsigned int n_rdwr; /* Number of read/write references */
174  fmode_t state; /* State on the server (R,W, or RW) */
175  atomic_t count;
176 };
177 
178 
179 struct nfs4_exception {
180  long timeout;
181  int retry;
182  struct nfs4_state *state;
183  struct inode *inode;
184 };
185 
186 struct nfs4_state_recovery_ops {
187  int owner_flag_bit;
188  int state_flag_bit;
189  int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
190  int (*recover_lock)(struct nfs4_state *, struct file_lock *);
191  int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
192  struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
193  int (*reclaim_complete)(struct nfs_client *);
194  int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
195  struct rpc_cred *);
196 };
197 
198 struct nfs4_state_maintenance_ops {
199  int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
200  struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
201  int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
202 };
203 
204 extern const struct dentry_operations nfs4_dentry_operations;
205 
206 /* dir.c */
207 int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
208  unsigned, umode_t, int *);
209 
210 /* super.c */
211 extern struct file_system_type nfs4_fs_type;
212 
213 /* nfs4namespace.c */
214 rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
215 struct rpc_clnt *nfs4_create_sec_client(struct rpc_clnt *, struct inode *, struct qstr *);
216 struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
217  struct nfs_fh *, struct nfs_fattr *);
218 
219 /* nfs4proc.c */
220 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
221 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
222 extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *);
223 extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
224 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
225 extern int nfs4_destroy_clientid(struct nfs_client *clp);
226 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
227 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
228 extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
229 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
230 extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
231  struct nfs4_fs_locations *, struct page *);
232 extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
233  struct nfs_fh *, struct nfs_fattr *);
234 extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
235 extern int nfs4_release_lockowner(struct nfs4_lock_state *);
236 extern const struct xattr_handler *nfs4_xattr_handlers[];
237 
238 #if defined(CONFIG_NFS_V4_1)
239 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
240 {
241  return server->nfs_client->cl_session;
242 }
243 
244 extern bool nfs4_set_task_privileged(struct rpc_task *task, void *dummy);
245 extern int nfs4_setup_sequence(const struct nfs_server *server,
246  struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
247  struct rpc_task *task);
248 extern int nfs41_setup_sequence(struct nfs4_session *session,
249  struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
250  struct rpc_task *task);
251 extern void nfs4_destroy_session(struct nfs4_session *session);
252 extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
253 extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
254 extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
255 extern int nfs4_init_session(struct nfs_server *server);
256 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
257  struct nfs_fsinfo *fsinfo);
258 extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
259  bool sync);
260 
261 static inline bool
262 is_ds_only_client(struct nfs_client *clp)
263 {
264  return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
265  EXCHGID4_FLAG_USE_PNFS_DS;
266 }
267 
268 static inline bool
269 is_ds_client(struct nfs_client *clp)
270 {
271  return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
272 }
273 #else /* CONFIG_NFS_v4_1 */
274 static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
275 {
276  return NULL;
277 }
278 
279 static inline int nfs4_setup_sequence(const struct nfs_server *server,
280  struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
281  struct rpc_task *task)
282 {
283  return 0;
284 }
285 
286 static inline int nfs4_init_session(struct nfs_server *server)
287 {
288  return 0;
289 }
290 
291 static inline bool
292 is_ds_only_client(struct nfs_client *clp)
293 {
294  return false;
295 }
296 
297 static inline bool
298 is_ds_client(struct nfs_client *clp)
299 {
300  return false;
301 }
302 #endif /* CONFIG_NFS_V4_1 */
303 
304 extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
305 
306 extern const u32 nfs4_fattr_bitmap[3];
307 extern const u32 nfs4_statfs_bitmap[2];
308 extern const u32 nfs4_pathconf_bitmap[2];
309 extern const u32 nfs4_fsinfo_bitmap[3];
310 extern const u32 nfs4_fs_locations_bitmap[2];
311 
312 void nfs4_free_client(struct nfs_client *);
313 
314 struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
315 
316 /* nfs4renewd.c */
317 extern void nfs4_schedule_state_renewal(struct nfs_client *);
318 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
319 extern void nfs4_kill_renewd(struct nfs_client *);
320 extern void nfs4_renew_state(struct work_struct *);
321 
322 /* nfs4state.c */
323 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
324 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
325 int nfs4_discover_server_trunking(struct nfs_client *clp,
326  struct nfs_client **);
327 int nfs40_discover_server_trunking(struct nfs_client *clp,
328  struct nfs_client **, struct rpc_cred *);
329 #if defined(CONFIG_NFS_V4_1)
330 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
331 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
332 int nfs41_discover_server_trunking(struct nfs_client *clp,
333  struct nfs_client **, struct rpc_cred *);
334 extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
335 #else
336 static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
337 {
338 }
339 #endif /* CONFIG_NFS_V4_1 */
340 
341 extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
342 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
343 extern void nfs4_purge_state_owners(struct nfs_server *);
344 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
345 extern void nfs4_put_open_state(struct nfs4_state *);
346 extern void nfs4_close_state(struct nfs4_state *, fmode_t);
347 extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
348 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
349 extern void nfs_inode_find_state_and_recover(struct inode *inode,
350  const nfs4_stateid *stateid);
351 extern void nfs4_schedule_lease_recovery(struct nfs_client *);
352 extern void nfs4_schedule_state_manager(struct nfs_client *);
353 extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
354 extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
355 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
356 extern void nfs41_handle_recall_slot(struct nfs_client *clp);
357 extern void nfs41_handle_server_scope(struct nfs_client *,
358  struct nfs41_server_scope **);
359 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
360 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
361 extern void nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
362  fmode_t, const struct nfs_lockowner *);
363 
364 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
365 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
366 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
367 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
368 extern void nfs_release_seqid(struct nfs_seqid *seqid);
369 extern void nfs_free_seqid(struct nfs_seqid *seqid);
370 
371 extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
372 
373 extern const nfs4_stateid zero_stateid;
374 
375 /* nfs4super.c */
376 struct nfs_mount_info;
377 extern struct nfs_subversion nfs_v4;
378 struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
379 extern bool nfs4_disable_idmapping;
380 extern unsigned short max_session_slots;
381 extern unsigned short send_implementation_id;
382 
383 #define NFS4_CLIENT_ID_UNIQ_LEN (64)
384 extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
385 
386 /* nfs4sysctl.c */
387 #ifdef CONFIG_SYSCTL
388 int nfs4_register_sysctl(void);
389 void nfs4_unregister_sysctl(void);
390 #else
391 static inline int nfs4_register_sysctl(void)
392 {
393  return 0;
394 }
395 
396 static inline void nfs4_unregister_sysctl(void)
397 {
398 }
399 #endif
400 
401 /* nfs4xdr.c */
402 extern struct rpc_procinfo nfs4_procedures[];
403 
404 struct nfs4_mount_data;
405 
406 /* callback_xdr.c */
407 extern struct svc_version nfs4_callback_version1;
408 extern struct svc_version nfs4_callback_version4;
409 
410 static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
411 {
412  memcpy(dst, src, sizeof(*dst));
413 }
414 
415 static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
416 {
417  return memcmp(dst, src, sizeof(*dst)) == 0;
418 }
419 
420 #else
421 
422 #define nfs4_close_state(a, b) do { } while (0)
423 #define nfs4_close_sync(a, b) do { } while (0)
424 
425 #endif /* CONFIG_NFS_V4 */
426 #endif /* __LINUX_FS_NFS_NFS4_FS.H */
Generated on Thu Jan 10 2013 14:48:28 for Linux Kernel by   doxygen 1.8.2