[mirror_ubuntu-zesty-kernel.git] / fs / nfs / nfs4_fs.h

/*
 * 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;

/*
 * In a seqid-mutating op, this macro controls which error return
 * values trigger incrementation of the seqid.
 *
 * from rfc 3010:
 * The client MUST monotonically increment the sequence number for the
 * CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE
 * operations.  This is true even in the event that the previous
 * operation that used the sequence number received an error.  The only
 * exception to this rule is if the previous operation received one of
 * the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID,
 * NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR,
 * NFSERR_RESOURCE, NFSERR_NOFILEHANDLE.
 *
 */
#define seqid_mutating_err(err)       \
(((err) != NFSERR_STALE_CLIENTID) &&  \
 ((err) != NFSERR_STALE_STATEID)  &&  \
 ((err) != NFSERR_BAD_STATEID)    &&  \
 ((err) != NFSERR_BAD_SEQID)      &&  \
 ((err) != NFSERR_BAD_XDR)        &&  \
 ((err) != NFSERR_RESOURCE)       &&  \
 ((err) != NFSERR_NOFILEHANDLE))

enum nfs4_client_state {
	NFS4CLNT_MANAGER_RUNNING  = 0,
	NFS4CLNT_CHECK_LEASE,
	NFS4CLNT_LEASE_EXPIRED,
	NFS4CLNT_RECLAIM_REBOOT,
	NFS4CLNT_RECLAIM_NOGRACE,
	NFS4CLNT_DELEGRETURN,
	NFS4CLNT_LAYOUTRECALL,
	NFS4CLNT_SESSION_RESET,
	NFS4CLNT_RECALL_SLOT,
	NFS4CLNT_LEASE_CONFIRM,
	NFS4CLNT_SERVER_SCOPE_MISMATCH,
};

enum nfs4_session_state {
	NFS4_SESSION_INITING,
	NFS4_SESSION_DRAINING,
};

struct nfs4_minor_version_ops {
	u32	minor_version;

	int	(*call_sync)(struct rpc_clnt *clnt,
			struct nfs_server *server,
			struct rpc_message *msg,
			struct nfs4_sequence_args *args,
			struct nfs4_sequence_res *res,
			int cache_reply);
	int	(*validate_stateid)(struct nfs_delegation *,
			const nfs4_stateid *);
	int	(*find_root_sec)(struct nfs_server *, struct nfs_fh *,
			struct nfs_fsinfo *);
	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;
};

/*
 * struct rpc_sequence ensures that RPC calls are sent in the exact
 * order that they appear on the list.
 */
struct rpc_sequence {
	struct rpc_wait_queue	wait;	/* RPC call delay queue */
	spinlock_t lock;		/* Protects the list */
	struct list_head list;		/* Defines sequence of RPC calls */
};

#define NFS_SEQID_CONFIRMED 1
struct nfs_seqid_counter {
	struct rpc_sequence *sequence;
	int flags;
	u32 counter;
};

struct nfs_seqid {
	struct nfs_seqid_counter *sequence;
	struct list_head list;
};

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

struct nfs_unique_id {
	struct rb_node rb_node;
	__u64 id;
};

/*
 * 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 {
	struct nfs_unique_id so_owner_id;
	struct nfs_server    *so_server;
	struct rb_node	     so_server_node;

	struct rpc_cred	     *so_cred;	 /* Associated cred */

	spinlock_t	     so_lock;
	atomic_t	     so_count;
	unsigned long	     so_flags;
	struct list_head     so_states;
	struct nfs_seqid_counter so_seqid;
	struct rpc_sequence  so_sequence;
};

enum {
	NFS_OWNER_RECLAIM_REBOOT,
	NFS_OWNER_RECLAIM_NOGRACE
};

#define NFS_LOCK_NEW		0
#define NFS_LOCK_RECLAIM	1
#define NFS_LOCK_EXPIRED	2

/*
 * 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)
 */

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;
};

struct nfs4_lock_state {
	struct list_head	ls_locks;	/* Other lock stateids */
	struct nfs4_state *	ls_state;	/* Pointer to open state */
#define NFS_LOCK_INITIALIZED 1
	int			ls_flags;
	struct nfs_seqid_counter	ls_seqid;
	struct rpc_sequence	ls_sequence;
	struct nfs_unique_id	ls_id;
	nfs4_stateid		ls_stateid;
	atomic_t		ls_count;
	struct nfs4_lock_owner	ls_owner;
};

