[mirror_ubuntu-artful-kernel.git] / fs / ocfs2 / dlmglue.h

/* -*- mode: c; c-basic-offset: 8; -*-
 * vim: noexpandtab sw=8 ts=8 sts=0:
 *
 * dlmglue.h
 *
 * description here
 *
 * Copyright (C) 2002, 2004 Oracle.  All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 021110-1307, USA.
 */


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

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

/* 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);
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 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)
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);
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
ccd979bd MF	1	/* -- mode: c; c-basic-offset: 8; --
	2	* vim: noexpandtab sw=8 ts=8 sts=0:
	3	*
	4	* dlmglue.h
	5	*
	6	* description here
	7	*
	8	* Copyright (C) 2002, 2004 Oracle. All rights reserved.
	9	*
	10	* This program is free software; you can redistribute it and/or
	11	* modify it under the terms of the GNU General Public
	12	* License as published by the Free Software Foundation; either
	13	* version 2 of the License, or (at your option) any later version.
	14	*
	15	* This program is distributed in the hope that it will be useful,
	16	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	17	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	18	* General Public License for more details.
	19	*
	20	* You should have received a copy of the GNU General Public
	21	* License along with this program; if not, write to the
	22	* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	23	* Boston, MA 021110-1307, USA.
	24	*/
	25
	26
	27	#ifndef DLMGLUE_H
	28	#define DLMGLUE_H
	29
d680efe9 MF	30	#include "dcache.h"
d680efe9 MF	31
15b1e36b	32	#define OCFS2_LVB_VERSION 5
ccd979bd MF	33
ccd979bd MF	34	struct ocfs2_meta_lvb {
4d3b83f7	35	__u8 lvb_version;
24c19ef4	36	__u8 lvb_reserved0;
15b1e36b	37	__be16 lvb_idynfeatures;
ccd979bd MF	38	__be32 lvb_iclusters;
	39	__be32 lvb_iuid;
	40	__be32 lvb_igid;
	41	__be64 lvb_iatime_packed;
	42	__be64 lvb_ictime_packed;
	43	__be64 lvb_imtime_packed;
	44	__be64 lvb_isize;
	45	__be16 lvb_imode;
	46	__be16 lvb_inlink;
ca4d147e	47	__be32 lvb_iattr;
f9e2d82e MF	48	__be32 lvb_igeneration;
f9e2d82e MF	49	__be32 lvb_reserved2;
ccd979bd MF	50	};
ccd979bd MF	51
9e33d69f JK	52	#define OCFS2_QINFO_LVB_VERSION 1
	53
	54	struct ocfs2_qinfo_lvb {
	55	__u8 lvb_version;
	56	__u8 lvb_reserved[3];
	57	__be32 lvb_bgrace;
	58	__be32 lvb_igrace;
	59	__be32 lvb_syncms;
	60	__be32 lvb_blocks;
	61	__be32 lvb_free_blk;
	62	__be32 lvb_free_entry;
	63	};
	64
83273932 SE	65	#define OCFS2_ORPHAN_LVB_VERSION 1
	66
	67	struct ocfs2_orphan_scan_lvb {
	68	__u8 lvb_version;
	69	__u8 lvb_reserved[3];
	70	__be32 lvb_os_seqno;
	71	};
	72
439a36b8 ER	73	struct ocfs2_lock_holder {
	74	struct list_head oh_list;
	75	struct pid *oh_owner_pid;
	76	};
	77
e63aecb6	78	/* ocfs2_inode_lock_full() 'arg_flags' flags */
ccd979bd MF	79	/* don't wait on recovery. */
	80	#define OCFS2_META_LOCK_RECOVERY (0x01)
	81	/* Instruct the dlm not to queue ourselves on the other node. */
	82	#define OCFS2_META_LOCK_NOQUEUE (0x02)
34d024f8	83	/* don't block waiting for the downconvert thread, instead return -EAGAIN */
ccd979bd	84	#define OCFS2_LOCK_NONBLOCK (0x04)
439a36b8 ER	85	/* just get back disk inode bh if we've got cluster lock. */
439a36b8 ER	86	#define OCFS2_META_LOCK_GETBH (0x08)
ccd979bd	87
cb25797d JK	88	/* Locking subclasses of inode cluster lock */
	89	enum {
	90	OI_LS_NORMAL = 0,
	91	OI_LS_PARENT,
	92	OI_LS_RENAME1,
	93	OI_LS_RENAME2,
07eaac94	94	OI_LS_REFLINK_TARGET,
cb25797d JK	95	};
cb25797d JK	96
ccd979bd	97	int ocfs2_dlm_init(struct ocfs2_super *osb);
286eaa95	98	void ocfs2_dlm_shutdown(struct ocfs2_super *osb, int hangup_pending);
ccd979bd MF	99	void ocfs2_lock_res_init_once(struct ocfs2_lock_res *res);
	100	void ocfs2_inode_lock_res_init(struct ocfs2_lock_res *res,
	101	enum ocfs2_lock_type type,
24c19ef4	102	unsigned int generation,
ccd979bd	103	struct inode *inode);
d680efe9 MF	104	void ocfs2_dentry_lock_res_init(struct ocfs2_dentry_lock *dl,
d680efe9 MF	105	u64 parent, struct inode *inode);
cf8e06f1 MF	106	struct ocfs2_file_private;
	107	void ocfs2_file_lock_res_init(struct ocfs2_lock_res *lockres,
	108	struct ocfs2_file_private *fp);
9e33d69f JK	109	struct ocfs2_mem_dqinfo;
	110	void ocfs2_qinfo_lock_res_init(struct ocfs2_lock_res *lockres,
	111	struct ocfs2_mem_dqinfo *info);
