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