/* bits for nfs4_state->flags */
enum {
	LK_STATE_IN_USE,
	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 */
	NFS_STATE_RECLAIM_REBOOT,	/* OPEN stateid server rebooted */
	NFS_STATE_RECLAIM_NOGRACE,	/* OPEN stateid needs to recover state */
	NFS_STATE_POSIX_LOCKS,		/* Posix locks are supported */
};

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? */
	spinlock_t state_lock;		/* Protects the lock_states list */

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

	/* The following 3 fields are protected by owner->so_lock */
	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 */
	fmode_t state;			/* State on the server (R,W, or RW) */
	atomic_t count;
};


struct nfs4_exception {
	long timeout;
	int retry;
	struct nfs4_state *state;
};

struct nfs4_state_recovery_ops {
	int owner_flag_bit;
	int state_flag_bit;
	int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
	int (*recover_lock)(struct nfs4_state *, struct file_lock *);
	int (*establish_clid)(struct nfs_client *, struct rpc_cred *);
	struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
	int (*reclaim_complete)(struct nfs_client *);
};

struct nfs4_state_maintenance_ops {
	int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *);
	struct rpc_cred * (*get_state_renewal_cred_locked)(struct nfs_client *);
	int (*renew_lease)(struct nfs_client *, struct rpc_cred *);
};

extern const struct dentry_operations nfs4_dentry_operations;
extern const struct inode_operations nfs4_dir_inode_operations;

/* nfs4proc.c */
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 *);
extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
extern int nfs4_proc_async_renew(struct nfs_client *, struct rpc_cred *);
extern int nfs4_proc_renew(struct nfs_client *, struct rpc_cred *);
extern int nfs4_init_clientid(struct nfs_client *, struct rpc_cred *);
extern int nfs41_init_clientid(struct nfs_client *, struct rpc_cred *);
extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
extern int nfs4_proc_fs_locations(struct inode *dir, const struct qstr *name,
		struct nfs4_fs_locations *fs_locations, struct page *page);
extern void nfs4_release_lockowner(const struct nfs4_lock_state *);
extern const struct xattr_handler *nfs4_xattr_handlers[];

#if defined(CONFIG_NFS_V4_1)
static inline struct nfs4_session *nfs4_get_session(const struct nfs_server *server)
{
	return server->nfs_client->cl_session;
}

extern int nfs4_setup_sequence(const struct nfs_server *server,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
		int cache_reply, struct rpc_task *task);
extern int nfs41_setup_sequence(struct nfs4_session *session,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
		int cache_reply, struct rpc_task *task);
extern void nfs4_destroy_session(struct nfs4_session *session);
extern struct nfs4_session *nfs4_alloc_session(struct nfs_client *clp);
extern int nfs4_proc_create_session(struct nfs_client *);
extern int nfs4_proc_destroy_session(struct nfs4_session *);
extern int nfs4_init_session(struct nfs_server *server);
extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
		struct nfs_fsinfo *fsinfo);
extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
				  bool sync);

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;
}

static inline bool
is_ds_client(struct nfs_client *clp)
{
	return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
}
#else /* CONFIG_NFS_v4_1 */
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,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
		int cache_reply, struct rpc_task *task)
{
	return 0;
}

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

static inline bool
is_ds_only_client(struct nfs_client *clp)
{
	return false;
}

static inline bool
is_ds_client(struct nfs_client *clp)
{
	return false;
}
#endif /* CONFIG_NFS_V4_1 */

extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];

extern const u32 nfs4_fattr_bitmap[2];
extern const u32 nfs4_statfs_bitmap[2];
extern const u32 nfs4_pathconf_bitmap[2];
extern const u32 nfs4_fsinfo_bitmap[3];
extern const u32 nfs4_fs_locations_bitmap[2];

/* nfs4renewd.c */
extern void nfs4_schedule_state_renewal(struct nfs_client *);
extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
extern void nfs4_kill_renewd(struct nfs_client *);
extern void nfs4_renew_state(struct work_struct *);

/* nfs4state.c */
struct rpc_cred *nfs4_get_setclientid_cred(struct nfs_client *clp);
struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
#if defined(CONFIG_NFS_V4_1)
struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
extern void nfs4_schedule_session_recovery(struct nfs4_session *);
#else
static inline void nfs4_schedule_session_recovery(struct nfs4_session *session)
{
}
#endif /* CONFIG_NFS_V4_1 */

extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *);
extern void nfs4_put_state_owner(struct nfs4_state_owner *);
extern struct nfs4_state * nfs4_get_open_state(struct inode *, struct nfs4_state_owner *);
extern void nfs4_put_open_state(struct nfs4_state *);
extern void nfs4_close_state(struct nfs4_state *, fmode_t);
extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
extern void nfs4_schedule_lease_recovery(struct nfs_client *);
extern void nfs4_schedule_state_manager(struct nfs_client *);
extern void nfs4_schedule_stateid_recovery(const struct nfs_server *, struct nfs4_state *);
extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
extern void nfs41_handle_recall_slot(struct nfs_client *clp);
extern void nfs41_handle_server_scope(struct nfs_client *,
				      struct server_scope **);
extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
extern int nfs4_set_lock_state(struct nfs4_state *state, struct file_lock *fl);
extern void nfs4_copy_stateid(nfs4_stateid *, struct nfs4_state *, fl_owner_t, pid_t);

extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter, gfp_t gfp_mask);
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);
extern void nfs_release_seqid(struct nfs_seqid *seqid);
extern void nfs_free_seqid(struct nfs_seqid *seqid);

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;
extern struct svc_version nfs4_callback_version4;

#else

#define nfs4_close_state(a, b) do { } while (0)
#define nfs4_close_sync(a, b) do { } while (0)

#endif /* CONFIG_NFS_V4 */
#endif /* __LINUX_FS_NFS_NFS4_FS.H */
Commit	Line	Data
4ce79717 TM	1	/*
	2	* linux/fs/nfs/nfs4_fs.h
	3	*
	4	* Copyright (C) 2005 Trond Myklebust
	5	*
	6	* NFSv4-specific filesystem definitions and declarations
	7	*/
	8
	9	#ifndef __LINUX_FS_NFS_NFS4_FS_H
	10	#define __LINUX_FS_NFS_NFS4_FS_H
	11
	12	#ifdef CONFIG_NFS_V4
	13
	14	struct idmap;
	15
	16	/*
	17	* In a seqid-mutating op, this macro controls which error return
	18	* values trigger incrementation of the seqid.
	19	*
	20	* from rfc 3010:
	21	* The client MUST monotonically increment the sequence number for the
	22	* CLOSE, LOCK, LOCKU, OPEN, OPEN_CONFIRM, and OPEN_DOWNGRADE
	23	* operations. This is true even in the event that the previous
	24	* operation that used the sequence number received an error. The only
	25	* exception to this rule is if the previous operation received one of
	26	* the following errors: NFSERR_STALE_CLIENTID, NFSERR_STALE_STATEID,
	27	* NFSERR_BAD_STATEID, NFSERR_BAD_SEQID, NFSERR_BADXDR,
	28	* NFSERR_RESOURCE, NFSERR_NOFILEHANDLE.
	29	*
	30	*/
	31	#define seqid_mutating_err(err) \
	32	(((err) != NFSERR_STALE_CLIENTID) && \
	33	((err) != NFSERR_STALE_STATEID) && \
	34	((err) != NFSERR_BAD_STATEID) && \
	35	((err) != NFSERR_BAD_SEQID) && \
	36	((err) != NFSERR_BAD_XDR) && \
	37	((err) != NFSERR_RESOURCE) && \
	38	((err) != NFSERR_NOFILEHANDLE))
	39
	40	enum nfs4_client_state {
e005e804	41	NFS4CLNT_MANAGER_RUNNING = 0,
e598d843	42	NFS4CLNT_CHECK_LEASE,
58d9714a	43	NFS4CLNT_LEASE_EXPIRED,
b79a4a1b TM	44	NFS4CLNT_RECLAIM_REBOOT,
b79a4a1b TM	45	NFS4CLNT_RECLAIM_NOGRACE,
707fb4b3	46	NFS4CLNT_DELEGRETURN,
43f1b3da	47	NFS4CLNT_LAYOUTRECALL,
6df08189	48	NFS4CLNT_SESSION_RESET,
b9efa1b2	49	NFS4CLNT_RECALL_SLOT,
fd954ae1	50	NFS4CLNT_LEASE_CONFIRM,
78fe0f41	51	NFS4CLNT_SERVER_SCOPE_MISMATCH,
4ce79717 TM	52	};
4ce79717 TM	53
a2118c33	54	enum nfs4_session_state {
1055d76d	55	NFS4_SESSION_INITING,
a2118c33 TM	56	NFS4_SESSION_DRAINING,
	57	};
	58
