[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)

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;

	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);
	bool	(*match_stateid)(const nfs4_stateid *,
			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;
};

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

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
	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_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 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 *);
	struct rpc_cred * (*get_clid_cred)(struct nfs_client *);
	int (*reclaim_complete)(struct nfs_client *);
	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 int nfs4_release_lockowner(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 bool nfs4_set_task_privileged(struct rpc_task *task, void *dummy);
extern int nfs4_setup_sequence(const struct nfs_server *server,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
		struct rpc_task *task);
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 int nfs4_setup_sequence(const struct nfs_server *server,
		struct nfs4_sequence_args *args, struct nfs4_sequence_res *res,
		struct rpc_task *task)
{
	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[3];
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];

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_setclientid_cred(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)
struct rpc_cred *nfs4_get_machine_cred_locked(struct nfs_client *clp);
struct rpc_cred *nfs4_get_exchange_id_cred(struct nfs_client *clp);
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);

#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 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_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 void 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;

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

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