NFS: Ensure that mmapped pages remain stable during writeback
[deliverable/linux.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
4ce79717 16enum nfs4_client_state {
e005e804 17 NFS4CLNT_MANAGER_RUNNING = 0,
e598d843 18 NFS4CLNT_CHECK_LEASE,
58d9714a 19 NFS4CLNT_LEASE_EXPIRED,
b79a4a1b
TM
20 NFS4CLNT_RECLAIM_REBOOT,
21 NFS4CLNT_RECLAIM_NOGRACE,
707fb4b3 22 NFS4CLNT_DELEGRETURN,
43f1b3da 23 NFS4CLNT_LAYOUTRECALL,
6df08189 24 NFS4CLNT_SESSION_RESET,
b9efa1b2 25 NFS4CLNT_RECALL_SLOT,
fd954ae1 26 NFS4CLNT_LEASE_CONFIRM,
78fe0f41 27 NFS4CLNT_SERVER_SCOPE_MISMATCH,
4ce79717
TM
28};
29
a2118c33 30enum nfs4_session_state {
1055d76d 31 NFS4_SESSION_INITING,
a2118c33
TM
32 NFS4_SESSION_DRAINING,
33};
34
2f60ea6b
TM
35#define NFS4_RENEW_TIMEOUT 0x01
36#define NFS4_RENEW_DELEGATION_CB 0x02
37
97dc1359
TM
38struct nfs4_minor_version_ops {
39 u32 minor_version;
40
7c513058
BS
41 int (*call_sync)(struct rpc_clnt *clnt,
42 struct nfs_server *server,
97dc1359
TM
43 struct rpc_message *msg,
44 struct nfs4_sequence_args *args,
45 struct nfs4_sequence_res *res,
46 int cache_reply);
e047a10c
TM
47 int (*validate_stateid)(struct nfs_delegation *,
48 const nfs4_stateid *);
fca78d6d
BS
49 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
50 struct nfs_fsinfo *);
c48f4f35
TM
51 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
52 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
53 const struct nfs4_state_maintenance_ops *state_renewal_ops;
97dc1359
TM
54};
55
48c22eb2
TM
56struct nfs_unique_id {
57 struct rb_node rb_node;
58 __u64 id;
59};
60
cee54fc9
TM
61#define NFS_SEQID_CONFIRMED 1
62struct nfs_seqid_counter {
48c22eb2 63 int owner_id;
cee54fc9
TM
64 int flags;
65 u32 counter;
7ba127ab
TM
66 spinlock_t lock; /* Protects the list */
67 struct list_head list; /* Defines sequence of RPC calls */
68 struct rpc_wait_queue wait; /* RPC call delay queue */
cee54fc9
TM
69};
70
71struct nfs_seqid {
cee54fc9 72 struct nfs_seqid_counter *sequence;
4e51336a 73 struct list_head list;
cee54fc9
TM
74};
75
76static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
77{
78 if (seqid_mutating_err(-status))
79 seqid->flags |= NFS_SEQID_CONFIRMED;
80}
81
4ce79717
TM
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.
4ce79717
TM
86 */
87struct nfs4_state_owner {
6f2e64d3 88 struct nfs_server *so_server;
0aaaf5c4
CL
89 struct list_head so_lru;
90 unsigned long so_expires;
24d292b8 91 struct rb_node so_server_node;
4ce79717
TM
92
93 struct rpc_cred *so_cred; /* Associated cred */
9f958ab8
TM
94
95 spinlock_t so_lock;
96 atomic_t so_count;
7eff03ae 97 unsigned long so_flags;
4ce79717 98 struct list_head so_states;
cee54fc9 99 struct nfs_seqid_counter so_seqid;
4ce79717
TM
100};
101
7eff03ae
TM
102enum {
103 NFS_OWNER_RECLAIM_REBOOT,
104 NFS_OWNER_RECLAIM_NOGRACE
105};
106
afe6c27c
AB
107#define NFS_LOCK_NEW 0
108#define NFS_LOCK_RECLAIM 1
109#define NFS_LOCK_EXPIRED 2
110
4ce79717
TM
111/*
112 * struct nfs4_state maintains the client-side state for a given
113 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
114 *
115 * OPEN:
116 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
117 * we need to know how many files are open for reading or writing on a
118 * given inode. This information too is stored here.
119 *
120 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
121 */
122
77041ed9
TM
123struct nfs4_lock_owner {
124 unsigned int lo_type;
125#define NFS4_ANY_LOCK_TYPE (0U)
126#define NFS4_FLOCK_LOCK_TYPE (1U << 0)
127#define NFS4_POSIX_LOCK_TYPE (1U << 1)
128 union {
129 fl_owner_t posix_owner;
130 pid_t flock_owner;
131 } lo_u;
132};
133
4ce79717
TM
134struct nfs4_lock_state {
135 struct list_head ls_locks; /* Other lock stateids */
8d0a8a9d 136 struct nfs4_state * ls_state; /* Pointer to open state */
4ce79717
TM
137#define NFS_LOCK_INITIALIZED 1
138 int ls_flags;
cee54fc9 139 struct nfs_seqid_counter ls_seqid;
4ce79717
TM
140 nfs4_stateid ls_stateid;
141 atomic_t ls_count;
77041ed9 142 struct nfs4_lock_owner ls_owner;
4ce79717
TM
143};
144
145/* bits for nfs4_state->flags */
146enum {
147 LK_STATE_IN_USE,
003707c7
TM
148 NFS_DELEGATED_STATE, /* Current stateid is delegation */
149 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
150 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
151 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
b79a4a1b
TM
152 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
153 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
8e469ebd 154 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
4ce79717
TM
155};
156
157struct nfs4_state {
158 struct list_head open_states; /* List of states for the same state_owner */
159 struct list_head inode_states; /* List of states for the same inode */
160 struct list_head lock_states; /* List of subservient lock stateids */
161
162 struct nfs4_state_owner *owner; /* Pointer to the open owner */
163 struct inode *inode; /* Pointer to the inode */
164
165 unsigned long flags; /* Do we hold any locks? */
8d0a8a9d 166 spinlock_t state_lock; /* Protects the lock_states list */
4ce79717 167
8bda4e4c 168 seqlock_t seqlock; /* Protects the stateid/open_stateid */
003707c7
TM
169 nfs4_stateid stateid; /* Current stateid: may be delegation */
170 nfs4_stateid open_stateid; /* OPEN stateid */
4ce79717 171
8bda4e4c 172 /* The following 3 fields are protected by owner->so_lock */
003707c7
TM
173 unsigned int n_rdonly; /* Number of read-only references */
174 unsigned int n_wronly; /* Number of write-only references */
175 unsigned int n_rdwr; /* Number of read/write references */
dc0b027d 176 fmode_t state; /* State on the server (R,W, or RW) */
4ce79717
TM
177 atomic_t count;
178};
179
180
181struct nfs4_exception {
182 long timeout;
183 int retry;
9e33bed5 184 struct nfs4_state *state;
4ce79717
TM
185};
186
187struct nfs4_state_recovery_ops {
7eff03ae 188 int owner_flag_bit;
b79a4a1b 189 int state_flag_bit;
4ce79717
TM
190 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
191 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
591d71cb 192 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
90a16617 193 struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
fce5c838 194 int (*reclaim_complete)(struct nfs_client *);
4ce79717
TM
195};
196
29fba38b 197struct nfs4_state_maintenance_ops {
2f60ea6b 198 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
a7b72103 199 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
8e69514f 200 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
29fba38b
BH
201};
202
f786aa90 203extern const struct dentry_operations nfs4_dentry_operations;
92e1d5be 204extern const struct inode_operations nfs4_dir_inode_operations;
6b3b5496 205
4ce79717 206/* nfs4proc.c */
bb8b27e5
TM
207extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
208extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
4d643d1d 209extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
591d71cb 210extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
4d643d1d 211extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
643168c2 212extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
55a97593 213extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
56659e99 214extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
7aaa0b3b 215 struct nfs4_fs_locations *fs_locations, struct page *page);
d3c7b7cc 216extern void nfs4_release_lockowner(const struct nfs4_lock_state *);
64c2ce8b 217extern const struct xattr_handler *nfs4_xattr_handlers[];
4ce79717 218
557134a3 219#if defined(CONFIG_NFS_V4_1)
035168ab
TM
220static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
221{
222 return server->nfs_client->cl_session;
223}
224
225extern int nfs4_setup_sequence(const struct nfs_server *server,
fbcd4abc 226 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
9d12b216 227 struct rpc_task *task);
dc70d7b3
AA
228extern int nfs41_setup_sequence(struct nfs4_session *session,
229 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
9d12b216 230 struct rpc_task *task);
557134a3
AA
231extern void nfs4_destroy_session(struct nfs4_session *session);
232extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
f26468fb 233extern int nfs4_proc_create_session(struct nfs_client *);
c3fad1b1 234extern int nfs4_proc_destroy_session(struct nfs4_session *);
fccba804 235extern int nfs4_init_session(struct nfs_server *server);
9430fb6b
RL
236extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
237 struct nfs_fsinfo *fsinfo);
863a3c6c 238extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
ef311537 239 bool sync);
94de8b27
AA
240
241static inline bool
242is_ds_only_client(struct nfs_client *clp)
243{
244 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
245 EXCHGID4_FLAG_USE_PNFS_DS;
246}
d83217c1
AA
247
248static inline bool
249is_ds_client(struct nfs_client *clp)
250{
251 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
252}
fbcd4abc 253#else /* CONFIG_NFS_v4_1 */
035168ab
TM
254static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
255{
256 return NULL;
257}
258
259static inline int nfs4_setup_sequence(const struct nfs_server *server,
fbcd4abc 260 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
9d12b216 261 struct rpc_task *task)
fbcd4abc
AA
262{
263 return 0;
264}
fccba804
TM
265
266static inline int nfs4_init_session(struct nfs_server *server)
267{
268 return 0;
269}
94de8b27
AA
270
271static inline bool
272is_ds_only_client(struct nfs_client *clp)
d83217c1
AA
273{
274 return false;
275}
276
277static inline bool
278is_ds_client(struct nfs_client *clp)
94de8b27
AA
279{
280 return false;
281}
557134a3 282#endif /* CONFIG_NFS_V4_1 */
4ce79717 283
97dc1359 284extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
29fba38b 285
4ce79717
TM
286extern const u32 nfs4_fattr_bitmap[2];
287extern const u32 nfs4_statfs_bitmap[2];
288extern const u32 nfs4_pathconf_bitmap[2];
dae100c2 289extern const u32 nfs4_fsinfo_bitmap[3];
830b8e33 290extern const u32 nfs4_fs_locations_bitmap[2];
4ce79717
TM
291
292/* nfs4renewd.c */
adfa6f98 293extern void nfs4_schedule_state_renewal(struct nfs_client *);
4ce79717 294extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
adfa6f98 295extern void nfs4_kill_renewd(struct nfs_client *);
65f27f38 296extern void nfs4_renew_state(struct work_struct *);
4ce79717
TM
297
298/* nfs4state.c */
a7b72103 299struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
6dc9d57a 300struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
a7b72103
AA
301#if defined(CONFIG_NFS_V4_1)
302struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
b4b82607 303struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
0400a6b0
TM
304extern void nfs4_schedule_session_recovery(struct nfs4_session *);
305#else
306static inline void nfs4_schedule_session_recovery(struct nfs4_session *session)
307{
308}
a7b72103 309#endif /* CONFIG_NFS_V4_1 */
4ce79717 310
d1e284d5 311extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
4ce79717 312extern void nfs4_put_state_owner(struct nfs4_state_owner *);
0aaaf5c4 313extern void nfs4_purge_state_owners(struct nfs_server *);
4ce79717
TM
314extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
315extern void nfs4_put_open_state(struct nfs4_state *);
643168c2
AV
316extern void nfs4_close_state(struct nfs4_state *, fmode_t);
317extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
dc0b027d 318extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
0400a6b0 319extern void nfs4_schedule_lease_recovery(struct nfs_client *);
b0d3ded1 320extern void nfs4_schedule_state_manager(struct nfs_client *);
042b60be 321extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
0400a6b0 322extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
0629e370 323extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
b9efa1b2 324extern void nfs41_handle_recall_slot(struct nfs_client *clp);
78fe0f41
WAA
325extern void nfs41_handle_server_scope(struct nfs_client *,
326 struct server_scope **);
faf5f49c 327extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
8d0a8a9d 328extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
77041ed9 329extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t, pid_t);
4ce79717 330
8535b2be 331extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
cee54fc9
TM
332extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
333extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
334extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
72211dbe 335extern void nfs_release_seqid(struct nfs_seqid *seqid);
cee54fc9
TM
336extern void nfs_free_seqid(struct nfs_seqid *seqid);
337
4ce79717
TM
338extern const nfs4_stateid zero_stateid;
339
340/* nfs4xdr.c */
4ce79717
TM
341extern struct rpc_procinfo nfs4_procedures[];
342
343struct nfs4_mount_data;
344
345/* callback_xdr.c */
346extern struct svc_version nfs4_callback_version1;
07bccc2d 347extern struct svc_version nfs4_callback_version4;
4ce79717
TM
348
349#else
350
643168c2
AV
351#define nfs4_close_state(a, b) do { } while (0)
352#define nfs4_close_sync(a, b) do { } while (0)
4ce79717
TM
353
354#endif /* CONFIG_NFS_V4 */
355#endif /* __LINUX_FS_NFS_NFS4_FS.H */
This page took 0.596007 seconds and 5 git commands to generate.