1 /******************************************************************************
2 *******************************************************************************
4 ** Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
5 ** Copyright (C) 2004-2011 Red Hat, Inc. All rights reserved.
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.
11 *******************************************************************************
12 ******************************************************************************/
14 #ifndef __DLM_INTERNAL_DOT_H__
15 #define __DLM_INTERNAL_DOT_H__
18 * This is the main header file to be included in each DLM source file.
21 #include <linux/slab.h>
22 #include <linux/sched.h>
23 #include <linux/types.h>
24 #include <linux/ctype.h>
25 #include <linux/spinlock.h>
26 #include <linux/vmalloc.h>
27 #include <linux/list.h>
28 #include <linux/errno.h>
29 #include <linux/random.h>
30 #include <linux/delay.h>
31 #include <linux/socket.h>
32 #include <linux/kthread.h>
33 #include <linux/kobject.h>
34 #include <linux/kref.h>
35 #include <linux/kernel.h>
36 #include <linux/jhash.h>
37 #include <linux/miscdevice.h>
38 #include <linux/mutex.h>
39 #include <linux/idr.h>
40 #include <linux/ratelimit.h>
41 #include <linux/uaccess.h>
43 #include <linux/dlm.h>
46 /* Size of the temp buffer midcomms allocates on the stack.
47 We try to make this large enough so most messages fit.
48 FIXME: should sctp make this unnecessary? */
50 #define DLM_INBUF_LEN 148
63 #define log_print(fmt, args...) \
64 printk(KERN_ERR "dlm: "fmt"\n" , ##args)
65 #define log_error(ls, fmt, args...) \
66 printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
68 #define log_rinfo(ls, fmt, args...) \
70 if (dlm_config.ci_log_info) \
71 printk(KERN_INFO "dlm: %s: " fmt "\n", \
72 (ls)->ls_name, ##args); \
73 else if (dlm_config.ci_log_debug) \
74 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
75 (ls)->ls_name , ##args); \
78 #define log_debug(ls, fmt, args...) \
80 if (dlm_config.ci_log_debug) \
81 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
82 (ls)->ls_name , ##args); \
85 #define log_limit(ls, fmt, args...) \
87 if (dlm_config.ci_log_debug) \
88 printk_ratelimited(KERN_DEBUG "dlm: %s: " fmt "\n", \
89 (ls)->ls_name , ##args); \
92 #define DLM_ASSERT(x, do) \
96 printk(KERN_ERR "\nDLM: Assertion failed on line %d of file %s\n" \
97 "DLM: assertion: \"%s\"\n" \
98 "DLM: time = %lu\n", \
99 __LINE__, __FILE__, #x, jiffies); \
102 panic("DLM: Record message above and reboot.\n"); \
107 #define DLM_RTF_SHRINK 0x00000001
109 struct dlm_rsbtable {
118 * Lockspace member (per node in a ls)
122 struct list_head list;
132 * Save and manage recovery state for a lockspace.
136 struct list_head list;
137 struct dlm_config_node *nodes;
143 * Pass input args to second stage locking function.
148 void (*astfn) (void *astparam);
150 void (*bastfn) (void *astparam, int mode);
152 struct dlm_lksb *lksb;
153 unsigned long timeout;
160 * A lock can be one of three types:
162 * local copy lock is mastered locally
163 * (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
164 * process copy lock is mastered on a remote node
165 * (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
166 * master copy master node's copy of a lock owned by remote node
167 * (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
169 * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
170 * dlm_unlock. The dlm does not modify these or use any private flags in
171 * this field; it only contains DLM_LKF_ flags from dlm.h. These flags
172 * are sent as-is to the remote master when the lock is remote.
174 * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
175 * Some internal flags are shared between the master and process nodes;
176 * these shared flags are kept in the lower two bytes. One of these
177 * flags set on the master copy will be propagated to the process copy
178 * and v.v. Other internal flags are private to the master or process
179 * node (e.g. DLM_IFL_MSTCPY). These are kept in the high two bytes.
181 * lkb_sbflags: status block flags. These flags are copied directly into
182 * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
183 * ast. All defined in dlm.h with DLM_SBF_ prefix.
185 * lkb_status: the lock status indicates which rsb queue the lock is
186 * on, grant, convert, or wait. DLM_LKSTS_ WAITING/GRANTED/CONVERT
188 * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
189 * reply is needed. Only set when the lkb is on the lockspace waiters
190 * list awaiting a reply from a remote node.
192 * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
193 * is a master copy, nodeid specifies the remote lock holder, when the
194 * lkb is a process copy, the nodeid specifies the lock master.
199 #define DLM_LKSTS_WAITING 1
200 #define DLM_LKSTS_GRANTED 2
201 #define DLM_LKSTS_CONVERT 3
205 #define DLM_IFL_MSTCPY 0x00010000
206 #define DLM_IFL_RESEND 0x00020000
207 #define DLM_IFL_DEAD 0x00040000
208 #define DLM_IFL_OVERLAP_UNLOCK 0x00080000
209 #define DLM_IFL_OVERLAP_CANCEL 0x00100000
210 #define DLM_IFL_ENDOFLIFE 0x00200000
211 #define DLM_IFL_WATCH_TIMEWARN 0x00400000
212 #define DLM_IFL_TIMEOUT_CANCEL 0x00800000
213 #define DLM_IFL_DEADLOCK_CANCEL 0x01000000
214 #define DLM_IFL_STUB_MS 0x02000000 /* magic number for m_flags */
215 #define DLM_IFL_USER 0x00000001
216 #define DLM_IFL_ORPHAN 0x00000002
218 #define DLM_CALLBACKS_SIZE 6
220 #define DLM_CB_CAST 0x00000001
221 #define DLM_CB_BAST 0x00000002
222 #define DLM_CB_SKIP 0x00000004
224 struct dlm_callback {
226 uint32_t flags; /* DLM_CBF_ */
227 int sb_status; /* copy to lksb status */
228 uint8_t sb_flags; /* copy to lksb flags */
229 int8_t mode; /* rq mode of bast, gr mode of cast */
233 struct dlm_rsb *lkb_resource; /* the rsb */
235 int lkb_nodeid; /* copied from rsb */
236 int lkb_ownpid; /* pid of lock owner */
237 uint32_t lkb_id; /* our lock ID */
238 uint32_t lkb_remid; /* lock ID on remote partner */
239 uint32_t lkb_exflags; /* external flags from caller */
240 uint32_t lkb_sbflags; /* lksb flags */
241 uint32_t lkb_flags; /* internal flags */
242 uint32_t lkb_lvbseq; /* lvb sequence number */
244 int8_t lkb_status; /* granted, waiting, convert */
245 int8_t lkb_rqmode; /* requested lock mode */
246 int8_t lkb_grmode; /* granted lock mode */
247 int8_t lkb_highbast; /* highest mode bast sent for */
249 int8_t lkb_wait_type; /* type of reply waiting for */
250 int8_t lkb_wait_count;
251 int lkb_wait_nodeid; /* for debugging */
253 struct list_head lkb_statequeue; /* rsb g/c/w list */
254 struct list_head lkb_rsb_lookup; /* waiting for rsb lookup */
255 struct list_head lkb_wait_reply; /* waiting for remote reply */
256 struct list_head lkb_ownqueue; /* list of locks for a process */
257 struct list_head lkb_time_list;
258 ktime_t lkb_timestamp;
259 ktime_t lkb_wait_time;
260 unsigned long lkb_timeout_cs;
262 struct mutex lkb_cb_mutex;
263 struct work_struct lkb_cb_work;
264 struct list_head lkb_cb_list; /* for ls_cb_delay or proc->asts */
265 struct dlm_callback lkb_callbacks[DLM_CALLBACKS_SIZE];
266 struct dlm_callback lkb_last_cast;
267 struct dlm_callback lkb_last_bast;
268 ktime_t lkb_last_cast_time; /* for debugging */
269 ktime_t lkb_last_bast_time; /* for debugging */
271 uint64_t lkb_recover_seq; /* from ls_recover_seq */
274 struct dlm_lksb *lkb_lksb; /* caller's status block */
275 void (*lkb_astfn) (void *astparam);
276 void (*lkb_bastfn) (void *astparam, int mode);
278 void *lkb_astparam; /* caller's ast arg */
279 struct dlm_user_args *lkb_ua;
284 * res_master_nodeid is "normal": 0 is unset/invalid, non-zero is the real
285 * nodeid, even when nodeid is our_nodeid.
287 * res_nodeid is "odd": -1 is unset/invalid, zero means our_nodeid,
288 * greater than zero when another nodeid.
290 * (TODO: remove res_nodeid and only use res_master_nodeid)
294 struct dlm_ls *res_ls; /* the lockspace */
296 struct mutex res_mutex;
297 unsigned long res_flags;
298 int res_length; /* length of rsb name */
300 int res_master_nodeid;
302 int res_id; /* for ls_recover_idr */
305 uint32_t res_bucket; /* rsbtbl */
306 unsigned long res_toss_time;
307 uint32_t res_first_lkid;
308 struct list_head res_lookup; /* lkbs waiting on first */
310 struct list_head res_hashchain;
311 struct rb_node res_hashnode; /* rsbtbl */
313 struct list_head res_grantqueue;
314 struct list_head res_convertqueue;
315 struct list_head res_waitqueue;
317 struct list_head res_root_list; /* used for recovery */
318 struct list_head res_recover_list; /* used for recovery */
319 int res_recover_locks_count;
322 char res_name[DLM_RESNAME_MAXLEN+1];
325 /* dlm_master_lookup() flags */
327 #define DLM_LU_RECOVER_DIR 1
328 #define DLM_LU_RECOVER_MASTER 2
330 /* dlm_master_lookup() results */
332 #define DLM_LU_MATCH 1
335 /* find_rsb() flags */
337 #define R_REQUEST 0x00000001
338 #define R_RECEIVE_REQUEST 0x00000002
339 #define R_RECEIVE_RECOVER 0x00000004
344 RSB_MASTER_UNCERTAIN,
346 RSB_VALNOTVALID_PREV,
351 RSB_RECOVER_LVB_INVAL,
354 static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
356 __set_bit(flag, &r->res_flags);
359 static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
361 __clear_bit(flag, &r->res_flags);
364 static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
366 return test_bit(flag, &r->res_flags);
370 /* dlm_header is first element of all structs sent between nodes */
372 #define DLM_HEADER_MAJOR 0x00030000
373 #define DLM_HEADER_MINOR 0x00000001
375 #define DLM_HEADER_SLOTS 0x00000001
382 uint32_t h_lockspace;
383 uint32_t h_nodeid; /* nodeid of sender */
385 uint8_t h_cmd; /* DLM_MSG, DLM_RCOM */
390 #define DLM_MSG_REQUEST 1
391 #define DLM_MSG_CONVERT 2
392 #define DLM_MSG_UNLOCK 3
393 #define DLM_MSG_CANCEL 4
394 #define DLM_MSG_REQUEST_REPLY 5
395 #define DLM_MSG_CONVERT_REPLY 6
396 #define DLM_MSG_UNLOCK_REPLY 7
397 #define DLM_MSG_CANCEL_REPLY 8
398 #define DLM_MSG_GRANT 9
399 #define DLM_MSG_BAST 10
400 #define DLM_MSG_LOOKUP 11
401 #define DLM_MSG_REMOVE 12
402 #define DLM_MSG_LOOKUP_REPLY 13
403 #define DLM_MSG_PURGE 14
406 struct dlm_header m_header;
407 uint32_t m_type; /* DLM_MSG_ */
410 uint32_t m_lkid; /* lkid on sender */
411 uint32_t m_remid; /* lkid on receiver */
412 uint32_t m_parent_lkid;
413 uint32_t m_parent_remid;
424 int m_result; /* 0 or -EXXX */
425 char m_extra[0]; /* name or lvb */
429 #define DLM_RS_NODES 0x00000001
430 #define DLM_RS_NODES_ALL 0x00000002
431 #define DLM_RS_DIR 0x00000004
432 #define DLM_RS_DIR_ALL 0x00000008
433 #define DLM_RS_LOCKS 0x00000010
434 #define DLM_RS_LOCKS_ALL 0x00000020
435 #define DLM_RS_DONE 0x00000040
436 #define DLM_RS_DONE_ALL 0x00000080
438 #define DLM_RCOM_STATUS 1
439 #define DLM_RCOM_NAMES 2
440 #define DLM_RCOM_LOOKUP 3
441 #define DLM_RCOM_LOCK 4
442 #define DLM_RCOM_STATUS_REPLY 5
443 #define DLM_RCOM_NAMES_REPLY 6
444 #define DLM_RCOM_LOOKUP_REPLY 7
445 #define DLM_RCOM_LOCK_REPLY 8
448 struct dlm_header rc_header;
449 uint32_t rc_type; /* DLM_RCOM_ */
450 int rc_result; /* multi-purpose */
451 uint64_t rc_id; /* match reply with request */
452 uint64_t rc_seq; /* sender's ls_recover_seq */
453 uint64_t rc_seq_reply; /* remote ls_recover_seq */
458 struct dlm_header header; /* common to other two */
459 struct dlm_message message;
460 struct dlm_rcom rcom;
463 #define DLM_RSF_NEED_SLOTS 0x00000001
465 /* RCOM_STATUS data */
472 /* RCOM_STATUS_REPLY data */
477 /* DLM_HEADER_SLOTS adds: */
481 __le32 rf_generation;
497 __le32 rl_parent_lkid;
498 __le32 rl_parent_remid;
509 char rl_name[DLM_RESNAME_MAXLEN];
514 * The max number of resources per rsbtbl bucket that shrink will attempt
515 * to remove in each iteration.
518 #define DLM_REMOVE_NAMES_MAX 8
521 struct list_head ls_list; /* list of lockspaces */
522 dlm_lockspace_t *ls_local_handle;
523 uint32_t ls_global_id; /* global unique lockspace ID */
524 uint32_t ls_generation;
527 int ls_count; /* refcount of processes in
528 the dlm using this ls */
529 int ls_create_count; /* create/release refcount */
530 unsigned long ls_flags; /* LSFL_ */
531 unsigned long ls_scan_time;
532 struct kobject ls_kobj;
534 struct idr ls_lkbidr;
535 spinlock_t ls_lkbidr_spin;
537 struct dlm_rsbtable *ls_rsbtbl;
538 uint32_t ls_rsbtbl_size;
540 struct mutex ls_waiters_mutex;
541 struct list_head ls_waiters; /* lkbs needing a reply */
543 struct mutex ls_orphans_mutex;
544 struct list_head ls_orphans;
546 struct mutex ls_timeout_mutex;
547 struct list_head ls_timeout;
549 spinlock_t ls_new_rsb_spin;
550 int ls_new_rsb_count;
551 struct list_head ls_new_rsb; /* new rsb structs */
553 spinlock_t ls_remove_spin;
554 char ls_remove_name[DLM_RESNAME_MAXLEN+1];
555 char *ls_remove_names[DLM_REMOVE_NAMES_MAX];
557 int ls_remove_lens[DLM_REMOVE_NAMES_MAX];
559 struct list_head ls_nodes; /* current nodes in ls */
560 struct list_head ls_nodes_gone; /* dead node list, recovery */
561 int ls_num_nodes; /* number of nodes in ls */
569 struct dlm_slot *ls_slots;
571 struct dlm_rsb ls_stub_rsb; /* for returning errors */
572 struct dlm_lkb ls_stub_lkb; /* for returning errors */
573 struct dlm_message ls_stub_ms; /* for faking a reply */
575 struct dentry *ls_debug_rsb_dentry; /* debugfs */
576 struct dentry *ls_debug_waiters_dentry; /* debugfs */
577 struct dentry *ls_debug_locks_dentry; /* debugfs */
578 struct dentry *ls_debug_all_dentry; /* debugfs */
579 struct dentry *ls_debug_toss_dentry; /* debugfs */
581 wait_queue_head_t ls_uevent_wait; /* user part of join/leave */
582 int ls_uevent_result;
583 struct completion ls_members_done;
584 int ls_members_result;
586 struct miscdevice ls_device;
588 struct workqueue_struct *ls_callback_wq;
590 /* recovery related */
592 struct mutex ls_cb_mutex;
593 struct list_head ls_cb_delay; /* save for queue_work later */
594 struct timer_list ls_timer;
595 struct task_struct *ls_recoverd_task;
596 struct mutex ls_recoverd_active;
597 spinlock_t ls_recover_lock;
598 unsigned long ls_recover_begin; /* jiffies timestamp */
599 uint32_t ls_recover_status; /* DLM_RS_ */
600 uint64_t ls_recover_seq;
601 struct dlm_recover *ls_recover_args;
602 struct rw_semaphore ls_in_recovery; /* block local requests */
603 struct rw_semaphore ls_recv_active; /* block dlm_recv */
604 struct list_head ls_requestqueue;/* queue remote requests */
605 struct mutex ls_requestqueue_mutex;
606 struct dlm_rcom *ls_recover_buf;
607 int ls_recover_nodeid; /* for debugging */
608 unsigned int ls_recover_dir_sent_res; /* for log info */
609 unsigned int ls_recover_dir_sent_msg; /* for log info */
610 unsigned int ls_recover_locks_in; /* for log info */
611 uint64_t ls_rcom_seq;
612 spinlock_t ls_rcom_spin;
613 struct list_head ls_recover_list;
614 spinlock_t ls_recover_list_lock;
615 int ls_recover_list_count;
616 struct idr ls_recover_idr;
617 spinlock_t ls_recover_idr_lock;
618 wait_queue_head_t ls_wait_general;
619 wait_queue_head_t ls_recover_lock_wait;
620 struct mutex ls_clear_proc_locks;
622 struct list_head ls_root_list; /* root resources */
623 struct rw_semaphore ls_root_sem; /* protect root_list */
625 const struct dlm_lockspace_ops *ls_ops;
633 * LSFL_RECOVER_STOP - dlm_ls_stop() sets this to tell dlm recovery routines
634 * that they should abort what they're doing so new recovery can be started.
636 * LSFL_RECOVER_DOWN - dlm_ls_stop() sets this to tell dlm_recoverd that it
637 * should do down_write() on the in_recovery rw_semaphore. (doing down_write
638 * within dlm_ls_stop causes complaints about the lock acquired/released
639 * in different contexts.)
641 * LSFL_RECOVER_LOCK - dlm_recoverd holds the in_recovery rw_semaphore.
642 * It sets this after it is done with down_write() on the in_recovery
643 * rw_semaphore and clears it after it has released the rw_semaphore.
645 * LSFL_RECOVER_WORK - dlm_ls_start() sets this to tell dlm_recoverd that it
646 * should begin recovery of the lockspace.
648 * LSFL_RUNNING - set when normal locking activity is enabled.
649 * dlm_ls_stop() clears this to tell dlm locking routines that they should
650 * quit what they are doing so recovery can run. dlm_recoverd sets
651 * this after recovery is finished.
654 #define LSFL_RECOVER_STOP 0
655 #define LSFL_RECOVER_DOWN 1
656 #define LSFL_RECOVER_LOCK 2
657 #define LSFL_RECOVER_WORK 3
658 #define LSFL_RUNNING 4
660 #define LSFL_RCOM_READY 5
661 #define LSFL_RCOM_WAIT 6
662 #define LSFL_UEVENT_WAIT 7
663 #define LSFL_TIMEWARN 8
664 #define LSFL_CB_DELAY 9
665 #define LSFL_NODIR 10
667 /* much of this is just saving user space pointers associated with the
668 lock that we pass back to the user lib with an ast */
670 struct dlm_user_args {
671 struct dlm_user_proc *proc; /* each process that opens the lockspace
672 device has private data
673 (dlm_user_proc) on the struct file,
674 the process's locks point back to it*/
675 struct dlm_lksb lksb;
676 struct dlm_lksb __user *user_lksb;
677 void __user *castparam;
678 void __user *castaddr;
679 void __user *bastparam;
680 void __user *bastaddr;
684 #define DLM_PROC_FLAGS_CLOSING 1
685 #define DLM_PROC_FLAGS_COMPAT 2
687 /* locks list is kept so we can remove all a process's locks when it
688 exits (or orphan those that are persistent) */
690 struct dlm_user_proc {
691 dlm_lockspace_t *lockspace;
692 unsigned long flags; /* DLM_PROC_FLAGS */
693 struct list_head asts;
694 spinlock_t asts_spin;
695 struct list_head locks;
696 spinlock_t locks_spin;
697 struct list_head unlocking;
698 wait_queue_head_t wait;
701 static inline int dlm_locking_stopped(struct dlm_ls *ls)
703 return !test_bit(LSFL_RUNNING, &ls->ls_flags);
706 static inline int dlm_recovery_stopped(struct dlm_ls *ls)
708 return test_bit(LSFL_RECOVER_STOP, &ls->ls_flags);
711 static inline int dlm_no_directory(struct dlm_ls *ls)
713 return test_bit(LSFL_NODIR, &ls->ls_flags);
716 int dlm_netlink_init(void);
717 void dlm_netlink_exit(void);
718 void dlm_timeout_warn(struct dlm_lkb *lkb);
719 int dlm_plock_init(void);
720 void dlm_plock_exit(void);
722 #ifdef CONFIG_DLM_DEBUG
723 int dlm_register_debugfs(void);
724 void dlm_unregister_debugfs(void);
725 int dlm_create_debug_file(struct dlm_ls *ls);
726 void dlm_delete_debug_file(struct dlm_ls *ls);
728 static inline int dlm_register_debugfs(void) { return 0; }
729 static inline void dlm_unregister_debugfs(void) { }
730 static inline int dlm_create_debug_file(struct dlm_ls *ls) { return 0; }
731 static inline void dlm_delete_debug_file(struct dlm_ls *ls) { }
734 #endif /* __DLM_INTERNAL_DOT_H__ */