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