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