97dc1359 TM	59	struct nfs4_minor_version_ops {
	60	u32 minor_version;
	61
7c513058 BS	62	int (call_sync)(struct rpc_clnt clnt,
7c513058 BS	63	struct nfs_server *server,
97dc1359 TM	64	struct rpc_message *msg,
	65	struct nfs4_sequence_args *args,
	66	struct nfs4_sequence_res *res,
	67	int cache_reply);
e047a10c TM	68	int (validate_stateid)(struct nfs_delegation ,
e047a10c TM	69	const nfs4_stateid *);
fca78d6d BS	70	int (find_root_sec)(struct nfs_server , struct nfs_fh *,
fca78d6d BS	71	struct nfs_fsinfo *);
c48f4f35 TM	72	const struct nfs4_state_recovery_ops *reboot_recovery_ops;
	73	const struct nfs4_state_recovery_ops *nograce_recovery_ops;
	74	const struct nfs4_state_maintenance_ops *state_renewal_ops;
97dc1359 TM	75	};
97dc1359 TM	76
cee54fc9 TM	77	/*
	78	* struct rpc_sequence ensures that RPC calls are sent in the exact
	79	* order that they appear on the list.
	80	*/
	81	struct rpc_sequence {
	82	struct rpc_wait_queue wait; /* RPC call delay queue */
	83	spinlock_t lock; /* Protects the list */
	84	struct list_head list; /* Defines sequence of RPC calls */
	85	};
	86
	87	#define NFS_SEQID_CONFIRMED 1
	88	struct nfs_seqid_counter {
	89	struct rpc_sequence *sequence;
	90	int flags;
	91	u32 counter;
	92	};
	93
	94	struct nfs_seqid {
cee54fc9	95	struct nfs_seqid_counter *sequence;
4e51336a	96	struct list_head list;
cee54fc9 TM	97	};
	98
	99	static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
	100	{
	101	if (seqid_mutating_err(-status))
	102	seqid->flags \|= NFS_SEQID_CONFIRMED;
	103	}
	104
9f958ab8 TM	105	struct nfs_unique_id {
	106	struct rb_node rb_node;
	107	__u64 id;
	108	};
	109
4ce79717 TM	110	/*
	111	* NFS4 state_owners and lock_owners are simply labels for ordered
	112	* sequences of RPC calls. Their sole purpose is to provide once-only
	113	* semantics by allowing the server to identify replayed requests.
4ce79717 TM	114	*/
4ce79717 TM	115	struct nfs4_state_owner {
9f958ab8	116	struct nfs_unique_id so_owner_id;
6f2e64d3	117	struct nfs_server *so_server;
24d292b8	118	struct rb_node so_server_node;
4ce79717 TM	119
4ce79717 TM	120	struct rpc_cred so_cred; / Associated cred */
9f958ab8 TM	121
	122	spinlock_t so_lock;
	123	atomic_t so_count;
7eff03ae	124	unsigned long so_flags;
4ce79717	125	struct list_head so_states;
cee54fc9 TM	126	struct nfs_seqid_counter so_seqid;
cee54fc9 TM	127	struct rpc_sequence so_sequence;
4ce79717 TM	128	};
4ce79717 TM	129
7eff03ae TM	130	enum {
	131	NFS_OWNER_RECLAIM_REBOOT,
	132	NFS_OWNER_RECLAIM_NOGRACE
	133	};
	134
afe6c27c AB	135	#define NFS_LOCK_NEW 0
	136	#define NFS_LOCK_RECLAIM 1
	137	#define NFS_LOCK_EXPIRED 2
	138
4ce79717 TM	139	/*
	140	* struct nfs4_state maintains the client-side state for a given
	141	* (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
	142	*
	143	* OPEN:
	144	* In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
	145	* we need to know how many files are open for reading or writing on a
	146	* given inode. This information too is stored here.
	147	*
	148	* LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
	149	*/
	150
