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