xref: /openbmc/linux/fs/dlm/dlm_internal.h (revision c7be761a8163d2f1ac0b606c21e4316b7abc5af7)
1e7fd4179SDavid Teigland /******************************************************************************
2e7fd4179SDavid Teigland *******************************************************************************
3e7fd4179SDavid Teigland **
4e7fd4179SDavid Teigland **  Copyright (C) Sistina Software, Inc.  1997-2003  All rights reserved.
50f8e0d9aSDavid Teigland **  Copyright (C) 2004-2008 Red Hat, Inc.  All rights reserved.
6e7fd4179SDavid Teigland **
7e7fd4179SDavid Teigland **  This copyrighted material is made available to anyone wishing to use,
8e7fd4179SDavid Teigland **  modify, copy, or redistribute it subject to the terms and conditions
9e7fd4179SDavid Teigland **  of the GNU General Public License v.2.
10e7fd4179SDavid Teigland **
11e7fd4179SDavid Teigland *******************************************************************************
12e7fd4179SDavid Teigland ******************************************************************************/
13e7fd4179SDavid Teigland 
14e7fd4179SDavid Teigland #ifndef __DLM_INTERNAL_DOT_H__
15e7fd4179SDavid Teigland #define __DLM_INTERNAL_DOT_H__
16e7fd4179SDavid Teigland 
17e7fd4179SDavid Teigland /*
18e7fd4179SDavid Teigland  * This is the main header file to be included in each DLM source file.
19e7fd4179SDavid Teigland  */
20e7fd4179SDavid Teigland 
21e7fd4179SDavid Teigland #include <linux/module.h>
22e7fd4179SDavid Teigland #include <linux/slab.h>
23e7fd4179SDavid Teigland #include <linux/sched.h>
24e7fd4179SDavid Teigland #include <linux/types.h>
25e7fd4179SDavid Teigland #include <linux/ctype.h>
26e7fd4179SDavid Teigland #include <linux/spinlock.h>
27e7fd4179SDavid Teigland #include <linux/vmalloc.h>
28e7fd4179SDavid Teigland #include <linux/list.h>
29e7fd4179SDavid Teigland #include <linux/errno.h>
30e7fd4179SDavid Teigland #include <linux/random.h>
31e7fd4179SDavid Teigland #include <linux/delay.h>
32e7fd4179SDavid Teigland #include <linux/socket.h>
33e7fd4179SDavid Teigland #include <linux/kthread.h>
34e7fd4179SDavid Teigland #include <linux/kobject.h>
35e7fd4179SDavid Teigland #include <linux/kref.h>
36e7fd4179SDavid Teigland #include <linux/kernel.h>
37e7fd4179SDavid Teigland #include <linux/jhash.h>
38597d0caeSDavid Teigland #include <linux/miscdevice.h>
3990135925SDavid Teigland #include <linux/mutex.h>
40e7fd4179SDavid Teigland #include <asm/uaccess.h>
41e7fd4179SDavid Teigland 
42e7fd4179SDavid Teigland #include <linux/dlm.h>
4399fc6487SDavid Teigland #include "config.h"
44e7fd4179SDavid Teigland 
45e7fd4179SDavid Teigland /* Size of the temp buffer midcomms allocates on the stack.
46e7fd4179SDavid Teigland    We try to make this large enough so most messages fit.
47e7fd4179SDavid Teigland    FIXME: should sctp make this unnecessary? */
48e7fd4179SDavid Teigland 
49e7fd4179SDavid Teigland #define DLM_INBUF_LEN		148
50e7fd4179SDavid Teigland 
51e7fd4179SDavid Teigland struct dlm_ls;
52e7fd4179SDavid Teigland struct dlm_lkb;
53e7fd4179SDavid Teigland struct dlm_rsb;
54e7fd4179SDavid Teigland struct dlm_member;
55e7fd4179SDavid Teigland struct dlm_lkbtable;
56e7fd4179SDavid Teigland struct dlm_rsbtable;
57e7fd4179SDavid Teigland struct dlm_dirtable;
58e7fd4179SDavid Teigland struct dlm_direntry;
59e7fd4179SDavid Teigland struct dlm_recover;
60e7fd4179SDavid Teigland struct dlm_header;
61e7fd4179SDavid Teigland struct dlm_message;
62e7fd4179SDavid Teigland struct dlm_rcom;
63e7fd4179SDavid Teigland struct dlm_mhandle;
64e7fd4179SDavid Teigland 
65e7fd4179SDavid Teigland #define log_print(fmt, args...) \
66e7fd4179SDavid Teigland 	printk(KERN_ERR "dlm: "fmt"\n" , ##args)
67e7fd4179SDavid Teigland #define log_error(ls, fmt, args...) \
68e7fd4179SDavid Teigland 	printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
69e7fd4179SDavid Teigland 
7099fc6487SDavid Teigland #define log_debug(ls, fmt, args...) \
7199fc6487SDavid Teigland do { \
7299fc6487SDavid Teigland 	if (dlm_config.ci_log_debug) \
7399fc6487SDavid Teigland 		printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
7499fc6487SDavid Teigland 		       (ls)->ls_name , ##args); \
7599fc6487SDavid Teigland } while (0)
76e7fd4179SDavid Teigland 
77e7fd4179SDavid Teigland #define DLM_ASSERT(x, do) \
78e7fd4179SDavid Teigland { \
79e7fd4179SDavid Teigland   if (!(x)) \
80e7fd4179SDavid Teigland   { \
81e7fd4179SDavid Teigland     printk(KERN_ERR "\nDLM:  Assertion failed on line %d of file %s\n" \
82e7fd4179SDavid Teigland                "DLM:  assertion:  \"%s\"\n" \
83e7fd4179SDavid Teigland                "DLM:  time = %lu\n", \
84e7fd4179SDavid Teigland                __LINE__, __FILE__, #x, jiffies); \
85e7fd4179SDavid Teigland     {do} \
86e7fd4179SDavid Teigland     printk("\n"); \
87e7fd4179SDavid Teigland     BUG(); \
88e7fd4179SDavid Teigland     panic("DLM:  Record message above and reboot.\n"); \
89e7fd4179SDavid Teigland   } \
90e7fd4179SDavid Teigland }
91e7fd4179SDavid Teigland 
92e7fd4179SDavid Teigland 
93e7fd4179SDavid Teigland struct dlm_direntry {
94e7fd4179SDavid Teigland 	struct list_head	list;
95e7fd4179SDavid Teigland 	uint32_t		master_nodeid;
96e7fd4179SDavid Teigland 	uint16_t		length;
97e7fd4179SDavid Teigland 	char			name[1];
98e7fd4179SDavid Teigland };
99e7fd4179SDavid Teigland 
100e7fd4179SDavid Teigland struct dlm_dirtable {
101e7fd4179SDavid Teigland 	struct list_head	list;
102e7fd4179SDavid Teigland 	rwlock_t		lock;
103e7fd4179SDavid Teigland };
104e7fd4179SDavid Teigland 
105e7fd4179SDavid Teigland struct dlm_rsbtable {
106e7fd4179SDavid Teigland 	struct list_head	list;
107e7fd4179SDavid Teigland 	struct list_head	toss;
108*c7be761aSDavid Teigland 	spinlock_t		lock;
109e7fd4179SDavid Teigland };
110e7fd4179SDavid Teigland 
111e7fd4179SDavid Teigland struct dlm_lkbtable {
112e7fd4179SDavid Teigland 	struct list_head	list;
113e7fd4179SDavid Teigland 	rwlock_t		lock;
114e7fd4179SDavid Teigland 	uint16_t		counter;
115e7fd4179SDavid Teigland };
116e7fd4179SDavid Teigland 
117e7fd4179SDavid Teigland /*
118e7fd4179SDavid Teigland  * Lockspace member (per node in a ls)
119e7fd4179SDavid Teigland  */
120e7fd4179SDavid Teigland 
121e7fd4179SDavid Teigland struct dlm_member {
122e7fd4179SDavid Teigland 	struct list_head	list;
123e7fd4179SDavid Teigland 	int			nodeid;
124e7fd4179SDavid Teigland 	int			weight;
125e7fd4179SDavid Teigland };
126e7fd4179SDavid Teigland 
127e7fd4179SDavid Teigland /*
128e7fd4179SDavid Teigland  * Save and manage recovery state for a lockspace.
129e7fd4179SDavid Teigland  */
130e7fd4179SDavid Teigland 
131e7fd4179SDavid Teigland struct dlm_recover {
132e7fd4179SDavid Teigland 	struct list_head	list;
133d44e0fc7SDavid Teigland 	int			*nodeids;   /* nodeids of all members */
134e7fd4179SDavid Teigland 	int			node_count;
135d44e0fc7SDavid Teigland 	int			*new;       /* nodeids of new members */
136d44e0fc7SDavid Teigland 	int			new_count;
137e7fd4179SDavid Teigland 	uint64_t		seq;
138e7fd4179SDavid Teigland };
139e7fd4179SDavid Teigland 
140e7fd4179SDavid Teigland /*
141e7fd4179SDavid Teigland  * Pass input args to second stage locking function.
142e7fd4179SDavid Teigland  */
143e7fd4179SDavid Teigland 
144e7fd4179SDavid Teigland struct dlm_args {
145e7fd4179SDavid Teigland 	uint32_t		flags;
146e5dae548SDavid Teigland 	void			(*astfn) (void *astparam);
147e5dae548SDavid Teigland 	void			*astparam;
148e5dae548SDavid Teigland 	void			(*bastfn) (void *astparam, int mode);
149e7fd4179SDavid Teigland 	int			mode;
150e7fd4179SDavid Teigland 	struct dlm_lksb		*lksb;
151d7db923eSDavid Teigland 	unsigned long		timeout;
152e7fd4179SDavid Teigland };
153e7fd4179SDavid Teigland 
154e7fd4179SDavid Teigland 
155e7fd4179SDavid Teigland /*
156e7fd4179SDavid Teigland  * Lock block
157e7fd4179SDavid Teigland  *
158e7fd4179SDavid Teigland  * A lock can be one of three types:
159e7fd4179SDavid Teigland  *
160e7fd4179SDavid Teigland  * local copy      lock is mastered locally
161e7fd4179SDavid Teigland  *                 (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
162e7fd4179SDavid Teigland  * process copy    lock is mastered on a remote node
163e7fd4179SDavid Teigland  *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
164e7fd4179SDavid Teigland  * master copy     master node's copy of a lock owned by remote node
165e7fd4179SDavid Teigland  *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
166e7fd4179SDavid Teigland  *
167e7fd4179SDavid Teigland  * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
168e7fd4179SDavid Teigland  * dlm_unlock.  The dlm does not modify these or use any private flags in
169e7fd4179SDavid Teigland  * this field; it only contains DLM_LKF_ flags from dlm.h.  These flags
170e7fd4179SDavid Teigland  * are sent as-is to the remote master when the lock is remote.
171e7fd4179SDavid Teigland  *
172e7fd4179SDavid Teigland  * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
173e7fd4179SDavid Teigland  * Some internal flags are shared between the master and process nodes;
174e7fd4179SDavid Teigland  * these shared flags are kept in the lower two bytes.  One of these
175e7fd4179SDavid Teigland  * flags set on the master copy will be propagated to the process copy
176e7fd4179SDavid Teigland  * and v.v.  Other internal flags are private to the master or process
177e7fd4179SDavid Teigland  * node (e.g. DLM_IFL_MSTCPY).  These are kept in the high two bytes.
178e7fd4179SDavid Teigland  *
179e7fd4179SDavid Teigland  * lkb_sbflags: status block flags.  These flags are copied directly into
180e7fd4179SDavid Teigland  * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
181e7fd4179SDavid Teigland  * ast.  All defined in dlm.h with DLM_SBF_ prefix.
182e7fd4179SDavid Teigland  *
183e7fd4179SDavid Teigland  * lkb_status: the lock status indicates which rsb queue the lock is
184e7fd4179SDavid Teigland  * on, grant, convert, or wait.  DLM_LKSTS_ WAITING/GRANTED/CONVERT
185e7fd4179SDavid Teigland  *
186e7fd4179SDavid Teigland  * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
187e7fd4179SDavid Teigland  * reply is needed.  Only set when the lkb is on the lockspace waiters
188e7fd4179SDavid Teigland  * list awaiting a reply from a remote node.
189e7fd4179SDavid Teigland  *
190e7fd4179SDavid Teigland  * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
191e7fd4179SDavid Teigland  * is a master copy, nodeid specifies the remote lock holder, when the
192e7fd4179SDavid Teigland  * lkb is a process copy, the nodeid specifies the lock master.
193e7fd4179SDavid Teigland  */
194e7fd4179SDavid Teigland 
195e7fd4179SDavid Teigland /* lkb_ast_type */
196e7fd4179SDavid Teigland 
197e7fd4179SDavid Teigland #define AST_COMP		1
198e7fd4179SDavid Teigland #define AST_BAST		2
199e7fd4179SDavid Teigland 
200e7fd4179SDavid Teigland /* lkb_status */
201e7fd4179SDavid Teigland 
202e7fd4179SDavid Teigland #define DLM_LKSTS_WAITING	1
203e7fd4179SDavid Teigland #define DLM_LKSTS_GRANTED	2
204e7fd4179SDavid Teigland #define DLM_LKSTS_CONVERT	3
205e7fd4179SDavid Teigland 
206e7fd4179SDavid Teigland /* lkb_flags */
207e7fd4179SDavid Teigland 
208e7fd4179SDavid Teigland #define DLM_IFL_MSTCPY		0x00010000
209e7fd4179SDavid Teigland #define DLM_IFL_RESEND		0x00020000
210597d0caeSDavid Teigland #define DLM_IFL_DEAD		0x00040000
211ef0c2bb0SDavid Teigland #define DLM_IFL_OVERLAP_UNLOCK  0x00080000
212ef0c2bb0SDavid Teigland #define DLM_IFL_OVERLAP_CANCEL  0x00100000
213ef0c2bb0SDavid Teigland #define DLM_IFL_ENDOFLIFE	0x00200000
2143ae1acf9SDavid Teigland #define DLM_IFL_WATCH_TIMEWARN	0x00400000
21584d8cd69SDavid Teigland #define DLM_IFL_TIMEOUT_CANCEL	0x00800000
2168b4021faSDavid Teigland #define DLM_IFL_DEADLOCK_CANCEL	0x01000000
217597d0caeSDavid Teigland #define DLM_IFL_USER		0x00000001
218597d0caeSDavid Teigland #define DLM_IFL_ORPHAN		0x00000002
219e7fd4179SDavid Teigland 
220e7fd4179SDavid Teigland struct dlm_lkb {
221e7fd4179SDavid Teigland 	struct dlm_rsb		*lkb_resource;	/* the rsb */
222e7fd4179SDavid Teigland 	struct kref		lkb_ref;
223e7fd4179SDavid Teigland 	int			lkb_nodeid;	/* copied from rsb */
224e7fd4179SDavid Teigland 	int			lkb_ownpid;	/* pid of lock owner */
225e7fd4179SDavid Teigland 	uint32_t		lkb_id;		/* our lock ID */
226e7fd4179SDavid Teigland 	uint32_t		lkb_remid;	/* lock ID on remote partner */
227e7fd4179SDavid Teigland 	uint32_t		lkb_exflags;	/* external flags from caller */
228e7fd4179SDavid Teigland 	uint32_t		lkb_sbflags;	/* lksb flags */
229e7fd4179SDavid Teigland 	uint32_t		lkb_flags;	/* internal flags */
230e7fd4179SDavid Teigland 	uint32_t		lkb_lvbseq;	/* lvb sequence number */
231e7fd4179SDavid Teigland 
232e7fd4179SDavid Teigland 	int8_t			lkb_status;     /* granted, waiting, convert */
233e7fd4179SDavid Teigland 	int8_t			lkb_rqmode;	/* requested lock mode */
234e7fd4179SDavid Teigland 	int8_t			lkb_grmode;	/* granted lock mode */
235e7fd4179SDavid Teigland 	int8_t			lkb_bastmode;	/* requested mode */
236e7fd4179SDavid Teigland 	int8_t			lkb_highbast;	/* highest mode bast sent for */
237e7fd4179SDavid Teigland 	int8_t			lkb_wait_type;	/* type of reply waiting for */
238ef0c2bb0SDavid Teigland 	int8_t			lkb_wait_count;
239e7fd4179SDavid Teigland 	int8_t			lkb_ast_type;	/* type of ast queued for */
240e7fd4179SDavid Teigland 
241e7fd4179SDavid Teigland 	struct list_head	lkb_idtbl_list;	/* lockspace lkbtbl */
242e7fd4179SDavid Teigland 	struct list_head	lkb_statequeue;	/* rsb g/c/w list */
243e7fd4179SDavid Teigland 	struct list_head	lkb_rsb_lookup;	/* waiting for rsb lookup */
244e7fd4179SDavid Teigland 	struct list_head	lkb_wait_reply;	/* waiting for remote reply */
245e7fd4179SDavid Teigland 	struct list_head	lkb_astqueue;	/* need ast to be sent */
246597d0caeSDavid Teigland 	struct list_head	lkb_ownqueue;	/* list of locks for a process */
2473ae1acf9SDavid Teigland 	struct list_head	lkb_time_list;
248e3a84ad4SDavid Teigland 	ktime_t			lkb_time_bast;	/* for debugging */
249eeda418dSDavid Teigland 	ktime_t			lkb_timestamp;
2503ae1acf9SDavid Teigland 	unsigned long		lkb_timeout_cs;
251e7fd4179SDavid Teigland 
252e7fd4179SDavid Teigland 	char			*lkb_lvbptr;
253e7fd4179SDavid Teigland 	struct dlm_lksb		*lkb_lksb;      /* caller's status block */
254e5dae548SDavid Teigland 	void			(*lkb_astfn) (void *astparam);
255e5dae548SDavid Teigland 	void			(*lkb_bastfn) (void *astparam, int mode);
256d292c0ccSDavid Teigland 	union {
257e5dae548SDavid Teigland 		void			*lkb_astparam;	/* caller's ast arg */
258d292c0ccSDavid Teigland 		struct dlm_user_args	*lkb_ua;
259d292c0ccSDavid Teigland 	};
260e7fd4179SDavid Teigland };
261e7fd4179SDavid Teigland 
262e7fd4179SDavid Teigland 
263e7fd4179SDavid Teigland struct dlm_rsb {
264e7fd4179SDavid Teigland 	struct dlm_ls		*res_ls;	/* the lockspace */
265e7fd4179SDavid Teigland 	struct kref		res_ref;
26690135925SDavid Teigland 	struct mutex		res_mutex;
267e7fd4179SDavid Teigland 	unsigned long		res_flags;
268e7fd4179SDavid Teigland 	int			res_length;	/* length of rsb name */
269e7fd4179SDavid Teigland 	int			res_nodeid;
270e7fd4179SDavid Teigland 	uint32_t                res_lvbseq;
271e7fd4179SDavid Teigland 	uint32_t		res_hash;
272e7fd4179SDavid Teigland 	uint32_t		res_bucket;	/* rsbtbl */
273e7fd4179SDavid Teigland 	unsigned long		res_toss_time;
274e7fd4179SDavid Teigland 	uint32_t		res_first_lkid;
275e7fd4179SDavid Teigland 	struct list_head	res_lookup;	/* lkbs waiting on first */
276e7fd4179SDavid Teigland 	struct list_head	res_hashchain;	/* rsbtbl */
277e7fd4179SDavid Teigland 	struct list_head	res_grantqueue;
278e7fd4179SDavid Teigland 	struct list_head	res_convertqueue;
279e7fd4179SDavid Teigland 	struct list_head	res_waitqueue;
280e7fd4179SDavid Teigland 
281e7fd4179SDavid Teigland 	struct list_head	res_root_list;	    /* used for recovery */
282e7fd4179SDavid Teigland 	struct list_head	res_recover_list;   /* used for recovery */
283e7fd4179SDavid Teigland 	int			res_recover_locks_count;
284e7fd4179SDavid Teigland 
285e7fd4179SDavid Teigland 	char			*res_lvbptr;
286e7fd4179SDavid Teigland 	char			res_name[1];
287e7fd4179SDavid Teigland };
288e7fd4179SDavid Teigland 
289e7fd4179SDavid Teigland /* find_rsb() flags */
290e7fd4179SDavid Teigland 
291e7fd4179SDavid Teigland #define R_MASTER		1	/* only return rsb if it's a master */
292e7fd4179SDavid Teigland #define R_CREATE		2	/* create/add rsb if not found */
293e7fd4179SDavid Teigland 
294e7fd4179SDavid Teigland /* rsb_flags */
295e7fd4179SDavid Teigland 
296e7fd4179SDavid Teigland enum rsb_flags {
297e7fd4179SDavid Teigland 	RSB_MASTER_UNCERTAIN,
298e7fd4179SDavid Teigland 	RSB_VALNOTVALID,
299e7fd4179SDavid Teigland 	RSB_VALNOTVALID_PREV,
300e7fd4179SDavid Teigland 	RSB_NEW_MASTER,
301e7fd4179SDavid Teigland 	RSB_NEW_MASTER2,
302e7fd4179SDavid Teigland 	RSB_RECOVER_CONVERT,
30397a35d1eSDavid Teigland 	RSB_LOCKS_PURGED,
304e7fd4179SDavid Teigland };
305e7fd4179SDavid Teigland 
306e7fd4179SDavid Teigland static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
307e7fd4179SDavid Teigland {
308e7fd4179SDavid Teigland 	__set_bit(flag, &r->res_flags);
309e7fd4179SDavid Teigland }
310e7fd4179SDavid Teigland 
311e7fd4179SDavid Teigland static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
312e7fd4179SDavid Teigland {
313e7fd4179SDavid Teigland 	__clear_bit(flag, &r->res_flags);
314e7fd4179SDavid Teigland }
315e7fd4179SDavid Teigland 
316e7fd4179SDavid Teigland static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
317e7fd4179SDavid Teigland {
318e7fd4179SDavid Teigland 	return test_bit(flag, &r->res_flags);
319e7fd4179SDavid Teigland }
320e7fd4179SDavid Teigland 
321e7fd4179SDavid Teigland 
322e7fd4179SDavid Teigland /* dlm_header is first element of all structs sent between nodes */
323e7fd4179SDavid Teigland 
32438aa8b0cSDavid Teigland #define DLM_HEADER_MAJOR	0x00030000
32538aa8b0cSDavid Teigland #define DLM_HEADER_MINOR	0x00000000
326e7fd4179SDavid Teigland 
327e7fd4179SDavid Teigland #define DLM_MSG			1
328e7fd4179SDavid Teigland #define DLM_RCOM		2
329e7fd4179SDavid Teigland 
330e7fd4179SDavid Teigland struct dlm_header {
331e7fd4179SDavid Teigland 	uint32_t		h_version;
332e7fd4179SDavid Teigland 	uint32_t		h_lockspace;
333e7fd4179SDavid Teigland 	uint32_t		h_nodeid;	/* nodeid of sender */
334e7fd4179SDavid Teigland 	uint16_t		h_length;
335e7fd4179SDavid Teigland 	uint8_t			h_cmd;		/* DLM_MSG, DLM_RCOM */
336e7fd4179SDavid Teigland 	uint8_t			h_pad;
337e7fd4179SDavid Teigland };
338e7fd4179SDavid Teigland 
339e7fd4179SDavid Teigland 
340e7fd4179SDavid Teigland #define DLM_MSG_REQUEST		1
341e7fd4179SDavid Teigland #define DLM_MSG_CONVERT		2
342e7fd4179SDavid Teigland #define DLM_MSG_UNLOCK		3
343e7fd4179SDavid Teigland #define DLM_MSG_CANCEL		4
344e7fd4179SDavid Teigland #define DLM_MSG_REQUEST_REPLY	5
345e7fd4179SDavid Teigland #define DLM_MSG_CONVERT_REPLY	6
346e7fd4179SDavid Teigland #define DLM_MSG_UNLOCK_REPLY	7
347e7fd4179SDavid Teigland #define DLM_MSG_CANCEL_REPLY	8
348e7fd4179SDavid Teigland #define DLM_MSG_GRANT		9
349e7fd4179SDavid Teigland #define DLM_MSG_BAST		10
350e7fd4179SDavid Teigland #define DLM_MSG_LOOKUP		11
351e7fd4179SDavid Teigland #define DLM_MSG_REMOVE		12
352e7fd4179SDavid Teigland #define DLM_MSG_LOOKUP_REPLY	13
3538499137dSDavid Teigland #define DLM_MSG_PURGE		14
354e7fd4179SDavid Teigland 
355e7fd4179SDavid Teigland struct dlm_message {
356e7fd4179SDavid Teigland 	struct dlm_header	m_header;
357e7fd4179SDavid Teigland 	uint32_t		m_type;		/* DLM_MSG_ */
358e7fd4179SDavid Teigland 	uint32_t		m_nodeid;
359e7fd4179SDavid Teigland 	uint32_t		m_pid;
360e7fd4179SDavid Teigland 	uint32_t		m_lkid;		/* lkid on sender */
361e7fd4179SDavid Teigland 	uint32_t		m_remid;	/* lkid on receiver */
362e7fd4179SDavid Teigland 	uint32_t		m_parent_lkid;
363e7fd4179SDavid Teigland 	uint32_t		m_parent_remid;
364e7fd4179SDavid Teigland 	uint32_t		m_exflags;
365e7fd4179SDavid Teigland 	uint32_t		m_sbflags;
366e7fd4179SDavid Teigland 	uint32_t		m_flags;
367e7fd4179SDavid Teigland 	uint32_t		m_lvbseq;
368e7fd4179SDavid Teigland 	uint32_t		m_hash;
369e7fd4179SDavid Teigland 	int			m_status;
370e7fd4179SDavid Teigland 	int			m_grmode;
371e7fd4179SDavid Teigland 	int			m_rqmode;
372e7fd4179SDavid Teigland 	int			m_bastmode;
373e7fd4179SDavid Teigland 	int			m_asts;
374e7fd4179SDavid Teigland 	int			m_result;	/* 0 or -EXXX */
375e7fd4179SDavid Teigland 	char			m_extra[0];	/* name or lvb */
376e7fd4179SDavid Teigland };
377e7fd4179SDavid Teigland 
378e7fd4179SDavid Teigland 
379e7fd4179SDavid Teigland #define DLM_RS_NODES		0x00000001
380e7fd4179SDavid Teigland #define DLM_RS_NODES_ALL	0x00000002
381e7fd4179SDavid Teigland #define DLM_RS_DIR		0x00000004
382e7fd4179SDavid Teigland #define DLM_RS_DIR_ALL		0x00000008
383e7fd4179SDavid Teigland #define DLM_RS_LOCKS		0x00000010
384e7fd4179SDavid Teigland #define DLM_RS_LOCKS_ALL	0x00000020
385e7fd4179SDavid Teigland #define DLM_RS_DONE		0x00000040
386e7fd4179SDavid Teigland #define DLM_RS_DONE_ALL		0x00000080
387e7fd4179SDavid Teigland 
388e7fd4179SDavid Teigland #define DLM_RCOM_STATUS		1
389e7fd4179SDavid Teigland #define DLM_RCOM_NAMES		2
390e7fd4179SDavid Teigland #define DLM_RCOM_LOOKUP		3
391e7fd4179SDavid Teigland #define DLM_RCOM_LOCK		4
392e7fd4179SDavid Teigland #define DLM_RCOM_STATUS_REPLY	5
393e7fd4179SDavid Teigland #define DLM_RCOM_NAMES_REPLY	6
394e7fd4179SDavid Teigland #define DLM_RCOM_LOOKUP_REPLY	7
395e7fd4179SDavid Teigland #define DLM_RCOM_LOCK_REPLY	8
396e7fd4179SDavid Teigland 
397e7fd4179SDavid Teigland struct dlm_rcom {
398e7fd4179SDavid Teigland 	struct dlm_header	rc_header;
399e7fd4179SDavid Teigland 	uint32_t		rc_type;	/* DLM_RCOM_ */
400e7fd4179SDavid Teigland 	int			rc_result;	/* multi-purpose */
401e7fd4179SDavid Teigland 	uint64_t		rc_id;		/* match reply with request */
40238aa8b0cSDavid Teigland 	uint64_t		rc_seq;		/* sender's ls_recover_seq */
40338aa8b0cSDavid Teigland 	uint64_t		rc_seq_reply;	/* remote ls_recover_seq */
404e7fd4179SDavid Teigland 	char			rc_buf[0];
405e7fd4179SDavid Teigland };
406e7fd4179SDavid Teigland 
407eef7d739SAl Viro union dlm_packet {
408eef7d739SAl Viro 	struct dlm_header	header;		/* common to other two */
409eef7d739SAl Viro 	struct dlm_message	message;
410eef7d739SAl Viro 	struct dlm_rcom		rcom;
411eef7d739SAl Viro };
412eef7d739SAl Viro 
413e7fd4179SDavid Teigland struct rcom_config {
41493ff2971SAl Viro 	__le32			rf_lvblen;
41593ff2971SAl Viro 	__le32			rf_lsflags;
41693ff2971SAl Viro 	__le64			rf_unused;
417e7fd4179SDavid Teigland };
418e7fd4179SDavid Teigland 
419e7fd4179SDavid Teigland struct rcom_lock {
420163a1859SAl Viro 	__le32			rl_ownpid;
421163a1859SAl Viro 	__le32			rl_lkid;
422163a1859SAl Viro 	__le32			rl_remid;
423163a1859SAl Viro 	__le32			rl_parent_lkid;
424163a1859SAl Viro 	__le32			rl_parent_remid;
425163a1859SAl Viro 	__le32			rl_exflags;
426163a1859SAl Viro 	__le32			rl_flags;
427163a1859SAl Viro 	__le32			rl_lvbseq;
428163a1859SAl Viro 	__le32			rl_result;
429e7fd4179SDavid Teigland 	int8_t			rl_rqmode;
430e7fd4179SDavid Teigland 	int8_t			rl_grmode;
431e7fd4179SDavid Teigland 	int8_t			rl_status;
432e7fd4179SDavid Teigland 	int8_t			rl_asts;
433163a1859SAl Viro 	__le16			rl_wait_type;
434163a1859SAl Viro 	__le16			rl_namelen;
435e7fd4179SDavid Teigland 	char			rl_name[DLM_RESNAME_MAXLEN];
436e7fd4179SDavid Teigland 	char			rl_lvb[0];
437e7fd4179SDavid Teigland };
438e7fd4179SDavid Teigland 
439e7fd4179SDavid Teigland struct dlm_ls {
440e7fd4179SDavid Teigland 	struct list_head	ls_list;	/* list of lockspaces */
441597d0caeSDavid Teigland 	dlm_lockspace_t		*ls_local_handle;
442e7fd4179SDavid Teigland 	uint32_t		ls_global_id;	/* global unique lockspace ID */
443e7fd4179SDavid Teigland 	uint32_t		ls_exflags;
444e7fd4179SDavid Teigland 	int			ls_lvblen;
4450f8e0d9aSDavid Teigland 	int			ls_count;	/* refcount of processes in
4460f8e0d9aSDavid Teigland 						   the dlm using this ls */
4470f8e0d9aSDavid Teigland 	int			ls_create_count; /* create/release refcount */
448e7fd4179SDavid Teigland 	unsigned long		ls_flags;	/* LSFL_ */
449c1dcf65fSDavid Teigland 	unsigned long		ls_scan_time;
450e7fd4179SDavid Teigland 	struct kobject		ls_kobj;
451e7fd4179SDavid Teigland 
452e7fd4179SDavid Teigland 	struct dlm_rsbtable	*ls_rsbtbl;
453e7fd4179SDavid Teigland 	uint32_t		ls_rsbtbl_size;
454e7fd4179SDavid Teigland 
455e7fd4179SDavid Teigland 	struct dlm_lkbtable	*ls_lkbtbl;
456e7fd4179SDavid Teigland 	uint32_t		ls_lkbtbl_size;
457e7fd4179SDavid Teigland 
458e7fd4179SDavid Teigland 	struct dlm_dirtable	*ls_dirtbl;
459e7fd4179SDavid Teigland 	uint32_t		ls_dirtbl_size;
460e7fd4179SDavid Teigland 
46190135925SDavid Teigland 	struct mutex		ls_waiters_mutex;
462e7fd4179SDavid Teigland 	struct list_head	ls_waiters;	/* lkbs needing a reply */
463e7fd4179SDavid Teigland 
464ef0c2bb0SDavid Teigland 	struct mutex		ls_orphans_mutex;
465ef0c2bb0SDavid Teigland 	struct list_head	ls_orphans;
466ef0c2bb0SDavid Teigland 
4673ae1acf9SDavid Teigland 	struct mutex		ls_timeout_mutex;
4683ae1acf9SDavid Teigland 	struct list_head	ls_timeout;
4693ae1acf9SDavid Teigland 
470e7fd4179SDavid Teigland 	struct list_head	ls_nodes;	/* current nodes in ls */
471e7fd4179SDavid Teigland 	struct list_head	ls_nodes_gone;	/* dead node list, recovery */
472e7fd4179SDavid Teigland 	int			ls_num_nodes;	/* number of nodes in ls */
473e7fd4179SDavid Teigland 	int			ls_low_nodeid;
474e7fd4179SDavid Teigland 	int			ls_total_weight;
475e7fd4179SDavid Teigland 	int			*ls_node_array;
47644f487a5SPatrick Caulfield 	gfp_t			ls_allocation;
477e7fd4179SDavid Teigland 
478e7fd4179SDavid Teigland 	struct dlm_rsb		ls_stub_rsb;	/* for returning errors */
479e7fd4179SDavid Teigland 	struct dlm_lkb		ls_stub_lkb;	/* for returning errors */
480e7fd4179SDavid Teigland 	struct dlm_message	ls_stub_ms;	/* for faking a reply */
481e7fd4179SDavid Teigland 
4825de6319bSDavid Teigland 	struct dentry		*ls_debug_rsb_dentry; /* debugfs */
4835de6319bSDavid Teigland 	struct dentry		*ls_debug_waiters_dentry; /* debugfs */
484ac90a255SDavid Teigland 	struct dentry		*ls_debug_locks_dentry; /* debugfs */
485d022509dSDavid Teigland 	struct dentry		*ls_debug_all_dentry; /* debugfs */
486e7fd4179SDavid Teigland 
487e7fd4179SDavid Teigland 	wait_queue_head_t	ls_uevent_wait;	/* user part of join/leave */
488e7fd4179SDavid Teigland 	int			ls_uevent_result;
4898b0e7b2cSDavid Teigland 	struct completion	ls_members_done;
4908b0e7b2cSDavid Teigland 	int			ls_members_result;
491e7fd4179SDavid Teigland 
492597d0caeSDavid Teigland 	struct miscdevice       ls_device;
493597d0caeSDavid Teigland 
494e7fd4179SDavid Teigland 	/* recovery related */
495e7fd4179SDavid Teigland 
496e7fd4179SDavid Teigland 	struct timer_list	ls_timer;
497e7fd4179SDavid Teigland 	struct task_struct	*ls_recoverd_task;
49890135925SDavid Teigland 	struct mutex		ls_recoverd_active;
499e7fd4179SDavid Teigland 	spinlock_t		ls_recover_lock;
5003ae1acf9SDavid Teigland 	unsigned long		ls_recover_begin; /* jiffies timestamp */
501e7fd4179SDavid Teigland 	uint32_t		ls_recover_status; /* DLM_RS_ */
502e7fd4179SDavid Teigland 	uint64_t		ls_recover_seq;
503e7fd4179SDavid Teigland 	struct dlm_recover	*ls_recover_args;
504e7fd4179SDavid Teigland 	struct rw_semaphore	ls_in_recovery;	/* block local requests */
505c36258b5SDavid Teigland 	struct rw_semaphore	ls_recv_active;	/* block dlm_recv */
506e7fd4179SDavid Teigland 	struct list_head	ls_requestqueue;/* queue remote requests */
50790135925SDavid Teigland 	struct mutex		ls_requestqueue_mutex;
5084007685cSAl Viro 	struct dlm_rcom		*ls_recover_buf;
509faa0f267SDavid Teigland 	int			ls_recover_nodeid; /* for debugging */
5104a99c3d9SDavid Teigland 	uint64_t		ls_rcom_seq;
51198f176fbSDavid Teigland 	spinlock_t		ls_rcom_spin;
512e7fd4179SDavid Teigland 	struct list_head	ls_recover_list;
513e7fd4179SDavid Teigland 	spinlock_t		ls_recover_list_lock;
514e7fd4179SDavid Teigland 	int			ls_recover_list_count;
515e7fd4179SDavid Teigland 	wait_queue_head_t	ls_wait_general;
516597d0caeSDavid Teigland 	struct mutex		ls_clear_proc_locks;
517e7fd4179SDavid Teigland 
518e7fd4179SDavid Teigland 	struct list_head	ls_root_list;	/* root resources */
519e7fd4179SDavid Teigland 	struct rw_semaphore	ls_root_sem;	/* protect root_list */
520e7fd4179SDavid Teigland 
521e7fd4179SDavid Teigland 	int			ls_namelen;
522e7fd4179SDavid Teigland 	char			ls_name[1];
523e7fd4179SDavid Teigland };
524e7fd4179SDavid Teigland 
525e7fd4179SDavid Teigland #define LSFL_WORK		0
526e7fd4179SDavid Teigland #define LSFL_RUNNING		1
527e7fd4179SDavid Teigland #define LSFL_RECOVERY_STOP	2
528e7fd4179SDavid Teigland #define LSFL_RCOM_READY		3
52998f176fbSDavid Teigland #define LSFL_RCOM_WAIT		4
53098f176fbSDavid Teigland #define LSFL_UEVENT_WAIT	5
5313ae1acf9SDavid Teigland #define LSFL_TIMEWARN		6
532e7fd4179SDavid Teigland 
533597d0caeSDavid Teigland /* much of this is just saving user space pointers associated with the
534597d0caeSDavid Teigland    lock that we pass back to the user lib with an ast */
535597d0caeSDavid Teigland 
536597d0caeSDavid Teigland struct dlm_user_args {
537597d0caeSDavid Teigland 	struct dlm_user_proc	*proc; /* each process that opens the lockspace
538597d0caeSDavid Teigland 					  device has private data
539597d0caeSDavid Teigland 					  (dlm_user_proc) on the struct file,
540597d0caeSDavid Teigland 					  the process's locks point back to it*/
541597d0caeSDavid Teigland 	struct dlm_lksb		lksb;
542597d0caeSDavid Teigland 	int			old_mode;
543597d0caeSDavid Teigland 	int			update_user_lvb;
544597d0caeSDavid Teigland 	struct dlm_lksb __user	*user_lksb;
545597d0caeSDavid Teigland 	void __user		*castparam;
546597d0caeSDavid Teigland 	void __user		*castaddr;
547597d0caeSDavid Teigland 	void __user		*bastparam;
548597d0caeSDavid Teigland 	void __user		*bastaddr;
549d7db923eSDavid Teigland 	uint64_t		xid;
550597d0caeSDavid Teigland };
551597d0caeSDavid Teigland 
552597d0caeSDavid Teigland #define DLM_PROC_FLAGS_CLOSING 1
553597d0caeSDavid Teigland #define DLM_PROC_FLAGS_COMPAT  2
554597d0caeSDavid Teigland 
555597d0caeSDavid Teigland /* locks list is kept so we can remove all a process's locks when it
556597d0caeSDavid Teigland    exits (or orphan those that are persistent) */
557597d0caeSDavid Teigland 
558597d0caeSDavid Teigland struct dlm_user_proc {
559597d0caeSDavid Teigland 	dlm_lockspace_t		*lockspace;
560597d0caeSDavid Teigland 	unsigned long		flags; /* DLM_PROC_FLAGS */
561597d0caeSDavid Teigland 	struct list_head	asts;
562597d0caeSDavid Teigland 	spinlock_t		asts_spin;
563597d0caeSDavid Teigland 	struct list_head	locks;
564597d0caeSDavid Teigland 	spinlock_t		locks_spin;
565a1bc86e6SDavid Teigland 	struct list_head	unlocking;
566597d0caeSDavid Teigland 	wait_queue_head_t	wait;
567597d0caeSDavid Teigland };
568597d0caeSDavid Teigland 
569e7fd4179SDavid Teigland static inline int dlm_locking_stopped(struct dlm_ls *ls)
570e7fd4179SDavid Teigland {
571e7fd4179SDavid Teigland 	return !test_bit(LSFL_RUNNING, &ls->ls_flags);
572e7fd4179SDavid Teigland }
573e7fd4179SDavid Teigland 
574e7fd4179SDavid Teigland static inline int dlm_recovery_stopped(struct dlm_ls *ls)
575e7fd4179SDavid Teigland {
576e7fd4179SDavid Teigland 	return test_bit(LSFL_RECOVERY_STOP, &ls->ls_flags);
577e7fd4179SDavid Teigland }
578e7fd4179SDavid Teigland 
579e7fd4179SDavid Teigland static inline int dlm_no_directory(struct dlm_ls *ls)
580e7fd4179SDavid Teigland {
581e7fd4179SDavid Teigland 	return (ls->ls_exflags & DLM_LSFL_NODIR) ? 1 : 0;
582e7fd4179SDavid Teigland }
583e7fd4179SDavid Teigland 
584e028398dSAdrian Bunk int dlm_netlink_init(void);
585e028398dSAdrian Bunk void dlm_netlink_exit(void);
586e028398dSAdrian Bunk void dlm_timeout_warn(struct dlm_lkb *lkb);
5872402211aSDavid Teigland int dlm_plock_init(void);
5882402211aSDavid Teigland void dlm_plock_exit(void);
589e028398dSAdrian Bunk 
590e028398dSAdrian Bunk #ifdef CONFIG_DLM_DEBUG
591e028398dSAdrian Bunk int dlm_register_debugfs(void);
592e028398dSAdrian Bunk void dlm_unregister_debugfs(void);
593e028398dSAdrian Bunk int dlm_create_debug_file(struct dlm_ls *ls);
594e028398dSAdrian Bunk void dlm_delete_debug_file(struct dlm_ls *ls);
595e028398dSAdrian Bunk #else
596e028398dSAdrian Bunk static inline int dlm_register_debugfs(void) { return 0; }
597e028398dSAdrian Bunk static inline void dlm_unregister_debugfs(void) { }
598e028398dSAdrian Bunk static inline int dlm_create_debug_file(struct dlm_ls *ls) { return 0; }
599e028398dSAdrian Bunk static inline void dlm_delete_debug_file(struct dlm_ls *ls) { }
600e028398dSAdrian Bunk #endif
601e028398dSAdrian Bunk 
602e7fd4179SDavid Teigland #endif				/* __DLM_INTERNAL_DOT_H__ */
603e7fd4179SDavid Teigland 
604