[people/ms/linux.git] / fs / ocfs2 / dlmglue.h

/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * dlmglue.h
 *
 * description here
 *
 * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
 */


#ifndef DLMGLUE_H
#define DLMGLUE_H

#include "dcache.h"

#define OCFS2_LVB_VERSION 5

struct ocfs2_meta_lvb {
	__u8         lvb_version;
	__u8         lvb_reserved0;
	__be16       lvb_idynfeatures;
	__be32       lvb_iclusters;
	__be32       lvb_iuid;
	__be32       lvb_igid;
	__be64       lvb_iatime_packed;
	__be64       lvb_ictime_packed;
	__be64       lvb_imtime_packed;
	__be64       lvb_isize;
	__be16       lvb_imode;
	__be16       lvb_inlink;
	__be32       lvb_iattr;
	__be32       lvb_igeneration;
	__be32       lvb_reserved2;
};

#define OCFS2_QINFO_LVB_VERSION 1

struct ocfs2_qinfo_lvb {
	__u8	lvb_version;
	__u8	lvb_reserved[3];
	__be32	lvb_bgrace;
	__be32	lvb_igrace;
	__be32	lvb_syncms;
	__be32	lvb_blocks;
	__be32	lvb_free_blk;
	__be32	lvb_free_entry;
};

#define OCFS2_ORPHAN_LVB_VERSION 1

struct ocfs2_orphan_scan_lvb {
	__u8	lvb_version;
	__u8	lvb_reserved[3];
	__be32	lvb_os_seqno;
};

#define OCFS2_TRIMFS_LVB_VERSION 1

struct ocfs2_trim_fs_lvb {
	__u8	lvb_version;
	__u8	lvb_success;
	__u8	lvb_reserved[2];
	__be32	lvb_nodenum;
	__be64	lvb_start;
	__be64	lvb_len;
	__be64	lvb_minlen;
	__be64	lvb_trimlen;
};

struct ocfs2_trim_fs_info {
	u8	tf_valid;	/* lvb is valid, or not */
	u8	tf_success;	/* trim is successful, or not */
	u32	tf_nodenum;	/* osb node number */
	u64	tf_start;	/* trim start offset in clusters */
	u64	tf_len;		/* trim end offset in clusters */
	u64	tf_minlen;	/* trim minimum contiguous free clusters */
	u64	tf_trimlen;	/* trimmed length in bytes */
};

struct ocfs2_lock_holder {
	struct list_head oh_list;
	struct pid *oh_owner_pid;
	int oh_ex;
};

/* ocfs2_inode_lock_full() 'arg_flags' flags */
/* don't wait on recovery. */
#define OCFS2_META_LOCK_RECOVERY	(0x01)
/* Instruct the dlm not to queue ourselves on the other node. */
#define OCFS2_META_LOCK_NOQUEUE		(0x02)
/* don't block waiting for the downconvert thread, instead return -EAGAIN */
#define OCFS2_LOCK_NONBLOCK		(0x04)
/* just get back disk inode bh if we've got cluster lock. */
#define OCFS2_META_LOCK_GETBH		(0x08)

/* Locking subclasses of inode cluster lock */
enum {
	OI_LS_NORMAL = 0,
	OI_LS_PARENT,
	OI_LS_RENAME1,
	OI_LS_RENAME2,
	OI_LS_REFLINK_TARGET,
};

int ocfs2_dlm_init(struct ocfs2_super *osb);
void ocfs2_dlm_shutdown(struct ocfs2_super *osb, int hangup_pending);
void ocfs2_lock_res_init_once(struct ocfs2_lock_res *res);
void ocfs2_inode_lock_res_init(struct ocfs2_lock_res *res,
			       enum ocfs2_lock_type type,
			       unsigned int generation,
			       struct inode *inode);
void ocfs2_dentry_lock_res_init(struct ocfs2_dentry_lock *dl,
				u64 parent, struct inode *inode);
struct ocfs2_file_private;
void ocfs2_file_lock_res_init(struct ocfs2_lock_res *lockres,
			      struct ocfs2_file_private *fp);
struct ocfs2_mem_dqinfo;
void ocfs2_qinfo_lock_res_init(struct ocfs2_lock_res *lockres,
                               struct ocfs2_mem_dqinfo *info);
