[deliverable/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 "incore.h"

/* Flags for lock requests; used in gfs2_holder gh_flag field.
   From lm_interface.h:
#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_ATIME		0x00000200
#define GL_NOCACHE		0x00000400

#define GLR_TRYFAILED		13

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 int gfs2_glock_is_blocking(struct gfs2_glock *gl)
{
	int ret;
	spin_lock(&gl->gl_spin);
	ret = test_bit(GLF_DEMOTE, &gl->gl_flags);
	spin_unlock(&gl->gl_spin);
	return ret;
}

int gfs2_glock_get(struct gfs2_sbd *sdp,
		   u64 number, const struct gfs2_glock_operations *glops,
		   int create, struct gfs2_glock **glp);
int gfs2_glock_put(struct gfs2_glock *gl);
void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state, unsigned flags,
		      struct gfs2_holder *gh);
void gfs2_holder_reinit(unsigned int state, unsigned flags,
			struct gfs2_holder *gh);
void gfs2_holder_uninit(struct gfs2_holder *gh);
int gfs2_glock_nq(struct gfs2_holder *gh);
int gfs2_glock_poll(struct gfs2_holder *gh);
int gfs2_glock_wait(struct gfs2_holder *gh);
void gfs2_glock_dq(struct gfs2_holder *gh);
void gfs2_glock_dq_wait(struct gfs2_holder *gh);

void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
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);

int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
void gfs2_glock_dq_uninit_m(unsigned int num_gh, struct gfs2_holder *ghs);
void gfs2_print_dbg(struct seq_file *seq, const char *fmt, ...);

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

/*  Lock Value Block functions  */

int gfs2_lvb_hold(struct gfs2_glock *gl);
void gfs2_lvb_unhold(struct gfs2_glock *gl);

void gfs2_glock_cb(void *cb_data, unsigned int type, void *data);
void gfs2_glock_schedule_for_reclaim(struct gfs2_glock *gl);
void gfs2_reclaim_glock(struct gfs2_sbd *sdp);
void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);

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

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

#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>
f2f7ba52 SW	14	#include "incore.h"
f2f7ba52 SW	15
b3b94faa DT	16	/* Flags for lock requests; used in gfs2_holder gh_flag field.
	17	From lm_interface.h:
	18	#define LM_FLAG_TRY 0x00000001
	19	#define LM_FLAG_TRY_1CB 0x00000002
	20	#define LM_FLAG_NOEXP 0x00000004
	21	#define LM_FLAG_ANY 0x00000008
	22	#define LM_FLAG_PRIORITY 0x00000010 */
	23
b3b94faa DT	24	#define GL_ASYNC 0x00000040
	25	#define GL_EXACT 0x00000080
	26	#define GL_SKIP 0x00000100
	27	#define GL_ATIME 0x00000200
	28	#define GL_NOCACHE 0x00000400
b3b94faa DT	29
b3b94faa DT	30	#define GLR_TRYFAILED 13
b3b94faa	31
7afd88d9	32	static inline struct gfs2_holder gfs2_glock_is_locked_by_me(struct gfs2_glock gl)
b3b94faa DT	33	{
b3b94faa DT	34	struct gfs2_holder *gh;
b1e058da	35	struct pid *pid;
b3b94faa DT	36
	37	/* Look in glock's list of holders for one with current task as owner */
	38	spin_lock(&gl->gl_spin);
b1e058da	39	pid = task_pid(current);
b3b94faa	40	list_for_each_entry(gh, &gl->gl_holders, gh_list) {
6802e340 SW	41	if (!test_bit(HIF_HOLDER, &gh->gh_iflags))
6802e340 SW	42	break;
7afd88d9 SW	43	if (gh->gh_owner_pid == pid)
7afd88d9 SW	44	goto out;
b3b94faa	45	}
7afd88d9 SW	46	gh = NULL;
7afd88d9 SW	47	out:
b3b94faa DT	48	spin_unlock(&gl->gl_spin);
b3b94faa DT	49
7afd88d9	50	return gh;
b3b94faa DT	51	}
	52
	53	static inline int gfs2_glock_is_held_excl(struct gfs2_glock *gl)
	54	{
50299965	55	return gl->gl_state == LM_ST_EXCLUSIVE;
b3b94faa DT	56	}
	57
	58	static inline int gfs2_glock_is_held_dfrd(struct gfs2_glock *gl)
	59	{
50299965	60	return gl->gl_state == LM_ST_DEFERRED;
b3b94faa DT	61	}
	62
	63	static inline int gfs2_glock_is_held_shrd(struct gfs2_glock *gl)
	64	{
50299965	65	return gl->gl_state == LM_ST_SHARED;
b3b94faa DT	66	}
	67
	68	static inline int gfs2_glock_is_blocking(struct gfs2_glock *gl)
	69	{
	70	int ret;
	71	spin_lock(&gl->gl_spin);
6802e340	72	ret = test_bit(GLF_DEMOTE, &gl->gl_flags);
b3b94faa DT	73	spin_unlock(&gl->gl_spin);
	74	return ret;
	75	}
	76
