[linux.git] / fs / gfs2 / glock.h

/*
 * Copyright (C) Sistina Software, Inc.  1997-2003 All rights reserved.
 * Copyright (C) 2004-2006 Red Hat, Inc.  All rights reserved.
 *
 * This copyrighted material is made available to anyone wishing to use,
 * modify, copy, or redistribute it subject to the terms and conditions
 * of the GNU General Public License version 2.
 */

#ifndef __GLOCK_DOT_H__
#define __GLOCK_DOT_H__

#include <linux/sched.h>
#include <linux/parser.h>
#include "incore.h"

/* Options for hostdata parser */

enum {
	Opt_jid,
	Opt_id,
	Opt_first,
	Opt_nodir,
	Opt_err,
};

/*
 * lm_lockname types
 */

#define LM_TYPE_RESERVED	0x00
#define LM_TYPE_NONDISK		0x01
#define LM_TYPE_INODE		0x02
#define LM_TYPE_RGRP		0x03
#define LM_TYPE_META		0x04
#define LM_TYPE_IOPEN		0x05
#define LM_TYPE_FLOCK		0x06
#define LM_TYPE_PLOCK		0x07
#define LM_TYPE_QUOTA		0x08
#define LM_TYPE_JOURNAL		0x09

/*
 * lm_lock() states
 *
 * SHARED is compatible with SHARED, not with DEFERRED or EX.
 * DEFERRED is compatible with DEFERRED, not with SHARED or EX.
 */

#define LM_ST_UNLOCKED		0
#define LM_ST_EXCLUSIVE		1
#define LM_ST_DEFERRED		2
#define LM_ST_SHARED		3

/*
 * lm_lock() flags
 *
 * LM_FLAG_TRY
 * Don't wait to acquire the lock if it can't be granted immediately.
 *
 * LM_FLAG_TRY_1CB
 * Send one blocking callback if TRY is set and the lock is not granted.
 *
 * LM_FLAG_NOEXP
 * GFS sets this flag on lock requests it makes while doing journal recovery.
 * These special requests should not be blocked due to the recovery like
 * ordinary locks would be.
 *
 * LM_FLAG_ANY
 * A SHARED request may also be granted in DEFERRED, or a DEFERRED request may
 * also be granted in SHARED.  The preferred state is whichever is compatible
 * with other granted locks, or the specified state if no other locks exist.
 *
 * LM_FLAG_PRIORITY
 * Override fairness considerations.  Suppose a lock is held in a shared state
 * and there is a pending request for the deferred state.  A shared lock
 * request with the priority flag would be allowed to bypass the deferred
 * request and directly join the other shared lock.  A shared lock request
 * without the priority flag might be forced to wait until the deferred
 * requested had acquired and released the lock.
 */

#define LM_FLAG_TRY		0x00000001
#define LM_FLAG_TRY_1CB		0x00000002
#define LM_FLAG_NOEXP		0x00000004
#define LM_FLAG_ANY		0x00000008
#define LM_FLAG_PRIORITY	0x00000010
#define GL_ASYNC		0x00000040
#define GL_EXACT		0x00000080
#define GL_SKIP			0x00000100
#define GL_NOCACHE		0x00000400
  
/*
 * lm_async_cb return flags
 *
 * LM_OUT_ST_MASK
 * Masks the lower two bits of lock state in the returned value.
 *
 * LM_OUT_CANCELED
 * The lock request was canceled.
 *
 */

#define LM_OUT_ST_MASK		0x00000003
#define LM_OUT_CANCELED		0x00000008
#define LM_OUT_ERROR		0x00000004

/*
 * lm_recovery_done() messages
 */

#define LM_RD_GAVEUP		308
#define LM_RD_SUCCESS		309

#define GLR_TRYFAILED		13

#define GL_GLOCK_MAX_HOLD        (long)(HZ / 5)
#define GL_GLOCK_DFT_HOLD        (long)(HZ / 5)
#define GL_GLOCK_MIN_HOLD        (long)(10)
#define GL_GLOCK_HOLD_INCR       (long)(HZ / 20)
#define GL_GLOCK_HOLD_DECR       (long)(HZ / 40)

