[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_STATE_RECOVER  = 0,
	NFS4CLNT_LEASE_EXPIRED,
};

/*
 * 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_client    *so_client;
	struct rb_node	     so_client_node;

	struct rpc_cred	     *so_cred;	 /* Associated cred */

	spinlock_t	     so_lock;
	atomic_t	     so_count;
	struct list_head     so_states;
	struct list_head     so_delegations;
	struct nfs_seqid_counter so_seqid;
	struct rpc_sequence  so_sequence;
};

/*
 * 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_state {
	struct list_head	ls_locks;	/* Other lock stateids */
	struct nfs4_state *	ls_state;	/* Pointer to open state */
	fl_owner_t		ls_owner;	/* POSIX lock owner */
#define NFS_LOCK_INITIALIZED 1
	int			ls_flags;
	struct nfs_seqid_counter	ls_seqid;
	struct nfs_unique_id	ls_id;
	nfs4_stateid		ls_stateid;
	atomic_t		ls_count;
};

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

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 */
	int state;			/* State on the server (R,W, or RW) */
	atomic_t count;
};


struct nfs4_exception {
	long timeout;
	int retry;
};

struct nfs4_state_recovery_ops {
	int (*recover_open)(struct nfs4_state_owner *, struct nfs4_state *);
	int (*recover_lock)(struct nfs4_state *, struct file_lock *);
};

extern struct dentry_operations nfs4_dentry_operations;
extern const struct inode_operations nfs4_dir_inode_operations;

/* inode.c */
extern ssize_t nfs4_getxattr(struct dentry *, const char *, void *, size_t);
extern int nfs4_setxattr(struct dentry *, const char *, const void *, size_t, int);
extern ssize_t nfs4_listxattr(struct dentry *, char *, size_t);


/* nfs4proc.c */
extern int nfs4_map_errors(int err);
extern int nfs4_proc_setclientid(struct nfs_client *, u32, unsigned short, struct rpc_cred *);
extern int nfs4_proc_setclientid_confirm(struct nfs_client *, struct rpc_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_do_close(struct path *path, struct nfs4_state *state);
extern struct dentry *nfs4_atomic_open(struct inode *, struct dentry *, struct nameidata *);
extern int nfs4_open_revalidate(struct inode *, struct dentry *, int, struct nameidata *);
extern int nfs4_server_capabilities(struct nfs_server *server, struct nfs_fh *fhandle);
extern int nfs4_proc_fs_locations(struct inode *dir, struct qstr *name,
		struct nfs4_fs_locations *fs_locations, struct page *page);

extern struct nfs4_state_recovery_ops nfs4_reboot_recovery_ops;
extern struct nfs4_state_recovery_ops nfs4_network_partition_recovery_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[2];
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_renew_cred(struct nfs_client *clp);

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 void nfs4_drop_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 path *, struct nfs4_state *, mode_t);
extern void nfs4_state_set_mode_locked(struct nfs4_state *, mode_t);
extern void nfs4_schedule_state_recovery(struct nfs_client *);
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);

extern struct nfs_seqid *nfs_alloc_seqid(struct nfs_seqid_counter *counter);
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_free_seqid(struct nfs_seqid *seqid);

extern const nfs4_stateid zero_stateid;

/* nfs4xdr.c */
extern __be32 *nfs4_decode_dirent(__be32 *p, struct nfs_entry *entry, int plus);
extern struct rpc_procinfo nfs4_procedures[];

struct nfs4_mount_data;

/* callback_xdr.c */
extern struct svc_version nfs4_callback_version1;

#else

#define nfs4_close_state(a, b, c) 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 {
433fbe4c	41	NFS4CLNT_STATE_RECOVER = 0,
58d9714a	42	NFS4CLNT_LEASE_EXPIRED,
4ce79717 TM	43	};
4ce79717 TM	44
cee54fc9 TM	45	/*
	46	* struct rpc_sequence ensures that RPC calls are sent in the exact
	47	* order that they appear on the list.
	48	*/
	49	struct rpc_sequence {
	50	struct rpc_wait_queue wait; /* RPC call delay queue */
	51	spinlock_t lock; /* Protects the list */
	52	struct list_head list; /* Defines sequence of RPC calls */
	53	};
	54
	55	#define NFS_SEQID_CONFIRMED 1
	56	struct nfs_seqid_counter {
	57	struct rpc_sequence *sequence;
	58	int flags;
	59	u32 counter;
	60	};
	61
	62	struct nfs_seqid {
cee54fc9	63	struct nfs_seqid_counter *sequence;
4e51336a	64	struct list_head list;
cee54fc9 TM	65	};
	66
	67	static inline void nfs_confirm_seqid(struct nfs_seqid_counter *seqid, int status)
	68	{
	69	if (seqid_mutating_err(-status))
	70	seqid->flags \|= NFS_SEQID_CONFIRMED;
	71	}
	72
