nfs41: rename cl_state session SETUP bit to RESET
[linux-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
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,
4ce79717
TM
48};
49
cee54fc9
TM
50/*
51 * struct rpc_sequence ensures that RPC calls are sent in the exact
52 * order that they appear on the list.
53 */
54struct rpc_sequence {
55 struct rpc_wait_queue wait; /* RPC call delay queue */
56 spinlock_t lock; /* Protects the list */
57 struct list_head list; /* Defines sequence of RPC calls */
58};
59
60#define NFS_SEQID_CONFIRMED 1
61struct nfs_seqid_counter {
62 struct rpc_sequence *sequence;
63 int flags;
64 u32 counter;
65};
66
67struct nfs_seqid {
cee54fc9 68 struct nfs_seqid_counter *sequence;
4e51336a 69 struct list_head list;
cee54fc9
TM
70};
71
72static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
73{
74 if (seqid_mutating_err(-status))
75 seqid->flags |= NFS_SEQID_CONFIRMED;
76}
77
9f958ab8
TM
78struct nfs_unique_id {
79 struct rb_node rb_node;
80 __u64 id;
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 {
9f958ab8 89 struct nfs_unique_id so_owner_id;
adfa6f98 90 struct nfs_client *so_client;
6f2e64d3 91 struct nfs_server *so_server;
9f958ab8 92 struct rb_node so_client_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
TM
99 struct list_head so_states;
100 struct list_head so_delegations;
cee54fc9
TM
101 struct nfs_seqid_counter so_seqid;
102 struct rpc_sequence so_sequence;
4ce79717
TM
103};
104
7eff03ae
TM
105enum {
106 NFS_OWNER_RECLAIM_REBOOT,
107 NFS_OWNER_RECLAIM_NOGRACE
108};
109
4ce79717
TM
110/*
111 * struct nfs4_state maintains the client-side state for a given
112 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
113 *
114 * OPEN:
115 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
116 * we need to know how many files are open for reading or writing on a
117 * given inode. This information too is stored here.
118 *
119 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
120 */
121
122struct nfs4_lock_state {
123 struct list_head ls_locks; /* Other lock stateids */
8d0a8a9d 124 struct nfs4_state * ls_state; /* Pointer to open state */
4ce79717
TM
125 fl_owner_t ls_owner; /* POSIX lock owner */
126#define NFS_LOCK_INITIALIZED 1
127 int ls_flags;
cee54fc9 128 struct nfs_seqid_counter ls_seqid;
d0dc3701 129 struct rpc_sequence ls_sequence;
9f958ab8 130 struct nfs_unique_id ls_id;
4ce79717
TM
131 nfs4_stateid ls_stateid;
132 atomic_t ls_count;
133};
134
135/* bits for nfs4_state->flags */
136enum {
137 LK_STATE_IN_USE,
003707c7
TM
138 NFS_DELEGATED_STATE, /* Current stateid is delegation */
139 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
140 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
141 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
b79a4a1b
TM
142 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
143 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
4ce79717
TM
144};
145
146struct nfs4_state {
147 struct list_head open_states; /* List of states for the same state_owner */
148 struct list_head inode_states; /* List of states for the same inode */
149 struct list_head lock_states; /* List of subservient lock stateids */
150
151 struct nfs4_state_owner *owner; /* Pointer to the open owner */
152 struct inode *inode; /* Pointer to the inode */
153
154 unsigned long flags; /* Do we hold any locks? */
8d0a8a9d 155 spinlock_t state_lock; /* Protects the lock_states list */
4ce79717 156
8bda4e4c 157 seqlock_t seqlock; /* Protects the stateid/open_stateid */
003707c7
TM
158 nfs4_stateid stateid; /* Current stateid: may be delegation */
159 nfs4_stateid open_stateid; /* OPEN stateid */
4ce79717 160
8bda4e4c 161 /* The following 3 fields are protected by owner->so_lock */
003707c7
TM
162 unsigned int n_rdonly; /* Number of read-only references */
163 unsigned int n_wronly; /* Number of write-only references */
164 unsigned int n_rdwr; /* Number of read/write references */
dc0b027d 165 fmode_t state; /* State on the server (R,W, or RW) */
4ce79717
TM
166 atomic_t count;
167};
168
169
170struct nfs4_exception {
171 long timeout;
172 int retry;
9e33bed5 173 struct nfs4_state *state;
4ce79717
TM
174};
175
176struct nfs4_state_recovery_ops {
7eff03ae 177 int owner_flag_bit;
b79a4a1b 178 int state_flag_bit;
4ce79717
TM
179 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
180 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
591d71cb 181 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
90a16617 182 struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
4ce79717
TM
183};
184
29fba38b
BH
185struct nfs4_state_maintenance_ops {
186 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
a7b72103 187 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
8e69514f 188 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
29fba38b
BH
189};
190
f786aa90 191extern const struct dentry_operations nfs4_dentry_operations;
92e1d5be 192extern const struct inode_operations nfs4_dir_inode_operations;
6b3b5496
BF
193
194/* inode.c */
195extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
196extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
197extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
198
4ce79717
TM
199
200/* nfs4proc.c */
adfa6f98
DH
201extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
202extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
4d643d1d 203extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
adfa6f98
DH
204extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
205extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
591d71cb 206extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
4d643d1d 207extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
a49c3c77 208extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait);
02a913a7
TM
209extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
210extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
55a97593 211extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
56659e99 212extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
7aaa0b3b 213 struct nfs4_fs_locations *fs_locations, struct page *page);
4ce79717 214
591d71cb
AA
215extern struct nfs4_state_recovery_ops *nfs4_reboot_recovery_ops[];
216extern struct nfs4_state_recovery_ops *nfs4_nograce_recovery_ops[];
557134a3 217#if defined(CONFIG_NFS_V4_1)
fbcd4abc
AA
218extern int nfs4_setup_sequence(struct nfs_client *clp,
219 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
220 int cache_reply, struct rpc_task *task);
557134a3
AA
221extern void nfs4_destroy_session(struct nfs4_session *session);
222extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
76db6d95 223extern int nfs4_proc_create_session(struct nfs_client *, int reset);
c3fad1b1 224extern int nfs4_proc_destroy_session(struct nfs4_session *);
fccba804 225extern int nfs4_init_session(struct nfs_server *server);
fbcd4abc
AA
226#else /* CONFIG_NFS_v4_1 */
227static inline int nfs4_setup_sequence(struct nfs_client *clp,
228 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
229 int cache_reply, struct rpc_task *task)
230{
231 return 0;
232}
fccba804
TM
233
234static inline int nfs4_init_session(struct nfs_server *server)
235{
236 return 0;
237}
557134a3 238#endif /* CONFIG_NFS_V4_1 */
4ce79717 239
29fba38b
BH
240extern struct nfs4_state_maintenance_ops *nfs4_state_renewal_ops[];
241
4ce79717
TM
242extern const u32 nfs4_fattr_bitmap[2];
243extern const u32 nfs4_statfs_bitmap[2];
244extern const u32 nfs4_pathconf_bitmap[2];
245extern const u32 nfs4_fsinfo_bitmap[2];
830b8e33 246extern const u32 nfs4_fs_locations_bitmap[2];
4ce79717
TM
247
248/* nfs4renewd.c */
adfa6f98 249extern void nfs4_schedule_state_renewal(struct nfs_client *);
4ce79717 250extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
adfa6f98 251extern void nfs4_kill_renewd(struct nfs_client *);
65f27f38 252extern void nfs4_renew_state(struct work_struct *);
4ce79717
TM
253
254/* nfs4state.c */
a7b72103 255struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
6dc9d57a 256struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
a7b72103
AA
257#if defined(CONFIG_NFS_V4_1)
258struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
b4b82607 259struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
a7b72103 260#endif /* CONFIG_NFS_V4_1 */
4ce79717
TM
261
262extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
263extern void nfs4_put_state_owner(struct nfs4_state_owner *);
4ce79717
TM
264extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
265extern void nfs4_put_open_state(struct nfs4_state *);
dc0b027d
TM
266extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t);
267extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t);
268extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
adfa6f98 269extern void nfs4_schedule_state_recovery(struct nfs_client *);
b0d3ded1 270extern void nfs4_schedule_state_manager(struct nfs_client *);
9e33bed5 271extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state);
faf5f49c 272extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
8d0a8a9d 273extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
4ce79717
TM
274extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
275
cee54fc9
TM
276extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
277extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
278extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
279extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
280extern void nfs_free_seqid(struct nfs_seqid *seqid);
281
4ce79717
TM
282extern const nfs4_stateid zero_stateid;
283
284/* nfs4xdr.c */
0dbb4c67 285extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
4ce79717
TM
286extern struct rpc_procinfo nfs4_procedures[];
287
288struct nfs4_mount_data;
289
290/* callback_xdr.c */
291extern struct svc_version nfs4_callback_version1;
292
293#else
294
4a35bd41 295#define nfs4_close_state(a, b, c) do { } while (0)
e9a40458 296#define nfs4_close_sync(a, b, c) do { } while (0)
4ce79717
TM
297
298#endif /* CONFIG_NFS_V4 */
299#endif /* __LINUX_FS_NFS_NFS4_FS.H */