77041ed9 TM	151	struct nfs4_lock_owner {
	152	unsigned int lo_type;
	153	#define NFS4_ANY_LOCK_TYPE (0U)
	154	#define NFS4_FLOCK_LOCK_TYPE (1U << 0)
	155	#define NFS4_POSIX_LOCK_TYPE (1U << 1)
	156	union {
	157	fl_owner_t posix_owner;
	158	pid_t flock_owner;
	159	} lo_u;
	160	};
	161
4ce79717 TM	162	struct nfs4_lock_state {
4ce79717 TM	163	struct list_head ls_locks; /* Other lock stateids */
8d0a8a9d	164	struct nfs4_state * ls_state; /* Pointer to open state */
4ce79717 TM	165	#define NFS_LOCK_INITIALIZED 1
4ce79717 TM	166	int ls_flags;
cee54fc9	167	struct nfs_seqid_counter ls_seqid;
d0dc3701	168	struct rpc_sequence ls_sequence;
9f958ab8	169	struct nfs_unique_id ls_id;
4ce79717 TM	170	nfs4_stateid ls_stateid;
4ce79717 TM	171	atomic_t ls_count;
77041ed9	172	struct nfs4_lock_owner ls_owner;
4ce79717 TM	173	};
	174
	175	/* bits for nfs4_state->flags */
	176	enum {
	177	LK_STATE_IN_USE,
003707c7 TM	178	NFS_DELEGATED_STATE, /* Current stateid is delegation */
	179	NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
	180	NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
	181	NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
b79a4a1b TM	182	NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
b79a4a1b TM	183	NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
8e469ebd	184	NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
4ce79717 TM	185	};
	186
	187	struct nfs4_state {
	188	struct list_head open_states; /* List of states for the same state_owner */
	189	struct list_head inode_states; /* List of states for the same inode */
	190	struct list_head lock_states; /* List of subservient lock stateids */
	191
	192	struct nfs4_state_owner owner; / Pointer to the open owner */
	193	struct inode inode; / Pointer to the inode */
	194
	195	unsigned long flags; /* Do we hold any locks? */
8d0a8a9d	196	spinlock_t state_lock; /* Protects the lock_states list */
4ce79717	197
8bda4e4c	198	seqlock_t seqlock; /* Protects the stateid/open_stateid */
003707c7 TM	199	nfs4_stateid stateid; /* Current stateid: may be delegation */
003707c7 TM	200	nfs4_stateid open_stateid; /* OPEN stateid */
4ce79717	201
8bda4e4c	202	/* The following 3 fields are protected by owner->so_lock */
003707c7 TM	203	unsigned int n_rdonly; /* Number of read-only references */
	204	unsigned int n_wronly; /* Number of write-only references */
	205	unsigned int n_rdwr; /* Number of read/write references */
dc0b027d	206	fmode_t state; /* State on the server (R,W, or RW) */
4ce79717 TM	207	atomic_t count;
	208	};
	209
	210
	211	struct nfs4_exception {
	212	long timeout;
	213	int retry;
9e33bed5	214	struct nfs4_state *state;
4ce79717 TM	215	};
	216
	217	struct nfs4_state_recovery_ops {
7eff03ae	218	int owner_flag_bit;
b79a4a1b	219	int state_flag_bit;
4ce79717 TM	220	int (recover_open)(struct nfs4_state_owner , struct nfs4_state *);
4ce79717 TM	221	int (recover_lock)(struct nfs4_state , struct file_lock *);
591d71cb	222	int (establish_clid)(struct nfs_client , struct rpc_cred *);
90a16617	223	struct rpc_cred * (get_clid_cred)(struct nfs_client );
fce5c838	224	int (reclaim_complete)(struct nfs_client );
4ce79717 TM	225	};
4ce79717 TM	226
29fba38b BH	227	struct nfs4_state_maintenance_ops {
29fba38b BH	228	int (sched_state_renewal)(struct nfs_client , struct rpc_cred *);
a7b72103	229	struct rpc_cred * (get_state_renewal_cred_locked)(struct nfs_client );
8e69514f	230	int (renew_lease)(struct nfs_client , struct rpc_cred *);
29fba38b BH	231	};
29fba38b BH	232
f786aa90	233	extern const struct dentry_operations nfs4_dentry_operations;
92e1d5be	234	extern const struct inode_operations nfs4_dir_inode_operations;
6b3b5496	235
4ce79717	236	/* nfs4proc.c */
bb8b27e5 TM	237	extern int nfs4_proc_setclientid(struct nfs_client , u32, unsigned short, struct rpc_cred , struct nfs4_setclientid_res *);
bb8b27e5 TM	238	extern int nfs4_proc_setclientid_confirm(struct nfs_client , struct nfs4_setclientid_res arg, struct rpc_cred *);
4d643d1d	239	extern int nfs4_proc_exchange_id(struct nfs_client clp, struct rpc_cred cred);
adfa6f98 DH	240	extern int nfs4_proc_async_renew(struct nfs_client , struct rpc_cred );
adfa6f98 DH	241	extern int nfs4_proc_renew(struct nfs_client , struct rpc_cred );
591d71cb	242	extern int nfs4_init_clientid(struct nfs_client , struct rpc_cred );
4d643d1d	243	extern int nfs41_init_clientid(struct nfs_client , struct rpc_cred );
643168c2	244	extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait, bool roc);
55a97593	245	extern int nfs4_server_capabilities(struct nfs_server server, struct nfs_fh fhandle);
56659e99	246	extern int nfs4_proc_fs_locations(struct inode dir, const struct qstr name,
7aaa0b3b	247	struct nfs4_fs_locations fs_locations, struct page page);
d3c7b7cc	248	extern void nfs4_release_lockowner(const struct nfs4_lock_state *);
64c2ce8b	249	extern const struct xattr_handler *nfs4_xattr_handlers[];
4ce79717	250
557134a3	251	#if defined(CONFIG_NFS_V4_1)
035168ab TM	252	static inline struct nfs4_session nfs4_get_session(const struct nfs_server server)
	253	{
	254	return server->nfs_client->cl_session;
	255	}
	256
	257	extern int nfs4_setup_sequence(const struct nfs_server *server,
fbcd4abc AA	258	struct nfs4_sequence_args args, struct nfs4_sequence_res res,
fbcd4abc AA	259	int cache_reply, struct rpc_task *task);
dc70d7b3 AA	260	extern int nfs41_setup_sequence(struct nfs4_session *session,
	261	struct nfs4_sequence_args args, struct nfs4_sequence_res res,
	262	int cache_reply, struct rpc_task *task);