struct lm_lockops {
	const char *lm_proto_name;
	int (*lm_mount) (struct gfs2_sbd *sdp, const char *table);
	void (*lm_first_done) (struct gfs2_sbd *sdp);
	void (*lm_recovery_result) (struct gfs2_sbd *sdp, unsigned int jid,
				    unsigned int result);
	void (*lm_unmount) (struct gfs2_sbd *sdp);
	void (*lm_withdraw) (struct gfs2_sbd *sdp);
	void (*lm_put_lock) (struct gfs2_glock *gl);
	int (*lm_lock) (struct gfs2_glock *gl, unsigned int req_state,
			unsigned int flags);
	void (*lm_cancel) (struct gfs2_glock *gl);
	const match_table_t *lm_tokens;
};

extern struct workqueue_struct *gfs2_delete_workqueue;
static inline struct gfs2_holder *gfs2_glock_is_locked_by_me(struct gfs2_glock *gl)
{
	struct gfs2_holder *gh;
	struct pid *pid;

	/* Look in glock's list of holders for one with current task as owner */
	spin_lock(&gl->gl_spin);
	pid = task_pid(current);
	list_for_each_entry(gh, &gl->gl_holders, gh_list) {
		if (!test_bit(HIF_HOLDER, &gh->gh_iflags))
			break;
		if (gh->gh_owner_pid == pid)
			goto out;
	}
	gh = NULL;
out:
	spin_unlock(&gl->gl_spin);

	return gh;
}

static inline int gfs2_glock_is_held_excl(struct gfs2_glock *gl)
{
	return gl->gl_state == LM_ST_EXCLUSIVE;
}

static inline int gfs2_glock_is_held_dfrd(struct gfs2_glock *gl)
{
	return gl->gl_state == LM_ST_DEFERRED;
}

static inline int gfs2_glock_is_held_shrd(struct gfs2_glock *gl)
{
	return gl->gl_state == LM_ST_SHARED;
}

static inline struct address_space *gfs2_glock2aspace(struct gfs2_glock *gl)
{
	if (gl->gl_ops->go_flags & GLOF_ASPACE)
		return (struct address_space *)(gl + 1);
	return NULL;
}

extern int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number,
			  const struct gfs2_glock_operations *glops,
			  int create, struct gfs2_glock **glp);
extern void gfs2_glock_hold(struct gfs2_glock *gl);
extern void gfs2_glock_put_nolock(struct gfs2_glock *gl);
extern void gfs2_glock_put(struct gfs2_glock *gl);
extern void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
			     unsigned flags, struct gfs2_holder *gh);
extern void gfs2_holder_reinit(unsigned int state, unsigned flags,
			       struct gfs2_holder *gh);
extern void gfs2_holder_uninit(struct gfs2_holder *gh);
extern int gfs2_glock_nq(struct gfs2_holder *gh);
extern int gfs2_glock_poll(struct gfs2_holder *gh);
extern int gfs2_glock_wait(struct gfs2_holder *gh);
extern void gfs2_glock_dq(struct gfs2_holder *gh);
extern void gfs2_glock_dq_wait(struct gfs2_holder *gh);
extern void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
extern int gfs2_glock_nq_num(struct gfs2_sbd *sdp, u64 number,
			     const struct gfs2_glock_operations *glops,
			     unsigned int state, int flags,
			     struct gfs2_holder *gh);
extern int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
extern void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
extern int gfs2_dump_glock(struct seq_file *seq, const struct gfs2_glock *gl);
#define GLOCK_BUG_ON(gl,x) do { if (unlikely(x)) { gfs2_dump_glock(NULL, gl); BUG(); } } while(0)
extern __printf(2, 3)
void gfs2_print_dbg(struct seq_file *seq, const char *fmt, ...);

/**
 * gfs2_glock_nq_init - initialize a holder and enqueue it on a glock
 * @gl: the glock
 * @state: the state we're requesting
 * @flags: the modifier flags
 * @gh: the holder structure
 *
 * Returns: 0, GLR_*, or errno
 */

static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
				     unsigned int state, int flags,
				     struct gfs2_holder *gh)
{
	int error;

	gfs2_holder_init(gl, state, flags, gh);

	error = gfs2_glock_nq(gh);
	if (error)
		gfs2_holder_uninit(gh);

	return error;
}