b3b94faa	77	int gfs2_glock_get(struct gfs2_sbd *sdp,
cd915493	78	u64 number, const struct gfs2_glock_operations *glops,
b3b94faa	79	int create, struct gfs2_glock **glp);
b3b94faa	80	int gfs2_glock_put(struct gfs2_glock *gl);
190562bd	81	void gfs2_holder_init(struct gfs2_glock *gl, unsigned int state, unsigned flags,
b3b94faa	82	struct gfs2_holder *gh);
190562bd SW	83	void gfs2_holder_reinit(unsigned int state, unsigned flags,
190562bd SW	84	struct gfs2_holder *gh);
b3b94faa	85	void gfs2_holder_uninit(struct gfs2_holder *gh);
b3b94faa DT	86	int gfs2_glock_nq(struct gfs2_holder *gh);
	87	int gfs2_glock_poll(struct gfs2_holder *gh);
	88	int gfs2_glock_wait(struct gfs2_holder *gh);
	89	void gfs2_glock_dq(struct gfs2_holder *gh);
d93cfa98	90	void gfs2_glock_dq_wait(struct gfs2_holder *gh);
b3b94faa	91
b3b94faa DT	92	void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
b3b94faa DT	93	int gfs2_glock_nq_num(struct gfs2_sbd *sdp,
cd915493	94	u64 number, const struct gfs2_glock_operations *glops,
b3b94faa DT	95	unsigned int state, int flags, struct gfs2_holder *gh);
	96
	97	int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
	98	void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
	99	void gfs2_glock_dq_uninit_m(unsigned int num_gh, struct gfs2_holder *ghs);
6802e340	100	void gfs2_print_dbg(struct seq_file seq, const char fmt, ...);
b3b94faa	101
d0dc80db SW	102	/**
	103	* gfs2_glock_nq_init - intialize a holder and enqueue it on a glock
	104	* @gl: the glock
	105	* @state: the state we're requesting
	106	* @flags: the modifier flags
	107	* @gh: the holder structure
	108	*
	109	* Returns: 0, GLR_*, or errno
	110	*/
	111
	112	static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
	113	unsigned int state, int flags,
	114	struct gfs2_holder *gh)
	115	{
	116	int error;
	117
	118	gfs2_holder_init(gl, state, flags, gh);
	119
	120	error = gfs2_glock_nq(gh);
	121	if (error)
	122	gfs2_holder_uninit(gh);
	123
	124	return error;
	125	}
	126
b3b94faa DT	127	/* Lock Value Block functions */
	128
	129	int gfs2_lvb_hold(struct gfs2_glock *gl);
	130	void gfs2_lvb_unhold(struct gfs2_glock *gl);
b3b94faa	131
9b47c11d	132	void gfs2_glock_cb(void cb_data, unsigned int type, void data);
b3b94faa DT	133	void gfs2_glock_schedule_for_reclaim(struct gfs2_glock *gl);
b3b94faa DT	134	void gfs2_reclaim_glock(struct gfs2_sbd *sdp);
1bdad606	135	void gfs2_gl_hash_clear(struct gfs2_sbd *sdp);
b3b94faa	136
85d1da67	137	int __init gfs2_glock_init(void);
8fbbfd21 SW	138	void gfs2_glock_exit(void);
8fbbfd21 SW	139
7c52b166 RP	140	int gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
	141	void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
	142	int gfs2_register_debugfs(void);
	143	void gfs2_unregister_debugfs(void);
85d1da67	144
b3b94faa	145	#endif /* __GLOCK_DOT_H__ */