nfs4_fs.h 12.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
/*
 * linux/fs/nfs/nfs4_fs.h
 *
 * Copyright (C) 2005 Trond Myklebust
 *
 * NFSv4-specific filesystem definitions and declarations
 */

#ifndef __LINUX_FS_NFS_NFS4_FS_H
#define __LINUX_FS_NFS_NFS4_FS_H

#ifdef CONFIG_NFS_V4

struct idmap;

enum nfs4_client_state {
17
	NFS4CLNT_MANAGER_RUNNING  = 0,
18
	NFS4CLNT_CHECK_LEASE,
19
	NFS4CLNT_LEASE_EXPIRED,
20 21
	NFS4CLNT_RECLAIM_REBOOT,
	NFS4CLNT_RECLAIM_NOGRACE,
22
	NFS4CLNT_DELEGRETURN,
23
	NFS4CLNT_SESSION_RESET,
A
Andy Adamson 已提交
24
	NFS4CLNT_RECALL_SLOT,
25
	NFS4CLNT_LEASE_CONFIRM,
26
	NFS4CLNT_SERVER_SCOPE_MISMATCH,
27
	NFS4CLNT_PURGE_STATE,
28
	NFS4CLNT_BIND_CONN_TO_SESSION,
29 30
};

31
enum nfs4_session_state {
32
	NFS4_SESSION_INITING,
33 34 35
	NFS4_SESSION_DRAINING,
};

36 37 38
#define NFS4_RENEW_TIMEOUT		0x01
#define NFS4_RENEW_DELEGATION_CB	0x02

39 40 41
struct nfs4_minor_version_ops {
	u32	minor_version;

42 43
	int	(*call_sync)(struct rpc_clnt *clnt,
			struct nfs_server *server,
44 45 46 47
			struct rpc_message *msg,
			struct nfs4_sequence_args *args,
			struct nfs4_sequence_res *res,
			int cache_reply);
48
	bool	(*match_stateid)(const nfs4_stateid *,
49
			const nfs4_stateid *);
50 51
	int	(*find_root_sec)(struct nfs_server *, struct nfs_fh *,
			struct nfs_fsinfo *);
52 53 54
	const struct nfs4_state_recovery_ops *reboot_recovery_ops;
	const struct nfs4_state_recovery_ops *nograce_recovery_ops;
	const struct nfs4_state_maintenance_ops *state_renewal_ops;
55 56
};

57 58
#define NFS_SEQID_CONFIRMED 1
struct nfs_seqid_counter {
59
	ktime_t create_time;
60
	int owner_id;
61 62
	int flags;
	u32 counter;
63 64 65
	spinlock_t lock;		/* Protects the list */
	struct list_head list;		/* Defines sequence of RPC calls */
	struct rpc_wait_queue	wait;	/* RPC call delay queue */
66 67 68 69
};

struct nfs_seqid {
	struct nfs_seqid_counter *sequence;
70
	struct list_head list;
71
	struct rpc_task *task;
72 73 74 75 76 77 78 79
};

static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
{
	if (seqid_mutating_err(-status))
		seqid->flags |= NFS_SEQID_CONFIRMED;
}

80 81 82 83 84 85
/*
 * NFS4 state_owners and lock_owners are simply labels for ordered
 * sequences of RPC calls. Their sole purpose is to provide once-only
 * semantics by allowing the server to identify replayed requests.
 */
struct nfs4_state_owner {
86
	struct nfs_server    *so_server;
87 88
	struct list_head     so_lru;
	unsigned long        so_expires;
89
	struct rb_node	     so_server_node;
90 91

	struct rpc_cred	     *so_cred;	 /* Associated cred */
92 93 94

	spinlock_t	     so_lock;
	atomic_t	     so_count;
95
	unsigned long	     so_flags;
96
	struct list_head     so_states;
97
	struct nfs_seqid_counter so_seqid;
98 99
};

100 101 102 103 104
enum {
	NFS_OWNER_RECLAIM_REBOOT,
	NFS_OWNER_RECLAIM_NOGRACE
};

105 106 107 108
#define NFS_LOCK_NEW		0
#define NFS_LOCK_RECLAIM	1
#define NFS_LOCK_EXPIRED	2

109 110 111 112 113 114 115 116 117 118 119 120
/*
 * struct nfs4_state maintains the client-side state for a given
 * (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
 *
 * OPEN:
 * In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
 * we need to know how many files are open for reading or writing on a
 * given inode. This information too is stored here.
 *
 * LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
 */

121 122 123 124 125 126 127 128 129 130 131
struct nfs4_lock_owner {
	unsigned int lo_type;
#define NFS4_ANY_LOCK_TYPE	(0U)
#define NFS4_FLOCK_LOCK_TYPE	(1U << 0)
#define NFS4_POSIX_LOCK_TYPE	(1U << 1)
	union {
		fl_owner_t posix_owner;
		pid_t flock_owner;
	} lo_u;
};

