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