1 /******************************************************************************
2 *******************************************************************************
4 ** Copyright (C) Sistina Software, Inc. 1997-2003 All rights reserved.
5 ** Copyright (C) 2004-2007 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/module.h>
22 #include <linux/slab.h>
23 #include <linux/sched.h>
24 #include <linux/types.h>
25 #include <linux/ctype.h>
26 #include <linux/spinlock.h>
27 #include <linux/vmalloc.h>
28 #include <linux/list.h>
29 #include <linux/errno.h>
30 #include <linux/random.h>
31 #include <linux/delay.h>
32 #include <linux/socket.h>
33 #include <linux/kthread.h>
34 #include <linux/kobject.h>
35 #include <linux/kref.h>
36 #include <linux/kernel.h>
37 #include <linux/jhash.h>
38 #include <linux/miscdevice.h>
39 #include <linux/mutex.h>
40 #include <asm/semaphore.h>
41 #include <asm/uaccess.h>
43 #include <linux/dlm.h>
46 #define DLM_LOCKSPACE_LEN 64
48 /* Size of the temp buffer midcomms allocates on the stack.
49 We try to make this large enough so most messages fit.
50 FIXME: should sctp make this unnecessary? */
52 #define DLM_INBUF_LEN 148
68 #define log_print(fmt, args...) \
69 printk(KERN_ERR "dlm: "fmt"\n" , ##args)
70 #define log_error(ls, fmt, args...) \
71 printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
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 DLM_ASSERT(x, do) \
84 printk(KERN_ERR "\nDLM: Assertion failed on line %d of file %s\n" \
85 "DLM: assertion: \"%s\"\n" \
86 "DLM: time = %lu\n", \
87 __LINE__, __FILE__, #x, jiffies); \
91 panic("DLM: Record message above and reboot.\n"); \
95 #define DLM_FAKE_USER_AST ERR_PTR(-EINVAL)
99 struct list_head list
;
100 uint32_t master_nodeid
;
105 struct dlm_dirtable
{
106 struct list_head list
;
110 struct dlm_rsbtable
{
111 struct list_head list
;
112 struct list_head toss
;
116 struct dlm_lkbtable
{
117 struct list_head list
;
123 * Lockspace member (per node in a ls)
127 struct list_head list
;
133 * Save and manage recovery state for a lockspace.
137 struct list_head list
;
144 * Pass input args to second stage locking function.
153 struct dlm_lksb
*lksb
;
154 unsigned long timeout
;
161 * A lock can be one of three types:
163 * local copy lock is mastered locally
164 * (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
165 * process copy lock is mastered on a remote node
166 * (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
167 * master copy master node's copy of a lock owned by remote node
168 * (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
170 * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
171 * dlm_unlock. The dlm does not modify these or use any private flags in
172 * this field; it only contains DLM_LKF_ flags from dlm.h. These flags
173 * are sent as-is to the remote master when the lock is remote.
175 * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
176 * Some internal flags are shared between the master and process nodes;
177 * these shared flags are kept in the lower two bytes. One of these
178 * flags set on the master copy will be propagated to the process copy
179 * and v.v. Other internal flags are private to the master or process
180 * node (e.g. DLM_IFL_MSTCPY). These are kept in the high two bytes.
182 * lkb_sbflags: status block flags. These flags are copied directly into
183 * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
184 * ast. All defined in dlm.h with DLM_SBF_ prefix.
186 * lkb_status: the lock status indicates which rsb queue the lock is
187 * on, grant, convert, or wait. DLM_LKSTS_ WAITING/GRANTED/CONVERT
189 * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
190 * reply is needed. Only set when the lkb is on the lockspace waiters
191 * list awaiting a reply from a remote node.
193 * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
194 * is a master copy, nodeid specifies the remote lock holder, when the
195 * lkb is a process copy, the nodeid specifies the lock master.
205 #define DLM_LKSTS_WAITING 1
206 #define DLM_LKSTS_GRANTED 2
207 #define DLM_LKSTS_CONVERT 3
211 #define DLM_IFL_MSTCPY 0x00010000
212 #define DLM_IFL_RESEND 0x00020000
213 #define DLM_IFL_DEAD 0x00040000
214 #define DLM_IFL_OVERLAP_UNLOCK 0x00080000
215 #define DLM_IFL_OVERLAP_CANCEL 0x00100000
216 #define DLM_IFL_ENDOFLIFE 0x00200000
217 #define DLM_IFL_WATCH_TIMEWARN 0x00400000
218 #define DLM_IFL_TIMEOUT_CANCEL 0x00800000
219 #define DLM_IFL_DEADLOCK_CANCEL 0x01000000
220 #define DLM_IFL_USER 0x00000001
221 #define DLM_IFL_ORPHAN 0x00000002
224 struct dlm_rsb
*lkb_resource
; /* the rsb */
226 int lkb_nodeid
; /* copied from rsb */
227 int lkb_ownpid
; /* pid of lock owner */
228 uint32_t lkb_id
; /* our lock ID */
229 uint32_t lkb_remid
; /* lock ID on remote partner */
230 uint32_t lkb_exflags
; /* external flags from caller */
231 uint32_t lkb_sbflags
; /* lksb flags */
232 uint32_t lkb_flags
; /* internal flags */
233 uint32_t lkb_lvbseq
; /* lvb sequence number */
235 int8_t lkb_status
; /* granted, waiting, convert */
236 int8_t lkb_rqmode
; /* requested lock mode */
237 int8_t lkb_grmode
; /* granted lock mode */
238 int8_t lkb_bastmode
; /* requested mode */
239 int8_t lkb_highbast
; /* highest mode bast sent for */
240 int8_t lkb_wait_type
; /* type of reply waiting for */
241 int8_t lkb_wait_count
;
242 int8_t lkb_ast_type
; /* type of ast queued for */
244 struct list_head lkb_idtbl_list
; /* lockspace lkbtbl */
245 struct list_head lkb_statequeue
; /* rsb g/c/w list */
246 struct list_head lkb_rsb_lookup
; /* waiting for rsb lookup */
247 struct list_head lkb_wait_reply
; /* waiting for remote reply */
248 struct list_head lkb_astqueue
; /* need ast to be sent */
249 struct list_head lkb_ownqueue
; /* list of locks for a process */
250 struct list_head lkb_time_list
;
251 unsigned long lkb_timestamp
;
252 unsigned long lkb_timeout_cs
;
255 struct dlm_lksb
*lkb_lksb
; /* caller's status block */
256 void *lkb_astaddr
; /* caller's ast function */
257 void *lkb_bastaddr
; /* caller's bast function */
258 long lkb_astparam
; /* caller's ast arg */
263 struct dlm_ls
*res_ls
; /* the lockspace */
265 struct mutex res_mutex
;
266 unsigned long res_flags
;
267 int res_length
; /* length of rsb name */
271 uint32_t res_bucket
; /* rsbtbl */
272 unsigned long res_toss_time
;
273 uint32_t res_first_lkid
;
274 struct list_head res_lookup
; /* lkbs waiting on first */
275 struct list_head res_hashchain
; /* rsbtbl */
276 struct list_head res_grantqueue
;
277 struct list_head res_convertqueue
;
278 struct list_head res_waitqueue
;
280 struct list_head res_root_list
; /* used for recovery */
281 struct list_head res_recover_list
; /* used for recovery */
282 int res_recover_locks_count
;
288 /* find_rsb() flags */
290 #define R_MASTER 1 /* only return rsb if it's a master */
291 #define R_CREATE 2 /* create/add rsb if not found */
296 RSB_MASTER_UNCERTAIN
,
298 RSB_VALNOTVALID_PREV
,
305 static inline void rsb_set_flag(struct dlm_rsb
*r
, enum rsb_flags flag
)
307 __set_bit(flag
, &r
->res_flags
);
310 static inline void rsb_clear_flag(struct dlm_rsb
*r
, enum rsb_flags flag
)
312 __clear_bit(flag
, &r
->res_flags
);
315 static inline int rsb_flag(struct dlm_rsb
*r
, enum rsb_flags flag
)
317 return test_bit(flag
, &r
->res_flags
);
321 /* dlm_header is first element of all structs sent between nodes */
323 #define DLM_HEADER_MAJOR 0x00030000
324 #define DLM_HEADER_MINOR 0x00000000
331 uint32_t h_lockspace
;
332 uint32_t h_nodeid
; /* nodeid of sender */
334 uint8_t h_cmd
; /* DLM_MSG, DLM_RCOM */
339 #define DLM_MSG_REQUEST 1
340 #define DLM_MSG_CONVERT 2
341 #define DLM_MSG_UNLOCK 3
342 #define DLM_MSG_CANCEL 4
343 #define DLM_MSG_REQUEST_REPLY 5
344 #define DLM_MSG_CONVERT_REPLY 6
345 #define DLM_MSG_UNLOCK_REPLY 7
346 #define DLM_MSG_CANCEL_REPLY 8
347 #define DLM_MSG_GRANT 9
348 #define DLM_MSG_BAST 10
349 #define DLM_MSG_LOOKUP 11
350 #define DLM_MSG_REMOVE 12
351 #define DLM_MSG_LOOKUP_REPLY 13
352 #define DLM_MSG_PURGE 14
355 struct dlm_header m_header
;
356 uint32_t m_type
; /* DLM_MSG_ */
359 uint32_t m_lkid
; /* lkid on sender */
360 uint32_t m_remid
; /* lkid on receiver */
361 uint32_t m_parent_lkid
;
362 uint32_t m_parent_remid
;
373 int m_result
; /* 0 or -EXXX */
374 char m_extra
[0]; /* name or lvb */
378 #define DLM_RS_NODES 0x00000001
379 #define DLM_RS_NODES_ALL 0x00000002
380 #define DLM_RS_DIR 0x00000004
381 #define DLM_RS_DIR_ALL 0x00000008
382 #define DLM_RS_LOCKS 0x00000010
383 #define DLM_RS_LOCKS_ALL 0x00000020
384 #define DLM_RS_DONE 0x00000040
385 #define DLM_RS_DONE_ALL 0x00000080
387 #define DLM_RCOM_STATUS 1
388 #define DLM_RCOM_NAMES 2
389 #define DLM_RCOM_LOOKUP 3
390 #define DLM_RCOM_LOCK 4
391 #define DLM_RCOM_STATUS_REPLY 5
392 #define DLM_RCOM_NAMES_REPLY 6
393 #define DLM_RCOM_LOOKUP_REPLY 7
394 #define DLM_RCOM_LOCK_REPLY 8
397 struct dlm_header rc_header
;
398 uint32_t rc_type
; /* DLM_RCOM_ */
399 int rc_result
; /* multi-purpose */
400 uint64_t rc_id
; /* match reply with request */
401 uint64_t rc_seq
; /* sender's ls_recover_seq */
402 uint64_t rc_seq_reply
; /* remote ls_recover_seq */
407 struct dlm_header header
; /* common to other two */
408 struct dlm_message message
;
409 struct dlm_rcom rcom
;
422 uint32_t rl_parent_lkid
;
423 uint32_t rl_parent_remid
;
432 uint16_t rl_wait_type
;
434 char rl_name
[DLM_RESNAME_MAXLEN
];
439 struct list_head ls_list
; /* list of lockspaces */
440 dlm_lockspace_t
*ls_local_handle
;
441 uint32_t ls_global_id
; /* global unique lockspace ID */
444 int ls_count
; /* reference count */
445 unsigned long ls_flags
; /* LSFL_ */
446 struct kobject ls_kobj
;
448 struct dlm_rsbtable
*ls_rsbtbl
;
449 uint32_t ls_rsbtbl_size
;
451 struct dlm_lkbtable
*ls_lkbtbl
;
452 uint32_t ls_lkbtbl_size
;
454 struct dlm_dirtable
*ls_dirtbl
;
455 uint32_t ls_dirtbl_size
;
457 struct mutex ls_waiters_mutex
;
458 struct list_head ls_waiters
; /* lkbs needing a reply */
460 struct mutex ls_orphans_mutex
;
461 struct list_head ls_orphans
;
463 struct mutex ls_timeout_mutex
;
464 struct list_head ls_timeout
;
466 struct list_head ls_nodes
; /* current nodes in ls */
467 struct list_head ls_nodes_gone
; /* dead node list, recovery */
468 int ls_num_nodes
; /* number of nodes in ls */
474 struct dlm_rsb ls_stub_rsb
; /* for returning errors */
475 struct dlm_lkb ls_stub_lkb
; /* for returning errors */
476 struct dlm_message ls_stub_ms
; /* for faking a reply */
478 struct dentry
*ls_debug_rsb_dentry
; /* debugfs */
479 struct dentry
*ls_debug_waiters_dentry
; /* debugfs */
480 struct dentry
*ls_debug_locks_dentry
; /* debugfs */
482 wait_queue_head_t ls_uevent_wait
; /* user part of join/leave */
483 int ls_uevent_result
;
484 struct completion ls_members_done
;
485 int ls_members_result
;
487 struct miscdevice ls_device
;
489 /* recovery related */
491 struct timer_list ls_timer
;
492 struct task_struct
*ls_recoverd_task
;
493 struct mutex ls_recoverd_active
;
494 spinlock_t ls_recover_lock
;
495 unsigned long ls_recover_begin
; /* jiffies timestamp */
496 uint32_t ls_recover_status
; /* DLM_RS_ */
497 uint64_t ls_recover_seq
;
498 struct dlm_recover
*ls_recover_args
;
499 struct rw_semaphore ls_in_recovery
; /* block local requests */
500 struct rw_semaphore ls_recv_active
; /* block dlm_recv */
501 struct list_head ls_requestqueue
;/* queue remote requests */
502 struct mutex ls_requestqueue_mutex
;
503 char *ls_recover_buf
;
504 int ls_recover_nodeid
; /* for debugging */
505 uint64_t ls_rcom_seq
;
506 spinlock_t ls_rcom_spin
;
507 struct list_head ls_recover_list
;
508 spinlock_t ls_recover_list_lock
;
509 int ls_recover_list_count
;
510 wait_queue_head_t ls_wait_general
;
511 struct mutex ls_clear_proc_locks
;
513 struct list_head ls_root_list
; /* root resources */
514 struct rw_semaphore ls_root_sem
; /* protect root_list */
521 #define LSFL_RUNNING 1
522 #define LSFL_RECOVERY_STOP 2
523 #define LSFL_RCOM_READY 3
524 #define LSFL_RCOM_WAIT 4
525 #define LSFL_UEVENT_WAIT 5
526 #define LSFL_TIMEWARN 6
528 /* much of this is just saving user space pointers associated with the
529 lock that we pass back to the user lib with an ast */
531 struct dlm_user_args
{
532 struct dlm_user_proc
*proc
; /* each process that opens the lockspace
533 device has private data
534 (dlm_user_proc) on the struct file,
535 the process's locks point back to it*/
536 struct dlm_lksb lksb
;
539 struct dlm_lksb __user
*user_lksb
;
540 void __user
*castparam
;
541 void __user
*castaddr
;
542 void __user
*bastparam
;
543 void __user
*bastaddr
;
547 #define DLM_PROC_FLAGS_CLOSING 1
548 #define DLM_PROC_FLAGS_COMPAT 2
550 /* locks list is kept so we can remove all a process's locks when it
551 exits (or orphan those that are persistent) */
553 struct dlm_user_proc
{
554 dlm_lockspace_t
*lockspace
;
555 unsigned long flags
; /* DLM_PROC_FLAGS */
556 struct list_head asts
;
557 spinlock_t asts_spin
;
558 struct list_head locks
;
559 spinlock_t locks_spin
;
560 struct list_head unlocking
;
561 wait_queue_head_t wait
;
564 static inline int dlm_locking_stopped(struct dlm_ls
*ls
)
566 return !test_bit(LSFL_RUNNING
, &ls
->ls_flags
);
569 static inline int dlm_recovery_stopped(struct dlm_ls
*ls
)
571 return test_bit(LSFL_RECOVERY_STOP
, &ls
->ls_flags
);
574 static inline int dlm_no_directory(struct dlm_ls
*ls
)
576 return (ls
->ls_exflags
& DLM_LSFL_NODIR
) ? 1 : 0;
579 int dlm_netlink_init(void);
580 void dlm_netlink_exit(void);
581 void dlm_timeout_warn(struct dlm_lkb
*lkb
);
583 #ifdef CONFIG_DLM_DEBUG
584 int dlm_register_debugfs(void);
585 void dlm_unregister_debugfs(void);
586 int dlm_create_debug_file(struct dlm_ls
*ls
);
587 void dlm_delete_debug_file(struct dlm_ls
*ls
);
589 static inline int dlm_register_debugfs(void) { return 0; }
590 static inline void dlm_unregister_debugfs(void) { }
591 static inline int dlm_create_debug_file(struct dlm_ls
*ls
) { return 0; }
592 static inline void dlm_delete_debug_file(struct dlm_ls
*ls
) { }
595 #endif /* __DLM_INTERNAL_DOT_H__ */