[mirror_ubuntu-bionic-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

#if IS_ENABLED(CONFIG_NFS_V4)

#define NFS4_MAX_LOOP_ON_RECOVER (10)

#include <linux/seqlock.h>

struct idmap;

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

#define NFS4_RENEW_TIMEOUT		0x01
#define NFS4_RENEW_DELEGATION_CB	0x02

struct nfs4_minor_version_ops {
	u32	minor_version;
	unsigned init_caps;

	int	(*init_client)(struct nfs_client *);
	void	(*shutdown_client)(struct nfs_client *);
	bool	(*match_stateid)(const nfs4_stateid *,
			const nfs4_stateid *);
	int	(*find_root_sec)(struct nfs_server *, struct nfs_fh *,
			struct nfs_fsinfo *);
	int	(*free_lock_state)(struct nfs_server *,
			struct nfs4_lock_state *);
	const struct rpc_call_ops *call_sync_ops;
	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;
};

#define NFS_SEQID_CONFIRMED 1
struct nfs_seqid_counter {
	ktime_t create_time;
	int owner_id;
	int flags;
	u32 counter;
	spinlock_t lock;		/* Protects the list */
	struct list_head list;		/* Defines sequence of RPC calls */
	struct rpc_wait_queue	wait;	/* RPC call delay queue */
};

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

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

/*
 * 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_server    *so_server;
	struct list_head     so_lru;
	unsigned long        so_expires;
	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;
	seqcount_t	     so_reclaim_seqcount;
	struct mutex	     so_delegreturn_mutex;
};

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 0
#define NFS_LOCK_LOST        1
	unsigned long		ls_flags;
	struct nfs_seqid_counter	ls_seqid;
	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_OPEN_STATE,			/* OPEN stateid is set */
	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 */
	NFS_STATE_RECOVERY_FAILED,	/* OPEN stateid state recovery failed */
};

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

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 *);
	int (*reclaim_complete)(struct nfs_client *, struct rpc_cred *);
	int (*detect_trunking)(struct nfs_client *, struct nfs_client **,
		struct rpc_cred *);
};