void ocfs2_refcount_lock_res_init(struct ocfs2_lock_res *lockres,
				  struct ocfs2_super *osb, u64 ref_blkno,
				  unsigned int generation);
void ocfs2_lock_res_free(struct ocfs2_lock_res *res);
int ocfs2_create_new_inode_locks(struct inode *inode);
int ocfs2_drop_inode_locks(struct inode *inode);
int ocfs2_rw_lock(struct inode *inode, int write);
int ocfs2_try_rw_lock(struct inode *inode, int write);
void ocfs2_rw_unlock(struct inode *inode, int write);
int ocfs2_open_lock(struct inode *inode);
int ocfs2_try_open_lock(struct inode *inode, int write);
void ocfs2_open_unlock(struct inode *inode);
int ocfs2_inode_lock_atime(struct inode *inode,
			  struct vfsmount *vfsmnt,
			  int *level, int wait);
int ocfs2_inode_lock_full_nested(struct inode *inode,
			 struct buffer_head **ret_bh,
			 int ex,
			 int arg_flags,
			 int subclass);
int ocfs2_inode_lock_with_page(struct inode *inode,
			      struct buffer_head **ret_bh,
			      int ex,
			      struct page *page);
/* Variants without special locking class or flags */
#define ocfs2_inode_lock_full(i, r, e, f)\
		ocfs2_inode_lock_full_nested(i, r, e, f, OI_LS_NORMAL)
#define ocfs2_inode_lock_nested(i, b, e, s)\
		ocfs2_inode_lock_full_nested(i, b, e, 0, s)
/* 99% of the time we don't want to supply any additional flags --
 * those are for very specific cases only. */
#define ocfs2_inode_lock(i, b, e) ocfs2_inode_lock_full_nested(i, b, e, 0, OI_LS_NORMAL)
#define ocfs2_try_inode_lock(i, b, e)\
		ocfs2_inode_lock_full_nested(i, b, e, OCFS2_META_LOCK_NOQUEUE,\
		OI_LS_NORMAL)
void ocfs2_inode_unlock(struct inode *inode,
		       int ex);
int ocfs2_super_lock(struct ocfs2_super *osb,
		     int ex);
void ocfs2_super_unlock(struct ocfs2_super *osb,
			int ex);
int ocfs2_orphan_scan_lock(struct ocfs2_super *osb, u32 *seqno);
void ocfs2_orphan_scan_unlock(struct ocfs2_super *osb, u32 seqno);

int ocfs2_rename_lock(struct ocfs2_super *osb);
void ocfs2_rename_unlock(struct ocfs2_super *osb);
int ocfs2_nfs_sync_lock(struct ocfs2_super *osb, int ex);
void ocfs2_nfs_sync_unlock(struct ocfs2_super *osb, int ex);
void ocfs2_trim_fs_lock_res_init(struct ocfs2_super *osb);
void ocfs2_trim_fs_lock_res_uninit(struct ocfs2_super *osb);
int ocfs2_trim_fs_lock(struct ocfs2_super *osb,
		       struct ocfs2_trim_fs_info *info, int trylock);
void ocfs2_trim_fs_unlock(struct ocfs2_super *osb,
			  struct ocfs2_trim_fs_info *info);
int ocfs2_dentry_lock(struct dentry *dentry, int ex);
void ocfs2_dentry_unlock(struct dentry *dentry, int ex);
int ocfs2_file_lock(struct file *file, int ex, int trylock);
void ocfs2_file_unlock(struct file *file);
int ocfs2_qinfo_lock(struct ocfs2_mem_dqinfo *oinfo, int ex);
void ocfs2_qinfo_unlock(struct ocfs2_mem_dqinfo *oinfo, int ex);
struct ocfs2_refcount_tree;
int ocfs2_refcount_lock(struct ocfs2_refcount_tree *ref_tree, int ex);
void ocfs2_refcount_unlock(struct ocfs2_refcount_tree *ref_tree, int ex);


void ocfs2_mark_lockres_freeing(struct ocfs2_super *osb,
				struct ocfs2_lock_res *lockres);
void ocfs2_simple_drop_lockres(struct ocfs2_super *osb,
			       struct ocfs2_lock_res *lockres);

/* for the downconvert thread */
void ocfs2_wake_downconvert_thread(struct ocfs2_super *osb);

