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