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