struct ocfs2_dlm_debug *ocfs2_new_dlm_debug(void);
void ocfs2_put_dlm_debug(struct ocfs2_dlm_debug *dlm_debug);

/* To set the locking protocol on module initialization */
void ocfs2_set_locking_protocol(void);

/* The _tracker pair is used to avoid cluster recursive locking */
int ocfs2_inode_lock_tracker(struct inode *inode,
			     struct buffer_head **ret_bh,
			     int ex,
			     struct ocfs2_lock_holder *oh);
void ocfs2_inode_unlock_tracker(struct inode *inode,
				int ex,
				struct ocfs2_lock_holder *oh,
				int had_lock);

#endif	/* DLMGLUE_H */
Commit	Line	Data
328970de	1	/* SPDX-License-Identifier: GPL-2.0-or-later */
fa60ce2c	2	/*
ccd979bd MF	3	* dlmglue.h
	4	*
	5	* description here
	6	*
	7	* Copyright (C) 2002, 2004 Oracle. All rights reserved.
ccd979bd MF	8	*/
	9
	10
	11	#ifndef DLMGLUE_H
	12	#define DLMGLUE_H
	13
d680efe9 MF	14	#include "dcache.h"
d680efe9 MF	15
15b1e36b	16	#define OCFS2_LVB_VERSION 5
ccd979bd MF	17
ccd979bd MF	18	struct ocfs2_meta_lvb {
4d3b83f7	19	__u8 lvb_version;
24c19ef4	20	__u8 lvb_reserved0;
15b1e36b	21	__be16 lvb_idynfeatures;
ccd979bd MF	22	__be32 lvb_iclusters;
	23	__be32 lvb_iuid;
	24	__be32 lvb_igid;
	25	__be64 lvb_iatime_packed;
	26	__be64 lvb_ictime_packed;
	27	__be64 lvb_imtime_packed;
	28	__be64 lvb_isize;
	29	__be16 lvb_imode;
	30	__be16 lvb_inlink;
ca4d147e	31	__be32 lvb_iattr;
f9e2d82e MF	32	__be32 lvb_igeneration;
f9e2d82e MF	33	__be32 lvb_reserved2;
ccd979bd MF	34	};
ccd979bd MF	35
9e33d69f JK	36	#define OCFS2_QINFO_LVB_VERSION 1
	37
	38	struct ocfs2_qinfo_lvb {
	39	__u8 lvb_version;
	40	__u8 lvb_reserved[3];
	41	__be32 lvb_bgrace;
	42	__be32 lvb_igrace;
	43	__be32 lvb_syncms;
	44	__be32 lvb_blocks;
	45	__be32 lvb_free_blk;
	46	__be32 lvb_free_entry;
	47	};
	48
83273932 SE	49	#define OCFS2_ORPHAN_LVB_VERSION 1
	50
	51	struct ocfs2_orphan_scan_lvb {
	52	__u8 lvb_version;
	53	__u8 lvb_reserved[3];
	54	__be32 lvb_os_seqno;
	55	};
	56
4882abeb GH	57	#define OCFS2_TRIMFS_LVB_VERSION 1
	58
	59	struct ocfs2_trim_fs_lvb {
	60	__u8 lvb_version;
	61	__u8 lvb_success;
	62	__u8 lvb_reserved[2];
	63	__be32 lvb_nodenum;
	64	__be64 lvb_start;
	65	__be64 lvb_len;
	66	__be64 lvb_minlen;
	67	__be64 lvb_trimlen;
	68	};
	69
	70	struct ocfs2_trim_fs_info {
	71	u8 tf_valid; /* lvb is valid, or not */
	72	u8 tf_success; /* trim is successful, or not */
	73	u32 tf_nodenum; /* osb node number */
	74	u64 tf_start; /* trim start offset in clusters */
	75	u64 tf_len; /* trim end offset in clusters */
	76	u64 tf_minlen; /* trim minimum contiguous free clusters */
	77	u64 tf_trimlen; /* trimmed length in bytes */
	78	};
	79
439a36b8 ER	80	struct ocfs2_lock_holder {
	81	struct list_head oh_list;
	82	struct pid *oh_owner_pid;
133b81f2	83	int oh_ex;
439a36b8 ER	84	};
439a36b8 ER	85
e63aecb6	86	/* ocfs2_inode_lock_full() 'arg_flags' flags */
ccd979bd MF	87	/* don't wait on recovery. */
	88	#define OCFS2_META_LOCK_RECOVERY (0x01)
	89	/* Instruct the dlm not to queue ourselves on the other node. */
	90	#define OCFS2_META_LOCK_NOQUEUE (0x02)
