[net-next-2.6.git] / fs / dlm / dlm_internal.h

/******************************************************************************
*******************************************************************************
**
**  Copyright (C) Sistina Software, Inc.  1997-2003  All rights reserved.
**  Copyright (C) 2004-2007 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 v.2.
**
*******************************************************************************
******************************************************************************/

#ifndef __DLM_INTERNAL_DOT_H__
#define __DLM_INTERNAL_DOT_H__

/*
 * This is the main header file to be included in each DLM source file.
 */

#include <linux/module.h>
#include <linux/slab.h>
#include <linux/sched.h>
#include <linux/types.h>
#include <linux/ctype.h>
#include <linux/spinlock.h>
#include <linux/vmalloc.h>
#include <linux/list.h>
#include <linux/errno.h>
#include <linux/random.h>
#include <linux/delay.h>
#include <linux/socket.h>
#include <linux/kthread.h>
#include <linux/kobject.h>
#include <linux/kref.h>
#include <linux/kernel.h>
#include <linux/jhash.h>
#include <linux/miscdevice.h>
#include <linux/mutex.h>
#include <asm/semaphore.h>
#include <asm/uaccess.h>

#include <linux/dlm.h>
#include "config.h"

#define DLM_LOCKSPACE_LEN	64

/* Size of the temp buffer midcomms allocates on the stack.
   We try to make this large enough so most messages fit.
   FIXME: should sctp make this unnecessary? */

#define DLM_INBUF_LEN		148

struct dlm_ls;
struct dlm_lkb;
struct dlm_rsb;
struct dlm_member;
struct dlm_lkbtable;
struct dlm_rsbtable;
struct dlm_dirtable;
struct dlm_direntry;
struct dlm_recover;
struct dlm_header;
struct dlm_message;
struct dlm_rcom;
struct dlm_mhandle;

#define log_print(fmt, args...) \
	printk(KERN_ERR "dlm: "fmt"\n" , ##args)
#define log_error(ls, fmt, args...) \
	printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)

#define log_debug(ls, fmt, args...) \
do { \
	if (dlm_config.ci_log_debug) \
		printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
		       (ls)->ls_name , ##args); \
} while (0)

