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