struct nfs4_state_maintenance_ops {
	int (*sched_state_renewal)(struct nfs_client *, struct rpc_cred *, unsigned);
	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;

/* dir.c */
int nfs_atomic_open(struct inode *, struct dentry *, struct file *,
		    unsigned, umode_t, int *);

/* super.c */
extern struct file_system_type nfs4_fs_type;

/* nfs4namespace.c */
rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
struct rpc_clnt *nfs4_create_sec_client(struct rpc_clnt *, struct inode *, struct qstr *);
struct vfsmount *nfs4_submount(struct nfs_server *, struct dentry *,
			       struct nfs_fh *, struct nfs_fattr *);

/* 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_get_rootfh(struct nfs_server *, struct nfs_fh *, struct nfs_fsinfo *);
extern int nfs4_proc_bind_conn_to_session(struct nfs_client *, struct rpc_cred *cred);
extern int nfs4_proc_exchange_id(struct nfs_client *clp, struct rpc_cred *cred);
extern int nfs4_destroy_clientid(struct nfs_client *clp);
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);
extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
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 *);
extern int nfs4_proc_secinfo(struct inode *, const struct qstr *, struct nfs4_secinfo_flavors *);
extern const struct xattr_handler *nfs4_xattr_handlers[];
extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
		const struct nfs_open_context *ctx,
		const struct nfs_lock_context *l_ctx,
		fmode_t fmode);

#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 nfs41_setup_sequence(struct nfs4_session *session,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
		struct rpc_task *task);
extern int nfs4_proc_create_session(struct nfs_client *, struct rpc_cred *);
extern int nfs4_proc_destroy_session(struct nfs4_session *, struct rpc_cred *);
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 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[3];
extern const u32 nfs4_statfs_bitmap[3];
extern const u32 nfs4_pathconf_bitmap[3];
extern const u32 nfs4_fsinfo_bitmap[3];
extern const u32 nfs4_fs_locations_bitmap[3];

void nfs40_shutdown_client(struct nfs_client *);
void nfs41_shutdown_client(struct nfs_client *);
int nfs40_init_client(struct nfs_client *);
int nfs41_init_client(struct nfs_client *);
void nfs4_free_client(struct nfs_client *);

struct nfs_client *nfs4_alloc_client(const struct nfs_client_initdata *);

/* 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_clid_cred(struct nfs_client *clp);
struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
struct rpc_cred *nfs4_get_renew_cred_locked(struct nfs_client *clp);
int nfs4_discover_server_trunking(struct nfs_client *clp,
			struct nfs_client **);
int nfs40_discover_server_trunking(struct nfs_client *clp,
			struct nfs_client **, struct rpc_cred *);
#if defined(CONFIG_NFS_V4_1)
int nfs41_discover_server_trunking(struct nfs_client *clp,
			struct nfs_client **, struct rpc_cred *);
extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
extern void nfs41_server_notify_target_slotid_update(struct nfs_client *clp);
extern void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp);

#else
static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
{
}
#endif /* CONFIG_NFS_V4_1 */

extern struct nfs4_state_owner *nfs4_get_state_owner(struct nfs_server *, struct rpc_cred *, gfp_t);
extern void nfs4_put_state_owner(struct nfs4_state_owner *);
extern void nfs4_purge_state_owners(struct nfs_server *);
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 nfs_inode_find_state_and_recover(struct inode *inode,
		const nfs4_stateid *stateid);
extern void nfs4_schedule_lease_recovery(struct nfs_client *);
extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
extern void nfs4_schedule_state_manager(struct nfs_client *);
extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
extern int 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_server_scope(struct nfs_client *,
				      struct nfs41_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 int nfs4_select_rw_stateid(nfs4_stateid *, struct nfs4_state *,
		fmode_t, const struct nfs_lockowner *);

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 void nfs4_free_lock_state(struct nfs_server *server, struct nfs4_lock_state *lsp);

extern const nfs4_stateid zero_stateid;

/* nfs4super.c */
struct nfs_mount_info;
extern struct nfs_subversion nfs_v4;
struct dentry *nfs4_try_mount(int, const char *, struct nfs_mount_info *, struct nfs_subversion *);
extern bool nfs4_disable_idmapping;
extern unsigned short max_session_slots;
extern unsigned short send_implementation_id;
extern bool recover_lost_locks;

#define NFS4_CLIENT_ID_UNIQ_LEN		(64)
extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];

/* nfs4sysctl.c */
#ifdef CONFIG_SYSCTL
int nfs4_register_sysctl(void);
void nfs4_unregister_sysctl(void);
#else
static inline int nfs4_register_sysctl(void)
{
	return 0;
}

static inline void nfs4_unregister_sysctl(void)
{
}
#endif

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

static inline void nfs4_stateid_copy(nfs4_stateid *dst, const nfs4_stateid *src)
{
	memcpy(dst, src, sizeof(*dst));
}

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

static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
{
	return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
}

#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
89d77c8f	12	#if IS_ENABLED(CONFIG_NFS_V4)
4ce79717	13
33021279 TM	14	#define NFS4_MAX_LOOP_ON_RECOVER (10)
33021279 TM	15
c137afab TM	16	#include <linux/seqlock.h>
c137afab TM	17
4ce79717 TM	18	struct idmap;
4ce79717 TM	19
4ce79717	20	enum nfs4_client_state {
e005e804	21	NFS4CLNT_MANAGER_RUNNING = 0,
e598d843	22	NFS4CLNT_CHECK_LEASE,
58d9714a	23	NFS4CLNT_LEASE_EXPIRED,
b79a4a1b TM	24	NFS4CLNT_RECLAIM_REBOOT,
b79a4a1b TM	25	NFS4CLNT_RECLAIM_NOGRACE,
707fb4b3	26	NFS4CLNT_DELEGRETURN,
6df08189	27	NFS4CLNT_SESSION_RESET,
fd954ae1	28	NFS4CLNT_LEASE_CONFIRM,
78fe0f41	29	NFS4CLNT_SERVER_SCOPE_MISMATCH,
2c820d9a	30	NFS4CLNT_PURGE_STATE,
a9e64442	31	NFS4CLNT_BIND_CONN_TO_SESSION,
4ce79717 TM	32	};
4ce79717 TM	33
2f60ea6b TM	34	#define NFS4_RENEW_TIMEOUT 0x01
	35	#define NFS4_RENEW_DELEGATION_CB 0x02
	36
97dc1359 TM	37	struct nfs4_minor_version_ops {
97dc1359 TM	38	u32 minor_version;
39c6daae	39	unsigned init_caps;
97dc1359	40
abf79bb3 CL	41	int (init_client)(struct nfs_client );
abf79bb3 CL	42	void (shutdown_client)(struct nfs_client );
36281caa	43	bool (match_stateid)(const nfs4_stateid ,
e047a10c	44	const nfs4_stateid *);
fca78d6d BS	45	int (find_root_sec)(struct nfs_server , struct nfs_fh *,
fca78d6d BS	46	struct nfs_fsinfo *);
c8b2d0bf TM	47	int (free_lock_state)(struct nfs_server ,
c8b2d0bf TM	48	struct nfs4_lock_state *);
9915ea7e	49	const struct rpc_call_ops *call_sync_ops;
c48f4f35 TM	50	const struct nfs4_state_recovery_ops *reboot_recovery_ops;
	51	const struct nfs4_state_recovery_ops *nograce_recovery_ops;
	52	const struct nfs4_state_maintenance_ops *state_renewal_ops;
97dc1359 TM	53	};
97dc1359 TM	54
cee54fc9 TM	55	#define NFS_SEQID_CONFIRMED 1
cee54fc9 TM	56	struct nfs_seqid_counter {
95b72eb0	57	ktime_t create_time;
48c22eb2	58	int owner_id;
cee54fc9 TM	59	int flags;
cee54fc9 TM	60	u32 counter;
7ba127ab TM	61	spinlock_t lock; /* Protects the list */
	62	struct list_head list; /* Defines sequence of RPC calls */
	63	struct rpc_wait_queue wait; /* RPC call delay queue */
cee54fc9 TM	64	};
	65
	66	struct nfs_seqid {
cee54fc9	67	struct nfs_seqid_counter *sequence;
4e51336a	68	struct list_head list;
4601df20	69	struct rpc_task *task;
cee54fc9 TM	70	};
	71
	72	static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
	73	{
	74	if (seqid_mutating_err(-status))
	75	seqid->flags \|= NFS_SEQID_CONFIRMED;
	76	}
	77
4ce79717 TM	78	/*
	79	* NFS4 state_owners and lock_owners are simply labels for ordered
	80	* sequences of RPC calls. Their sole purpose is to provide once-only
	81	* semantics by allowing the server to identify replayed requests.
4ce79717 TM	82	*/
4ce79717 TM	83	struct nfs4_state_owner {
6f2e64d3	84	struct nfs_server *so_server;
0aaaf5c4 CL	85	struct list_head so_lru;
0aaaf5c4 CL	86	unsigned long so_expires;
24d292b8	87	struct rb_node so_server_node;
4ce79717 TM	88
4ce79717 TM	89	struct rpc_cred so_cred; / Associated cred */
9f958ab8 TM	90
	91	spinlock_t so_lock;
	92	atomic_t so_count;
7eff03ae	93	unsigned long so_flags;
4ce79717	94	struct list_head so_states;
cee54fc9	95	struct nfs_seqid_counter so_seqid;
c137afab	96	seqcount_t so_reclaim_seqcount;
65b62a29	97	struct mutex so_delegreturn_mutex;
4ce79717 TM	98	};
4ce79717 TM	99
7eff03ae TM	100	enum {
	101	NFS_OWNER_RECLAIM_REBOOT,
	102	NFS_OWNER_RECLAIM_NOGRACE
	103	};
	104
afe6c27c AB	105	#define NFS_LOCK_NEW 0
	106	#define NFS_LOCK_RECLAIM 1
	107	#define NFS_LOCK_EXPIRED 2
	108
4ce79717 TM	109	/*
	110	* struct nfs4_state maintains the client-side state for a given
	111	* (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
	112	*
	113	* OPEN:
	114	* In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
	115	* we need to know how many files are open for reading or writing on a
	116	* given inode. This information too is stored here.
	117	*
	118	* LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
	119	*/
	120
77041ed9 TM	121	struct nfs4_lock_owner {
	122	unsigned int lo_type;
	123	#define NFS4_ANY_LOCK_TYPE (0U)
	124	#define NFS4_FLOCK_LOCK_TYPE (1U << 0)
	125	#define NFS4_POSIX_LOCK_TYPE (1U << 1)
	126	union {
	127	fl_owner_t posix_owner;
	128	pid_t flock_owner;
	129	} lo_u;
	130	};
	131
4ce79717 TM	132	struct nfs4_lock_state {
4ce79717 TM	133	struct list_head ls_locks; /* Other lock stateids */
8d0a8a9d	134	struct nfs4_state * ls_state; /* Pointer to open state */
795a88c9	135	#define NFS_LOCK_INITIALIZED 0
ef1820f9	136	#define NFS_LOCK_LOST 1
795a88c9	137	unsigned long ls_flags;
cee54fc9	138	struct nfs_seqid_counter ls_seqid;
4ce79717 TM	139	nfs4_stateid ls_stateid;
4ce79717 TM	140	atomic_t ls_count;
77041ed9	141	struct nfs4_lock_owner ls_owner;
4ce79717 TM	142	};
	143
	144	/* bits for nfs4_state->flags */
	145	enum {
	146	LK_STATE_IN_USE,
003707c7	147	NFS_DELEGATED_STATE, /* Current stateid is delegation */
92b40e93	148	NFS_OPEN_STATE, /* OPEN stateid is set */
003707c7 TM	149	NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
	150	NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
	151	NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
b79a4a1b TM	152	NFS_STATE_RECLAIM_REBOOT, /* OPEN stateid server rebooted */
b79a4a1b TM	153	NFS_STATE_RECLAIM_NOGRACE, /* OPEN stateid needs to recover state */
8e469ebd	154	NFS_STATE_POSIX_LOCKS, /* Posix locks are supported */
5d422301	155	NFS_STATE_RECOVERY_FAILED, /* OPEN stateid state recovery failed */
4ce79717 TM	156	};
	157
	158	struct nfs4_state {
	159	struct list_head open_states; /* List of states for the same state_owner */
	160	struct list_head inode_states; /* List of states for the same inode */
	161	struct list_head lock_states; /* List of subservient lock stateids */
	162
	163	struct nfs4_state_owner owner; / Pointer to the open owner */
	164	struct inode inode; / Pointer to the inode */
	165
	166	unsigned long flags; /* Do we hold any locks? */
8d0a8a9d	167	spinlock_t state_lock; /* Protects the lock_states list */
4ce79717	168
8bda4e4c	169	seqlock_t seqlock; /* Protects the stateid/open_stateid */
003707c7 TM	170	nfs4_stateid stateid; /* Current stateid: may be delegation */
003707c7 TM	171	nfs4_stateid open_stateid; /* OPEN stateid */
4ce79717	172
8bda4e4c	173	/* The following 3 fields are protected by owner->so_lock */
003707c7 TM	174	unsigned int n_rdonly; /* Number of read-only references */
	175	unsigned int n_wronly; /* Number of write-only references */
	176	unsigned int n_rdwr; /* Number of read/write references */
dc0b027d	177	fmode_t state; /* State on the server (R,W, or RW) */
4ce79717 TM	178	atomic_t count;
	179	};
	180
	181
	182	struct nfs4_exception {
	183	long timeout;
	184	int retry;
9e33bed5	185	struct nfs4_state *state;
3114ea7a	186	struct inode *inode;
4ce79717 TM	187	};
	188
	189	struct nfs4_state_recovery_ops {
7eff03ae	190	int owner_flag_bit;
b79a4a1b	191	int state_flag_bit;
4ce79717 TM	192	int (recover_open)(struct nfs4_state_owner , struct nfs4_state *);
4ce79717 TM	193	int (recover_lock)(struct nfs4_state , struct file_lock *);
591d71cb	194	int (establish_clid)(struct nfs_client , struct rpc_cred *);
965e9c23	195	int (reclaim_complete)(struct nfs_client , struct rpc_cred *);
05f4c350 CL	196	int (detect_trunking)(struct nfs_client , struct nfs_client **,
05f4c350 CL	197	struct rpc_cred *);
4ce79717 TM	198	};
4ce79717 TM	199
29fba38b	200	struct nfs4_state_maintenance_ops {
2f60ea6b	201	int (sched_state_renewal)(struct nfs_client , struct rpc_cred *, unsigned);
a7b72103	202	struct rpc_cred * (get_state_renewal_cred_locked)(struct nfs_client );
8e69514f	203	int (renew_lease)(struct nfs_client , struct rpc_cred *);
29fba38b BH	204	};
29fba38b BH	205
f786aa90	206	extern const struct dentry_operations nfs4_dentry_operations;
73a79706 BS	207
	208	/* dir.c */
	209	int nfs_atomic_open(struct inode , struct dentry , struct file *,
	210	unsigned, umode_t, int *);
6b3b5496	211
1ae811ee	212	/* super.c */
	213	extern struct file_system_type nfs4_fs_type;
	214
72de53ec	215	/* nfs4namespace.c */
2671bfc3	216	rpc_authflavor_t nfs_find_best_sec(struct nfs4_secinfo_flavors *);
72de53ec	217	struct rpc_clnt nfs4_create_sec_client(struct rpc_clnt , struct inode , struct qstr );
281cad46 BS	218	struct vfsmount nfs4_submount(struct nfs_server , struct dentry *,
281cad46 BS	219	struct nfs_fh , struct nfs_fattr );
72de53ec	220
4ce79717	221	/* nfs4proc.c */
bb8b27e5 TM	222	extern int nfs4_proc_setclientid(struct nfs_client , u32, unsigned short, struct rpc_cred , struct nfs4_setclientid_res *);
bb8b27e5 TM	223	extern int nfs4_proc_setclientid_confirm(struct nfs_client , struct nfs4_setclientid_res arg, struct rpc_cred *);
3028eb2b	224	extern int nfs4_proc_get_rootfh(struct nfs_server , struct nfs_fh , struct nfs_fsinfo *);
2cf047c9	225	extern int nfs4_proc_bind_conn_to_session(struct nfs_client , struct rpc_cred cred);
4d643d1d	226	extern int nfs4_proc_exchange_id(struct nfs_client clp, struct rpc_cred cred);
66245539	227	extern int nfs4_destroy_clientid(struct nfs_client *clp);
591d71cb	228	extern int nfs4_init_clientid(struct nfs_client , struct rpc_cred );
4d643d1d	229	extern int nfs41_init_clientid(struct nfs_client , struct rpc_cred );
1f7977c1	230	extern int nfs4_do_close(struct nfs4_state *state, gfp_t gfp_mask, int wait);
55a97593	231	extern int nfs4_server_capabilities(struct nfs_server server, struct nfs_fh fhandle);
f05d147f BS	232	extern int nfs4_proc_fs_locations(struct rpc_clnt , struct inode , const struct qstr *,
	233	struct nfs4_fs_locations , struct page );
	234	extern struct rpc_clnt nfs4_proc_lookup_mountpoint(struct inode , struct qstr *,
	235	struct nfs_fh , struct nfs_fattr );
72de53ec	236	extern int nfs4_proc_secinfo(struct inode , const struct qstr , struct nfs4_secinfo_flavors *);
64c2ce8b	237	extern const struct xattr_handler *nfs4_xattr_handlers[];
5521abfd	238	extern int nfs4_set_rw_stateid(nfs4_stateid *stateid,
9b206149 TM	239	const struct nfs_open_context *ctx,
	240	const struct nfs_lock_context *l_ctx,
	241	fmode_t fmode);
4ce79717	242
557134a3	243	#if defined(CONFIG_NFS_V4_1)
035168ab TM	244	static inline struct nfs4_session nfs4_get_session(const struct nfs_server server)
	245	{
	246	return server->nfs_client->cl_session;
	247	}
	248
dc70d7b3 AA	249	extern int nfs41_setup_sequence(struct nfs4_session *session,
dc70d7b3 AA	250	struct nfs4_sequence_args args, struct nfs4_sequence_res res,
9d12b216	251	struct rpc_task *task);
848f5bda TM	252	extern int nfs4_proc_create_session(struct nfs_client , struct rpc_cred );
848f5bda TM	253	extern int nfs4_proc_destroy_session(struct nfs4_session , struct rpc_cred );
9430fb6b RL	254	extern int nfs4_proc_get_lease_time(struct nfs_client *clp,
9430fb6b RL	255	struct nfs_fsinfo *fsinfo);
863a3c6c	256	extern int nfs4_proc_layoutcommit(struct nfs4_layoutcommit_data *data,
ef311537	257	bool sync);
94de8b27 AA	258
	259	static inline bool
	260	is_ds_only_client(struct nfs_client *clp)
	261	{
	262	return (clp->cl_exchange_flags & EXCHGID4_FLAG_MASK_PNFS) ==
	263	EXCHGID4_FLAG_USE_PNFS_DS;
	264	}
d83217c1 AA	265
	266	static inline bool
	267	is_ds_client(struct nfs_client *clp)
	268	{
	269	return clp->cl_exchange_flags & EXCHGID4_FLAG_USE_PNFS_DS;
	270	}
fbcd4abc	271	#else /* CONFIG_NFS_v4_1 */
035168ab TM	272	static inline struct nfs4_session nfs4_get_session(const struct nfs_server server)
	273	{
	274	return NULL;
	275	}
	276
94de8b27 AA	277	static inline bool
94de8b27 AA	278	is_ds_only_client(struct nfs_client *clp)
d83217c1 AA	279	{
	280	return false;
	281	}
	282
	283	static inline bool
	284	is_ds_client(struct nfs_client *clp)
94de8b27 AA	285	{
	286	return false;
	287	}
557134a3	288	#endif /* CONFIG_NFS_V4_1 */
4ce79717	289
97dc1359	290	extern const struct nfs4_minor_version_ops *nfs_v4_minor_ops[];
29fba38b	291
1549210f	292	extern const u32 nfs4_fattr_bitmap[3];
a09df2ca DQ	293	extern const u32 nfs4_statfs_bitmap[3];
a09df2ca DQ	294	extern const u32 nfs4_pathconf_bitmap[3];
dae100c2	295	extern const u32 nfs4_fsinfo_bitmap[3];
a09df2ca	296	extern const u32 nfs4_fs_locations_bitmap[3];
4ce79717	297
abf79bb3 CL	298	void nfs40_shutdown_client(struct nfs_client *);
	299	void nfs41_shutdown_client(struct nfs_client *);
	300	int nfs40_init_client(struct nfs_client *);
	301	int nfs41_init_client(struct nfs_client *);
cdb7eced BS	302	void nfs4_free_client(struct nfs_client *);
cdb7eced BS	303
6663ee7f BS	304	struct nfs_client nfs4_alloc_client(const struct nfs_client_initdata );
6663ee7f BS	305
4ce79717	306	/* nfs4renewd.c */
adfa6f98	307	extern void nfs4_schedule_state_renewal(struct nfs_client *);
4ce79717	308	extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
adfa6f98	309	extern void nfs4_kill_renewd(struct nfs_client *);
65f27f38	310	extern void nfs4_renew_state(struct work_struct *);
4ce79717 TM	311
4ce79717 TM	312	/* nfs4state.c */
73d8bde5	313	struct rpc_cred nfs4_get_clid_cred(struct nfs_client clp);
fe20d7d5	314	struct rpc_cred nfs4_get_machine_cred_locked(struct nfs_client clp);
6dc9d57a	315	struct rpc_cred nfs4_get_renew_cred_locked(struct nfs_client clp);
05f4c350 CL	316	int nfs4_discover_server_trunking(struct nfs_client *clp,
	317	struct nfs_client **);
	318	int nfs40_discover_server_trunking(struct nfs_client *clp,
	319	struct nfs_client *, struct rpc_cred );
a7b72103	320	#if defined(CONFIG_NFS_V4_1)
05f4c350 CL	321	int nfs41_discover_server_trunking(struct nfs_client *clp,
05f4c350 CL	322	struct nfs_client *, struct rpc_cred );
9f594791	323	extern void nfs4_schedule_session_recovery(struct nfs4_session *, int);
ac074835	324	extern void nfs41_server_notify_target_slotid_update(struct nfs_client *clp);
c10e4498	325	extern void nfs41_server_notify_highest_slotid_update(struct nfs_client *clp);
5d63360d	326
0400a6b0	327	#else
9f594791	328	static inline void nfs4_schedule_session_recovery(struct nfs4_session *session, int err)
0400a6b0 TM	329	{
0400a6b0 TM	330	}
a7b72103	331	#endif /* CONFIG_NFS_V4_1 */
4ce79717	332
d1e284d5	333	extern struct nfs4_state_owner nfs4_get_state_owner(struct nfs_server , struct rpc_cred *, gfp_t);
4ce79717	334	extern void nfs4_put_state_owner(struct nfs4_state_owner *);
0aaaf5c4	335	extern void nfs4_purge_state_owners(struct nfs_server *);
4ce79717 TM	336	extern struct nfs4_state * nfs4_get_open_state(struct inode , struct nfs4_state_owner );
4ce79717 TM	337	extern void nfs4_put_open_state(struct nfs4_state *);
643168c2 AV	338	extern void nfs4_close_state(struct nfs4_state *, fmode_t);
643168c2 AV	339	extern void nfs4_close_sync(struct nfs4_state *, fmode_t);
dc0b027d	340	extern void nfs4_state_set_mode_locked(struct nfs4_state *, fmode_t);
a1d0b5ee TM	341	extern void nfs_inode_find_state_and_recover(struct inode *inode,
a1d0b5ee TM	342	const nfs4_stateid *stateid);
0400a6b0	343	extern void nfs4_schedule_lease_recovery(struct nfs_client *);
33021279 TM	344	extern int nfs4_wait_clnt_recover(struct nfs_client *clp);
33021279 TM	345	extern int nfs4_client_recover_expired_lease(struct nfs_client *clp);
b0d3ded1	346	extern void nfs4_schedule_state_manager(struct nfs_client *);
042b60be	347	extern void nfs4_schedule_path_down_recovery(struct nfs_client *clp);
5d422301	348	extern int nfs4_schedule_stateid_recovery(const struct nfs_server , struct nfs4_state );
0629e370	349	extern void nfs41_handle_sequence_flag_errors(struct nfs_client *clp, u32 flags);
78fe0f41	350	extern void nfs41_handle_server_scope(struct nfs_client *,
79d4e1f0	351	struct nfs41_server_scope **);
faf5f49c	352	extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
8d0a8a9d	353	extern int nfs4_set_lock_state(struct nfs4_state state, struct file_lock fl);
5521abfd	354	extern int nfs4_select_rw_stateid(nfs4_stateid , struct nfs4_state ,
2a369153	355	fmode_t, const struct nfs_lockowner *);
4ce79717	356
8535b2be	357	extern struct nfs_seqid nfs_alloc_seqid(struct nfs_seqid_counter counter, gfp_t gfp_mask);
cee54fc9 TM	358	extern int nfs_wait_on_sequence(struct nfs_seqid seqid, struct rpc_task task);
	359	extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
	360	extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
72211dbe	361	extern void nfs_release_seqid(struct nfs_seqid *seqid);
cee54fc9 TM	362	extern void nfs_free_seqid(struct nfs_seqid *seqid);
cee54fc9 TM	363
5ae67c4f	364	extern void nfs4_free_lock_state(struct nfs_server server, struct nfs4_lock_state lsp);
cf470c3e	365
4ce79717 TM	366	extern const nfs4_stateid zero_stateid;
4ce79717 TM	367
129d1977	368	/* nfs4super.c */
fbdefd64	369	struct nfs_mount_info;
ab7017a3	370	extern struct nfs_subversion nfs_v4;
ff9099f2	371	struct dentry nfs4_try_mount(int, const char , struct nfs_mount_info , struct nfs_subversion );
fac1e8e4 BS	372	extern bool nfs4_disable_idmapping;
	373	extern unsigned short max_session_slots;
	374	extern unsigned short send_implementation_id;
f6de7a39	375	extern bool recover_lost_locks;
89d77c8f	376
6f2ea7f2 CL	377	#define NFS4_CLIENT_ID_UNIQ_LEN (64)
	378	extern char nfs4_client_id_uniquifier[NFS4_CLIENT_ID_UNIQ_LEN];
	379
466bfe7f BS	380	/* nfs4sysctl.c */
	381	#ifdef CONFIG_SYSCTL
	382	int nfs4_register_sysctl(void);
	383	void nfs4_unregister_sysctl(void);
	384	#else
	385	static inline int nfs4_register_sysctl(void)
	386	{
	387	return 0;
	388	}
	389
0add3e85	390	static inline void nfs4_unregister_sysctl(void)
466bfe7f BS	391	{
	392	}
	393	#endif
	394
4ce79717	395	/* nfs4xdr.c */
4ce79717 TM	396	extern struct rpc_procinfo nfs4_procedures[];
	397
	398	struct nfs4_mount_data;
	399
	400	/* callback_xdr.c */
	401	extern struct svc_version nfs4_callback_version1;
07bccc2d	402	extern struct svc_version nfs4_callback_version4;
4ce79717	403
f597c537 TM	404	static inline void nfs4_stateid_copy(nfs4_stateid dst, const nfs4_stateid src)
f597c537 TM	405	{
2d2f24ad	406	memcpy(dst, src, sizeof(*dst));
f597c537 TM	407	}
	408
	409	static inline bool nfs4_stateid_match(const nfs4_stateid dst, const nfs4_stateid src)
	410	{
2d2f24ad	411	return memcmp(dst, src, sizeof(*dst)) == 0;
f597c537 TM	412	}
f597c537 TM	413
5d422301 TM	414	static inline bool nfs4_valid_open_stateid(const struct nfs4_state *state)
	415	{
	416	return test_bit(NFS_STATE_RECOVERY_FAILED, &state->flags) == 0;
	417	}
	418
4ce79717 TM	419	#else
4ce79717 TM	420
643168c2 AV	421	#define nfs4_close_state(a, b) do { } while (0)
643168c2 AV	422	#define nfs4_close_sync(a, b) do { } while (0)
4ce79717 TM	423
	424	#endif /* CONFIG_NFS_V4 */
	425	#endif /* __LINUX_FS_NFS_NFS4_FS.H */