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_USER 0x00000001
219 #define DLM_IFL_ORPHAN 0x00000002
220 #define DLM_IFL_TIMEOUT_CANCEL 0x00000004
223 struct dlm_rsb *lkb_resource; /* the rsb */
225 int lkb_nodeid; /* copied from rsb */
226 int lkb_ownpid; /* pid of lock owner */
227 uint32_t lkb_id; /* our lock ID */
228 uint32_t lkb_remid; /* lock ID on remote partner */
229 uint32_t lkb_exflags; /* external flags from caller */
230 uint32_t lkb_sbflags; /* lksb flags */
231 uint32_t lkb_flags; /* internal flags */
232 uint32_t lkb_lvbseq; /* lvb sequence number */
234 int8_t lkb_status; /* granted, waiting, convert */
235 int8_t lkb_rqmode; /* requested lock mode */
236 int8_t lkb_grmode; /* granted lock mode */
237 int8_t lkb_bastmode; /* requested mode */
238 int8_t lkb_highbast; /* highest mode bast sent for */
239 int8_t lkb_wait_type; /* type of reply waiting for */
240 int8_t lkb_wait_count;
241 int8_t lkb_ast_type; /* type of ast queued for */
243 struct list_head lkb_idtbl_list; /* lockspace lkbtbl */
244 struct list_head lkb_statequeue; /* rsb g/c/w list */
245 struct list_head lkb_rsb_lookup; /* waiting for rsb lookup */
246 struct list_head lkb_wait_reply; /* waiting for remote reply */
247 struct list_head lkb_astqueue; /* need ast to be sent */
248 struct list_head lkb_ownqueue; /* list of locks for a process */
249 struct list_head lkb_time_list;
250 unsigned long lkb_timestamp;
251 unsigned long lkb_timeout_cs;
254 struct dlm_lksb *lkb_lksb; /* caller's status block */
255 void *lkb_astaddr; /* caller's ast function */
256 void *lkb_bastaddr; /* caller's bast function */
257 long lkb_astparam; /* caller's ast arg */
262 struct dlm_ls *res_ls; /* the lockspace */
264 struct mutex res_mutex;
265 unsigned long res_flags;
266 int res_length; /* length of rsb name */
270 uint32_t res_bucket; /* rsbtbl */
271 unsigned long res_toss_time;
272 uint32_t res_first_lkid;
273 struct list_head res_lookup; /* lkbs waiting on first */
274 struct list_head res_hashchain; /* rsbtbl */
275 struct list_head res_grantqueue;
276 struct list_head res_convertqueue;
277 struct list_head res_waitqueue;
279 struct list_head res_root_list; /* used for recovery */
280 struct list_head res_recover_list; /* used for recovery */
281 int res_recover_locks_count;
287 /* find_rsb() flags */
289 #define R_MASTER 1 /* only return rsb if it's a master */
290 #define R_CREATE 2 /* create/add rsb if not found */
295 RSB_MASTER_UNCERTAIN,
297 RSB_VALNOTVALID_PREV,
304 static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
306 __set_bit(flag, &r->res_flags);
309 static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
311 __clear_bit(flag, &r->res_flags);
314 static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
316 return test_bit(flag, &r->res_flags);
320 /* dlm_header is first element of all structs sent between nodes */
322 #define DLM_HEADER_MAJOR 0x00030000
323 #define DLM_HEADER_MINOR 0x00000000
330 uint32_t h_lockspace;
331 uint32_t h_nodeid; /* nodeid of sender */
333 uint8_t h_cmd; /* DLM_MSG, DLM_RCOM */
338 #define DLM_MSG_REQUEST 1
339 #define DLM_MSG_CONVERT 2
340 #define DLM_MSG_UNLOCK 3
341 #define DLM_MSG_CANCEL 4
342 #define DLM_MSG_REQUEST_REPLY 5
343 #define DLM_MSG_CONVERT_REPLY 6
344 #define DLM_MSG_UNLOCK_REPLY 7
345 #define DLM_MSG_CANCEL_REPLY 8
346 #define DLM_MSG_GRANT 9
347 #define DLM_MSG_BAST 10
348 #define DLM_MSG_LOOKUP 11
349 #define DLM_MSG_REMOVE 12
350 #define DLM_MSG_LOOKUP_REPLY 13
351 #define DLM_MSG_PURGE 14
354 struct dlm_header m_header;
355 uint32_t m_type; /* DLM_MSG_ */
358 uint32_t m_lkid; /* lkid on sender */
359 uint32_t m_remid; /* lkid on receiver */
360 uint32_t m_parent_lkid;
361 uint32_t m_parent_remid;
372 int m_result; /* 0 or -EXXX */
373 char m_extra[0]; /* name or lvb */
377 #define DLM_RS_NODES 0x00000001
378 #define DLM_RS_NODES_ALL 0x00000002
379 #define DLM_RS_DIR 0x00000004
380 #define DLM_RS_DIR_ALL 0x00000008
381 #define DLM_RS_LOCKS 0x00000010
382 #define DLM_RS_LOCKS_ALL 0x00000020
383 #define DLM_RS_DONE 0x00000040
384 #define DLM_RS_DONE_ALL 0x00000080
386 #define DLM_RCOM_STATUS 1
387 #define DLM_RCOM_NAMES 2
388 #define DLM_RCOM_LOOKUP 3
389 #define DLM_RCOM_LOCK 4
390 #define DLM_RCOM_STATUS_REPLY 5
391 #define DLM_RCOM_NAMES_REPLY 6
392 #define DLM_RCOM_LOOKUP_REPLY 7
393 #define DLM_RCOM_LOCK_REPLY 8
396 struct dlm_header rc_header;
397 uint32_t rc_type; /* DLM_RCOM_ */
398 int rc_result; /* multi-purpose */
399 uint64_t rc_id; /* match reply with request */
400 uint64_t rc_seq; /* sender's ls_recover_seq */
401 uint64_t rc_seq_reply; /* remote ls_recover_seq */
415 uint32_t rl_parent_lkid;
416 uint32_t rl_parent_remid;
425 uint16_t rl_wait_type;
427 char rl_name[DLM_RESNAME_MAXLEN];
432 struct list_head ls_list; /* list of lockspaces */
433 dlm_lockspace_t *ls_local_handle;
434 uint32_t ls_global_id; /* global unique lockspace ID */
437 int ls_count; /* reference count */
438 unsigned long ls_flags; /* LSFL_ */
439 struct kobject ls_kobj;
441 struct dlm_rsbtable *ls_rsbtbl;
442 uint32_t ls_rsbtbl_size;
444 struct dlm_lkbtable *ls_lkbtbl;
445 uint32_t ls_lkbtbl_size;
447 struct dlm_dirtable *ls_dirtbl;
448 uint32_t ls_dirtbl_size;
450 struct mutex ls_waiters_mutex;
451 struct list_head ls_waiters; /* lkbs needing a reply */
453 struct mutex ls_orphans_mutex;
454 struct list_head ls_orphans;
456 struct mutex ls_timeout_mutex;
457 struct list_head ls_timeout;
459 struct list_head ls_nodes; /* current nodes in ls */
460 struct list_head ls_nodes_gone; /* dead node list, recovery */
461 int ls_num_nodes; /* number of nodes in ls */
466 struct dlm_rsb ls_stub_rsb; /* for returning errors */
467 struct dlm_lkb ls_stub_lkb; /* for returning errors */
468 struct dlm_message ls_stub_ms; /* for faking a reply */
470 struct dentry *ls_debug_rsb_dentry; /* debugfs */
471 struct dentry *ls_debug_waiters_dentry; /* debugfs */
473 wait_queue_head_t ls_uevent_wait; /* user part of join/leave */
474 int ls_uevent_result;
476 struct miscdevice ls_device;
478 /* recovery related */
480 struct timer_list ls_timer;
481 struct task_struct *ls_recoverd_task;
482 struct mutex ls_recoverd_active;
483 spinlock_t ls_recover_lock;
484 unsigned long ls_recover_begin; /* jiffies timestamp */
485 uint32_t ls_recover_status; /* DLM_RS_ */
486 uint64_t ls_recover_seq;
487 struct dlm_recover *ls_recover_args;
488 struct rw_semaphore ls_in_recovery; /* block local requests */
489 struct list_head ls_requestqueue;/* queue remote requests */
490 struct mutex ls_requestqueue_mutex;
491 char *ls_recover_buf;
492 int ls_recover_nodeid; /* for debugging */
493 uint64_t ls_rcom_seq;
494 spinlock_t ls_rcom_spin;
495 struct list_head ls_recover_list;
496 spinlock_t ls_recover_list_lock;
497 int ls_recover_list_count;
498 wait_queue_head_t ls_wait_general;
499 struct mutex ls_clear_proc_locks;
501 struct list_head ls_root_list; /* root resources */
502 struct rw_semaphore ls_root_sem; /* protect root_list */
509 #define LSFL_RUNNING 1
510 #define LSFL_RECOVERY_STOP 2
511 #define LSFL_RCOM_READY 3
512 #define LSFL_RCOM_WAIT 4
513 #define LSFL_UEVENT_WAIT 5
514 #define LSFL_TIMEWARN 6
516 /* much of this is just saving user space pointers associated with the
517 lock that we pass back to the user lib with an ast */
519 struct dlm_user_args {
520 struct dlm_user_proc *proc; /* each process that opens the lockspace
521 device has private data
522 (dlm_user_proc) on the struct file,
523 the process's locks point back to it*/
524 struct dlm_lksb lksb;
527 struct dlm_lksb __user *user_lksb;
528 void __user *castparam;
529 void __user *castaddr;
530 void __user *bastparam;
531 void __user *bastaddr;
535 #define DLM_PROC_FLAGS_CLOSING 1
536 #define DLM_PROC_FLAGS_COMPAT 2
538 /* locks list is kept so we can remove all a process's locks when it
539 exits (or orphan those that are persistent) */
541 struct dlm_user_proc {
542 dlm_lockspace_t *lockspace;
543 unsigned long flags; /* DLM_PROC_FLAGS */
544 struct list_head asts;
545 spinlock_t asts_spin;
546 struct list_head locks;
547 spinlock_t locks_spin;
548 struct list_head unlocking;
549 wait_queue_head_t wait;
552 static inline int dlm_locking_stopped(struct dlm_ls *ls)
554 return !test_bit(LSFL_RUNNING, &ls->ls_flags);
557 static inline int dlm_recovery_stopped(struct dlm_ls *ls)
559 return test_bit(LSFL_RECOVERY_STOP, &ls->ls_flags);
562 static inline int dlm_no_directory(struct dlm_ls *ls)
564 return (ls->ls_exflags & DLM_LSFL_NODIR) ? 1 : 0;
567 #endif /* __DLM_INTERNAL_DOT_H__ */