extern void gfs2_glock_cb(struct gfs2_glock *gl, unsigned int state);
extern void gfs2_glock_complete(struct gfs2_glock *gl, int ret);
extern void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);
extern void gfs2_glock_finish_truncate(struct gfs2_inode *ip);
extern void gfs2_glock_thaw(struct gfs2_sbd *sdp);
extern void gfs2_glock_add_to_lru(struct gfs2_glock *gl);
extern void gfs2_glock_free(struct gfs2_glock *gl);

extern int __init gfs2_glock_init(void);
extern void gfs2_glock_exit(void);

extern int gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
extern void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
extern int gfs2_register_debugfs(void);
extern void gfs2_unregister_debugfs(void);

extern const struct lm_lockops gfs2_dlm_ops;

#endif /* __GLOCK_DOT_H__ */
Commit	Line	Data
b3b94faa DT	1	/*
b3b94faa DT	2	* Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
3a8a9a10	3	* Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
b3b94faa DT	4	*
	5	* This copyrighted material is made available to anyone wishing to use,
	6	* modify, copy, or redistribute it subject to the terms and conditions
e9fc2aa0	7	* of the GNU General Public License version 2.
b3b94faa DT	8	*/
	9
	10	#ifndef __GLOCK_DOT_H__
	11	#define __GLOCK_DOT_H__
	12
e8edc6e0	13	#include <linux/sched.h>
f057f6cd	14	#include <linux/parser.h>
f2f7ba52 SW	15	#include "incore.h"
f2f7ba52 SW	16
f057f6cd SW	17	/* Options for hostdata parser */
	18
	19	enum {
	20	Opt_jid,
	21	Opt_id,
	22	Opt_first,
	23	Opt_nodir,
	24	Opt_err,
	25	};
	26
	27	/*
	28	* lm_lockname types
	29	*/
	30
	31	#define LM_TYPE_RESERVED 0x00
	32	#define LM_TYPE_NONDISK 0x01
	33	#define LM_TYPE_INODE 0x02
	34	#define LM_TYPE_RGRP 0x03
	35	#define LM_TYPE_META 0x04
	36	#define LM_TYPE_IOPEN 0x05
	37	#define LM_TYPE_FLOCK 0x06
	38	#define LM_TYPE_PLOCK 0x07
	39	#define LM_TYPE_QUOTA 0x08
	40	#define LM_TYPE_JOURNAL 0x09
	41
	42	/*
	43	* lm_lock() states
	44	*
	45	* SHARED is compatible with SHARED, not with DEFERRED or EX.
	46	* DEFERRED is compatible with DEFERRED, not with SHARED or EX.
	47	*/
	48
	49	#define LM_ST_UNLOCKED 0
	50	#define LM_ST_EXCLUSIVE 1
	51	#define LM_ST_DEFERRED 2
	52	#define LM_ST_SHARED 3
	53
	54	/*
	55	* lm_lock() flags
	56	*
	57	* LM_FLAG_TRY
	58	* Don't wait to acquire the lock if it can't be granted immediately.
	59	*
	60	* LM_FLAG_TRY_1CB
	61	* Send one blocking callback if TRY is set and the lock is not granted.
	62	*
	63	* LM_FLAG_NOEXP
	64	* GFS sets this flag on lock requests it makes while doing journal recovery.
	65	* These special requests should not be blocked due to the recovery like
	66	* ordinary locks would be.
	67	*
	68	* LM_FLAG_ANY
	69	* A SHARED request may also be granted in DEFERRED, or a DEFERRED request may
	70	* also be granted in SHARED. The preferred state is whichever is compatible
	71	* with other granted locks, or the specified state if no other locks exist.
	72	*
	73	* LM_FLAG_PRIORITY
	74	* Override fairness considerations. Suppose a lock is held in a shared state
	75	* and there is a pending request for the deferred state. A shared lock
	76	* request with the priority flag would be allowed to bypass the deferred
	77	* request and directly join the other shared lock. A shared lock request
	78	* without the priority flag might be forced to wait until the deferred
	79	* requested had acquired and released the lock.
	80	*/
81
b3b94faa DT	82	#define LM_FLAG_TRY 0x00000001
	83	#define LM_FLAG_TRY_1CB 0x00000002
	84	#define LM_FLAG_NOEXP 0x00000004
	85	#define LM_FLAG_ANY 0x00000008
