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