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