xref: /linux/fs/dlm/dlm_internal.h (revision 955abe0a1b41de5ba61fe4cd614ebc123084d499)
1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /******************************************************************************
3 *******************************************************************************
4 **
5 **  Copyright (C) Sistina Software, Inc.  1997-2003  All rights reserved.
6 **  Copyright (C) 2004-2011 Red Hat, Inc.  All rights reserved.
7 **
8 **
9 *******************************************************************************
10 ******************************************************************************/
11 
12 #ifndef __DLM_INTERNAL_DOT_H__
13 #define __DLM_INTERNAL_DOT_H__
14 
15 /*
16  * This is the main header file to be included in each DLM source file.
17  */
18 
19 #include <uapi/linux/dlm_device.h>
20 #include <linux/slab.h>
21 #include <linux/sched.h>
22 #include <linux/types.h>
23 #include <linux/ctype.h>
24 #include <linux/spinlock.h>
25 #include <linux/vmalloc.h>
26 #include <linux/list.h>
27 #include <linux/errno.h>
28 #include <linux/random.h>
29 #include <linux/delay.h>
30 #include <linux/socket.h>
31 #include <linux/kthread.h>
32 #include <linux/kobject.h>
33 #include <linux/kref.h>
34 #include <linux/kernel.h>
35 #include <linux/jhash.h>
36 #include <linux/miscdevice.h>
37 #include <linux/rhashtable.h>
38 #include <linux/mutex.h>
39 #include <linux/xarray.h>
40 #include <linux/ratelimit.h>
41 #include <linux/uaccess.h>
42 
43 #include <linux/dlm.h>
44 #include "config.h"
45 
46 struct dlm_ls;
47 struct dlm_lkb;
48 struct dlm_rsb;
49 struct dlm_member;
50 struct dlm_rsbtable;
51 struct dlm_recover;
52 struct dlm_header;
53 struct dlm_message;
54 struct dlm_rcom;
55 struct dlm_mhandle;
56 struct dlm_msg;
57 
58 #define log_print(fmt, args...) \
59 	printk(KERN_ERR "dlm: "fmt"\n" , ##args)
60 #define log_print_ratelimited(fmt, args...) \
61 	printk_ratelimited(KERN_ERR "dlm: "fmt"\n", ##args)
62 #define log_error(ls, fmt, args...) \
63 	printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
64 
65 #define log_rinfo(ls, fmt, args...) \
66 do { \
67 	if (dlm_config.ci_log_info) \
68 		printk(KERN_INFO "dlm: %s: " fmt "\n", \
69 			(ls)->ls_name, ##args); \
70 	else if (dlm_config.ci_log_debug) \
71 		printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
72 		       (ls)->ls_name , ##args); \
73 } while (0)
74 
75 #define log_debug(ls, fmt, args...) \
76 do { \
77 	if (dlm_config.ci_log_debug) \
78 		printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
79 		       (ls)->ls_name , ##args); \
80 } while (0)
81 
82 #define log_limit(ls, fmt, args...) \
83 do { \
84 	if (dlm_config.ci_log_debug) \
85 		printk_ratelimited(KERN_DEBUG "dlm: %s: " fmt "\n", \
86 			(ls)->ls_name , ##args); \
87 } while (0)
88 
89 #define DLM_ASSERT(x, do) \
90 { \
91   if (!(x)) \
92   { \
93     printk(KERN_ERR "\nDLM:  Assertion failed on line %d of file %s\n" \
94                "DLM:  assertion:  \"%s\"\n" \
95                "DLM:  time = %lu\n", \
96                __LINE__, __FILE__, #x, jiffies); \
97     {do} \
98     printk("\n"); \
99     panic("DLM:  Record message above and reboot.\n"); \
100   } \
101 }
102 
103 /*
104  * Lockspace member (per node in a ls)
105  */
106 
107 struct dlm_member {
108 	struct list_head	list;
109 	int			nodeid;
110 	int			weight;
111 	int			slot;
112 	int			slot_prev;
113 	int			comm_seq;
114 	uint32_t		generation;
115 };
116 
117 /*
118  * Save and manage recovery state for a lockspace.
119  */
120 
121 struct dlm_recover {
122 	struct list_head	list;
123 	struct dlm_config_node	*nodes;
124 	int			nodes_count;
125 	uint64_t		seq;
126 };
127 
128 /*
129  * Pass input args to second stage locking function.
130  */
131 
132 struct dlm_args {
133 	uint32_t		flags;
134 	void			(*astfn) (void *astparam);
135 	void			*astparam;
136 	void			(*bastfn) (void *astparam, int mode);
137 	int			mode;
138 	struct dlm_lksb		*lksb;
139 };
140 
141 
142 /*
143  * Lock block
144  *
145  * A lock can be one of three types:
146  *
147  * local copy      lock is mastered locally
148  *                 (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
149  * process copy    lock is mastered on a remote node
150  *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
151  * master copy     master node's copy of a lock owned by remote node
152  *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
153  *
154  * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
155  * dlm_unlock.  The dlm does not modify these or use any private flags in
156  * this field; it only contains DLM_LKF_ flags from dlm.h.  These flags
157  * are sent as-is to the remote master when the lock is remote.
158  *
159  * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
160  * Some internal flags are shared between the master and process nodes;
161  * these shared flags are kept in the lower two bytes.  One of these
162  * flags set on the master copy will be propagated to the process copy
163  * and v.v.  Other internal flags are private to the master or process
164  * node (e.g. DLM_IFL_MSTCPY).  These are kept in the high two bytes.
165  *
166  * lkb_sbflags: status block flags.  These flags are copied directly into
167  * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
168  * ast.  All defined in dlm.h with DLM_SBF_ prefix.
169  *
170  * lkb_status: the lock status indicates which rsb queue the lock is
171  * on, grant, convert, or wait.  DLM_LKSTS_ WAITING/GRANTED/CONVERT
172  *
173  * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
174  * reply is needed.  Only set when the lkb is on the lockspace waiters
175  * list awaiting a reply from a remote node.
176  *
177  * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
178  * is a master copy, nodeid specifies the remote lock holder, when the
179  * lkb is a process copy, the nodeid specifies the lock master.
180  */
181 
182 /* lkb_status */
183 
184 #define DLM_LKSTS_WAITING	1
185 #define DLM_LKSTS_GRANTED	2
186 #define DLM_LKSTS_CONVERT	3
187 
188 /* lkb_iflags */
189 
190 #define DLM_IFL_MSTCPY_BIT	16
191 #define __DLM_IFL_MIN_BIT	DLM_IFL_MSTCPY_BIT
192 #define DLM_IFL_RESEND_BIT	17
193 #define DLM_IFL_DEAD_BIT	18
194 #define DLM_IFL_OVERLAP_UNLOCK_BIT 19
195 #define DLM_IFL_OVERLAP_CANCEL_BIT 20
196 #define DLM_IFL_ENDOFLIFE_BIT	21
197 #define DLM_IFL_DEADLOCK_CANCEL_BIT 24
198 #define __DLM_IFL_MAX_BIT	DLM_IFL_DEADLOCK_CANCEL_BIT
199 
200 /* lkb_dflags */
201 
202 #define DLM_DFL_USER_BIT	0
203 #define __DLM_DFL_MIN_BIT	DLM_DFL_USER_BIT
204 #define DLM_DFL_ORPHAN_BIT	1
205 #define __DLM_DFL_MAX_BIT	DLM_DFL_ORPHAN_BIT
206 
207 #define DLM_CB_CAST		0x00000001
208 #define DLM_CB_BAST		0x00000002
209 
210 /* much of this is just saving user space pointers associated with the
211  * lock that we pass back to the user lib with an ast
212  */
213 
214 struct dlm_user_args {
215 	struct dlm_user_proc	*proc; /* each process that opens the lockspace
216 					* device has private data
217 					* (dlm_user_proc) on the struct file,
218 					* the process's locks point back to it
219 					*/
220 	struct dlm_lksb		lksb;
221 	struct dlm_lksb __user	*user_lksb;
222 	void __user		*castparam;
223 	void __user		*castaddr;
224 	void __user		*bastparam;
225 	void __user		*bastaddr;
226 	uint64_t		xid;
227 };
228 
229 struct dlm_callback {
230 	uint32_t		flags;		/* DLM_CBF_ */
231 	int			sb_status;	/* copy to lksb status */
232 	uint8_t			sb_flags;	/* copy to lksb flags */
233 	int8_t			mode; /* rq mode of bast, gr mode of cast */
234 	bool			copy_lvb;
235 	struct dlm_lksb		*lkb_lksb;
236 	unsigned char		lvbptr[DLM_USER_LVB_LEN];
237 
238 	union {
239 		void			*astparam;	/* caller's ast arg */
240 		struct dlm_user_args	ua;
241 	};
242 	struct work_struct	work;
243 	void			(*bastfn)(void *astparam, int mode);
244 	void			(*astfn)(void *astparam);
245 	char			res_name[DLM_RESNAME_MAXLEN];
246 	size_t			res_length;
247 	uint32_t		ls_id;
248 	uint32_t		lkb_id;
249 
250 	struct list_head	list;
251 };
252 
253 struct dlm_lkb {
254 	struct dlm_rsb		*lkb_resource;	/* the rsb */
255 	struct kref		lkb_ref;
256 	int			lkb_nodeid;	/* copied from rsb */
257 	int			lkb_ownpid;	/* pid of lock owner */
258 	uint32_t		lkb_id;		/* our lock ID */
259 	uint32_t		lkb_remid;	/* lock ID on remote partner */
260 	uint32_t		lkb_exflags;	/* external flags from caller */
261 	unsigned long		lkb_sbflags;	/* lksb flags */
262 	unsigned long		lkb_dflags;	/* distributed flags */
263 	unsigned long		lkb_iflags;	/* internal flags */
264 	uint32_t		lkb_lvbseq;	/* lvb sequence number */
265 
266 	int8_t			lkb_status;     /* granted, waiting, convert */
267 	int8_t			lkb_rqmode;	/* requested lock mode */
268 	int8_t			lkb_grmode;	/* granted lock mode */
269 	int8_t			lkb_highbast;	/* highest mode bast sent for */
270 
271 	int8_t			lkb_wait_type;	/* type of reply waiting for */
272 	int8_t			lkb_wait_count;
273 	int			lkb_wait_nodeid; /* for debugging */
274 
275 	struct list_head	lkb_statequeue;	/* rsb g/c/w list */
276 	struct list_head	lkb_rsb_lookup;	/* waiting for rsb lookup */
277 	struct list_head	lkb_wait_reply;	/* waiting for remote reply */
278 	struct list_head	lkb_ownqueue;	/* list of locks for a process */
279 	ktime_t			lkb_timestamp;
280 
281 	int8_t			lkb_last_cast_cb_mode;
282 	int8_t			lkb_last_bast_cb_mode;
283 	int8_t			lkb_last_cb_mode;
284 	uint8_t			lkb_last_cb_flags;
285 	ktime_t			lkb_last_cast_time;	/* for debugging */
286 	ktime_t			lkb_last_bast_time;	/* for debugging */
287 
288 	uint64_t		lkb_recover_seq; /* from ls_recover_seq */
289 
290 	char			*lkb_lvbptr;
291 	struct dlm_lksb		*lkb_lksb;      /* caller's status block */
292 	void			(*lkb_astfn) (void *astparam);
293 	void			(*lkb_bastfn) (void *astparam, int mode);
294 	union {
295 		void			*lkb_astparam;	/* caller's ast arg */
296 		struct dlm_user_args	*lkb_ua;
297 	};
298 };
299 
300 /*
301  * res_master_nodeid is "normal": 0 is unset/invalid, non-zero is the real
302  * nodeid, even when nodeid is our_nodeid.
303  *
304  * res_nodeid is "odd": -1 is unset/invalid, zero means our_nodeid,
305  * greater than zero when another nodeid.
306  *
307  * (TODO: remove res_nodeid and only use res_master_nodeid)
308  */
309 
310 struct dlm_rsb {
311 	struct dlm_ls		*res_ls;	/* the lockspace */
312 	struct kref		res_ref;
313 	spinlock_t		res_lock;
314 	unsigned long		res_flags;
315 	int			res_length;	/* length of rsb name */
316 	int			res_nodeid;
317 	int			res_master_nodeid;
318 	int			res_dir_nodeid;
319 	unsigned long		res_id;		/* for ls_recover_xa */
320 	uint32_t                res_lvbseq;
321 	uint32_t		res_hash;
322 	unsigned long		res_toss_time;
323 	uint32_t		res_first_lkid;
324 	struct list_head	res_lookup;	/* lkbs waiting on first */
325 	struct rhash_head	res_node;	/* rsbtbl */
326 	struct list_head	res_grantqueue;
327 	struct list_head	res_convertqueue;
328 	struct list_head	res_waitqueue;
329 
330 	struct list_head	res_slow_list;      /* ls_slow_* */
331 	struct list_head	res_scan_list;
332 	struct list_head	res_root_list;	    /* used for recovery */
333 	struct list_head	res_masters_list;   /* used for recovery */
334 	struct list_head	res_recover_list;   /* used for recovery */
335 	int			res_recover_locks_count;
336 	struct rcu_head		rcu;
337 
338 	char			*res_lvbptr;
339 	char			res_name[DLM_RESNAME_MAXLEN+1];
340 };
341 
342 /* dlm_master_lookup() flags */
343 
344 #define DLM_LU_RECOVER_DIR	1
345 #define DLM_LU_RECOVER_MASTER	2
346 
347 /* dlm_master_lookup() results */
348 
349 #define DLM_LU_MATCH		1
350 #define DLM_LU_ADD		2
351 
352 /* find_rsb() flags */
353 
354 #define R_REQUEST		0x00000001
355 #define R_RECEIVE_REQUEST	0x00000002
356 #define R_RECEIVE_RECOVER	0x00000004
357 
358 /* rsb_flags */
359 
360 enum rsb_flags {
361 	RSB_MASTER_UNCERTAIN,
362 	RSB_VALNOTVALID,
363 	RSB_VALNOTVALID_PREV,
364 	RSB_NEW_MASTER,
365 	RSB_NEW_MASTER2,
366 	RSB_RECOVER_CONVERT,
367 	RSB_RECOVER_GRANT,
368 	RSB_RECOVER_LVB_INVAL,
369 	RSB_INACTIVE,
370 	RSB_HASHED, /* set while rsb is on ls_rsbtbl */
371 };
372 
373 static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
374 {
375 	__set_bit(flag, &r->res_flags);
376 }
377 
378 static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
379 {
380 	__clear_bit(flag, &r->res_flags);
381 }
382 
383 static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
384 {
385 	return test_bit(flag, &r->res_flags);
386 }
387 
388 
389 /* dlm_header is first element of all structs sent between nodes */
390 
391 #define DLM_HEADER_MAJOR	0x00030000
392 #define DLM_HEADER_MINOR	0x00000002
393 
394 #define DLM_VERSION_3_1		0x00030001
395 #define DLM_VERSION_3_2		0x00030002
396 
397 #define DLM_HEADER_SLOTS	0x00000001
398 
399 #define DLM_MSG			1
400 #define DLM_RCOM		2
401 #define DLM_OPTS		3
402 #define DLM_ACK			4
403 #define DLM_FIN			5
404 
405 struct dlm_header {
406 	__le32			h_version;
407 	union {
408 		/* for DLM_MSG and DLM_RCOM */
409 		__le32		h_lockspace;
410 		/* for DLM_ACK and DLM_OPTS */
411 		__le32		h_seq;
412 	} u;
413 	__le32			h_nodeid;	/* nodeid of sender */
414 	__le16			h_length;
415 	uint8_t			h_cmd;		/* DLM_MSG, DLM_RCOM */
416 	uint8_t			h_pad;
417 };
418 
419 #define DLM_MSG_REQUEST		1
420 #define DLM_MSG_CONVERT		2
421 #define DLM_MSG_UNLOCK		3
422 #define DLM_MSG_CANCEL		4
423 #define DLM_MSG_REQUEST_REPLY	5
424 #define DLM_MSG_CONVERT_REPLY	6
425 #define DLM_MSG_UNLOCK_REPLY	7
426 #define DLM_MSG_CANCEL_REPLY	8
427 #define DLM_MSG_GRANT		9
428 #define DLM_MSG_BAST		10
429 #define DLM_MSG_LOOKUP		11
430 #define DLM_MSG_REMOVE		12
431 #define DLM_MSG_LOOKUP_REPLY	13
432 #define DLM_MSG_PURGE		14
433 
434 struct dlm_message {
435 	struct dlm_header	m_header;
436 	__le32			m_type;		/* DLM_MSG_ */
437 	__le32			m_nodeid;
438 	__le32			m_pid;
439 	__le32			m_lkid;		/* lkid on sender */
440 	__le32			m_remid;	/* lkid on receiver */
441 	__le32			m_parent_lkid;
442 	__le32			m_parent_remid;
443 	__le32			m_exflags;
444 	__le32			m_sbflags;
445 	__le32			m_flags;
446 	__le32			m_lvbseq;
447 	__le32			m_hash;
448 	__le32			m_status;
449 	__le32			m_grmode;
450 	__le32			m_rqmode;
451 	__le32			m_bastmode;
452 	__le32			m_asts;
453 	__le32			m_result;	/* 0 or -EXXX */
454 	char			m_extra[];	/* name or lvb */
455 };
456 
457 
458 #define DLM_RS_NODES		0x00000001
459 #define DLM_RS_NODES_ALL	0x00000002
460 #define DLM_RS_DIR		0x00000004
461 #define DLM_RS_DIR_ALL		0x00000008
462 #define DLM_RS_LOCKS		0x00000010
463 #define DLM_RS_LOCKS_ALL	0x00000020
464 #define DLM_RS_DONE		0x00000040
465 #define DLM_RS_DONE_ALL		0x00000080
466 
467 #define DLM_RCOM_STATUS		1
468 #define DLM_RCOM_NAMES		2
469 #define DLM_RCOM_LOOKUP		3
470 #define DLM_RCOM_LOCK		4
471 #define DLM_RCOM_STATUS_REPLY	5
472 #define DLM_RCOM_NAMES_REPLY	6
473 #define DLM_RCOM_LOOKUP_REPLY	7
474 #define DLM_RCOM_LOCK_REPLY	8
475 
476 struct dlm_rcom {
477 	struct dlm_header	rc_header;
478 	__le32			rc_type;	/* DLM_RCOM_ */
479 	__le32			rc_result;	/* multi-purpose */
480 	__le64			rc_id;		/* match reply with request */
481 	__le64			rc_seq;		/* sender's ls_recover_seq */
482 	__le64			rc_seq_reply;	/* remote ls_recover_seq */
483 	char			rc_buf[];
484 };
485 
486 struct dlm_opt_header {
487 	__le16		t_type;
488 	__le16		t_length;
489 	__le32		t_pad;
490 	/* need to be 8 byte aligned */
491 	char		t_value[];
492 };
493 
494 /* encapsulation header */
495 struct dlm_opts {
496 	struct dlm_header	o_header;
497 	uint8_t			o_nextcmd;
498 	uint8_t			o_pad;
499 	__le16			o_optlen;
500 	__le32			o_pad2;
501 	char			o_opts[];
502 };
503 
504 union dlm_packet {
505 	struct dlm_header	header;		/* common to other two */
506 	struct dlm_message	message;
507 	struct dlm_rcom		rcom;
508 	struct dlm_opts		opts;
509 };
510 
511 #define DLM_RSF_NEED_SLOTS	0x00000001
512 
513 /* RCOM_STATUS data */
514 struct rcom_status {
515 	__le32			rs_flags;
516 	__le32			rs_unused1;
517 	__le64			rs_unused2;
518 };
519 
520 /* RCOM_STATUS_REPLY data */
521 struct rcom_config {
522 	__le32			rf_lvblen;
523 	__le32			rf_lsflags;
524 
525 	/* DLM_HEADER_SLOTS adds: */
526 	__le32			rf_flags;
527 	__le16			rf_our_slot;
528 	__le16			rf_num_slots;
529 	__le32			rf_generation;
530 	__le32			rf_unused1;
531 	__le64			rf_unused2;
532 };
533 
534 struct rcom_slot {
535 	__le32			ro_nodeid;
536 	__le16			ro_slot;
537 	__le16			ro_unused1;
538 	__le64			ro_unused2;
539 };
540 
541 struct rcom_lock {
542 	__le32			rl_ownpid;
543 	__le32			rl_lkid;
544 	__le32			rl_remid;
545 	__le32			rl_parent_lkid;
546 	__le32			rl_parent_remid;
547 	__le32			rl_exflags;
548 	__le32			rl_flags;
549 	__le32			rl_lvbseq;
550 	__le32			rl_result;
551 	int8_t			rl_rqmode;
552 	int8_t			rl_grmode;
553 	int8_t			rl_status;
554 	int8_t			rl_asts;
555 	__le16			rl_wait_type;
556 	__le16			rl_namelen;
557 	char			rl_name[DLM_RESNAME_MAXLEN];
558 	char			rl_lvb[];
559 };
560 
561 struct dlm_ls {
562 	struct list_head	ls_list;	/* list of lockspaces */
563 	uint32_t		ls_global_id;	/* global unique lockspace ID */
564 	uint32_t		ls_generation;
565 	uint32_t		ls_exflags;
566 	int			ls_lvblen;
567 	atomic_t		ls_count;	/* refcount of processes in
568 						   the dlm using this ls */
569 	wait_queue_head_t	ls_count_wait;
570 	int			ls_create_count; /* create/release refcount */
571 	unsigned long		ls_flags;	/* LSFL_ */
572 	struct kobject		ls_kobj;
573 
574 	struct xarray		ls_lkbxa;
575 	rwlock_t		ls_lkbxa_lock;
576 
577 	/* an rsb is on rsbtl for primary locking functions,
578 	   and on a slow list for recovery/dump iteration  */
579 	struct rhashtable	ls_rsbtbl;
580 	rwlock_t		ls_rsbtbl_lock; /* for ls_rsbtbl and ls_slow */
581 	struct list_head	ls_slow_inactive; /* to iterate rsbtbl */
582 	struct list_head	ls_slow_active;   /* to iterate rsbtbl */
583 
584 	struct timer_list	ls_scan_timer; /* based on first scan_list rsb toss_time */
585 	struct list_head	ls_scan_list;  /* rsbs ordered by res_toss_time */
586 	spinlock_t		ls_scan_lock;
587 
588 	spinlock_t		ls_waiters_lock;
589 	struct list_head	ls_waiters;	/* lkbs needing a reply */
590 
591 	spinlock_t		ls_orphans_lock;
592 	struct list_head	ls_orphans;
593 
594 	struct list_head	ls_nodes;	/* current nodes in ls */
595 	struct list_head	ls_nodes_gone;	/* dead node list, recovery */
596 	int			ls_num_nodes;	/* number of nodes in ls */
597 	int			ls_low_nodeid;
598 	int			ls_total_weight;
599 	int			*ls_node_array;
600 
601 	int			ls_slot;
602 	int			ls_num_slots;
603 	int			ls_slots_size;
604 	struct dlm_slot		*ls_slots;
605 
606 	struct dlm_rsb		ls_local_rsb;	/* for returning errors */
607 	struct dlm_lkb		ls_local_lkb;	/* for returning errors */
608 	struct dlm_message	ls_local_ms;	/* for faking a reply */
609 
610 	struct dentry		*ls_debug_rsb_dentry; /* debugfs */
611 	struct dentry		*ls_debug_waiters_dentry; /* debugfs */
612 	struct dentry		*ls_debug_locks_dentry; /* debugfs */
613 	struct dentry		*ls_debug_all_dentry; /* debugfs */
614 	struct dentry		*ls_debug_toss_dentry; /* debugfs */
615 	struct dentry		*ls_debug_queued_asts_dentry; /* debugfs */
616 
617 	wait_queue_head_t	ls_uevent_wait;	/* user part of join/leave */
618 	int			ls_uevent_result;
619 	struct completion	ls_recovery_done;
620 	int			ls_recovery_result;
621 
622 	struct miscdevice       ls_device;
623 
624 	struct workqueue_struct	*ls_callback_wq;
625 
626 	/* recovery related */
627 
628 	spinlock_t		ls_cb_lock;
629 	struct list_head	ls_cb_delay; /* save for queue_work later */
630 	struct task_struct	*ls_recoverd_task;
631 	struct mutex		ls_recoverd_active;
632 	spinlock_t		ls_recover_lock;
633 	unsigned long		ls_recover_begin; /* jiffies timestamp */
634 	uint32_t		ls_recover_status; /* DLM_RS_ */
635 	uint64_t		ls_recover_seq;
636 	struct dlm_recover	*ls_recover_args;
637 	struct rw_semaphore	ls_in_recovery;	/* block local requests */
638 	rwlock_t		ls_recv_active;	/* block dlm_recv */
639 	struct list_head	ls_requestqueue;/* queue remote requests */
640 	rwlock_t		ls_requestqueue_lock;
641 	struct dlm_rcom		*ls_recover_buf;
642 	int			ls_recover_nodeid; /* for debugging */
643 	unsigned int		ls_recover_locks_in; /* for log info */
644 	uint64_t		ls_rcom_seq;
645 	spinlock_t		ls_rcom_spin;
646 	struct list_head	ls_recover_list;
647 	spinlock_t		ls_recover_list_lock;
648 	int			ls_recover_list_count;
649 	struct xarray		ls_recover_xa;
650 	spinlock_t		ls_recover_xa_lock;
651 	wait_queue_head_t	ls_wait_general;
652 	wait_queue_head_t	ls_recover_lock_wait;
653 	spinlock_t		ls_clear_proc_locks;
654 
655 	struct list_head	ls_masters_list; /* root resources */
656 	rwlock_t		ls_masters_lock; /* protect root_list */
657 	struct list_head	ls_dir_dump_list; /* root resources */
658 	rwlock_t		ls_dir_dump_lock; /* protect root_list */
659 
660 	const struct dlm_lockspace_ops *ls_ops;
661 	void			*ls_ops_arg;
662 
663 	int			ls_namelen;
664 	char			ls_name[DLM_LOCKSPACE_LEN + 1];
665 };
666 
667 /*
668  * LSFL_RECOVER_STOP - dlm_ls_stop() sets this to tell dlm recovery routines
669  * that they should abort what they're doing so new recovery can be started.
670  *
671  * LSFL_RECOVER_DOWN - dlm_ls_stop() sets this to tell dlm_recoverd that it
672  * should do down_write() on the in_recovery rw_semaphore. (doing down_write
673  * within dlm_ls_stop causes complaints about the lock acquired/released
674  * in different contexts.)
675  *
676  * LSFL_RECOVER_LOCK - dlm_recoverd holds the in_recovery rw_semaphore.
677  * It sets this after it is done with down_write() on the in_recovery
678  * rw_semaphore and clears it after it has released the rw_semaphore.
679  *
680  * LSFL_RECOVER_WORK - dlm_ls_start() sets this to tell dlm_recoverd that it
681  * should begin recovery of the lockspace.
682  *
683  * LSFL_RUNNING - set when normal locking activity is enabled.
684  * dlm_ls_stop() clears this to tell dlm locking routines that they should
685  * quit what they are doing so recovery can run.  dlm_recoverd sets
686  * this after recovery is finished.
687  */
688 
689 #define LSFL_RECOVER_STOP	0
690 #define LSFL_RECOVER_DOWN	1
691 #define LSFL_RECOVER_LOCK	2
692 #define LSFL_RECOVER_WORK	3
693 #define LSFL_RUNNING		4
694 
695 #define LSFL_RCOM_READY		5
696 #define LSFL_RCOM_WAIT		6
697 #define LSFL_UEVENT_WAIT	7
698 #define LSFL_CB_DELAY		9
699 #define LSFL_NODIR		10
700 #define LSFL_RECV_MSG_BLOCKED	11
701 #define LSFL_FS			12
702 #define LSFL_SOFTIRQ		13
703 
704 #define DLM_PROC_FLAGS_CLOSING 1
705 #define DLM_PROC_FLAGS_COMPAT  2
706 
707 /* locks list is kept so we can remove all a process's locks when it
708    exits (or orphan those that are persistent) */
709 
710 struct dlm_user_proc {
711 	dlm_lockspace_t		*lockspace;
712 	unsigned long		flags; /* DLM_PROC_FLAGS */
713 	struct list_head	asts;
714 	spinlock_t		asts_spin;
715 	struct list_head	locks;
716 	spinlock_t		locks_spin;
717 	struct list_head	unlocking;
718 	wait_queue_head_t	wait;
719 };
720 
721 static inline int dlm_locking_stopped(struct dlm_ls *ls)
722 {
723 	return !test_bit(LSFL_RUNNING, &ls->ls_flags);
724 }
725 
726 static inline int dlm_recovery_stopped(struct dlm_ls *ls)
727 {
728 	return test_bit(LSFL_RECOVER_STOP, &ls->ls_flags);
729 }
730 
731 static inline int dlm_no_directory(struct dlm_ls *ls)
732 {
733 	return test_bit(LSFL_NODIR, &ls->ls_flags);
734 }
735 
736 /* takes a snapshot from dlm atomic flags */
737 static inline uint32_t dlm_flags_val(const unsigned long *addr,
738 				     uint32_t min, uint32_t max)
739 {
740 	uint32_t bit = min, val = 0;
741 
742 	for_each_set_bit_from(bit, addr, max + 1) {
743 		val |= BIT(bit);
744 	}
745 
746 	return val;
747 }
748 
749 static inline uint32_t dlm_iflags_val(const struct dlm_lkb *lkb)
750 {
751 	return dlm_flags_val(&lkb->lkb_iflags, __DLM_IFL_MIN_BIT,
752 			     __DLM_IFL_MAX_BIT);
753 }
754 
755 static inline uint32_t dlm_dflags_val(const struct dlm_lkb *lkb)
756 {
757 	return dlm_flags_val(&lkb->lkb_dflags, __DLM_DFL_MIN_BIT,
758 			     __DLM_DFL_MAX_BIT);
759 }
760 
761 /* coming from UAPI header
762  *
763  * TODO:
764  * Move this to UAPI header and let other values point to them and use BIT()
765  */
766 #define DLM_SBF_DEMOTED_BIT	0
767 #define __DLM_SBF_MIN_BIT	DLM_SBF_DEMOTED_BIT
768 #define DLM_SBF_VALNOTVALID_BIT	1
769 #define DLM_SBF_ALTMODE_BIT	2
770 #define __DLM_SBF_MAX_BIT	DLM_SBF_ALTMODE_BIT
771 
772 static inline uint32_t dlm_sbflags_val(const struct dlm_lkb *lkb)
773 {
774 	/* be sure the next person updates this */
775 	BUILD_BUG_ON(BIT(__DLM_SBF_MAX_BIT) != DLM_SBF_ALTMODE);
776 
777 	return dlm_flags_val(&lkb->lkb_sbflags, __DLM_SBF_MIN_BIT,
778 			     __DLM_SBF_MAX_BIT);
779 }
780 
781 static inline void dlm_set_flags_val(unsigned long *addr, uint32_t val,
782 				     uint32_t min, uint32_t max)
783 {
784 	uint32_t bit;
785 
786 	for (bit = min; bit < (max + 1); bit++) {
787 		if (val & BIT(bit))
788 			set_bit(bit, addr);
789 		else
790 			clear_bit(bit, addr);
791 	}
792 }
793 
794 static inline void dlm_set_dflags_val(struct dlm_lkb *lkb, uint32_t val)
795 {
796 	dlm_set_flags_val(&lkb->lkb_dflags, val, __DLM_DFL_MIN_BIT,
797 			  __DLM_DFL_MAX_BIT);
798 }
799 
800 static inline void dlm_set_sbflags_val(struct dlm_lkb *lkb, uint32_t val)
801 {
802 	dlm_set_flags_val(&lkb->lkb_sbflags, val, __DLM_SBF_MIN_BIT,
803 			  __DLM_SBF_MAX_BIT);
804 }
805 
806 int dlm_plock_init(void);
807 void dlm_plock_exit(void);
808 
809 #ifdef CONFIG_DLM_DEBUG
810 void dlm_register_debugfs(void);
811 void dlm_unregister_debugfs(void);
812 void dlm_create_debug_file(struct dlm_ls *ls);
813 void dlm_delete_debug_file(struct dlm_ls *ls);
814 void *dlm_create_debug_comms_file(int nodeid, void *data);
815 void dlm_delete_debug_comms_file(void *ctx);
816 #else
817 static inline void dlm_register_debugfs(void) { }
818 static inline void dlm_unregister_debugfs(void) { }
819 static inline void dlm_create_debug_file(struct dlm_ls *ls) { }
820 static inline void dlm_delete_debug_file(struct dlm_ls *ls) { }
821 static inline void *dlm_create_debug_comms_file(int nodeid, void *data) { return NULL; }
822 static inline void dlm_delete_debug_comms_file(void *ctx) { }
823 #endif
824 
825 #endif				/* __DLM_INTERNAL_DOT_H__ */
826 
827