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