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