#define DLM_ASSERT(x, do) \
{ \
  if (!(x)) \
  { \
    printk(KERN_ERR "\nDLM:  Assertion failed on line %d of file %s\n" \
               "DLM:  assertion:  \"%s\"\n" \
               "DLM:  time = %lu\n", \
               __LINE__, __FILE__, #x, jiffies); \
    {do} \
    printk("\n"); \
    BUG(); \
    panic("DLM:  Record message above and reboot.\n"); \
  } \
}

#define DLM_FAKE_USER_AST ERR_PTR(-EINVAL)


struct dlm_direntry {
	struct list_head	list;
	uint32_t		master_nodeid;
	uint16_t		length;
	char			name[1];
};

struct dlm_dirtable {
	struct list_head	list;
	rwlock_t		lock;
};

struct dlm_rsbtable {
	struct list_head	list;
	struct list_head	toss;
	rwlock_t		lock;
};

struct dlm_lkbtable {
	struct list_head	list;
	rwlock_t		lock;
	uint16_t		counter;
};

/*
 * Lockspace member (per node in a ls)
 */

struct dlm_member {
	struct list_head	list;
	int			nodeid;
	int			weight;
};

/*
 * Save and manage recovery state for a lockspace.
 */

struct dlm_recover {
	struct list_head	list;
	int			*nodeids;
	int			node_count;
	uint64_t		seq;
};

/*
 * Pass input args to second stage locking function.
 */

struct dlm_args {
	uint32_t		flags;
	void			*astaddr;
	long			astparam;
	void			*bastaddr;
	int			mode;
	struct dlm_lksb		*lksb;
	unsigned long		timeout;
};


/*
 * Lock block
 *
 * A lock can be one of three types:
 *
 * local copy      lock is mastered locally
 *                 (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
 * process copy    lock is mastered on a remote node
 *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
 * master copy     master node's copy of a lock owned by remote node
 *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
 *
 * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
 * dlm_unlock.  The dlm does not modify these or use any private flags in
 * this field; it only contains DLM_LKF_ flags from dlm.h.  These flags
 * are sent as-is to the remote master when the lock is remote.
 *
 * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
 * Some internal flags are shared between the master and process nodes;
 * these shared flags are kept in the lower two bytes.  One of these
 * flags set on the master copy will be propagated to the process copy
 * and v.v.  Other internal flags are private to the master or process
 * node (e.g. DLM_IFL_MSTCPY).  These are kept in the high two bytes.
 *
 * lkb_sbflags: status block flags.  These flags are copied directly into
 * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
 * ast.  All defined in dlm.h with DLM_SBF_ prefix.
 *
 * lkb_status: the lock status indicates which rsb queue the lock is
 * on, grant, convert, or wait.  DLM_LKSTS_ WAITING/GRANTED/CONVERT
 *
 * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
 * reply is needed.  Only set when the lkb is on the lockspace waiters
 * list awaiting a reply from a remote node.
 *
 * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
 * is a master copy, nodeid specifies the remote lock holder, when the
 * lkb is a process copy, the nodeid specifies the lock master.
 */

/* lkb_ast_type */

#define AST_COMP		1
#define AST_BAST		2

/* lkb_status */

#define DLM_LKSTS_WAITING	1
#define DLM_LKSTS_GRANTED	2
#define DLM_LKSTS_CONVERT	3

/* lkb_flags */

#define DLM_IFL_MSTCPY		0x00010000
#define DLM_IFL_RESEND		0x00020000
#define DLM_IFL_DEAD		0x00040000
#define DLM_IFL_OVERLAP_UNLOCK  0x00080000
#define DLM_IFL_OVERLAP_CANCEL  0x00100000
#define DLM_IFL_ENDOFLIFE	0x00200000
#define DLM_IFL_WATCH_TIMEWARN	0x00400000
#define DLM_IFL_USER		0x00000001
#define DLM_IFL_ORPHAN		0x00000002
#define DLM_IFL_TIMEOUT_CANCEL	0x00000004

struct dlm_lkb {
	struct dlm_rsb		*lkb_resource;	/* the rsb */
	struct kref		lkb_ref;
	int			lkb_nodeid;	/* copied from rsb */
	int			lkb_ownpid;	/* pid of lock owner */
	uint32_t		lkb_id;		/* our lock ID */
	uint32_t		lkb_remid;	/* lock ID on remote partner */
	uint32_t		lkb_exflags;	/* external flags from caller */
	uint32_t		lkb_sbflags;	/* lksb flags */
	uint32_t		lkb_flags;	/* internal flags */
	uint32_t		lkb_lvbseq;	/* lvb sequence number */

	int8_t			lkb_status;     /* granted, waiting, convert */
	int8_t			lkb_rqmode;	/* requested lock mode */
	int8_t			lkb_grmode;	/* granted lock mode */
	int8_t			lkb_bastmode;	/* requested mode */
	int8_t			lkb_highbast;	/* highest mode bast sent for */
	int8_t			lkb_wait_type;	/* type of reply waiting for */
	int8_t			lkb_wait_count;
	int8_t			lkb_ast_type;	/* type of ast queued for */

	struct list_head	lkb_idtbl_list;	/* lockspace lkbtbl */
	struct list_head	lkb_statequeue;	/* rsb g/c/w list */
	struct list_head	lkb_rsb_lookup;	/* waiting for rsb lookup */
	struct list_head	lkb_wait_reply;	/* waiting for remote reply */
	struct list_head	lkb_astqueue;	/* need ast to be sent */
	struct list_head	lkb_ownqueue;	/* list of locks for a process */
	struct list_head	lkb_time_list;
	unsigned long		lkb_timestamp;
	unsigned long		lkb_timeout_cs;

	char			*lkb_lvbptr;
	struct dlm_lksb		*lkb_lksb;      /* caller's status block */
	void			*lkb_astaddr;	/* caller's ast function */
	void			*lkb_bastaddr;	/* caller's bast function */
	long			lkb_astparam;	/* caller's ast arg */
};


struct dlm_rsb {
	struct dlm_ls		*res_ls;	/* the lockspace */
	struct kref		res_ref;
	struct mutex		res_mutex;
	unsigned long		res_flags;
	int			res_length;	/* length of rsb name */
	int			res_nodeid;
	uint32_t                res_lvbseq;
	uint32_t		res_hash;
	uint32_t		res_bucket;	/* rsbtbl */
	unsigned long		res_toss_time;
	uint32_t		res_first_lkid;
	struct list_head	res_lookup;	/* lkbs waiting on first */
	struct list_head	res_hashchain;	/* rsbtbl */
	struct list_head	res_grantqueue;
	struct list_head	res_convertqueue;
	struct list_head	res_waitqueue;

	struct list_head	res_root_list;	    /* used for recovery */
	struct list_head	res_recover_list;   /* used for recovery */
	int			res_recover_locks_count;

	char			*res_lvbptr;
	char			res_name[1];
};

/* find_rsb() flags */

#define R_MASTER		1	/* only return rsb if it's a master */
#define R_CREATE		2	/* create/add rsb if not found */

/* rsb_flags */

enum rsb_flags {
	RSB_MASTER_UNCERTAIN,
	RSB_VALNOTVALID,
	RSB_VALNOTVALID_PREV,
	RSB_NEW_MASTER,
	RSB_NEW_MASTER2,
	RSB_RECOVER_CONVERT,
	RSB_LOCKS_PURGED,
};

static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
{
	__set_bit(flag, &r->res_flags);
}

static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
{
	__clear_bit(flag, &r->res_flags);
}

static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
{
	return test_bit(flag, &r->res_flags);
}


/* dlm_header is first element of all structs sent between nodes */

#define DLM_HEADER_MAJOR	0x00030000
#define DLM_HEADER_MINOR	0x00000000

#define DLM_MSG			1
#define DLM_RCOM		2

struct dlm_header {
	uint32_t		h_version;
	uint32_t		h_lockspace;
	uint32_t		h_nodeid;	/* nodeid of sender */
	uint16_t		h_length;
	uint8_t			h_cmd;		/* DLM_MSG, DLM_RCOM */
	uint8_t			h_pad;
};


#define DLM_MSG_REQUEST		1
#define DLM_MSG_CONVERT		2
#define DLM_MSG_UNLOCK		3
#define DLM_MSG_CANCEL		4
#define DLM_MSG_REQUEST_REPLY	5
#define DLM_MSG_CONVERT_REPLY	6
#define DLM_MSG_UNLOCK_REPLY	7
#define DLM_MSG_CANCEL_REPLY	8
#define DLM_MSG_GRANT		9
#define DLM_MSG_BAST		10
#define DLM_MSG_LOOKUP		11
#define DLM_MSG_REMOVE		12
#define DLM_MSG_LOOKUP_REPLY	13
#define DLM_MSG_PURGE		14

struct dlm_message {
	struct dlm_header	m_header;
	uint32_t		m_type;		/* DLM_MSG_ */
	uint32_t		m_nodeid;
	uint32_t		m_pid;
	uint32_t		m_lkid;		/* lkid on sender */
	uint32_t		m_remid;	/* lkid on receiver */
	uint32_t		m_parent_lkid;
	uint32_t		m_parent_remid;
	uint32_t		m_exflags;
	uint32_t		m_sbflags;
	uint32_t		m_flags;
	uint32_t		m_lvbseq;
	uint32_t		m_hash;
	int			m_status;
	int			m_grmode;
	int			m_rqmode;
	int			m_bastmode;
	int			m_asts;
	int			m_result;	/* 0 or -EXXX */
	char			m_extra[0];	/* name or lvb */
};


#define DLM_RS_NODES		0x00000001
#define DLM_RS_NODES_ALL	0x00000002
#define DLM_RS_DIR		0x00000004
#define DLM_RS_DIR_ALL		0x00000008
#define DLM_RS_LOCKS		0x00000010
#define DLM_RS_LOCKS_ALL	0x00000020
#define DLM_RS_DONE		0x00000040
#define DLM_RS_DONE_ALL		0x00000080

#define DLM_RCOM_STATUS		1
#define DLM_RCOM_NAMES		2
#define DLM_RCOM_LOOKUP		3
#define DLM_RCOM_LOCK		4
#define DLM_RCOM_STATUS_REPLY	5
#define DLM_RCOM_NAMES_REPLY	6
#define DLM_RCOM_LOOKUP_REPLY	7
#define DLM_RCOM_LOCK_REPLY	8

struct dlm_rcom {
	struct dlm_header	rc_header;
	uint32_t		rc_type;	/* DLM_RCOM_ */
	int			rc_result;	/* multi-purpose */
	uint64_t		rc_id;		/* match reply with request */
	uint64_t		rc_seq;		/* sender's ls_recover_seq */
	uint64_t		rc_seq_reply;	/* remote ls_recover_seq */
	char			rc_buf[0];
};

struct rcom_config {
	uint32_t		rf_lvblen;
	uint32_t		rf_lsflags;
	uint64_t		rf_unused;
};

struct rcom_lock {
	uint32_t		rl_ownpid;
	uint32_t		rl_lkid;
	uint32_t		rl_remid;
	uint32_t		rl_parent_lkid;
	uint32_t		rl_parent_remid;
	uint32_t		rl_exflags;
	uint32_t		rl_flags;
	uint32_t		rl_lvbseq;
	int			rl_result;
	int8_t			rl_rqmode;
	int8_t			rl_grmode;
	int8_t			rl_status;
	int8_t			rl_asts;
	uint16_t		rl_wait_type;
	uint16_t		rl_namelen;
	char			rl_name[DLM_RESNAME_MAXLEN];
	char			rl_lvb[0];
};

struct dlm_ls {
	struct list_head	ls_list;	/* list of lockspaces */
	dlm_lockspace_t		*ls_local_handle;
	uint32_t		ls_global_id;	/* global unique lockspace ID */
	uint32_t		ls_exflags;
	int			ls_lvblen;
	int			ls_count;	/* reference count */
	unsigned long		ls_flags;	/* LSFL_ */
	struct kobject		ls_kobj;

	struct dlm_rsbtable	*ls_rsbtbl;
	uint32_t		ls_rsbtbl_size;

	struct dlm_lkbtable	*ls_lkbtbl;
	uint32_t		ls_lkbtbl_size;

	struct dlm_dirtable	*ls_dirtbl;
	uint32_t		ls_dirtbl_size;

	struct mutex		ls_waiters_mutex;
	struct list_head	ls_waiters;	/* lkbs needing a reply */

	struct mutex		ls_orphans_mutex;
	struct list_head	ls_orphans;

	struct mutex		ls_timeout_mutex;
	struct list_head	ls_timeout;

	struct list_head	ls_nodes;	/* current nodes in ls */
	struct list_head	ls_nodes_gone;	/* dead node list, recovery */
	int			ls_num_nodes;	/* number of nodes in ls */
	int			ls_low_nodeid;
	int			ls_total_weight;
	int			*ls_node_array;

	struct dlm_rsb		ls_stub_rsb;	/* for returning errors */
	struct dlm_lkb		ls_stub_lkb;	/* for returning errors */
	struct dlm_message	ls_stub_ms;	/* for faking a reply */

	struct dentry		*ls_debug_rsb_dentry; /* debugfs */
	struct dentry		*ls_debug_waiters_dentry; /* debugfs */

	wait_queue_head_t	ls_uevent_wait;	/* user part of join/leave */
	int			ls_uevent_result;

	struct miscdevice       ls_device;

	/* recovery related */

	struct timer_list	ls_timer;
	struct task_struct	*ls_recoverd_task;
	struct mutex		ls_recoverd_active;
	spinlock_t		ls_recover_lock;
	unsigned long		ls_recover_begin; /* jiffies timestamp */
	uint32_t		ls_recover_status; /* DLM_RS_ */
	uint64_t		ls_recover_seq;
	struct dlm_recover	*ls_recover_args;
	struct rw_semaphore	ls_in_recovery;	/* block local requests */
	struct list_head	ls_requestqueue;/* queue remote requests */
	struct mutex		ls_requestqueue_mutex;
	char			*ls_recover_buf;
	int			ls_recover_nodeid; /* for debugging */
	uint64_t		ls_rcom_seq;
	spinlock_t		ls_rcom_spin;
	struct list_head	ls_recover_list;
	spinlock_t		ls_recover_list_lock;
	int			ls_recover_list_count;
	wait_queue_head_t	ls_wait_general;
	struct mutex		ls_clear_proc_locks;

	struct list_head	ls_root_list;	/* root resources */
	struct rw_semaphore	ls_root_sem;	/* protect root_list */

	int			ls_namelen;
	char			ls_name[1];
};

#define LSFL_WORK		0
#define LSFL_RUNNING		1
#define LSFL_RECOVERY_STOP	2
#define LSFL_RCOM_READY		3
#define LSFL_RCOM_WAIT		4
#define LSFL_UEVENT_WAIT	5
#define LSFL_TIMEWARN		6

/* much of this is just saving user space pointers associated with the
   lock that we pass back to the user lib with an ast */

struct dlm_user_args {
	struct dlm_user_proc	*proc; /* each process that opens the lockspace
					  device has private data
					  (dlm_user_proc) on the struct file,
					  the process's locks point back to it*/
	struct dlm_lksb		lksb;
	int			old_mode;
	int			update_user_lvb;
	struct dlm_lksb __user	*user_lksb;
	void __user		*castparam;
	void __user		*castaddr;
	void __user		*bastparam;
	void __user		*bastaddr;
	uint64_t		xid;
};

#define DLM_PROC_FLAGS_CLOSING 1
#define DLM_PROC_FLAGS_COMPAT  2

/* locks list is kept so we can remove all a process's locks when it
   exits (or orphan those that are persistent) */

struct dlm_user_proc {
	dlm_lockspace_t		*lockspace;
	unsigned long		flags; /* DLM_PROC_FLAGS */
	struct list_head	asts;
	spinlock_t		asts_spin;
	struct list_head	locks;
	spinlock_t		locks_spin;
	struct list_head	unlocking;
	wait_queue_head_t	wait;
};

static inline int dlm_locking_stopped(struct dlm_ls *ls)
{
	return !test_bit(LSFL_RUNNING, &ls->ls_flags);
}

static inline int dlm_recovery_stopped(struct dlm_ls *ls)
{
	return test_bit(LSFL_RECOVERY_STOP, &ls->ls_flags);
}

static inline int dlm_no_directory(struct dlm_ls *ls)
{
	return (ls->ls_exflags & DLM_LSFL_NODIR) ? 1 : 0;
}

#endif				/* __DLM_INTERNAL_DOT_H__ */
Commit	Line	Data
e7fd4179 DT	1	/******************************************************************************
	2	*******************************************************************************
	3	**
	4	** Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
ef0c2bb0	5	** Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
e7fd4179 DT	6	**
	7	** This copyrighted material is made available to anyone wishing to use,
	8	** modify, copy, or redistribute it subject to the terms and conditions
	9	** of the GNU General Public License v.2.
	10	**
	11	*******************************************************************************
	12	******************************************************************************/
	13
	14	#ifndef __DLM_INTERNAL_DOT_H__
	15	#define __DLM_INTERNAL_DOT_H__
	16
	17	/*
	18	* This is the main header file to be included in each DLM source file.
	19	*/
	20
	21	#include <linux/module.h>
	22	#include <linux/slab.h>
	23	#include <linux/sched.h>
	24	#include <linux/types.h>
	25	#include <linux/ctype.h>
	26	#include <linux/spinlock.h>
	27	#include <linux/vmalloc.h>
	28	#include <linux/list.h>
	29	#include <linux/errno.h>
	30	#include <linux/random.h>
	31	#include <linux/delay.h>
	32	#include <linux/socket.h>
	33	#include <linux/kthread.h>
	34	#include <linux/kobject.h>
	35	#include <linux/kref.h>
	36	#include <linux/kernel.h>
	37	#include <linux/jhash.h>
597d0cae	38	#include <linux/miscdevice.h>
90135925	39	#include <linux/mutex.h>
e7fd4179 DT	40	#include <asm/semaphore.h>
	41	#include <asm/uaccess.h>
	42
	43	#include <linux/dlm.h>
99fc6487	44	#include "config.h"
e7fd4179 DT	45
	46	#define DLM_LOCKSPACE_LEN 64
	47
e7fd4179 DT	48	/* Size of the temp buffer midcomms allocates on the stack.
	49	We try to make this large enough so most messages fit.
	50	FIXME: should sctp make this unnecessary? */
	51
	52	#define DLM_INBUF_LEN 148
	53
	54	struct dlm_ls;
	55	struct dlm_lkb;
	56	struct dlm_rsb;
	57	struct dlm_member;
	58	struct dlm_lkbtable;
	59	struct dlm_rsbtable;
	60	struct dlm_dirtable;
	61	struct dlm_direntry;
	62	struct dlm_recover;
	63	struct dlm_header;
	64	struct dlm_message;
	65	struct dlm_rcom;
	66	struct dlm_mhandle;
	67
	68	#define log_print(fmt, args...) \
	69	printk(KERN_ERR "dlm: "fmt"\n" , ##args)
	70	#define log_error(ls, fmt, args...) \
	71	printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
	72
99fc6487 DT	73	#define log_debug(ls, fmt, args...) \
	74	do { \
	75	if (dlm_config.ci_log_debug) \
	76	printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
	77	(ls)->ls_name , ##args); \
	78	} while (0)
e7fd4179 DT	79
	80	#define DLM_ASSERT(x, do) \
	81	{ \
	82	if (!(x)) \
	83	{ \
	84	printk(KERN_ERR "\nDLM: Assertion failed on line %d of file %s\n" \
	85	"DLM: assertion: \"%s\"\n" \
	86	"DLM: time = %lu\n", \
	87	__LINE__, __FILE__, #x, jiffies); \
	88	{do} \
	89	printk("\n"); \
	90	BUG(); \
	91	panic("DLM: Record message above and reboot.\n"); \
	92	} \
	93	}
	94
32f105a1 DT	95	#define DLM_FAKE_USER_AST ERR_PTR(-EINVAL)
32f105a1 DT	96
e7fd4179 DT	97
	98	struct dlm_direntry {
	99	struct list_head list;
	100	uint32_t master_nodeid;
	101	uint16_t length;
	102	char name[1];
	103	};
	104
	105	struct dlm_dirtable {
	106	struct list_head list;
	107	rwlock_t lock;
	108	};
	109
	110	struct dlm_rsbtable {
	111	struct list_head list;
	112	struct list_head toss;
	113	rwlock_t lock;
	114	};
	115
	116	struct dlm_lkbtable {
	117	struct list_head list;
	118	rwlock_t lock;
	119	uint16_t counter;
	120	};
	121
	122	/*
	123	* Lockspace member (per node in a ls)
	124	*/
	125
	126	struct dlm_member {
	127	struct list_head list;
	128	int nodeid;
	129	int weight;
	130	};
	131
	132	/*
	133	* Save and manage recovery state for a lockspace.
	134	*/
	135
	136	struct dlm_recover {
	137	struct list_head list;
	138	int *nodeids;
	139	int node_count;
	140	uint64_t seq;
	141	};
	142
	143	/*
	144	* Pass input args to second stage locking function.
	145	*/
	146
	147	struct dlm_args {
	148	uint32_t flags;
	149	void *astaddr;
	150	long astparam;
	151	void *bastaddr;
	152	int mode;
	153	struct dlm_lksb *lksb;
d7db923e	154	unsigned long timeout;
e7fd4179 DT	155	};
	156
	157
	158	/*
	159	* Lock block
	160	*
	161	* A lock can be one of three types:
	162	*
	163	* local copy lock is mastered locally
	164	* (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
	165	* process copy lock is mastered on a remote node
	166	* (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
	167	* master copy master node's copy of a lock owned by remote node
	168	* (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
	169	*
	170	* lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
	171	* dlm_unlock. The dlm does not modify these or use any private flags in
	172	* this field; it only contains DLM_LKF_ flags from dlm.h. These flags
	173	* are sent as-is to the remote master when the lock is remote.
	174	*
	175	* lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
	176	* Some internal flags are shared between the master and process nodes;
	177	* these shared flags are kept in the lower two bytes. One of these
	178	* flags set on the master copy will be propagated to the process copy
	179	* and v.v. Other internal flags are private to the master or process
	180	* node (e.g. DLM_IFL_MSTCPY). These are kept in the high two bytes.
	181	*
	182	* lkb_sbflags: status block flags. These flags are copied directly into
	183	* the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
	184	* ast. All defined in dlm.h with DLM_SBF_ prefix.
	185	*
	186	* lkb_status: the lock status indicates which rsb queue the lock is
	187	* on, grant, convert, or wait. DLM_LKSTS_ WAITING/GRANTED/CONVERT
	188	*
	189	* lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
	190	* reply is needed. Only set when the lkb is on the lockspace waiters
	191	* list awaiting a reply from a remote node.
	192	*
	193	* lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
	194	* is a master copy, nodeid specifies the remote lock holder, when the
	195	* lkb is a process copy, the nodeid specifies the lock master.
	196	*/
	197
	198	/* lkb_ast_type */
	199
	200	#define AST_COMP 1
	201	#define AST_BAST 2
	202
e7fd4179 DT	203	/* lkb_status */
	204
	205	#define DLM_LKSTS_WAITING 1
	206	#define DLM_LKSTS_GRANTED 2
	207	#define DLM_LKSTS_CONVERT 3
	208
	209	/* lkb_flags */
	210
	211	#define DLM_IFL_MSTCPY 0x00010000
	212	#define DLM_IFL_RESEND 0x00020000
597d0cae	213	#define DLM_IFL_DEAD 0x00040000
ef0c2bb0 DT	214	#define DLM_IFL_OVERLAP_UNLOCK 0x00080000
	215	#define DLM_IFL_OVERLAP_CANCEL 0x00100000
	216	#define DLM_IFL_ENDOFLIFE 0x00200000
3ae1acf9	217	#define DLM_IFL_WATCH_TIMEWARN 0x00400000
597d0cae DT	218	#define DLM_IFL_USER 0x00000001
597d0cae DT	219	#define DLM_IFL_ORPHAN 0x00000002
3ae1acf9	220	#define DLM_IFL_TIMEOUT_CANCEL 0x00000004
e7fd4179 DT	221
	222	struct dlm_lkb {
	223	struct dlm_rsb lkb_resource; / the rsb */
	224	struct kref lkb_ref;
	225	int lkb_nodeid; /* copied from rsb */
	226	int lkb_ownpid; /* pid of lock owner */
	227	uint32_t lkb_id; /* our lock ID */
	228	uint32_t lkb_remid; /* lock ID on remote partner */
	229	uint32_t lkb_exflags; /* external flags from caller */
	230	uint32_t lkb_sbflags; /* lksb flags */
	231	uint32_t lkb_flags; /* internal flags */
	232	uint32_t lkb_lvbseq; /* lvb sequence number */
	233
	234	int8_t lkb_status; /* granted, waiting, convert */
	235	int8_t lkb_rqmode; /* requested lock mode */
	236	int8_t lkb_grmode; /* granted lock mode */
	237	int8_t lkb_bastmode; /* requested mode */
	238	int8_t lkb_highbast; /* highest mode bast sent for */
e7fd4179	239	int8_t lkb_wait_type; /* type of reply waiting for */
ef0c2bb0	240	int8_t lkb_wait_count;
e7fd4179 DT	241	int8_t lkb_ast_type; /* type of ast queued for */
	242
	243	struct list_head lkb_idtbl_list; /* lockspace lkbtbl */
	244	struct list_head lkb_statequeue; /* rsb g/c/w list */
	245	struct list_head lkb_rsb_lookup; /* waiting for rsb lookup */
	246	struct list_head lkb_wait_reply; /* waiting for remote reply */
	247	struct list_head lkb_astqueue; /* need ast to be sent */
597d0cae	248	struct list_head lkb_ownqueue; /* list of locks for a process */
3ae1acf9 DT	249	struct list_head lkb_time_list;
	250	unsigned long lkb_timestamp;
	251	unsigned long lkb_timeout_cs;
e7fd4179	252
e7fd4179 DT	253	char *lkb_lvbptr;
	254	struct dlm_lksb lkb_lksb; / caller's status block */
	255	void lkb_astaddr; / caller's ast function */
	256	void lkb_bastaddr; / caller's bast function */
	257	long lkb_astparam; /* caller's ast arg */
	258	};
	259
	260
	261	struct dlm_rsb {
	262	struct dlm_ls res_ls; / the lockspace */
	263	struct kref res_ref;
90135925	264	struct mutex res_mutex;
e7fd4179 DT	265	unsigned long res_flags;
	266	int res_length; /* length of rsb name */
	267	int res_nodeid;
	268	uint32_t res_lvbseq;
	269	uint32_t res_hash;
	270	uint32_t res_bucket; /* rsbtbl */
	271	unsigned long res_toss_time;
	272	uint32_t res_first_lkid;
	273	struct list_head res_lookup; /* lkbs waiting on first */
	274	struct list_head res_hashchain; /* rsbtbl */
	275	struct list_head res_grantqueue;
	276	struct list_head res_convertqueue;
	277	struct list_head res_waitqueue;
	278
	279	struct list_head res_root_list; /* used for recovery */
	280	struct list_head res_recover_list; /* used for recovery */
	281	int res_recover_locks_count;
	282
	283	char *res_lvbptr;
	284	char res_name[1];
	285	};
	286
	287	/* find_rsb() flags */
	288
	289	#define R_MASTER 1 /* only return rsb if it's a master */
	290	#define R_CREATE 2 /* create/add rsb if not found */
	291
	292	/* rsb_flags */
	293
	294	enum rsb_flags {
	295	RSB_MASTER_UNCERTAIN,
	296	RSB_VALNOTVALID,
	297	RSB_VALNOTVALID_PREV,
	298	RSB_NEW_MASTER,
	299	RSB_NEW_MASTER2,
	300	RSB_RECOVER_CONVERT,
97a35d1e	301	RSB_LOCKS_PURGED,
e7fd4179 DT	302	};
	303
	304	static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
	305	{
	306	__set_bit(flag, &r->res_flags);
	307	}
	308
	309	static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
	310	{
	311	__clear_bit(flag, &r->res_flags);
	312	}
	313
	314	static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
	315	{
	316	return test_bit(flag, &r->res_flags);
	317	}
	318
	319
	320	/* dlm_header is first element of all structs sent between nodes */
	321
38aa8b0c DT	322	#define DLM_HEADER_MAJOR 0x00030000
38aa8b0c DT	323	#define DLM_HEADER_MINOR 0x00000000
e7fd4179 DT	324
	325	#define DLM_MSG 1
	326	#define DLM_RCOM 2
	327
	328	struct dlm_header {
	329	uint32_t h_version;
	330	uint32_t h_lockspace;
	331	uint32_t h_nodeid; /* nodeid of sender */
	332	uint16_t h_length;
	333	uint8_t h_cmd; /* DLM_MSG, DLM_RCOM */
	334	uint8_t h_pad;
	335	};
	336
	337
	338	#define DLM_MSG_REQUEST 1
	339	#define DLM_MSG_CONVERT 2
	340	#define DLM_MSG_UNLOCK 3
	341	#define DLM_MSG_CANCEL 4
	342	#define DLM_MSG_REQUEST_REPLY 5
	343	#define DLM_MSG_CONVERT_REPLY 6
	344	#define DLM_MSG_UNLOCK_REPLY 7
	345	#define DLM_MSG_CANCEL_REPLY 8
	346	#define DLM_MSG_GRANT 9
	347	#define DLM_MSG_BAST 10
	348	#define DLM_MSG_LOOKUP 11
	349	#define DLM_MSG_REMOVE 12
	350	#define DLM_MSG_LOOKUP_REPLY 13
8499137d	351	#define DLM_MSG_PURGE 14
e7fd4179 DT	352
	353	struct dlm_message {
	354	struct dlm_header m_header;
	355	uint32_t m_type; /* DLM_MSG_ */
	356	uint32_t m_nodeid;
	357	uint32_t m_pid;
	358	uint32_t m_lkid; /* lkid on sender */
	359	uint32_t m_remid; /* lkid on receiver */
	360	uint32_t m_parent_lkid;
	361	uint32_t m_parent_remid;
	362	uint32_t m_exflags;
	363	uint32_t m_sbflags;
	364	uint32_t m_flags;
	365	uint32_t m_lvbseq;
	366	uint32_t m_hash;
	367	int m_status;
	368	int m_grmode;
	369	int m_rqmode;
	370	int m_bastmode;
	371	int m_asts;
	372	int m_result; /* 0 or -EXXX */
e7fd4179 DT	373	char m_extra[0]; /* name or lvb */
	374	};
	375
	376
	377	#define DLM_RS_NODES 0x00000001
	378	#define DLM_RS_NODES_ALL 0x00000002
	379	#define DLM_RS_DIR 0x00000004
	380	#define DLM_RS_DIR_ALL 0x00000008
	381	#define DLM_RS_LOCKS 0x00000010
	382	#define DLM_RS_LOCKS_ALL 0x00000020
	383	#define DLM_RS_DONE 0x00000040
	384	#define DLM_RS_DONE_ALL 0x00000080
	385
	386	#define DLM_RCOM_STATUS 1
	387	#define DLM_RCOM_NAMES 2
	388	#define DLM_RCOM_LOOKUP 3
	389	#define DLM_RCOM_LOCK 4
	390	#define DLM_RCOM_STATUS_REPLY 5
	391	#define DLM_RCOM_NAMES_REPLY 6
	392	#define DLM_RCOM_LOOKUP_REPLY 7
	393	#define DLM_RCOM_LOCK_REPLY 8
	394
	395	struct dlm_rcom {
	396	struct dlm_header rc_header;
	397	uint32_t rc_type; /* DLM_RCOM_ */
	398	int rc_result; /* multi-purpose */
	399	uint64_t rc_id; /* match reply with request */
38aa8b0c DT	400	uint64_t rc_seq; /* sender's ls_recover_seq */
38aa8b0c DT	401	uint64_t rc_seq_reply; /* remote ls_recover_seq */
e7fd4179 DT	402	char rc_buf[0];
	403	};
	404
	405	struct rcom_config {
	406	uint32_t rf_lvblen;
	407	uint32_t rf_lsflags;
	408	uint64_t rf_unused;
	409	};
	410
	411	struct rcom_lock {
	412	uint32_t rl_ownpid;
	413	uint32_t rl_lkid;
	414	uint32_t rl_remid;
	415	uint32_t rl_parent_lkid;
	416	uint32_t rl_parent_remid;
	417	uint32_t rl_exflags;
	418	uint32_t rl_flags;
	419	uint32_t rl_lvbseq;
	420	int rl_result;
	421	int8_t rl_rqmode;
	422	int8_t rl_grmode;
	423	int8_t rl_status;
	424	int8_t rl_asts;
	425	uint16_t rl_wait_type;
	426	uint16_t rl_namelen;
e7fd4179 DT	427	char rl_name[DLM_RESNAME_MAXLEN];
	428	char rl_lvb[0];
	429	};
	430
	431	struct dlm_ls {
	432	struct list_head ls_list; /* list of lockspaces */
597d0cae	433	dlm_lockspace_t *ls_local_handle;
e7fd4179 DT	434	uint32_t ls_global_id; /* global unique lockspace ID */
	435	uint32_t ls_exflags;
	436	int ls_lvblen;
	437	int ls_count; /* reference count */
	438	unsigned long ls_flags; /* LSFL_ */
	439	struct kobject ls_kobj;
	440
	441	struct dlm_rsbtable *ls_rsbtbl;
	442	uint32_t ls_rsbtbl_size;
	443
	444	struct dlm_lkbtable *ls_lkbtbl;
	445	uint32_t ls_lkbtbl_size;
	446
	447	struct dlm_dirtable *ls_dirtbl;
	448	uint32_t ls_dirtbl_size;
	449
90135925	450	struct mutex ls_waiters_mutex;
e7fd4179 DT	451	struct list_head ls_waiters; /* lkbs needing a reply */
e7fd4179 DT	452
ef0c2bb0 DT	453	struct mutex ls_orphans_mutex;
	454	struct list_head ls_orphans;
	455
3ae1acf9 DT	456	struct mutex ls_timeout_mutex;
	457	struct list_head ls_timeout;
	458
e7fd4179 DT	459	struct list_head ls_nodes; /* current nodes in ls */
	460	struct list_head ls_nodes_gone; /* dead node list, recovery */
	461	int ls_num_nodes; /* number of nodes in ls */
	462	int ls_low_nodeid;
	463	int ls_total_weight;
	464	int *ls_node_array;
	465
	466	struct dlm_rsb ls_stub_rsb; /* for returning errors */
	467	struct dlm_lkb ls_stub_lkb; /* for returning errors */
	468	struct dlm_message ls_stub_ms; /* for faking a reply */
	469
5de6319b DT	470	struct dentry ls_debug_rsb_dentry; / debugfs */
5de6319b DT	471	struct dentry ls_debug_waiters_dentry; / debugfs */
e7fd4179 DT	472
	473	wait_queue_head_t ls_uevent_wait; /* user part of join/leave */
	474	int ls_uevent_result;
	475
597d0cae DT	476	struct miscdevice ls_device;
597d0cae DT	477
e7fd4179 DT	478	/* recovery related */
	479
	480	struct timer_list ls_timer;
	481	struct task_struct *ls_recoverd_task;
90135925	482	struct mutex ls_recoverd_active;
e7fd4179	483	spinlock_t ls_recover_lock;
3ae1acf9	484	unsigned long ls_recover_begin; /* jiffies timestamp */
e7fd4179 DT	485	uint32_t ls_recover_status; /* DLM_RS_ */
	486	uint64_t ls_recover_seq;
	487	struct dlm_recover *ls_recover_args;
	488	struct rw_semaphore ls_in_recovery; /* block local requests */
	489	struct list_head ls_requestqueue;/* queue remote requests */
90135925	490	struct mutex ls_requestqueue_mutex;
e7fd4179	491	char *ls_recover_buf;
faa0f267	492	int ls_recover_nodeid; /* for debugging */
4a99c3d9	493	uint64_t ls_rcom_seq;
98f176fb	494	spinlock_t ls_rcom_spin;
e7fd4179 DT	495	struct list_head ls_recover_list;
	496	spinlock_t ls_recover_list_lock;
	497	int ls_recover_list_count;
	498	wait_queue_head_t ls_wait_general;
597d0cae	499	struct mutex ls_clear_proc_locks;
e7fd4179 DT	500
	501	struct list_head ls_root_list; /* root resources */
	502	struct rw_semaphore ls_root_sem; /* protect root_list */
	503
	504	int ls_namelen;
	505	char ls_name[1];
	506	};
	507
	508	#define LSFL_WORK 0
	509	#define LSFL_RUNNING 1
	510	#define LSFL_RECOVERY_STOP 2
	511	#define LSFL_RCOM_READY 3
98f176fb DT	512	#define LSFL_RCOM_WAIT 4
98f176fb DT	513	#define LSFL_UEVENT_WAIT 5
3ae1acf9	514	#define LSFL_TIMEWARN 6
e7fd4179	515
597d0cae DT	516	/* much of this is just saving user space pointers associated with the
	517	lock that we pass back to the user lib with an ast */
	518
	519	struct dlm_user_args {
	520	struct dlm_user_proc proc; / each process that opens the lockspace
	521	device has private data
	522	(dlm_user_proc) on the struct file,
	523	the process's locks point back to it*/
	524	struct dlm_lksb lksb;
	525	int old_mode;
	526	int update_user_lvb;
	527	struct dlm_lksb __user *user_lksb;
	528	void __user *castparam;
	529	void __user *castaddr;
	530	void __user *bastparam;
	531	void __user *bastaddr;
d7db923e	532	uint64_t xid;
597d0cae DT	533	};
	534
	535	#define DLM_PROC_FLAGS_CLOSING 1
	536	#define DLM_PROC_FLAGS_COMPAT 2
	537
	538	/* locks list is kept so we can remove all a process's locks when it
	539	exits (or orphan those that are persistent) */
	540
	541	struct dlm_user_proc {
	542	dlm_lockspace_t *lockspace;
	543	unsigned long flags; /* DLM_PROC_FLAGS */
	544	struct list_head asts;
	545	spinlock_t asts_spin;
	546	struct list_head locks;
	547	spinlock_t locks_spin;
a1bc86e6	548	struct list_head unlocking;
597d0cae DT	549	wait_queue_head_t wait;
	550	};
	551
e7fd4179 DT	552	static inline int dlm_locking_stopped(struct dlm_ls *ls)
	553	{
	554	return !test_bit(LSFL_RUNNING, &ls->ls_flags);
	555	}
	556
	557	static inline int dlm_recovery_stopped(struct dlm_ls *ls)
	558	{
	559	return test_bit(LSFL_RECOVERY_STOP, &ls->ls_flags);
	560	}
	561
	562	static inline int dlm_no_directory(struct dlm_ls *ls)
	563	{
	564	return (ls->ls_exflags & DLM_LSFL_NODIR) ? 1 : 0;
	565	}
	566
	567	#endif /* __DLM_INTERNAL_DOT_H__ */
	568