blob: 9c136d53987d4ad9a2bd0d4012881bcb2cad606e [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 Myklebustaeabb3c2018-11-19 20:11:45 -050044 NFS4CLNT_RUN_MANAGER,
45 NFS4CLNT_DELEGRETURN_RUNNING,
Trond Myklebust4ce79712005-06-22 17:16:21 +000046};
47
Trond Myklebust2f60ea62011-08-24 15:07:37 -040048#define NFS4_RENEW_TIMEOUT 0x01
49#define NFS4_RENEW_DELEGATION_CB 0x02
50
Trond Myklebust63f5f792015-01-23 19:19:25 -050051struct nfs_seqid_counter;
Trond Myklebust97dc1352010-06-16 09:52:26 -040052struct nfs4_minor_version_ops {
53 u32 minor_version;
Trond Myklebust39c6daa2013-03-15 16:11:57 -040054 unsigned init_caps;
Trond Myklebust97dc1352010-06-16 09:52:26 -040055
Chuck Leverabf79bb2013-08-09 12:49:11 -040056 int (*init_client)(struct nfs_client *);
57 void (*shutdown_client)(struct nfs_client *);
Trond Myklebust36281ca2012-03-04 18:13:56 -050058 bool (*match_stateid)(const nfs4_stateid *,
Trond Myklebuste047a102010-06-16 09:52:27 -040059 const nfs4_stateid *);
Bryan Schumakerfca78d62011-06-02 14:59:07 -040060 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
61 struct nfs_fsinfo *);
Jeff Laytonf1cdae82014-05-01 06:28:47 -040062 void (*free_lock_state)(struct nfs_server *,
Trond Myklebustc8b2d0b2013-05-03 16:22:55 -040063 struct nfs4_lock_state *);
Trond Myklebust45870d62016-09-22 13:38:59 -040064 int (*test_and_free_expired)(struct nfs_server *,
NeilBrowna52458b2018-12-03 11:30:31 +110065 nfs4_stateid *, const struct cred *);
Trond Myklebust63f5f792015-01-23 19:19:25 -050066 struct nfs_seqid *
67 (*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
Santosh kumar pradhan10e037d2018-12-19 12:29:57 +053068 void (*session_trunk)(struct rpc_clnt *clnt,
69 struct rpc_xprt *xprt, void *data);
Chuck Lever9915ea72013-08-09 12:48:27 -040070 const struct rpc_call_ops *call_sync_ops;
Trond Myklebustc48f4f32010-06-16 09:52:27 -040071 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
72 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
73 const struct nfs4_state_maintenance_ops *state_renewal_ops;
Chuck Leverec011fe2013-10-17 14:12:39 -040074 const struct nfs4_mig_recovery_ops *mig_recovery_ops;
Trond Myklebust97dc1352010-06-16 09:52:26 -040075};
76
Trond Myklebustcee54fc2005-10-18 14:20:12 -070077#define NFS_SEQID_CONFIRMED 1
78struct nfs_seqid_counter {
Trond Myklebust95b72eb2012-04-20 19:24:51 -040079 ktime_t create_time;
Trond Myklebust48c22eb2012-01-17 22:04:25 -050080 int owner_id;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070081 int flags;
82 u32 counter;
Trond Myklebust7ba127a2012-01-17 22:04:25 -050083 spinlock_t lock; /* Protects the list */
84 struct list_head list; /* Defines sequence of RPC calls */
85 struct rpc_wait_queue wait; /* RPC call delay queue */
Trond Myklebustcee54fc2005-10-18 14:20:12 -070086};
87
88struct nfs_seqid {
Trond Myklebustcee54fc2005-10-18 14:20:12 -070089 struct nfs_seqid_counter *sequence;
Trond Myklebust4e513362005-10-20 14:22:41 -070090 struct list_head list;
Trond Myklebust4601df22012-01-20 18:47:05 -050091 struct rpc_task *task;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070092};
93
94static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
95{
96 if (seqid_mutating_err(-status))
97 seqid->flags |= NFS_SEQID_CONFIRMED;
98}
99
100/*
Trond Myklebust4ce79712005-06-22 17:16:21 +0000101 * NFS4 state_owners and lock_owners are simply labels for ordered
102 * sequences of RPC calls. Their sole purpose is to provide once-only
103 * semantics by allowing the server to identify replayed requests.
Trond Myklebust4ce79712005-06-22 17:16:21 +0000104 */
105struct nfs4_state_owner {
Trond Myklebust6f2e64d2007-07-06 10:53:21 -0400106 struct nfs_server *so_server;
Chuck Lever0aaaf5c2011-12-06 16:13:48 -0500107 struct list_head so_lru;
108 unsigned long so_expires;
Chuck Lever24d292b2010-12-24 01:32:43 +0000109 struct rb_node so_server_node;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000110
NeilBrowna52458b2018-12-03 11:30:31 +1100111 const struct cred *so_cred; /* Associated cred */
Trond Myklebust9f958ab2007-07-02 13:58:33 -0400112
113 spinlock_t so_lock;
114 atomic_t so_count;
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500115 unsigned long so_flags;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000116 struct list_head so_states;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700117 struct nfs_seqid_counter so_seqid;
Trond Myklebustc137afa2013-02-07 14:41:11 -0500118 seqcount_t so_reclaim_seqcount;
Trond Myklebust65b62a22013-02-07 10:54:07 -0500119 struct mutex so_delegreturn_mutex;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000120};
121
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500122enum {
123 NFS_OWNER_RECLAIM_REBOOT,
124 NFS_OWNER_RECLAIM_NOGRACE
125};
126
Alexandros Batsakisafe6c272009-12-09 01:50:14 -0800127#define NFS_LOCK_NEW 0
128#define NFS_LOCK_RECLAIM 1
129#define NFS_LOCK_EXPIRED 2
130
Trond Myklebust4ce79712005-06-22 17:16:21 +0000131/*
132 * struct nfs4_state maintains the client-side state for a given
133 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
134 *
135 * OPEN:
136 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
137 * we need to know how many files are open for reading or writing on a
138 * given inode. This information too is stored here.
139 *
140 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
141 */
142
143struct nfs4_lock_state {
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400144 struct list_head ls_locks; /* Other lock stateids */
145 struct nfs4_state * ls_state; /* Pointer to open state */
Trond Myklebust795a88c2012-09-10 13:26:49 -0400146#define NFS_LOCK_INITIALIZED 0
NeilBrownef1820f2013-09-04 17:04:49 +1000147#define NFS_LOCK_LOST 1
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400148 unsigned long ls_flags;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700149 struct nfs_seqid_counter ls_seqid;
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400150 nfs4_stateid ls_stateid;
Elena Reshetova194bc1f2017-10-20 12:53:36 +0300151 refcount_t ls_count;
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400152 fl_owner_t ls_owner;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000153};
154
155/* bits for nfs4_state->flags */
156enum {
157 LK_STATE_IN_USE,
Trond Myklebust003707c2007-07-05 18:07:55 -0400158 NFS_DELEGATED_STATE, /* Current stateid is delegation */
Trond Myklebust92b40e92013-04-20 01:25:45 -0400159 NFS_OPEN_STATE, /* OPEN stateid is set */
Trond Myklebust003707c2007-07-05 18:07:55 -0400160 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
161 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
162 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
Trond Myklebustb79a4a12008-12-23 15:21:41 -0500163 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
164 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
Trond Myklebust8e469eb2010-01-26 15:42:30 -0500165 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
Trond Myklebust5d422302013-03-14 16:57:48 -0400166 NFS_STATE_RECOVERY_FAILED, /* OPEN stateid state recovery failed */
Jeff Laytona8ce3772016-09-17 18:17:35 -0400167 NFS_STATE_MAY_NOTIFY_LOCK, /* server may CB_NOTIFY_LOCK */
Trond Myklebustc9399f22017-11-06 15:28:01 -0500168 NFS_STATE_CHANGE_WAIT, /* A state changing operation is outstanding */
Olga Kornievskaiae4648aa2018-08-13 15:33:01 -0400169 NFS_CLNT_DST_SSC_COPY_STATE, /* dst server open state on client*/
Olga Kornievskaia0e65a322019-06-14 14:38:40 -0400170 NFS_CLNT_SRC_SSC_COPY_STATE, /* src server open state on client*/
Olga Kornievskaia0b9018b2019-10-08 16:34:36 -0400171 NFS_SRV_SSC_COPY_STATE, /* ssc state on the dst server */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000172};
173
174struct nfs4_state {
175 struct list_head open_states; /* List of states for the same state_owner */
176 struct list_head inode_states; /* List of states for the same inode */
177 struct list_head lock_states; /* List of subservient lock stateids */
178
179 struct nfs4_state_owner *owner; /* Pointer to the open owner */
180 struct inode *inode; /* Pointer to the inode */
181
182 unsigned long flags; /* Do we hold any locks? */
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000183 spinlock_t state_lock; /* Protects the lock_states list */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000184
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400185 seqlock_t seqlock; /* Protects the stateid/open_stateid */
Trond Myklebust003707c2007-07-05 18:07:55 -0400186 nfs4_stateid stateid; /* Current stateid: may be delegation */
187 nfs4_stateid open_stateid; /* OPEN stateid */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000188
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400189 /* The following 3 fields are protected by owner->so_lock */
Trond Myklebust003707c2007-07-05 18:07:55 -0400190 unsigned int n_rdonly; /* Number of read-only references */
191 unsigned int n_wronly; /* Number of write-only references */
192 unsigned int n_rdwr; /* Number of read/write references */
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500193 fmode_t state; /* State on the server (R,W, or RW) */
Trond Myklebustace9fad2018-09-02 19:19:07 -0400194 refcount_t count;
Trond Myklebustc9399f22017-11-06 15:28:01 -0500195
196 wait_queue_head_t waitq;
Trond Myklebust9ae075f2018-09-02 19:15:15 -0400197 struct rcu_head rcu_head;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000198};
199
200
201struct nfs4_exception {
Trond Myklebust9e33bed2008-12-23 15:21:46 -0500202 struct nfs4_state *state;
Trond Myklebust3114ea72012-03-07 16:39:06 -0500203 struct inode *inode;
Trond Myklebust8487c472016-06-26 08:44:35 -0400204 nfs4_stateid *stateid;
Trond Myklebustb3c2aa02015-09-20 14:32:45 -0400205 long timeout;
206 unsigned char delay : 1,
207 recovering : 1,
208 retry : 1;
Trond Myklebust0688e642019-04-07 13:59:09 -0400209 bool interruptible;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000210};
211
212struct nfs4_state_recovery_ops {
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500213 int owner_flag_bit;
Trond Myklebustb79a4a12008-12-23 15:21:41 -0500214 int state_flag_bit;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000215 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
216 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
NeilBrowna52458b2018-12-03 11:30:31 +1100217 int (*establish_clid)(struct nfs_client *, const struct cred *);
218 int (*reclaim_complete)(struct nfs_client *, const struct cred *);
Chuck Lever05f4c352012-09-14 17:24:32 -0400219 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
NeilBrowna52458b2018-12-03 11:30:31 +1100220 const struct cred *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000221};
222
Fred Isaman1b146fc2016-09-21 15:24:26 -0400223struct nfs4_opendata {
224 struct kref kref;
225 struct nfs_openargs o_arg;
226 struct nfs_openres o_res;
227 struct nfs_open_confirmargs c_arg;
228 struct nfs_open_confirmres c_res;
229 struct nfs4_string owner_name;
230 struct nfs4_string group_name;
231 struct nfs4_label *a_label;
232 struct nfs_fattr f_attr;
233 struct nfs4_label *f_label;
234 struct dentry *dir;
235 struct dentry *dentry;
236 struct nfs4_state_owner *owner;
237 struct nfs4_state *state;
238 struct iattr attrs;
239 struct nfs4_layoutget *lgp;
240 unsigned long timestamp;
241 bool rpc_done;
242 bool file_created;
243 bool is_recover;
244 bool cancelled;
245 int rpc_status;
246};
247
Andy Adamson04fa2c62016-09-09 09:22:29 -0400248struct nfs4_add_xprt_data {
249 struct nfs_client *clp;
NeilBrowna52458b2018-12-03 11:30:31 +1100250 const struct cred *cred;
Andy Adamson04fa2c62016-09-09 09:22:29 -0400251};
252
Benny Halevy29fba382009-04-01 09:22:44 -0400253struct nfs4_state_maintenance_ops {
NeilBrowna52458b2018-12-03 11:30:31 +1100254 int (*sched_state_renewal)(struct nfs_client *, const struct cred *, unsigned);
255 const struct cred * (*get_state_renewal_cred)(struct nfs_client *);
256 int (*renew_lease)(struct nfs_client *, const struct cred *);
Benny Halevy29fba382009-04-01 09:22:44 -0400257};
258
Chuck Leverec011fe2013-10-17 14:12:39 -0400259struct nfs4_mig_recovery_ops {
Chuck Leverb03d7352013-10-17 14:12:50 -0400260 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
NeilBrowna52458b2018-12-03 11:30:31 +1100261 struct page *, const struct cred *);
262 int (*fsid_present)(struct inode *, const struct cred *);
Chuck Leverec011fe2013-10-17 14:12:39 -0400263};
264
Al Virof786aa92009-02-20 05:51:22 +0000265extern const struct dentry_operations nfs4_dentry_operations;
Bryan Schumaker73a79702012-07-16 16:39:12 -0400266
267/* dir.c */
268int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
Al Viro44907d72018-06-08 13:32:02 -0400269 unsigned, umode_t);
J. Bruce Fields6b3b5492005-06-22 17:16:22 +0000270
David Howellsf2aedb72019-12-10 07:31:13 -0500271/* fs_context.c */
bjschuma@gmail.com1ae811e2012-08-08 13:57:06 -0400272extern struct file_system_type nfs4_fs_type;
273
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400274/* nfs4namespace.c */
Al Virobeffb8f2016-07-20 16:34:42 -0400275struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
276 const struct qstr *);
David Howellsf2aedb72019-12-10 07:31:13 -0500277int nfs4_submount(struct fs_context *, struct nfs_server *);
Chuck Lever800c06a2013-10-17 14:12:34 -0400278int nfs4_replace_transport(struct nfs_server *server,
279 const struct nfs4_fs_locations *locations);
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400280
Trond Myklebust4ce79712005-06-22 17:16:21 +0000281/* nfs4proc.c */
Anna Schumakerf4ac1672014-11-25 13:18:15 -0500282extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
Olga Kornievskaia0f913a52018-07-09 15:13:33 -0400283extern int nfs4_async_handle_error(struct rpc_task *task,
284 struct nfs_server *server,
285 struct nfs4_state *state, long *timeout);
Anna Schumaker1c6dcbe2014-09-26 13:58:48 -0400286extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
287 struct rpc_message *, struct nfs4_sequence_args *,
288 struct nfs4_sequence_res *, int);
Anna Schumakerfba83f32018-05-04 16:22:50 -0400289extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int, int);
NeilBrowna52458b2018-12-03 11:30:31 +1100290extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, const struct cred *, struct nfs4_setclientid_res *);
291extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, const struct cred *);
Trond Myklebust5e6b1992013-09-07 12:58:57 -0400292extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
NeilBrowna52458b2018-12-03 11:30:31 +1100293extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, const struct cred *cred);
294extern int nfs4_proc_exchange_id(struct nfs_client *clp, const struct cred *cred);
Trond Myklebust66245532012-05-25 17:18:09 -0400295extern int nfs4_destroy_clientid(struct nfs_client *clp);
NeilBrowna52458b2018-12-03 11:30:31 +1100296extern int nfs4_init_clientid(struct nfs_client *, const struct cred *);
297extern int nfs41_init_clientid(struct nfs_client *, const struct cred *);
Trond Myklebust1f7977c2012-09-20 20:31:51 -0400298extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
Trond Myklebust55a97592006-06-09 09:34:19 -0400299extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
Bryan Schumakerf05d1472012-04-27 13:27:41 -0400300extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
301 struct nfs4_fs_locations *, struct page *);
Chuck Leverb03d7352013-10-17 14:12:50 -0400302extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
NeilBrowna52458b2018-12-03 11:30:31 +1100303 struct page *page, const struct cred *);
304extern int nfs4_proc_fsid_present(struct inode *, const struct cred *);
Al Virobeffb8f2016-07-20 16:34:42 -0400305extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, const struct qstr *,
Bryan Schumakerf05d1472012-04-27 13:27:41 -0400306 struct nfs_fh *, struct nfs_fattr *);
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400307extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
Aneesh Kumar K.V64c2ce82010-12-09 11:35:25 +0000308extern const struct xattr_handler *nfs4_xattr_handlers[];
Trond Myklebust5521abf2013-03-16 20:54:34 -0400309extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
Trond Myklebust9b206142013-03-17 15:52:00 -0400310 const struct nfs_open_context *ctx,
311 const struct nfs_lock_context *l_ctx,
312 fmode_t fmode);
Olga Kornievskaiaec4b0922019-10-08 16:33:53 -0400313extern int nfs4_proc_getattr(struct nfs_server *server, struct nfs_fh *fhandle,
314 struct nfs_fattr *fattr, struct nfs4_label *label,
315 struct inode *inode);
316extern int update_open_stateid(struct nfs4_state *state,
317 const nfs4_stateid *open_stateid,
318 const nfs4_stateid *deleg_stateid,
319 fmode_t fmode);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000320
Donald Buczek0efb01b2019-07-07 21:26:08 +0200321extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
322 struct nfs_fsinfo *fsinfo);
Andy Adamson557134a2009-04-01 09:21:53 -0400323#if defined(CONFIG_NFS_V4_1)
Andy Adamsonf9c96fc2014-01-29 11:34:38 -0500324extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
NeilBrowna52458b2018-12-03 11:30:31 +1100325extern int nfs4_proc_create_session(struct nfs_client *, const struct cred *);
326extern int nfs4_proc_destroy_session(struct nfs4_session *, const struct cred *);
Andy Adamson863a3c62011-03-23 13:27:54 +0000327extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
Andy Adamsonef311532011-03-12 02:58:10 -0500328 bool sync);
Andy Adamsonba84db92016-09-09 09:22:21 -0400329extern int nfs4_detect_session_trunking(struct nfs_client *clp,
330 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
Andy Adamson94de8b22011-03-01 01:34:12 +0000331
332static inline bool
333is_ds_only_client(struct nfs_client *clp)
334{
335 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
336 EXCHGID4_FLAG_USE_PNFS_DS;
337}
Andy Adamsond83217c2011-03-01 01:34:17 +0000338
339static inline bool
340is_ds_client(struct nfs_client *clp)
341{
342 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
343}
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400344
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400345static inline bool
346_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
347 struct rpc_clnt **clntp, struct rpc_message *msg)
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400348{
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400349 rpc_authflavor_t flavor;
350
NeilBrownb79e87e2017-08-18 17:12:52 +1000351 if (sp4_mode == NFS_SP4_MACH_CRED_CLEANUP ||
352 sp4_mode == NFS_SP4_MACH_CRED_PNFS_CLEANUP) {
353 /* Using machine creds for cleanup operations
354 * is only relevent if the client credentials
355 * might expire. So don't bother for
356 * RPC_AUTH_UNIX. If file was only exported to
357 * sec=sys, the PUTFH would fail anyway.
358 */
359 if ((*clntp)->cl_auth->au_flavor == RPC_AUTH_UNIX)
360 return false;
361 }
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400362 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
NeilBrown5e169232018-12-03 11:30:30 +1100363 msg->rpc_cred = rpc_machine_cred();
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400364
365 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
Weston Andros Adamson312cd952013-09-10 18:44:33 -0400366 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
367 flavor != RPC_AUTH_GSS_KRB5P);
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400368 *clntp = clp->cl_rpcclient;
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400369
370 return true;
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400371 }
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400372 return false;
373}
374
375/*
376 * Function responsible for determining if an rpc_message should use the
377 * machine cred under SP4_MACH_CRED and if so switching the credential and
378 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
379 * Should be called before rpc_call_sync/rpc_call_async.
380 */
381static inline void
382nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
383 struct rpc_clnt **clntp, struct rpc_message *msg)
384{
385 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
386}
387
388/*
389 * Special wrapper to nfs4_state_protect for write.
390 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
391 * that use machine cred use NFS_FILE_SYNC.
392 */
393static inline void
394nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400395 struct rpc_message *msg, struct nfs_pgio_header *hdr)
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400396{
397 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
398 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400399 hdr->args.stable = NFS_FILE_SYNC;
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400400}
Andy Adamsonfbcd4ab2009-04-01 09:22:15 -0400401#else /* CONFIG_NFS_v4_1 */
Andy Adamson94de8b22011-03-01 01:34:12 +0000402static inline bool
403is_ds_only_client(struct nfs_client *clp)
404{
405 return false;
406}
Andy Adamsond83217c2011-03-01 01:34:17 +0000407
408static inline bool
409is_ds_client(struct nfs_client *clp)
410{
411 return false;
412}
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400413
414static inline void
415nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
416 struct rpc_clnt **clntp, struct rpc_message *msg)
417{
418}
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400419
420static inline void
421nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400422 struct rpc_message *msg, struct nfs_pgio_header *hdr)
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400423{
424}
Andy Adamson557134a2009-04-01 09:21:53 -0400425#endif /* CONFIG_NFS_V4_1 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000426
Trond Myklebust97dc1352010-06-16 09:52:26 -0400427extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
Benny Halevy29fba382009-04-01 09:22:44 -0400428
Trond Myklebust1549210f2012-06-05 09:16:47 -0400429extern const u32 nfs4_fattr_bitmap[3];
David Quigleya09df2c2013-05-22 12:50:41 -0400430extern const u32 nfs4_statfs_bitmap[3];
431extern const u32 nfs4_pathconf_bitmap[3];
Fred Isamandae100c2011-07-30 20:52:37 -0400432extern const u32 nfs4_fsinfo_bitmap[3];
David Quigleya09df2c2013-05-22 12:50:41 -0400433extern const u32 nfs4_fs_locations_bitmap[3];
Trond Myklebust4ce79712005-06-22 17:16:21 +0000434
Chuck Leverabf79bb2013-08-09 12:49:11 -0400435void nfs40_shutdown_client(struct nfs_client *);
436void nfs41_shutdown_client(struct nfs_client *);
437int nfs40_init_client(struct nfs_client *);
438int nfs41_init_client(struct nfs_client *);
Bryan Schumakercdb7ece2012-06-20 15:53:45 -0400439void nfs4_free_client(struct nfs_client *);
440
Bryan Schumaker6663ee72012-06-20 15:53:46 -0400441struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
442
Trond Myklebust4ce79712005-06-22 17:16:21 +0000443/* nfs4renewd.c */
David Howellsadfa6f92006-08-22 20:06:08 -0400444extern void nfs4_schedule_state_renewal(struct nfs_client *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000445extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
David Howellsadfa6f92006-08-22 20:06:08 -0400446extern void nfs4_kill_renewd(struct nfs_client *);
David Howells65f27f32006-11-22 14:55:48 +0000447extern void nfs4_renew_state(struct work_struct *);
Trond Myklebustfb10fb62016-08-05 19:13:08 -0400448extern void nfs4_set_lease_period(struct nfs_client *clp,
449 unsigned long lease,
450 unsigned long lastrenewed);
451
Trond Myklebust4ce79712005-06-22 17:16:21 +0000452
453/* nfs4state.c */
Ben Dooksd49dd112019-10-16 17:28:21 +0100454extern const nfs4_stateid current_stateid;
455
NeilBrowna52458b2018-12-03 11:30:31 +1100456const struct cred *nfs4_get_clid_cred(struct nfs_client *clp);
457const struct cred *nfs4_get_machine_cred(struct nfs_client *clp);
458const struct cred *nfs4_get_renew_cred(struct nfs_client *clp);
Chuck Lever05f4c352012-09-14 17:24:32 -0400459int nfs4_discover_server_trunking(struct nfs_client *clp,
460 struct nfs_client **);
461int nfs40_discover_server_trunking(struct nfs_client *clp,
NeilBrowna52458b2018-12-03 11:30:31 +1100462 struct nfs_client **, const struct cred *);
Andy Adamsona7b72102009-04-01 09:22:46 -0400463#if defined(CONFIG_NFS_V4_1)
Chuck Lever05f4c352012-09-14 17:24:32 -0400464int nfs41_discover_server_trunking(struct nfs_client *clp,
NeilBrowna52458b2018-12-03 11:30:31 +1100465 struct nfs_client **, const struct cred *);
Trond Myklebust9f594792012-05-27 13:02:53 -0400466extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
Anna Schumaker3f10a6a2015-07-13 14:01:31 -0400467extern void nfs41_notify_server(struct nfs_client *);
Olga Kornievskaia04915672019-06-04 16:14:30 -0400468bool nfs4_check_serverowner_major_id(struct nfs41_server_owner *o1,
469 struct nfs41_server_owner *o2);
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500470#else
Trond Myklebust9f594792012-05-27 13:02:53 -0400471static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500472{
473}
Andy Adamsona7b72102009-04-01 09:22:46 -0400474#endif /* CONFIG_NFS_V4_1 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000475
NeilBrowna52458b2018-12-03 11:30:31 +1100476extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, const struct cred *, gfp_t);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000477extern void nfs4_put_state_owner(struct nfs4_state_owner *);
Trond Myklebustc77e2282019-08-03 10:11:27 -0400478extern void nfs4_purge_state_owners(struct nfs_server *, struct list_head *);
479extern void nfs4_free_state_owners(struct list_head *head);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000480extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
481extern void nfs4_put_open_state(struct nfs4_state *);
Al Viro643168c2011-06-22 18:20:23 -0400482extern void nfs4_close_state(struct nfs4_state *, fmode_t);
483extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500484extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500485extern void nfs_inode_find_state_and_recover(struct inode *inode,
486 const nfs4_stateid *stateid);
Trond Myklebust4f14c192014-02-12 19:15:06 -0500487extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500488extern void nfs4_schedule_lease_recovery(struct nfs_client *);
Trond Myklebust33021272012-11-26 13:13:29 -0500489extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
490extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
Trond Myklebustb0d3ded2008-12-23 15:21:50 -0500491extern void nfs4_schedule_state_manager(struct nfs_client *);
Trond Myklebust042b60b2011-08-24 15:07:37 -0400492extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
Trond Myklebust5d422302013-03-14 16:57:48 -0400493extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
Chuck Leverc9fdeb22013-10-17 14:13:02 -0400494extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
Chuck Leverb7f7a662013-10-17 14:13:35 -0400495extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
Trond Myklebust0a014a42016-09-22 13:38:51 -0400496extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
Weston Andros Adamson78fe0f42011-05-31 19:05:47 -0400497extern void nfs41_handle_server_scope(struct nfs_client *,
Chuck Lever79d4e1f2012-05-21 22:44:31 -0400498 struct nfs41_server_scope **);
Trond Myklebustfaf5f492005-10-18 14:20:15 -0700499extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000500extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
Trond Myklebustabf4e132016-05-16 17:42:44 -0400501extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
NeilBrown17393472016-10-13 15:26:47 +1100502 const struct nfs_lock_context *, nfs4_stateid *,
NeilBrowna52458b2018-12-03 11:30:31 +1100503 const struct cred **);
Trond Myklebustc82bac62017-11-06 15:28:06 -0500504extern bool nfs4_copy_open_stateid(nfs4_stateid *dst,
505 struct nfs4_state *state);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000506
Trond Myklebust8535b2b2010-05-13 12:51:01 -0400507extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700508extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
509extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
510extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
Trond Myklebust72211db2009-12-15 14:47:36 -0500511extern void nfs_release_seqid(struct nfs_seqid *seqid);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700512extern void nfs_free_seqid(struct nfs_seqid *seqid);
Trond Myklebust3be0f80b2017-10-19 15:46:45 -0400513extern int nfs4_setup_sequence(struct nfs_client *client,
Peng Taocb04ad22014-06-11 05:24:15 +0800514 struct nfs4_sequence_args *args,
515 struct nfs4_sequence_res *res,
516 struct rpc_task *task);
Peng Tao2c4b1312014-06-11 05:24:16 +0800517extern int nfs4_sequence_done(struct rpc_task *task,
518 struct nfs4_sequence_res *res);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700519
Trond Myklebust5ae67c42012-03-19 16:17:18 -0400520extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
Olga Kornievskaia6b8d84e2018-07-09 15:13:36 -0400521extern int nfs4_proc_commit(struct file *dst, __u64 offset, __u32 count, struct nfs_commitres *res);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000522extern const nfs4_stateid zero_stateid;
Trond Myklebustfcd88432017-11-07 12:39:44 -0500523extern const nfs4_stateid invalid_stateid;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000524
Bryan Schumaker129d1972012-07-16 16:39:13 -0400525/* nfs4super.c */
Bryan Schumakerfbdefd62012-07-16 16:39:20 -0400526struct nfs_mount_info;
Bryan Schumakerab7017a2012-07-30 16:05:16 -0400527extern struct nfs_subversion nfs_v4;
Bryan Schumakerfac1e8e2012-07-30 16:05:22 -0400528extern bool nfs4_disable_idmapping;
529extern unsigned short max_session_slots;
Trond Myklebust5405fc42016-08-29 20:03:52 -0400530extern unsigned short max_session_cb_slots;
Bryan Schumakerfac1e8e2012-07-30 16:05:22 -0400531extern unsigned short send_implementation_id;
Trond Myklebustf6de7a32013-09-04 10:08:54 -0400532extern bool recover_lost_locks;
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400533
Chuck Lever6f2ea7f2012-09-14 17:24:41 -0400534#define NFS4_CLIENT_ID_UNIQ_LEN (64)
535extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
536
David Howellsf2aedb72019-12-10 07:31:13 -0500537extern int nfs4_try_get_tree(struct fs_context *);
538extern int nfs4_get_referral_tree(struct fs_context *);
539
Bryan Schumaker466bfe72012-07-16 16:39:14 -0400540/* nfs4sysctl.c */
541#ifdef CONFIG_SYSCTL
542int nfs4_register_sysctl(void);
543void nfs4_unregister_sysctl(void);
544#else
545static inline int nfs4_register_sysctl(void)
546{
547 return 0;
548}
549
Randy Dunlap0add3e82012-07-27 11:49:26 -0700550static inline void nfs4_unregister_sysctl(void)
Bryan Schumaker466bfe72012-07-16 16:39:14 -0400551{
552}
553#endif
554
Trond Myklebust4ce79712005-06-22 17:16:21 +0000555/* nfs4xdr.c */
Christoph Hellwig499b4982017-05-12 15:36:49 +0200556extern const struct rpc_procinfo nfs4_procedures[];
Trond Myklebust4ce79712005-06-22 17:16:21 +0000557
558struct nfs4_mount_data;
559
560/* callback_xdr.c */
Christoph Hellwige9679182017-05-12 16:21:37 +0200561extern const struct svc_version nfs4_callback_version1;
562extern const struct svc_version nfs4_callback_version4;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000563
Trond Myklebustf597c532012-03-04 18:13:56 -0500564static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
565{
Trond Myklebust93b717f2016-05-16 17:42:43 -0400566 memcpy(dst->data, src->data, sizeof(dst->data));
567 dst->type = src->type;
Trond Myklebustf597c532012-03-04 18:13:56 -0500568}
569
570static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
571{
Trond Myklebust93b717f2016-05-16 17:42:43 -0400572 if (dst->type != src->type)
573 return false;
574 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
Trond Myklebustf597c532012-03-04 18:13:56 -0500575}
576
Trond Myklebuste999e802014-02-10 18:20:47 -0500577static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
578{
579 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
580}
581
582static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
583{
584 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
585}
586
Trond Myklebust42c304c2019-10-26 10:16:15 -0400587static inline bool nfs4_stateid_match_or_older(const nfs4_stateid *dst, const nfs4_stateid *src)
588{
589 return nfs4_stateid_match_other(dst, src) &&
590 !(src->seqid && nfs4_stateid_is_newer(dst, src));
591}
592
Trond Myklebust92283952019-09-20 07:23:44 -0400593static inline void nfs4_stateid_seqid_inc(nfs4_stateid *s1)
594{
595 u32 seqid = be32_to_cpu(s1->seqid);
596
597 if (++seqid == 0)
598 ++seqid;
599 s1->seqid = cpu_to_be32(seqid);
600}
601
Trond Myklebust5d422302013-03-14 16:57:48 -0400602static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
603{
604 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
605}
606
Trond Myklebust3e7dfb12016-11-14 11:19:55 -0500607static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
608 const nfs4_stateid *stateid)
609{
610 return test_bit(NFS_OPEN_STATE, &state->flags) &&
611 nfs4_stateid_match_other(&state->open_stateid, stateid);
612}
613
Trond Myklebust4ce79712005-06-22 17:16:21 +0000614#else
615
Al Viro643168c2011-06-22 18:20:23 -0400616#define nfs4_close_state(a, b) do { } while (0)
617#define nfs4_close_sync(a, b) do { } while (0)
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400618#define nfs4_state_protect(a, b, c, d) do { } while (0)
619#define nfs4_state_protect_write(a, b, c, d) do { } while (0)
Trond Myklebust4ce79712005-06-22 17:16:21 +0000620
621#endif /* CONFIG_NFS_V4 */
622#endif /* __LINUX_FS_NFS_NFS4_FS.H */