5685a9a5dba21b21ca9e7b4b5302b7a88cc0737a
[platform/kernel/linux-rpi.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 rb_root          keep;
107         struct rb_root          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_ownqueue;   /* list of locks for a process */
250         struct list_head        lkb_time_list;
251         ktime_t                 lkb_timestamp;
252         ktime_t                 lkb_wait_time;
253         unsigned long           lkb_timeout_cs;
254
255         struct mutex            lkb_cb_mutex;
256         struct work_struct      lkb_cb_work;
257         struct list_head        lkb_cb_list; /* for ls_cb_delay or proc->asts */
258         struct dlm_callback     lkb_callbacks[DLM_CALLBACKS_SIZE];
259         struct dlm_callback     lkb_last_cast;
260         struct dlm_callback     lkb_last_bast;
261         ktime_t                 lkb_last_cast_time;     /* for debugging */
262         ktime_t                 lkb_last_bast_time;     /* for debugging */
263
264         char                    *lkb_lvbptr;
265         struct dlm_lksb         *lkb_lksb;      /* caller's status block */
266         void                    (*lkb_astfn) (void *astparam);
267         void                    (*lkb_bastfn) (void *astparam, int mode);
268         union {
269                 void                    *lkb_astparam;  /* caller's ast arg */
270                 struct dlm_user_args    *lkb_ua;
271         };
272 };
273
274
275 struct dlm_rsb {
276         struct dlm_ls           *res_ls;        /* the lockspace */
277         struct kref             res_ref;
278         struct mutex            res_mutex;
279         unsigned long           res_flags;
280         int                     res_length;     /* length of rsb name */
281         int                     res_nodeid;
282         uint32_t                res_lvbseq;
283         uint32_t                res_hash;
284         uint32_t                res_bucket;     /* rsbtbl */
285         unsigned long           res_toss_time;
286         uint32_t                res_first_lkid;
287         struct list_head        res_lookup;     /* lkbs waiting on first */
288         union {
289                 struct list_head        res_hashchain;
290                 struct rb_node          res_hashnode;   /* rsbtbl */
291         };
292         struct list_head        res_grantqueue;
293         struct list_head        res_convertqueue;
294         struct list_head        res_waitqueue;
295
296         struct list_head        res_root_list;      /* used for recovery */
297         struct list_head        res_recover_list;   /* used for recovery */
298         int                     res_recover_locks_count;
299
300         char                    *res_lvbptr;
301         char                    res_name[DLM_RESNAME_MAXLEN+1];
302 };
303
304 /* find_rsb() flags */
305
306 #define R_MASTER                1       /* only return rsb if it's a master */
307 #define R_CREATE                2       /* create/add rsb if not found */
308
309 /* rsb_flags */
310
311 enum rsb_flags {
312         RSB_MASTER_UNCERTAIN,
313         RSB_VALNOTVALID,
314         RSB_VALNOTVALID_PREV,
315         RSB_NEW_MASTER,
316         RSB_NEW_MASTER2,
317         RSB_RECOVER_CONVERT,
318         RSB_LOCKS_PURGED,
319 };
320
321 static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
322 {
323         __set_bit(flag, &r->res_flags);
324 }
325
326 static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
327 {
328         __clear_bit(flag, &r->res_flags);
329 }
330
331 static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
332 {
333         return test_bit(flag, &r->res_flags);
334 }
335
336
337 /* dlm_header is first element of all structs sent between nodes */
338
339 #define DLM_HEADER_MAJOR        0x00030000
340 #define DLM_HEADER_MINOR        0x00000000
341
342 #define DLM_MSG                 1
343 #define DLM_RCOM                2
344
345 struct dlm_header {
346         uint32_t                h_version;
347         uint32_t                h_lockspace;
348         uint32_t                h_nodeid;       /* nodeid of sender */
349         uint16_t                h_length;
350         uint8_t                 h_cmd;          /* DLM_MSG, DLM_RCOM */
351         uint8_t                 h_pad;
352 };
353
354
355 #define DLM_MSG_REQUEST         1
356 #define DLM_MSG_CONVERT         2
357 #define DLM_MSG_UNLOCK          3
358 #define DLM_MSG_CANCEL          4
359 #define DLM_MSG_REQUEST_REPLY   5
360 #define DLM_MSG_CONVERT_REPLY   6
361 #define DLM_MSG_UNLOCK_REPLY    7
362 #define DLM_MSG_CANCEL_REPLY    8
363 #define DLM_MSG_GRANT           9
364 #define DLM_MSG_BAST            10
365 #define DLM_MSG_LOOKUP          11
366 #define DLM_MSG_REMOVE          12
367 #define DLM_MSG_LOOKUP_REPLY    13
368 #define DLM_MSG_PURGE           14
369
370 struct dlm_message {
371         struct dlm_header       m_header;
372         uint32_t                m_type;         /* DLM_MSG_ */
373         uint32_t                m_nodeid;
374         uint32_t                m_pid;
375         uint32_t                m_lkid;         /* lkid on sender */
376         uint32_t                m_remid;        /* lkid on receiver */
377         uint32_t                m_parent_lkid;
378         uint32_t                m_parent_remid;
379         uint32_t                m_exflags;
380         uint32_t                m_sbflags;
381         uint32_t                m_flags;
382         uint32_t                m_lvbseq;
383         uint32_t                m_hash;
384         int                     m_status;
385         int                     m_grmode;
386         int                     m_rqmode;
387         int                     m_bastmode;
388         int                     m_asts;
389         int                     m_result;       /* 0 or -EXXX */
390         char                    m_extra[0];     /* name or lvb */
391 };
392
393
394 #define DLM_RS_NODES            0x00000001
395 #define DLM_RS_NODES_ALL        0x00000002
396 #define DLM_RS_DIR              0x00000004
397 #define DLM_RS_DIR_ALL          0x00000008
398 #define DLM_RS_LOCKS            0x00000010
399 #define DLM_RS_LOCKS_ALL        0x00000020
400 #define DLM_RS_DONE             0x00000040
401 #define DLM_RS_DONE_ALL         0x00000080
402
403 #define DLM_RCOM_STATUS         1
404 #define DLM_RCOM_NAMES          2
405 #define DLM_RCOM_LOOKUP         3
406 #define DLM_RCOM_LOCK           4
407 #define DLM_RCOM_STATUS_REPLY   5
408 #define DLM_RCOM_NAMES_REPLY    6
409 #define DLM_RCOM_LOOKUP_REPLY   7
410 #define DLM_RCOM_LOCK_REPLY     8
411
412 struct dlm_rcom {
413         struct dlm_header       rc_header;
414         uint32_t                rc_type;        /* DLM_RCOM_ */
415         int                     rc_result;      /* multi-purpose */
416         uint64_t                rc_id;          /* match reply with request */
417         uint64_t                rc_seq;         /* sender's ls_recover_seq */
418         uint64_t                rc_seq_reply;   /* remote ls_recover_seq */
419         char                    rc_buf[0];
420 };
421
422 union dlm_packet {
423         struct dlm_header       header;         /* common to other two */
424         struct dlm_message      message;
425         struct dlm_rcom         rcom;
426 };
427
428 struct rcom_config {
429         __le32                  rf_lvblen;
430         __le32                  rf_lsflags;
431         __le64                  rf_unused;
432 };
433
434 struct rcom_lock {
435         __le32                  rl_ownpid;
436         __le32                  rl_lkid;
437         __le32                  rl_remid;
438         __le32                  rl_parent_lkid;
439         __le32                  rl_parent_remid;
440         __le32                  rl_exflags;
441         __le32                  rl_flags;
442         __le32                  rl_lvbseq;
443         __le32                  rl_result;
444         int8_t                  rl_rqmode;
445         int8_t                  rl_grmode;
446         int8_t                  rl_status;
447         int8_t                  rl_asts;
448         __le16                  rl_wait_type;
449         __le16                  rl_namelen;
450         char                    rl_name[DLM_RESNAME_MAXLEN];
451         char                    rl_lvb[0];
452 };
453
454 struct dlm_ls {
455         struct list_head        ls_list;        /* list of lockspaces */
456         dlm_lockspace_t         *ls_local_handle;
457         uint32_t                ls_global_id;   /* global unique lockspace ID */
458         uint32_t                ls_exflags;
459         int                     ls_lvblen;
460         int                     ls_count;       /* refcount of processes in
461                                                    the dlm using this ls */
462         int                     ls_create_count; /* create/release refcount */
463         unsigned long           ls_flags;       /* LSFL_ */
464         unsigned long           ls_scan_time;
465         struct kobject          ls_kobj;
466
467         struct idr              ls_lkbidr;
468         spinlock_t              ls_lkbidr_spin;
469
470         struct dlm_rsbtable     *ls_rsbtbl;
471         uint32_t                ls_rsbtbl_size;
472
473         struct dlm_dirtable     *ls_dirtbl;
474         uint32_t                ls_dirtbl_size;
475
476         struct mutex            ls_waiters_mutex;
477         struct list_head        ls_waiters;     /* lkbs needing a reply */
478
479         struct mutex            ls_orphans_mutex;
480         struct list_head        ls_orphans;
481
482         struct mutex            ls_timeout_mutex;
483         struct list_head        ls_timeout;
484
485         spinlock_t              ls_new_rsb_spin;
486         int                     ls_new_rsb_count;
487         struct list_head        ls_new_rsb;     /* new rsb structs */
488
489         struct list_head        ls_nodes;       /* current nodes in ls */
490         struct list_head        ls_nodes_gone;  /* dead node list, recovery */
491         int                     ls_num_nodes;   /* number of nodes in ls */
492         int                     ls_low_nodeid;
493         int                     ls_total_weight;
494         int                     *ls_node_array;
495
496         struct dlm_rsb          ls_stub_rsb;    /* for returning errors */
497         struct dlm_lkb          ls_stub_lkb;    /* for returning errors */
498         struct dlm_message      ls_stub_ms;     /* for faking a reply */
499
500         struct dentry           *ls_debug_rsb_dentry; /* debugfs */
501         struct dentry           *ls_debug_waiters_dentry; /* debugfs */
502         struct dentry           *ls_debug_locks_dentry; /* debugfs */
503         struct dentry           *ls_debug_all_dentry; /* debugfs */
504
505         wait_queue_head_t       ls_uevent_wait; /* user part of join/leave */
506         int                     ls_uevent_result;
507         struct completion       ls_members_done;
508         int                     ls_members_result;
509
510         struct miscdevice       ls_device;
511
512         struct workqueue_struct *ls_callback_wq;
513
514         /* recovery related */
515
516         struct mutex            ls_cb_mutex;
517         struct list_head        ls_cb_delay; /* save for queue_work later */
518         struct timer_list       ls_timer;
519         struct task_struct      *ls_recoverd_task;
520         struct mutex            ls_recoverd_active;
521         spinlock_t              ls_recover_lock;
522         unsigned long           ls_recover_begin; /* jiffies timestamp */
523         uint32_t                ls_recover_status; /* DLM_RS_ */
524         uint64_t                ls_recover_seq;
525         struct dlm_recover      *ls_recover_args;
526         struct rw_semaphore     ls_in_recovery; /* block local requests */
527         struct rw_semaphore     ls_recv_active; /* block dlm_recv */
528         struct list_head        ls_requestqueue;/* queue remote requests */
529         struct mutex            ls_requestqueue_mutex;
530         struct dlm_rcom         *ls_recover_buf;
531         int                     ls_recover_nodeid; /* for debugging */
532         uint64_t                ls_rcom_seq;
533         spinlock_t              ls_rcom_spin;
534         struct list_head        ls_recover_list;
535         spinlock_t              ls_recover_list_lock;
536         int                     ls_recover_list_count;
537         wait_queue_head_t       ls_wait_general;
538         struct mutex            ls_clear_proc_locks;
539
540         struct list_head        ls_root_list;   /* root resources */
541         struct rw_semaphore     ls_root_sem;    /* protect root_list */
542
543         int                     ls_namelen;
544         char                    ls_name[1];
545 };
546
547 #define LSFL_WORK               0
548 #define LSFL_RUNNING            1
549 #define LSFL_RECOVERY_STOP      2
550 #define LSFL_RCOM_READY         3
551 #define LSFL_RCOM_WAIT          4
552 #define LSFL_UEVENT_WAIT        5
553 #define LSFL_TIMEWARN           6
554 #define LSFL_CB_DELAY           7
555
556 /* much of this is just saving user space pointers associated with the
557    lock that we pass back to the user lib with an ast */
558
559 struct dlm_user_args {
560         struct dlm_user_proc    *proc; /* each process that opens the lockspace
561                                           device has private data
562                                           (dlm_user_proc) on the struct file,
563                                           the process's locks point back to it*/
564         struct dlm_lksb         lksb;
565         struct dlm_lksb __user  *user_lksb;
566         void __user             *castparam;
567         void __user             *castaddr;
568         void __user             *bastparam;
569         void __user             *bastaddr;
570         uint64_t                xid;
571 };
572
573 #define DLM_PROC_FLAGS_CLOSING 1
574 #define DLM_PROC_FLAGS_COMPAT  2
575
576 /* locks list is kept so we can remove all a process's locks when it
577    exits (or orphan those that are persistent) */
578
579 struct dlm_user_proc {
580         dlm_lockspace_t         *lockspace;
581         unsigned long           flags; /* DLM_PROC_FLAGS */
582         struct list_head        asts;
583         spinlock_t              asts_spin;
584         struct list_head        locks;
585         spinlock_t              locks_spin;
586         struct list_head        unlocking;
587         wait_queue_head_t       wait;
588 };
589
590 static inline int dlm_locking_stopped(struct dlm_ls *ls)
591 {
592         return !test_bit(LSFL_RUNNING, &ls->ls_flags);
593 }
594
595 static inline int dlm_recovery_stopped(struct dlm_ls *ls)
596 {
597         return test_bit(LSFL_RECOVERY_STOP, &ls->ls_flags);
598 }
599
600 static inline int dlm_no_directory(struct dlm_ls *ls)
601 {
602         return (ls->ls_exflags & DLM_LSFL_NODIR) ? 1 : 0;
603 }
604
605 int dlm_netlink_init(void);
606 void dlm_netlink_exit(void);
607 void dlm_timeout_warn(struct dlm_lkb *lkb);
608 int dlm_plock_init(void);
609 void dlm_plock_exit(void);
610
611 #ifdef CONFIG_DLM_DEBUG
612 int dlm_register_debugfs(void);
613 void dlm_unregister_debugfs(void);
614 int dlm_create_debug_file(struct dlm_ls *ls);
615 void dlm_delete_debug_file(struct dlm_ls *ls);
616 #else
617 static inline int dlm_register_debugfs(void) { return 0; }
618 static inline void dlm_unregister_debugfs(void) { }
619 static inline int dlm_create_debug_file(struct dlm_ls *ls) { return 0; }
620 static inline void dlm_delete_debug_file(struct dlm_ls *ls) { }
621 #endif
622
623 #endif                          /* __DLM_INTERNAL_DOT_H__ */
624