[mirror_ubuntu-eoan-kernel.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 GL_NOCANCEL		0x00001000

#define GLR_TRYFAILED		13
#define GLR_CANCELED		14

static inline int gfs2_glock_is_locked_by_me(struct gfs2_glock *gl)
{
	struct gfs2_holder *gh;
	int locked = 0;

	/* Look in glock's list of holders for one with current task as owner */
	spin_lock(&gl->gl_spin);
	list_for_each_entry(gh, &gl->gl_holders, gh_list) {
		if (gh->gh_owner_pid == current->pid) {
			locked = 1;
			break;
		}
	}
	spin_unlock(&gl->gl_spin);

	return locked;
}

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) || !list_empty(&gl->gl_waiters3);
	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);
void gfs2_glock_hold(struct gfs2_glock *gl);
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_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);

/**
 * 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_scand_internal(struct gfs2_sbd *sdp);
void gfs2_gl_hash_clear(struct gfs2_sbd *sdp, int wait);

int __init gfs2_glock_init(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	29	#define GL_NOCANCEL 0x00001000
b3b94faa DT	30
	31	#define GLR_TRYFAILED 13
	32	#define GLR_CANCELED 14
	33
	34	static inline int gfs2_glock_is_locked_by_me(struct gfs2_glock *gl)
	35	{
	36	struct gfs2_holder *gh;
	37	int locked = 0;
	38
	39	/* Look in glock's list of holders for one with current task as owner */
	40	spin_lock(&gl->gl_spin);
	41	list_for_each_entry(gh, &gl->gl_holders, gh_list) {
04b933f2	42	if (gh->gh_owner_pid == current->pid) {
b3b94faa DT	43	locked = 1;
	44	break;
	45	}
	46	}
	47	spin_unlock(&gl->gl_spin);
	48
	49	return locked;
	50	}
	51
	52	static inline int gfs2_glock_is_held_excl(struct gfs2_glock *gl)
	53	{
50299965	54	return gl->gl_state == LM_ST_EXCLUSIVE;
b3b94faa DT	55	}
	56
	57	static inline int gfs2_glock_is_held_dfrd(struct gfs2_glock *gl)
	58	{
50299965	59	return gl->gl_state == LM_ST_DEFERRED;
b3b94faa DT	60	}
	61
	62	static inline int gfs2_glock_is_held_shrd(struct gfs2_glock *gl)
	63	{
50299965	64	return gl->gl_state == LM_ST_SHARED;
b3b94faa DT	65	}
	66
	67	static inline int gfs2_glock_is_blocking(struct gfs2_glock *gl)
	68	{
	69	int ret;
	70	spin_lock(&gl->gl_spin);
3b8249f6	71	ret = test_bit(GLF_DEMOTE, &gl->gl_flags) \|\| !list_empty(&gl->gl_waiters3);
b3b94faa DT	72	spin_unlock(&gl->gl_spin);
	73	return ret;
	74	}
	75
b3b94faa	76	int gfs2_glock_get(struct gfs2_sbd *sdp,
cd915493	77	u64 number, const struct gfs2_glock_operations *glops,
b3b94faa DT	78	int create, struct gfs2_glock **glp);
	79	void gfs2_glock_hold(struct gfs2_glock *gl);
	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);
	90
b3b94faa DT	91	void gfs2_glock_dq_uninit(struct gfs2_holder *gh);
b3b94faa DT	92	int gfs2_glock_nq_num(struct gfs2_sbd *sdp,
cd915493	93	u64 number, const struct gfs2_glock_operations *glops,
b3b94faa DT	94	unsigned int state, int flags, struct gfs2_holder *gh);
	95
	96	int gfs2_glock_nq_m(unsigned int num_gh, struct gfs2_holder *ghs);
	97	void gfs2_glock_dq_m(unsigned int num_gh, struct gfs2_holder *ghs);
	98	void gfs2_glock_dq_uninit_m(unsigned int num_gh, struct gfs2_holder *ghs);
	99
d0dc80db SW	100	/**
	101	* gfs2_glock_nq_init - intialize a holder and enqueue it on a glock
	102	* @gl: the glock
	103	* @state: the state we're requesting
	104	* @flags: the modifier flags
	105	* @gh: the holder structure
	106	*
	107	* Returns: 0, GLR_*, or errno
	108	*/
	109
	110	static inline int gfs2_glock_nq_init(struct gfs2_glock *gl,
	111	unsigned int state, int flags,
	112	struct gfs2_holder *gh)
	113	{
	114	int error;
	115
	116	gfs2_holder_init(gl, state, flags, gh);
	117
	118	error = gfs2_glock_nq(gh);
	119	if (error)
	120	gfs2_holder_uninit(gh);
	121
	122	return error;
	123	}
	124
b3b94faa DT	125	/* Lock Value Block functions */
	126
	127	int gfs2_lvb_hold(struct gfs2_glock *gl);
	128	void gfs2_lvb_unhold(struct gfs2_glock *gl);
b3b94faa	129
9b47c11d	130	void gfs2_glock_cb(void cb_data, unsigned int type, void data);
b3b94faa	131
b3b94faa DT	132	void gfs2_glock_schedule_for_reclaim(struct gfs2_glock *gl);
	133	void gfs2_reclaim_glock(struct gfs2_sbd *sdp);
	134
	135	void gfs2_scand_internal(struct gfs2_sbd *sdp);
	136	void gfs2_gl_hash_clear(struct gfs2_sbd *sdp, int wait);
	137
85d1da67	138	int __init gfs2_glock_init(void);
7c52b166 RP	139	int gfs2_create_debugfs_file(struct gfs2_sbd *sdp);
	140	void gfs2_delete_debugfs_file(struct gfs2_sbd *sdp);
	141	int gfs2_register_debugfs(void);
	142	void gfs2_unregister_debugfs(void);
85d1da67	143
b3b94faa	144	#endif /* __GLOCK_DOT_H__ */