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