[PATCH] ocfs2: use hlists for lockres hash
[linux-2.6.git] / fs / ocfs2 / dlm / dlmcommon.h
1 /* -*- mode: c; c-basic-offset: 8; -*-
2  * vim: noexpandtab sw=8 ts=8 sts=0:
3  *
4  * dlmcommon.h
5  *
6  * Copyright (C) 2004 Oracle.  All rights reserved.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public
19  * License along with this program; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 021110-1307, USA.
22  *
23  */
24
25 #ifndef DLMCOMMON_H
26 #define DLMCOMMON_H
27
28 #include <linux/kref.h>
29
30 #define DLM_HB_NODE_DOWN_PRI     (0xf000000)
31 #define DLM_HB_NODE_UP_PRI       (0x8000000)
32
33 #define DLM_LOCKID_NAME_MAX    32
34
35 #define DLM_DOMAIN_NAME_MAX_LEN    255
36 #define DLM_LOCK_RES_OWNER_UNKNOWN     O2NM_MAX_NODES
37 #define DLM_THREAD_SHUFFLE_INTERVAL    5     // flush everything every 5 passes
38 #define DLM_THREAD_MS                  200   // flush at least every 200 ms
39
40 #define DLM_HASH_BUCKETS     (PAGE_SIZE / sizeof(struct hlist_head))
41
42 enum dlm_ast_type {
43         DLM_AST = 0,
44         DLM_BAST,
45         DLM_ASTUNLOCK
46 };
47
48
49 #define LKM_VALID_FLAGS (LKM_VALBLK | LKM_CONVERT | LKM_UNLOCK | \
50                          LKM_CANCEL | LKM_INVVALBLK | LKM_FORCE | \
51                          LKM_RECOVERY | LKM_LOCAL | LKM_NOQUEUE)
52
53 #define DLM_RECOVERY_LOCK_NAME       "$RECOVERY"
54 #define DLM_RECOVERY_LOCK_NAME_LEN   9
55
56 static inline int dlm_is_recovery_lock(const char *lock_name, int name_len)
57 {
58         if (name_len == DLM_RECOVERY_LOCK_NAME_LEN &&
59             memcmp(lock_name, DLM_RECOVERY_LOCK_NAME, name_len)==0)
60                 return 1;
61         return 0;
62 }
63
64 #define DLM_RECO_STATE_ACTIVE  0x0001
65
66 struct dlm_recovery_ctxt
67 {
68         struct list_head resources;
69         struct list_head received;
70         struct list_head node_data;
71         u8  new_master;
72         u8  dead_node;
73         u16 state;
74         unsigned long node_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
75         wait_queue_head_t event;
76 };
77
78 enum dlm_ctxt_state {
79         DLM_CTXT_NEW = 0,
80         DLM_CTXT_JOINED,
81         DLM_CTXT_IN_SHUTDOWN,
82         DLM_CTXT_LEAVING,
83 };
84
85 struct dlm_ctxt
86 {
87         struct list_head list;
88         struct hlist_head *lockres_hash;
89         struct list_head dirty_list;
90         struct list_head purge_list;
91         struct list_head pending_asts;
92         struct list_head pending_basts;
93         unsigned int purge_count;
94         spinlock_t spinlock;
95         spinlock_t ast_lock;
96         char *name;
97         u8 node_num;
98         u32 key;
99         u8  joining_node;
100         wait_queue_head_t dlm_join_events;
101         unsigned long live_nodes_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
102         unsigned long domain_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
103         unsigned long recovery_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
104         struct dlm_recovery_ctxt reco;
105         spinlock_t master_lock;
106         struct list_head master_list;
107         struct list_head mle_hb_events;
108
109         /* these give a really vague idea of the system load */
110         atomic_t local_resources;
111         atomic_t remote_resources;
112         atomic_t unknown_resources;
113
114         /* NOTE: Next three are protected by dlm_domain_lock */
115         struct kref dlm_refs;
116         enum dlm_ctxt_state dlm_state;
117         unsigned int num_joins;
118
119         struct o2hb_callback_func dlm_hb_up;
120         struct o2hb_callback_func dlm_hb_down;
121         struct task_struct *dlm_thread_task;
122         struct task_struct *dlm_reco_thread_task;
123         wait_queue_head_t dlm_thread_wq;
124         wait_queue_head_t dlm_reco_thread_wq;
125         wait_queue_head_t ast_wq;
126         wait_queue_head_t migration_wq;
127
128         struct work_struct dispatched_work;
129         struct list_head work_list;
130         spinlock_t work_lock;
131         struct list_head dlm_domain_handlers;
132         struct list_head        dlm_eviction_callbacks;
133 };
134
135 /* these keventd work queue items are for less-frequently
136  * called functions that cannot be directly called from the
137  * net message handlers for some reason, usually because
138  * they need to send net messages of their own. */
139 void dlm_dispatch_work(void *data);
140
141 struct dlm_lock_resource;
142 struct dlm_work_item;
143
144 typedef void (dlm_workfunc_t)(struct dlm_work_item *, void *);
145
146 struct dlm_request_all_locks_priv
147 {
148         u8 reco_master;
149         u8 dead_node;
150 };
151
152 struct dlm_mig_lockres_priv
153 {
154         struct dlm_lock_resource *lockres;
155         u8 real_master;
156 };
157
158 struct dlm_assert_master_priv
159 {
160         struct dlm_lock_resource *lockres;
161         u8 request_from;
162         u32 flags;
163         unsigned ignore_higher:1;
164 };
165
166
167 struct dlm_work_item
168 {
169         struct list_head list;
170         dlm_workfunc_t *func;
171         struct dlm_ctxt *dlm;
172         void *data;
173         union {
174                 struct dlm_request_all_locks_priv ral;
175                 struct dlm_mig_lockres_priv ml;
176                 struct dlm_assert_master_priv am;
177         } u;
178 };
179
180 static inline void dlm_init_work_item(struct dlm_ctxt *dlm,
181                                       struct dlm_work_item *i,
182                                       dlm_workfunc_t *f, void *data)
183 {
184         memset(i, 0, sizeof(*i));
185         i->func = f;
186         INIT_LIST_HEAD(&i->list);
187         i->data = data;
188         i->dlm = dlm;  /* must have already done a dlm_grab on this! */
189 }
190
191
192
193 static inline void __dlm_set_joining_node(struct dlm_ctxt *dlm,
194                                           u8 node)
195 {
196         assert_spin_locked(&dlm->spinlock);
197
198         dlm->joining_node = node;
199         wake_up(&dlm->dlm_join_events);
200 }
201
202 #define DLM_LOCK_RES_UNINITED             0x00000001
203 #define DLM_LOCK_RES_RECOVERING           0x00000002
204 #define DLM_LOCK_RES_READY                0x00000004
205 #define DLM_LOCK_RES_DIRTY                0x00000008
206 #define DLM_LOCK_RES_IN_PROGRESS          0x00000010
207 #define DLM_LOCK_RES_MIGRATING            0x00000020
208
209 /* max milliseconds to wait to sync up a network failure with a node death */
210 #define DLM_NODE_DEATH_WAIT_MAX (5 * 1000)
211
212 #define DLM_PURGE_INTERVAL_MS   (8 * 1000)
213
214 struct dlm_lock_resource
215 {
216         /* WARNING: Please see the comment in dlm_init_lockres before
217          * adding fields here. */
218         struct hlist_node hash_node;
219         struct kref      refs;
220
221         /* please keep these next 3 in this order
222          * some funcs want to iterate over all lists */
223         struct list_head granted;
224         struct list_head converting;
225         struct list_head blocked;
226
227         struct list_head dirty;
228         struct list_head recovering; // dlm_recovery_ctxt.resources list
229
230         /* unused lock resources have their last_used stamped and are
231          * put on a list for the dlm thread to run. */
232         struct list_head purge;
233         unsigned long    last_used;
234
235         unsigned migration_pending:1;
236         atomic_t asts_reserved;
237         spinlock_t spinlock;
238         wait_queue_head_t wq;
239         u8  owner;              //node which owns the lock resource, or unknown
240         u16 state;
241         struct qstr lockname;
242         char lvb[DLM_LVB_LEN];
243 };
244
245 struct dlm_migratable_lock
246 {
247         __be64 cookie;
248
249         /* these 3 are just padding for the in-memory structure, but
250          * list and flags are actually used when sent over the wire */
251         __be16 pad1;
252         u8 list;  // 0=granted, 1=converting, 2=blocked
253         u8 flags;
254
255         s8 type;
256         s8 convert_type;
257         s8 highest_blocked;
258         u8 node;
259 };  // 16 bytes
260
261 struct dlm_lock
262 {
263         struct dlm_migratable_lock ml;
264
265         struct list_head list;
266         struct list_head ast_list;
267         struct list_head bast_list;
268         struct dlm_lock_resource *lockres;
269         spinlock_t spinlock;
270         struct kref lock_refs;
271
272         // ast and bast must be callable while holding a spinlock!
273         dlm_astlockfunc_t *ast;
274         dlm_bastlockfunc_t *bast;
275         void *astdata;
276         struct dlm_lockstatus *lksb;
277         unsigned ast_pending:1,
278                  bast_pending:1,
279                  convert_pending:1,
280                  lock_pending:1,
281                  cancel_pending:1,
282                  unlock_pending:1,
283                  lksb_kernel_allocated:1;
284 };
285
286
287 #define DLM_LKSB_UNUSED1           0x01
288 #define DLM_LKSB_PUT_LVB           0x02
289 #define DLM_LKSB_GET_LVB           0x04
290 #define DLM_LKSB_UNUSED2           0x08
291 #define DLM_LKSB_UNUSED3           0x10
292 #define DLM_LKSB_UNUSED4           0x20
293 #define DLM_LKSB_UNUSED5           0x40
294 #define DLM_LKSB_UNUSED6           0x80
295
296
297 enum dlm_lockres_list {
298         DLM_GRANTED_LIST = 0,
299         DLM_CONVERTING_LIST,
300         DLM_BLOCKED_LIST
301 };
302
303 static inline struct list_head *
304 dlm_list_idx_to_ptr(struct dlm_lock_resource *res, enum dlm_lockres_list idx)
305 {
306         struct list_head *ret = NULL;
307         if (idx == DLM_GRANTED_LIST)
308                 ret = &res->granted;
309         else if (idx == DLM_CONVERTING_LIST)
310                 ret = &res->converting;
311         else if (idx == DLM_BLOCKED_LIST)
312                 ret = &res->blocked;
313         else
314                 BUG();
315         return ret;
316 }
317
318
319
320
321 struct dlm_node_iter
322 {
323         unsigned long node_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
324         int curnode;
325 };
326
327
328 enum {
329         DLM_MASTER_REQUEST_MSG    = 500,
330         DLM_UNUSED_MSG1,         /* 501 */
331         DLM_ASSERT_MASTER_MSG,   /* 502 */
332         DLM_CREATE_LOCK_MSG,     /* 503 */
333         DLM_CONVERT_LOCK_MSG,    /* 504 */
334         DLM_PROXY_AST_MSG,       /* 505 */
335         DLM_UNLOCK_LOCK_MSG,     /* 506 */
336         DLM_UNUSED_MSG2,         /* 507 */
337         DLM_MIGRATE_REQUEST_MSG, /* 508 */
338         DLM_MIG_LOCKRES_MSG,     /* 509 */
339         DLM_QUERY_JOIN_MSG,      /* 510 */
340         DLM_ASSERT_JOINED_MSG,   /* 511 */
341         DLM_CANCEL_JOIN_MSG,     /* 512 */
342         DLM_EXIT_DOMAIN_MSG,     /* 513 */
343         DLM_MASTER_REQUERY_MSG,  /* 514 */
344         DLM_LOCK_REQUEST_MSG,    /* 515 */
345         DLM_RECO_DATA_DONE_MSG,  /* 516 */
346         DLM_BEGIN_RECO_MSG,      /* 517 */
347         DLM_FINALIZE_RECO_MSG    /* 518 */
348 };
349
350 struct dlm_reco_node_data
351 {
352         int state;
353         u8 node_num;
354         struct list_head list;
355 };
356
357 enum {
358         DLM_RECO_NODE_DATA_DEAD = -1,
359         DLM_RECO_NODE_DATA_INIT = 0,
360         DLM_RECO_NODE_DATA_REQUESTING,
361         DLM_RECO_NODE_DATA_REQUESTED,
362         DLM_RECO_NODE_DATA_RECEIVING,
363         DLM_RECO_NODE_DATA_DONE,
364         DLM_RECO_NODE_DATA_FINALIZE_SENT,
365 };
366
367
368 enum {
369         DLM_MASTER_RESP_NO = 0,
370         DLM_MASTER_RESP_YES,
371         DLM_MASTER_RESP_MAYBE,
372         DLM_MASTER_RESP_ERROR
373 };
374
375
376 struct dlm_master_request
377 {
378         u8 node_idx;
379         u8 namelen;
380         __be16 pad1;
381         __be32 flags;
382
383         u8 name[O2NM_MAX_NAME_LEN];
384 };
385
386 #define DLM_ASSERT_MASTER_MLE_CLEANUP      0x00000001
387 #define DLM_ASSERT_MASTER_REQUERY          0x00000002
388 #define DLM_ASSERT_MASTER_FINISH_MIGRATION 0x00000004
389 struct dlm_assert_master
390 {
391         u8 node_idx;
392         u8 namelen;
393         __be16 pad1;
394         __be32 flags;
395
396         u8 name[O2NM_MAX_NAME_LEN];
397 };
398
399 struct dlm_migrate_request
400 {
401         u8 master;
402         u8 new_master;
403         u8 namelen;
404         u8 pad1;
405         __be32 pad2;
406         u8 name[O2NM_MAX_NAME_LEN];
407 };
408
409 struct dlm_master_requery
410 {
411         u8 pad1;
412         u8 pad2;
413         u8 node_idx;
414         u8 namelen;
415         __be32 pad3;
416         u8 name[O2NM_MAX_NAME_LEN];
417 };
418
419 #define DLM_MRES_RECOVERY   0x01
420 #define DLM_MRES_MIGRATION  0x02
421 #define DLM_MRES_ALL_DONE   0x04
422
423 /*
424  * We would like to get one whole lockres into a single network
425  * message whenever possible.  Generally speaking, there will be
426  * at most one dlm_lock on a lockres for each node in the cluster,
427  * plus (infrequently) any additional locks coming in from userdlm.
428  *
429  * struct _dlm_lockres_page
430  * {
431  *      dlm_migratable_lockres mres;
432  *      dlm_migratable_lock ml[DLM_MAX_MIGRATABLE_LOCKS];
433  *      u8 pad[DLM_MIG_LOCKRES_RESERVED];
434  * };
435  *
436  * from ../cluster/tcp.h
437  *    NET_MAX_PAYLOAD_BYTES  (4096 - sizeof(net_msg))
438  *    (roughly 4080 bytes)
439  * and sizeof(dlm_migratable_lockres) = 112 bytes
440  * and sizeof(dlm_migratable_lock) = 16 bytes
441  *
442  * Choosing DLM_MAX_MIGRATABLE_LOCKS=240 and
443  * DLM_MIG_LOCKRES_RESERVED=128 means we have this:
444  *
445  *  (DLM_MAX_MIGRATABLE_LOCKS * sizeof(dlm_migratable_lock)) +
446  *     sizeof(dlm_migratable_lockres) + DLM_MIG_LOCKRES_RESERVED =
447  *        NET_MAX_PAYLOAD_BYTES
448  *  (240 * 16) + 112 + 128 = 4080
449  *
450  * So a lockres would need more than 240 locks before it would
451  * use more than one network packet to recover.  Not too bad.
452  */
453 #define DLM_MAX_MIGRATABLE_LOCKS   240
454
455 struct dlm_migratable_lockres
456 {
457         u8 master;
458         u8 lockname_len;
459         u8 num_locks;    // locks sent in this structure
460         u8 flags;
461         __be32 total_locks; // locks to be sent for this migration cookie
462         __be64 mig_cookie;  // cookie for this lockres migration
463                          // or zero if not needed
464         // 16 bytes
465         u8 lockname[DLM_LOCKID_NAME_MAX];
466         // 48 bytes
467         u8 lvb[DLM_LVB_LEN];
468         // 112 bytes
469         struct dlm_migratable_lock ml[0];  // 16 bytes each, begins at byte 112
470 };
471 #define DLM_MIG_LOCKRES_MAX_LEN  \
472         (sizeof(struct dlm_migratable_lockres) + \
473          (sizeof(struct dlm_migratable_lock) * \
474           DLM_MAX_MIGRATABLE_LOCKS) )
475
476 /* from above, 128 bytes
477  * for some undetermined future use */
478 #define DLM_MIG_LOCKRES_RESERVED   (NET_MAX_PAYLOAD_BYTES - \
479                                     DLM_MIG_LOCKRES_MAX_LEN)
480
481 struct dlm_create_lock
482 {
483         __be64 cookie;
484
485         __be32 flags;
486         u8 pad1;
487         u8 node_idx;
488         s8 requested_type;
489         u8 namelen;
490
491         u8 name[O2NM_MAX_NAME_LEN];
492 };
493
494 struct dlm_convert_lock
495 {
496         __be64 cookie;
497
498         __be32 flags;
499         u8 pad1;
500         u8 node_idx;
501         s8 requested_type;
502         u8 namelen;
503
504         u8 name[O2NM_MAX_NAME_LEN];
505
506         s8 lvb[0];
507 };
508 #define DLM_CONVERT_LOCK_MAX_LEN  (sizeof(struct dlm_convert_lock)+DLM_LVB_LEN)
509
510 struct dlm_unlock_lock
511 {
512         __be64 cookie;
513
514         __be32 flags;
515         __be16 pad1;
516         u8 node_idx;
517         u8 namelen;
518
519         u8 name[O2NM_MAX_NAME_LEN];
520
521         s8 lvb[0];
522 };
523 #define DLM_UNLOCK_LOCK_MAX_LEN  (sizeof(struct dlm_unlock_lock)+DLM_LVB_LEN)
524
525 struct dlm_proxy_ast
526 {
527         __be64 cookie;
528
529         __be32 flags;
530         u8 node_idx;
531         u8 type;
532         u8 blocked_type;
533         u8 namelen;
534
535         u8 name[O2NM_MAX_NAME_LEN];
536
537         s8 lvb[0];
538 };
539 #define DLM_PROXY_AST_MAX_LEN  (sizeof(struct dlm_proxy_ast)+DLM_LVB_LEN)
540
541 #define DLM_MOD_KEY (0x666c6172)
542 enum dlm_query_join_response {
543         JOIN_DISALLOW = 0,
544         JOIN_OK,
545         JOIN_OK_NO_MAP,
546 };
547
548 struct dlm_lock_request
549 {
550         u8 node_idx;
551         u8 dead_node;
552         __be16 pad1;
553         __be32 pad2;
554 };
555
556 struct dlm_reco_data_done
557 {
558         u8 node_idx;
559         u8 dead_node;
560         __be16 pad1;
561         __be32 pad2;
562
563         /* unused for now */
564         /* eventually we can use this to attempt
565          * lvb recovery based on each node's info */
566         u8 reco_lvb[DLM_LVB_LEN];
567 };
568
569 struct dlm_begin_reco
570 {
571         u8 node_idx;
572         u8 dead_node;
573         __be16 pad1;
574         __be32 pad2;
575 };
576
577
578 struct dlm_query_join_request
579 {
580         u8 node_idx;
581         u8 pad1[2];
582         u8 name_len;
583         u8 domain[O2NM_MAX_NAME_LEN];
584 };
585
586 struct dlm_assert_joined
587 {
588         u8 node_idx;
589         u8 pad1[2];
590         u8 name_len;
591         u8 domain[O2NM_MAX_NAME_LEN];
592 };
593
594 struct dlm_cancel_join
595 {
596         u8 node_idx;
597         u8 pad1[2];
598         u8 name_len;
599         u8 domain[O2NM_MAX_NAME_LEN];
600 };
601
602 struct dlm_exit_domain
603 {
604         u8 node_idx;
605         u8 pad1[3];
606 };
607
608 struct dlm_finalize_reco
609 {
610         u8 node_idx;
611         u8 dead_node;
612         __be16 pad1;
613         __be32 pad2;
614 };
615
616 static inline enum dlm_status
617 __dlm_lockres_state_to_status(struct dlm_lock_resource *res)
618 {
619         enum dlm_status status = DLM_NORMAL;
620
621         assert_spin_locked(&res->spinlock);
622
623         if (res->state & DLM_LOCK_RES_RECOVERING)
624                 status = DLM_RECOVERING;
625         else if (res->state & DLM_LOCK_RES_MIGRATING)
626                 status = DLM_MIGRATING;
627         else if (res->state & DLM_LOCK_RES_IN_PROGRESS)
628                 status = DLM_FORWARD;
629
630         return status;
631 }
632
633 struct dlm_lock * dlm_new_lock(int type, u8 node, u64 cookie,
634                                struct dlm_lockstatus *lksb);
635 void dlm_lock_get(struct dlm_lock *lock);
636 void dlm_lock_put(struct dlm_lock *lock);
637
638 void dlm_lock_attach_lockres(struct dlm_lock *lock,
639                              struct dlm_lock_resource *res);
640
641 int dlm_create_lock_handler(struct o2net_msg *msg, u32 len, void *data);
642 int dlm_convert_lock_handler(struct o2net_msg *msg, u32 len, void *data);
643 int dlm_proxy_ast_handler(struct o2net_msg *msg, u32 len, void *data);
644
645 void dlm_revert_pending_convert(struct dlm_lock_resource *res,
646                                 struct dlm_lock *lock);
647 void dlm_revert_pending_lock(struct dlm_lock_resource *res,
648                              struct dlm_lock *lock);
649
650 int dlm_unlock_lock_handler(struct o2net_msg *msg, u32 len, void *data);
651 void dlm_commit_pending_cancel(struct dlm_lock_resource *res,
652                                struct dlm_lock *lock);
653 void dlm_commit_pending_unlock(struct dlm_lock_resource *res,
654                                struct dlm_lock *lock);
655
656 int dlm_launch_thread(struct dlm_ctxt *dlm);
657 void dlm_complete_thread(struct dlm_ctxt *dlm);
658 int dlm_launch_recovery_thread(struct dlm_ctxt *dlm);
659 void dlm_complete_recovery_thread(struct dlm_ctxt *dlm);
660 void dlm_wait_for_recovery(struct dlm_ctxt *dlm);
661 int dlm_is_node_dead(struct dlm_ctxt *dlm, u8 node);
662 int dlm_wait_for_node_death(struct dlm_ctxt *dlm, u8 node, int timeout);
663
664 void dlm_put(struct dlm_ctxt *dlm);
665 struct dlm_ctxt *dlm_grab(struct dlm_ctxt *dlm);
666 int dlm_domain_fully_joined(struct dlm_ctxt *dlm);
667
668 void __dlm_lockres_calc_usage(struct dlm_ctxt *dlm,
669                               struct dlm_lock_resource *res);
670 void dlm_lockres_calc_usage(struct dlm_ctxt *dlm,
671                             struct dlm_lock_resource *res);
672 void dlm_purge_lockres(struct dlm_ctxt *dlm,
673                        struct dlm_lock_resource *lockres);
674 void dlm_lockres_get(struct dlm_lock_resource *res);
675 void dlm_lockres_put(struct dlm_lock_resource *res);
676 void __dlm_unhash_lockres(struct dlm_lock_resource *res);
677 void __dlm_insert_lockres(struct dlm_ctxt *dlm,
678                           struct dlm_lock_resource *res);
679 struct dlm_lock_resource * __dlm_lookup_lockres(struct dlm_ctxt *dlm,
680                                                 const char *name,
681                                                 unsigned int len);
682 struct dlm_lock_resource * dlm_lookup_lockres(struct dlm_ctxt *dlm,
683                                               const char *name,
684                                               unsigned int len);
685
686 int dlm_is_host_down(int errno);
687 void dlm_change_lockres_owner(struct dlm_ctxt *dlm,
688                               struct dlm_lock_resource *res,
689                               u8 owner);
690 struct dlm_lock_resource * dlm_get_lock_resource(struct dlm_ctxt *dlm,
691                                                  const char *lockid,
692                                                  int flags);
693 struct dlm_lock_resource *dlm_new_lockres(struct dlm_ctxt *dlm,
694                                           const char *name,
695                                           unsigned int namelen);
696
697 void dlm_queue_ast(struct dlm_ctxt *dlm, struct dlm_lock *lock);
698 void dlm_queue_bast(struct dlm_ctxt *dlm, struct dlm_lock *lock);
699 void dlm_do_local_ast(struct dlm_ctxt *dlm,
700                       struct dlm_lock_resource *res,
701                       struct dlm_lock *lock);
702 int dlm_do_remote_ast(struct dlm_ctxt *dlm,
703                       struct dlm_lock_resource *res,
704                       struct dlm_lock *lock);
705 void dlm_do_local_bast(struct dlm_ctxt *dlm,
706                        struct dlm_lock_resource *res,
707                        struct dlm_lock *lock,
708                        int blocked_type);
709 int dlm_send_proxy_ast_msg(struct dlm_ctxt *dlm,
710                            struct dlm_lock_resource *res,
711                            struct dlm_lock *lock,
712                            int msg_type,
713                            int blocked_type, int flags);
714 static inline int dlm_send_proxy_bast(struct dlm_ctxt *dlm,
715                                       struct dlm_lock_resource *res,
716                                       struct dlm_lock *lock,
717                                       int blocked_type)
718 {
719         return dlm_send_proxy_ast_msg(dlm, res, lock, DLM_BAST,
720                                       blocked_type, 0);
721 }
722
723 static inline int dlm_send_proxy_ast(struct dlm_ctxt *dlm,
724                                      struct dlm_lock_resource *res,
725                                      struct dlm_lock *lock,
726                                      int flags)
727 {
728         return dlm_send_proxy_ast_msg(dlm, res, lock, DLM_AST,
729                                       0, flags);
730 }
731
732 void dlm_print_one_lock_resource(struct dlm_lock_resource *res);
733 void __dlm_print_one_lock_resource(struct dlm_lock_resource *res);
734
735 u8 dlm_nm_this_node(struct dlm_ctxt *dlm);
736 void dlm_kick_thread(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
737 void __dlm_dirty_lockres(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
738
739
740 int dlm_nm_init(struct dlm_ctxt *dlm);
741 int dlm_heartbeat_init(struct dlm_ctxt *dlm);
742 void dlm_hb_node_down_cb(struct o2nm_node *node, int idx, void *data);
743 void dlm_hb_node_up_cb(struct o2nm_node *node, int idx, void *data);
744
745 int dlm_lockres_is_dirty(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
746 int dlm_migrate_lockres(struct dlm_ctxt *dlm,
747                         struct dlm_lock_resource *res,
748                         u8 target);
749 int dlm_finish_migration(struct dlm_ctxt *dlm,
750                          struct dlm_lock_resource *res,
751                          u8 old_master);
752 void dlm_lockres_release_ast(struct dlm_ctxt *dlm,
753                              struct dlm_lock_resource *res);
754 void __dlm_lockres_reserve_ast(struct dlm_lock_resource *res);
755
756 int dlm_master_request_handler(struct o2net_msg *msg, u32 len, void *data);
757 int dlm_assert_master_handler(struct o2net_msg *msg, u32 len, void *data);
758 int dlm_migrate_request_handler(struct o2net_msg *msg, u32 len, void *data);
759 int dlm_mig_lockres_handler(struct o2net_msg *msg, u32 len, void *data);
760 int dlm_master_requery_handler(struct o2net_msg *msg, u32 len, void *data);
761 int dlm_request_all_locks_handler(struct o2net_msg *msg, u32 len, void *data);
762 int dlm_reco_data_done_handler(struct o2net_msg *msg, u32 len, void *data);
763 int dlm_begin_reco_handler(struct o2net_msg *msg, u32 len, void *data);
764 int dlm_finalize_reco_handler(struct o2net_msg *msg, u32 len, void *data);
765
766 int dlm_dispatch_assert_master(struct dlm_ctxt *dlm,
767                                struct dlm_lock_resource *res,
768                                int ignore_higher,
769                                u8 request_from,
770                                u32 flags);
771
772
773 int dlm_send_one_lockres(struct dlm_ctxt *dlm,
774                          struct dlm_lock_resource *res,
775                          struct dlm_migratable_lockres *mres,
776                          u8 send_to,
777                          u8 flags);
778 void dlm_move_lockres_to_recovery_list(struct dlm_ctxt *dlm,
779                                        struct dlm_lock_resource *res);
780
781 /* will exit holding res->spinlock, but may drop in function */
782 void __dlm_wait_on_lockres_flags(struct dlm_lock_resource *res, int flags);
783 void __dlm_wait_on_lockres_flags_set(struct dlm_lock_resource *res, int flags);
784
785 /* will exit holding res->spinlock, but may drop in function */
786 static inline void __dlm_wait_on_lockres(struct dlm_lock_resource *res)
787 {
788         __dlm_wait_on_lockres_flags(res, (DLM_LOCK_RES_IN_PROGRESS|
789                                           DLM_LOCK_RES_RECOVERING|
790                                           DLM_LOCK_RES_MIGRATING));
791 }
792
793
794 int dlm_init_mle_cache(void);
795 void dlm_destroy_mle_cache(void);
796 void dlm_hb_event_notify_attached(struct dlm_ctxt *dlm, int idx, int node_up);
797 void dlm_clean_master_list(struct dlm_ctxt *dlm,
798                            u8 dead_node);
799 int dlm_lock_basts_flushed(struct dlm_ctxt *dlm, struct dlm_lock *lock);
800
801
802 static inline const char * dlm_lock_mode_name(int mode)
803 {
804         switch (mode) {
805                 case LKM_EXMODE:
806                         return "EX";
807                 case LKM_PRMODE:
808                         return "PR";
809                 case LKM_NLMODE:
810                         return "NL";
811         }
812         return "UNKNOWN";
813 }
814
815
816 static inline int dlm_lock_compatible(int existing, int request)
817 {
818         /* NO_LOCK compatible with all */
819         if (request == LKM_NLMODE ||
820             existing == LKM_NLMODE)
821                 return 1;
822
823         /* EX incompatible with all non-NO_LOCK */
824         if (request == LKM_EXMODE)
825                 return 0;
826
827         /* request must be PR, which is compatible with PR */
828         if (existing == LKM_PRMODE)
829                 return 1;
830
831         return 0;
832 }
833
834 static inline int dlm_lock_on_list(struct list_head *head,
835                                    struct dlm_lock *lock)
836 {
837         struct list_head *iter;
838         struct dlm_lock *tmplock;
839
840         list_for_each(iter, head) {
841                 tmplock = list_entry(iter, struct dlm_lock, list);
842                 if (tmplock == lock)
843                         return 1;
844         }
845         return 0;
846 }
847
848
849 static inline enum dlm_status dlm_err_to_dlm_status(int err)
850 {
851         enum dlm_status ret;
852         if (err == -ENOMEM)
853                 ret = DLM_SYSERR;
854         else if (err == -ETIMEDOUT || o2net_link_down(err, NULL))
855                 ret = DLM_NOLOCKMGR;
856         else if (err == -EINVAL)
857                 ret = DLM_BADPARAM;
858         else if (err == -ENAMETOOLONG)
859                 ret = DLM_IVBUFLEN;
860         else
861                 ret = DLM_BADARGS;
862         return ret;
863 }
864
865
866 static inline void dlm_node_iter_init(unsigned long *map,
867                                       struct dlm_node_iter *iter)
868 {
869         memcpy(iter->node_map, map, sizeof(iter->node_map));
870         iter->curnode = -1;
871 }
872
873 static inline int dlm_node_iter_next(struct dlm_node_iter *iter)
874 {
875         int bit;
876         bit = find_next_bit(iter->node_map, O2NM_MAX_NODES, iter->curnode+1);
877         if (bit >= O2NM_MAX_NODES) {
878                 iter->curnode = O2NM_MAX_NODES;
879                 return -ENOENT;
880         }
881         iter->curnode = bit;
882         return bit;
883 }
884
885
886
887 #endif /* DLMCOMMON_H */