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