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