557134a3 AA	263	extern void nfs4_destroy_session(struct nfs4_session *session);
557134a3 AA	264	extern struct nfs4_session nfs4_alloc_session(struct nfs_client clp);
f26468fb	265	extern int nfs4_proc_create_session(struct nfs_client *);
c3fad1b1	266	extern int nfs4_proc_destroy_session(struct nfs4_session *);
fccba804	267	extern int nfs4_init_session(struct nfs_server *server);
9430fb6b RL	268	extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
9430fb6b RL	269	struct nfs_fsinfo *fsinfo);
863a3c6c	270	extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
ef311537	271	bool sync);
94de8b27 AA	272
	273	static inline bool
	274	is_ds_only_client(struct nfs_client *clp)
	275	{
	276	return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
	277	EXCHGID4_FLAG_USE_PNFS_DS;
	278	}
d83217c1 AA	279
	280	static inline bool
	281	is_ds_client(struct nfs_client *clp)
	282	{
	283	return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
	284	}
fbcd4abc	285	#else /* CONFIG_NFS_v4_1 */
035168ab TM	286	static inline struct nfs4_session nfs4_get_session(const struct nfs_server server)
	287	{
	288	return NULL;
	289	}
	290
	291	static inline int nfs4_setup_sequence(const struct nfs_server *server,
fbcd4abc AA	292	struct nfs4_sequence_args args, struct nfs4_sequence_res res,
	293	int cache_reply, struct rpc_task *task)
	294	{
	295	return 0;
	296	}
fccba804 TM	297
	298	static inline int nfs4_init_session(struct nfs_server *server)
	299	{
	300	return 0;
	301	}
94de8b27 AA	302
	303	static inline bool
	304	is_ds_only_client(struct nfs_client *clp)
d83217c1 AA	305	{
	306	return false;
	307	}
	308
	309	static inline bool
	310	is_ds_client(struct nfs_client *clp)
94de8b27 AA	311	{
	312	return false;
	313	}
557134a3	314	#endif /* CONFIG_NFS_V4_1 */
4ce79717	315
97dc1359	316	extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
29fba38b	317
4ce79717 TM	318	extern const u32 nfs4_fattr_bitmap[2];
	319	extern const u32 nfs4_statfs_bitmap[2];
	320	extern const u32 nfs4_pathconf_bitmap[2];
