blob: 137e18abb7e792660be11acf7b114213f71cd9a1 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Trond Myklebust4ce79712005-06-22 17:16:21 +00002/*
3 * linux/fs/nfs/nfs4_fs.h
4 *
5 * Copyright (C) 2005 Trond Myklebust
6 *
7 * NFSv4-specific filesystem definitions and declarations
8 */
9
10#ifndef __LINUX_FS_NFS_NFS4_FS_H
11#define __LINUX_FS_NFS_NFS4_FS_H
12
Anna Schumaker694e0962013-11-13 12:29:08 -050013#if defined(CONFIG_NFS_V4_2)
14#define NFS4_MAX_MINOR_VERSION 2
15#elif defined(CONFIG_NFS_V4_1)
16#define NFS4_MAX_MINOR_VERSION 1
17#else
18#define NFS4_MAX_MINOR_VERSION 0
19#endif
20
Bryan Schumaker89d77c82012-07-30 16:05:25 -040021#if IS_ENABLED(CONFIG_NFS_V4)
Trond Myklebust4ce79712005-06-22 17:16:21 +000022
Trond Myklebust33021272012-11-26 13:13:29 -050023#define NFS4_MAX_LOOP_ON_RECOVER (10)
24
Trond Myklebustc137afa2013-02-07 14:41:11 -050025#include <linux/seqlock.h>
26
Trond Myklebust4ce79712005-06-22 17:16:21 +000027struct idmap;
28
Trond Myklebust4ce79712005-06-22 17:16:21 +000029enum nfs4_client_state {
Trond Myklebuste005e802008-12-23 15:21:48 -050030 NFS4CLNT_MANAGER_RUNNING = 0,
Trond Myklebuste598d842008-12-23 15:21:42 -050031 NFS4CLNT_CHECK_LEASE,
Trond Myklebust58d97142006-01-03 09:55:24 +010032 NFS4CLNT_LEASE_EXPIRED,
Trond Myklebustb79a4a12008-12-23 15:21:41 -050033 NFS4CLNT_RECLAIM_REBOOT,
34 NFS4CLNT_RECLAIM_NOGRACE,
Trond Myklebust707fb4b2008-12-23 15:21:47 -050035 NFS4CLNT_DELEGRETURN,
Andy Adamson6df08182009-12-04 15:55:05 -050036 NFS4CLNT_SESSION_RESET,
Trond Myklebustfd954ae2011-04-24 14:28:18 -040037 NFS4CLNT_LEASE_CONFIRM,
Weston Andros Adamson78fe0f42011-05-31 19:05:47 -040038 NFS4CLNT_SERVER_SCOPE_MISMATCH,
Chuck Lever2c820d92012-05-21 22:45:33 -040039 NFS4CLNT_PURGE_STATE,
Weston Andros Adamsona9e64442012-05-24 12:26:37 -040040 NFS4CLNT_BIND_CONN_TO_SESSION,
Chuck Leverc9fdeb22013-10-17 14:13:02 -040041 NFS4CLNT_MOVED,
Chuck Leverb7f7a662013-10-17 14:13:35 -040042 NFS4CLNT_LEASE_MOVED,
Trond Myklebust45870d62016-09-22 13:38:59 -040043 NFS4CLNT_DELEGATION_EXPIRED,
Trond Myklebust4ce79712005-06-22 17:16:21 +000044};
45
Trond Myklebust2f60ea62011-08-24 15:07:37 -040046#define NFS4_RENEW_TIMEOUT 0x01
47#define NFS4_RENEW_DELEGATION_CB 0x02
48
Trond Myklebust63f5f792015-01-23 19:19:25 -050049struct nfs_seqid_counter;
Trond Myklebust97dc1352010-06-16 09:52:26 -040050struct nfs4_minor_version_ops {
51 u32 minor_version;
Trond Myklebust39c6daa2013-03-15 16:11:57 -040052 unsigned init_caps;
Trond Myklebust97dc1352010-06-16 09:52:26 -040053
Chuck Leverabf79bb2013-08-09 12:49:11 -040054 int (*init_client)(struct nfs_client *);
55 void (*shutdown_client)(struct nfs_client *);
Trond Myklebust36281ca2012-03-04 18:13:56 -050056 bool (*match_stateid)(const nfs4_stateid *,
Trond Myklebuste047a102010-06-16 09:52:27 -040057 const nfs4_stateid *);
Bryan Schumakerfca78d62011-06-02 14:59:07 -040058 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
59 struct nfs_fsinfo *);
Jeff Laytonf1cdae82014-05-01 06:28:47 -040060 void (*free_lock_state)(struct nfs_server *,
Trond Myklebustc8b2d0b2013-05-03 16:22:55 -040061 struct nfs4_lock_state *);
Trond Myklebust45870d62016-09-22 13:38:59 -040062 int (*test_and_free_expired)(struct nfs_server *,
63 nfs4_stateid *, struct rpc_cred *);
Trond Myklebust63f5f792015-01-23 19:19:25 -050064 struct nfs_seqid *
65 (*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
Andy Adamson04fa2c62016-09-09 09:22:29 -040066 int (*session_trunk)(struct rpc_clnt *, struct rpc_xprt *, void *);
Chuck Lever9915ea72013-08-09 12:48:27 -040067 const struct rpc_call_ops *call_sync_ops;
Trond Myklebustc48f4f32010-06-16 09:52:27 -040068 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
69 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
70 const struct nfs4_state_maintenance_ops *state_renewal_ops;
Chuck Leverec011fe2013-10-17 14:12:39 -040071 const struct nfs4_mig_recovery_ops *mig_recovery_ops;
Trond Myklebust97dc1352010-06-16 09:52:26 -040072};
73
Trond Myklebustcee54fc2005-10-18 14:20:12 -070074#define NFS_SEQID_CONFIRMED 1
75struct nfs_seqid_counter {
Trond Myklebust95b72eb2012-04-20 19:24:51 -040076 ktime_t create_time;
Trond Myklebust48c22eb2012-01-17 22:04:25 -050077 int owner_id;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070078 int flags;
79 u32 counter;
Trond Myklebust7ba127a2012-01-17 22:04:25 -050080 spinlock_t lock; /* Protects the list */
81 struct list_head list; /* Defines sequence of RPC calls */
82 struct rpc_wait_queue wait; /* RPC call delay queue */
Trond Myklebustcee54fc2005-10-18 14:20:12 -070083};
84
85struct nfs_seqid {
Trond Myklebustcee54fc2005-10-18 14:20:12 -070086 struct nfs_seqid_counter *sequence;
Trond Myklebust4e513362005-10-20 14:22:41 -070087 struct list_head list;
Trond Myklebust4601df22012-01-20 18:47:05 -050088 struct rpc_task *task;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070089};
90
91static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
92{
93 if (seqid_mutating_err(-status))
94 seqid->flags |= NFS_SEQID_CONFIRMED;
95}
96
97/*
Trond Myklebust4ce79712005-06-22 17:16:21 +000098 * NFS4 state_owners and lock_owners are simply labels for ordered
99 * sequences of RPC calls. Their sole purpose is to provide once-only
100 * semantics by allowing the server to identify replayed requests.
Trond Myklebust4ce79712005-06-22 17:16:21 +0000101 */
102struct nfs4_state_owner {
Trond Myklebust6f2e64d2007-07-06 10:53:21 -0400103 struct nfs_server *so_server;
Chuck Lever0aaaf5c2011-12-06 16:13:48 -0500104 struct list_head so_lru;
105 unsigned long so_expires;
Chuck Lever24d292b2010-12-24 01:32:43 +0000106 struct rb_node so_server_node;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000107
108 struct rpc_cred *so_cred; /* Associated cred */
Trond Myklebust9f958ab2007-07-02 13:58:33 -0400109
110 spinlock_t so_lock;
111 atomic_t so_count;
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500112 unsigned long so_flags;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000113 struct list_head so_states;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700114 struct nfs_seqid_counter so_seqid;
Trond Myklebustc137afa2013-02-07 14:41:11 -0500115 seqcount_t so_reclaim_seqcount;
Trond Myklebust65b62a22013-02-07 10:54:07 -0500116 struct mutex so_delegreturn_mutex;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000117};
118
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500119enum {
120 NFS_OWNER_RECLAIM_REBOOT,
121 NFS_OWNER_RECLAIM_NOGRACE
122};
123
Alexandros Batsakisafe6c272009-12-09 01:50:14 -0800124#define NFS_LOCK_NEW 0
125#define NFS_LOCK_RECLAIM 1
126#define NFS_LOCK_EXPIRED 2
127
Trond Myklebust4ce79712005-06-22 17:16:21 +0000128/*
129 * struct nfs4_state maintains the client-side state for a given
130 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
131 *
132 * OPEN:
133 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
134 * we need to know how many files are open for reading or writing on a
135 * given inode. This information too is stored here.
136 *
137 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
138 */
139
140struct nfs4_lock_state {
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400141 struct list_head ls_locks; /* Other lock stateids */
142 struct nfs4_state * ls_state; /* Pointer to open state */
Trond Myklebust795a88c2012-09-10 13:26:49 -0400143#define NFS_LOCK_INITIALIZED 0
NeilBrownef1820f2013-09-04 17:04:49 +1000144#define NFS_LOCK_LOST 1
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400145 unsigned long ls_flags;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700146 struct nfs_seqid_counter ls_seqid;
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400147 nfs4_stateid ls_stateid;
Elena Reshetova194bc1f2017-10-20 12:53:36 +0300148 refcount_t ls_count;
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400149 fl_owner_t ls_owner;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000150};
151
152/* bits for nfs4_state->flags */
153enum {
154 LK_STATE_IN_USE,
Trond Myklebust003707c2007-07-05 18:07:55 -0400155 NFS_DELEGATED_STATE, /* Current stateid is delegation */
Trond Myklebust92b40e92013-04-20 01:25:45 -0400156 NFS_OPEN_STATE, /* OPEN stateid is set */
Trond Myklebust003707c2007-07-05 18:07:55 -0400157 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
158 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
159 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
Trond Myklebustb79a4a12008-12-23 15:21:41 -0500160 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
161 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
Trond Myklebust8e469eb2010-01-26 15:42:30 -0500162 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
Trond Myklebust5d422302013-03-14 16:57:48 -0400163 NFS_STATE_RECOVERY_FAILED, /* OPEN stateid state recovery failed */
Jeff Laytona8ce3772016-09-17 18:17:35 -0400164 NFS_STATE_MAY_NOTIFY_LOCK, /* server may CB_NOTIFY_LOCK */
Trond Myklebustc9399f22017-11-06 15:28:01 -0500165 NFS_STATE_CHANGE_WAIT, /* A state changing operation is outstanding */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000166};
167
168struct nfs4_state {
169 struct list_head open_states; /* List of states for the same state_owner */
170 struct list_head inode_states; /* List of states for the same inode */
171 struct list_head lock_states; /* List of subservient lock stateids */
172
173 struct nfs4_state_owner *owner; /* Pointer to the open owner */
174 struct inode *inode; /* Pointer to the inode */
175
176 unsigned long flags; /* Do we hold any locks? */
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000177 spinlock_t state_lock; /* Protects the lock_states list */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000178
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400179 seqlock_t seqlock; /* Protects the stateid/open_stateid */
Trond Myklebust003707c2007-07-05 18:07:55 -0400180 nfs4_stateid stateid; /* Current stateid: may be delegation */
181 nfs4_stateid open_stateid; /* OPEN stateid */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000182
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400183 /* The following 3 fields are protected by owner->so_lock */
Trond Myklebust003707c2007-07-05 18:07:55 -0400184 unsigned int n_rdonly; /* Number of read-only references */
185 unsigned int n_wronly; /* Number of write-only references */
186 unsigned int n_rdwr; /* Number of read/write references */
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500187 fmode_t state; /* State on the server (R,W, or RW) */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000188 atomic_t count;
Trond Myklebustc9399f22017-11-06 15:28:01 -0500189
190 wait_queue_head_t waitq;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000191};
192
193
194struct nfs4_exception {
Trond Myklebust9e33bed2008-12-23 15:21:46 -0500195 struct nfs4_state *state;
Trond Myklebust3114ea72012-03-07 16:39:06 -0500196 struct inode *inode;
Trond Myklebust8487c472016-06-26 08:44:35 -0400197 nfs4_stateid *stateid;
Trond Myklebustb3c2aa02015-09-20 14:32:45 -0400198 long timeout;
199 unsigned char delay : 1,
200 recovering : 1,
201 retry : 1;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000202};
203
204struct nfs4_state_recovery_ops {
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500205 int owner_flag_bit;
Trond Myklebustb79a4a12008-12-23 15:21:41 -0500206 int state_flag_bit;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000207 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
208 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
Andy Adamson591d71c2009-04-01 09:22:47 -0400209 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
Trond Myklebust965e9c22013-05-20 11:05:17 -0400210 int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
Chuck Lever05f4c352012-09-14 17:24:32 -0400211 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
212 struct rpc_cred *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000213};
214
Fred Isaman1b146fc2016-09-21 15:24:26 -0400215struct nfs4_opendata {
216 struct kref kref;
217 struct nfs_openargs o_arg;
218 struct nfs_openres o_res;
219 struct nfs_open_confirmargs c_arg;
220 struct nfs_open_confirmres c_res;
221 struct nfs4_string owner_name;
222 struct nfs4_string group_name;
223 struct nfs4_label *a_label;
224 struct nfs_fattr f_attr;
225 struct nfs4_label *f_label;
226 struct dentry *dir;
227 struct dentry *dentry;
228 struct nfs4_state_owner *owner;
229 struct nfs4_state *state;
230 struct iattr attrs;
231 struct nfs4_layoutget *lgp;
232 unsigned long timestamp;
233 bool rpc_done;
234 bool file_created;
235 bool is_recover;
236 bool cancelled;
237 int rpc_status;
238};
239
Andy Adamson04fa2c62016-09-09 09:22:29 -0400240struct nfs4_add_xprt_data {
241 struct nfs_client *clp;
242 struct rpc_cred *cred;
243};
244
Benny Halevy29fba382009-04-01 09:22:44 -0400245struct nfs4_state_maintenance_ops {
Trond Myklebust2f60ea62011-08-24 15:07:37 -0400246 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
Andy Adamsona7b72102009-04-01 09:22:46 -0400247 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
Benny Halevy8e69514f2009-04-01 09:22:45 -0400248 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
Benny Halevy29fba382009-04-01 09:22:44 -0400249};
250
Chuck Leverec011fe2013-10-17 14:12:39 -0400251struct nfs4_mig_recovery_ops {
Chuck Leverb03d7352013-10-17 14:12:50 -0400252 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
253 struct page *, struct rpc_cred *);
Chuck Lever44c99932013-10-17 14:13:30 -0400254 int (*fsid_present)(struct inode *, struct rpc_cred *);
Chuck Leverec011fe2013-10-17 14:12:39 -0400255};
256
Al Virof786aa92009-02-20 05:51:22 +0000257extern const struct dentry_operations nfs4_dentry_operations;
Bryan Schumaker73a79702012-07-16 16:39:12 -0400258
259/* dir.c */
260int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
261 unsigned, umode_t, int *);
J. Bruce Fields6b3b5492005-06-22 17:16:22 +0000262
bjschuma@gmail.com1ae811e2012-08-08 13:57:06 -0400263/* super.c */
264extern struct file_system_type nfs4_fs_type;
265
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400266/* nfs4namespace.c */
Al Virobeffb8f2016-07-20 16:34:42 -0400267struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
268 const struct qstr *);
Bryan Schumaker281cad42012-04-27 13:27:45 -0400269struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
270 struct nfs_fh *, struct nfs_fattr *);
Chuck Lever800c06a2013-10-17 14:12:34 -0400271int nfs4_replace_transport(struct nfs_server *server,
272 const struct nfs4_fs_locations *locations);
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400273
Trond Myklebust4ce79712005-06-22 17:16:21 +0000274/* nfs4proc.c */
Anna Schumakerf4ac1672014-11-25 13:18:15 -0500275extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
Anna Schumaker1c6dcbe2014-09-26 13:58:48 -0400276extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
277 struct rpc_message *, struct nfs4_sequence_args *,
278 struct nfs4_sequence_res *, int);
Anna Schumakerfba83f32018-05-04 16:22:50 -0400279extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
Trond Myklebustbb8b27e2010-04-16 16:43:06 -0400280extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
281extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
Trond Myklebust5e6b1992013-09-07 12:58:57 -0400282extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
Trond Myklebust2cf047c2012-05-25 17:57:41 -0400283extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
Andy Adamson4d643d12009-12-04 15:52:24 -0500284extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
Trond Myklebust66245532012-05-25 17:18:09 -0400285extern int nfs4_destroy_clientid(struct nfs_client *clp);
Andy Adamson591d71c2009-04-01 09:22:47 -0400286extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
Andy Adamson4d643d12009-12-04 15:52:24 -0500287extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
Trond Myklebust1f7977c2012-09-20 20:31:51 -0400288extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
Trond Myklebust55a97592006-06-09 09:34:19 -0400289extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
Bryan Schumakerf05d1472012-04-27 13:27:41 -0400290extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
291 struct nfs4_fs_locations *, struct page *);
Chuck Leverb03d7352013-10-17 14:12:50 -0400292extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
293 struct page *page, struct rpc_cred *);
Chuck Lever44c99932013-10-17 14:13:30 -0400294extern int nfs4_proc_fsid_present(struct inode *, struct rpc_cred *);
Al Virobeffb8f2016-07-20 16:34:42 -0400295extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, const struct qstr *,
Bryan Schumakerf05d1472012-04-27 13:27:41 -0400296 struct nfs_fh *, struct nfs_fattr *);
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400297extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
Aneesh Kumar K.V64c2ce82010-12-09 11:35:25 +0000298extern const struct xattr_handler *nfs4_xattr_handlers[];
Trond Myklebust5521abf2013-03-16 20:54:34 -0400299extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
Trond Myklebust9b206142013-03-17 15:52:00 -0400300 const struct nfs_open_context *ctx,
301 const struct nfs_lock_context *l_ctx,
302 fmode_t fmode);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000303
Andy Adamson557134a2009-04-01 09:21:53 -0400304#if defined(CONFIG_NFS_V4_1)
Andy Adamsonf9c96fc2014-01-29 11:34:38 -0500305extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
Trond Myklebust848f5bd2012-05-25 17:51:23 -0400306extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
307extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
Ricardo Labiaga9430fb62009-12-06 12:23:46 -0500308extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
309 struct nfs_fsinfo *fsinfo);
Andy Adamson863a3c62011-03-23 13:27:54 +0000310extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
Andy Adamsonef311532011-03-12 02:58:10 -0500311 bool sync);
Andy Adamsonba84db92016-09-09 09:22:21 -0400312extern int nfs4_detect_session_trunking(struct nfs_client *clp,
313 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
Andy Adamson94de8b22011-03-01 01:34:12 +0000314
315static inline bool
316is_ds_only_client(struct nfs_client *clp)
317{
318 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
319 EXCHGID4_FLAG_USE_PNFS_DS;
320}
Andy Adamsond83217c2011-03-01 01:34:17 +0000321
322static inline bool
323is_ds_client(struct nfs_client *clp)
324{
325 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
326}
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400327
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400328static inline bool
329_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
330 struct rpc_clnt **clntp, struct rpc_message *msg)
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400331{
332 struct rpc_cred *newcred = NULL;
333 rpc_authflavor_t flavor;
334
NeilBrownb79e87e2017-08-18 17:12:52 +1000335 if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
336 sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
337 /* Using machine creds for cleanup operations
338 * is only relevent if the client credentials
339 * might expire. So don't bother for
340 * RPC_AUTH_UNIX. If file was only exported to
341 * sec=sys, the PUTFH would fail anyway.
342 */
343 if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
344 return false;
345 }
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400346 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
347 spin_lock(&clp->cl_lock);
348 if (clp->cl_machine_cred != NULL)
Weston Andros Adamsonade33ff2013-09-10 18:44:32 -0400349 /* don't call get_rpccred on the machine cred -
350 * a reference will be held for life of clp */
351 newcred = clp->cl_machine_cred;
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400352 spin_unlock(&clp->cl_lock);
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400353 msg->rpc_cred = newcred;
354
355 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
Weston Andros Adamson312cd952013-09-10 18:44:33 -0400356 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
357 flavor != RPC_AUTH_GSS_KRB5P);
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400358 *clntp = clp->cl_rpcclient;
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400359
360 return true;
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400361 }
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400362 return false;
363}
364
365/*
366 * Function responsible for determining if an rpc_message should use the
367 * machine cred under SP4_MACH_CRED and if so switching the credential and
368 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
369 * Should be called before rpc_call_sync/rpc_call_async.
370 */
371static inline void
372nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
373 struct rpc_clnt **clntp, struct rpc_message *msg)
374{
375 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
376}
377
378/*
379 * Special wrapper to nfs4_state_protect for write.
380 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
381 * that use machine cred use NFS_FILE_SYNC.
382 */
383static inline void
384nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400385 struct rpc_message *msg, struct nfs_pgio_header *hdr)
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400386{
387 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
388 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400389 hdr->args.stable = NFS_FILE_SYNC;
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400390}
Andy Adamsonfbcd4ab2009-04-01 09:22:15 -0400391#else /* CONFIG_NFS_v4_1 */
Andy Adamson94de8b22011-03-01 01:34:12 +0000392static inline bool
393is_ds_only_client(struct nfs_client *clp)
394{
395 return false;
396}
Andy Adamsond83217c2011-03-01 01:34:17 +0000397
398static inline bool
399is_ds_client(struct nfs_client *clp)
400{
401 return false;
402}
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400403
404static inline void
405nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
406 struct rpc_clnt **clntp, struct rpc_message *msg)
407{
408}
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400409
410static inline void
411nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400412 struct rpc_message *msg, struct nfs_pgio_header *hdr)
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400413{
414}
Andy Adamson557134a2009-04-01 09:21:53 -0400415#endif /* CONFIG_NFS_V4_1 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000416
Trond Myklebust97dc1352010-06-16 09:52:26 -0400417extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
Benny Halevy29fba382009-04-01 09:22:44 -0400418
Trond Myklebust1549210f2012-06-05 09:16:47 -0400419extern const u32 nfs4_fattr_bitmap[3];
David Quigleya09df2c2013-05-22 12:50:41 -0400420extern const u32 nfs4_statfs_bitmap[3];
421extern const u32 nfs4_pathconf_bitmap[3];
Fred Isamandae100c2011-07-30 20:52:37 -0400422extern const u32 nfs4_fsinfo_bitmap[3];
David Quigleya09df2c2013-05-22 12:50:41 -0400423extern const u32 nfs4_fs_locations_bitmap[3];
Trond Myklebust4ce79712005-06-22 17:16:21 +0000424
Chuck Leverabf79bb2013-08-09 12:49:11 -0400425void nfs40_shutdown_client(struct nfs_client *);
426void nfs41_shutdown_client(struct nfs_client *);
427int nfs40_init_client(struct nfs_client *);
428int nfs41_init_client(struct nfs_client *);
Bryan Schumakercdb7ece2012-06-20 15:53:45 -0400429void nfs4_free_client(struct nfs_client *);
430
Bryan Schumaker6663ee72012-06-20 15:53:46 -0400431struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
432
Trond Myklebust4ce79712005-06-22 17:16:21 +0000433/* nfs4renewd.c */
David Howellsadfa6f92006-08-22 20:06:08 -0400434extern void nfs4_schedule_state_renewal(struct nfs_client *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000435extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
David Howellsadfa6f92006-08-22 20:06:08 -0400436extern void nfs4_kill_renewd(struct nfs_client *);
David Howells65f27f32006-11-22 14:55:48 +0000437extern void nfs4_renew_state(struct work_struct *);
Trond Myklebustfb10fb62016-08-05 19:13:08 -0400438extern void nfs4_set_lease_period(struct nfs_client *clp,
439 unsigned long lease,
440 unsigned long lastrenewed);
441
Trond Myklebust4ce79712005-06-22 17:16:21 +0000442
443/* nfs4state.c */
Chuck Lever73d8bde2013-07-24 12:28:37 -0400444struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
Trond Myklebustfe20d7d2012-11-21 22:49:36 -0500445struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
Trond Myklebust6dc9d572008-12-23 15:21:41 -0500446struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
Chuck Lever05f4c352012-09-14 17:24:32 -0400447int nfs4_discover_server_trunking(struct nfs_client *clp,
448 struct nfs_client **);
449int nfs40_discover_server_trunking(struct nfs_client *clp,
450 struct nfs_client **, struct rpc_cred *);
Andy Adamsona7b72102009-04-01 09:22:46 -0400451#if defined(CONFIG_NFS_V4_1)
Chuck Lever05f4c352012-09-14 17:24:32 -0400452int nfs41_discover_server_trunking(struct nfs_client *clp,
453 struct nfs_client **, struct rpc_cred *);
Trond Myklebust9f594792012-05-27 13:02:53 -0400454extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
Anna Schumaker3f10a6a2015-07-13 14:01:31 -0400455extern void nfs41_notify_server(struct nfs_client *);
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500456#else
Trond Myklebust9f594792012-05-27 13:02:53 -0400457static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500458{
459}
Andy Adamsona7b72102009-04-01 09:22:46 -0400460#endif /* CONFIG_NFS_V4_1 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000461
Trond Myklebustd1e284d2012-01-17 22:04:24 -0500462extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000463extern void nfs4_put_state_owner(struct nfs4_state_owner *);
Chuck Lever0aaaf5c2011-12-06 16:13:48 -0500464extern void nfs4_purge_state_owners(struct nfs_server *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000465extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
466extern void nfs4_put_open_state(struct nfs4_state *);
Al Viro643168c2011-06-22 18:20:23 -0400467extern void nfs4_close_state(struct nfs4_state *, fmode_t);
468extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500469extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500470extern void nfs_inode_find_state_and_recover(struct inode *inode,
471 const nfs4_stateid *stateid);
Trond Myklebust4f14c192014-02-12 19:15:06 -0500472extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500473extern void nfs4_schedule_lease_recovery(struct nfs_client *);
Trond Myklebust33021272012-11-26 13:13:29 -0500474extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
475extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
Trond Myklebustb0d3ded2008-12-23 15:21:50 -0500476extern void nfs4_schedule_state_manager(struct nfs_client *);
Trond Myklebust042b60b2011-08-24 15:07:37 -0400477extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
Trond Myklebust5d422302013-03-14 16:57:48 -0400478extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
Chuck Leverc9fdeb22013-10-17 14:13:02 -0400479extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
Chuck Leverb7f7a662013-10-17 14:13:35 -0400480extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
Trond Myklebust0a014a42016-09-22 13:38:51 -0400481extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
Weston Andros Adamson78fe0f42011-05-31 19:05:47 -0400482extern void nfs41_handle_server_scope(struct nfs_client *,
Chuck Lever79d4e1f2012-05-21 22:44:31 -0400483 struct nfs41_server_scope **);
Trond Myklebustfaf5f492005-10-18 14:20:15 -0700484extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000485extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
Trond Myklebustabf4e132016-05-16 17:42:44 -0400486extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
NeilBrown17393472016-10-13 15:26:47 +1100487 const struct nfs_lock_context *, nfs4_stateid *,
Trond Myklebustabf4e132016-05-16 17:42:44 -0400488 struct rpc_cred **);
Trond Myklebust12f275c2017-11-06 15:28:05 -0500489extern bool nfs4_refresh_open_stateid(nfs4_stateid *dst,
490 struct nfs4_state *state);
Trond Myklebustc82bac62017-11-06 15:28:06 -0500491extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
492 struct nfs4_state *state);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000493
Trond Myklebust8535b2b2010-05-13 12:51:01 -0400494extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700495extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
496extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
497extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
Trond Myklebust72211db2009-12-15 14:47:36 -0500498extern void nfs_release_seqid(struct nfs_seqid *seqid);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700499extern void nfs_free_seqid(struct nfs_seqid *seqid);
Trond Myklebust3be0f80b2017-10-19 15:46:45 -0400500extern int nfs4_setup_sequence(struct nfs_client *client,
Peng Taocb04ad22014-06-11 05:24:15 +0800501 struct nfs4_sequence_args *args,
502 struct nfs4_sequence_res *res,
503 struct rpc_task *task);
Peng Tao2c4b1312014-06-11 05:24:16 +0800504extern int nfs4_sequence_done(struct rpc_task *task,
505 struct nfs4_sequence_res *res);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700506
Trond Myklebust5ae67c42012-03-19 16:17:18 -0400507extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
Trond Myklebustcf470c32012-03-07 13:49:12 -0500508
Trond Myklebust4ce79712005-06-22 17:16:21 +0000509extern const nfs4_stateid zero_stateid;
Trond Myklebustfcd88432017-11-07 12:39:44 -0500510extern const nfs4_stateid invalid_stateid;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000511
Bryan Schumaker129d1972012-07-16 16:39:13 -0400512/* nfs4super.c */
Bryan Schumakerfbdefd62012-07-16 16:39:20 -0400513struct nfs_mount_info;
Bryan Schumakerab7017a2012-07-30 16:05:16 -0400514extern struct nfs_subversion nfs_v4;
Bryan Schumakerff9099f22012-07-30 16:05:18 -0400515struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
Bryan Schumakerfac1e8e2012-07-30 16:05:22 -0400516extern bool nfs4_disable_idmapping;
517extern unsigned short max_session_slots;
Trond Myklebust5405fc42016-08-29 20:03:52 -0400518extern unsigned short max_session_cb_slots;
Bryan Schumakerfac1e8e2012-07-30 16:05:22 -0400519extern unsigned short send_implementation_id;
Trond Myklebustf6de7a32013-09-04 10:08:54 -0400520extern bool recover_lost_locks;
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400521
Chuck Lever6f2ea7f2012-09-14 17:24:41 -0400522#define NFS4_CLIENT_ID_UNIQ_LEN (64)
523extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
524
Bryan Schumaker466bfe72012-07-16 16:39:14 -0400525/* nfs4sysctl.c */
526#ifdef CONFIG_SYSCTL
527int nfs4_register_sysctl(void);
528void nfs4_unregister_sysctl(void);
529#else
530static inline int nfs4_register_sysctl(void)
531{
532 return 0;
533}
534
Randy Dunlap0add3e82012-07-27 11:49:26 -0700535static inline void nfs4_unregister_sysctl(void)
Bryan Schumaker466bfe72012-07-16 16:39:14 -0400536{
537}
538#endif
539
Trond Myklebust4ce79712005-06-22 17:16:21 +0000540/* nfs4xdr.c */
Christoph Hellwig499b4982017-05-12 15:36:49 +0200541extern const struct rpc_procinfo nfs4_procedures[];
Trond Myklebust4ce79712005-06-22 17:16:21 +0000542
543struct nfs4_mount_data;
544
545/* callback_xdr.c */
Christoph Hellwige9679182017-05-12 16:21:37 +0200546extern const struct svc_version nfs4_callback_version1;
547extern const struct svc_version nfs4_callback_version4;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000548
Trond Myklebustf597c532012-03-04 18:13:56 -0500549static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
550{
Trond Myklebust93b717f2016-05-16 17:42:43 -0400551 memcpy(dst->data, src->data, sizeof(dst->data));
552 dst->type = src->type;
Trond Myklebustf597c532012-03-04 18:13:56 -0500553}
554
555static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
556{
Trond Myklebust93b717f2016-05-16 17:42:43 -0400557 if (dst->type != src->type)
558 return false;
559 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
Trond Myklebustf597c532012-03-04 18:13:56 -0500560}
561
Trond Myklebuste999e802014-02-10 18:20:47 -0500562static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
563{
564 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
565}
566
567static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
568{
569 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
570}
571
Trond Myklebust5d422302013-03-14 16:57:48 -0400572static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
573{
574 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
575}
576
Trond Myklebust3e7dfb12016-11-14 11:19:55 -0500577static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
578 const nfs4_stateid *stateid)
579{
580 return test_bit(NFS_OPEN_STATE, &state->flags) &&
581 nfs4_stateid_match_other(&state->open_stateid, stateid);
582}
583
Trond Myklebust4ce79712005-06-22 17:16:21 +0000584#else
585
Al Viro643168c2011-06-22 18:20:23 -0400586#define nfs4_close_state(a, b) do { } while (0)
587#define nfs4_close_sync(a, b) do { } while (0)
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400588#define nfs4_state_protect(a, b, c, d) do { } while (0)
589#define nfs4_state_protect_write(a, b, c, d) do { } while (0)
Trond Myklebust4ce79712005-06-22 17:16:21 +0000590
591#endif /* CONFIG_NFS_V4 */
592#endif /* __LINUX_FS_NFS_NFS4_FS.H */