[PATCH] NFSv4: Clean up nfs4 lock state accounting
[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_OK  = 0,
42 };
43
44 /*
45  * The nfs4_client identifies our client state to the server.
46  */
47 struct nfs4_client {
48         struct list_head        cl_servers;     /* Global list of servers */
49         struct in_addr          cl_addr;        /* Server identifier */
50         u64                     cl_clientid;    /* constant */
51         nfs4_verifier           cl_confirm;
52         unsigned long           cl_state;
53
54         u32                     cl_lockowner_id;
55
56         /*
57          * The following rwsem ensures exclusive access to the server
58          * while we recover the state following a lease expiration.
59          */
60         struct rw_semaphore     cl_sem;
61
62         struct list_head        cl_delegations;
63         struct list_head        cl_state_owners;
64         struct list_head        cl_unused;
65         int                     cl_nunused;
66         spinlock_t              cl_lock;
67         atomic_t                cl_count;
68
69         struct rpc_clnt *       cl_rpcclient;
70         struct rpc_cred *       cl_cred;
71
72         struct list_head        cl_superblocks; /* List of nfs_server structs */
73
74         unsigned long           cl_lease_time;
75         unsigned long           cl_last_renewal;
76         struct work_struct      cl_renewd;
77         struct work_struct      cl_recoverd;
78
79         wait_queue_head_t       cl_waitq;
80         struct rpc_wait_queue   cl_rpcwaitq;
81
82         /* used for the setclientid verifier */
83         struct timespec         cl_boot_time;
84
85         /* idmapper */
86         struct idmap *          cl_idmap;
87
88         /* Our own IP address, as a null-terminated string.
89          * This is used to generate the clientid, and the callback address.
90          */
91         char                    cl_ipaddr[16];
92         unsigned char           cl_id_uniquifier;
93 };
94
95 /*
96  * NFS4 state_owners and lock_owners are simply labels for ordered
97  * sequences of RPC calls. Their sole purpose is to provide once-only
98  * semantics by allowing the server to identify replayed requests.
99  *
100  * The ->so_sema is held during all state_owner seqid-mutating operations:
101  * OPEN, OPEN_DOWNGRADE, and CLOSE. Its purpose is to properly serialize
102  * so_seqid.
103  */
104 struct nfs4_state_owner {
105         struct list_head     so_list;    /* per-clientid list of state_owners */
106         struct nfs4_client   *so_client;
107         u32                  so_id;      /* 32-bit identifier, unique */
108         struct semaphore     so_sema;
109         u32                  so_seqid;   /* protected by so_sema */
110         atomic_t             so_count;
111
112         struct rpc_cred      *so_cred;   /* Associated cred */
113         struct list_head     so_states;
114         struct list_head     so_delegations;
115 };
116
117 /*
118  * struct nfs4_state maintains the client-side state for a given
119  * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
120  *
121  * OPEN:
122  * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
123  * we need to know how many files are open for reading or writing on a
124  * given inode. This information too is stored here.
125  *
126  * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
127  */
128
129 struct nfs4_lock_state {
130         struct list_head        ls_locks;       /* Other lock stateids */
131         struct nfs4_state *     ls_state;       /* Pointer to open state */
132         fl_owner_t              ls_owner;       /* POSIX lock owner */
133 #define NFS_LOCK_INITIALIZED 1
134         int                     ls_flags;
135         u32                     ls_seqid;
136         u32                     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,
145 };
146
147 struct nfs4_state {
148         struct list_head open_states;   /* List of states for the same state_owner */
149         struct list_head inode_states;  /* List of states for the same inode */
150         struct list_head lock_states;   /* List of subservient lock stateids */
151
152         struct nfs4_state_owner *owner; /* Pointer to the open owner */
153         struct inode *inode;            /* Pointer to the inode */
154
155         unsigned long flags;            /* Do we hold any locks? */
156         struct semaphore lock_sema;     /* Serializes file locking operations */
157         spinlock_t state_lock;          /* Protects the lock_states list */
158
159         nfs4_stateid stateid;
160
161         unsigned int nreaders;
162         unsigned int nwriters;
163         int state;                      /* State on the server (R,W, or RW) */
164         atomic_t count;
165 };
166
167
168 struct nfs4_exception {
169         long timeout;
170         int retry;
171 };
172
173 struct nfs4_state_recovery_ops {
174         int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
175         int (*recover_lock)(struct nfs4_state *, struct file_lock *);
176 };
177
178 extern struct dentry_operations nfs4_dentry_operations;
179 extern struct inode_operations nfs4_dir_inode_operations;
180
181 /* inode.c */
182 extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
183 extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
184 extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);
185
186
187 /* nfs4proc.c */
188 extern int nfs4_map_errors(int err);
189 extern int nfs4_proc_setclientid(struct nfs4_client *, u32, unsigned short);
190 extern int nfs4_proc_setclientid_confirm(struct nfs4_client *);
191 extern int nfs4_proc_async_renew(struct nfs4_client *);
192 extern int nfs4_proc_renew(struct nfs4_client *);
193 extern int nfs4_do_close(struct inode *inode, struct nfs4_state *state, mode_t mode);
194 extern struct inode *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
195 extern int nfs4_open_revalidate(struct inode *, struct dentry *, int);
196
197 extern struct nfs4_state_recovery_ops nfs4_reboot_recovery_ops;
198 extern struct nfs4_state_recovery_ops nfs4_network_partition_recovery_ops;
199
200 extern const u32 nfs4_fattr_bitmap[2];
201 extern const u32 nfs4_statfs_bitmap[2];
202 extern const u32 nfs4_pathconf_bitmap[2];
203 extern const u32 nfs4_fsinfo_bitmap[2];
204
205 /* nfs4renewd.c */
206 extern void nfs4_schedule_state_renewal(struct nfs4_client *);
207 extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
208 extern void nfs4_kill_renewd(struct nfs4_client *);
209 extern void nfs4_renew_state(void *);
210
211 /* nfs4state.c */
212 extern void init_nfsv4_state(struct nfs_server *);
213 extern void destroy_nfsv4_state(struct nfs_server *);
214 extern struct nfs4_client *nfs4_get_client(struct in_addr *);
215 extern void nfs4_put_client(struct nfs4_client *clp);
216 extern int nfs4_init_client(struct nfs4_client *clp);
217 extern struct nfs4_client *nfs4_find_client(struct in_addr *);
218 extern u32 nfs4_alloc_lockowner_id(struct nfs4_client *);
219
220 extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
221 extern void nfs4_put_state_owner(struct nfs4_state_owner *);
222 extern void nfs4_drop_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 nfs4_state *, mode_t);
226 extern struct nfs4_state *nfs4_find_state(struct inode *, struct rpc_cred *, mode_t mode);
227 extern void nfs4_increment_seqid(int status, struct nfs4_state_owner *sp);
228 extern void nfs4_schedule_state_recovery(struct nfs4_client *);
229 extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
230 extern void nfs4_increment_lock_seqid(int status, struct nfs4_lock_state *ls);
231 extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t);
232
233 extern const nfs4_stateid zero_stateid;
234
235 /* nfs4xdr.c */
236 extern uint32_t *nfs4_decode_dirent(uint32_t *p, struct nfs_entry *entry, int plus);
237 extern struct rpc_procinfo nfs4_procedures[];
238
239 struct nfs4_mount_data;
240
241 /* callback_xdr.c */
242 extern struct svc_version nfs4_callback_version1;
243
244 #else
245
246 #define init_nfsv4_state(server)  do { } while (0)
247 #define destroy_nfsv4_state(server)       do { } while (0)
248 #define nfs4_put_state_owner(inode, owner) do { } while (0)
249 #define nfs4_put_open_state(state) do { } while (0)
250 #define nfs4_close_state(a, b) do { } while (0)
251
252 #endif /* CONFIG_NFS_V4 */
253 #endif /* __LINUX_FS_NFS_NFS4_FS.H */