fs/nfs/nfs4proc.c: make nfs4_map_errors() static
[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 };
48
49 /*
50  * struct rpc_sequence ensures that RPC calls are sent in the exact
51  * order that they appear on the list.
52  */
53 struct rpc_sequence {
54         struct rpc_wait_queue   wait;   /* RPC call delay queue */
55         spinlock_t lock;                /* Protects the list */
56         struct list_head list;          /* Defines sequence of RPC calls */
57 };
58
59 #define NFS_SEQID_CONFIRMED 1
60 struct nfs_seqid_counter {
61         struct rpc_sequence *sequence;
62         int flags;
63         u32 counter;
64 };
65
66 struct nfs_seqid {
67         struct nfs_seqid_counter *sequence;
68         struct list_head list;
69 };
70
71 static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
72 {
73         if (seqid_mutating_err(-status))
74                 seqid->flags |= NFS_SEQID_CONFIRMED;
75 }
76
77 struct nfs_unique_id {
78         struct rb_node rb_node;
79         __u64 id;
80 };
81
82 /*
83  * NFS4 state_owners and lock_owners are simply labels for ordered
84  * sequences of RPC calls. Their sole purpose is to provide once-only
85  * semantics by allowing the server to identify replayed requests.
86  */
87 struct nfs4_state_owner {
88         struct nfs_unique_id so_owner_id;
89         struct nfs_client    *so_client;
90         struct nfs_server    *so_server;
91         struct rb_node       so_client_node;
92
93         struct rpc_cred      *so_cred;   /* Associated cred */
94
95         spinlock_t           so_lock;
96         atomic_t             so_count;
97         unsigned long        so_flags;
98         struct list_head     so_states;
99         struct list_head     so_delegations;
100         struct nfs_seqid_counter so_seqid;
101         struct rpc_sequence  so_sequence;
102 };
103
104 enum {
105         NFS_OWNER_RECLAIM_REBOOT,
106         NFS_OWNER_RECLAIM_NOGRACE
107 };
108
109 /*
110  * struct nfs4_state maintains the client-side state for a given
111  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
112  *
113  * OPEN:
114  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
115  * we need to know how many files are open for reading or writing on a
116  * given inode. This information too is stored here.
117  *
118  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
119  */
120
121 struct nfs4_lock_state {
122         struct list_head        ls_locks;       /* Other lock stateids */
123         struct nfs4_state *     ls_state;       /* Pointer to open state */
124         fl_owner_t              ls_owner;       /* POSIX lock owner */
125 #define NFS_LOCK_INITIALIZED 1
126         int                     ls_flags;
127         struct nfs_seqid_counter        ls_seqid;
128         struct rpc_sequence     ls_sequence;
129         struct nfs_unique_id    ls_id;
130         nfs4_stateid            ls_stateid;
131         atomic_t                ls_count;
132 };
133
134 /* bits for nfs4_state->flags */
135 enum {
136         LK_STATE_IN_USE,
137         NFS_DELEGATED_STATE,            /* Current stateid is delegation */
138         NFS_O_RDONLY_STATE,             /* OPEN stateid has read-only state */
139         NFS_O_WRONLY_STATE,             /* OPEN stateid has write-only state */
140         NFS_O_RDWR_STATE,               /* OPEN stateid has read/write state */
141         NFS_STATE_RECLAIM_REBOOT,       /* OPEN stateid server rebooted */
142         NFS_STATE_RECLAIM_NOGRACE,      /* OPEN stateid needs to recover state */
143 };
144
145 struct nfs4_state {
146         struct list_head open_states;   /* List of states for the same state_owner */
147         struct list_head inode_states;  /* List of states for the same inode */
148         struct list_head lock_states;   /* List of subservient lock stateids */
149
150         struct nfs4_state_owner *owner; /* Pointer to the open owner */
151         struct inode *inode;            /* Pointer to the inode */
152
153         unsigned long flags;            /* Do we hold any locks? */
154         spinlock_t state_lock;          /* Protects the lock_states list */
155
156         seqlock_t seqlock;              /* Protects the stateid/open_stateid */
157         nfs4_stateid stateid;           /* Current stateid: may be delegation */
158         nfs4_stateid open_stateid;      /* OPEN stateid */
159
160         /* The following 3 fields are protected by owner->so_lock */
161         unsigned int n_rdonly;          /* Number of read-only references */
162         unsigned int n_wronly;          /* Number of write-only references */
163         unsigned int n_rdwr;            /* Number of read/write references */
164         fmode_t state;                  /* State on the server (R,W, or RW) */
165         atomic_t count;
166 };
167
168
169 struct nfs4_exception {
170         long timeout;
171         int retry;
172         struct nfs4_state *state;
173 };
174
175 struct nfs4_state_recovery_ops {
176         int owner_flag_bit;
177         int state_flag_bit;
178         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
179         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
180 };
181
182 extern struct dentry_operations nfs4_dentry_operations;
183 extern const struct inode_operations nfs4_dir_inode_operations;
184
185 /* inode.c */
186 extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
187 extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
188 extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
189
190
191 /* nfs4proc.c */
192 extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
193 extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_cred *);
194 extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
195 extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
196 extern int nfs4_do_close(struct path *path, struct nfs4_state *state, int wait);
197 extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
198 extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
199 extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
200 extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
201                 struct nfs4_fs_locations *fs_locations, struct page *page);
202
203 extern struct nfs4_state_recovery_ops nfs4_reboot_recovery_ops;
204 extern struct nfs4_state_recovery_ops nfs4_nograce_recovery_ops;
205
206 extern const u32 nfs4_fattr_bitmap[2];
207 extern const u32 nfs4_statfs_bitmap[2];
208 extern const u32 nfs4_pathconf_bitmap[2];
209 extern const u32 nfs4_fsinfo_bitmap[2];
210 extern const u32 nfs4_fs_locations_bitmap[2];
211
212 /* nfs4renewd.c */
213 extern void nfs4_schedule_state_renewal(struct nfs_client *);
214 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
215 extern void nfs4_kill_renewd(struct nfs_client *);
216 extern void nfs4_renew_state(struct work_struct *);
217
218 /* nfs4state.c */
219 struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
220
221 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
222 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
223 extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
224 extern void nfs4_put_open_state(struct nfs4_state *);
225 extern void nfs4_close_state(struct path *, struct nfs4_state *, fmode_t);
226 extern void nfs4_close_sync(struct path *, struct nfs4_state *, fmode_t);
227 extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
228 extern void nfs4_schedule_state_recovery(struct nfs_client *);
229 extern void nfs4_schedule_state_manager(struct nfs_client *);
230 extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *clp, struct nfs4_state *state);
231 extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
232 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
233 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
234
235 extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
236 extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
237 extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
238 extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
239 extern void nfs_free_seqid(struct nfs_seqid *seqid);
240
241 extern const nfs4_stateid zero_stateid;
242
243 /* nfs4xdr.c */
244 extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
245 extern struct rpc_procinfo nfs4_procedures[];
246
247 struct nfs4_mount_data;
248
249 /* callback_xdr.c */
250 extern struct svc_version nfs4_callback_version1;
251
252 #else
253
254 #define nfs4_close_state(a, b, c) do { } while (0)
255 #define nfs4_close_sync(a, b, c) do { } while (0)
256
257 #endif /* CONFIG_NFS_V4 */
258 #endif /* __LINUX_FS_NFS_NFS4_FS.H */