34d024f8	91	/* don't block waiting for the downconvert thread, instead return -EAGAIN */
ccd979bd	92	#define OCFS2_LOCK_NONBLOCK (0x04)
439a36b8 ER	93	/* just get back disk inode bh if we've got cluster lock. */
439a36b8 ER	94	#define OCFS2_META_LOCK_GETBH (0x08)
ccd979bd	95
cb25797d JK	96	/* Locking subclasses of inode cluster lock */
	97	enum {
	98	OI_LS_NORMAL = 0,
	99	OI_LS_PARENT,
	100	OI_LS_RENAME1,
	101	OI_LS_RENAME2,
07eaac94	102	OI_LS_REFLINK_TARGET,
cb25797d JK	103	};
cb25797d JK	104
ccd979bd	105	int ocfs2_dlm_init(struct ocfs2_super *osb);
286eaa95	106	void ocfs2_dlm_shutdown(struct ocfs2_super *osb, int hangup_pending);
ccd979bd MF	107	void ocfs2_lock_res_init_once(struct ocfs2_lock_res *res);
	108	void ocfs2_inode_lock_res_init(struct ocfs2_lock_res *res,
	109	enum ocfs2_lock_type type,
24c19ef4	110	unsigned int generation,
ccd979bd	111	struct inode *inode);
d680efe9 MF	112	void ocfs2_dentry_lock_res_init(struct ocfs2_dentry_lock *dl,
d680efe9 MF	113	u64 parent, struct inode *inode);
cf8e06f1 MF	114	struct ocfs2_file_private;
	115	void ocfs2_file_lock_res_init(struct ocfs2_lock_res *lockres,
	116	struct ocfs2_file_private *fp);
9e33d69f JK	117	struct ocfs2_mem_dqinfo;
	118	void ocfs2_qinfo_lock_res_init(struct ocfs2_lock_res *lockres,
	119	struct ocfs2_mem_dqinfo *info);
8dec98ed TM	120	void ocfs2_refcount_lock_res_init(struct ocfs2_lock_res *lockres,
	121	struct ocfs2_super *osb, u64 ref_blkno,
	122	unsigned int generation);
ccd979bd MF	123	void ocfs2_lock_res_free(struct ocfs2_lock_res *res);
	124	int ocfs2_create_new_inode_locks(struct inode *inode);
	125	int ocfs2_drop_inode_locks(struct inode *inode);
ccd979bd	126	int ocfs2_rw_lock(struct inode *inode, int write);
06e7f13d	127	int ocfs2_try_rw_lock(struct inode *inode, int write);
ccd979bd	128	void ocfs2_rw_unlock(struct inode *inode, int write);
50008630 TY	129	int ocfs2_open_lock(struct inode *inode);
	130	int ocfs2_try_open_lock(struct inode *inode, int write);
	131	void ocfs2_open_unlock(struct inode *inode);
e63aecb6	132	int ocfs2_inode_lock_atime(struct inode *inode,
7f1a37e3	133	struct vfsmount *vfsmnt,
c4c2416a	134	int *level, int wait);
cb25797d	135	int ocfs2_inode_lock_full_nested(struct inode *inode,
ccd979bd MF	136	struct buffer_head **ret_bh,
ccd979bd MF	137	int ex,
cb25797d JK	138	int arg_flags,
cb25797d JK	139	int subclass);
e63aecb6	140	int ocfs2_inode_lock_with_page(struct inode *inode,
ccd979bd MF	141	struct buffer_head **ret_bh,
	142	int ex,
	143	struct page *page);
cb25797d JK	144	/* Variants without special locking class or flags */
	145	#define ocfs2_inode_lock_full(i, r, e, f)\
	146	ocfs2_inode_lock_full_nested(i, r, e, f, OI_LS_NORMAL)
	147	#define ocfs2_inode_lock_nested(i, b, e, s)\
	148	ocfs2_inode_lock_full_nested(i, b, e, 0, s)