132 133
struct nfs4_lock_state {
	struct list_head	ls_locks;	/* Other lock stateids */
134
	struct nfs4_state *	ls_state;	/* Pointer to open state */
135 136
#define NFS_LOCK_INITIALIZED 1
	int			ls_flags;
137
	struct nfs_seqid_counter	ls_seqid;
138 139
	nfs4_stateid		ls_stateid;
	atomic_t		ls_count;
140
	struct nfs4_lock_owner	ls_owner;
141 142 143 144 145
};

/* bits for nfs4_state->flags */
enum {
	LK_STATE_IN_USE,
146 147 148 149
	NFS_DELEGATED_STATE,		/* Current stateid is delegation */
	NFS_O_RDONLY_STATE,		/* OPEN stateid has read-only state */
	NFS_O_WRONLY_STATE,		/* OPEN stateid has write-only state */
	NFS_O_RDWR_STATE,		/* OPEN stateid has read/write state */
150 151
	NFS_STATE_RECLAIM_REBOOT,	/* OPEN stateid server rebooted */
	NFS_STATE_RECLAIM_NOGRACE,	/* OPEN stateid needs to recover state */
152
	NFS_STATE_POSIX_LOCKS,		/* Posix locks are supported */
153 154 155 156 157 158 159 160 161 162 163
};

struct nfs4_state {
	struct list_head open_states;	/* List of states for the same state_owner */
	struct list_head inode_states;	/* List of states for the same inode */
	struct list_head lock_states;	/* List of subservient lock stateids */

	struct nfs4_state_owner *owner;	/* Pointer to the open owner */
	struct inode *inode;		/* Pointer to the inode */

	unsigned long flags;		/* Do we hold any locks? */
164
	spinlock_t state_lock;		/* Protects the lock_states list */
165

166
	seqlock_t seqlock;		/* Protects the stateid/open_stateid */
167 168
	nfs4_stateid stateid;		/* Current stateid: may be delegation */
	nfs4_stateid open_stateid;	/* OPEN stateid */
169

170
	/* The following 3 fields are protected by owner->so_lock */
171 172 173
	unsigned int n_rdonly;		/* Number of read-only references */
	unsigned int n_wronly;		/* Number of write-only references */
	unsigned int n_rdwr;		/* Number of read/write references */
174
	fmode_t state;			/* State on the server (R,W, or RW) */
175 176 177 178 179 180 181
	atomic_t count;
};


struct nfs4_exception {
	long timeout;
	int retry;
182
	struct nfs4_state *state;
183
	struct inode *inode;
184 185 186
};

struct nfs4_state_recovery_ops {
187
	int owner_flag_bit;
188
	int state_flag_bit;
189 190
	int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
	int (*recover_lock)(struct nfs4_state *, struct file_lock *);
191
	int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
192
	struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
193
	int (*reclaim_complete)(struct nfs_client *);
194 195
};

B
Benny Halevy 已提交
196
struct nfs4_state_maintenance_ops {
197
	int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
198
	struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
199
	int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
B
Benny Halevy 已提交
200 201
};

A
Al Viro 已提交
202
extern const struct dentry_operations nfs4_dentry_operations;
203
extern const struct inode_operations nfs4_dir_inode_operations;
204

205
/* nfs4namespace.c */
206
rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
207
struct rpc_clnt *nfs4_create_sec_client(struct rpc_clnt *, struct inode *, struct qstr *);
B
Bryan Schumaker 已提交
208 209
struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
			       struct nfs_fh *, struct nfs_fattr *);
210

211
/* nfs4proc.c */
212 213
extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *, struct nfs4_setclientid_res *);
extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct nfs4_setclientid_res *arg, struct rpc_cred *);
214
extern int nfs4_proc_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *);
215
extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
216
extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
T
Trond Myklebust 已提交
217
extern int nfs4_destroy_clientid(struct nfs_client *clp);
218
extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
219
extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
220
extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
221
extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
222 223 224 225
extern int nfs4_proc_fs_locations(struct rpc_clnt *, struct inode *, const struct qstr *,
				  struct nfs4_fs_locations *, struct page *);
extern struct rpc_clnt *nfs4_proc_lookup_mountpoint(struct inode *, struct qstr *,
			    struct nfs_fh *, struct nfs_fattr *);
226
extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
227
extern int nfs4_release_lockowner(struct nfs4_lock_state *);
228
extern const struct xattr_handler *nfs4_xattr_handlers[];
229

230
#if defined(CONFIG_NFS_V4_1)
231 232 233 234 235
static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
{
	return server->nfs_client->cl_session;
}

236
extern bool nfs4_set_task_privileged(struct rpc_task *task, void *dummy);
237
extern int nfs4_setup_sequence(const struct nfs_server *server,
A
Andy Adamson 已提交
238
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
239
		struct rpc_task *task);
