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