Merge branch 'v4l_for_linus' of git://git.kernel.org/pub/scm/linux/kernel/git/mchehab...
[linux-2.6-block.git] / fs / nfs / nfs4_fs.h
CommitLineData
4ce79717
TM
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#ifdef CONFIG_NFS_V4
13
14struct idmap;
15
4ce79717 16enum nfs4_client_state {
e005e804 17 NFS4CLNT_MANAGER_RUNNING = 0,
e598d843 18 NFS4CLNT_CHECK_LEASE,
58d9714a 19 NFS4CLNT_LEASE_EXPIRED,
b79a4a1b
TM
20 NFS4CLNT_RECLAIM_REBOOT,
21 NFS4CLNT_RECLAIM_NOGRACE,
707fb4b3 22 NFS4CLNT_DELEGRETURN,
43f1b3da 23 NFS4CLNT_LAYOUTRECALL,
6df08189 24 NFS4CLNT_SESSION_RESET,
b9efa1b2 25 NFS4CLNT_RECALL_SLOT,
fd954ae1 26 NFS4CLNT_LEASE_CONFIRM,
78fe0f41 27 NFS4CLNT_SERVER_SCOPE_MISMATCH,
4ce79717
TM
28};
29
a2118c33 30enum nfs4_session_state {
1055d76d 31 NFS4_SESSION_INITING,
a2118c33
TM
32 NFS4_SESSION_DRAINING,
33};
34
2f60ea6b
TM
35#define NFS4_RENEW_TIMEOUT 0x01
36#define NFS4_RENEW_DELEGATION_CB 0x02
37
97dc1359
TM
38struct nfs4_minor_version_ops {
39 u32 minor_version;
40
7c513058
BS
41 int (*call_sync)(struct rpc_clnt *clnt,
42 struct nfs_server *server,
97dc1359
TM
43 struct rpc_message *msg,
44 struct nfs4_sequence_args *args,
45 struct nfs4_sequence_res *res,
46 int cache_reply);
e047a10c
TM
47 int (*validate_stateid)(struct nfs_delegation *,
48 const nfs4_stateid *);
fca78d6d
BS
49 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
50 struct nfs_fsinfo *);
c48f4f35
TM
51 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
52 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
53 const struct nfs4_state_maintenance_ops *state_renewal_ops;
97dc1359
TM
54};
55
cee54fc9
TM
56/*
57 * struct rpc_sequence ensures that RPC calls are sent in the exact
58 * order that they appear on the list.
59 */
60struct rpc_sequence {
61 struct rpc_wait_queue wait; /* RPC call delay queue */
62 spinlock_t lock; /* Protects the list */
63 struct list_head list; /* Defines sequence of RPC calls */
64};
65
66#define NFS_SEQID_CONFIRMED 1
67struct nfs_seqid_counter {
68 struct rpc_sequence *sequence;
69 int flags;
70 u32 counter;
71};
72
73struct nfs_seqid {
cee54fc9 74 struct nfs_seqid_counter *sequence;
4e51336a 75 struct list_head list;
cee54fc9
TM
76};
77
78static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
79{
80 if (seqid_mutating_err(-status))
81 seqid->flags |= NFS_SEQID_CONFIRMED;
82}
83
9f958ab8
TM
84struct nfs_unique_id {
85 struct rb_node rb_node;
86 __u64 id;
87};
88
4ce79717
TM
89/*
90 * NFS4 state_owners and lock_owners are simply labels for ordered
91 * sequences of RPC calls. Their sole purpose is to provide once-only
92 * semantics by allowing the server to identify replayed requests.
4ce79717
TM
93 */
94struct nfs4_state_owner {
9f958ab8 95 struct nfs_unique_id so_owner_id;
6f2e64d3 96 struct nfs_server *so_server;
0aaaf5c4
CL
97 struct list_head so_lru;
98 unsigned long so_expires;
24d292b8 99 struct rb_node so_server_node;
4ce79717
TM
100
101 struct rpc_cred *so_cred; /* Associated cred */
9f958ab8
TM
102
103 spinlock_t so_lock;
104 atomic_t so_count;
7eff03ae 105 unsigned long so_flags;
4ce79717 106 struct list_head so_states;
cee54fc9
TM
107 struct nfs_seqid_counter so_seqid;
108 struct rpc_sequence so_sequence;
4ce79717
TM
109};
110
7eff03ae
TM
111enum {
112 NFS_OWNER_RECLAIM_REBOOT,
113 NFS_OWNER_RECLAIM_NOGRACE
114};
115
afe6c27c
AB
116#define NFS_LOCK_NEW 0
117#define NFS_LOCK_RECLAIM 1
118#define NFS_LOCK_EXPIRED 2
119
4ce79717
TM
120/*
121 * struct nfs4_state maintains the client-side state for a given
122 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
123 *
124 * OPEN:
125 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
126 * we need to know how many files are open for reading or writing on a
127 * given inode. This information too is stored here.
128 *
129 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
130 */
131
77041ed9
TM
132struct nfs4_lock_owner {
133 unsigned int lo_type;
134#define NFS4_ANY_LOCK_TYPE (0U)
135#define NFS4_FLOCK_LOCK_TYPE (1U << 0)
136#define NFS4_POSIX_LOCK_TYPE (1U << 1)
137 union {
138 fl_owner_t posix_owner;
139 pid_t flock_owner;
140 } lo_u;
141};
142
4ce79717
TM
143struct nfs4_lock_state {
144 struct list_head ls_locks; /* Other lock stateids */
8d0a8a9d 145 struct nfs4_state * ls_state; /* Pointer to open state */
4ce79717
TM
146#define NFS_LOCK_INITIALIZED 1
147 int ls_flags;
cee54fc9 148 struct nfs_seqid_counter ls_seqid;
d0dc3701 149 struct rpc_sequence ls_sequence;
9f958ab8 150 struct nfs_unique_id ls_id;
4ce79717
TM
151 nfs4_stateid ls_stateid;
152 atomic_t ls_count;
77041ed9 153 struct nfs4_lock_owner ls_owner;
4ce79717
TM
154};
155
156/* bits for nfs4_state->flags */
157enum {
158 LK_STATE_IN_USE,
003707c7
TM
159 NFS_DELEGATED_STATE, /* Current stateid is delegation */
160 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
161 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
162 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
b79a4a1b
TM
163 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
164 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
8e469ebd 165 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
4ce79717
TM
166};
167
168struct nfs4_state {
169 struct list_head open_states; /* List of states for the same state_owner */
170 struct list_head inode_states; /* List of states for the same inode */
171 struct list_head lock_states; /* List of subservient lock stateids */
172
173 struct nfs4_state_owner *owner; /* Pointer to the open owner */
174 struct inode *inode; /* Pointer to the inode */
175
176 unsigned long flags; /* Do we hold any locks? */
8d0a8a9d 177 spinlock_t state_lock; /* Protects the lock_states list */
4ce79717 178
8bda4e4c 179 seqlock_t seqlock; /* Protects the stateid/open_stateid */
003707c7
TM
180 nfs4_stateid stateid; /* Current stateid: may be delegation */
181 nfs4_stateid open_stateid; /* OPEN stateid */
4ce79717 182
8bda4e4c 183 /* The following 3 fields are protected by owner->so_lock */
003707c7
TM
184 unsigned int n_rdonly; /* Number of read-only references */
185 unsigned int n_wronly; /* Number of write-only references */
186 unsigned int n_rdwr; /* Number of read/write references */
dc0b027d 187 fmode_t state; /* State on the server (R,W, or RW) */
4ce79717
TM
188 atomic_t count;
189};
190
191
192struct nfs4_exception {
193 long timeout;
194 int retry;
9e33bed5 195 struct nfs4_state *state;
4ce79717
TM
196};
197
198struct nfs4_state_recovery_ops {
7eff03ae 199 int owner_flag_bit;
b79a4a1b 200 int state_flag_bit;
4ce79717
TM
201 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
202 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
591d71cb 203 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
90a16617 204 struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
fce5c838 205 int (*reclaim_complete)(struct nfs_client *);
4ce79717
TM
206};
207
29fba38b 208struct nfs4_state_maintenance_ops {
2f60ea6b 209 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
a7b72103 210 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
8e69514f 211 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
29fba38b
BH
212};
213
f786aa90 214extern const struct dentry_operations nfs4_dentry_operations;
92e1d5be 215extern const struct inode_operations nfs4_dir_inode_operations;
6b3b5496 216
4ce79717 217/* nfs4proc.c */
bb8b27e5
TM
218extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
219extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
4d643d1d 220extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
591d71cb 221extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
4d643d1d 222extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
643168c2 223extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
55a97593 224extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
56659e99 225extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
7aaa0b3b 226 struct nfs4_fs_locations *fs_locations, struct page *page);
d3c7b7cc 227extern void nfs4_release_lockowner(const struct nfs4_lock_state *);
64c2ce8b 228extern const struct xattr_handler *nfs4_xattr_handlers[];
4ce79717 229
557134a3 230#if defined(CONFIG_NFS_V4_1)
035168ab
TM
231static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
232{
233 return server->nfs_client->cl_session;
234}
235
236extern int nfs4_setup_sequence(const struct nfs_server *server,
fbcd4abc
AA
237 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
238 int cache_reply, struct rpc_task *task);
dc70d7b3
AA
239extern int nfs41_setup_sequence(struct nfs4_session *session,
240 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
241 int cache_reply, struct rpc_task *task);
557134a3
AA
242extern void nfs4_destroy_session(struct nfs4_session *session);
243extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
f26468fb 244extern int nfs4_proc_create_session(struct nfs_client *);
c3fad1b1 245extern int nfs4_proc_destroy_session(struct nfs4_session *);
fccba804 246extern int nfs4_init_session(struct nfs_server *server);
9430fb6b
RL
247extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
248 struct nfs_fsinfo *fsinfo);
863a3c6c 249extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
ef311537 250 bool sync);
94de8b27
AA
251
252static inline bool
253is_ds_only_client(struct nfs_client *clp)
254{
255 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
256 EXCHGID4_FLAG_USE_PNFS_DS;
257}
d83217c1
AA
258
259static inline bool
260is_ds_client(struct nfs_client *clp)
261{
262 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
263}
fbcd4abc 264#else /* CONFIG_NFS_v4_1 */
035168ab
TM
265static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
266{
267 return NULL;
268}
269
270static inline int nfs4_setup_sequence(const struct nfs_server *server,
fbcd4abc
AA
271 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
272 int cache_reply, struct rpc_task *task)
273{
274 return 0;
275}
fccba804
TM
276
277static inline int nfs4_init_session(struct nfs_server *server)
278{
279 return 0;
280}
94de8b27
AA
281
282static inline bool
283is_ds_only_client(struct nfs_client *clp)
d83217c1
AA
284{
285 return false;
286}
287
288static inline bool
289is_ds_client(struct nfs_client *clp)
94de8b27
AA
290{
291 return false;
292}
557134a3 293#endif /* CONFIG_NFS_V4_1 */
4ce79717 294
97dc1359 295extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
29fba38b 296
4ce79717
TM
297extern const u32 nfs4_fattr_bitmap[2];
298extern const u32 nfs4_statfs_bitmap[2];
299extern const u32 nfs4_pathconf_bitmap[2];
dae100c2 300extern const u32 nfs4_fsinfo_bitmap[3];
830b8e33 301extern const u32 nfs4_fs_locations_bitmap[2];
4ce79717
TM
302
303/* nfs4renewd.c */
adfa6f98 304extern void nfs4_schedule_state_renewal(struct nfs_client *);
4ce79717 305extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
adfa6f98 306extern void nfs4_kill_renewd(struct nfs_client *);
65f27f38 307extern void nfs4_renew_state(struct work_struct *);
4ce79717
TM
308
309/* nfs4state.c */
a7b72103 310struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
6dc9d57a 311struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
a7b72103
AA
312#if defined(CONFIG_NFS_V4_1)
313struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
b4b82607 314struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
0400a6b0
TM
315extern void nfs4_schedule_session_recovery(struct nfs4_session *);
316#else
317static inline void nfs4_schedule_session_recovery(struct nfs4_session *session)
318{
319}
a7b72103 320#endif /* CONFIG_NFS_V4_1 */
4ce79717
TM
321
322extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
323extern void nfs4_put_state_owner(struct nfs4_state_owner *);
0aaaf5c4 324extern void nfs4_purge_state_owners(struct nfs_server *);
4ce79717
TM
325extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
326extern void nfs4_put_open_state(struct nfs4_state *);
643168c2
AV
327extern void nfs4_close_state(struct nfs4_state *, fmode_t);
328extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
dc0b027d 329extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
0400a6b0 330extern void nfs4_schedule_lease_recovery(struct nfs_client *);
b0d3ded1 331extern void nfs4_schedule_state_manager(struct nfs_client *);
042b60be 332extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
0400a6b0 333extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
0629e370 334extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
b9efa1b2 335extern void nfs41_handle_recall_slot(struct nfs_client *clp);
78fe0f41
WAA
336extern void nfs41_handle_server_scope(struct nfs_client *,
337 struct server_scope **);
faf5f49c 338extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
8d0a8a9d 339extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
77041ed9 340extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t, pid_t);
4ce79717 341
8535b2be 342extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
cee54fc9
TM
343extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
344extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
345extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
72211dbe 346extern void nfs_release_seqid(struct nfs_seqid *seqid);
cee54fc9
TM
347extern void nfs_free_seqid(struct nfs_seqid *seqid);
348
4ce79717
TM
349extern const nfs4_stateid zero_stateid;
350
351/* nfs4xdr.c */
4ce79717
TM
352extern struct rpc_procinfo nfs4_procedures[];
353
354struct nfs4_mount_data;
355
356/* callback_xdr.c */
357extern struct svc_version nfs4_callback_version1;
07bccc2d 358extern struct svc_version nfs4_callback_version4;
4ce79717
TM
359
360#else
361
643168c2
AV
362#define nfs4_close_state(a, b) do { } while (0)
363#define nfs4_close_sync(a, b) do { } while (0)
4ce79717
TM
364
365#endif /* CONFIG_NFS_V4 */
366#endif /* __LINUX_FS_NFS_NFS4_FS.H */