fs/dlm/dlm_internal.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /******************************************************************************
   3 *******************************************************************************
   4 **
   5 **  Copyright (C) Sistina Software, Inc.  1997-2003  All rights reserved.
   6 **  Copyright (C) 2004-2011 Red Hat, Inc.  All rights reserved.
   7 **
   8 **
   9 *******************************************************************************
  10 ******************************************************************************/
  11
  12 #ifndef __DLM_INTERNAL_DOT_H__
  13 #define __DLM_INTERNAL_DOT_H__
  14
  15 /*
  16  * This is the main header file to be included in each DLM source file.
  17  */
  18
  19 #include <linux/slab.h>
  20 #include <linux/sched.h>
  21 #include <linux/types.h>
  22 #include <linux/ctype.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/vmalloc.h>
  25 #include <linux/list.h>
  26 #include <linux/errno.h>
  27 #include <linux/random.h>
  28 #include <linux/delay.h>
  29 #include <linux/socket.h>
  30 #include <linux/kthread.h>
  31 #include <linux/kobject.h>
  32 #include <linux/kref.h>
  33 #include <linux/kernel.h>
  34 #include <linux/jhash.h>
  35 #include <linux/miscdevice.h>
  36 #include <linux/mutex.h>
  37 #include <linux/idr.h>
  38 #include <linux/ratelimit.h>
  39 #include <linux/uaccess.h>
  40
  41 #include <linux/dlm.h>
  42 #include "config.h"
  43
  44 /* Size of the temp buffer midcomms allocates on the stack.
  45    We try to make this large enough so most messages fit.
  46    FIXME: should sctp make this unnecessary? */
  47
  48 #define DLM_INBUF_LEN           148
  49
  50 struct dlm_ls;
  51 struct dlm_lkb;
  52 struct dlm_rsb;
  53 struct dlm_member;
  54 struct dlm_rsbtable;
  55 struct dlm_recover;
  56 struct dlm_header;
  57 struct dlm_message;
  58 struct dlm_rcom;
  59 struct dlm_mhandle;
  60
  61 #define log_print(fmt, args...) \
  62         printk(KERN_ERR "dlm: "fmt"\n" , ##args)
  63 #define log_error(ls, fmt, args...) \
  64         printk(KERN_ERR "dlm: %s: " fmt "\n", (ls)->ls_name , ##args)
  65
  66 #define log_rinfo(ls, fmt, args...) \
  67 do { \
  68         if (dlm_config.ci_log_info) \
  69                 printk(KERN_INFO "dlm: %s: " fmt "\n", \
  70                         (ls)->ls_name, ##args); \
  71         else if (dlm_config.ci_log_debug) \
  72                 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
  73                        (ls)->ls_name , ##args); \
  74 } while (0)
  75
  76 #define log_debug(ls, fmt, args...) \
  77 do { \
  78         if (dlm_config.ci_log_debug) \
  79                 printk(KERN_DEBUG "dlm: %s: " fmt "\n", \
  80                        (ls)->ls_name , ##args); \
  81 } while (0)
  82
  83 #define log_limit(ls, fmt, args...) \
  84 do { \
  85         if (dlm_config.ci_log_debug) \
  86                 printk_ratelimited(KERN_DEBUG "dlm: %s: " fmt "\n", \
  87                         (ls)->ls_name , ##args); \
  88 } while (0)
  89
  90 #define DLM_ASSERT(x, do) \
  91 { \
  92   if (!(x)) \
  93   { \
  94     printk(KERN_ERR "\nDLM:  Assertion failed on line %d of file %s\n" \
  95                "DLM:  assertion:  \"%s\"\n" \
  96                "DLM:  time = %lu\n", \
  97                __LINE__, __FILE__, #x, jiffies); \
  98     {do} \
  99     printk("\n"); \
 100     panic("DLM:  Record message above and reboot.\n"); \
 101   } \
 102 }
 103
 104
 105 #define DLM_RTF_SHRINK          0x00000001
 106
 107 struct dlm_rsbtable {
 108         struct rb_root          keep;
 109         struct rb_root          toss;
 110         spinlock_t              lock;
 111         uint32_t                flags;
 112 };
 113
 114
 115 /*
 116  * Lockspace member (per node in a ls)
 117  */
 118
 119 struct dlm_member {
 120         struct list_head        list;
 121         int                     nodeid;
 122         int                     weight;
 123         int                     slot;
 124         int                     slot_prev;
 125         int                     comm_seq;
 126         uint32_t                generation;
 127 };
 128
 129 /*
 130  * Save and manage recovery state for a lockspace.
 131  */
 132
 133 struct dlm_recover {
 134         struct list_head        list;
 135         struct dlm_config_node  *nodes;
 136         int                     nodes_count;
 137         uint64_t                seq;
 138 };
 139
 140 /*
 141  * Pass input args to second stage locking function.
 142  */
 143
 144 struct dlm_args {
 145         uint32_t                flags;
 146         void                    (*astfn) (void *astparam);
 147         void                    *astparam;
 148         void                    (*bastfn) (void *astparam, int mode);
 149         int                     mode;
 150         struct dlm_lksb         *lksb;
 151         unsigned long           timeout;
 152 };
 153
 154
 155 /*
 156  * Lock block
 157  *
 158  * A lock can be one of three types:
 159  *
 160  * local copy      lock is mastered locally
 161  *                 (lkb_nodeid is zero and DLM_LKF_MSTCPY is not set)
 162  * process copy    lock is mastered on a remote node
 163  *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is not set)
 164  * master copy     master node's copy of a lock owned by remote node
 165  *                 (lkb_nodeid is non-zero and DLM_LKF_MSTCPY is set)
 166  *
 167  * lkb_exflags: a copy of the most recent flags arg provided to dlm_lock or
 168  * dlm_unlock.  The dlm does not modify these or use any private flags in
 169  * this field; it only contains DLM_LKF_ flags from dlm.h.  These flags
 170  * are sent as-is to the remote master when the lock is remote.
 171  *
 172  * lkb_flags: internal dlm flags (DLM_IFL_ prefix) from dlm_internal.h.
 173  * Some internal flags are shared between the master and process nodes;
 174  * these shared flags are kept in the lower two bytes.  One of these
 175  * flags set on the master copy will be propagated to the process copy
 176  * and v.v.  Other internal flags are private to the master or process
 177  * node (e.g. DLM_IFL_MSTCPY).  These are kept in the high two bytes.
 178  *
 179  * lkb_sbflags: status block flags.  These flags are copied directly into
 180  * the caller's lksb.sb_flags prior to the dlm_lock/dlm_unlock completion
 181  * ast.  All defined in dlm.h with DLM_SBF_ prefix.
 182  *
 183  * lkb_status: the lock status indicates which rsb queue the lock is
 184  * on, grant, convert, or wait.  DLM_LKSTS_ WAITING/GRANTED/CONVERT
 185  *
 186  * lkb_wait_type: the dlm message type (DLM_MSG_ prefix) for which a
 187  * reply is needed.  Only set when the lkb is on the lockspace waiters
 188  * list awaiting a reply from a remote node.
 189  *
 190  * lkb_nodeid: when the lkb is a local copy, nodeid is 0; when the lkb
 191  * is a master copy, nodeid specifies the remote lock holder, when the
 192  * lkb is a process copy, the nodeid specifies the lock master.
 193  */
 194
 195 /* lkb_status */
 196
 197 #define DLM_LKSTS_WAITING       1
 198 #define DLM_LKSTS_GRANTED       2
 199 #define DLM_LKSTS_CONVERT       3
 200
 201 /* lkb_flags */
 202
 203 #define DLM_IFL_MSTCPY          0x00010000
 204 #define DLM_IFL_RESEND          0x00020000
 205 #define DLM_IFL_DEAD            0x00040000
 206 #define DLM_IFL_OVERLAP_UNLOCK  0x00080000
 207 #define DLM_IFL_OVERLAP_CANCEL  0x00100000
 208 #define DLM_IFL_ENDOFLIFE       0x00200000
 209 #define DLM_IFL_WATCH_TIMEWARN  0x00400000
 210 #define DLM_IFL_TIMEOUT_CANCEL  0x00800000
 211 #define DLM_IFL_DEADLOCK_CANCEL 0x01000000
 212 #define DLM_IFL_STUB_MS         0x02000000 /* magic number for m_flags */
 213 #define DLM_IFL_USER            0x00000001
 214 #define DLM_IFL_ORPHAN          0x00000002
 215
 216 #define DLM_CALLBACKS_SIZE      6
 217
 218 #define DLM_CB_CAST             0x00000001
 219 #define DLM_CB_BAST             0x00000002
 220 #define DLM_CB_SKIP             0x00000004
 221
 222 struct dlm_callback {
 223         uint64_t                seq;
 224         uint32_t                flags;          /* DLM_CBF_ */
 225         int                     sb_status;      /* copy to lksb status */
 226         uint8_t                 sb_flags;       /* copy to lksb flags */
 227         int8_t                  mode; /* rq mode of bast, gr mode of cast */
 228 };
 229
 230 struct dlm_lkb {
 231         struct dlm_rsb          *lkb_resource;  /* the rsb */
 232         struct kref             lkb_ref;
 233         int                     lkb_nodeid;     /* copied from rsb */
 234         int                     lkb_ownpid;     /* pid of lock owner */
 235         uint32_t                lkb_id;         /* our lock ID */
 236         uint32_t                lkb_remid;      /* lock ID on remote partner */
 237         uint32_t                lkb_exflags;    /* external flags from caller */
 238         uint32_t                lkb_sbflags;    /* lksb flags */
 239         uint32_t                lkb_flags;      /* internal flags */
 240         uint32_t                lkb_lvbseq;     /* lvb sequence number */
 241
 242         int8_t                  lkb_status;     /* granted, waiting, convert */
 243         int8_t                  lkb_rqmode;     /* requested lock mode */
 244         int8_t                  lkb_grmode;     /* granted lock mode */
 245         int8_t                  lkb_highbast;   /* highest mode bast sent for */
 246
 247         int8_t                  lkb_wait_type;  /* type of reply waiting for */
 248         int8_t                  lkb_wait_count;
 249         int                     lkb_wait_nodeid; /* for debugging */
 250
 251         struct list_head        lkb_statequeue; /* rsb g/c/w list */
 252         struct list_head        lkb_rsb_lookup; /* waiting for rsb lookup */
 253         struct list_head        lkb_wait_reply; /* waiting for remote reply */
 254         struct list_head        lkb_ownqueue;   /* list of locks for a process */
 255         struct list_head        lkb_time_list;
 256         ktime_t                 lkb_timestamp;
 257         ktime_t                 lkb_wait_time;
 258         unsigned long           lkb_timeout_cs;
 259
 260         struct mutex            lkb_cb_mutex;
 261         struct work_struct      lkb_cb_work;
 262         struct list_head        lkb_cb_list; /* for ls_cb_delay or proc->asts */
 263         struct dlm_callback     lkb_callbacks[DLM_CALLBACKS_SIZE];
 264         struct dlm_callback     lkb_last_cast;
 265         struct dlm_callback     lkb_last_bast;
 266         ktime_t                 lkb_last_cast_time;     /* for debugging */
 267         ktime_t                 lkb_last_bast_time;     /* for debugging */
 268
 269         uint64_t                lkb_recover_seq; /* from ls_recover_seq */
 270
 271         char                    *lkb_lvbptr;
 272         struct dlm_lksb         *lkb_lksb;      /* caller's status block */
 273         void                    (*lkb_astfn) (void *astparam);
 274         void                    (*lkb_bastfn) (void *astparam, int mode);
 275         union {
 276                 void                    *lkb_astparam;  /* caller's ast arg */
 277                 struct dlm_user_args    *lkb_ua;
 278         };
 279 };
 280
 281 /*
 282  * res_master_nodeid is "normal": 0 is unset/invalid, non-zero is the real
 283  * nodeid, even when nodeid is our_nodeid.
 284  *
 285  * res_nodeid is "odd": -1 is unset/invalid, zero means our_nodeid,
 286  * greater than zero when another nodeid.
 287  *
 288  * (TODO: remove res_nodeid and only use res_master_nodeid)
 289  */
 290
 291 struct dlm_rsb {
 292         struct dlm_ls           *res_ls;        /* the lockspace */
 293         struct kref             res_ref;
 294         struct mutex            res_mutex;
 295         unsigned long           res_flags;
 296         int                     res_length;     /* length of rsb name */
 297         int                     res_nodeid;
 298         int                     res_master_nodeid;
 299         int                     res_dir_nodeid;
 300         int                     res_id;         /* for ls_recover_idr */
 301         uint32_t                res_lvbseq;
 302         uint32_t                res_hash;
 303         uint32_t                res_bucket;     /* rsbtbl */
 304         unsigned long           res_toss_time;
 305         uint32_t                res_first_lkid;
 306         struct list_head        res_lookup;     /* lkbs waiting on first */
 307         union {
 308                 struct list_head        res_hashchain;
 309                 struct rb_node          res_hashnode;   /* rsbtbl */
 310         };
 311         struct list_head        res_grantqueue;
 312         struct list_head        res_convertqueue;
 313         struct list_head        res_waitqueue;
 314
 315         struct list_head        res_root_list;      /* used for recovery */
 316         struct list_head        res_recover_list;   /* used for recovery */
 317         int                     res_recover_locks_count;
 318
 319         char                    *res_lvbptr;
 320         char                    res_name[DLM_RESNAME_MAXLEN+1];
 321 };
 322
 323 /* dlm_master_lookup() flags */
 324
 325 #define DLM_LU_RECOVER_DIR      1
 326 #define DLM_LU_RECOVER_MASTER   2
 327
 328 /* dlm_master_lookup() results */
 329
 330 #define DLM_LU_MATCH            1
 331 #define DLM_LU_ADD              2
 332
 333 /* find_rsb() flags */
 334
 335 #define R_REQUEST               0x00000001
 336 #define R_RECEIVE_REQUEST       0x00000002
 337 #define R_RECEIVE_RECOVER       0x00000004
 338
 339 /* rsb_flags */
 340
 341 enum rsb_flags {
 342         RSB_MASTER_UNCERTAIN,
 343         RSB_VALNOTVALID,
 344         RSB_VALNOTVALID_PREV,
 345         RSB_NEW_MASTER,
 346         RSB_NEW_MASTER2,
 347         RSB_RECOVER_CONVERT,
 348         RSB_RECOVER_GRANT,
 349         RSB_RECOVER_LVB_INVAL,
 350 };
 351
 352 static inline void rsb_set_flag(struct dlm_rsb *r, enum rsb_flags flag)
 353 {
 354         __set_bit(flag, &r->res_flags);
 355 }
 356
 357 static inline void rsb_clear_flag(struct dlm_rsb *r, enum rsb_flags flag)
 358 {
 359         __clear_bit(flag, &r->res_flags);
 360 }
 361
 362 static inline int rsb_flag(struct dlm_rsb *r, enum rsb_flags flag)
 363 {
 364         return test_bit(flag, &r->res_flags);
 365 }
 366
 367
 368 /* dlm_header is first element of all structs sent between nodes */
 369
 370 #define DLM_HEADER_MAJOR        0x00030000
 371 #define DLM_HEADER_MINOR        0x00000001
 372
 373 #define DLM_HEADER_SLOTS        0x00000001
 374
 375 #define DLM_MSG                 1
 376 #define DLM_RCOM                2
 377
 378 struct dlm_header {
 379         uint32_t                h_version;
 380         uint32_t                h_lockspace;
 381         uint32_t                h_nodeid;       /* nodeid of sender */
 382         uint16_t                h_length;
 383         uint8_t                 h_cmd;          /* DLM_MSG, DLM_RCOM */
 384         uint8_t                 h_pad;
 385 };
 386
 387
 388 #define DLM_MSG_REQUEST         1
 389 #define DLM_MSG_CONVERT         2
 390 #define DLM_MSG_UNLOCK          3
 391 #define DLM_MSG_CANCEL          4
 392 #define DLM_MSG_REQUEST_REPLY   5
 393 #define DLM_MSG_CONVERT_REPLY   6
 394 #define DLM_MSG_UNLOCK_REPLY    7
 395 #define DLM_MSG_CANCEL_REPLY    8
 396 #define DLM_MSG_GRANT           9
 397 #define DLM_MSG_BAST            10
 398 #define DLM_MSG_LOOKUP          11
 399 #define DLM_MSG_REMOVE          12
 400 #define DLM_MSG_LOOKUP_REPLY    13
 401 #define DLM_MSG_PURGE           14
 402
 403 struct dlm_message {
 404         struct dlm_header       m_header;
 405         uint32_t                m_type;         /* DLM_MSG_ */
 406         uint32_t                m_nodeid;
 407         uint32_t                m_pid;
 408         uint32_t                m_lkid;         /* lkid on sender */
 409         uint32_t                m_remid;        /* lkid on receiver */
 410         uint32_t                m_parent_lkid;
 411         uint32_t                m_parent_remid;
 412         uint32_t                m_exflags;
 413         uint32_t                m_sbflags;
 414         uint32_t                m_flags;
 415         uint32_t                m_lvbseq;
 416         uint32_t                m_hash;
 417         int                     m_status;
 418         int                     m_grmode;
 419         int                     m_rqmode;
 420         int                     m_bastmode;
 421         int                     m_asts;
 422         int                     m_result;       /* 0 or -EXXX */
 423         char                    m_extra[];      /* name or lvb */
 424 };
 425
 426
 427 #define DLM_RS_NODES            0x00000001
 428 #define DLM_RS_NODES_ALL        0x00000002
 429 #define DLM_RS_DIR              0x00000004
 430 #define DLM_RS_DIR_ALL          0x00000008
 431 #define DLM_RS_LOCKS            0x00000010
 432 #define DLM_RS_LOCKS_ALL        0x00000020
 433 #define DLM_RS_DONE             0x00000040
 434 #define DLM_RS_DONE_ALL         0x00000080
 435
 436 #define DLM_RCOM_STATUS         1
 437 #define DLM_RCOM_NAMES          2
 438 #define DLM_RCOM_LOOKUP         3
 439 #define DLM_RCOM_LOCK           4
 440 #define DLM_RCOM_STATUS_REPLY   5
 441 #define DLM_RCOM_NAMES_REPLY    6
 442 #define DLM_RCOM_LOOKUP_REPLY   7
 443 #define DLM_RCOM_LOCK_REPLY     8
 444
 445 struct dlm_rcom {
 446         struct dlm_header       rc_header;
 447         uint32_t                rc_type;        /* DLM_RCOM_ */
 448         int                     rc_result;      /* multi-purpose */
 449         uint64_t                rc_id;          /* match reply with request */
 450         uint64_t                rc_seq;         /* sender's ls_recover_seq */
 451         uint64_t                rc_seq_reply;   /* remote ls_recover_seq */
 452         char                    rc_buf[];
 453 };
 454
 455 union dlm_packet {
 456         struct dlm_header       header;         /* common to other two */
 457         struct dlm_message      message;
 458         struct dlm_rcom         rcom;
 459 };
 460
 461 #define DLM_RSF_NEED_SLOTS      0x00000001
 462
 463 /* RCOM_STATUS data */
 464 struct rcom_status {
 465         __le32                  rs_flags;
 466         __le32                  rs_unused1;
 467         __le64                  rs_unused2;
 468 };
 469
 470 /* RCOM_STATUS_REPLY data */
 471 struct rcom_config {
 472         __le32                  rf_lvblen;
 473         __le32                  rf_lsflags;
 474
 475         /* DLM_HEADER_SLOTS adds: */
 476         __le32                  rf_flags;
 477         __le16                  rf_our_slot;
 478         __le16                  rf_num_slots;
 479         __le32                  rf_generation;
 480         __le32                  rf_unused1;
 481         __le64                  rf_unused2;
 482 };
 483
 484 struct rcom_slot {
 485         __le32                  ro_nodeid;
 486         __le16                  ro_slot;
 487         __le16                  ro_unused1;
 488         __le64                  ro_unused2;
 489 };
 490
 491 struct rcom_lock {
 492         __le32                  rl_ownpid;
 493         __le32                  rl_lkid;
 494         __le32                  rl_remid;
 495         __le32                  rl_parent_lkid;
 496         __le32                  rl_parent_remid;
 497         __le32                  rl_exflags;
 498         __le32                  rl_flags;
 499         __le32                  rl_lvbseq;
 500         __le32                  rl_result;
 501         int8_t                  rl_rqmode;
 502         int8_t                  rl_grmode;
 503         int8_t                  rl_status;
 504         int8_t                  rl_asts;
 505         __le16                  rl_wait_type;
 506         __le16                  rl_namelen;
 507         char                    rl_name[DLM_RESNAME_MAXLEN];
 508         char                    rl_lvb[];
 509 };
 510
 511 /*
 512  * The max number of resources per rsbtbl bucket that shrink will attempt
 513  * to remove in each iteration.
 514  */
 515
 516 #define DLM_REMOVE_NAMES_MAX 8
 517
 518 struct dlm_ls {
 519         struct list_head        ls_list;        /* list of lockspaces */
 520         dlm_lockspace_t         *ls_local_handle;
 521         uint32_t                ls_global_id;   /* global unique lockspace ID */
 522         uint32_t                ls_generation;
 523         uint32_t                ls_exflags;
 524         int                     ls_lvblen;
 525         int                     ls_count;       /* refcount of processes in
 526                                                    the dlm using this ls */
 527         int                     ls_create_count; /* create/release refcount */
 528         unsigned long           ls_flags;       /* LSFL_ */
 529         unsigned long           ls_scan_time;
 530         struct kobject          ls_kobj;
 531
 532         struct idr              ls_lkbidr;
 533         spinlock_t              ls_lkbidr_spin;
 534
 535         struct dlm_rsbtable     *ls_rsbtbl;
 536         uint32_t                ls_rsbtbl_size;
 537
 538         struct mutex            ls_waiters_mutex;
 539         struct list_head        ls_waiters;     /* lkbs needing a reply */
 540
 541         struct mutex            ls_orphans_mutex;
 542         struct list_head        ls_orphans;
 543
 544         struct mutex            ls_timeout_mutex;
 545         struct list_head        ls_timeout;
 546
 547         spinlock_t              ls_new_rsb_spin;
 548         int                     ls_new_rsb_count;
 549         struct list_head        ls_new_rsb;     /* new rsb structs */
 550
 551         spinlock_t              ls_remove_spin;
 552         char                    ls_remove_name[DLM_RESNAME_MAXLEN+1];
 553         char                    *ls_remove_names[DLM_REMOVE_NAMES_MAX];
 554         int                     ls_remove_len;
 555         int                     ls_remove_lens[DLM_REMOVE_NAMES_MAX];
 556
 557         struct list_head        ls_nodes;       /* current nodes in ls */
 558         struct list_head        ls_nodes_gone;  /* dead node list, recovery */
 559         int                     ls_num_nodes;   /* number of nodes in ls */
 560         int                     ls_low_nodeid;
 561         int                     ls_total_weight;
 562         int                     *ls_node_array;
 563
 564         int                     ls_slot;
 565         int                     ls_num_slots;
 566         int                     ls_slots_size;
 567         struct dlm_slot         *ls_slots;
 568
 569         struct dlm_rsb          ls_stub_rsb;    /* for returning errors */
 570         struct dlm_lkb          ls_stub_lkb;    /* for returning errors */
 571         struct dlm_message      ls_stub_ms;     /* for faking a reply */
 572
 573         struct dentry           *ls_debug_rsb_dentry; /* debugfs */
 574         struct dentry           *ls_debug_waiters_dentry; /* debugfs */
 575         struct dentry           *ls_debug_locks_dentry; /* debugfs */
 576         struct dentry           *ls_debug_all_dentry; /* debugfs */
 577         struct dentry           *ls_debug_toss_dentry; /* debugfs */
 578
 579         wait_queue_head_t       ls_uevent_wait; /* user part of join/leave */
 580         int                     ls_uevent_result;
 581         struct completion       ls_members_done;
 582         int                     ls_members_result;
 583
 584         struct miscdevice       ls_device;
 585
 586         struct workqueue_struct *ls_callback_wq;
 587
 588         /* recovery related */
 589
 590         struct mutex            ls_cb_mutex;
 591         struct list_head        ls_cb_delay; /* save for queue_work later */
 592         struct timer_list       ls_timer;
 593         struct task_struct      *ls_recoverd_task;
 594         struct mutex            ls_recoverd_active;
 595         spinlock_t              ls_recover_lock;
 596         unsigned long           ls_recover_begin; /* jiffies timestamp */
 597         uint32_t                ls_recover_status; /* DLM_RS_ */
 598         uint64_t                ls_recover_seq;
 599         struct dlm_recover      *ls_recover_args;
 600         struct rw_semaphore     ls_in_recovery; /* block local requests */
 601         struct rw_semaphore     ls_recv_active; /* block dlm_recv */
 602         struct list_head        ls_requestqueue;/* queue remote requests */
 603         struct mutex            ls_requestqueue_mutex;
 604         struct dlm_rcom         *ls_recover_buf;
 605         int                     ls_recover_nodeid; /* for debugging */
 606         unsigned int            ls_recover_dir_sent_res; /* for log info */
 607         unsigned int            ls_recover_dir_sent_msg; /* for log info */
 608         unsigned int            ls_recover_locks_in; /* for log info */
 609         uint64_t                ls_rcom_seq;
 610         spinlock_t              ls_rcom_spin;
 611         struct list_head        ls_recover_list;
 612         spinlock_t              ls_recover_list_lock;
 613         int                     ls_recover_list_count;
 614         struct idr              ls_recover_idr;
 615         spinlock_t              ls_recover_idr_lock;
 616         wait_queue_head_t       ls_wait_general;
 617         wait_queue_head_t       ls_recover_lock_wait;
 618         struct mutex            ls_clear_proc_locks;
 619
 620         struct list_head        ls_root_list;   /* root resources */
 621         struct rw_semaphore     ls_root_sem;    /* protect root_list */
 622
 623         const struct dlm_lockspace_ops *ls_ops;
 624         void                    *ls_ops_arg;
 625
 626         int                     ls_namelen;
 627         char                    ls_name[1];
 628 };
 629
 630 /*
 631  * LSFL_RECOVER_STOP - dlm_ls_stop() sets this to tell dlm recovery routines
 632  * that they should abort what they're doing so new recovery can be started.
 633  *
 634  * LSFL_RECOVER_DOWN - dlm_ls_stop() sets this to tell dlm_recoverd that it
 635  * should do down_write() on the in_recovery rw_semaphore. (doing down_write
 636  * within dlm_ls_stop causes complaints about the lock acquired/released
 637  * in different contexts.)
 638  *
 639  * LSFL_RECOVER_LOCK - dlm_recoverd holds the in_recovery rw_semaphore.
 640  * It sets this after it is done with down_write() on the in_recovery
 641  * rw_semaphore and clears it after it has released the rw_semaphore.
 642  *
 643  * LSFL_RECOVER_WORK - dlm_ls_start() sets this to tell dlm_recoverd that it
 644  * should begin recovery of the lockspace.
 645  *
 646  * LSFL_RUNNING - set when normal locking activity is enabled.
 647  * dlm_ls_stop() clears this to tell dlm locking routines that they should
 648  * quit what they are doing so recovery can run.  dlm_recoverd sets
 649  * this after recovery is finished.
 650  */
 651
 652 #define LSFL_RECOVER_STOP       0
 653 #define LSFL_RECOVER_DOWN       1
 654 #define LSFL_RECOVER_LOCK       2
 655 #define LSFL_RECOVER_WORK       3
 656 #define LSFL_RUNNING            4
 657
 658 #define LSFL_RCOM_READY         5
 659 #define LSFL_RCOM_WAIT          6
 660 #define LSFL_UEVENT_WAIT        7
 661 #define LSFL_TIMEWARN           8
 662 #define LSFL_CB_DELAY           9
 663 #define LSFL_NODIR              10
 664
 665 /* much of this is just saving user space pointers associated with the
 666    lock that we pass back to the user lib with an ast */
 667
 668 struct dlm_user_args {
 669         struct dlm_user_proc    *proc; /* each process that opens the lockspace
 670                                           device has private data
 671                                           (dlm_user_proc) on the struct file,
 672                                           the process's locks point back to it*/
 673         struct dlm_lksb         lksb;
 674         struct dlm_lksb __user  *user_lksb;
 675         void __user             *castparam;
 676         void __user             *castaddr;
 677         void __user             *bastparam;
 678         void __user             *bastaddr;
 679         uint64_t                xid;
 680 };
 681
 682 #define DLM_PROC_FLAGS_CLOSING 1
 683 #define DLM_PROC_FLAGS_COMPAT  2
 684
 685 /* locks list is kept so we can remove all a process's locks when it
 686    exits (or orphan those that are persistent) */
 687
 688 struct dlm_user_proc {
 689         dlm_lockspace_t         *lockspace;
 690         unsigned long           flags; /* DLM_PROC_FLAGS */
 691         struct list_head        asts;
 692         spinlock_t              asts_spin;
 693         struct list_head        locks;
 694         spinlock_t              locks_spin;
 695         struct list_head        unlocking;
 696         wait_queue_head_t       wait;
 697 };
 698
 699 static inline int dlm_locking_stopped(struct dlm_ls *ls)
 700 {
 701         return !test_bit(LSFL_RUNNING, &ls->ls_flags);
 702 }
 703
 704 static inline int dlm_recovery_stopped(struct dlm_ls *ls)
 705 {
 706         return test_bit(LSFL_RECOVER_STOP, &ls->ls_flags);
 707 }
 708
 709 static inline int dlm_no_directory(struct dlm_ls *ls)
 710 {
 711         return test_bit(LSFL_NODIR, &ls->ls_flags);
 712 }
 713
 714 int dlm_netlink_init(void);
 715 void dlm_netlink_exit(void);
 716 void dlm_timeout_warn(struct dlm_lkb *lkb);
 717 int dlm_plock_init(void);
 718 void dlm_plock_exit(void);
 719
 720 #ifdef CONFIG_DLM_DEBUG
 721 void dlm_register_debugfs(void);
 722 void dlm_unregister_debugfs(void);
 723 void dlm_create_debug_file(struct dlm_ls *ls);
 724 void dlm_delete_debug_file(struct dlm_ls *ls);
 725 #else
 726 static inline void dlm_register_debugfs(void) { }
 727 static inline void dlm_unregister_debugfs(void) { }
 728 static inline void dlm_create_debug_file(struct dlm_ls *ls) { }
 729 static inline void dlm_delete_debug_file(struct dlm_ls *ls) { }
 730 #endif
 731
 732 #endif                          /* __DLM_INTERNAL_DOT_H__ */
 733