f057f6cd SW	86	#define LM_FLAG_PRIORITY 0x00000010
	87	#define GL_ASYNC 0x00000040
	88	#define GL_EXACT 0x00000080
	89	#define GL_SKIP 0x00000100
f057f6cd SW	90	#define GL_NOCACHE 0x00000400
	91
	92	/*
921169ca	93	* lm_async_cb return flags
f057f6cd SW	94	*
	95	* LM_OUT_ST_MASK
	96	* Masks the lower two bits of lock state in the returned value.
	97	*
	98	* LM_OUT_CANCELED
	99	* The lock request was canceled.
	100	*
f057f6cd SW	101	*/
	102
	103	#define LM_OUT_ST_MASK 0x00000003
	104	#define LM_OUT_CANCELED 0x00000008
921169ca	105	#define LM_OUT_ERROR 0x00000004
f057f6cd SW	106
	107	/*
	108	* lm_recovery_done() messages
	109	*/
	110
	111	#define LM_RD_GAVEUP 308
	112	#define LM_RD_SUCCESS 309
	113
	114	#define GLR_TRYFAILED 13
	115
7cf8dcd3 BP	116	#define GL_GLOCK_MAX_HOLD (long)(HZ / 5)
	117	#define GL_GLOCK_DFT_HOLD (long)(HZ / 5)
	118	#define GL_GLOCK_MIN_HOLD (long)(10)
	119	#define GL_GLOCK_HOLD_INCR (long)(HZ / 20)
	120	#define GL_GLOCK_HOLD_DECR (long)(HZ / 40)
	121
f057f6cd SW	122	struct lm_lockops {
f057f6cd SW	123	const char *lm_proto_name;
e0c2a9aa DT	124	int (lm_mount) (struct gfs2_sbd sdp, const char *table);
	125	void (lm_first_done) (struct gfs2_sbd sdp);
	126	void (lm_recovery_result) (struct gfs2_sbd sdp, unsigned int jid,
	127	unsigned int result);
	128	void (lm_unmount) (struct gfs2_sbd sdp);
f057f6cd	129	void (lm_withdraw) (struct gfs2_sbd sdp);
bc015cb8	130	void (lm_put_lock) (struct gfs2_glock gl);
921169ca SW	131	int (lm_lock) (struct gfs2_glock gl, unsigned int req_state,
921169ca SW	132	unsigned int flags);
f057f6cd SW	133	void (lm_cancel) (struct gfs2_glock gl);
	134	const match_table_t *lm_tokens;
	135	};
	136
b94a170e	137	extern struct workqueue_struct *gfs2_delete_workqueue;
7afd88d9	138	static inline struct gfs2_holder gfs2_glock_is_locked_by_me(struct gfs2_glock gl)
b3b94faa DT	139	{
b3b94faa DT	140	struct gfs2_holder *gh;
b1e058da	141	struct pid *pid;
b3b94faa DT	142
	143	/* Look in glock's list of holders for one with current task as owner */
	144	spin_lock(&gl->gl_spin);
b1e058da	145	pid = task_pid(current);
b3b94faa	146	list_for_each_entry(gh, &gl->gl_holders, gh_list) {
6802e340 SW	147	if (!test_bit(HIF_HOLDER, &gh->gh_iflags))
6802e340 SW	148	break;
7afd88d9 SW	149	if (gh->gh_owner_pid == pid)
7afd88d9 SW	150	goto out;
b3b94faa	151	}
7afd88d9 SW	152	gh = NULL;
7afd88d9 SW	153	out:
b3b94faa DT	154	spin_unlock(&gl->gl_spin);
b3b94faa DT	155
7afd88d9	156	return gh;
b3b94faa DT	157	}
	158
	159	static inline int gfs2_glock_is_held_excl(struct gfs2_glock *gl)
	160	{
50299965	161	return gl->gl_state == LM_ST_EXCLUSIVE;
b3b94faa DT	162	}
	163
	164	static inline int gfs2_glock_is_held_dfrd(struct gfs2_glock *gl)
	165	{
50299965	166	return gl->gl_state == LM_ST_DEFERRED;
b3b94faa DT	167	}
	168
	169	static inline int gfs2_glock_is_held_shrd(struct gfs2_glock *gl)
	170	{
50299965	171	return gl->gl_state == LM_ST_SHARED;
b3b94faa DT	172	}
b3b94faa DT	173
009d8518 SW	174	static inline struct address_space gfs2_glock2aspace(struct gfs2_glock gl)
	175	{
	176	if (gl->gl_ops->go_flags & GLOF_ASPACE)
	177	return (struct address_space *)(gl + 1);
	178	return NULL;
	179	}
	180
