blob: 66516583366069dd85d10d0fd9b0e826ce33268f [file] [log] [blame]
Trond Myklebust4ce79712005-06-22 17:16:21 +00001/*
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
Anna Schumaker694e0962013-11-13 12:29:08 -050012#if defined(CONFIG_NFS_V4_2)
13#define NFS4_MAX_MINOR_VERSION 2
14#elif defined(CONFIG_NFS_V4_1)
15#define NFS4_MAX_MINOR_VERSION 1
16#else
17#define NFS4_MAX_MINOR_VERSION 0
18#endif
19
Bryan Schumaker89d77c82012-07-30 16:05:25 -040020#if IS_ENABLED(CONFIG_NFS_V4)
Trond Myklebust4ce79712005-06-22 17:16:21 +000021
Trond Myklebust33021272012-11-26 13:13:29 -050022#define NFS4_MAX_LOOP_ON_RECOVER (10)
23
Trond Myklebustc137afa2013-02-07 14:41:11 -050024#include <linux/seqlock.h>
25
Trond Myklebust4ce79712005-06-22 17:16:21 +000026struct idmap;
27
Trond Myklebust4ce79712005-06-22 17:16:21 +000028enum nfs4_client_state {
Trond Myklebuste005e802008-12-23 15:21:48 -050029 NFS4CLNT_MANAGER_RUNNING = 0,
Trond Myklebuste598d842008-12-23 15:21:42 -050030 NFS4CLNT_CHECK_LEASE,
Trond Myklebust58d97142006-01-03 09:55:24 +010031 NFS4CLNT_LEASE_EXPIRED,
Trond Myklebustb79a4a12008-12-23 15:21:41 -050032 NFS4CLNT_RECLAIM_REBOOT,
33 NFS4CLNT_RECLAIM_NOGRACE,
Trond Myklebust707fb4b2008-12-23 15:21:47 -050034 NFS4CLNT_DELEGRETURN,
Andy Adamson6df08182009-12-04 15:55:05 -050035 NFS4CLNT_SESSION_RESET,
Trond Myklebustfd954ae2011-04-24 14:28:18 -040036 NFS4CLNT_LEASE_CONFIRM,
Weston Andros Adamson78fe0f42011-05-31 19:05:47 -040037 NFS4CLNT_SERVER_SCOPE_MISMATCH,
Chuck Lever2c820d92012-05-21 22:45:33 -040038 NFS4CLNT_PURGE_STATE,
Weston Andros Adamsona9e64442012-05-24 12:26:37 -040039 NFS4CLNT_BIND_CONN_TO_SESSION,
Chuck Leverc9fdeb22013-10-17 14:13:02 -040040 NFS4CLNT_MOVED,
Chuck Leverb7f7a662013-10-17 14:13:35 -040041 NFS4CLNT_LEASE_MOVED,
Trond Myklebust45870d62016-09-22 13:38:59 -040042 NFS4CLNT_DELEGATION_EXPIRED,
Trond Myklebust4ce79712005-06-22 17:16:21 +000043};
44
Trond Myklebust2f60ea62011-08-24 15:07:37 -040045#define NFS4_RENEW_TIMEOUT 0x01
46#define NFS4_RENEW_DELEGATION_CB 0x02
47
Trond Myklebust63f5f792015-01-23 19:19:25 -050048struct nfs_seqid_counter;
Trond Myklebust97dc1352010-06-16 09:52:26 -040049struct nfs4_minor_version_ops {
50 u32 minor_version;
Trond Myklebust39c6daa2013-03-15 16:11:57 -040051 unsigned init_caps;
Trond Myklebust97dc1352010-06-16 09:52:26 -040052
Chuck Leverabf79bb2013-08-09 12:49:11 -040053 int (*init_client)(struct nfs_client *);
54 void (*shutdown_client)(struct nfs_client *);
Trond Myklebust36281ca2012-03-04 18:13:56 -050055 bool (*match_stateid)(const nfs4_stateid *,
Trond Myklebuste047a102010-06-16 09:52:27 -040056 const nfs4_stateid *);
Bryan Schumakerfca78d62011-06-02 14:59:07 -040057 int (*find_root_sec)(struct nfs_server *, struct nfs_fh *,
58 struct nfs_fsinfo *);
Jeff Laytonf1cdae82014-05-01 06:28:47 -040059 void (*free_lock_state)(struct nfs_server *,
Trond Myklebustc8b2d0b2013-05-03 16:22:55 -040060 struct nfs4_lock_state *);
Trond Myklebust45870d62016-09-22 13:38:59 -040061 int (*test_and_free_expired)(struct nfs_server *,
62 nfs4_stateid *, struct rpc_cred *);
Trond Myklebust63f5f792015-01-23 19:19:25 -050063 struct nfs_seqid *
64 (*alloc_seqid)(struct nfs_seqid_counter *, gfp_t);
Andy Adamson04fa2c62016-09-09 09:22:29 -040065 int (*session_trunk)(struct rpc_clnt *, struct rpc_xprt *, void *);
Chuck Lever9915ea72013-08-09 12:48:27 -040066 const struct rpc_call_ops *call_sync_ops;
Trond Myklebustc48f4f32010-06-16 09:52:27 -040067 const struct nfs4_state_recovery_ops *reboot_recovery_ops;
68 const struct nfs4_state_recovery_ops *nograce_recovery_ops;
69 const struct nfs4_state_maintenance_ops *state_renewal_ops;
Chuck Leverec011fe2013-10-17 14:12:39 -040070 const struct nfs4_mig_recovery_ops *mig_recovery_ops;
Trond Myklebust97dc1352010-06-16 09:52:26 -040071};
72
Trond Myklebustcee54fc2005-10-18 14:20:12 -070073#define NFS_SEQID_CONFIRMED 1
74struct nfs_seqid_counter {
Trond Myklebust95b72eb2012-04-20 19:24:51 -040075 ktime_t create_time;
Trond Myklebust48c22eb2012-01-17 22:04:25 -050076 int owner_id;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070077 int flags;
78 u32 counter;
Trond Myklebust7ba127a2012-01-17 22:04:25 -050079 spinlock_t lock; /* Protects the list */
80 struct list_head list; /* Defines sequence of RPC calls */
81 struct rpc_wait_queue wait; /* RPC call delay queue */
Trond Myklebustcee54fc2005-10-18 14:20:12 -070082};
83
84struct nfs_seqid {
Trond Myklebustcee54fc2005-10-18 14:20:12 -070085 struct nfs_seqid_counter *sequence;
Trond Myklebust4e513362005-10-20 14:22:41 -070086 struct list_head list;
Trond Myklebust4601df22012-01-20 18:47:05 -050087 struct rpc_task *task;
Trond Myklebustcee54fc2005-10-18 14:20:12 -070088};
89
90static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
91{
92 if (seqid_mutating_err(-status))
93 seqid->flags |= NFS_SEQID_CONFIRMED;
94}
95
96/*
Trond Myklebust4ce79712005-06-22 17:16:21 +000097 * NFS4 state_owners and lock_owners are simply labels for ordered
98 * sequences of RPC calls. Their sole purpose is to provide once-only
99 * semantics by allowing the server to identify replayed requests.
Trond Myklebust4ce79712005-06-22 17:16:21 +0000100 */
101struct nfs4_state_owner {
Trond Myklebust6f2e64d2007-07-06 10:53:21 -0400102 struct nfs_server *so_server;
Chuck Lever0aaaf5c2011-12-06 16:13:48 -0500103 struct list_head so_lru;
104 unsigned long so_expires;
Chuck Lever24d292b2010-12-24 01:32:43 +0000105 struct rb_node so_server_node;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000106
107 struct rpc_cred *so_cred; /* Associated cred */
Trond Myklebust9f958ab2007-07-02 13:58:33 -0400108
109 spinlock_t so_lock;
110 atomic_t so_count;
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500111 unsigned long so_flags;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000112 struct list_head so_states;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700113 struct nfs_seqid_counter so_seqid;
Trond Myklebustc137afa2013-02-07 14:41:11 -0500114 seqcount_t so_reclaim_seqcount;
Trond Myklebust65b62a22013-02-07 10:54:07 -0500115 struct mutex so_delegreturn_mutex;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000116};
117
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500118enum {
119 NFS_OWNER_RECLAIM_REBOOT,
120 NFS_OWNER_RECLAIM_NOGRACE
121};
122
Alexandros Batsakisafe6c272009-12-09 01:50:14 -0800123#define NFS_LOCK_NEW 0
124#define NFS_LOCK_RECLAIM 1
125#define NFS_LOCK_EXPIRED 2
126
Trond Myklebust4ce79712005-06-22 17:16:21 +0000127/*
128 * struct nfs4_state maintains the client-side state for a given
129 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
130 *
131 * OPEN:
132 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
133 * we need to know how many files are open for reading or writing on a
134 * given inode. This information too is stored here.
135 *
136 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
137 */
138
139struct nfs4_lock_state {
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400140 struct list_head ls_locks; /* Other lock stateids */
141 struct nfs4_state * ls_state; /* Pointer to open state */
Trond Myklebust795a88c2012-09-10 13:26:49 -0400142#define NFS_LOCK_INITIALIZED 0
NeilBrownef1820f2013-09-04 17:04:49 +1000143#define NFS_LOCK_LOST 1
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400144 unsigned long ls_flags;
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700145 struct nfs_seqid_counter ls_seqid;
Jeff Layton0c0e0d32014-09-08 08:26:01 -0400146 nfs4_stateid ls_stateid;
147 atomic_t ls_count;
148 fl_owner_t ls_owner;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000149};
150
151/* bits for nfs4_state->flags */
152enum {
153 LK_STATE_IN_USE,
Trond Myklebust003707c2007-07-05 18:07:55 -0400154 NFS_DELEGATED_STATE, /* Current stateid is delegation */
Trond Myklebust92b40e92013-04-20 01:25:45 -0400155 NFS_OPEN_STATE, /* OPEN stateid is set */
Trond Myklebust003707c2007-07-05 18:07:55 -0400156 NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
157 NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
158 NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
Trond Myklebustb79a4a12008-12-23 15:21:41 -0500159 NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
160 NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
Trond Myklebust8e469eb2010-01-26 15:42:30 -0500161 NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
Trond Myklebust5d422302013-03-14 16:57:48 -0400162 NFS_STATE_RECOVERY_FAILED, /* OPEN stateid state recovery failed */
Jeff Laytona8ce3772016-09-17 18:17:35 -0400163 NFS_STATE_MAY_NOTIFY_LOCK, /* server may CB_NOTIFY_LOCK */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000164};
165
166struct nfs4_state {
167 struct list_head open_states; /* List of states for the same state_owner */
168 struct list_head inode_states; /* List of states for the same inode */
169 struct list_head lock_states; /* List of subservient lock stateids */
170
171 struct nfs4_state_owner *owner; /* Pointer to the open owner */
172 struct inode *inode; /* Pointer to the inode */
173
174 unsigned long flags; /* Do we hold any locks? */
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000175 spinlock_t state_lock; /* Protects the lock_states list */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000176
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400177 seqlock_t seqlock; /* Protects the stateid/open_stateid */
Trond Myklebust003707c2007-07-05 18:07:55 -0400178 nfs4_stateid stateid; /* Current stateid: may be delegation */
179 nfs4_stateid open_stateid; /* OPEN stateid */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000180
Trond Myklebust8bda4e42007-07-09 10:45:42 -0400181 /* The following 3 fields are protected by owner->so_lock */
Trond Myklebust003707c2007-07-05 18:07:55 -0400182 unsigned int n_rdonly; /* Number of read-only references */
183 unsigned int n_wronly; /* Number of write-only references */
184 unsigned int n_rdwr; /* Number of read/write references */
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500185 fmode_t state; /* State on the server (R,W, or RW) */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000186 atomic_t count;
187};
188
189
190struct nfs4_exception {
Trond Myklebust9e33bed2008-12-23 15:21:46 -0500191 struct nfs4_state *state;
Trond Myklebust3114ea72012-03-07 16:39:06 -0500192 struct inode *inode;
Trond Myklebust8487c472016-06-26 08:44:35 -0400193 nfs4_stateid *stateid;
Trond Myklebustb3c2aa02015-09-20 14:32:45 -0400194 long timeout;
195 unsigned char delay : 1,
196 recovering : 1,
197 retry : 1;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000198};
199
200struct nfs4_state_recovery_ops {
Trond Myklebust7eff03a2008-12-23 15:21:43 -0500201 int owner_flag_bit;
Trond Myklebustb79a4a12008-12-23 15:21:41 -0500202 int state_flag_bit;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000203 int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
204 int (*recover_lock)(struct nfs4_state *, struct file_lock *);
Andy Adamson591d71c2009-04-01 09:22:47 -0400205 int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
Trond Myklebust965e9c22013-05-20 11:05:17 -0400206 int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
Chuck Lever05f4c352012-09-14 17:24:32 -0400207 int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
208 struct rpc_cred *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000209};
210
Andy Adamson04fa2c62016-09-09 09:22:29 -0400211struct nfs4_add_xprt_data {
212 struct nfs_client *clp;
213 struct rpc_cred *cred;
214};
215
Benny Halevy29fba382009-04-01 09:22:44 -0400216struct nfs4_state_maintenance_ops {
Trond Myklebust2f60ea62011-08-24 15:07:37 -0400217 int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
Andy Adamsona7b72102009-04-01 09:22:46 -0400218 struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
Benny Halevy8e69514f2009-04-01 09:22:45 -0400219 int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
Benny Halevy29fba382009-04-01 09:22:44 -0400220};
221
Chuck Leverec011fe2013-10-17 14:12:39 -0400222struct nfs4_mig_recovery_ops {
Chuck Leverb03d7352013-10-17 14:12:50 -0400223 int (*get_locations)(struct inode *, struct nfs4_fs_locations *,
224 struct page *, struct rpc_cred *);
Chuck Lever44c99932013-10-17 14:13:30 -0400225 int (*fsid_present)(struct inode *, struct rpc_cred *);
Chuck Leverec011fe2013-10-17 14:12:39 -0400226};
227
Al Virof786aa92009-02-20 05:51:22 +0000228extern const struct dentry_operations nfs4_dentry_operations;
Bryan Schumaker73a79702012-07-16 16:39:12 -0400229
230/* dir.c */
231int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
232 unsigned, umode_t, int *);
J. Bruce Fields6b3b5492005-06-22 17:16:22 +0000233
bjschuma@gmail.com1ae811e2012-08-08 13:57:06 -0400234/* super.c */
235extern struct file_system_type nfs4_fs_type;
236
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400237/* nfs4namespace.c */
Al Virobeffb8f2016-07-20 16:34:42 -0400238struct rpc_clnt *nfs4_negotiate_security(struct rpc_clnt *, struct inode *,
239 const struct qstr *);
Bryan Schumaker281cad42012-04-27 13:27:45 -0400240struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
241 struct nfs_fh *, struct nfs_fattr *);
Chuck Lever800c06a2013-10-17 14:12:34 -0400242int nfs4_replace_transport(struct nfs_server *server,
243 const struct nfs4_fs_locations *locations);
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400244
Trond Myklebust4ce79712005-06-22 17:16:21 +0000245/* nfs4proc.c */
Anna Schumakerf4ac1672014-11-25 13:18:15 -0500246extern int nfs4_handle_exception(struct nfs_server *, int, struct nfs4_exception *);
Anna Schumaker1c6dcbe2014-09-26 13:58:48 -0400247extern int nfs4_call_sync(struct rpc_clnt *, struct nfs_server *,
248 struct rpc_message *, struct nfs4_sequence_args *,
249 struct nfs4_sequence_res *, int);
Trond Myklebustbe3a5d22015-06-23 19:51:55 +0800250extern void nfs4_init_sequence(struct nfs4_sequence_args *, struct nfs4_sequence_res *, int);
Trond Myklebustbb8b27e2010-04-16 16:43:06 -0400251extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
252extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
Trond Myklebust5e6b1992013-09-07 12:58:57 -0400253extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *, bool);
Trond Myklebust2cf047c2012-05-25 17:57:41 -0400254extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
Andy Adamson4d643d12009-12-04 15:52:24 -0500255extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
Trond Myklebust66245532012-05-25 17:18:09 -0400256extern int nfs4_destroy_clientid(struct nfs_client *clp);
Andy Adamson591d71c2009-04-01 09:22:47 -0400257extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
Andy Adamson4d643d12009-12-04 15:52:24 -0500258extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
Trond Myklebust1f7977c2012-09-20 20:31:51 -0400259extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
Trond Myklebust55a97592006-06-09 09:34:19 -0400260extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
Bryan Schumakerf05d1472012-04-27 13:27:41 -0400261extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
262 struct nfs4_fs_locations *, struct page *);
Chuck Leverb03d7352013-10-17 14:12:50 -0400263extern int nfs4_proc_get_locations(struct inode *, struct nfs4_fs_locations *,
264 struct page *page, struct rpc_cred *);
Chuck Lever44c99932013-10-17 14:13:30 -0400265extern int nfs4_proc_fsid_present(struct inode *, struct rpc_cred *);
Al Virobeffb8f2016-07-20 16:34:42 -0400266extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, const struct qstr *,
Bryan Schumakerf05d1472012-04-27 13:27:41 -0400267 struct nfs_fh *, struct nfs_fattr *);
Bryan Schumaker72de53e2012-04-27 13:27:40 -0400268extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
Aneesh Kumar K.V64c2ce82010-12-09 11:35:25 +0000269extern const struct xattr_handler *nfs4_xattr_handlers[];
Trond Myklebust5521abf2013-03-16 20:54:34 -0400270extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
Trond Myklebust9b206142013-03-17 15:52:00 -0400271 const struct nfs_open_context *ctx,
272 const struct nfs_lock_context *l_ctx,
273 fmode_t fmode);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000274
Andy Adamson557134a2009-04-01 09:21:53 -0400275#if defined(CONFIG_NFS_V4_1)
Trond Myklebust035168a2010-06-16 09:52:26 -0400276static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
277{
278 return server->nfs_client->cl_session;
279}
280
Andy Adamsondc70d7b2011-03-01 01:34:19 +0000281extern int nfs41_setup_sequence(struct nfs4_session *session,
282 struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
Trond Myklebust9d12b212012-01-17 22:04:25 -0500283 struct rpc_task *task);
Andy Adamsonf9c96fc2014-01-29 11:34:38 -0500284extern int nfs41_sequence_done(struct rpc_task *, struct nfs4_sequence_res *);
Trond Myklebust848f5bd2012-05-25 17:51:23 -0400285extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
286extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
Ricardo Labiaga9430fb62009-12-06 12:23:46 -0500287extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
288 struct nfs_fsinfo *fsinfo);
Andy Adamson863a3c62011-03-23 13:27:54 +0000289extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
Andy Adamsonef311532011-03-12 02:58:10 -0500290 bool sync);
Andy Adamsonba84db92016-09-09 09:22:21 -0400291extern int nfs4_detect_session_trunking(struct nfs_client *clp,
292 struct nfs41_exchange_id_res *res, struct rpc_xprt *xprt);
Andy Adamson94de8b22011-03-01 01:34:12 +0000293
294static inline bool
295is_ds_only_client(struct nfs_client *clp)
296{
297 return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
298 EXCHGID4_FLAG_USE_PNFS_DS;
299}
Andy Adamsond83217c2011-03-01 01:34:17 +0000300
301static inline bool
302is_ds_client(struct nfs_client *clp)
303{
304 return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
305}
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400306
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400307static inline bool
308_nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
309 struct rpc_clnt **clntp, struct rpc_message *msg)
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400310{
311 struct rpc_cred *newcred = NULL;
312 rpc_authflavor_t flavor;
313
314 if (test_bit(sp4_mode, &clp->cl_sp4_flags)) {
315 spin_lock(&clp->cl_lock);
316 if (clp->cl_machine_cred != NULL)
Weston Andros Adamsonade33ff2013-09-10 18:44:32 -0400317 /* don't call get_rpccred on the machine cred -
318 * a reference will be held for life of clp */
319 newcred = clp->cl_machine_cred;
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400320 spin_unlock(&clp->cl_lock);
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400321 msg->rpc_cred = newcred;
322
323 flavor = clp->cl_rpcclient->cl_auth->au_flavor;
Weston Andros Adamson312cd952013-09-10 18:44:33 -0400324 WARN_ON_ONCE(flavor != RPC_AUTH_GSS_KRB5I &&
325 flavor != RPC_AUTH_GSS_KRB5P);
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400326 *clntp = clp->cl_rpcclient;
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400327
328 return true;
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400329 }
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400330 return false;
331}
332
333/*
334 * Function responsible for determining if an rpc_message should use the
335 * machine cred under SP4_MACH_CRED and if so switching the credential and
336 * authflavor (using the nfs_client's rpc_clnt which will be krb5i/p).
337 * Should be called before rpc_call_sync/rpc_call_async.
338 */
339static inline void
340nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_mode,
341 struct rpc_clnt **clntp, struct rpc_message *msg)
342{
343 _nfs4_state_protect(clp, sp4_mode, clntp, msg);
344}
345
346/*
347 * Special wrapper to nfs4_state_protect for write.
348 * If WRITE can use machine cred but COMMIT cannot, make sure all writes
349 * that use machine cred use NFS_FILE_SYNC.
350 */
351static inline void
352nfs4_state_protect_write(struct nfs_client *clp, struct rpc_clnt **clntp,
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400353 struct rpc_message *msg, struct nfs_pgio_header *hdr)
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400354{
355 if (_nfs4_state_protect(clp, NFS_SP4_MACH_CRED_WRITE, clntp, msg) &&
356 !test_bit(NFS_SP4_MACH_CRED_COMMIT, &clp->cl_sp4_flags))
Weston Andros Adamsond45f60c2014-06-09 11:48:35 -0400357 hdr->args.stable = NFS_FILE_SYNC;
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400358}
Andy Adamsonfbcd4ab2009-04-01 09:22:15 -0400359#else /* CONFIG_NFS_v4_1 */
Trond Myklebust035168a2010-06-16 09:52:26 -0400360static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
361{
362 return NULL;
363}
364
Andy Adamson94de8b22011-03-01 01:34:12 +0000365static inline bool
366is_ds_only_client(struct nfs_client *clp)
367{
368 return false;
369}
Andy Adamsond83217c2011-03-01 01:34:17 +0000370
371static inline bool
372is_ds_client(struct nfs_client *clp)
373{
374 return false;
375}
Weston Andros Adamsonab4c2362013-08-13 16:37:33 -0400376
377static inline void
378nfs4_state_protect(struct nfs_client *clp, unsigned long sp4_flags,
379 struct rpc_clnt **clntp, struct rpc_message *msg)
380{
381}
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400382
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}
Andy Adamson557134a2009-04-01 09:21:53 -0400388#endif /* CONFIG_NFS_V4_1 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000389
Trond Myklebust97dc1352010-06-16 09:52:26 -0400390extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
Benny Halevy29fba382009-04-01 09:22:44 -0400391
Trond Myklebust1549210f2012-06-05 09:16:47 -0400392extern const u32 nfs4_fattr_bitmap[3];
David Quigleya09df2c2013-05-22 12:50:41 -0400393extern const u32 nfs4_statfs_bitmap[3];
394extern const u32 nfs4_pathconf_bitmap[3];
Fred Isamandae100c2011-07-30 20:52:37 -0400395extern const u32 nfs4_fsinfo_bitmap[3];
David Quigleya09df2c2013-05-22 12:50:41 -0400396extern const u32 nfs4_fs_locations_bitmap[3];
Trond Myklebust4ce79712005-06-22 17:16:21 +0000397
Chuck Leverabf79bb2013-08-09 12:49:11 -0400398void nfs40_shutdown_client(struct nfs_client *);
399void nfs41_shutdown_client(struct nfs_client *);
400int nfs40_init_client(struct nfs_client *);
401int nfs41_init_client(struct nfs_client *);
Bryan Schumakercdb7ece2012-06-20 15:53:45 -0400402void nfs4_free_client(struct nfs_client *);
403
Bryan Schumaker6663ee72012-06-20 15:53:46 -0400404struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);
405
Trond Myklebust4ce79712005-06-22 17:16:21 +0000406/* nfs4renewd.c */
David Howellsadfa6f92006-08-22 20:06:08 -0400407extern void nfs4_schedule_state_renewal(struct nfs_client *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000408extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
David Howellsadfa6f92006-08-22 20:06:08 -0400409extern void nfs4_kill_renewd(struct nfs_client *);
David Howells65f27f32006-11-22 14:55:48 +0000410extern void nfs4_renew_state(struct work_struct *);
Trond Myklebustfb10fb62016-08-05 19:13:08 -0400411extern void nfs4_set_lease_period(struct nfs_client *clp,
412 unsigned long lease,
413 unsigned long lastrenewed);
414
Trond Myklebust4ce79712005-06-22 17:16:21 +0000415
416/* nfs4state.c */
Chuck Lever73d8bde2013-07-24 12:28:37 -0400417struct rpc_cred *nfs4_get_clid_cred(struct nfs_client *clp);
Trond Myklebustfe20d7d2012-11-21 22:49:36 -0500418struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
Trond Myklebust6dc9d572008-12-23 15:21:41 -0500419struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
Chuck Lever05f4c352012-09-14 17:24:32 -0400420int nfs4_discover_server_trunking(struct nfs_client *clp,
421 struct nfs_client **);
422int nfs40_discover_server_trunking(struct nfs_client *clp,
423 struct nfs_client **, struct rpc_cred *);
Andy Adamsona7b72102009-04-01 09:22:46 -0400424#if defined(CONFIG_NFS_V4_1)
Chuck Lever05f4c352012-09-14 17:24:32 -0400425int nfs41_discover_server_trunking(struct nfs_client *clp,
426 struct nfs_client **, struct rpc_cred *);
Trond Myklebust9f594792012-05-27 13:02:53 -0400427extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
Anna Schumaker3f10a6a2015-07-13 14:01:31 -0400428extern void nfs41_notify_server(struct nfs_client *);
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500429#else
Trond Myklebust9f594792012-05-27 13:02:53 -0400430static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500431{
432}
Andy Adamsona7b72102009-04-01 09:22:46 -0400433#endif /* CONFIG_NFS_V4_1 */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000434
Trond Myklebustd1e284d2012-01-17 22:04:24 -0500435extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000436extern void nfs4_put_state_owner(struct nfs4_state_owner *);
Chuck Lever0aaaf5c2011-12-06 16:13:48 -0500437extern void nfs4_purge_state_owners(struct nfs_server *);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000438extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
439extern void nfs4_put_open_state(struct nfs4_state *);
Al Viro643168c2011-06-22 18:20:23 -0400440extern void nfs4_close_state(struct nfs4_state *, fmode_t);
441extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
Trond Myklebustdc0b0272008-12-23 15:21:56 -0500442extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
Trond Myklebusta1d0b5e2012-03-05 19:56:44 -0500443extern void nfs_inode_find_state_and_recover(struct inode *inode,
444 const nfs4_stateid *stateid);
Trond Myklebust4f14c192014-02-12 19:15:06 -0500445extern int nfs4_state_mark_reclaim_nograce(struct nfs_client *, struct nfs4_state *);
Trond Myklebust0400a6b2011-03-09 16:00:53 -0500446extern void nfs4_schedule_lease_recovery(struct nfs_client *);
Trond Myklebust33021272012-11-26 13:13:29 -0500447extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
448extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
Trond Myklebustb0d3ded2008-12-23 15:21:50 -0500449extern void nfs4_schedule_state_manager(struct nfs_client *);
Trond Myklebust042b60b2011-08-24 15:07:37 -0400450extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
Trond Myklebust5d422302013-03-14 16:57:48 -0400451extern int nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
Chuck Leverc9fdeb22013-10-17 14:13:02 -0400452extern int nfs4_schedule_migration_recovery(const struct nfs_server *);
Chuck Leverb7f7a662013-10-17 14:13:35 -0400453extern void nfs4_schedule_lease_moved_recovery(struct nfs_client *);
Trond Myklebust0a014a42016-09-22 13:38:51 -0400454extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags, bool);
Weston Andros Adamson78fe0f42011-05-31 19:05:47 -0400455extern void nfs41_handle_server_scope(struct nfs_client *,
Chuck Lever79d4e1f2012-05-21 22:44:31 -0400456 struct nfs41_server_scope **);
Trond Myklebustfaf5f492005-10-18 14:20:15 -0700457extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
Trond Myklebust8d0a8a92005-06-22 17:16:32 +0000458extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
Trond Myklebustabf4e132016-05-16 17:42:44 -0400459extern int nfs4_select_rw_stateid(struct nfs4_state *, fmode_t,
NeilBrown17393472016-10-13 15:26:47 +1100460 const struct nfs_lock_context *, nfs4_stateid *,
Trond Myklebustabf4e132016-05-16 17:42:44 -0400461 struct rpc_cred **);
Trond Myklebust4ce79712005-06-22 17:16:21 +0000462
Trond Myklebust8535b2b2010-05-13 12:51:01 -0400463extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700464extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
465extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
466extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
Trond Myklebust72211db2009-12-15 14:47:36 -0500467extern void nfs_release_seqid(struct nfs_seqid *seqid);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700468extern void nfs_free_seqid(struct nfs_seqid *seqid);
Peng Taocb04ad22014-06-11 05:24:15 +0800469extern int nfs40_setup_sequence(struct nfs4_slot_table *tbl,
470 struct nfs4_sequence_args *args,
471 struct nfs4_sequence_res *res,
472 struct rpc_task *task);
Peng Tao2c4b1312014-06-11 05:24:16 +0800473extern int nfs4_sequence_done(struct rpc_task *task,
474 struct nfs4_sequence_res *res);
Trond Myklebustcee54fc2005-10-18 14:20:12 -0700475
Trond Myklebust5ae67c42012-03-19 16:17:18 -0400476extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
Trond Myklebustcf470c32012-03-07 13:49:12 -0500477
Trond Myklebust4ce79712005-06-22 17:16:21 +0000478extern const nfs4_stateid zero_stateid;
479
Bryan Schumaker129d1972012-07-16 16:39:13 -0400480/* nfs4super.c */
Bryan Schumakerfbdefd62012-07-16 16:39:20 -0400481struct nfs_mount_info;
Bryan Schumakerab7017a2012-07-30 16:05:16 -0400482extern struct nfs_subversion nfs_v4;
Bryan Schumakerff9099f22012-07-30 16:05:18 -0400483struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
Bryan Schumakerfac1e8e2012-07-30 16:05:22 -0400484extern bool nfs4_disable_idmapping;
485extern unsigned short max_session_slots;
Trond Myklebust5405fc42016-08-29 20:03:52 -0400486extern unsigned short max_session_cb_slots;
Bryan Schumakerfac1e8e2012-07-30 16:05:22 -0400487extern unsigned short send_implementation_id;
Trond Myklebustf6de7a32013-09-04 10:08:54 -0400488extern bool recover_lost_locks;
Bryan Schumaker89d77c82012-07-30 16:05:25 -0400489
Chuck Lever6f2ea7f2012-09-14 17:24:41 -0400490#define NFS4_CLIENT_ID_UNIQ_LEN (64)
491extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
492
Bryan Schumaker466bfe72012-07-16 16:39:14 -0400493/* nfs4sysctl.c */
494#ifdef CONFIG_SYSCTL
495int nfs4_register_sysctl(void);
496void nfs4_unregister_sysctl(void);
497#else
498static inline int nfs4_register_sysctl(void)
499{
500 return 0;
501}
502
Randy Dunlap0add3e82012-07-27 11:49:26 -0700503static inline void nfs4_unregister_sysctl(void)
Bryan Schumaker466bfe72012-07-16 16:39:14 -0400504{
505}
506#endif
507
Trond Myklebust4ce79712005-06-22 17:16:21 +0000508/* nfs4xdr.c */
Trond Myklebust4ce79712005-06-22 17:16:21 +0000509extern struct rpc_procinfo nfs4_procedures[];
510
511struct nfs4_mount_data;
512
513/* callback_xdr.c */
514extern struct svc_version nfs4_callback_version1;
Alexandros Batsakis07bccc22009-12-05 13:19:01 -0500515extern struct svc_version nfs4_callback_version4;
Trond Myklebust4ce79712005-06-22 17:16:21 +0000516
Trond Myklebustf597c532012-03-04 18:13:56 -0500517static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
518{
Trond Myklebust93b717f2016-05-16 17:42:43 -0400519 memcpy(dst->data, src->data, sizeof(dst->data));
520 dst->type = src->type;
Trond Myklebustf597c532012-03-04 18:13:56 -0500521}
522
523static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
524{
Trond Myklebust93b717f2016-05-16 17:42:43 -0400525 if (dst->type != src->type)
526 return false;
527 return memcmp(dst->data, src->data, sizeof(dst->data)) == 0;
Trond Myklebustf597c532012-03-04 18:13:56 -0500528}
529
Trond Myklebuste999e802014-02-10 18:20:47 -0500530static inline bool nfs4_stateid_match_other(const nfs4_stateid *dst, const nfs4_stateid *src)
531{
532 return memcmp(dst->other, src->other, NFS4_STATEID_OTHER_SIZE) == 0;
533}
534
535static inline bool nfs4_stateid_is_newer(const nfs4_stateid *s1, const nfs4_stateid *s2)
536{
537 return (s32)(be32_to_cpu(s1->seqid) - be32_to_cpu(s2->seqid)) > 0;
538}
539
Trond Myklebust5d422302013-03-14 16:57:48 -0400540static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
541{
542 return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
543}
544
Trond Myklebust3e7dfb12016-11-14 11:19:55 -0500545static inline bool nfs4_state_match_open_stateid_other(const struct nfs4_state *state,
546 const nfs4_stateid *stateid)
547{
548 return test_bit(NFS_OPEN_STATE, &state->flags) &&
549 nfs4_stateid_match_other(&state->open_stateid, stateid);
550}
551
Trond Myklebust4ce79712005-06-22 17:16:21 +0000552#else
553
Al Viro643168c2011-06-22 18:20:23 -0400554#define nfs4_close_state(a, b) do { } while (0)
555#define nfs4_close_sync(a, b) do { } while (0)
Weston Andros Adamson8c21c622013-08-13 16:37:37 -0400556#define nfs4_state_protect(a, b, c, d) do { } while (0)
557#define nfs4_state_protect_write(a, b, c, d) do { } while (0)
Trond Myklebust4ce79712005-06-22 17:16:21 +0000558
559#endif /* CONFIG_NFS_V4 */
560#endif /* __LINUX_FS_NFS_NFS4_FS.H */