30994d68f6a078d7e87e0a46429093b11fc4f631
[linux-2.6.git] / fs / dlm / dlm_internal.h
1 /******************************************************************************
2 *******************************************************************************
3 **
4 **  Copyright (C) Sistina Software, Inc.  1997-2003  All rights reserved.
5 **  Copyright (C) 2004-2007 Red Hat, Inc.  All rights reserved.
6 **
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.
10 **
11 *******************************************************************************
12 ******************************************************************************/
13
14 #ifndef __DLM_INTERNAL_DOT_H__
15 #define __DLM_INTERNAL_DOT_H__
16
17 /*
18  * This is the main header file to be included in each DLM source file.
19  */
20
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>
42
43 #include <linux/dlm.h>
44 #include "config.h"
45
46 #define DLM_LOCKSPACE_LEN       64
47
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? */
51
52 #define DLM_INBUF_LEN           148
53
54 struct dlm_ls;
55 struct dlm_lkb;
56 struct dlm_rsb;
57 struct dlm_member;
58 struct dlm_lkbtable;
59 struct dlm_rsbtable;
60 struct dlm_dirtable;
61 struct dlm_direntry;
62 struct dlm_recover;
63 struct dlm_header;
64 struct dlm_message;
65 struct dlm_rcom;
66 struct dlm_mhandle;
67
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)
72
73 #define log_debug(ls, fmt, args...) \
74 do { \
75         if (dlm_config.ci_log_debug) \
76                 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
77                        (ls)->ls_name , ##args); \
78 } while (0)
79
80 #define DLM_ASSERT(x, do) \
81 { \
82   if (!(x)) \
83   { \
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); \
88     {do} \
89     printk("\n"); \
90     BUG(); \
91     panic("DLM:  Record message above and reboot.\n"); \
92   } \
93 }
94
95 #define DLM_FAKE_USER_AST ERR_PTR(-EINVAL)
96
97
98 struct dlm_direntry {
99         struct list_head        list;
100         uint32_t                master_nodeid;
101         uint16_t                length;
102         char                    name[1];
103 };
104
105 struct dlm_dirtable {
106         struct list_head        list;
107         rwlock_t                lock;
108 };
109
110 struct dlm_rsbtable {
111         struct list_head        list;
112         struct list_head        toss;
113         rwlock_t                lock;
114 };
115
116 struct dlm_lkbtable {
117         struct list_head        list;
118         rwlock_t                lock;
119         uint16_t                counter;
120 };
121
122 /*
123  * Lockspace member (per node in a ls)
124  */
125
126 struct dlm_member {
127         struct list_head        list;
128         int                     nodeid;
129         int                     weight;
130 };
131
132 /*
133  * Save and manage recovery state for a lockspace.
134  */
135
136 struct dlm_recover {
137         struct list_head        list;
138         int                     *nodeids;
139         int                     node_count;
140         uint64_t                seq;
141 };
142
143 /*
144  * Pass input args to second stage locking function.
145  */
146
147 struct dlm_args {
148         uint32_t                flags;
149         void                    *astaddr;
150         long                    astparam;
151         void                    *bastaddr;
152         int                     mode;
153         struct dlm_lksb         *lksb;
154 };
155
156
157 /*
158  * Lock block
159  *
160  * A lock can be one of three types:
161  *
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)
168  *
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.
173  *
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.
180  *
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.
184  *
185  * lkb_status: the lock status indicates which rsb queue the lock is
186  * on, grant, convert, or wait.  DLM_LKSTS_ WAITING/GRANTED/CONVERT
187  *
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.
191  *
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.
195  */
196
197 /* lkb_ast_type */
198
199 #define AST_COMP                1
200 #define AST_BAST                2
201
202 /* lkb_status */
203
204 #define DLM_LKSTS_WAITING       1
205 #define DLM_LKSTS_GRANTED       2
206 #define DLM_LKSTS_CONVERT       3
207
208 /* lkb_flags */
209
210 #define DLM_IFL_MSTCPY          0x00010000
211 #define DLM_IFL_RESEND          0x00020000
212 #define DLM_IFL_DEAD            0x00040000
213 #define DLM_IFL_OVERLAP_UNLOCK  0x00080000
214 #define DLM_IFL_OVERLAP_CANCEL  0x00100000
215 #define DLM_IFL_ENDOFLIFE       0x00200000
216 #define DLM_IFL_USER            0x00000001
217 #define DLM_IFL_ORPHAN          0x00000002
218
219 struct dlm_lkb {
220         struct dlm_rsb          *lkb_resource;  /* the rsb */
221         struct kref             lkb_ref;
222         int                     lkb_nodeid;     /* copied from rsb */
223         int                     lkb_ownpid;     /* pid of lock owner */
224         uint32_t                lkb_id;         /* our lock ID */
225         uint32_t                lkb_remid;      /* lock ID on remote partner */
226         uint32_t                lkb_exflags;    /* external flags from caller */
227         uint32_t                lkb_sbflags;    /* lksb flags */
228         uint32_t                lkb_flags;      /* internal flags */
229         uint32_t                lkb_lvbseq;     /* lvb sequence number */
230
231         int8_t                  lkb_status;     /* granted, waiting, convert */
232         int8_t                  lkb_rqmode;     /* requested lock mode */
233         int8_t                  lkb_grmode;     /* granted lock mode */
234         int8_t                  lkb_bastmode;   /* requested mode */
235         int8_t                  lkb_highbast;   /* highest mode bast sent for */
236         int8_t                  lkb_wait_type;  /* type of reply waiting for */
237         int8_t                  lkb_wait_count;
238         int8_t                  lkb_ast_type;   /* type of ast queued for */
239
240         struct list_head        lkb_idtbl_list; /* lockspace lkbtbl */
241         struct list_head        lkb_statequeue; /* rsb g/c/w list */
242         struct list_head        lkb_rsb_lookup; /* waiting for rsb lookup */
243         struct list_head        lkb_wait_reply; /* waiting for remote reply */
244         struct list_head        lkb_astqueue;   /* need ast to be sent */
245         struct list_head        lkb_ownqueue;   /* list of locks for a process */
246
247         char                    *lkb_lvbptr;
248         struct dlm_lksb         *lkb_lksb;      /* caller's status block */
249         void                    *lkb_astaddr;   /* caller's ast function */
250         void                    *lkb_bastaddr;  /* caller's bast function */
251         long                    lkb_astparam;   /* caller's ast arg */
252 };
253
254
255 struct dlm_rsb {
256         struct dlm_ls           *res_ls;        /* the lockspace */
257         struct kref             res_ref;
258         struct mutex            res_mutex;
259         unsigned long           res_flags;
260         int                     res_length;     /* length of rsb name */
261         int                     res_nodeid;
262         uint32_t                res_lvbseq;
263         uint32_t                res_hash;
264         uint32_t                res_bucket;     /* rsbtbl */
265         unsigned long           res_toss_time;
266         uint32_t                res_first_lkid;
267         struct list_head        res_lookup;     /* lkbs waiting on first */
268         struct list_head        res_hashchain;  /* rsbtbl */
269         struct list_head        res_grantqueue;
270         struct list_head        res_convertqueue;
271         struct list_head        res_waitqueue;
272
273         struct list_head        res_root_list;      /* used for recovery */
274         struct list_head        res_recover_list;   /* used for recovery */
275         int                     res_recover_locks_count;
276
277         char                    *res_lvbptr;
278         char                    res_name[1];
279 };
280
281 /* find_rsb() flags */
282
283 #define R_MASTER                1       /* only return rsb if it's a master */
284 #define R_CREATE                2       /* create/add rsb if not found */
285
286 /* rsb_flags */
287
288 enum rsb_flags {
289         RSB_MASTER_UNCERTAIN,
290         RSB_VALNOTVALID,
291         RSB_VALNOTVALID_PREV,
292         RSB_NEW_MASTER,
293         RSB_NEW_MASTER2,
294         RSB_RECOVER_CONVERT,
295         RSB_LOCKS_PURGED,
296 };
297
298 static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
299 {
300         __set_bit(flag, &r->res_flags);
301 }
302
303 static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
304 {
305         __clear_bit(flag, &r->res_flags);
306 }
307
308 static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
309 {
310         return test_bit(flag, &r->res_flags);
311 }
312
313
314 /* dlm_header is first element of all structs sent between nodes */
315
316 #define DLM_HEADER_MAJOR        0x00030000
317 #define DLM_HEADER_MINOR        0x00000000
318
319 #define DLM_MSG                 1
320 #define DLM_RCOM                2
321
322 struct dlm_header {
323         uint32_t                h_version;
324         uint32_t                h_lockspace;
325         uint32_t                h_nodeid;       /* nodeid of sender */
326         uint16_t                h_length;
327         uint8_t                 h_cmd;          /* DLM_MSG, DLM_RCOM */
328         uint8_t                 h_pad;
329 };
330
331
332 #define DLM_MSG_REQUEST         1
333 #define DLM_MSG_CONVERT         2
334 #define DLM_MSG_UNLOCK          3
335 #define DLM_MSG_CANCEL          4
336 #define DLM_MSG_REQUEST_REPLY   5
337 #define DLM_MSG_CONVERT_REPLY   6
338 #define DLM_MSG_UNLOCK_REPLY    7
339 #define DLM_MSG_CANCEL_REPLY    8
340 #define DLM_MSG_GRANT           9
341 #define DLM_MSG_BAST            10
342 #define DLM_MSG_LOOKUP          11
343 #define DLM_MSG_REMOVE          12
344 #define DLM_MSG_LOOKUP_REPLY    13
345 #define DLM_MSG_PURGE           14
346
347 struct dlm_message {
348         struct dlm_header       m_header;
349         uint32_t                m_type;         /* DLM_MSG_ */
350         uint32_t                m_nodeid;
351         uint32_t                m_pid;
352         uint32_t                m_lkid;         /* lkid on sender */
353         uint32_t                m_remid;        /* lkid on receiver */
354         uint32_t                m_parent_lkid;
355         uint32_t                m_parent_remid;
356         uint32_t                m_exflags;
357         uint32_t                m_sbflags;
358         uint32_t                m_flags;
359         uint32_t                m_lvbseq;
360         uint32_t                m_hash;
361         int                     m_status;
362         int                     m_grmode;
363         int                     m_rqmode;
364         int                     m_bastmode;
365         int                     m_asts;
366         int                     m_result;       /* 0 or -EXXX */
367         char                    m_extra[0];     /* name or lvb */
368 };
369
370
371 #define DLM_RS_NODES            0x00000001
372 #define DLM_RS_NODES_ALL        0x00000002
373 #define DLM_RS_DIR              0x00000004
374 #define DLM_RS_DIR_ALL          0x00000008
375 #define DLM_RS_LOCKS            0x00000010
376 #define DLM_RS_LOCKS_ALL        0x00000020
377 #define DLM_RS_DONE             0x00000040
378 #define DLM_RS_DONE_ALL         0x00000080
379
380 #define DLM_RCOM_STATUS         1
381 #define DLM_RCOM_NAMES          2
382 #define DLM_RCOM_LOOKUP         3
383 #define DLM_RCOM_LOCK           4
384 #define DLM_RCOM_STATUS_REPLY   5
385 #define DLM_RCOM_NAMES_REPLY    6
386 #define DLM_RCOM_LOOKUP_REPLY   7
387 #define DLM_RCOM_LOCK_REPLY     8
388
389 struct dlm_rcom {
390         struct dlm_header       rc_header;
391         uint32_t                rc_type;        /* DLM_RCOM_ */
392         int                     rc_result;      /* multi-purpose */
393         uint64_t                rc_id;          /* match reply with request */
394         uint64_t                rc_seq;         /* sender's ls_recover_seq */
395         uint64_t                rc_seq_reply;   /* remote ls_recover_seq */
396         char                    rc_buf[0];
397 };
398
399 struct rcom_config {
400         uint32_t                rf_lvblen;
401         uint32_t                rf_lsflags;
402         uint64_t                rf_unused;
403 };
404
405 struct rcom_lock {
406         uint32_t                rl_ownpid;
407         uint32_t                rl_lkid;
408         uint32_t                rl_remid;
409         uint32_t                rl_parent_lkid;
410         uint32_t                rl_parent_remid;
411         uint32_t                rl_exflags;
412         uint32_t                rl_flags;
413         uint32_t                rl_lvbseq;
414         int                     rl_result;
415         int8_t                  rl_rqmode;
416         int8_t                  rl_grmode;
417         int8_t                  rl_status;
418         int8_t                  rl_asts;
419         uint16_t                rl_wait_type;
420         uint16_t                rl_namelen;
421         char                    rl_name[DLM_RESNAME_MAXLEN];
422         char                    rl_lvb[0];
423 };
424
425 struct dlm_ls {
426         struct list_head        ls_list;        /* list of lockspaces */
427         dlm_lockspace_t         *ls_local_handle;
428         uint32_t                ls_global_id;   /* global unique lockspace ID */
429         uint32_t                ls_exflags;
430         int                     ls_lvblen;
431         int                     ls_count;       /* reference count */
432         unsigned long           ls_flags;       /* LSFL_ */
433         struct kobject          ls_kobj;
434
435         struct dlm_rsbtable     *ls_rsbtbl;
436         uint32_t                ls_rsbtbl_size;
437
438         struct dlm_lkbtable     *ls_lkbtbl;
439         uint32_t                ls_lkbtbl_size;
440
441         struct dlm_dirtable     *ls_dirtbl;
442         uint32_t                ls_dirtbl_size;
443
444         struct mutex            ls_waiters_mutex;
445         struct list_head        ls_waiters;     /* lkbs needing a reply */
446
447         struct mutex            ls_orphans_mutex;
448         struct list_head        ls_orphans;
449
450         struct list_head        ls_nodes;       /* current nodes in ls */
451         struct list_head        ls_nodes_gone;  /* dead node list, recovery */
452         int                     ls_num_nodes;   /* number of nodes in ls */
453         int                     ls_low_nodeid;
454         int                     ls_total_weight;
455         int                     *ls_node_array;
456
457         struct dlm_rsb          ls_stub_rsb;    /* for returning errors */
458         struct dlm_lkb          ls_stub_lkb;    /* for returning errors */
459         struct dlm_message      ls_stub_ms;     /* for faking a reply */
460
461         struct dentry           *ls_debug_rsb_dentry; /* debugfs */
462         struct dentry           *ls_debug_waiters_dentry; /* debugfs */
463
464         wait_queue_head_t       ls_uevent_wait; /* user part of join/leave */
465         int                     ls_uevent_result;
466
467         struct miscdevice       ls_device;
468
469         /* recovery related */
470
471         struct timer_list       ls_timer;
472         struct task_struct      *ls_recoverd_task;
473         struct mutex            ls_recoverd_active;
474         spinlock_t              ls_recover_lock;
475         uint32_t                ls_recover_status; /* DLM_RS_ */
476         uint64_t                ls_recover_seq;
477         struct dlm_recover      *ls_recover_args;
478         struct rw_semaphore     ls_in_recovery; /* block local requests */
479         struct list_head        ls_requestqueue;/* queue remote requests */
480         struct mutex            ls_requestqueue_mutex;
481         char                    *ls_recover_buf;
482         int                     ls_recover_nodeid; /* for debugging */
483         uint64_t                ls_rcom_seq;
484         spinlock_t              ls_rcom_spin;
485         struct list_head        ls_recover_list;
486         spinlock_t              ls_recover_list_lock;
487         int                     ls_recover_list_count;
488         wait_queue_head_t       ls_wait_general;
489         struct mutex            ls_clear_proc_locks;
490
491         struct list_head        ls_root_list;   /* root resources */
492         struct rw_semaphore     ls_root_sem;    /* protect root_list */
493
494         int                     ls_namelen;
495         char                    ls_name[1];
496 };
497
498 #define LSFL_WORK               0
499 #define LSFL_RUNNING            1
500 #define LSFL_RECOVERY_STOP      2
501 #define LSFL_RCOM_READY         3
502 #define LSFL_RCOM_WAIT          4
503 #define LSFL_UEVENT_WAIT        5
504
505 /* much of this is just saving user space pointers associated with the
506    lock that we pass back to the user lib with an ast */
507
508 struct dlm_user_args {
509         struct dlm_user_proc    *proc; /* each process that opens the lockspace
510                                           device has private data
511                                           (dlm_user_proc) on the struct file,
512                                           the process's locks point back to it*/
513         struct dlm_lksb         lksb;
514         int                     old_mode;
515         int                     update_user_lvb;
516         struct dlm_lksb __user  *user_lksb;
517         void __user             *castparam;
518         void __user             *castaddr;
519         void __user             *bastparam;
520         void __user             *bastaddr;
521 };
522
523 #define DLM_PROC_FLAGS_CLOSING 1
524 #define DLM_PROC_FLAGS_COMPAT  2
525
526 /* locks list is kept so we can remove all a process's locks when it
527    exits (or orphan those that are persistent) */
528
529 struct dlm_user_proc {
530         dlm_lockspace_t         *lockspace;
531         unsigned long           flags; /* DLM_PROC_FLAGS */
532         struct list_head        asts;
533         spinlock_t              asts_spin;
534         struct list_head        locks;
535         spinlock_t              locks_spin;
536         struct list_head        unlocking;
537         wait_queue_head_t       wait;
538 };
539
540 static inline int dlm_locking_stopped(struct dlm_ls *ls)
541 {
542         return !test_bit(LSFL_RUNNING, &ls->ls_flags);
543 }
544
545 static inline int dlm_recovery_stopped(struct dlm_ls *ls)
546 {
547         return test_bit(LSFL_RECOVERY_STOP, &ls->ls_flags);
548 }
549
550 static inline int dlm_no_directory(struct dlm_ls *ls)
551 {
552         return (ls->ls_exflags & DLM_LSFL_NODIR) ? 1 : 0;
553 }
554
555 #endif                          /* __DLM_INTERNAL_DOT_H__ */
556