ccd979bd MF	149	/* 99% of the time we don't want to supply any additional flags --
ccd979bd MF	150	* those are for very specific cases only. */
cb25797d	151	#define ocfs2_inode_lock(i, b, e) ocfs2_inode_lock_full_nested(i, b, e, 0, OI_LS_NORMAL)
06e7f13d GH	152	#define ocfs2_try_inode_lock(i, b, e)\
	153	ocfs2_inode_lock_full_nested(i, b, e, OCFS2_META_LOCK_NOQUEUE,\
	154	OI_LS_NORMAL)
e63aecb6	155	void ocfs2_inode_unlock(struct inode *inode,
ccd979bd MF	156	int ex);
	157	int ocfs2_super_lock(struct ocfs2_super *osb,
	158	int ex);
	159	void ocfs2_super_unlock(struct ocfs2_super *osb,
	160	int ex);
df152c24 SM	161	int ocfs2_orphan_scan_lock(struct ocfs2_super osb, u32 seqno);
df152c24 SM	162	void ocfs2_orphan_scan_unlock(struct ocfs2_super *osb, u32 seqno);
83273932	163
ccd979bd MF	164	int ocfs2_rename_lock(struct ocfs2_super *osb);
ccd979bd MF	165	void ocfs2_rename_unlock(struct ocfs2_super *osb);
6ca497a8	166	int ocfs2_nfs_sync_lock(struct ocfs2_super *osb, int ex);
6ca497a8	167	void ocfs2_nfs_sync_unlock(struct ocfs2_super *osb, int ex);
4882abeb GH	168	void ocfs2_trim_fs_lock_res_init(struct ocfs2_super *osb);
	169	void ocfs2_trim_fs_lock_res_uninit(struct ocfs2_super *osb);
	170	int ocfs2_trim_fs_lock(struct ocfs2_super *osb,
	171	struct ocfs2_trim_fs_info *info, int trylock);
	172	void ocfs2_trim_fs_unlock(struct ocfs2_super *osb,
	173	struct ocfs2_trim_fs_info *info);
d680efe9 MF	174	int ocfs2_dentry_lock(struct dentry *dentry, int ex);
d680efe9 MF	175	void ocfs2_dentry_unlock(struct dentry *dentry, int ex);
cf8e06f1 MF	176	int ocfs2_file_lock(struct file *file, int ex, int trylock);
cf8e06f1 MF	177	void ocfs2_file_unlock(struct file *file);
9e33d69f JK	178	int ocfs2_qinfo_lock(struct ocfs2_mem_dqinfo *oinfo, int ex);
9e33d69f JK	179	void ocfs2_qinfo_unlock(struct ocfs2_mem_dqinfo *oinfo, int ex);
8dec98ed TM	180	struct ocfs2_refcount_tree;
	181	int ocfs2_refcount_lock(struct ocfs2_refcount_tree *ref_tree, int ex);
	182	void ocfs2_refcount_unlock(struct ocfs2_refcount_tree *ref_tree, int ex);
9e33d69f	183
d680efe9	184
84d86f83 JK	185	void ocfs2_mark_lockres_freeing(struct ocfs2_super *osb,
84d86f83 JK	186	struct ocfs2_lock_res *lockres);
d680efe9 MF	187	void ocfs2_simple_drop_lockres(struct ocfs2_super *osb,
d680efe9 MF	188	struct ocfs2_lock_res *lockres);
ccd979bd	189
34d024f8	190	/* for the downconvert thread */
34d024f8	191	void ocfs2_wake_downconvert_thread(struct ocfs2_super *osb);
ccd979bd MF	192
	193	struct ocfs2_dlm_debug *ocfs2_new_dlm_debug(void);
	194	void ocfs2_put_dlm_debug(struct ocfs2_dlm_debug *dlm_debug);
	195
63e0c48a JB	196	/* To set the locking protocol on module initialization */
63e0c48a JB	197	void ocfs2_set_locking_protocol(void);
439a36b8 ER	198
	199	/* The _tracker pair is used to avoid cluster recursive locking */
	200	int ocfs2_inode_lock_tracker(struct inode *inode,
	201	struct buffer_head **ret_bh,
	202	int ex,
	203	struct ocfs2_lock_holder *oh);
	204	void ocfs2_inode_unlock_tracker(struct inode *inode,
	205	int ex,
	206	struct ocfs2_lock_holder *oh,
	207	int had_lock);
	208
ccd979bd	209	#endif /* DLMGLUE_H */