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