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