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