lustre/include/lustre_dlm.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * (visit-tags-table FILE)
   3  * vim:expandtab:shiftwidth=8:tabstop=8:
   4  */
   5
   6 #ifndef _LUSTRE_DLM_H__
   7 #define _LUSTRE_DLM_H__
   8
   9 #if defined(__linux__)
  10 #include <linux/lustre_dlm.h>
  11 #elif defined(__APPLE__)
  12 #include <darwin/lustre_dlm.h>
  13 #elif defined(__WINNT__)
  14 #include <winnt/lustre_dlm.h>
  15 #else
  16 #error Unsupported operating system.
  17 #endif
  18
  19 #include <lustre_lib.h>
  20 #include <lustre_net.h>
  21 #include <lustre_import.h>
  22 #include <lustre_handles.h>
  23 #include <lustre_export.h> /* for obd_export, for LDLM_DEBUG */
  24 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
  25
  26 struct obd_ops;
  27 struct obd_device;
  28
  29 #define OBD_LDLM_DEVICENAME  "ldlm"
  30
  31 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
  32 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
  33 #define LDLM_CTIME_AGE_LIMIT (10)
  34
  35 typedef enum {
  36         ELDLM_OK = 0,
  37
  38         ELDLM_LOCK_CHANGED = 300,
  39         ELDLM_LOCK_ABORTED = 301,
  40         ELDLM_LOCK_REPLACED = 302,
  41         ELDLM_NO_LOCK_DATA = 303,
  42
  43         ELDLM_NAMESPACE_EXISTS = 400,
  44         ELDLM_BAD_NAMESPACE    = 401
  45 } ldlm_error_t;
  46
  47 typedef enum {
  48         LDLM_NAMESPACE_SERVER = 1 << 0,
  49         LDLM_NAMESPACE_CLIENT = 1 << 1
  50 } ldlm_side_t;
  51
  52 #define LDLM_FL_LOCK_CHANGED   0x000001 /* extent, mode, or resource changed */
  53
  54 /* If the server returns one of these flags, then the lock was put on that list.
  55  * If the client sends one of these flags (during recovery ONLY!), it wants the
  56  * lock added to the specified list, no questions asked. -p */
  57 #define LDLM_FL_BLOCK_GRANTED  0x000002
  58 #define LDLM_FL_BLOCK_CONV     0x000004
  59 #define LDLM_FL_BLOCK_WAIT     0x000008
  60
  61 #define LDLM_FL_CBPENDING      0x000010 /* this lock is being destroyed */
  62 #define LDLM_FL_AST_SENT       0x000020 /* blocking or cancel packet was sent */
  63 #define LDLM_FL_WAIT_NOREPROC  0x000040 /* not a real flag, not saved in lock */
  64 #define LDLM_FL_CANCEL         0x000080 /* cancellation callback already run */
  65
  66 /* Lock is being replayed.  This could probably be implied by the fact that one
  67  * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
  68 #define LDLM_FL_REPLAY         0x000100
  69
  70 #define LDLM_FL_INTENT_ONLY    0x000200 /* don't grant lock, just do intent */
  71 #define LDLM_FL_LOCAL_ONLY     0x000400 /* see ldlm_cli_cancel_unused */
  72
  73 /* don't run the cancel callback under ldlm_cli_cancel_unused */
  74 #define LDLM_FL_FAILED         0x000800
  75
  76 #define LDLM_FL_HAS_INTENT     0x001000 /* lock request has intent */
  77 #define LDLM_FL_CANCELING      0x002000 /* lock cancel has already been sent */
  78 #define LDLM_FL_LOCAL          0x004000 /* local lock (ie, no srv/cli split) */
  79 #define LDLM_FL_WARN           0x008000 /* see ldlm_cli_cancel_unused */
  80 #define LDLM_FL_DISCARD_DATA   0x010000 /* discard (no writeback) on cancel */
  81
  82 #define LDLM_FL_NO_TIMEOUT     0x020000 /* Blocked by group lock - wait
  83                                          * indefinitely */
  84
  85 /* file & record locking */
  86 #define LDLM_FL_BLOCK_NOWAIT   0x040000 // server told not to wait if blocked
  87 #define LDLM_FL_TEST_LOCK      0x080000 // return blocking lock
  88
  89 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
  90  * the LVB filling happens _after_ the lock has been granted, so another thread
  91  * can match`t before the LVB has been updated.  As a dirty hack, we set
  92  * LDLM_FL_LVB_READY only after we've done the LVB poop.
  93  * this is only needed on lov/osc now, where lvb is actually used and callers
  94  * must set it in input flags.
  95  *
  96  * The proper fix is to do the granting inside of the completion AST, which can
  97  * be replaced with a LVB-aware wrapping function for OSC locks.  That change is
  98  * pretty high-risk, though, and would need a lot more testing. */
  99
 100 #define LDLM_FL_LVB_READY      0x100000
 101
 102 /* A lock contributes to the kms calculation until it has finished the part
 103  * of it's cancelation that performs write back on its dirty pages.  It
 104  * can remain on the granted list during this whole time.  Threads racing
 105  * to update the kms after performing their writeback need to know to
 106  * exclude each others locks from the calculation as they walk the granted
 107  * list. */
 108 #define LDLM_FL_KMS_IGNORE     0x200000
 109
 110 /* Don't drop lock covering mmapped file in LRU */
 111 #define LDLM_FL_NO_LRU         0x400000
 112
 113 /* Immediatelly cancel such locks when they block some other locks. Send
 114    cancel notification to original lock holder, but expect no reply. */
 115 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
 116
 117 /* Flags flags inherited from parent lock when doing intents. */
 118 #define LDLM_INHERIT_FLAGS     (LDLM_FL_CANCEL_ON_BLOCK)
 119
 120 /* These are flags that are mapped into the flags and ASTs of blocking locks */
 121 #define LDLM_AST_DISCARD_DATA  0x80000000 /* Add FL_DISCARD to blocking ASTs */
 122 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
 123 #define LDLM_AST_FLAGS         (LDLM_FL_DISCARD_DATA)
 124
 125 /* completion ast to be executed */
 126 #define LDLM_FL_CP_REQD        0x1000000
 127
 128 /* cleanup_resource has already handled the lock */
 129 #define LDLM_FL_CLEANED        0x2000000
 130
 131 /* optimization hint: LDLM can run blocking callback from current context
 132  * w/o involving separate thread. in order to decrease cs rate */
 133 #define LDLM_FL_ATOMIC_CB      0x4000000
 134
 135 /* Cancel lock asynchronously. See ldlm_cli_cancel_unused_resource. */
 136 #define LDLM_FL_ASYNC           0x8000000
 137
 138 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
 139  * such that server send blocking ast for conflict locks to this client for
 140  * the 1st operation, whereas the 2nd operation has canceled this lock and
 141  * is waiting for rpc_lock which is taken by the 1st operation.
 142  * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
 143  * ELC code to cancel it.
 144  * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
 145  * droped to let ldlm_callback_handler() return EINVAL to the server. It is
 146  * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
 147  * to send a separate CANCEL rpc. */
 148 #define LDLM_FL_BL_AST          0x10000000
 149 #define LDLM_FL_BL_DONE         0x20000000
 150
 151 /* measure lock contention and return -EUSERS if locking contention is high */
 152 #define LDLM_FL_DENY_ON_CONTENTION 0x40000000
 153
 154 /* The blocking callback is overloaded to perform two functions.  These flags
 155  * indicate which operation should be performed. */
 156 #define LDLM_CB_BLOCKING    1
 157 #define LDLM_CB_CANCELING   2
 158
 159 /* position flag of skip list pointers */
 160 #define LDLM_SL_HEAD(skip_list)   ((skip_list)->next != NULL)
 161 #define LDLM_SL_TAIL(skip_list)   ((skip_list)->prev != NULL)
 162 #define LDLM_SL_EMPTY(skip_list)  ((skip_list)->next == NULL && \
 163                                    (skip_list)->prev == NULL)
 164
 165 /* compatibility matrix */
 166 #define LCK_COMPAT_EX  LCK_NL
 167 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
 168 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
 169 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
 170 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
 171 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
 172 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
 173
 174 extern ldlm_mode_t lck_compat_array[];
 175
 176 static inline void lockmode_verify(ldlm_mode_t mode)
 177 {
 178        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
 179 }
 180
 181 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
 182 {
 183        return (lck_compat_array[exist] & new);
 184 }
 185
 186 /*
 187  *
 188  * cluster name spaces
 189  *
 190  */
 191
 192 #define DLM_OST_NAMESPACE 1
 193 #define DLM_MDS_NAMESPACE 2
 194
 195 /* XXX
 196    - do we just separate this by security domains and use a prefix for
 197      multiple namespaces in the same domain?
 198    -
 199 */
 200
 201 /*
 202  * Locking rules:
 203  *
 204  * lr_lock
 205  *
 206  * lr_lock
 207  *     waiting_locks_spinlock
 208  *
 209  * lr_lock
 210  *     led_lock
 211  *
 212  * lr_lock
 213  *     ns_unused_lock
 214  *
 215  * lr_lvb_sem
 216  *     lr_lock
 217  *
 218  */
 219
 220 struct ldlm_pool;
 221 struct ldlm_lock;
 222 struct ldlm_resource;
 223 struct ldlm_namespace;
 224
 225 struct ldlm_pool_ops {
 226         int (*po_recalc)(struct ldlm_pool *pl);
 227         int (*po_shrink)(struct ldlm_pool *pl, int nr,
 228                          unsigned int gfp_mask);
 229         int (*po_setup)(struct ldlm_pool *pl, int limit);
 230 };
 231
 232 /* One second for pools thread check interval. */
 233 #define LDLM_POOLS_THREAD_PERIOD (1)
 234
 235 /* 5% margin for modest pools. See ldlm_pool.c for details. */
 236 #define LDLM_POOLS_MODEST_MARGIN (5)
 237
 238 /* A change to SLV in % after which we want to wake up pools thread asap. */
 239 #define LDLM_POOLS_FAST_SLV_CHANGE (50)
 240
 241 struct ldlm_pool {
 242         /* Common pool fields */
 243         cfs_proc_dir_entry_t  *pl_proc_dir;      /* Pool proc directory. */
 244         char                   pl_name[100];     /* Pool name, should be long
 245                                                   * enough to contain complex
 246                                                   * proc entry name. */
 247         spinlock_t             pl_lock;          /* Lock for protecting slv/clv
 248                                                   * updates. */
 249         atomic_t               pl_limit;         /* Number of allowed locks in
 250                                                   * in pool, both, client and
 251                                                   * server side. */
 252         atomic_t               pl_granted;       /* Number of granted locks. */
 253         atomic_t               pl_grant_rate;    /* Grant rate per T. */
 254         atomic_t               pl_cancel_rate;   /* Cancel rate per T. */
 255         atomic_t               pl_grant_speed;   /* Grant speed (GR-CR) per T. */
 256         __u64                  pl_server_lock_volume; /* Server lock volume.
 257                                                   * Protected by pl_lock */
 258         atomic_t               pl_lock_volume_factor; /* Lock volume factor. */
 259
 260         time_t                 pl_recalc_time;   /* Time when last slv from
 261                                                   * server was obtained. */
 262         struct ldlm_pool_ops  *pl_ops;           /* Recalc and shrink ops. */
 263
 264         int                    pl_grant_plan;    /* Planned number of granted
 265                                                   * locks for next T. */
 266         int                    pl_grant_step;    /* Grant plan step for next
 267                                                   * T. */
 268
 269         struct lprocfs_stats  *pl_stats;         /* Pool statistics. */
 270 };
 271
 272 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
 273                                void *req_cookie, ldlm_mode_t mode, int flags,
 274                                void *data);
 275
 276 struct ldlm_valblock_ops {
 277         int (*lvbo_init)(struct ldlm_resource *res);
 278         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
 279                            int buf_idx, int increase);
 280 };
 281
 282 typedef enum {
 283         LDLM_NAMESPACE_GREEDY = 1 << 0,
 284         LDLM_NAMESPACE_MODEST = 1 << 1
 285 } ldlm_appetite_t;
 286
 287 /* Default value for ->ns_shrink_thumb. If lock is not extent one its cost
 288  * is one page. Here we have 256 pages which is 1M on i386. Thus by default
 289  * all extent locks which have more than 1M long extent will be kept in lru,
 290  * others (including ibits locks) will be canceled on memory pressure event. */
 291 #define LDLM_LOCK_SHRINK_THUMB 256
 292
 293 /* default values for the "max_nolock_size", "contention_time"
 294  * and "contended_locks" namespace tunables */
 295 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
 296 #define NS_DEFAULT_CONTENTION_SECONDS 2
 297 #define NS_DEFAULT_CONTENDED_LOCKS 32
 298
 299 struct ldlm_namespace {
 300         char                  *ns_name;
 301         ldlm_side_t            ns_client; /* is this a client-side lock tree? */
 302         __u64                  ns_connect_flags; /* ns connect flags supported
 303                                            * by server (may be changed via proc,
 304                                            * lru resize may be disabled/enabled) */
 305         __u64                  ns_orig_connect_flags; /* client side orig connect
 306                                            * flags supported by server */
 307         struct list_head      *ns_hash;   /* hash table for ns */
 308         spinlock_t             ns_hash_lock;
 309         __u32                  ns_refcount; /* count of resources in the hash */
 310         struct list_head       ns_root_list; /* all root resources in ns */
 311         struct list_head       ns_list_chain; /* position in global NS list */
 312
 313         struct list_head       ns_unused_list; /* all root resources in ns */
 314         int                    ns_nr_unused;
 315         spinlock_t             ns_unused_lock;
 316
 317         unsigned int           ns_max_unused;
 318         unsigned int           ns_max_age;
 319         unsigned int           ns_ctime_age_limit; /* seconds */
 320
 321         /* Lower limit to number of pages in lock to keep it in cache */
 322         unsigned int           ns_shrink_thumb;
 323         cfs_time_t             ns_next_dump;   /* next debug dump, jiffies */
 324
 325         atomic_t               ns_locks;
 326         __u64                  ns_resources;
 327         ldlm_res_policy        ns_policy;
 328         struct ldlm_valblock_ops *ns_lvbo;
 329         void                  *ns_lvbp;
 330         cfs_waitq_t            ns_waitq;
 331         struct ldlm_pool       ns_pool;
 332         ldlm_appetite_t        ns_appetite;
 333         /* if more than @ns_contented_locks found, the resource considered
 334          * as contended */
 335         unsigned               ns_contended_locks;
 336         /* the resource remembers contended state during @ns_contention_time,
 337          * in seconds */
 338         unsigned               ns_contention_time;
 339         /* limit size of nolock requests, in bytes */
 340         unsigned               ns_max_nolock_size;
 341 };
 342
 343 static inline int ns_is_client(struct ldlm_namespace *ns)
 344 {
 345         LASSERT(ns != NULL);
 346         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 347                                     LDLM_NAMESPACE_SERVER)));
 348         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 349                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 350         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
 351 }
 352
 353 static inline int ns_is_server(struct ldlm_namespace *ns)
 354 {
 355         LASSERT(ns != NULL);
 356         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 357                                     LDLM_NAMESPACE_SERVER)));
 358         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 359                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 360         return ns->ns_client == LDLM_NAMESPACE_SERVER;
 361 }
 362
 363 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
 364 {
 365         LASSERT(ns != NULL);
 366         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
 367 }
 368
 369 /*
 370  *
 371  * Resource hash table
 372  *
 373  */
 374
 375 #define RES_HASH_BITS 10
 376 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 377 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 378
 379 struct ldlm_lock;
 380
 381 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 382                                       struct ldlm_lock_desc *new, void *data,
 383                                       int flag);
 384 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
 385                                         void *data);
 386 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
 387
 388 /* Interval node data for each LDLM_EXTENT lock */
 389 struct ldlm_interval {
 390         struct interval_node li_node;   /* node for tree mgmt */
 391         struct list_head     li_group;  /* the locks which have the same
 392                                          * policy - group of the policy */
 393 };
 394 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
 395
 396 /* the interval tree must be accessed inside the resource lock. */
 397 struct ldlm_interval_tree {
 398         /* tree size, this variable is used to count
 399          * granted PW locks in ldlm_extent_policy()*/
 400         int                   lit_size;
 401         ldlm_mode_t           lit_mode; /* lock mode */
 402         struct interval_node *lit_root; /* actually ldlm_interval */
 403 };
 404
 405 struct ldlm_lock {
 406         struct portals_handle l_handle; // must be first in the structure
 407         atomic_t              l_refc;
 408
 409         /* internal spinlock protects l_resource.  we should hold this lock
 410          * first before grabbing res_lock.*/
 411         spinlock_t            l_lock;
 412
 413         /* ldlm_lock_change_resource() can change this */
 414         struct ldlm_resource *l_resource;
 415
 416         /* protected by ns_hash_lock. FIXME */
 417         struct list_head      l_lru;
 418
 419         /* protected by lr_lock */
 420         struct list_head      l_res_link; // position in one of three res lists
 421
 422         struct list_head      l_sl_mode;        // skip pointer for request mode
 423         struct list_head      l_sl_policy;      // skip pointer for inodebits
 424
 425         struct ldlm_interval *l_tree_node;      /* tree node for ldlm_extent */
 426
 427         /* protected by led_lock */
 428         struct list_head      l_export_chain; // per-export chain of locks
 429
 430         /* protected by lr_lock */
 431         ldlm_mode_t           l_req_mode;
 432         ldlm_mode_t           l_granted_mode;
 433
 434         ldlm_completion_callback l_completion_ast;
 435         ldlm_blocking_callback   l_blocking_ast;
 436         ldlm_glimpse_callback    l_glimpse_ast;
 437
 438         struct obd_export    *l_export;
 439         struct obd_export    *l_conn_export;
 440
 441         struct lustre_handle  l_remote_handle;
 442         ldlm_policy_data_t    l_policy_data;
 443
 444         /* protected by lr_lock */
 445         __u32                 l_flags;
 446         __u32                 l_readers;
 447         __u32                 l_writers;
 448         __u8                  l_destroyed;
 449
 450         /* If the lock is granted, a process sleeps on this waitq to learn when
 451          * it's no longer in use.  If the lock is not granted, a process sleeps
 452          * on this waitq to learn when it becomes granted. */
 453         cfs_waitq_t           l_waitq;
 454         struct timeval        l_enqueued_time;
 455
 456         cfs_time_t            l_last_used;      /* jiffies */
 457         struct ldlm_extent    l_req_extent;
 458
 459         /* Client-side-only members */
 460         __u32                 l_lvb_len;        /* temporary storage for */
 461         void                 *l_lvb_data;       /* an LVB received during */
 462         void                 *l_lvb_swabber;    /* an enqueue */
 463         void                 *l_ast_data;
 464
 465         /* Server-side-only members */
 466
 467         /* protected by elt_lock */
 468         struct list_head      l_pending_chain;  /* callbacks pending */
 469         cfs_time_t            l_callback_timeout; /* jiffies */
 470
 471         __u32                 l_pid;            /* pid which created this lock */
 472
 473         /* for ldlm_add_ast_work_item() */
 474         struct list_head      l_bl_ast;
 475         struct list_head      l_cp_ast;
 476         struct ldlm_lock     *l_blocking_lock;
 477         int                   l_bl_ast_run;
 478 };
 479
 480 struct ldlm_resource {
 481         struct ldlm_namespace *lr_namespace;
 482
 483         /* protected by ns_hash_lock */
 484         struct list_head       lr_hash;
 485         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 486         struct list_head       lr_children; /* list head for child resources */
 487         struct list_head       lr_childof;  /* part of ns_root_list if root res,
 488                                              * part of lr_children if child */
 489         spinlock_t             lr_lock;
 490
 491         /* protected by lr_lock */
 492         struct list_head       lr_granted;
 493         struct list_head       lr_converting;
 494         struct list_head       lr_waiting;
 495         ldlm_mode_t            lr_most_restr;
 496         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 497         struct ldlm_res_id     lr_name;
 498         atomic_t               lr_refcount;
 499
 500         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
 501
 502         /* Server-side-only lock value block elements */
 503         struct semaphore       lr_lvb_sem;
 504         __u32                  lr_lvb_len;
 505         void                  *lr_lvb_data;
 506
 507         /* when the resource was considered as contended */
 508         cfs_time_t             lr_contention_time;
 509 };
 510
 511 struct ldlm_ast_work {
 512         struct ldlm_lock *w_lock;
 513         int               w_blocking;
 514         struct ldlm_lock_desc w_desc;
 515         struct list_head   w_list;
 516         int w_flags;
 517         void *w_data;
 518         int w_datalen;
 519 };
 520
 521 /* ldlm_enqueue parameters common */
 522 struct ldlm_enqueue_info {
 523         __u32 ei_type;   /* Type of the lock being enqueued. */
 524         __u32 ei_mode;   /* Mode of the lock being enqueued. */
 525         void *ei_cb_bl;  /* Different callbacks for lock handling (blocking, */
 526         void *ei_cb_cp;  /* completion, glimpse) */
 527         void *ei_cb_gl;
 528         void *ei_cbdata; /* Data to be passed into callbacks. */
 529 };
 530
 531 extern struct obd_ops ldlm_obd_ops;
 532
 533 extern char *ldlm_lockname[];
 534 extern char *ldlm_typename[];
 535 extern char *ldlm_it2str(int it);
 536 #ifdef LIBCFS_DEBUG
 537 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
 538         CHECK_STACK();                                                  \
 539                                                                         \
 540         if (((level) & D_CANTMASK) != 0 ||                              \
 541             ((libcfs_debug & (level)) != 0 &&                           \
 542              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
 543                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
 544                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
 545                                     file, func, line);                  \
 546                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
 547                                  ##a );                                 \
 548         }                                                               \
 549 } while(0)
 550
 551 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
 552                       struct libcfs_debug_msg_data *data, const char *fmt,
 553                       ...)
 554         __attribute__ ((format (printf, 4, 5)));
 555
 556 #define LDLM_ERROR(lock, fmt, a...) do {                                \
 557         static cfs_debug_limit_state_t _ldlm_cdls;                      \
 558         ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock,                     \
 559                         __FILE__, __FUNCTION__, __LINE__,               \
 560                         "### " fmt , ##a);                              \
 561 } while (0)
 562
 563 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
 564         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
 565                         __FILE__, __FUNCTION__, __LINE__,               \
 566                          "### " fmt , ##a);                             \
 567 } while (0)
 568 #else
 569 #define LDLM_DEBUG(lock, fmt, a...) ((void)0)
 570 #define LDLM_ERROR(lock, fmt, a...) ((void)0)
 571 #endif
 572
 573 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 574         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
 575
 576 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 577                                       int first_enq, ldlm_error_t *err,
 578                                       struct list_head *work_list);
 579
 580 /*
 581  * Iterators.
 582  */
 583
 584 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 585 #define LDLM_ITER_STOP     2 /* stop iterating */
 586
 587 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 588 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 589
 590 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 591                           void *closure);
 592 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 593                            void *closure);
 594 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
 595                                ldlm_res_iterator_t iter, void *closure);
 596
 597 int ldlm_replay_locks(struct obd_import *imp);
 598 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
 599                            ldlm_iterator_t iter, void *data);
 600
 601 /* ldlm_flock.c */
 602 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 603
 604 /* ldlm_extent.c */
 605 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 606
 607
 608 /* ldlm_lockd.c */
 609 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 610                              void *data, int flag);
 611 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 612 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 613 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 614                         ldlm_blocking_callback, ldlm_glimpse_callback);
 615 int ldlm_handle_convert(struct ptlrpc_request *req);
 616 int ldlm_handle_cancel(struct ptlrpc_request *req);
 617 int ldlm_request_cancel(struct ptlrpc_request *req,
 618                         const struct ldlm_request *dlm_req, int first);
 619 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
 620 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
 621 void ldlm_revoke_export_locks(struct obd_export *exp);
 622 int ldlm_get_ref(void);
 623 void ldlm_put_ref(int force);
 624
 625 /* ldlm_lock.c */
 626 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
 627 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
 628 void ldlm_lock2handle(const struct ldlm_lock *lock,
 629                       struct lustre_handle *lockh);
 630 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
 631 void ldlm_cancel_callback(struct ldlm_lock *);
 632 int ldlm_lock_set_data(struct lustre_handle *, void *data);
 633 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
 634 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
 635                                       const struct lustre_handle *);
 636
 637 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
 638 {
 639         return __ldlm_handle2lock(h, 0);
 640 }
 641
 642 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
 643                                        struct lustre_msg *m, int buf_idx,
 644                                        int increase)
 645 {
 646         if (res->lr_namespace->ns_lvbo &&
 647             res->lr_namespace->ns_lvbo->lvbo_update) {
 648                 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
 649                                                                increase);
 650         }
 651         return 0;
 652 }
 653
 654 #define LDLM_LOCK_PUT(lock)                     \
 655 do {                                            \
 656         /*LDLM_DEBUG((lock), "put");*/          \
 657         ldlm_lock_put(lock);                    \
 658 } while (0)
 659
 660 #define LDLM_LOCK_GET(lock)                     \
 661 ({                                              \
 662         ldlm_lock_get(lock);                    \
 663         /*LDLM_DEBUG((lock), "get");*/          \
 664         lock;                                   \
 665 })
 666
 667 #define ldlm_lock_list_put(head, member, count)                 \
 668 ({                                                              \
 669         struct ldlm_lock *_lock, *_next;                        \
 670         int c = count;                                          \
 671         list_for_each_entry_safe(_lock, _next, head, member) {  \
 672                 if (c-- == 0)                                   \
 673                         break;                                  \
 674                 list_del_init(&_lock->member);                  \
 675                 LDLM_LOCK_PUT(_lock);                           \
 676         }                                                       \
 677         LASSERT(c <= 0);                                        \
 678 })
 679
 680 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
 681 void ldlm_lock_put(struct ldlm_lock *lock);
 682 void ldlm_lock_destroy(struct ldlm_lock *lock);
 683 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
 684 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
 685 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
 686 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
 687 void ldlm_lock_allow_match(struct ldlm_lock *lock);
 688 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
 689                             const struct ldlm_res_id *, ldlm_type_t type,
 690                             ldlm_policy_data_t *, ldlm_mode_t mode,
 691                             struct lustre_handle *);
 692 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
 693                                         __u32 *flags);
 694 void ldlm_lock_cancel(struct ldlm_lock *lock);
 695 void ldlm_cancel_locks_for_export(struct obd_export *export);
 696 void ldlm_reprocess_all(struct ldlm_resource *res);
 697 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
 698 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
 699 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
 700 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
 701
 702 /* resource.c */
 703 struct ldlm_namespace *ldlm_namespace_new(char *name, ldlm_side_t client,
 704                                           ldlm_appetite_t apt);
 705 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
 706 int ldlm_namespace_free(struct ldlm_namespace *ns, int force);
 707 void ldlm_namespace_move(struct ldlm_namespace *ns, ldlm_side_t client);
 708 struct ldlm_namespace *ldlm_namespace_first(ldlm_side_t client);
 709 void ldlm_namespace_get(struct ldlm_namespace *ns);
 710 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
 711 void ldlm_namespace_get_nolock(struct ldlm_namespace *ns);
 712 void ldlm_namespace_put_nolock(struct ldlm_namespace *ns, int wakeup);
 713 int ldlm_proc_setup(void);
 714 #ifdef LPROCFS
 715 void ldlm_proc_cleanup(void);
 716 #else
 717 static inline void ldlm_proc_cleanup(void) {}
 718 #endif
 719
 720 /* resource.c - internal */
 721 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
 722                                         struct ldlm_resource *parent,
 723                                         const struct ldlm_res_id *,
 724                                         ldlm_type_t type, int create);
 725 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
 726 int ldlm_resource_putref(struct ldlm_resource *res);
 727 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
 728                             struct ldlm_lock *lock);
 729 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
 730 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
 731 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
 732 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
 733 void ldlm_resource_dump(int level, struct ldlm_resource *);
 734 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
 735                               const struct ldlm_res_id *);
 736
 737 struct ldlm_callback_suite {
 738         ldlm_completion_callback lcs_completion;
 739         ldlm_blocking_callback   lcs_blocking;
 740         ldlm_glimpse_callback    lcs_glimpse;
 741 };
 742
 743 /* ldlm_request.c */
 744 int ldlm_expired_completion_wait(void *data);
 745 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 746                       void *data, int flag);
 747 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
 748 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 749 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
 750                      struct ldlm_enqueue_info *einfo,
 751                      const struct ldlm_res_id *res_id,
 752                      ldlm_policy_data_t *policy, int *flags,
 753                      void *lvb, __u32 lvb_len, void *lvb_swabber,
 754                      struct lustre_handle *lockh, int async);
 755 int ldlm_prep_enqueue_req(struct obd_export *exp,
 756                           struct ptlrpc_request *req,
 757                           struct list_head *cancels,
 758                           int count);
 759 int ldlm_prep_elc_req(struct obd_export *exp,
 760                       struct ptlrpc_request *req,
 761                       int version, int opc, int canceloff,
 762                       struct list_head *cancels, int count);
 763 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
 764                          const struct ldlm_request *dlm_req,
 765                          const struct ldlm_callback_suite *cbs);
 766 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
 767                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
 768                           int *flags, void *lvb, __u32 lvb_len,
 769                           void *lvb_swabber, struct lustre_handle *lockh,
 770                           int rc);
 771 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
 772                            const struct ldlm_res_id *res_id,
 773                            ldlm_type_t type, ldlm_policy_data_t *policy,
 774                            ldlm_mode_t mode, int *flags,
 775                            ldlm_blocking_callback blocking,
 776                            ldlm_completion_callback completion,
 777                            ldlm_glimpse_callback glimpse,
 778                            void *data, __u32 lvb_len, void *lvb_swabber,
 779                            struct lustre_handle *lockh);
 780 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
 781                     void *data, __u32 data_len);
 782 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
 783 int ldlm_cli_update_pool(struct ptlrpc_request *req);
 784 int ldlm_handle_convert0(struct ptlrpc_request *req,
 785                          const struct ldlm_request *dlm_req);
 786 int ldlm_cli_cancel(struct lustre_handle *lockh);
 787 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
 788                            int flags, void *opaque);
 789 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
 790                                     const struct ldlm_res_id *res_id,
 791                                     ldlm_policy_data_t *policy,
 792                                     ldlm_mode_t mode, int flags, void *opaque);
 793 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
 794                         int count, int flags);
 795 int ldlm_cli_join_lru(struct ldlm_namespace *,
 796                       const struct ldlm_res_id *, int join);
 797 int ldlm_cancel_resource_local(struct ldlm_resource *res,
 798                                struct list_head *cancels,
 799                                ldlm_policy_data_t *policy,
 800                                ldlm_mode_t mode, int lock_flags,
 801                                int cancel_flags, void *opaque);
 802 int ldlm_cli_cancel_list(struct list_head *head, int count,
 803                          struct ptlrpc_request *req, int flags);
 804
 805 /* mds/handler.c */
 806 /* This has to be here because recursive inclusion sucks. */
 807 int intent_disposition(struct ldlm_reply *rep, int flag);
 808 void intent_set_disposition(struct ldlm_reply *rep, int flag);
 809
 810
 811 /* ioctls for trying requests */
 812 #define IOC_LDLM_TYPE                   'f'
 813 #define IOC_LDLM_MIN_NR                 40
 814
 815 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
 816 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
 817 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
 818 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
 819 #define IOC_LDLM_MAX_NR                 43
 820
 821 static inline void lock_res(struct ldlm_resource *res)
 822 {
 823         spin_lock(&res->lr_lock);
 824 }
 825
 826 static inline void unlock_res(struct ldlm_resource *res)
 827 {
 828         spin_unlock(&res->lr_lock);
 829 }
 830
 831 static inline void check_res_locked(struct ldlm_resource *res)
 832 {
 833         LASSERT_SPIN_LOCKED(&res->lr_lock);
 834 }
 835
 836 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
 837 void unlock_res_and_lock(struct ldlm_lock *lock);
 838
 839 /* ldlm_pool.c */
 840 void ldlm_pools_recalc(ldlm_side_t client);
 841 int ldlm_pools_init(void);
 842 void ldlm_pools_fini(void);
 843 void ldlm_pools_wakeup(void);
 844
 845 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
 846                    int idx, ldlm_side_t client);
 847 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
 848                      unsigned int gfp_mask);
 849 void ldlm_pool_fini(struct ldlm_pool *pl);
 850 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
 851 int ldlm_pool_recalc(struct ldlm_pool *pl);
 852 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
 853 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
 854 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
 855 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
 856 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
 857 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
 858 #endif
 859