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