1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /******************************************************************************
3 *******************************************************************************
5 ** Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
6 ** Copyright (C) 2004-2011 Red Hat, Inc. All rights reserved.
9 *******************************************************************************
10 ******************************************************************************/
12 #ifndef __DLM_INTERNAL_DOT_H__
13 #define __DLM_INTERNAL_DOT_H__
16 * This is the main header file to be included in each DLM source file.
19 #include <linux/slab.h>
20 #include <linux/sched.h>
21 #include <linux/types.h>
22 #include <linux/ctype.h>
23 #include <linux/spinlock.h>
24 #include <linux/vmalloc.h>
25 #include <linux/list.h>
26 #include <linux/errno.h>
27 #include <linux/random.h>
28 #include <linux/delay.h>
29 #include <linux/socket.h>
30 #include <linux/kthread.h>
31 #include <linux/kobject.h>
32 #include <linux/kref.h>
33 #include <linux/kernel.h>
34 #include <linux/jhash.h>
35 #include <linux/miscdevice.h>
36 #include <linux/mutex.h>
37 #include <linux/idr.h>
38 #include <linux/ratelimit.h>
39 #include <linux/uaccess.h>
41 #include <linux/dlm.h>
56 #define log_print(fmt, args...) \
57 printk(KERN_ERR "dlm: "fmt"\n" , ##args)
58 #define log_print_ratelimited(fmt, args...) \
59 printk_ratelimited(KERN_ERR "dlm: "fmt"\n", ##args)
60 #define log_error(ls, fmt, args...) \
61 printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
63 #define log_rinfo(ls, fmt, args...) \
65 if (dlm_config.ci_log_info) \
66 printk(KERN_INFO "dlm: %s: " fmt "\n", \
67 (ls)->ls_name, ##args); \
68 else if (dlm_config.ci_log_debug) \
69 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
70 (ls)->ls_name , ##args); \
73 #define log_debug(ls, fmt, args...) \
75 if (dlm_config.ci_log_debug) \
76 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
77 (ls)->ls_name , ##args); \
80 #define log_limit(ls, fmt, args...) \
82 if (dlm_config.ci_log_debug) \
83 printk_ratelimited(KERN_DEBUG "dlm: %s: " fmt "\n", \
84 (ls)->ls_name , ##args); \
87 #define DLM_ASSERT(x, do) \
91 printk(KERN_ERR "\nDLM: Assertion failed on line %d of file %s\n" \
92 "DLM: assertion: \"%s\"\n" \
93 "DLM: time = %lu\n", \
94 __LINE__, __FILE__, #x, jiffies); \
97 panic("DLM: Record message above and reboot.\n"); \
102 #define DLM_RTF_SHRINK 0x00000001
104 struct dlm_rsbtable {
113 * Lockspace member (per node in a ls)
117 struct list_head list;
127 * Save and manage recovery state for a lockspace.
131 struct list_head list;
132 struct dlm_config_node *nodes;
138 * Pass input args to second stage locking function.
143 void (*astfn) (void *astparam);
145 void (*bastfn) (void *astparam, int mode);
147 struct dlm_lksb *lksb;
148 #ifdef CONFIG_DLM_DEPRECATED_API
149 unsigned long timeout;
157 * A lock can be one of three types:
159 * local copy lock is mastered locally
160 * (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
161 * process copy lock is mastered on a remote node
162 * (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
163 * master copy master node's copy of a lock owned by remote node
164 * (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
166 * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
167 * dlm_unlock. The dlm does not modify these or use any private flags in
168 * this field; it only contains DLM_LKF_ flags from dlm.h. These flags
169 * are sent as-is to the remote master when the lock is remote.
171 * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
172 * Some internal flags are shared between the master and process nodes;
173 * these shared flags are kept in the lower two bytes. One of these
174 * flags set on the master copy will be propagated to the process copy
175 * and v.v. Other internal flags are private to the master or process
176 * node (e.g. DLM_IFL_MSTCPY). These are kept in the high two bytes.
178 * lkb_sbflags: status block flags. These flags are copied directly into
179 * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
180 * ast. All defined in dlm.h with DLM_SBF_ prefix.
182 * lkb_status: the lock status indicates which rsb queue the lock is
183 * on, grant, convert, or wait. DLM_LKSTS_ WAITING/GRANTED/CONVERT
185 * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
186 * reply is needed. Only set when the lkb is on the lockspace waiters
187 * list awaiting a reply from a remote node.
189 * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
190 * is a master copy, nodeid specifies the remote lock holder, when the
191 * lkb is a process copy, the nodeid specifies the lock master.
196 #define DLM_LKSTS_WAITING 1
197 #define DLM_LKSTS_GRANTED 2
198 #define DLM_LKSTS_CONVERT 3
202 #define DLM_IFL_MSTCPY 0x00010000
203 #define DLM_IFL_RESEND 0x00020000
204 #define DLM_IFL_DEAD 0x00040000
205 #define DLM_IFL_OVERLAP_UNLOCK 0x00080000
206 #define DLM_IFL_OVERLAP_CANCEL 0x00100000
207 #define DLM_IFL_ENDOFLIFE 0x00200000
208 #ifdef CONFIG_DLM_DEPRECATED_API
209 #define DLM_IFL_WATCH_TIMEWARN 0x00400000
210 #define DLM_IFL_TIMEOUT_CANCEL 0x00800000
212 #define DLM_IFL_DEADLOCK_CANCEL 0x01000000
213 #define DLM_IFL_STUB_MS 0x02000000 /* magic number for m_flags */
214 #define DLM_IFL_CB_PENDING 0x04000000
215 /* least significant 2 bytes are message changed, they are full transmitted
216 * but at receive side only the 2 bytes LSB will be set.
218 * Even wireshark dlm dissector does only evaluate the lower bytes and note
219 * that they may not be used on transceiver side, we assume the higher bytes
220 * are for internal use or reserved so long they are not parsed on receiver
223 #define DLM_IFL_USER 0x00000001
224 #define DLM_IFL_ORPHAN 0x00000002
226 #define DLM_CB_CAST 0x00000001
227 #define DLM_CB_BAST 0x00000002
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 */
235 struct list_head list;
240 struct dlm_rsb *lkb_resource; /* the rsb */
242 int lkb_nodeid; /* copied from rsb */
243 int lkb_ownpid; /* pid of lock owner */
244 uint32_t lkb_id; /* our lock ID */
245 uint32_t lkb_remid; /* lock ID on remote partner */
246 uint32_t lkb_exflags; /* external flags from caller */
247 uint32_t lkb_sbflags; /* lksb flags */
248 uint32_t lkb_flags; /* internal flags */
249 uint32_t lkb_lvbseq; /* lvb sequence number */
251 int8_t lkb_status; /* granted, waiting, convert */
252 int8_t lkb_rqmode; /* requested lock mode */
253 int8_t lkb_grmode; /* granted lock mode */
254 int8_t lkb_highbast; /* highest mode bast sent for */
256 int8_t lkb_wait_type; /* type of reply waiting for */
257 int8_t lkb_wait_count;
258 int lkb_wait_nodeid; /* for debugging */
260 struct list_head lkb_statequeue; /* rsb g/c/w list */
261 struct list_head lkb_rsb_lookup; /* waiting for rsb lookup */
262 struct list_head lkb_wait_reply; /* waiting for remote reply */
263 struct list_head lkb_ownqueue; /* list of locks for a process */
264 ktime_t lkb_timestamp;
266 #ifdef CONFIG_DLM_DEPRECATED_API
267 struct list_head lkb_time_list;
268 unsigned long lkb_timeout_cs;
271 spinlock_t lkb_cb_lock;
272 struct work_struct lkb_cb_work;
273 struct list_head lkb_cb_list; /* for ls_cb_delay or proc->asts */
274 struct list_head lkb_callbacks;
275 struct dlm_callback *lkb_last_cast;
276 struct dlm_callback *lkb_last_cb;
277 int lkb_last_bast_mode;
278 ktime_t lkb_last_cast_time; /* for debugging */
279 ktime_t lkb_last_bast_time; /* for debugging */
281 uint64_t lkb_recover_seq; /* from ls_recover_seq */
284 struct dlm_lksb *lkb_lksb; /* caller's status block */
285 void (*lkb_astfn) (void *astparam);
286 void (*lkb_bastfn) (void *astparam, int mode);
288 void *lkb_astparam; /* caller's ast arg */
289 struct dlm_user_args *lkb_ua;
294 * res_master_nodeid is "normal": 0 is unset/invalid, non-zero is the real
295 * nodeid, even when nodeid is our_nodeid.
297 * res_nodeid is "odd": -1 is unset/invalid, zero means our_nodeid,
298 * greater than zero when another nodeid.
300 * (TODO: remove res_nodeid and only use res_master_nodeid)
304 struct dlm_ls *res_ls; /* the lockspace */
306 struct mutex res_mutex;
307 unsigned long res_flags;
308 int res_length; /* length of rsb name */
310 int res_master_nodeid;
312 int res_id; /* for ls_recover_idr */
315 uint32_t res_bucket; /* rsbtbl */
316 unsigned long res_toss_time;
317 uint32_t res_first_lkid;
318 struct list_head res_lookup; /* lkbs waiting on first */
320 struct list_head res_hashchain;
321 struct rb_node res_hashnode; /* rsbtbl */
323 struct list_head res_grantqueue;
324 struct list_head res_convertqueue;
325 struct list_head res_waitqueue;
327 struct list_head res_root_list; /* used for recovery */
328 struct list_head res_recover_list; /* used for recovery */
329 int res_recover_locks_count;
332 char res_name[DLM_RESNAME_MAXLEN+1];
335 /* dlm_master_lookup() flags */
337 #define DLM_LU_RECOVER_DIR 1
338 #define DLM_LU_RECOVER_MASTER 2
340 /* dlm_master_lookup() results */
342 #define DLM_LU_MATCH 1
345 /* find_rsb() flags */
347 #define R_REQUEST 0x00000001
348 #define R_RECEIVE_REQUEST 0x00000002
349 #define R_RECEIVE_RECOVER 0x00000004
354 RSB_MASTER_UNCERTAIN,
356 RSB_VALNOTVALID_PREV,
361 RSB_RECOVER_LVB_INVAL,
364 static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
366 __set_bit(flag, &r->res_flags);
369 static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
371 __clear_bit(flag, &r->res_flags);
374 static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
376 return test_bit(flag, &r->res_flags);
380 /* dlm_header is first element of all structs sent between nodes */
382 #define DLM_HEADER_MAJOR 0x00030000
383 #define DLM_HEADER_MINOR 0x00000002
385 #define DLM_VERSION_3_1 0x00030001
386 #define DLM_VERSION_3_2 0x00030002
388 #define DLM_HEADER_SLOTS 0x00000001
399 /* for DLM_MSG and DLM_RCOM */
401 /* for DLM_ACK and DLM_OPTS */
404 __le32 h_nodeid; /* nodeid of sender */
406 uint8_t h_cmd; /* DLM_MSG, DLM_RCOM */
410 #define DLM_MSG_REQUEST 1
411 #define DLM_MSG_CONVERT 2
412 #define DLM_MSG_UNLOCK 3
413 #define DLM_MSG_CANCEL 4
414 #define DLM_MSG_REQUEST_REPLY 5
415 #define DLM_MSG_CONVERT_REPLY 6
416 #define DLM_MSG_UNLOCK_REPLY 7
417 #define DLM_MSG_CANCEL_REPLY 8
418 #define DLM_MSG_GRANT 9
419 #define DLM_MSG_BAST 10
420 #define DLM_MSG_LOOKUP 11
421 #define DLM_MSG_REMOVE 12
422 #define DLM_MSG_LOOKUP_REPLY 13
423 #define DLM_MSG_PURGE 14
426 struct dlm_header m_header;
427 __le32 m_type; /* DLM_MSG_ */
430 __le32 m_lkid; /* lkid on sender */
431 __le32 m_remid; /* lkid on receiver */
432 __le32 m_parent_lkid;
433 __le32 m_parent_remid;
444 __le32 m_result; /* 0 or -EXXX */
445 char m_extra[]; /* name or lvb */
449 #define DLM_RS_NODES 0x00000001
450 #define DLM_RS_NODES_ALL 0x00000002
451 #define DLM_RS_DIR 0x00000004
452 #define DLM_RS_DIR_ALL 0x00000008
453 #define DLM_RS_LOCKS 0x00000010
454 #define DLM_RS_LOCKS_ALL 0x00000020
455 #define DLM_RS_DONE 0x00000040
456 #define DLM_RS_DONE_ALL 0x00000080
458 #define DLM_RCOM_STATUS 1
459 #define DLM_RCOM_NAMES 2
460 #define DLM_RCOM_LOOKUP 3
461 #define DLM_RCOM_LOCK 4
462 #define DLM_RCOM_STATUS_REPLY 5
463 #define DLM_RCOM_NAMES_REPLY 6
464 #define DLM_RCOM_LOOKUP_REPLY 7
465 #define DLM_RCOM_LOCK_REPLY 8
468 struct dlm_header rc_header;
469 __le32 rc_type; /* DLM_RCOM_ */
470 __le32 rc_result; /* multi-purpose */
471 __le64 rc_id; /* match reply with request */
472 __le64 rc_seq; /* sender's ls_recover_seq */
473 __le64 rc_seq_reply; /* remote ls_recover_seq */
477 struct dlm_opt_header {
481 /* need to be 8 byte aligned */
485 /* encapsulation header */
487 struct dlm_header o_header;
496 struct dlm_header header; /* common to other two */
497 struct dlm_message message;
498 struct dlm_rcom rcom;
499 struct dlm_opts opts;
502 #define DLM_RSF_NEED_SLOTS 0x00000001
504 /* RCOM_STATUS data */
511 /* RCOM_STATUS_REPLY data */
516 /* DLM_HEADER_SLOTS adds: */
520 __le32 rf_generation;
536 __le32 rl_parent_lkid;
537 __le32 rl_parent_remid;
548 char rl_name[DLM_RESNAME_MAXLEN];
553 * The max number of resources per rsbtbl bucket that shrink will attempt
554 * to remove in each iteration.
557 #define DLM_REMOVE_NAMES_MAX 8
560 struct list_head ls_list; /* list of lockspaces */
561 dlm_lockspace_t *ls_local_handle;
562 uint32_t ls_global_id; /* global unique lockspace ID */
563 uint32_t ls_generation;
566 atomic_t ls_count; /* refcount of processes in
567 the dlm using this ls */
568 wait_queue_head_t ls_count_wait;
569 int ls_create_count; /* create/release refcount */
570 unsigned long ls_flags; /* LSFL_ */
571 unsigned long ls_scan_time;
572 struct kobject ls_kobj;
574 struct idr ls_lkbidr;
575 spinlock_t ls_lkbidr_spin;
577 struct dlm_rsbtable *ls_rsbtbl;
578 uint32_t ls_rsbtbl_size;
580 struct mutex ls_waiters_mutex;
581 struct list_head ls_waiters; /* lkbs needing a reply */
583 struct mutex ls_orphans_mutex;
584 struct list_head ls_orphans;
586 #ifdef CONFIG_DLM_DEPRECATED_API
587 struct mutex ls_timeout_mutex;
588 struct list_head ls_timeout;
591 spinlock_t ls_new_rsb_spin;
592 int ls_new_rsb_count;
593 struct list_head ls_new_rsb; /* new rsb structs */
595 char *ls_remove_names[DLM_REMOVE_NAMES_MAX];
596 int ls_remove_lens[DLM_REMOVE_NAMES_MAX];
598 struct list_head ls_nodes; /* current nodes in ls */
599 struct list_head ls_nodes_gone; /* dead node list, recovery */
600 int ls_num_nodes; /* number of nodes in ls */
608 struct dlm_slot *ls_slots;
610 struct dlm_rsb ls_stub_rsb; /* for returning errors */
611 struct dlm_lkb ls_stub_lkb; /* for returning errors */
612 struct dlm_message ls_stub_ms; /* for faking a reply */
614 struct dentry *ls_debug_rsb_dentry; /* debugfs */
615 struct dentry *ls_debug_waiters_dentry; /* debugfs */
616 struct dentry *ls_debug_locks_dentry; /* debugfs */
617 struct dentry *ls_debug_all_dentry; /* debugfs */
618 struct dentry *ls_debug_toss_dentry; /* debugfs */
620 wait_queue_head_t ls_uevent_wait; /* user part of join/leave */
621 int ls_uevent_result;
622 struct completion ls_recovery_done;
623 int ls_recovery_result;
625 struct miscdevice ls_device;
627 struct workqueue_struct *ls_callback_wq;
629 /* recovery related */
631 spinlock_t ls_cb_lock;
632 struct list_head ls_cb_delay; /* save for queue_work later */
633 struct timer_list ls_timer;
634 struct task_struct *ls_recoverd_task;
635 struct mutex ls_recoverd_active;
636 spinlock_t ls_recover_lock;
637 unsigned long ls_recover_begin; /* jiffies timestamp */
638 uint32_t ls_recover_status; /* DLM_RS_ */
639 uint64_t ls_recover_seq;
640 struct dlm_recover *ls_recover_args;
641 struct rw_semaphore ls_in_recovery; /* block local requests */
642 struct rw_semaphore ls_recv_active; /* block dlm_recv */
643 struct list_head ls_requestqueue;/* queue remote requests */
644 atomic_t ls_requestqueue_cnt;
645 wait_queue_head_t ls_requestqueue_wait;
646 struct mutex ls_requestqueue_mutex;
647 struct dlm_rcom *ls_recover_buf;
648 int ls_recover_nodeid; /* for debugging */
649 unsigned int ls_recover_dir_sent_res; /* for log info */
650 unsigned int ls_recover_dir_sent_msg; /* for log info */
651 unsigned int ls_recover_locks_in; /* for log info */
652 uint64_t ls_rcom_seq;
653 spinlock_t ls_rcom_spin;
654 struct list_head ls_recover_list;
655 spinlock_t ls_recover_list_lock;
656 int ls_recover_list_count;
657 struct idr ls_recover_idr;
658 spinlock_t ls_recover_idr_lock;
659 wait_queue_head_t ls_wait_general;
660 wait_queue_head_t ls_recover_lock_wait;
661 spinlock_t ls_clear_proc_locks;
663 struct list_head ls_root_list; /* root resources */
664 struct rw_semaphore ls_root_sem; /* protect root_list */
666 const struct dlm_lockspace_ops *ls_ops;
670 char ls_name[DLM_LOCKSPACE_LEN + 1];
674 * LSFL_RECOVER_STOP - dlm_ls_stop() sets this to tell dlm recovery routines
675 * that they should abort what they're doing so new recovery can be started.
677 * LSFL_RECOVER_DOWN - dlm_ls_stop() sets this to tell dlm_recoverd that it
678 * should do down_write() on the in_recovery rw_semaphore. (doing down_write
679 * within dlm_ls_stop causes complaints about the lock acquired/released
680 * in different contexts.)
682 * LSFL_RECOVER_LOCK - dlm_recoverd holds the in_recovery rw_semaphore.
683 * It sets this after it is done with down_write() on the in_recovery
684 * rw_semaphore and clears it after it has released the rw_semaphore.
686 * LSFL_RECOVER_WORK - dlm_ls_start() sets this to tell dlm_recoverd that it
687 * should begin recovery of the lockspace.
689 * LSFL_RUNNING - set when normal locking activity is enabled.
690 * dlm_ls_stop() clears this to tell dlm locking routines that they should
691 * quit what they are doing so recovery can run. dlm_recoverd sets
692 * this after recovery is finished.
695 #define LSFL_RECOVER_STOP 0
696 #define LSFL_RECOVER_DOWN 1
697 #define LSFL_RECOVER_LOCK 2
698 #define LSFL_RECOVER_WORK 3
699 #define LSFL_RUNNING 4
701 #define LSFL_RCOM_READY 5
702 #define LSFL_RCOM_WAIT 6
703 #define LSFL_UEVENT_WAIT 7
704 #ifdef CONFIG_DLM_DEPRECATED_API
705 #define LSFL_TIMEWARN 8
707 #define LSFL_CB_DELAY 9
708 #define LSFL_NODIR 10
710 /* much of this is just saving user space pointers associated with the
711 lock that we pass back to the user lib with an ast */
713 struct dlm_user_args {
714 struct dlm_user_proc *proc; /* each process that opens the lockspace
715 device has private data
716 (dlm_user_proc) on the struct file,
717 the process's locks point back to it*/
718 struct dlm_lksb lksb;
719 struct dlm_lksb __user *user_lksb;
720 void __user *castparam;
721 void __user *castaddr;
722 void __user *bastparam;
723 void __user *bastaddr;
727 #define DLM_PROC_FLAGS_CLOSING 1
728 #define DLM_PROC_FLAGS_COMPAT 2
730 /* locks list is kept so we can remove all a process's locks when it
731 exits (or orphan those that are persistent) */
733 struct dlm_user_proc {
734 dlm_lockspace_t *lockspace;
735 unsigned long flags; /* DLM_PROC_FLAGS */
736 struct list_head asts;
737 spinlock_t asts_spin;
738 struct list_head locks;
739 spinlock_t locks_spin;
740 struct list_head unlocking;
741 wait_queue_head_t wait;
744 static inline int dlm_locking_stopped(struct dlm_ls *ls)
746 return !test_bit(LSFL_RUNNING, &ls->ls_flags);
749 static inline int dlm_recovery_stopped(struct dlm_ls *ls)
751 return test_bit(LSFL_RECOVER_STOP, &ls->ls_flags);
754 static inline int dlm_no_directory(struct dlm_ls *ls)
756 return test_bit(LSFL_NODIR, &ls->ls_flags);
759 #ifdef CONFIG_DLM_DEPRECATED_API
760 int dlm_netlink_init(void);
761 void dlm_netlink_exit(void);
762 void dlm_timeout_warn(struct dlm_lkb *lkb);
764 static inline int dlm_netlink_init(void) { return 0; }
765 static inline void dlm_netlink_exit(void) { };
766 static inline void dlm_timeout_warn(struct dlm_lkb *lkb) { };
768 int dlm_plock_init(void);
769 void dlm_plock_exit(void);
771 #ifdef CONFIG_DLM_DEBUG
772 void dlm_register_debugfs(void);
773 void dlm_unregister_debugfs(void);
774 void dlm_create_debug_file(struct dlm_ls *ls);
775 void dlm_delete_debug_file(struct dlm_ls *ls);
776 void *dlm_create_debug_comms_file(int nodeid, void *data);
777 void dlm_delete_debug_comms_file(void *ctx);
779 static inline void dlm_register_debugfs(void) { }
780 static inline void dlm_unregister_debugfs(void) { }
781 static inline void dlm_create_debug_file(struct dlm_ls *ls) { }
782 static inline void dlm_delete_debug_file(struct dlm_ls *ls) { }
783 static inline void *dlm_create_debug_comms_file(int nodeid, void *data) { return NULL; }
784 static inline void dlm_delete_debug_comms_file(void *ctx) { }
787 #endif /* __DLM_INTERNAL_DOT_H__ */