8dec98ed TM	112	void ocfs2_refcount_lock_res_init(struct ocfs2_lock_res *lockres,
	113	struct ocfs2_super *osb, u64 ref_blkno,
	114	unsigned int generation);
ccd979bd MF	115	void ocfs2_lock_res_free(struct ocfs2_lock_res *res);
	116	int ocfs2_create_new_inode_locks(struct inode *inode);
	117	int ocfs2_drop_inode_locks(struct inode *inode);
ccd979bd MF	118	int ocfs2_rw_lock(struct inode *inode, int write);
ccd979bd MF	119	void ocfs2_rw_unlock(struct inode *inode, int write);
50008630 TY	120	int ocfs2_open_lock(struct inode *inode);
	121	int ocfs2_try_open_lock(struct inode *inode, int write);
	122	void ocfs2_open_unlock(struct inode *inode);
e63aecb6	123	int ocfs2_inode_lock_atime(struct inode *inode,
7f1a37e3 TY	124	struct vfsmount *vfsmnt,
7f1a37e3 TY	125	int *level);
cb25797d	126	int ocfs2_inode_lock_full_nested(struct inode *inode,
ccd979bd MF	127	struct buffer_head **ret_bh,
ccd979bd MF	128	int ex,
cb25797d JK	129	int arg_flags,
cb25797d JK	130	int subclass);
e63aecb6	131	int ocfs2_inode_lock_with_page(struct inode *inode,
ccd979bd MF	132	struct buffer_head **ret_bh,
	133	int ex,
	134	struct page *page);
cb25797d JK	135	/* Variants without special locking class or flags */
	136	#define ocfs2_inode_lock_full(i, r, e, f)\
	137	ocfs2_inode_lock_full_nested(i, r, e, f, OI_LS_NORMAL)
	138	#define ocfs2_inode_lock_nested(i, b, e, s)\
	139	ocfs2_inode_lock_full_nested(i, b, e, 0, s)
ccd979bd MF	140	/* 99% of the time we don't want to supply any additional flags --
ccd979bd MF	141	* those are for very specific cases only. */
cb25797d	142	#define ocfs2_inode_lock(i, b, e) ocfs2_inode_lock_full_nested(i, b, e, 0, OI_LS_NORMAL)
e63aecb6	143	void ocfs2_inode_unlock(struct inode *inode,
ccd979bd MF	144	int ex);
	145	int ocfs2_super_lock(struct ocfs2_super *osb,
	146	int ex);
	147	void ocfs2_super_unlock(struct ocfs2_super *osb,
	148	int ex);
df152c24 SM	149	int ocfs2_orphan_scan_lock(struct ocfs2_super osb, u32 seqno);
df152c24 SM	150	void ocfs2_orphan_scan_unlock(struct ocfs2_super *osb, u32 seqno);
83273932	151
ccd979bd MF	152	int ocfs2_rename_lock(struct ocfs2_super *osb);
ccd979bd MF	153	void ocfs2_rename_unlock(struct ocfs2_super *osb);
6ca497a8	154	int ocfs2_nfs_sync_lock(struct ocfs2_super *osb, int ex);
6ca497a8	155	void ocfs2_nfs_sync_unlock(struct ocfs2_super *osb, int ex);
d680efe9 MF	156	int ocfs2_dentry_lock(struct dentry *dentry, int ex);
d680efe9 MF	157	void ocfs2_dentry_unlock(struct dentry *dentry, int ex);
cf8e06f1 MF	158	int ocfs2_file_lock(struct file *file, int ex, int trylock);
cf8e06f1 MF	159	void ocfs2_file_unlock(struct file *file);
9e33d69f JK	160	int ocfs2_qinfo_lock(struct ocfs2_mem_dqinfo *oinfo, int ex);
9e33d69f JK	161	void ocfs2_qinfo_unlock(struct ocfs2_mem_dqinfo *oinfo, int ex);
8dec98ed TM	162	struct ocfs2_refcount_tree;
	163	int ocfs2_refcount_lock(struct ocfs2_refcount_tree *ref_tree, int ex);
	164	void ocfs2_refcount_unlock(struct ocfs2_refcount_tree *ref_tree, int ex);
9e33d69f	165
d680efe9	166
84d86f83 JK	167	void ocfs2_mark_lockres_freeing(struct ocfs2_super *osb,
84d86f83 JK	168	struct ocfs2_lock_res *lockres);
d680efe9 MF	169	void ocfs2_simple_drop_lockres(struct ocfs2_super *osb,
d680efe9 MF	170	struct ocfs2_lock_res *lockres);
ccd979bd	171
34d024f8	172	/* for the downconvert thread */
34d024f8	173	void ocfs2_wake_downconvert_thread(struct ocfs2_super *osb);
ccd979bd MF	174
	175	struct ocfs2_dlm_debug *ocfs2_new_dlm_debug(void);
	176	void ocfs2_put_dlm_debug(struct ocfs2_dlm_debug *dlm_debug);
	177
63e0c48a JB	178	/* To set the locking protocol on module initialization */
63e0c48a JB	179	void ocfs2_set_locking_protocol(void);
439a36b8 ER	180
	181	/* The _tracker pair is used to avoid cluster recursive locking */
	182	int ocfs2_inode_lock_tracker(struct inode *inode,
	183	struct buffer_head **ret_bh,
	184	int ex,
	185	struct ocfs2_lock_holder *oh);
	186	void ocfs2_inode_unlock_tracker(struct inode *inode,
	187	int ex,
	188	struct ocfs2_lock_holder *oh,
	189	int had_lock);
	190
ccd979bd	191	#endif /* DLMGLUE_H */