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