NFSv4: Clean up the NFSv4 setclientid operation
[linux-2.6.git] / fs / nfs / nfs4_fs.h
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
14 struct 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
40 enum nfs4_client_state {
41         NFS4CLNT_MANAGER_RUNNING  = 0,
42         NFS4CLNT_CHECK_LEASE,
43         NFS4CLNT_LEASE_EXPIRED,
44         NFS4CLNT_RECLAIM_REBOOT,
45         NFS4CLNT_RECLAIM_NOGRACE,
46         NFS4CLNT_DELEGRETURN,
47         NFS4CLNT_SESSION_RESET,
48         NFS4CLNT_SESSION_DRAINING,
49         NFS4CLNT_RECALL_SLOT,
50 };
51
52 /*
53  * struct rpc_sequence ensures that RPC calls are sent in the exact
54  * order that they appear on the list.
55  */
56 struct rpc_sequence {
57         struct rpc_wait_queue   wait;   /* RPC call delay queue */
58         spinlock_t lock;                /* Protects the list */
59         struct list_head list;          /* Defines sequence of RPC calls */
60 };
61
62 #define NFS_SEQID_CONFIRMED 1
63 struct nfs_seqid_counter {
64         struct rpc_sequence *sequence;
65         int flags;
66         u32 counter;
67 };
68
69 struct nfs_seqid {
70         struct nfs_seqid_counter *sequence;
71         struct list_head list;
72 };
73
74 static 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
80 struct nfs_unique_id {
81         struct rb_node rb_node;
82         __u64 id;
83 };
84
85 /*
86  * NFS4 state_owners and lock_owners are simply labels for ordered
87  * sequences of RPC calls. Their sole purpose is to provide once-only
88  * semantics by allowing the server to identify replayed requests.
89  */
90 struct nfs4_state_owner {
91         struct nfs_unique_id so_owner_id;
92         struct nfs_client    *so_client;
93         struct nfs_server    *so_server;
94         struct rb_node       so_client_node;
95
96         struct rpc_cred      *so_cred;   /* Associated cred */
97
98         spinlock_t           so_lock;
99         atomic_t             so_count;
100         unsigned long        so_flags;
101         struct list_head     so_states;
102         struct list_head     so_delegations;
103         struct nfs_seqid_counter so_seqid;
104         struct rpc_sequence  so_sequence;
105 };
106
107 enum {
108         NFS_OWNER_RECLAIM_REBOOT,
109         NFS_OWNER_RECLAIM_NOGRACE
110 };
111
112 #define NFS_LOCK_NEW            0
113 #define NFS_LOCK_RECLAIM        1
114 #define NFS_LOCK_EXPIRED        2
115
116 /*
117  * struct nfs4_state maintains the client-side state for a given
118  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
119  *
120  * OPEN:
121  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
122  * we need to know how many files are open for reading or writing on a
123  * given inode. This information too is stored here.
124  *
125  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
126  */
127
128 struct nfs4_lock_state {
129         struct list_head        ls_locks;       /* Other lock stateids */
130         struct nfs4_state *     ls_state;       /* Pointer to open state */
131         fl_owner_t              ls_owner;       /* POSIX lock owner */
132 #define NFS_LOCK_INITIALIZED 1
133         int                     ls_flags;
134         struct nfs_seqid_counter        ls_seqid;
135         struct rpc_sequence     ls_sequence;
136         struct nfs_unique_id    ls_id;
137         nfs4_stateid            ls_stateid;
138         atomic_t                ls_count;
139 };
140
141 /* bits for nfs4_state->flags */
142 enum {
143         LK_STATE_IN_USE,
144         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
145         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
146         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
147         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
148         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
149         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
150         NFS_STATE_POSIX_LOCKS,          /* Posix locks are supported */
151 };
152
153 struct nfs4_state {
154         struct list_head open_states;   /* List of states for the same state_owner */
155         struct list_head inode_states;  /* List of states for the same inode */
156         struct list_head lock_states;   /* List of subservient lock stateids */
157
158         struct nfs4_state_owner *owner; /* Pointer to the open owner */
159         struct inode *inode;            /* Pointer to the inode */
160
161         unsigned long flags;            /* Do we hold any locks? */
162         spinlock_t state_lock;          /* Protects the lock_states list */
163
164         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
165         nfs4_stateid stateid;           /* Current stateid: may be delegation */
166         nfs4_stateid open_stateid;      /* OPEN stateid */
167
168         /* The following 3 fields are protected by owner->so_lock */
169         unsigned int n_rdonly;          /* Number of read-only references */
170         unsigned int n_wronly;          /* Number of write-only references */
171         unsigned int n_rdwr;            /* Number of read/write references */
172         fmode_t state;                  /* State on the server (R,W, or RW) */
173         atomic_t count;
174 };
175
176
177 struct nfs4_exception {
178         long timeout;
179         int retry;
180         struct nfs4_state *state;
181 };
182
183 struct nfs4_state_recovery_ops {
184         int owner_flag_bit;
185         int state_flag_bit;
186         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
187         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
188         int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
189         struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
190         int (*reclaim_complete)(struct nfs_client *);
191 };
192
193 struct nfs4_state_maintenance_ops {
194         int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
195         struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
196         int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
197 };
198
199 extern const struct dentry_operations nfs4_dentry_operations;
200 extern const struct inode_operations nfs4_dir_inode_operations;
201
202 /* inode.c */
203 extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
204 extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
205 extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
206
207
208 /* nfs4proc.c */
209 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
210 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
211 extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
212 extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
213 extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
214 extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
215 extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
216 extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait);
217 extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
218 extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
219 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
220 extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
221                 struct nfs4_fs_locations *fs_locations, struct page *page);
222
223 extern struct nfs4_state_recovery_ops *nfs4_reboot_recovery_ops[];
224 extern struct nfs4_state_recovery_ops *nfs4_nograce_recovery_ops[];
225 #if defined(CONFIG_NFS_V4_1)
226 extern int nfs4_setup_sequence(struct nfs_client *clp,
227                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
228                 int cache_reply, struct rpc_task *task);
229 extern void nfs4_destroy_session(struct nfs4_session *session);
230 extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
231 extern int nfs4_proc_create_session(struct nfs_client *);
232 extern int nfs4_proc_destroy_session(struct nfs4_session *);
233 extern int nfs4_init_session(struct nfs_server *server);
234 extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
235                 struct nfs_fsinfo *fsinfo);
236 #else /* CONFIG_NFS_v4_1 */
237 static inline int nfs4_setup_sequence(struct nfs_client *clp,
238                 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
239                 int cache_reply, struct rpc_task *task)
240 {
241         return 0;
242 }
243
244 static inline int nfs4_init_session(struct nfs_server *server)
245 {
246         return 0;
247 }
248 #endif /* CONFIG_NFS_V4_1 */
249
250 extern struct nfs4_state_maintenance_ops *nfs4_state_renewal_ops[];
251
252 extern const u32 nfs4_fattr_bitmap[2];
253 extern const u32 nfs4_statfs_bitmap[2];
254 extern const u32 nfs4_pathconf_bitmap[2];
255 extern const u32 nfs4_fsinfo_bitmap[2];
256 extern const u32 nfs4_fs_locations_bitmap[2];
257
258 /* nfs4renewd.c */
259 extern void nfs4_schedule_state_renewal(struct nfs_client *);
260 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
261 extern void nfs4_kill_renewd(struct nfs_client *);
262 extern void nfs4_renew_state(struct work_struct *);
263
264 /* nfs4state.c */
265 struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
266 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
267 #if defined(CONFIG_NFS_V4_1)
268 struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
269 struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
270 #endif /* CONFIG_NFS_V4_1 */
271
272 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
273 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
274 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
275 extern void nfs4_put_open_state(struct nfs4_state *);
276 extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t);
277 extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t);
278 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
279 extern void nfs4_schedule_state_recovery(struct nfs_client *);
280 extern void nfs4_schedule_state_manager(struct nfs_client *);
281 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state);
282 extern int nfs4_state_mark_reclaim_reboot(struct nfs_client *clp, struct nfs4_state *state);
283 extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
284 extern void nfs41_handle_recall_slot(struct nfs_client *clp);
285 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
286 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
287 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
288
289 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
290 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
291 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
292 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
293 extern void nfs_release_seqid(struct nfs_seqid *seqid);
294 extern void nfs_free_seqid(struct nfs_seqid *seqid);
295
296 extern const nfs4_stateid zero_stateid;
297
298 /* nfs4xdr.c */
299 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
300 extern struct rpc_procinfo nfs4_procedures[];
301
302 struct nfs4_mount_data;
303
304 /* callback_xdr.c */
305 extern struct svc_version nfs4_callback_version1;
306 extern struct svc_version nfs4_callback_version4;
307
308 #else
309
310 #define nfs4_close_state(a, b, c) do { } while (0)
311 #define nfs4_close_sync(a, b, c) do { } while (0)
312
313 #endif /* CONFIG_NFS_V4 */
314 #endif /* __LINUX_FS_NFS_NFS4_FS.H */