9f958ab8 TM	73	struct nfs_unique_id {
	74	struct rb_node rb_node;
	75	__u64 id;
	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 {
9f958ab8	84	struct nfs_unique_id so_owner_id;
adfa6f98	85	struct nfs_client *so_client;
9f958ab8	86	struct rb_node so_client_node;
4ce79717 TM	87
4ce79717 TM	88	struct rpc_cred so_cred; / Associated cred */
9f958ab8 TM	89
	90	spinlock_t so_lock;
	91	atomic_t so_count;
4ce79717 TM	92	struct list_head so_states;
4ce79717 TM	93	struct list_head so_delegations;
cee54fc9 TM	94	struct nfs_seqid_counter so_seqid;
cee54fc9 TM	95	struct rpc_sequence so_sequence;
4ce79717 TM	96	};
	97
	98	/*
	99	* struct nfs4_state maintains the client-side state for a given
	100	* (state_owner,inode) tuple (OPEN) or state_owner (LOCK).
	101	*
	102	* OPEN:
	103	* In order to know when to OPEN_DOWNGRADE or CLOSE the state on the server,
	104	* we need to know how many files are open for reading or writing on a
	105	* given inode. This information too is stored here.
	106	*
	107	* LOCK: one nfs4_state (LOCK) to hold the lock stateid nfs4_state(OPEN)
	108	*/
	109
	110	struct nfs4_lock_state {
	111	struct list_head ls_locks; /* Other lock stateids */
8d0a8a9d	112	struct nfs4_state * ls_state; /* Pointer to open state */
4ce79717 TM	113	fl_owner_t ls_owner; /* POSIX lock owner */
	114	#define NFS_LOCK_INITIALIZED 1
	115	int ls_flags;
cee54fc9	116	struct nfs_seqid_counter ls_seqid;
9f958ab8	117	struct nfs_unique_id ls_id;
4ce79717 TM	118	nfs4_stateid ls_stateid;
	119	atomic_t ls_count;
	120	};
	121
	122	/* bits for nfs4_state->flags */
	123	enum {
	124	LK_STATE_IN_USE,
003707c7 TM	125	NFS_DELEGATED_STATE, /* Current stateid is delegation */
	126	NFS_O_RDONLY_STATE, /* OPEN stateid has read-only state */
	127	NFS_O_WRONLY_STATE, /* OPEN stateid has write-only state */
	128	NFS_O_RDWR_STATE, /* OPEN stateid has read/write state */
4ce79717 TM	129	};
	130
	131	struct nfs4_state {
	132	struct list_head open_states; /* List of states for the same state_owner */
	133	struct list_head inode_states; /* List of states for the same inode */
	134	struct list_head lock_states; /* List of subservient lock stateids */
	135
	136	struct nfs4_state_owner owner; / Pointer to the open owner */
	137	struct inode inode; / Pointer to the inode */
	138
	139	unsigned long flags; /* Do we hold any locks? */
8d0a8a9d	140	spinlock_t state_lock; /* Protects the lock_states list */
4ce79717	141
8bda4e4c	142	seqlock_t seqlock; /* Protects the stateid/open_stateid */
003707c7 TM	143	nfs4_stateid stateid; /* Current stateid: may be delegation */
003707c7 TM	144	nfs4_stateid open_stateid; /* OPEN stateid */
4ce79717	145
8bda4e4c	146	/* The following 3 fields are protected by owner->so_lock */
003707c7 TM	147	unsigned int n_rdonly; /* Number of read-only references */
	148	unsigned int n_wronly; /* Number of write-only references */
	149	unsigned int n_rdwr; /* Number of read/write references */
4ce79717 TM	150	int state; /* State on the server (R,W, or RW) */
	151	atomic_t count;
	152	};
	153
	154
	155	struct nfs4_exception {
	156	long timeout;
	157	int retry;
	158	};
	159
	160	struct nfs4_state_recovery_ops {
	161	int (recover_open)(struct nfs4_state_owner , struct nfs4_state *);
	162	int (recover_lock)(struct nfs4_state , struct file_lock *);
	163	};
	164
	165	extern struct dentry_operations nfs4_dentry_operations;
92e1d5be	166	extern const struct inode_operations nfs4_dir_inode_operations;
6b3b5496 BF	167
	168	/* inode.c */
	169	extern ssize_t nfs4_getxattr(struct dentry , const char , void *, size_t);
	170	extern int nfs4_setxattr(struct dentry , const char , const void *, size_t, int);
	171	extern ssize_t nfs4_listxattr(struct dentry , char , size_t);
	172
4ce79717 TM	173
	174	/* nfs4proc.c */
	175	extern int nfs4_map_errors(int err);
adfa6f98 DH	176	extern int nfs4_proc_setclientid(struct nfs_client , u32, unsigned short, struct rpc_cred );
	177	extern int nfs4_proc_setclientid_confirm(struct nfs_client , struct rpc_cred );
	178	extern int nfs4_proc_async_renew(struct nfs_client , struct rpc_cred );
	179	extern int nfs4_proc_renew(struct nfs_client , struct rpc_cred );
4a35bd41	180	extern int nfs4_do_close(struct path path, struct nfs4_state state);
02a913a7 TM	181	extern struct dentry nfs4_atomic_open(struct inode , struct dentry , struct nameidata );
02a913a7 TM	182	extern int nfs4_open_revalidate(struct inode , struct dentry , int, struct nameidata *);
55a97593	183	extern int nfs4_server_capabilities(struct nfs_server server, struct nfs_fh fhandle);
c228fd3a	184	extern int nfs4_proc_fs_locations(struct inode dir, struct qstr name,
7aaa0b3b	185	struct nfs4_fs_locations fs_locations, struct page page);
4ce79717 TM	186
	187	extern struct nfs4_state_recovery_ops nfs4_reboot_recovery_ops;
	188	extern struct nfs4_state_recovery_ops nfs4_network_partition_recovery_ops;
	189
	190	extern const u32 nfs4_fattr_bitmap[2];
	191	extern const u32 nfs4_statfs_bitmap[2];
	192	extern const u32 nfs4_pathconf_bitmap[2];
	193	extern const u32 nfs4_fsinfo_bitmap[2];
830b8e33	194	extern const u32 nfs4_fs_locations_bitmap[2];
4ce79717 TM	195
4ce79717 TM	196	/* nfs4renewd.c */
adfa6f98	197	extern void nfs4_schedule_state_renewal(struct nfs_client *);
4ce79717	198	extern void nfs4_renewd_prepare_shutdown(struct nfs_server *);
adfa6f98	199	extern void nfs4_kill_renewd(struct nfs_client *);
65f27f38	200	extern void nfs4_renew_state(struct work_struct *);
4ce79717 TM	201
4ce79717 TM	202	/* nfs4state.c */
adfa6f98	203	struct rpc_cred nfs4_get_renew_cred(struct nfs_client clp);
4ce79717 TM	204
	205	extern struct nfs4_state_owner * nfs4_get_state_owner(struct nfs_server , struct rpc_cred );
	206	extern void nfs4_put_state_owner(struct nfs4_state_owner *);
	207	extern void nfs4_drop_state_owner(struct nfs4_state_owner *);
	208	extern struct nfs4_state * nfs4_get_open_state(struct inode , struct nfs4_state_owner );
	209	extern void nfs4_put_open_state(struct nfs4_state *);
4a35bd41	210	extern void nfs4_close_state(struct path , struct nfs4_state , mode_t);
4cecb76f	211	extern void nfs4_state_set_mode_locked(struct nfs4_state *, mode_t);
adfa6f98	212	extern void nfs4_schedule_state_recovery(struct nfs_client *);
faf5f49c	213	extern void nfs4_put_lock_state(struct nfs4_lock_state *lsp);
8d0a8a9d	214	extern int nfs4_set_lock_state(struct nfs4_state state, struct file_lock fl);
4ce79717 TM	215	extern void nfs4_copy_stateid(nfs4_stateid , struct nfs4_state , fl_owner_t);
4ce79717 TM	216
cee54fc9 TM	217	extern struct nfs_seqid nfs_alloc_seqid(struct nfs_seqid_counter counter);
	218	extern int nfs_wait_on_sequence(struct nfs_seqid seqid, struct rpc_task task);
	219	extern void nfs_increment_open_seqid(int status, struct nfs_seqid *seqid);
	220	extern void nfs_increment_lock_seqid(int status, struct nfs_seqid *seqid);
	221	extern void nfs_free_seqid(struct nfs_seqid *seqid);
	222
4ce79717 TM	223	extern const nfs4_stateid zero_stateid;
	224
	225	/* nfs4xdr.c */
0dbb4c67	226	extern __be32 nfs4_decode_dirent(__be32 p, struct nfs_entry *entry, int plus);
4ce79717 TM	227	extern struct rpc_procinfo nfs4_procedures[];
	228
	229	struct nfs4_mount_data;
	230
	231	/* callback_xdr.c */
	232	extern struct svc_version nfs4_callback_version1;
	233
	234	#else
	235
4a35bd41	236	#define nfs4_close_state(a, b, c) do { } while (0)
4ce79717 TM	237
	238	#endif /* CONFIG_NFS_V4 */
	239	#endif /* __LINUX_FS_NFS_NFS4_FS.H */