A
Andy Adamson 已提交
240 241
extern int nfs41_setup_sequence(struct nfs4_session *session,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
242
		struct rpc_task *task);
243 244
extern void nfs4_destroy_session(struct nfs4_session *session);
extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
245 246
extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
247
extern int nfs4_init_session(struct nfs_server *server);
R
Ricardo Labiaga 已提交
248 249
extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
		struct nfs_fsinfo *fsinfo);
A
Andy Adamson 已提交
250
extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
251
				  bool sync);
252 253 254 255 256 257 258

static inline bool
is_ds_only_client(struct nfs_client *clp)
{
	return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
		EXCHGID4_FLAG_USE_PNFS_DS;
}
A
Andy Adamson 已提交
259 260 261 262 263 264

static inline bool
is_ds_client(struct nfs_client *clp)
{
	return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
}
A
Andy Adamson 已提交
265
#else /* CONFIG_NFS_v4_1 */
266 267 268 269 270 271
static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
{
	return NULL;
}

static inline int nfs4_setup_sequence(const struct nfs_server *server,
A
Andy Adamson 已提交
272
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
273
		struct rpc_task *task)
A
Andy Adamson 已提交
274 275 276
{
	return 0;
}
277 278 279 280 281

static inline int nfs4_init_session(struct nfs_server *server)
{
	return 0;
}
282 283 284

static inline bool
is_ds_only_client(struct nfs_client *clp)
A
Andy Adamson 已提交
285 286 287 288 289 290
{
	return false;
}

static inline bool
is_ds_client(struct nfs_client *clp)
291 292 293
{
	return false;
}
294
#endif /* CONFIG_NFS_V4_1 */
295

296
extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
B
Benny Halevy 已提交
297

298
extern const u32 nfs4_fattr_bitmap[3];
299 300
extern const u32 nfs4_statfs_bitmap[2];
extern const u32 nfs4_pathconf_bitmap[2];
301
extern const u32 nfs4_fsinfo_bitmap[3];
302
extern const u32 nfs4_fs_locations_bitmap[2];
303

304 305
void nfs4_free_client(struct nfs_client *);

306
/* nfs4renewd.c */
307
extern void nfs4_schedule_state_renewal(struct nfs_client *);
308
extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
309
extern void nfs4_kill_renewd(struct nfs_client *);
310
extern void nfs4_renew_state(struct work_struct *);
311 312

/* nfs4state.c */
313
struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
314
struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
315 316
#if defined(CONFIG_NFS_V4_1)
struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
317
struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
318
extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
319
#else
320
static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
321 322
{
}
323
#endif /* CONFIG_NFS_V4_1 */
324

325
extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
326
extern void nfs4_put_state_owner(struct nfs4_state_owner *);
327
extern void nfs4_purge_state_owners(struct nfs_server *);
328 329
extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
extern void nfs4_put_open_state(struct nfs4_state *);
330 331
extern void nfs4_close_state(struct nfs4_state *, fmode_t);
extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
332
extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
333 334
extern void nfs_inode_find_state_and_recover(struct inode *inode,
		const nfs4_stateid *stateid);
335
extern void nfs4_schedule_lease_recovery(struct nfs_client *);
336
extern void nfs4_schedule_state_manager(struct nfs_client *);
337
extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
338
extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
339
extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
A
Andy Adamson 已提交
340
extern void nfs41_handle_recall_slot(struct nfs_client *clp);
341
extern void nfs41_handle_server_scope(struct nfs_client *,
342
				      struct nfs41_server_scope **);
343
extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
344
extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
345 346
extern void nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
		fmode_t, fl_owner_t, pid_t);
347

348
extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
349 350 351
extern int nfs_wait_on_sequence(struct nfs_seqid *seqid, struct rpc_task *task);
extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
352
extern void nfs_release_seqid(struct nfs_seqid *seqid);
353 354
extern void nfs_free_seqid(struct nfs_seqid *seqid);

355
extern void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);
356

357 358 359 360 361 362 363 364 365
extern const nfs4_stateid zero_stateid;

/* nfs4xdr.c */
extern struct rpc_procinfo nfs4_procedures[];

struct nfs4_mount_data;

/* callback_xdr.c */
extern struct svc_version nfs4_callback_version1;
366
extern struct svc_version nfs4_callback_version4;
367

368 369
static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
{
370
	memcpy(dst, src, sizeof(*dst));
371 372 373 374
}

static inline bool nfs4_stateid_match(const nfs4_stateid *dst, const nfs4_stateid *src)
{
375
	return memcmp(dst, src, sizeof(*dst)) == 0;
376 377
}

378 379
#else

380 381
#define nfs4_close_state(a, b) do { } while (0)
#define nfs4_close_sync(a, b) do { } while (0)
382 383 384

#endif /* CONFIG_NFS_V4 */
#endif /* __LINUX_FS_NFS_NFS4_FS.H */