8eae1ca0 SW	181	extern int gfs2_glock_get(struct gfs2_sbd *sdp, u64 number,
	182	const struct gfs2_glock_operations *glops,
	183	int create, struct gfs2_glock **glp);
	184	extern void gfs2_glock_hold(struct gfs2_glock *gl);
	185	extern void gfs2_glock_put_nolock(struct gfs2_glock *gl);
	186	extern void gfs2_glock_put(struct gfs2_glock *gl);
	187	extern void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state,
	188	unsigned flags, struct gfs2_holder *gh);
	189	extern void gfs2_holder_reinit(unsigned int state, unsigned flags,
	190	struct gfs2_holder *gh);
	191	extern void gfs2_holder_uninit(struct gfs2_holder *gh);
	192	extern int gfs2_glock_nq(struct gfs2_holder *gh);
	193	extern int gfs2_glock_poll(struct gfs2_holder *gh);
	194	extern int gfs2_glock_wait(struct gfs2_holder *gh);
	195	extern void gfs2_glock_dq(struct gfs2_holder *gh);
	196	extern void gfs2_glock_dq_wait(struct gfs2_holder *gh);
	197	extern void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
	198	extern int gfs2_glock_nq_num(struct gfs2_sbd *sdp, u64 number,
	199	const struct gfs2_glock_operations *glops,
	200	unsigned int state, int flags,
	201	struct gfs2_holder *gh);
	202	extern int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
	203	extern void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
8eae1ca0 SW	204	extern int gfs2_dump_glock(struct seq_file seq, const struct gfs2_glock gl);
	205	#define GLOCK_BUG_ON(gl,x) do { if (unlikely(x)) { gfs2_dump_glock(NULL, gl); BUG(); } } while(0)
	206	extern __printf(2, 3)
6802e340	207	void gfs2_print_dbg(struct seq_file seq, const char fmt, ...);
b3b94faa	208
d0dc80db	209	/**
33027af6	210	* gfs2_glock_nq_init - initialize a holder and enqueue it on a glock
d0dc80db SW	211	* @gl: the glock
	212	* @state: the state we're requesting
	213	* @flags: the modifier flags
	214	* @gh: the holder structure
	215	*
	216	* Returns: 0, GLR_*, or errno
	217	*/
	218
	219	static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
	220	unsigned int state, int flags,
	221	struct gfs2_holder *gh)
	222	{
	223	int error;
	224
	225	gfs2_holder_init(gl, state, flags, gh);
	226
	227	error = gfs2_glock_nq(gh);
	228	if (error)
	229	gfs2_holder_uninit(gh);
	230
	231	return error;
	232	}
	233
bc015cb8 SW	234	extern void gfs2_glock_cb(struct gfs2_glock *gl, unsigned int state);
bc015cb8 SW	235	extern void gfs2_glock_complete(struct gfs2_glock *gl, int ret);
bc015cb8 SW	236	extern void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);
	237	extern void gfs2_glock_finish_truncate(struct gfs2_inode *ip);
	238	extern void gfs2_glock_thaw(struct gfs2_sbd *sdp);
29687a2a	239	extern void gfs2_glock_add_to_lru(struct gfs2_glock *gl);
fc0e38da	240	extern void gfs2_glock_free(struct gfs2_glock *gl);
bc015cb8 SW	241
	242	extern int __init gfs2_glock_init(void);
	243	extern void gfs2_glock_exit(void);
	244
	245	extern int gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
	246	extern void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
	247	extern int gfs2_register_debugfs(void);
	248	extern void gfs2_unregister_debugfs(void);
85d1da67	249
f057f6cd SW	250	extern const struct lm_lockops gfs2_dlm_ops;
f057f6cd SW	251
b3b94faa	252	#endif /* __GLOCK_DOT_H__ */