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