Merge branch 'x86-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[GitHub/mt8127/android_kernel_alcatel_ttab.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
89d77c8f 12#if IS_ENABLED(CONFIG_NFS_V4)
4ce79717 13
33021279
TM
14#define NFS4_MAX_LOOP_ON_RECOVER (10)
15
4ce79717
TM
16struct idmap;
17
4ce79717 18enum nfs4_client_state {
e005e804 19 NFS4CLNT_MANAGER_RUNNING = 0,
e598d843 20 NFS4CLNT_CHECK_LEASE,
58d9714a 21 NFS4CLNT_LEASE_EXPIRED,
b79a4a1b
TM
22 NFS4CLNT_RECLAIM_REBOOT,
23 NFS4CLNT_RECLAIM_NOGRACE,
707fb4b3 24 NFS4CLNT_DELEGRETURN,
6df08189 25 NFS4CLNT_SESSION_RESET,
fd954ae1 26 NFS4CLNT_LEASE_CONFIRM,
78fe0f41 27 NFS4CLNT_SERVER_SCOPE_MISMATCH,
2c820d9a 28 NFS4CLNT_PURGE_STATE,
a9e64442 29 NFS4CLNT_BIND_CONN_TO_SESSION,
4ce79717
TM
30};
31
2f60ea6b
TM
32#define NFS4_RENEW_TIMEOUT 0x01
33#define NFS4_RENEW_DELEGATION_CB 0x02
34
97dc1359
TM
35struct nfs4_minor_version_ops {
36 u32 minor_version;
37
7c513058
BS
38 int (*call_sync)(struct rpc_clnt *clnt,
39 struct nfs_server *server,
97dc1359
TM
40 struct rpc_message *msg,
41 struct nfs4_sequence_args *args,
fd0c0953 42 struct nfs4_sequence_res *res);
36281caa 43 bool (*match_stateid)(const nfs4_stateid *,
e047a10c 44 const nfs4_stateid *);
fca78d6d
BS
45 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
46 struct nfs_fsinfo *);
c48f4f35
TM
47 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
48 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
49 const struct nfs4_state_maintenance_ops *state_renewal_ops;
97dc1359
TM
50};
51
cee54fc9
TM
52#define NFS_SEQID_CONFIRMED 1
53struct nfs_seqid_counter {
95b72eb0 54 ktime_t create_time;
48c22eb2 55 int owner_id;
cee54fc9
TM
56 int flags;
57 u32 counter;
7ba127ab
TM
58 spinlock_t lock; /* Protects the list */
59 struct list_head list; /* Defines sequence of RPC calls */
60 struct rpc_wait_queue wait; /* RPC call delay queue */
cee54fc9
TM
61};
62
63struct nfs_seqid {
cee54fc9 64 struct nfs_seqid_counter *sequence;
4e51336a 65 struct list_head list;
4601df20 66 struct rpc_task *task;
cee54fc9
TM
67};
68
69static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
70{
71 if (seqid_mutating_err(-status))
72 seqid->flags |= NFS_SEQID_CONFIRMED;
73}
74
4ce79717
TM
75/*
76 * NFS4 state_owners and lock_owners are simply labels for ordered
77 * sequences of RPC calls. Their sole purpose is to provide once-only
78 * semantics by allowing the server to identify replayed requests.
4ce79717
TM
79 */
80struct nfs4_state_owner {
6f2e64d3 81 struct nfs_server *so_server;
0aaaf5c4
CL
82 struct list_head so_lru;
83 unsigned long so_expires;
24d292b8 84 struct rb_node so_server_node;
4ce79717
TM
85
86 struct rpc_cred *so_cred; /* Associated cred */
9f958ab8
TM
87
88 spinlock_t so_lock;
89 atomic_t so_count;
7eff03ae 90 unsigned long so_flags;
4ce79717 91 struct list_head so_states;
cee54fc9 92 struct nfs_seqid_counter so_seqid;
4ce79717
TM
93};
94
7eff03ae
TM
95enum {
96 NFS_OWNER_RECLAIM_REBOOT,
97 NFS_OWNER_RECLAIM_NOGRACE
98};
99
afe6c27c
AB
100#define NFS_LOCK_NEW 0
101#define NFS_LOCK_RECLAIM 1
102#define NFS_LOCK_EXPIRED 2
103
4ce79717
TM
104/*
105 * struct nfs4_state maintains the client-side state for a given
106 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
107 *
108 * OPEN:
109 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
110 * we need to know how many files are open for reading or writing on a
111 * given inode. This information too is stored here.
112 *
113 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
114 */
115
77041ed9
TM
116struct nfs4_lock_owner {
117 unsigned int lo_type;
118#define NFS4_ANY_LOCK_TYPE (0U)
119#define NFS4_FLOCK_LOCK_TYPE (1U << 0)
120#define NFS4_POSIX_LOCK_TYPE (1U << 1)
121 union {
122 fl_owner_t posix_owner;
123 pid_t flock_owner;
124 } lo_u;
125};
126
4ce79717
TM
127struct nfs4_lock_state {
128 struct list_head ls_locks; /* Other lock stateids */
8d0a8a9d 129 struct nfs4_state * ls_state; /* Pointer to open state */
795a88c9
TM
130#define NFS_LOCK_INITIALIZED 0
131 unsigned long ls_flags;
cee54fc9 132 struct nfs_seqid_counter ls_seqid;
4ce79717
TM
133 nfs4_stateid ls_stateid;
134 atomic_t ls_count;
77041ed9 135 struct nfs4_lock_owner ls_owner;
4ce79717
TM
136};
137
138/* bits for nfs4_state->flags */
139enum {
140 LK_STATE_IN_USE,
003707c7
TM
141 NFS_DELEGATED_STATE, /* Current stateid is delegation */
142 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
143 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
144 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
b79a4a1b
TM
145 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
146 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
8e469ebd 147 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
4ce79717
TM
148};
149
150struct nfs4_state {
151 struct list_head open_states; /* List of states for the same state_owner */
152 struct list_head inode_states; /* List of states for the same inode */
153 struct list_head lock_states; /* List of subservient lock stateids */
154
155 struct nfs4_state_owner *owner; /* Pointer to the open owner */
156 struct inode *inode; /* Pointer to the inode */
157
158 unsigned long flags; /* Do we hold any locks? */
8d0a8a9d 159 spinlock_t state_lock; /* Protects the lock_states list */
4ce79717 160
8bda4e4c 161 seqlock_t seqlock; /* Protects the stateid/open_stateid */
003707c7
TM
162 nfs4_stateid stateid; /* Current stateid: may be delegation */
163 nfs4_stateid open_stateid; /* OPEN stateid */
4ce79717 164
8bda4e4c 165 /* The following 3 fields are protected by owner->so_lock */
003707c7
TM
166 unsigned int n_rdonly; /* Number of read-only references */
167 unsigned int n_wronly; /* Number of write-only references */
168 unsigned int n_rdwr; /* Number of read/write references */
dc0b027d 169 fmode_t state; /* State on the server (R,W, or RW) */
4ce79717
TM
170 atomic_t count;
171};
172
173
174struct nfs4_exception {
175 long timeout;
176 int retry;
9e33bed5 177 struct nfs4_state *state;
3114ea7a 178 struct inode *inode;
4ce79717
TM
179};
180
181struct nfs4_state_recovery_ops {
7eff03ae 182 int owner_flag_bit;
b79a4a1b 183 int state_flag_bit;
4ce79717
TM
184 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
185 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
591d71cb 186 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
90a16617 187 struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
fce5c838 188 int (*reclaim_complete)(struct nfs_client *);
05f4c350
CL
189 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
190 struct rpc_cred *);
4ce79717
TM
191};
192
29fba38b 193struct nfs4_state_maintenance_ops {
2f60ea6b 194 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
a7b72103 195 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
8e69514f 196 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
29fba38b
BH
197};
198
f786aa90 199extern const struct dentry_operations nfs4_dentry_operations;
73a79706
BS
200
201/* dir.c */
202int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
203 unsigned, umode_t, int *);
6b3b5496 204
1ae811ee 205/* super.c */
206extern struct file_system_type nfs4_fs_type;
207
72de53ec 208/* nfs4namespace.c */
2671bfc3 209rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
72de53ec 210struct rpc_clnt *nfs4_create_sec_client(struct rpc_clnt *, struct inode *, struct qstr *);
281cad46
BS
211struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
212 struct nfs_fh *, struct nfs_fattr *);
72de53ec 213
4ce79717 214/* nfs4proc.c */
bb8b27e5
TM
215extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
216extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
3028eb2b 217extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *);
2cf047c9 218extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
4d643d1d 219extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
66245539 220extern int nfs4_destroy_clientid(struct nfs_client *clp);
591d71cb 221extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
4d643d1d 222extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
1f7977c1 223extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
55a97593 224extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
f05d147f
BS
225extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
226 struct nfs4_fs_locations *, struct page *);
227extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
228 struct nfs_fh *, struct nfs_fattr *);
72de53ec 229extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
cf470c3e 230extern int nfs4_release_lockowner(struct nfs4_lock_state *);
64c2ce8b 231extern const struct xattr_handler *nfs4_xattr_handlers[];
4ce79717 232
557134a3 233#if defined(CONFIG_NFS_V4_1)
035168ab
TM
234static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
235{
236 return server->nfs_client->cl_session;
237}
238
239extern int nfs4_setup_sequence(const struct nfs_server *server,
fbcd4abc 240 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
9d12b216 241 struct rpc_task *task);
dc70d7b3
AA
242extern int nfs41_setup_sequence(struct nfs4_session *session,
243 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
9d12b216 244 struct rpc_task *task);
848f5bda
TM
245extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
246extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
9430fb6b
RL
247extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
248 struct nfs_fsinfo *fsinfo);
863a3c6c 249extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
ef311537 250 bool sync);
94de8b27
AA
251
252static inline bool
253is_ds_only_client(struct nfs_client *clp)
254{
255 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
256 EXCHGID4_FLAG_USE_PNFS_DS;
257}
d83217c1
AA
258
259static inline bool
260is_ds_client(struct nfs_client *clp)
261{
262 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
263}
fbcd4abc 264#else /* CONFIG_NFS_v4_1 */
035168ab
TM
265static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
266{
267 return NULL;
268}
269
270static inline int nfs4_setup_sequence(const struct nfs_server *server,
fbcd4abc 271 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
9d12b216 272 struct rpc_task *task)
fbcd4abc 273{
d9afbd1b 274 rpc_call_start(task);
fbcd4abc
AA
275 return 0;
276}
fccba804 277
94de8b27
AA
278static inline bool
279is_ds_only_client(struct nfs_client *clp)
d83217c1
AA
280{
281 return false;
282}
283
284static inline bool
285is_ds_client(struct nfs_client *clp)
94de8b27
AA
286{
287 return false;
288}
557134a3 289#endif /* CONFIG_NFS_V4_1 */
4ce79717 290
97dc1359 291extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
29fba38b 292
1549210f 293extern const u32 nfs4_fattr_bitmap[3];
4ce79717
TM
294extern const u32 nfs4_statfs_bitmap[2];
295extern const u32 nfs4_pathconf_bitmap[2];
dae100c2 296extern const u32 nfs4_fsinfo_bitmap[3];
830b8e33 297extern const u32 nfs4_fs_locations_bitmap[2];
4ce79717 298
cdb7eced
BS
299void nfs4_free_client(struct nfs_client *);
300
6663ee7f
BS
301struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
302
4ce79717 303/* nfs4renewd.c */
adfa6f98 304extern void nfs4_schedule_state_renewal(struct nfs_client *);
4ce79717 305extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
adfa6f98 306extern void nfs4_kill_renewd(struct nfs_client *);
65f27f38 307extern void nfs4_renew_state(struct work_struct *);
4ce79717
TM
308
309/* nfs4state.c */
a7b72103 310struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
fe20d7d5 311struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
6dc9d57a 312struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
05f4c350
CL
313int nfs4_discover_server_trunking(struct nfs_client *clp,
314 struct nfs_client **);
315int nfs40_discover_server_trunking(struct nfs_client *clp,
316 struct nfs_client **, struct rpc_cred *);
a7b72103 317#if defined(CONFIG_NFS_V4_1)
b4b82607 318struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
05f4c350
CL
319int nfs41_discover_server_trunking(struct nfs_client *clp,
320 struct nfs_client **, struct rpc_cred *);
9f594791 321extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
ac074835 322extern void nfs41_server_notify_target_slotid_update(struct nfs_client *clp);
c10e4498 323extern void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp);
5d63360d 324
0400a6b0 325#else
9f594791 326static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
0400a6b0
TM
327{
328}
a7b72103 329#endif /* CONFIG_NFS_V4_1 */
4ce79717 330
d1e284d5 331extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
4ce79717 332extern void nfs4_put_state_owner(struct nfs4_state_owner *);
0aaaf5c4 333extern void nfs4_purge_state_owners(struct nfs_server *);
4ce79717
TM
334extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
335extern void nfs4_put_open_state(struct nfs4_state *);
643168c2
AV
336extern void nfs4_close_state(struct nfs4_state *, fmode_t);
337extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
dc0b027d 338extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
a1d0b5ee
TM
339extern void nfs_inode_find_state_and_recover(struct inode *inode,
340 const nfs4_stateid *stateid);
0400a6b0 341extern void nfs4_schedule_lease_recovery(struct nfs_client *);
33021279
TM
342extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
343extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
b0d3ded1 344extern void nfs4_schedule_state_manager(struct nfs_client *);
042b60be 345extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
0400a6b0 346extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
0629e370 347extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
78fe0f41 348extern void nfs41_handle_server_scope(struct nfs_client *,
79d4e1f0 349 struct nfs41_server_scope **);
faf5f49c 350extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
8d0a8a9d 351extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
4fc8796d 352extern void nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
2a369153 353 fmode_t, const struct nfs_lockowner *);
4ce79717 354
8535b2be 355extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
cee54fc9
TM
356extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
357extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
358extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
72211dbe 359extern void nfs_release_seqid(struct nfs_seqid *seqid);
cee54fc9
TM
360extern void nfs_free_seqid(struct nfs_seqid *seqid);
361
5ae67c4f 362extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
cf470c3e 363
4ce79717
TM
364extern const nfs4_stateid zero_stateid;
365
129d1977 366/* nfs4super.c */
fbdefd64 367struct nfs_mount_info;
ab7017a3 368extern struct nfs_subversion nfs_v4;
ff9099f2 369struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
fac1e8e4
BS
370extern bool nfs4_disable_idmapping;
371extern unsigned short max_session_slots;
372extern unsigned short send_implementation_id;
89d77c8f 373
6f2ea7f2
CL
374#define NFS4_CLIENT_ID_UNIQ_LEN (64)
375extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
376
466bfe7f
BS
377/* nfs4sysctl.c */
378#ifdef CONFIG_SYSCTL
379int nfs4_register_sysctl(void);
380void nfs4_unregister_sysctl(void);
381#else
382static inline int nfs4_register_sysctl(void)
383{
384 return 0;
385}
386
0add3e85 387static inline void nfs4_unregister_sysctl(void)
466bfe7f
BS
388{
389}
390#endif
391
4ce79717 392/* nfs4xdr.c */
4ce79717
TM
393extern struct rpc_procinfo nfs4_procedures[];
394
395struct nfs4_mount_data;
396
397/* callback_xdr.c */
398extern struct svc_version nfs4_callback_version1;
07bccc2d 399extern struct svc_version nfs4_callback_version4;
4ce79717 400
f597c537
TM
401static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
402{
2d2f24ad 403 memcpy(dst, src, sizeof(*dst));
f597c537
TM
404}
405
406static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
407{
2d2f24ad 408 return memcmp(dst, src, sizeof(*dst)) == 0;
f597c537
TM
409}
410
4ce79717
TM
411#else
412
643168c2
AV
413#define nfs4_close_state(a, b) do { } while (0)
414#define nfs4_close_sync(a, b) do { } while (0)
4ce79717
TM
415
416#endif /* CONFIG_NFS_V4 */
417#endif /* __LINUX_FS_NFS_NFS4_FS.H */