dae100c2	321	extern const u32 nfs4_fsinfo_bitmap[3];
830b8e33	322	extern const u32 nfs4_fs_locations_bitmap[2];
4ce79717 TM	323
4ce79717 TM	324	/* nfs4renewd.c */
adfa6f98	325	extern void nfs4_schedule_state_renewal(struct nfs_client *);
4ce79717	326	extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
adfa6f98	327	extern void nfs4_kill_renewd(struct nfs_client *);
65f27f38	328	extern void nfs4_renew_state(struct work_struct *);
4ce79717 TM	329
4ce79717 TM	330	/* nfs4state.c */
a7b72103	331	struct rpc_cred nfs4_get_setclientid_cred(struct nfs_client clp);
6dc9d57a	332	struct rpc_cred nfs4_get_renew_cred_locked(struct nfs_client clp);
a7b72103 AA	333	#if defined(CONFIG_NFS_V4_1)
a7b72103 AA	334	struct rpc_cred nfs4_get_machine_cred_locked(struct nfs_client clp);
b4b82607	335	struct rpc_cred nfs4_get_exchange_id_cred(struct nfs_client clp);
0400a6b0 TM	336	extern void nfs4_schedule_session_recovery(struct nfs4_session *);
	337	#else
	338	static inline void nfs4_schedule_session_recovery(struct nfs4_session *session)
	339	{
	340	}
a7b72103	341	#endif /* CONFIG_NFS_V4_1 */
4ce79717 TM	342
	343	extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server , struct rpc_cred );
	344	extern void nfs4_put_state_owner(struct nfs4_state_owner *);
4ce79717 TM	345	extern struct nfs4_state * nfs4_get_open_state(struct inode , struct nfs4_state_owner );
4ce79717 TM	346	extern void nfs4_put_open_state(struct nfs4_state *);
643168c2 AV	347	extern void nfs4_close_state(struct nfs4_state *, fmode_t);
643168c2 AV	348	extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
dc0b027d	349	extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
0400a6b0	350	extern void nfs4_schedule_lease_recovery(struct nfs_client *);
b0d3ded1	351	extern void nfs4_schedule_state_manager(struct nfs_client *);
0400a6b0	352	extern void nfs4_schedule_stateid_recovery(const struct nfs_server , struct nfs4_state );
0629e370	353	extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
b9efa1b2	354	extern void nfs41_handle_recall_slot(struct nfs_client *clp);
78fe0f41 WAA	355	extern void nfs41_handle_server_scope(struct nfs_client *,
78fe0f41 WAA	356	struct server_scope **);
faf5f49c	357	extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
8d0a8a9d	358	extern int nfs4_set_lock_state(struct nfs4_state state, struct file_lock fl);
77041ed9	359	extern void nfs4_copy_stateid(nfs4_stateid , struct nfs4_state , fl_owner_t, pid_t);
4ce79717	360
8535b2be	361	extern struct nfs_seqid nfs_alloc_seqid(struct nfs_seqid_counter counter, gfp_t gfp_mask);
cee54fc9 TM	362	extern int nfs_wait_on_sequence(struct nfs_seqid seqid, struct rpc_task task);
	363	extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
	364	extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
72211dbe	365	extern void nfs_release_seqid(struct nfs_seqid *seqid);
cee54fc9 TM	366	extern void nfs_free_seqid(struct nfs_seqid *seqid);
cee54fc9 TM	367
4ce79717 TM	368	extern const nfs4_stateid zero_stateid;
	369
	370	/* nfs4xdr.c */
4ce79717 TM	371	extern struct rpc_procinfo nfs4_procedures[];
	372
	373	struct nfs4_mount_data;
	374
	375	/* callback_xdr.c */
	376	extern struct svc_version nfs4_callback_version1;
07bccc2d	377	extern struct svc_version nfs4_callback_version4;
4ce79717 TM	378
	379	#else
	380
643168c2 AV	381	#define nfs4_close_state(a, b) do { } while (0)
643168c2 AV	382	#define nfs4_close_sync(a, b) do { } while (0)
4ce79717 TM	383
	384	#endif /* CONFIG_NFS_V4 */
	385	#endif /* __LINUX_FS_NFS_NFS4_FS.H */