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