dlm: keep lkbs in idr
[pandora-kernel.git] / fs / dlm / dlm_internal.h
1 /******************************************************************************
2 *******************************************************************************
3 **
4 **  Copyright (C) Sistina Software, Inc.  1997-2003  All rights reserved.
5 **  Copyright (C) 2004-2010 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 <linux/idr.h>
41 #include <asm/uaccess.h>
42
43 #include <linux/dlm.h>
44 #include "config.h"
45
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? */
49
50 #define DLM_INBUF_LEN           148
51
52 struct dlm_ls;
53 struct dlm_lkb;
54 struct dlm_rsb;
55 struct dlm_member;
56 struct dlm_rsbtable;
57 struct dlm_dirtable;
58 struct dlm_direntry;
59 struct dlm_recover;
60 struct dlm_header;
61 struct dlm_message;
62 struct dlm_rcom;
63 struct dlm_mhandle;
64
65 #define log_print(fmt, args...) \
66         printk(KERN_ERR "dlm: "fmt"\n" , ##args)
67 #define log_error(ls, fmt, args...) \
68         printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
69
70 #define log_debug(ls, fmt, args...) \
71 do { \
72         if (dlm_config.ci_log_debug) \
73                 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
74                        (ls)->ls_name , ##args); \
75 } while (0)
76
77 #define DLM_ASSERT(x, do) \
78 { \
79   if (!(x)) \
80   { \
81     printk(KERN_ERR "\nDLM:  Assertion failed on line %d of file %s\n" \
82                "DLM:  assertion:  \"%s\"\n" \
83                "DLM:  time = %lu\n", \
84                __LINE__, __FILE__, #x, jiffies); \
85     {do} \
86     printk("\n"); \
87     BUG(); \
88     panic("DLM:  Record message above and reboot.\n"); \
89   } \
90 }
91
92
93 struct dlm_direntry {
94         struct list_head        list;
95         uint32_t                master_nodeid;
96         uint16_t                length;
97         char                    name[1];
98 };
99
100 struct dlm_dirtable {
101         struct list_head        list;
102         spinlock_t              lock;
103 };
104
105 struct dlm_rsbtable {
106         struct list_head        list;
107         struct list_head        toss;
108         spinlock_t              lock;
109 };
110
111
112 /*
113  * Lockspace member (per node in a ls)
114  */
115
116 struct dlm_member {
117         struct list_head        list;
118         int                     nodeid;
119         int                     weight;
120 };
121
122 /*
123  * Save and manage recovery state for a lockspace.
124  */
125
126 struct dlm_recover {
127         struct list_head        list;
128         int                     *nodeids;   /* nodeids of all members */
129         int                     node_count;
130         int                     *new;       /* nodeids of new members */
131         int                     new_count;
132         uint64_t                seq;
133 };
134
135 /*
136  * Pass input args to second stage locking function.
137  */
138
139 struct dlm_args {
140         uint32_t                flags;
141         void                    (*astfn) (void *astparam);
142         void                    *astparam;
143         void                    (*bastfn) (void *astparam, int mode);
144         int                     mode;
145         struct dlm_lksb         *lksb;
146         unsigned long           timeout;
147 };
148
149
150 /*
151  * Lock block
152  *
153  * A lock can be one of three types:
154  *
155  * local copy      lock is mastered locally
156  *                 (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
157  * process copy    lock is mastered on a remote node
158  *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
159  * master copy     master node's copy of a lock owned by remote node
160  *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
161  *
162  * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
163  * dlm_unlock.  The dlm does not modify these or use any private flags in
164  * this field; it only contains DLM_LKF_ flags from dlm.h.  These flags
165  * are sent as-is to the remote master when the lock is remote.
166  *
167  * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
168  * Some internal flags are shared between the master and process nodes;
169  * these shared flags are kept in the lower two bytes.  One of these
170  * flags set on the master copy will be propagated to the process copy
171  * and v.v.  Other internal flags are private to the master or process
172  * node (e.g. DLM_IFL_MSTCPY).  These are kept in the high two bytes.
173  *
174  * lkb_sbflags: status block flags.  These flags are copied directly into
175  * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
176  * ast.  All defined in dlm.h with DLM_SBF_ prefix.
177  *
178  * lkb_status: the lock status indicates which rsb queue the lock is
179  * on, grant, convert, or wait.  DLM_LKSTS_ WAITING/GRANTED/CONVERT
180  *
181  * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
182  * reply is needed.  Only set when the lkb is on the lockspace waiters
183  * list awaiting a reply from a remote node.
184  *
185  * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
186  * is a master copy, nodeid specifies the remote lock holder, when the
187  * lkb is a process copy, the nodeid specifies the lock master.
188  */
189
190 /* lkb_status */
191
192 #define DLM_LKSTS_WAITING       1
193 #define DLM_LKSTS_GRANTED       2
194 #define DLM_LKSTS_CONVERT       3
195
196 /* lkb_flags */
197
198 #define DLM_IFL_MSTCPY          0x00010000
199 #define DLM_IFL_RESEND          0x00020000
200 #define DLM_IFL_DEAD            0x00040000
201 #define DLM_IFL_OVERLAP_UNLOCK  0x00080000
202 #define DLM_IFL_OVERLAP_CANCEL  0x00100000
203 #define DLM_IFL_ENDOFLIFE       0x00200000
204 #define DLM_IFL_WATCH_TIMEWARN  0x00400000
205 #define DLM_IFL_TIMEOUT_CANCEL  0x00800000
206 #define DLM_IFL_DEADLOCK_CANCEL 0x01000000
207 #define DLM_IFL_STUB_MS         0x02000000 /* magic number for m_flags */
208 #define DLM_IFL_USER            0x00000001
209 #define DLM_IFL_ORPHAN          0x00000002
210
211 #define DLM_CALLBACKS_SIZE      6
212
213 #define DLM_CB_CAST             0x00000001
214 #define DLM_CB_BAST             0x00000002
215 #define DLM_CB_SKIP             0x00000004
216
217 struct dlm_callback {
218         uint64_t                seq;
219         uint32_t                flags;          /* DLM_CBF_ */
220         int                     sb_status;      /* copy to lksb status */
221         uint8_t                 sb_flags;       /* copy to lksb flags */
222         int8_t                  mode; /* rq mode of bast, gr mode of cast */
223 };
224
225 struct dlm_lkb {
226         struct dlm_rsb          *lkb_resource;  /* the rsb */
227         struct kref             lkb_ref;
228         int                     lkb_nodeid;     /* copied from rsb */
229         int                     lkb_ownpid;     /* pid of lock owner */
230         uint32_t                lkb_id;         /* our lock ID */
231         uint32_t                lkb_remid;      /* lock ID on remote partner */
232         uint32_t                lkb_exflags;    /* external flags from caller */
233         uint32_t                lkb_sbflags;    /* lksb flags */
234         uint32_t                lkb_flags;      /* internal flags */
235         uint32_t                lkb_lvbseq;     /* lvb sequence number */
236
237         int8_t                  lkb_status;     /* granted, waiting, convert */
238         int8_t                  lkb_rqmode;     /* requested lock mode */
239         int8_t                  lkb_grmode;     /* granted lock mode */
240         int8_t                  lkb_highbast;   /* highest mode bast sent for */
241
242         int8_t                  lkb_wait_type;  /* type of reply waiting for */
243         int8_t                  lkb_wait_count;
244         int                     lkb_wait_nodeid; /* for debugging */
245
246         struct list_head        lkb_statequeue; /* rsb g/c/w list */
247         struct list_head        lkb_rsb_lookup; /* waiting for rsb lookup */
248         struct list_head        lkb_wait_reply; /* waiting for remote reply */
249         struct list_head        lkb_astqueue;   /* need ast to be sent */
250         struct list_head        lkb_ownqueue;   /* list of locks for a process */
251         struct list_head        lkb_time_list;
252         ktime_t                 lkb_timestamp;
253         ktime_t                 lkb_wait_time;
254         unsigned long           lkb_timeout_cs;
255
256         struct dlm_callback     lkb_callbacks[DLM_CALLBACKS_SIZE];
257         struct dlm_callback     lkb_last_cast;
258         struct dlm_callback     lkb_last_bast;
259         ktime_t                 lkb_last_cast_time;     /* for debugging */
260         ktime_t                 lkb_last_bast_time;     /* for debugging */
261
262         char                    *lkb_lvbptr;
263         struct dlm_lksb         *lkb_lksb;      /* caller's status block */
264         void                    (*lkb_astfn) (void *astparam);
265         void                    (*lkb_bastfn) (void *astparam, int mode);
266         union {
267                 void                    *lkb_astparam;  /* caller's ast arg */
268                 struct dlm_user_args    *lkb_ua;
269         };
270 };
271
272
273 struct dlm_rsb {
274         struct dlm_ls           *res_ls;        /* the lockspace */
275         struct kref             res_ref;
276         struct mutex            res_mutex;
277         unsigned long           res_flags;
278         int                     res_length;     /* length of rsb name */
279         int                     res_nodeid;
280         uint32_t                res_lvbseq;
281         uint32_t                res_hash;
282         uint32_t                res_bucket;     /* rsbtbl */
283         unsigned long           res_toss_time;
284         uint32_t                res_first_lkid;
285         struct list_head        res_lookup;     /* lkbs waiting on first */
286         struct list_head        res_hashchain;  /* rsbtbl */
287         struct list_head        res_grantqueue;
288         struct list_head        res_convertqueue;
289         struct list_head        res_waitqueue;
290
291         struct list_head        res_root_list;      /* used for recovery */
292         struct list_head        res_recover_list;   /* used for recovery */
293         int                     res_recover_locks_count;
294
295         char                    *res_lvbptr;
296         char                    res_name[1];
297 };
298
299 /* find_rsb() flags */
300
301 #define R_MASTER                1       /* only return rsb if it's a master */
302 #define R_CREATE                2       /* create/add rsb if not found */
303
304 /* rsb_flags */
305
306 enum rsb_flags {
307         RSB_MASTER_UNCERTAIN,
308         RSB_VALNOTVALID,
309         RSB_VALNOTVALID_PREV,
310         RSB_NEW_MASTER,
311         RSB_NEW_MASTER2,
312         RSB_RECOVER_CONVERT,
313         RSB_LOCKS_PURGED,
314 };
315
316 static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
317 {
318         __set_bit(flag, &r->res_flags);
319 }
320
321 static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
322 {
323         __clear_bit(flag, &r->res_flags);
324 }
325
326 static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
327 {
328         return test_bit(flag, &r->res_flags);
329 }
330
331
332 /* dlm_header is first element of all structs sent between nodes */
333
334 #define DLM_HEADER_MAJOR        0x00030000
335 #define DLM_HEADER_MINOR        0x00000000
336
337 #define DLM_MSG                 1
338 #define DLM_RCOM                2
339
340 struct dlm_header {
341         uint32_t                h_version;
342         uint32_t                h_lockspace;
343         uint32_t                h_nodeid;       /* nodeid of sender */
344         uint16_t                h_length;
345         uint8_t                 h_cmd;          /* DLM_MSG, DLM_RCOM */
346         uint8_t                 h_pad;
347 };
348
349
350 #define DLM_MSG_REQUEST         1
351 #define DLM_MSG_CONVERT         2
352 #define DLM_MSG_UNLOCK          3
353 #define DLM_MSG_CANCEL          4
354 #define DLM_MSG_REQUEST_REPLY   5
355 #define DLM_MSG_CONVERT_REPLY   6
356 #define DLM_MSG_UNLOCK_REPLY    7
357 #define DLM_MSG_CANCEL_REPLY    8
358 #define DLM_MSG_GRANT           9
359 #define DLM_MSG_BAST            10
360 #define DLM_MSG_LOOKUP          11
361 #define DLM_MSG_REMOVE          12
362 #define DLM_MSG_LOOKUP_REPLY    13
363 #define DLM_MSG_PURGE           14
364
365 struct dlm_message {
366         struct dlm_header       m_header;
367         uint32_t                m_type;         /* DLM_MSG_ */
368         uint32_t                m_nodeid;
369         uint32_t                m_pid;
370         uint32_t                m_lkid;         /* lkid on sender */
371         uint32_t                m_remid;        /* lkid on receiver */
372         uint32_t                m_parent_lkid;
373         uint32_t                m_parent_remid;
374         uint32_t                m_exflags;
375         uint32_t                m_sbflags;
376         uint32_t                m_flags;
377         uint32_t                m_lvbseq;
378         uint32_t                m_hash;
379         int                     m_status;
380         int                     m_grmode;
381         int                     m_rqmode;
382         int                     m_bastmode;
383         int                     m_asts;
384         int                     m_result;       /* 0 or -EXXX */
385         char                    m_extra[0];     /* name or lvb */
386 };
387
388
389 #define DLM_RS_NODES            0x00000001
390 #define DLM_RS_NODES_ALL        0x00000002
391 #define DLM_RS_DIR              0x00000004
392 #define DLM_RS_DIR_ALL          0x00000008
393 #define DLM_RS_LOCKS            0x00000010
394 #define DLM_RS_LOCKS_ALL        0x00000020
395 #define DLM_RS_DONE             0x00000040
396 #define DLM_RS_DONE_ALL         0x00000080
397
398 #define DLM_RCOM_STATUS         1
399 #define DLM_RCOM_NAMES          2
400 #define DLM_RCOM_LOOKUP         3
401 #define DLM_RCOM_LOCK           4
402 #define DLM_RCOM_STATUS_REPLY   5
403 #define DLM_RCOM_NAMES_REPLY    6
404 #define DLM_RCOM_LOOKUP_REPLY   7
405 #define DLM_RCOM_LOCK_REPLY     8
406
407 struct dlm_rcom {
408         struct dlm_header       rc_header;
409         uint32_t                rc_type;        /* DLM_RCOM_ */
410         int                     rc_result;      /* multi-purpose */
411         uint64_t                rc_id;          /* match reply with request */
412         uint64_t                rc_seq;         /* sender's ls_recover_seq */
413         uint64_t                rc_seq_reply;   /* remote ls_recover_seq */
414         char                    rc_buf[0];
415 };
416
417 union dlm_packet {
418         struct dlm_header       header;         /* common to other two */
419         struct dlm_message      message;
420         struct dlm_rcom         rcom;
421 };
422
423 struct rcom_config {
424         __le32                  rf_lvblen;
425         __le32                  rf_lsflags;
426         __le64                  rf_unused;
427 };
428
429 struct rcom_lock {
430         __le32                  rl_ownpid;
431         __le32                  rl_lkid;
432         __le32                  rl_remid;
433         __le32                  rl_parent_lkid;
434         __le32                  rl_parent_remid;
435         __le32                  rl_exflags;
436         __le32                  rl_flags;
437         __le32                  rl_lvbseq;
438         __le32                  rl_result;
439         int8_t                  rl_rqmode;
440         int8_t                  rl_grmode;
441         int8_t                  rl_status;
442         int8_t                  rl_asts;
443         __le16                  rl_wait_type;
444         __le16                  rl_namelen;
445         char                    rl_name[DLM_RESNAME_MAXLEN];
446         char                    rl_lvb[0];
447 };
448
449 struct dlm_ls {
450         struct list_head        ls_list;        /* list of lockspaces */
451         dlm_lockspace_t         *ls_local_handle;
452         uint32_t                ls_global_id;   /* global unique lockspace ID */
453         uint32_t                ls_exflags;
454         int                     ls_lvblen;
455         int                     ls_count;       /* refcount of processes in
456                                                    the dlm using this ls */
457         int                     ls_create_count; /* create/release refcount */
458         unsigned long           ls_flags;       /* LSFL_ */
459         unsigned long           ls_scan_time;
460         struct kobject          ls_kobj;
461
462         struct idr              ls_lkbidr;
463         spinlock_t              ls_lkbidr_spin;
464
465         struct dlm_rsbtable     *ls_rsbtbl;
466         uint32_t                ls_rsbtbl_size;
467
468         struct dlm_dirtable     *ls_dirtbl;
469         uint32_t                ls_dirtbl_size;
470
471         struct mutex            ls_waiters_mutex;
472         struct list_head        ls_waiters;     /* lkbs needing a reply */
473
474         struct mutex            ls_orphans_mutex;
475         struct list_head        ls_orphans;
476
477         struct mutex            ls_timeout_mutex;
478         struct list_head        ls_timeout;
479
480         struct list_head        ls_nodes;       /* current nodes in ls */
481         struct list_head        ls_nodes_gone;  /* dead node list, recovery */
482         int                     ls_num_nodes;   /* number of nodes in ls */
483         int                     ls_low_nodeid;
484         int                     ls_total_weight;
485         int                     *ls_node_array;
486
487         struct dlm_rsb          ls_stub_rsb;    /* for returning errors */
488         struct dlm_lkb          ls_stub_lkb;    /* for returning errors */
489         struct dlm_message      ls_stub_ms;     /* for faking a reply */
490
491         struct dentry           *ls_debug_rsb_dentry; /* debugfs */
492         struct dentry           *ls_debug_waiters_dentry; /* debugfs */
493         struct dentry           *ls_debug_locks_dentry; /* debugfs */
494         struct dentry           *ls_debug_all_dentry; /* debugfs */
495
496         wait_queue_head_t       ls_uevent_wait; /* user part of join/leave */
497         int                     ls_uevent_result;
498         struct completion       ls_members_done;
499         int                     ls_members_result;
500
501         struct miscdevice       ls_device;
502
503         /* recovery related */
504
505         struct timer_list       ls_timer;
506         struct task_struct      *ls_recoverd_task;
507         struct mutex            ls_recoverd_active;
508         spinlock_t              ls_recover_lock;
509         unsigned long           ls_recover_begin; /* jiffies timestamp */
510         uint32_t                ls_recover_status; /* DLM_RS_ */
511         uint64_t                ls_recover_seq;
512         struct dlm_recover      *ls_recover_args;
513         struct rw_semaphore     ls_in_recovery; /* block local requests */
514         struct rw_semaphore     ls_recv_active; /* block dlm_recv */
515         struct list_head        ls_requestqueue;/* queue remote requests */
516         struct mutex            ls_requestqueue_mutex;
517         struct dlm_rcom         *ls_recover_buf;
518         int                     ls_recover_nodeid; /* for debugging */
519         uint64_t                ls_rcom_seq;
520         spinlock_t              ls_rcom_spin;
521         struct list_head        ls_recover_list;
522         spinlock_t              ls_recover_list_lock;
523         int                     ls_recover_list_count;
524         wait_queue_head_t       ls_wait_general;
525         struct mutex            ls_clear_proc_locks;
526
527         struct list_head        ls_root_list;   /* root resources */
528         struct rw_semaphore     ls_root_sem;    /* protect root_list */
529
530         int                     ls_namelen;
531         char                    ls_name[1];
532 };
533
534 #define LSFL_WORK               0
535 #define LSFL_RUNNING            1
536 #define LSFL_RECOVERY_STOP      2
537 #define LSFL_RCOM_READY         3
538 #define LSFL_RCOM_WAIT          4
539 #define LSFL_UEVENT_WAIT        5
540 #define LSFL_TIMEWARN           6
541
542 /* much of this is just saving user space pointers associated with the
543    lock that we pass back to the user lib with an ast */
544
545 struct dlm_user_args {
546         struct dlm_user_proc    *proc; /* each process that opens the lockspace
547                                           device has private data
548                                           (dlm_user_proc) on the struct file,
549                                           the process's locks point back to it*/
550         struct dlm_lksb         lksb;
551         struct dlm_lksb __user  *user_lksb;
552         void __user             *castparam;
553         void __user             *castaddr;
554         void __user             *bastparam;
555         void __user             *bastaddr;
556         uint64_t                xid;
557 };
558
559 #define DLM_PROC_FLAGS_CLOSING 1
560 #define DLM_PROC_FLAGS_COMPAT  2
561
562 /* locks list is kept so we can remove all a process's locks when it
563    exits (or orphan those that are persistent) */
564
565 struct dlm_user_proc {
566         dlm_lockspace_t         *lockspace;
567         unsigned long           flags; /* DLM_PROC_FLAGS */
568         struct list_head        asts;
569         spinlock_t              asts_spin;
570         struct list_head        locks;
571         spinlock_t              locks_spin;
572         struct list_head        unlocking;
573         wait_queue_head_t       wait;
574 };
575
576 static inline int dlm_locking_stopped(struct dlm_ls *ls)
577 {
578         return !test_bit(LSFL_RUNNING, &ls->ls_flags);
579 }
580
581 static inline int dlm_recovery_stopped(struct dlm_ls *ls)
582 {
583         return test_bit(LSFL_RECOVERY_STOP, &ls->ls_flags);
584 }
585
586 static inline int dlm_no_directory(struct dlm_ls *ls)
587 {
588         return (ls->ls_exflags & DLM_LSFL_NODIR) ? 1 : 0;
589 }
590
591 int dlm_netlink_init(void);
592 void dlm_netlink_exit(void);
593 void dlm_timeout_warn(struct dlm_lkb *lkb);
594 int dlm_plock_init(void);
595 void dlm_plock_exit(void);
596
597 #ifdef CONFIG_DLM_DEBUG
598 int dlm_register_debugfs(void);
599 void dlm_unregister_debugfs(void);
600 int dlm_create_debug_file(struct dlm_ls *ls);
601 void dlm_delete_debug_file(struct dlm_ls *ls);
602 #else
603 static inline int dlm_register_debugfs(void) { return 0; }
604 static inline void dlm_unregister_debugfs(void) { }
605 static inline int dlm_create_debug_file(struct dlm_ls *ls) { return 0; }
606 static inline void dlm_delete_debug_file(struct dlm_ls *ls) { }
607 #endif
608
609 #endif                          /* __DLM_INTERNAL_DOT_H__ */
610