SAFE public projects git trees. - safe/jmp/linux-2.6/blob - fs/ocfs2/dlm/dlmcommon.h

   1 /* -*- mode: c; c-basic-offset: 8; -*-
   2  * vim: noexpandtab sw=8 ts=8 sts=0:
   3  *
   4  * dlmcommon.h
   5  *
   6  * Copyright (C) 2004 Oracle.  All rights reserved.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public
  19  * License along with this program; if not, write to the
  20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  21  * Boston, MA 021110-1307, USA.
  22  *
  23  */
  24
  25 #ifndef DLMCOMMON_H
  26 #define DLMCOMMON_H
  27
  28 #include <linux/kref.h>
  29
  30 #define DLM_HB_NODE_DOWN_PRI     (0xf000000)
  31 #define DLM_HB_NODE_UP_PRI       (0x8000000)
  32
  33 #define DLM_LOCKID_NAME_MAX    32
  34
  35 #define DLM_DOMAIN_NAME_MAX_LEN    255
  36 #define DLM_LOCK_RES_OWNER_UNKNOWN     O2NM_MAX_NODES
  37 #define DLM_THREAD_SHUFFLE_INTERVAL    5     // flush everything every 5 passes
  38 #define DLM_THREAD_MS                  200   // flush at least every 200 ms
  39
  40 #define DLM_HASH_SIZE_DEFAULT   (1 << 14)
  41 #if DLM_HASH_SIZE_DEFAULT < PAGE_SIZE
  42 # define DLM_HASH_PAGES         1
  43 #else
  44 # define DLM_HASH_PAGES         (DLM_HASH_SIZE_DEFAULT / PAGE_SIZE)
  45 #endif
  46 #define DLM_BUCKETS_PER_PAGE    (PAGE_SIZE / sizeof(struct hlist_head))
  47 #define DLM_HASH_BUCKETS        (DLM_HASH_PAGES * DLM_BUCKETS_PER_PAGE)
  48
  49 /* Intended to make it easier for us to switch out hash functions */
  50 #define dlm_lockid_hash(_n, _l) full_name_hash(_n, _l)
  51
  52 enum dlm_ast_type {
  53         DLM_AST = 0,
  54         DLM_BAST,
  55         DLM_ASTUNLOCK
  56 };
  57
  58
  59 #define LKM_VALID_FLAGS (LKM_VALBLK | LKM_CONVERT | LKM_UNLOCK | \
  60                          LKM_CANCEL | LKM_INVVALBLK | LKM_FORCE | \
  61                          LKM_RECOVERY | LKM_LOCAL | LKM_NOQUEUE)
  62
  63 #define DLM_RECOVERY_LOCK_NAME       "$RECOVERY"
  64 #define DLM_RECOVERY_LOCK_NAME_LEN   9
  65
  66 static inline int dlm_is_recovery_lock(const char *lock_name, int name_len)
  67 {
  68         if (name_len == DLM_RECOVERY_LOCK_NAME_LEN &&
  69             memcmp(lock_name, DLM_RECOVERY_LOCK_NAME, name_len)==0)
  70                 return 1;
  71         return 0;
  72 }
  73
  74 #define DLM_RECO_STATE_ACTIVE    0x0001
  75 #define DLM_RECO_STATE_FINALIZE  0x0002
  76
  77 struct dlm_recovery_ctxt
  78 {
  79         struct list_head resources;
  80         struct list_head received;
  81         struct list_head node_data;
  82         u8  new_master;
  83         u8  dead_node;
  84         u16 state;
  85         unsigned long node_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
  86         wait_queue_head_t event;
  87 };
  88
  89 enum dlm_ctxt_state {
  90         DLM_CTXT_NEW = 0,
  91         DLM_CTXT_JOINED,
  92         DLM_CTXT_IN_SHUTDOWN,
  93         DLM_CTXT_LEAVING,
  94 };
  95
  96 struct dlm_ctxt
  97 {
  98         struct list_head list;
  99         struct hlist_head **lockres_hash;
 100         struct list_head dirty_list;
 101         struct list_head purge_list;
 102         struct list_head pending_asts;
 103         struct list_head pending_basts;
 104         struct list_head tracking_list;
 105         unsigned int purge_count;
 106         spinlock_t spinlock;
 107         spinlock_t ast_lock;
 108         char *name;
 109         u8 node_num;
 110         u32 key;
 111         u8  joining_node;
 112         wait_queue_head_t dlm_join_events;
 113         unsigned long live_nodes_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
 114         unsigned long domain_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
 115         unsigned long recovery_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
 116         struct dlm_recovery_ctxt reco;
 117         spinlock_t master_lock;
 118         struct list_head master_list;
 119         struct list_head mle_hb_events;
 120
 121         /* these give a really vague idea of the system load */
 122         atomic_t local_resources;
 123         atomic_t remote_resources;
 124         atomic_t unknown_resources;
 125
 126         struct dlm_debug_ctxt *dlm_debug_ctxt;
 127         struct dentry *dlm_debugfs_subroot;
 128
 129         /* NOTE: Next three are protected by dlm_domain_lock */
 130         struct kref dlm_refs;
 131         enum dlm_ctxt_state dlm_state;
 132         unsigned int num_joins;
 133
 134         struct o2hb_callback_func dlm_hb_up;
 135         struct o2hb_callback_func dlm_hb_down;
 136         struct task_struct *dlm_thread_task;
 137         struct task_struct *dlm_reco_thread_task;
 138         struct workqueue_struct *dlm_worker;
 139         wait_queue_head_t dlm_thread_wq;
 140         wait_queue_head_t dlm_reco_thread_wq;
 141         wait_queue_head_t ast_wq;
 142         wait_queue_head_t migration_wq;
 143
 144         struct work_struct dispatched_work;
 145         struct list_head work_list;
 146         spinlock_t work_lock;
 147         struct list_head dlm_domain_handlers;
 148         struct list_head        dlm_eviction_callbacks;
 149
 150         /* The filesystem specifies this at domain registration.  We
 151          * cache it here to know what to tell other nodes. */
 152         struct dlm_protocol_version fs_locking_proto;
 153         /* This is the inter-dlm communication version */
 154         struct dlm_protocol_version dlm_locking_proto;
 155 };
 156
 157 static inline struct hlist_head *dlm_lockres_hash(struct dlm_ctxt *dlm, unsigned i)
 158 {
 159         return dlm->lockres_hash[(i / DLM_BUCKETS_PER_PAGE) % DLM_HASH_PAGES] + (i % DLM_BUCKETS_PER_PAGE);
 160 }
 161
 162 /* these keventd work queue items are for less-frequently
 163  * called functions that cannot be directly called from the
 164  * net message handlers for some reason, usually because
 165  * they need to send net messages of their own. */
 166 void dlm_dispatch_work(struct work_struct *work);
 167
 168 struct dlm_lock_resource;
 169 struct dlm_work_item;
 170
 171 typedef void (dlm_workfunc_t)(struct dlm_work_item *, void *);
 172
 173 struct dlm_request_all_locks_priv
 174 {
 175         u8 reco_master;
 176         u8 dead_node;
 177 };
 178
 179 struct dlm_mig_lockres_priv
 180 {
 181         struct dlm_lock_resource *lockres;
 182         u8 real_master;
 183         u8 extra_ref;
 184 };
 185
 186 struct dlm_assert_master_priv
 187 {
 188         struct dlm_lock_resource *lockres;
 189         u8 request_from;
 190         u32 flags;
 191         unsigned ignore_higher:1;
 192 };
 193
 194 struct dlm_deref_lockres_priv
 195 {
 196         struct dlm_lock_resource *deref_res;
 197         u8 deref_node;
 198 };
 199
 200 struct dlm_work_item
 201 {
 202         struct list_head list;
 203         dlm_workfunc_t *func;
 204         struct dlm_ctxt *dlm;
 205         void *data;
 206         union {
 207                 struct dlm_request_all_locks_priv ral;
 208                 struct dlm_mig_lockres_priv ml;
 209                 struct dlm_assert_master_priv am;
 210                 struct dlm_deref_lockres_priv dl;
 211         } u;
 212 };
 213
 214 static inline void dlm_init_work_item(struct dlm_ctxt *dlm,
 215                                       struct dlm_work_item *i,
 216                                       dlm_workfunc_t *f, void *data)
 217 {
 218         memset(i, 0, sizeof(*i));
 219         i->func = f;
 220         INIT_LIST_HEAD(&i->list);
 221         i->data = data;
 222         i->dlm = dlm;  /* must have already done a dlm_grab on this! */
 223 }
 224
 225
 226
 227 static inline void __dlm_set_joining_node(struct dlm_ctxt *dlm,
 228                                           u8 node)
 229 {
 230         assert_spin_locked(&dlm->spinlock);
 231
 232         dlm->joining_node = node;
 233         wake_up(&dlm->dlm_join_events);
 234 }
 235
 236 #define DLM_LOCK_RES_UNINITED             0x00000001
 237 #define DLM_LOCK_RES_RECOVERING           0x00000002
 238 #define DLM_LOCK_RES_READY                0x00000004
 239 #define DLM_LOCK_RES_DIRTY                0x00000008
 240 #define DLM_LOCK_RES_IN_PROGRESS          0x00000010
 241 #define DLM_LOCK_RES_MIGRATING            0x00000020
 242 #define DLM_LOCK_RES_DROPPING_REF         0x00000040
 243 #define DLM_LOCK_RES_BLOCK_DIRTY          0x00001000
 244 #define DLM_LOCK_RES_SETREF_INPROG        0x00002000
 245
 246 /* max milliseconds to wait to sync up a network failure with a node death */
 247 #define DLM_NODE_DEATH_WAIT_MAX (5 * 1000)
 248
 249 #define DLM_PURGE_INTERVAL_MS   (8 * 1000)
 250
 251 struct dlm_lock_resource
 252 {
 253         /* WARNING: Please see the comment in dlm_init_lockres before
 254          * adding fields here. */
 255         struct hlist_node hash_node;
 256         struct qstr lockname;
 257         struct kref      refs;
 258
 259         /*
 260          * Please keep granted, converting, and blocked in this order,
 261          * as some funcs want to iterate over all lists.
 262          *
 263          * All four lists are protected by the hash's reference.
 264          */
 265         struct list_head granted;
 266         struct list_head converting;
 267         struct list_head blocked;
 268         struct list_head purge;
 269
 270         /*
 271          * These two lists require you to hold an additional reference
 272          * while they are on the list.
 273          */
 274         struct list_head dirty;
 275         struct list_head recovering; // dlm_recovery_ctxt.resources list
 276
 277         /* Added during init and removed during release */
 278         struct list_head tracking;      /* dlm->tracking_list */
 279
 280         /* unused lock resources have their last_used stamped and are
 281          * put on a list for the dlm thread to run. */
 282         unsigned long    last_used;
 283
 284         unsigned migration_pending:1;
 285         atomic_t asts_reserved;
 286         spinlock_t spinlock;
 287         wait_queue_head_t wq;
 288         u8  owner;              //node which owns the lock resource, or unknown
 289         u16 state;
 290         char lvb[DLM_LVB_LEN];
 291         unsigned int inflight_locks;
 292         unsigned long refmap[BITS_TO_LONGS(O2NM_MAX_NODES)];
 293 };
 294
 295 struct dlm_migratable_lock
 296 {
 297         __be64 cookie;
 298
 299         /* these 3 are just padding for the in-memory structure, but
 300          * list and flags are actually used when sent over the wire */
 301         __be16 pad1;
 302         u8 list;  // 0=granted, 1=converting, 2=blocked
 303         u8 flags;
 304
 305         s8 type;
 306         s8 convert_type;
 307         s8 highest_blocked;
 308         u8 node;
 309 };  // 16 bytes
 310
 311 struct dlm_lock
 312 {
 313         struct dlm_migratable_lock ml;
 314
 315         struct list_head list;
 316         struct list_head ast_list;
 317         struct list_head bast_list;
 318         struct dlm_lock_resource *lockres;
 319         spinlock_t spinlock;
 320         struct kref lock_refs;
 321
 322         // ast and bast must be callable while holding a spinlock!
 323         dlm_astlockfunc_t *ast;
 324         dlm_bastlockfunc_t *bast;
 325         void *astdata;
 326         struct dlm_lockstatus *lksb;
 327         unsigned ast_pending:1,
 328                  bast_pending:1,
 329                  convert_pending:1,
 330                  lock_pending:1,
 331                  cancel_pending:1,
 332                  unlock_pending:1,
 333                  lksb_kernel_allocated:1;
 334 };
 335
 336
 337 #define DLM_LKSB_UNUSED1           0x01
 338 #define DLM_LKSB_PUT_LVB           0x02
 339 #define DLM_LKSB_GET_LVB           0x04
 340 #define DLM_LKSB_UNUSED2           0x08
 341 #define DLM_LKSB_UNUSED3           0x10
 342 #define DLM_LKSB_UNUSED4           0x20
 343 #define DLM_LKSB_UNUSED5           0x40
 344 #define DLM_LKSB_UNUSED6           0x80
 345
 346
 347 enum dlm_lockres_list {
 348         DLM_GRANTED_LIST = 0,
 349         DLM_CONVERTING_LIST,
 350         DLM_BLOCKED_LIST
 351 };
 352
 353 static inline int dlm_lvb_is_empty(char *lvb)
 354 {
 355         int i;
 356         for (i=0; i<DLM_LVB_LEN; i++)
 357                 if (lvb[i])
 358                         return 0;
 359         return 1;
 360 }
 361
 362 static inline struct list_head *
 363 dlm_list_idx_to_ptr(struct dlm_lock_resource *res, enum dlm_lockres_list idx)
 364 {
 365         struct list_head *ret = NULL;
 366         if (idx == DLM_GRANTED_LIST)
 367                 ret = &res->granted;
 368         else if (idx == DLM_CONVERTING_LIST)
 369                 ret = &res->converting;
 370         else if (idx == DLM_BLOCKED_LIST)
 371                 ret = &res->blocked;
 372         else
 373                 BUG();
 374         return ret;
 375 }
 376
 377
 378
 379
 380 struct dlm_node_iter
 381 {
 382         unsigned long node_map[BITS_TO_LONGS(O2NM_MAX_NODES)];
 383         int curnode;
 384 };
 385
 386
 387 enum {
 388         DLM_MASTER_REQUEST_MSG    = 500,
 389         DLM_UNUSED_MSG1,         /* 501 */
 390         DLM_ASSERT_MASTER_MSG,   /* 502 */
 391         DLM_CREATE_LOCK_MSG,     /* 503 */
 392         DLM_CONVERT_LOCK_MSG,    /* 504 */
 393         DLM_PROXY_AST_MSG,       /* 505 */
 394         DLM_UNLOCK_LOCK_MSG,     /* 506 */
 395         DLM_DEREF_LOCKRES_MSG,   /* 507 */
 396         DLM_MIGRATE_REQUEST_MSG, /* 508 */
 397         DLM_MIG_LOCKRES_MSG,     /* 509 */
 398         DLM_QUERY_JOIN_MSG,      /* 510 */
 399         DLM_ASSERT_JOINED_MSG,   /* 511 */
 400         DLM_CANCEL_JOIN_MSG,     /* 512 */
 401         DLM_EXIT_DOMAIN_MSG,     /* 513 */
 402         DLM_MASTER_REQUERY_MSG,  /* 514 */
 403         DLM_LOCK_REQUEST_MSG,    /* 515 */
 404         DLM_RECO_DATA_DONE_MSG,  /* 516 */
 405         DLM_BEGIN_RECO_MSG,      /* 517 */
 406         DLM_FINALIZE_RECO_MSG    /* 518 */
 407 };
 408
 409 struct dlm_reco_node_data
 410 {
 411         int state;
 412         u8 node_num;
 413         struct list_head list;
 414 };
 415
 416 enum {
 417         DLM_RECO_NODE_DATA_DEAD = -1,
 418         DLM_RECO_NODE_DATA_INIT = 0,
 419         DLM_RECO_NODE_DATA_REQUESTING,
 420         DLM_RECO_NODE_DATA_REQUESTED,
 421         DLM_RECO_NODE_DATA_RECEIVING,
 422         DLM_RECO_NODE_DATA_DONE,
 423         DLM_RECO_NODE_DATA_FINALIZE_SENT,
 424 };
 425
 426
 427 enum {
 428         DLM_MASTER_RESP_NO = 0,
 429         DLM_MASTER_RESP_YES,
 430         DLM_MASTER_RESP_MAYBE,
 431         DLM_MASTER_RESP_ERROR
 432 };
 433
 434
 435 struct dlm_master_request
 436 {
 437         u8 node_idx;
 438         u8 namelen;
 439         __be16 pad1;
 440         __be32 flags;
 441
 442         u8 name[O2NM_MAX_NAME_LEN];
 443 };
 444
 445 #define DLM_ASSERT_RESPONSE_REASSERT       0x00000001
 446 #define DLM_ASSERT_RESPONSE_MASTERY_REF    0x00000002
 447
 448 #define DLM_ASSERT_MASTER_MLE_CLEANUP      0x00000001
 449 #define DLM_ASSERT_MASTER_REQUERY          0x00000002
 450 #define DLM_ASSERT_MASTER_FINISH_MIGRATION 0x00000004
 451 struct dlm_assert_master
 452 {
 453         u8 node_idx;
 454         u8 namelen;
 455         __be16 pad1;
 456         __be32 flags;
 457
 458         u8 name[O2NM_MAX_NAME_LEN];
 459 };
 460
 461 #define DLM_MIGRATE_RESPONSE_MASTERY_REF   0x00000001
 462
 463 struct dlm_migrate_request
 464 {
 465         u8 master;
 466         u8 new_master;
 467         u8 namelen;
 468         u8 pad1;
 469         __be32 pad2;
 470         u8 name[O2NM_MAX_NAME_LEN];
 471 };
 472
 473 struct dlm_master_requery
 474 {
 475         u8 pad1;
 476         u8 pad2;
 477         u8 node_idx;
 478         u8 namelen;
 479         __be32 pad3;
 480         u8 name[O2NM_MAX_NAME_LEN];
 481 };
 482
 483 #define DLM_MRES_RECOVERY   0x01
 484 #define DLM_MRES_MIGRATION  0x02
 485 #define DLM_MRES_ALL_DONE   0x04
 486
 487 /*
 488  * We would like to get one whole lockres into a single network
 489  * message whenever possible.  Generally speaking, there will be
 490  * at most one dlm_lock on a lockres for each node in the cluster,
 491  * plus (infrequently) any additional locks coming in from userdlm.
 492  *
 493  * struct _dlm_lockres_page
 494  * {
 495  *      dlm_migratable_lockres mres;
 496  *      dlm_migratable_lock ml[DLM_MAX_MIGRATABLE_LOCKS];
 497  *      u8 pad[DLM_MIG_LOCKRES_RESERVED];
 498  * };
 499  *
 500  * from ../cluster/tcp.h
 501  *    NET_MAX_PAYLOAD_BYTES  (4096 - sizeof(net_msg))
 502  *    (roughly 4080 bytes)
 503  * and sizeof(dlm_migratable_lockres) = 112 bytes
 504  * and sizeof(dlm_migratable_lock) = 16 bytes
 505  *
 506  * Choosing DLM_MAX_MIGRATABLE_LOCKS=240 and
 507  * DLM_MIG_LOCKRES_RESERVED=128 means we have this:
 508  *
 509  *  (DLM_MAX_MIGRATABLE_LOCKS * sizeof(dlm_migratable_lock)) +
 510  *     sizeof(dlm_migratable_lockres) + DLM_MIG_LOCKRES_RESERVED =
 511  *        NET_MAX_PAYLOAD_BYTES
 512  *  (240 * 16) + 112 + 128 = 4080
 513  *
 514  * So a lockres would need more than 240 locks before it would
 515  * use more than one network packet to recover.  Not too bad.
 516  */
 517 #define DLM_MAX_MIGRATABLE_LOCKS   240
 518
 519 struct dlm_migratable_lockres
 520 {
 521         u8 master;
 522         u8 lockname_len;
 523         u8 num_locks;    // locks sent in this structure
 524         u8 flags;
 525         __be32 total_locks; // locks to be sent for this migration cookie
 526         __be64 mig_cookie;  // cookie for this lockres migration
 527                          // or zero if not needed
 528         // 16 bytes
 529         u8 lockname[DLM_LOCKID_NAME_MAX];
 530         // 48 bytes
 531         u8 lvb[DLM_LVB_LEN];
 532         // 112 bytes
 533         struct dlm_migratable_lock ml[0];  // 16 bytes each, begins at byte 112
 534 };
 535 #define DLM_MIG_LOCKRES_MAX_LEN  \
 536         (sizeof(struct dlm_migratable_lockres) + \
 537          (sizeof(struct dlm_migratable_lock) * \
 538           DLM_MAX_MIGRATABLE_LOCKS) )
 539
 540 /* from above, 128 bytes
 541  * for some undetermined future use */
 542 #define DLM_MIG_LOCKRES_RESERVED   (NET_MAX_PAYLOAD_BYTES - \
 543                                     DLM_MIG_LOCKRES_MAX_LEN)
 544
 545 struct dlm_create_lock
 546 {
 547         __be64 cookie;
 548
 549         __be32 flags;
 550         u8 pad1;
 551         u8 node_idx;
 552         s8 requested_type;
 553         u8 namelen;
 554
 555         u8 name[O2NM_MAX_NAME_LEN];
 556 };
 557
 558 struct dlm_convert_lock
 559 {
 560         __be64 cookie;
 561
 562         __be32 flags;
 563         u8 pad1;
 564         u8 node_idx;
 565         s8 requested_type;
 566         u8 namelen;
 567
 568         u8 name[O2NM_MAX_NAME_LEN];
 569
 570         s8 lvb[0];
 571 };
 572 #define DLM_CONVERT_LOCK_MAX_LEN  (sizeof(struct dlm_convert_lock)+DLM_LVB_LEN)
 573
 574 struct dlm_unlock_lock
 575 {
 576         __be64 cookie;
 577
 578         __be32 flags;
 579         __be16 pad1;
 580         u8 node_idx;
 581         u8 namelen;
 582
 583         u8 name[O2NM_MAX_NAME_LEN];
 584
 585         s8 lvb[0];
 586 };
 587 #define DLM_UNLOCK_LOCK_MAX_LEN  (sizeof(struct dlm_unlock_lock)+DLM_LVB_LEN)
 588
 589 struct dlm_proxy_ast
 590 {
 591         __be64 cookie;
 592
 593         __be32 flags;
 594         u8 node_idx;
 595         u8 type;
 596         u8 blocked_type;
 597         u8 namelen;
 598
 599         u8 name[O2NM_MAX_NAME_LEN];
 600
 601         s8 lvb[0];
 602 };
 603 #define DLM_PROXY_AST_MAX_LEN  (sizeof(struct dlm_proxy_ast)+DLM_LVB_LEN)
 604
 605 #define DLM_MOD_KEY (0x666c6172)
 606 enum dlm_query_join_response_code {
 607         JOIN_DISALLOW = 0,
 608         JOIN_OK,
 609         JOIN_OK_NO_MAP,
 610         JOIN_PROTOCOL_MISMATCH,
 611 };
 612
 613 struct dlm_query_join_packet {
 614         u8 code;        /* Response code.  dlm_minor and fs_minor
 615                            are only valid if this is JOIN_OK */
 616         u8 dlm_minor;   /* The minor version of the protocol the
 617                            dlm is speaking. */
 618         u8 fs_minor;    /* The minor version of the protocol the
 619                            filesystem is speaking. */
 620         u8 reserved;
 621 };
 622
 623 union dlm_query_join_response {
 624         u32 intval;
 625         struct dlm_query_join_packet packet;
 626 };
 627
 628 struct dlm_lock_request
 629 {
 630         u8 node_idx;
 631         u8 dead_node;
 632         __be16 pad1;
 633         __be32 pad2;
 634 };
 635
 636 struct dlm_reco_data_done
 637 {
 638         u8 node_idx;
 639         u8 dead_node;
 640         __be16 pad1;
 641         __be32 pad2;
 642
 643         /* unused for now */
 644         /* eventually we can use this to attempt
 645          * lvb recovery based on each node's info */
 646         u8 reco_lvb[DLM_LVB_LEN];
 647 };
 648
 649 struct dlm_begin_reco
 650 {
 651         u8 node_idx;
 652         u8 dead_node;
 653         __be16 pad1;
 654         __be32 pad2;
 655 };
 656
 657
 658 #define BITS_PER_BYTE 8
 659 #define BITS_TO_BYTES(bits) (((bits)+BITS_PER_BYTE-1)/BITS_PER_BYTE)
 660
 661 struct dlm_query_join_request
 662 {
 663         u8 node_idx;
 664         u8 pad1[2];
 665         u8 name_len;
 666         struct dlm_protocol_version dlm_proto;
 667         struct dlm_protocol_version fs_proto;
 668         u8 domain[O2NM_MAX_NAME_LEN];
 669         u8 node_map[BITS_TO_BYTES(O2NM_MAX_NODES)];
 670 };
 671
 672 struct dlm_assert_joined
 673 {
 674         u8 node_idx;
 675         u8 pad1[2];
 676         u8 name_len;
 677         u8 domain[O2NM_MAX_NAME_LEN];
 678 };
 679
 680 struct dlm_cancel_join
 681 {
 682         u8 node_idx;
 683         u8 pad1[2];
 684         u8 name_len;
 685         u8 domain[O2NM_MAX_NAME_LEN];
 686 };
 687
 688 struct dlm_exit_domain
 689 {
 690         u8 node_idx;
 691         u8 pad1[3];
 692 };
 693
 694 struct dlm_finalize_reco
 695 {
 696         u8 node_idx;
 697         u8 dead_node;
 698         u8 flags;
 699         u8 pad1;
 700         __be32 pad2;
 701 };
 702
 703 struct dlm_deref_lockres
 704 {
 705         u32 pad1;
 706         u16 pad2;
 707         u8 node_idx;
 708         u8 namelen;
 709
 710         u8 name[O2NM_MAX_NAME_LEN];
 711 };
 712
 713 static inline enum dlm_status
 714 __dlm_lockres_state_to_status(struct dlm_lock_resource *res)
 715 {
 716         enum dlm_status status = DLM_NORMAL;
 717
 718         assert_spin_locked(&res->spinlock);
 719
 720         if (res->state & DLM_LOCK_RES_RECOVERING)
 721                 status = DLM_RECOVERING;
 722         else if (res->state & DLM_LOCK_RES_MIGRATING)
 723                 status = DLM_MIGRATING;
 724         else if (res->state & DLM_LOCK_RES_IN_PROGRESS)
 725                 status = DLM_FORWARD;
 726
 727         return status;
 728 }
 729
 730 static inline u8 dlm_get_lock_cookie_node(u64 cookie)
 731 {
 732         u8 ret;
 733         cookie >>= 56;
 734         ret = (u8)(cookie & 0xffULL);
 735         return ret;
 736 }
 737
 738 static inline unsigned long long dlm_get_lock_cookie_seq(u64 cookie)
 739 {
 740         unsigned long long ret;
 741         ret = ((unsigned long long)cookie) & 0x00ffffffffffffffULL;
 742         return ret;
 743 }
 744
 745 struct dlm_lock * dlm_new_lock(int type, u8 node, u64 cookie,
 746                                struct dlm_lockstatus *lksb);
 747 void dlm_lock_get(struct dlm_lock *lock);
 748 void dlm_lock_put(struct dlm_lock *lock);
 749
 750 void dlm_lock_attach_lockres(struct dlm_lock *lock,
 751                              struct dlm_lock_resource *res);
 752
 753 int dlm_create_lock_handler(struct o2net_msg *msg, u32 len, void *data,
 754                             void **ret_data);
 755 int dlm_convert_lock_handler(struct o2net_msg *msg, u32 len, void *data,
 756                              void **ret_data);
 757 int dlm_proxy_ast_handler(struct o2net_msg *msg, u32 len, void *data,
 758                           void **ret_data);
 759
 760 void dlm_revert_pending_convert(struct dlm_lock_resource *res,
 761                                 struct dlm_lock *lock);
 762 void dlm_revert_pending_lock(struct dlm_lock_resource *res,
 763                              struct dlm_lock *lock);
 764
 765 int dlm_unlock_lock_handler(struct o2net_msg *msg, u32 len, void *data,
 766                             void **ret_data);
 767 void dlm_commit_pending_cancel(struct dlm_lock_resource *res,
 768                                struct dlm_lock *lock);
 769 void dlm_commit_pending_unlock(struct dlm_lock_resource *res,
 770                                struct dlm_lock *lock);
 771
 772 int dlm_launch_thread(struct dlm_ctxt *dlm);
 773 void dlm_complete_thread(struct dlm_ctxt *dlm);
 774 int dlm_launch_recovery_thread(struct dlm_ctxt *dlm);
 775 void dlm_complete_recovery_thread(struct dlm_ctxt *dlm);
 776 void dlm_wait_for_recovery(struct dlm_ctxt *dlm);
 777 void dlm_kick_recovery_thread(struct dlm_ctxt *dlm);
 778 int dlm_is_node_dead(struct dlm_ctxt *dlm, u8 node);
 779 int dlm_wait_for_node_death(struct dlm_ctxt *dlm, u8 node, int timeout);
 780 int dlm_wait_for_node_recovery(struct dlm_ctxt *dlm, u8 node, int timeout);
 781
 782 void dlm_put(struct dlm_ctxt *dlm);
 783 struct dlm_ctxt *dlm_grab(struct dlm_ctxt *dlm);
 784 int dlm_domain_fully_joined(struct dlm_ctxt *dlm);
 785
 786 void __dlm_lockres_calc_usage(struct dlm_ctxt *dlm,
 787                               struct dlm_lock_resource *res);
 788 void dlm_lockres_calc_usage(struct dlm_ctxt *dlm,
 789                             struct dlm_lock_resource *res);
 790 static inline void dlm_lockres_get(struct dlm_lock_resource *res)
 791 {
 792         /* This is called on every lookup, so it might be worth
 793          * inlining. */
 794         kref_get(&res->refs);
 795 }
 796 void dlm_lockres_put(struct dlm_lock_resource *res);
 797 void __dlm_unhash_lockres(struct dlm_lock_resource *res);
 798 void __dlm_insert_lockres(struct dlm_ctxt *dlm,
 799                           struct dlm_lock_resource *res);
 800 struct dlm_lock_resource * __dlm_lookup_lockres_full(struct dlm_ctxt *dlm,
 801                                                      const char *name,
 802                                                      unsigned int len,
 803                                                      unsigned int hash);
 804 struct dlm_lock_resource * __dlm_lookup_lockres(struct dlm_ctxt *dlm,
 805                                                 const char *name,
 806                                                 unsigned int len,
 807                                                 unsigned int hash);
 808 struct dlm_lock_resource * dlm_lookup_lockres(struct dlm_ctxt *dlm,
 809                                               const char *name,
 810                                               unsigned int len);
 811
 812 int dlm_is_host_down(int errno);
 813 void dlm_change_lockres_owner(struct dlm_ctxt *dlm,
 814                               struct dlm_lock_resource *res,
 815                               u8 owner);
 816 struct dlm_lock_resource * dlm_get_lock_resource(struct dlm_ctxt *dlm,
 817                                                  const char *lockid,
 818                                                  int namelen,
 819                                                  int flags);
 820 struct dlm_lock_resource *dlm_new_lockres(struct dlm_ctxt *dlm,
 821                                           const char *name,
 822                                           unsigned int namelen);
 823
 824 #define dlm_lockres_set_refmap_bit(bit,res)  \
 825         __dlm_lockres_set_refmap_bit(bit,res,__FILE__,__LINE__)
 826 #define dlm_lockres_clear_refmap_bit(bit,res)  \
 827         __dlm_lockres_clear_refmap_bit(bit,res,__FILE__,__LINE__)
 828
 829 static inline void __dlm_lockres_set_refmap_bit(int bit,
 830                                                 struct dlm_lock_resource *res,
 831                                                 const char *file,
 832                                                 int line)
 833 {
 834         //printk("%s:%d:%.*s: setting bit %d\n", file, line,
 835         //     res->lockname.len, res->lockname.name, bit);
 836         set_bit(bit, res->refmap);
 837 }
 838
 839 static inline void __dlm_lockres_clear_refmap_bit(int bit,
 840                                                   struct dlm_lock_resource *res,
 841                                                   const char *file,
 842                                                   int line)
 843 {
 844         //printk("%s:%d:%.*s: clearing bit %d\n", file, line,
 845         //     res->lockname.len, res->lockname.name, bit);
 846         clear_bit(bit, res->refmap);
 847 }
 848
 849 void __dlm_lockres_drop_inflight_ref(struct dlm_ctxt *dlm,
 850                                    struct dlm_lock_resource *res,
 851                                    const char *file,
 852                                    int line);
 853 void __dlm_lockres_grab_inflight_ref(struct dlm_ctxt *dlm,
 854                                    struct dlm_lock_resource *res,
 855                                    int new_lockres,
 856                                    const char *file,
 857                                    int line);
 858 #define dlm_lockres_drop_inflight_ref(d,r)  \
 859         __dlm_lockres_drop_inflight_ref(d,r,__FILE__,__LINE__)
 860 #define dlm_lockres_grab_inflight_ref(d,r)  \
 861         __dlm_lockres_grab_inflight_ref(d,r,0,__FILE__,__LINE__)
 862 #define dlm_lockres_grab_inflight_ref_new(d,r)  \
 863         __dlm_lockres_grab_inflight_ref(d,r,1,__FILE__,__LINE__)
 864
 865 void dlm_queue_ast(struct dlm_ctxt *dlm, struct dlm_lock *lock);
 866 void dlm_queue_bast(struct dlm_ctxt *dlm, struct dlm_lock *lock);
 867 void dlm_do_local_ast(struct dlm_ctxt *dlm,
 868                       struct dlm_lock_resource *res,
 869                       struct dlm_lock *lock);
 870 int dlm_do_remote_ast(struct dlm_ctxt *dlm,
 871                       struct dlm_lock_resource *res,
 872                       struct dlm_lock *lock);
 873 void dlm_do_local_bast(struct dlm_ctxt *dlm,
 874                        struct dlm_lock_resource *res,
 875                        struct dlm_lock *lock,
 876                        int blocked_type);
 877 int dlm_send_proxy_ast_msg(struct dlm_ctxt *dlm,
 878                            struct dlm_lock_resource *res,
 879                            struct dlm_lock *lock,
 880                            int msg_type,
 881                            int blocked_type, int flags);
 882 static inline int dlm_send_proxy_bast(struct dlm_ctxt *dlm,
 883                                       struct dlm_lock_resource *res,
 884                                       struct dlm_lock *lock,
 885                                       int blocked_type)
 886 {
 887         return dlm_send_proxy_ast_msg(dlm, res, lock, DLM_BAST,
 888                                       blocked_type, 0);
 889 }
 890
 891 static inline int dlm_send_proxy_ast(struct dlm_ctxt *dlm,
 892                                      struct dlm_lock_resource *res,
 893                                      struct dlm_lock *lock,
 894                                      int flags)
 895 {
 896         return dlm_send_proxy_ast_msg(dlm, res, lock, DLM_AST,
 897                                       0, flags);
 898 }
 899
 900 void dlm_print_one_lock_resource(struct dlm_lock_resource *res);
 901 void __dlm_print_one_lock_resource(struct dlm_lock_resource *res);
 902
 903 u8 dlm_nm_this_node(struct dlm_ctxt *dlm);
 904 void dlm_kick_thread(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
 905 void __dlm_dirty_lockres(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
 906
 907
 908 int dlm_nm_init(struct dlm_ctxt *dlm);
 909 int dlm_heartbeat_init(struct dlm_ctxt *dlm);
 910 void dlm_hb_node_down_cb(struct o2nm_node *node, int idx, void *data);
 911 void dlm_hb_node_up_cb(struct o2nm_node *node, int idx, void *data);
 912
 913 int dlm_empty_lockres(struct dlm_ctxt *dlm, struct dlm_lock_resource *res);
 914 int dlm_finish_migration(struct dlm_ctxt *dlm,
 915                          struct dlm_lock_resource *res,
 916                          u8 old_master);
 917 void dlm_lockres_release_ast(struct dlm_ctxt *dlm,
 918                              struct dlm_lock_resource *res);
 919 void __dlm_lockres_reserve_ast(struct dlm_lock_resource *res);
 920
 921 int dlm_master_request_handler(struct o2net_msg *msg, u32 len, void *data,
 922                                void **ret_data);
 923 int dlm_assert_master_handler(struct o2net_msg *msg, u32 len, void *data,
 924                               void **ret_data);
 925 void dlm_assert_master_post_handler(int status, void *data, void *ret_data);
 926 int dlm_deref_lockres_handler(struct o2net_msg *msg, u32 len, void *data,
 927                               void **ret_data);
 928 int dlm_migrate_request_handler(struct o2net_msg *msg, u32 len, void *data,
 929                                 void **ret_data);
 930 int dlm_mig_lockres_handler(struct o2net_msg *msg, u32 len, void *data,
 931                             void **ret_data);
 932 int dlm_master_requery_handler(struct o2net_msg *msg, u32 len, void *data,
 933                                void **ret_data);
 934 int dlm_request_all_locks_handler(struct o2net_msg *msg, u32 len, void *data,
 935                                   void **ret_data);
 936 int dlm_reco_data_done_handler(struct o2net_msg *msg, u32 len, void *data,
 937                                void **ret_data);
 938 int dlm_begin_reco_handler(struct o2net_msg *msg, u32 len, void *data,
 939                            void **ret_data);
 940 int dlm_finalize_reco_handler(struct o2net_msg *msg, u32 len, void *data,
 941                               void **ret_data);
 942 int dlm_do_master_requery(struct dlm_ctxt *dlm, struct dlm_lock_resource *res,
 943                           u8 nodenum, u8 *real_master);
 944
 945
 946 int dlm_dispatch_assert_master(struct dlm_ctxt *dlm,
 947                                struct dlm_lock_resource *res,
 948                                int ignore_higher,
 949                                u8 request_from,
 950                                u32 flags);
 951
 952
 953 int dlm_send_one_lockres(struct dlm_ctxt *dlm,
 954                          struct dlm_lock_resource *res,
 955                          struct dlm_migratable_lockres *mres,
 956                          u8 send_to,
 957                          u8 flags);
 958 void dlm_move_lockres_to_recovery_list(struct dlm_ctxt *dlm,
 959                                        struct dlm_lock_resource *res);
 960
 961 /* will exit holding res->spinlock, but may drop in function */
 962 void __dlm_wait_on_lockres_flags(struct dlm_lock_resource *res, int flags);
 963 void __dlm_wait_on_lockres_flags_set(struct dlm_lock_resource *res, int flags);
 964
 965 /* will exit holding res->spinlock, but may drop in function */
 966 static inline void __dlm_wait_on_lockres(struct dlm_lock_resource *res)
 967 {
 968         __dlm_wait_on_lockres_flags(res, (DLM_LOCK_RES_IN_PROGRESS|
 969                                           DLM_LOCK_RES_RECOVERING|
 970                                           DLM_LOCK_RES_MIGRATING));
 971 }
 972
 973 /* create/destroy slab caches */
 974 int dlm_init_master_caches(void);
 975 void dlm_destroy_master_caches(void);
 976
 977 int dlm_init_lock_cache(void);
 978 void dlm_destroy_lock_cache(void);
 979
 980 int dlm_init_mle_cache(void);
 981 void dlm_destroy_mle_cache(void);
 982
 983 void dlm_hb_event_notify_attached(struct dlm_ctxt *dlm, int idx, int node_up);
 984 int dlm_drop_lockres_ref(struct dlm_ctxt *dlm,
 985                          struct dlm_lock_resource *res);
 986 void dlm_clean_master_list(struct dlm_ctxt *dlm,
 987                            u8 dead_node);
 988 int dlm_lock_basts_flushed(struct dlm_ctxt *dlm, struct dlm_lock *lock);
 989 int __dlm_lockres_has_locks(struct dlm_lock_resource *res);
 990 int __dlm_lockres_unused(struct dlm_lock_resource *res);
 991
 992 static inline const char * dlm_lock_mode_name(int mode)
 993 {
 994         switch (mode) {
 995                 case LKM_EXMODE:
 996                         return "EX";
 997                 case LKM_PRMODE:
 998                         return "PR";
 999                 case LKM_NLMODE:
1000                         return "NL";
1001         }
1002         return "UNKNOWN";
1003 }
1004
1005
1006 static inline int dlm_lock_compatible(int existing, int request)
1007 {
1008         /* NO_LOCK compatible with all */
1009         if (request == LKM_NLMODE ||
1010             existing == LKM_NLMODE)
1011                 return 1;
1012
1013         /* EX incompatible with all non-NO_LOCK */
1014         if (request == LKM_EXMODE)
1015                 return 0;
1016
1017         /* request must be PR, which is compatible with PR */
1018         if (existing == LKM_PRMODE)
1019                 return 1;
1020
1021         return 0;
1022 }
1023
1024 static inline int dlm_lock_on_list(struct list_head *head,
1025                                    struct dlm_lock *lock)
1026 {
1027         struct list_head *iter;
1028         struct dlm_lock *tmplock;
1029
1030         list_for_each(iter, head) {
1031                 tmplock = list_entry(iter, struct dlm_lock, list);
1032                 if (tmplock == lock)
1033                         return 1;
1034         }
1035         return 0;
1036 }
1037
1038
1039 static inline enum dlm_status dlm_err_to_dlm_status(int err)
1040 {
1041         enum dlm_status ret;
1042         if (err == -ENOMEM)
1043                 ret = DLM_SYSERR;
1044         else if (err == -ETIMEDOUT || o2net_link_down(err, NULL))
1045                 ret = DLM_NOLOCKMGR;
1046         else if (err == -EINVAL)
1047                 ret = DLM_BADPARAM;
1048         else if (err == -ENAMETOOLONG)
1049                 ret = DLM_IVBUFLEN;
1050         else
1051                 ret = DLM_BADARGS;
1052         return ret;
1053 }
1054
1055
1056 static inline void dlm_node_iter_init(unsigned long *map,
1057                                       struct dlm_node_iter *iter)
1058 {
1059         memcpy(iter->node_map, map, sizeof(iter->node_map));
1060         iter->curnode = -1;
1061 }
1062
1063 static inline int dlm_node_iter_next(struct dlm_node_iter *iter)
1064 {
1065         int bit;
1066         bit = find_next_bit(iter->node_map, O2NM_MAX_NODES, iter->curnode+1);
1067         if (bit >= O2NM_MAX_NODES) {
1068                 iter->curnode = O2NM_MAX_NODES;
1069                 return -ENOENT;
1070         }
1071         iter->curnode = bit;
1072         return bit;
1073 }
1074
1075
1076
1077 #endif /* DLMCOMMON_H */