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 /* compatibility matrix */
 160 #define LCK_COMPAT_EX  LCK_NL
 161 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
 162 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
 163 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
 164 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
 165 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
 166 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
 167
 168 extern ldlm_mode_t lck_compat_array[];
 169
 170 static inline void lockmode_verify(ldlm_mode_t mode)
 171 {
 172        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
 173 }
 174
 175 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
 176 {
 177        return (lck_compat_array[exist] & new);
 178 }
 179
 180 /*
 181  *
 182  * cluster name spaces
 183  *
 184  */
 185
 186 #define DLM_OST_NAMESPACE 1
 187 #define DLM_MDS_NAMESPACE 2
 188
 189 /* XXX
 190    - do we just separate this by security domains and use a prefix for
 191      multiple namespaces in the same domain?
 192    -
 193 */
 194
 195 /*
 196  * Locking rules:
 197  *
 198  * lr_lock
 199  *
 200  * lr_lock
 201  *     waiting_locks_spinlock
 202  *
 203  * lr_lock
 204  *     led_lock
 205  *
 206  * lr_lock
 207  *     ns_unused_lock
 208  *
 209  * lr_lvb_sem
 210  *     lr_lock
 211  *
 212  */
 213
 214 struct ldlm_pool;
 215 struct ldlm_lock;
 216 struct ldlm_resource;
 217 struct ldlm_namespace;
 218
 219 struct ldlm_pool_ops {
 220         int (*po_recalc)(struct ldlm_pool *pl);
 221         int (*po_shrink)(struct ldlm_pool *pl, int nr,
 222                          unsigned int gfp_mask);
 223         int (*po_setup)(struct ldlm_pool *pl, int limit);
 224 };
 225
 226 /* One second for pools thread check interval. */
 227 #define LDLM_POOLS_THREAD_PERIOD (1)
 228
 229 /* 5% margin for modest pools. See ldlm_pool.c for details. */
 230 #define LDLM_POOLS_MODEST_MARGIN (5)
 231
 232 /* A change to SLV in % after which we want to wake up pools thread asap. */
 233 #define LDLM_POOLS_FAST_SLV_CHANGE (50)
 234
 235 struct ldlm_pool {
 236         /* Common pool fields */
 237         cfs_proc_dir_entry_t  *pl_proc_dir;      /* Pool proc directory. */
 238         char                   pl_name[100];     /* Pool name, should be long
 239                                                   * enough to contain complex
 240                                                   * proc entry name. */
 241         spinlock_t             pl_lock;          /* Lock for protecting slv/clv
 242                                                   * updates. */
 243         atomic_t               pl_limit;         /* Number of allowed locks in
 244                                                   * in pool, both, client and
 245                                                   * server side. */
 246         atomic_t               pl_granted;       /* Number of granted locks. */
 247         atomic_t               pl_grant_rate;    /* Grant rate per T. */
 248         atomic_t               pl_cancel_rate;   /* Cancel rate per T. */
 249         atomic_t               pl_grant_speed;   /* Grant speed (GR-CR) per T. */
 250         __u64                  pl_server_lock_volume; /* Server lock volume.
 251                                                   * Protected by pl_lock */
 252         atomic_t               pl_lock_volume_factor; /* Lock volume factor. */
 253
 254         time_t                 pl_recalc_time;   /* Time when last slv from
 255                                                   * server was obtained. */
 256         struct ldlm_pool_ops  *pl_ops;           /* Recalc and shrink ops. */
 257
 258         int                    pl_grant_plan;    /* Planned number of granted
 259                                                   * locks for next T. */
 260         int                    pl_grant_step;    /* Grant plan step for next
 261                                                   * T. */
 262
 263         struct lprocfs_stats  *pl_stats;         /* Pool statistics. */
 264 };
 265
 266 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
 267                                void *req_cookie, ldlm_mode_t mode, int flags,
 268                                void *data);
 269
 270 struct ldlm_valblock_ops {
 271         int (*lvbo_init)(struct ldlm_resource *res);
 272         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
 273                            int buf_idx, int increase);
 274 };
 275
 276 typedef enum {
 277         LDLM_NAMESPACE_GREEDY = 1 << 0,
 278         LDLM_NAMESPACE_MODEST = 1 << 1
 279 } ldlm_appetite_t;
 280
 281 /* Default value for ->ns_shrink_thumb. If lock is not extent one its cost
 282  * is one page. Here we have 256 pages which is 1M on i386. Thus by default
 283  * all extent locks which have more than 1M long extent will be kept in lru,
 284  * others (including ibits locks) will be canceled on memory pressure event. */
 285 #define LDLM_LOCK_SHRINK_THUMB 256
 286
 287 /* default values for the "max_nolock_size", "contention_time"
 288  * and "contended_locks" namespace tunables */
 289 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
 290 #define NS_DEFAULT_CONTENTION_SECONDS 2
 291 #define NS_DEFAULT_CONTENDED_LOCKS 32
 292
 293 struct ldlm_namespace {
 294         char                  *ns_name;
 295         ldlm_side_t            ns_client; /* is this a client-side lock tree? */
 296         __u64                  ns_connect_flags; /* ns connect flags supported
 297                                            * by server (may be changed via proc,
 298                                            * lru resize may be disabled/enabled) */
 299         __u64                  ns_orig_connect_flags; /* client side orig connect
 300                                            * flags supported by server */
 301         struct list_head      *ns_hash;   /* hash table for ns */
 302         spinlock_t             ns_hash_lock;
 303         __u32                  ns_refcount; /* count of resources in the hash */
 304         struct list_head       ns_root_list; /* all root resources in ns */
 305         struct list_head       ns_list_chain; /* position in global NS list */
 306
 307         struct list_head       ns_unused_list; /* all root resources in ns */
 308         int                    ns_nr_unused;
 309         spinlock_t             ns_unused_lock;
 310
 311         unsigned int           ns_max_unused;
 312         unsigned int           ns_max_age;
 313         unsigned int           ns_ctime_age_limit; /* seconds */
 314
 315         /* Lower limit to number of pages in lock to keep it in cache */
 316         unsigned int           ns_shrink_thumb;
 317         cfs_time_t             ns_next_dump;   /* next debug dump, jiffies */
 318
 319         atomic_t               ns_locks;
 320         __u64                  ns_resources;
 321         ldlm_res_policy        ns_policy;
 322         struct ldlm_valblock_ops *ns_lvbo;
 323         void                  *ns_lvbp;
 324         cfs_waitq_t            ns_waitq;
 325         struct ldlm_pool       ns_pool;
 326         ldlm_appetite_t        ns_appetite;
 327         /* if more than @ns_contented_locks found, the resource considered
 328          * as contended */
 329         unsigned               ns_contended_locks;
 330         /* the resource remembers contended state during @ns_contention_time,
 331          * in seconds */
 332         unsigned               ns_contention_time;
 333         /* limit size of nolock requests, in bytes */
 334         unsigned               ns_max_nolock_size;
 335 };
 336
 337 static inline int ns_is_client(struct ldlm_namespace *ns)
 338 {
 339         LASSERT(ns != NULL);
 340         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 341                                     LDLM_NAMESPACE_SERVER)));
 342         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 343                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 344         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
 345 }
 346
 347 static inline int ns_is_server(struct ldlm_namespace *ns)
 348 {
 349         LASSERT(ns != NULL);
 350         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 351                                     LDLM_NAMESPACE_SERVER)));
 352         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 353                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 354         return ns->ns_client == LDLM_NAMESPACE_SERVER;
 355 }
 356
 357 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
 358 {
 359         LASSERT(ns != NULL);
 360         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
 361 }
 362
 363 /*
 364  *
 365  * Resource hash table
 366  *
 367  */
 368
 369 #define RES_HASH_BITS 10
 370 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 371 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 372
 373 struct ldlm_lock;
 374
 375 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 376                                       struct ldlm_lock_desc *new, void *data,
 377                                       int flag);
 378 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
 379                                         void *data);
 380 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
 381
 382 /* Interval node data for each LDLM_EXTENT lock */
 383 struct ldlm_interval {
 384         struct interval_node li_node;   /* node for tree mgmt */
 385         struct list_head     li_group;  /* the locks which have the same
 386                                          * policy - group of the policy */
 387 };
 388 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
 389
 390 /* the interval tree must be accessed inside the resource lock. */
 391 struct ldlm_interval_tree {
 392         /* tree size, this variable is used to count
 393          * granted PW locks in ldlm_extent_policy()*/
 394         int                   lit_size;
 395         ldlm_mode_t           lit_mode; /* lock mode */
 396         struct interval_node *lit_root; /* actually ldlm_interval */
 397 };
 398
 399 struct ldlm_lock {
 400         struct portals_handle l_handle; // must be first in the structure
 401         atomic_t              l_refc;
 402
 403         /* internal spinlock protects l_resource.  we should hold this lock
 404          * first before grabbing res_lock.*/
 405         spinlock_t            l_lock;
 406
 407         /* ldlm_lock_change_resource() can change this */
 408         struct ldlm_resource *l_resource;
 409
 410         /* protected by ns_hash_lock. FIXME */
 411         struct list_head      l_lru;
 412
 413         /* protected by lr_lock, linkage to resource's lock queues */
 414         struct list_head      l_res_link;
 415
 416         struct ldlm_interval *l_tree_node;      /* tree node for ldlm_extent */
 417
 418         /* protected by led_lock */
 419         struct list_head      l_export_chain; // per-export chain of locks
 420
 421         /* protected by lr_lock */
 422         ldlm_mode_t           l_req_mode;
 423         ldlm_mode_t           l_granted_mode;
 424
 425         ldlm_completion_callback l_completion_ast;
 426         ldlm_blocking_callback   l_blocking_ast;
 427         ldlm_glimpse_callback    l_glimpse_ast;
 428
 429         struct obd_export    *l_export;
 430         struct obd_export    *l_conn_export;
 431
 432         struct lustre_handle  l_remote_handle;
 433         ldlm_policy_data_t    l_policy_data;
 434
 435         /* protected by lr_lock */
 436         __u32                 l_flags;
 437         __u32                 l_readers;
 438         __u32                 l_writers;
 439         __u8                  l_destroyed;
 440
 441         /* If the lock is granted, a process sleeps on this waitq to learn when
 442          * it's no longer in use.  If the lock is not granted, a process sleeps
 443          * on this waitq to learn when it becomes granted. */
 444         cfs_waitq_t           l_waitq;
 445         struct timeval        l_enqueued_time;
 446
 447         cfs_time_t            l_last_used;      /* jiffies */
 448         struct ldlm_extent    l_req_extent;
 449
 450         /* Client-side-only members */
 451         __u32                 l_lvb_len;        /* temporary storage for */
 452         void                 *l_lvb_data;       /* an LVB received during */
 453         void                 *l_lvb_swabber;    /* an enqueue */
 454         void                 *l_ast_data;
 455
 456         /* Server-side-only members */
 457
 458         /* protected by elt_lock */
 459         struct list_head      l_pending_chain;  /* callbacks pending */
 460         cfs_time_t            l_callback_timeout; /* jiffies */
 461
 462         __u32                 l_pid;            /* pid which created this lock */
 463
 464         /* for ldlm_add_ast_work_item() */
 465         struct list_head      l_bl_ast;
 466         struct list_head      l_cp_ast;
 467         struct ldlm_lock     *l_blocking_lock;
 468         int                   l_bl_ast_run;
 469
 470         /* protected by lr_lock, linkages to "skip lists" */
 471         struct list_head      l_sl_mode;
 472         struct list_head      l_sl_policy;
 473 };
 474
 475 struct ldlm_resource {
 476         struct ldlm_namespace *lr_namespace;
 477
 478         /* protected by ns_hash_lock */
 479         struct list_head       lr_hash;
 480         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 481         struct list_head       lr_children; /* list head for child resources */
 482         struct list_head       lr_childof;  /* part of ns_root_list if root res,
 483                                              * part of lr_children if child */
 484         spinlock_t             lr_lock;
 485
 486         /* protected by lr_lock */
 487         struct list_head       lr_granted;
 488         struct list_head       lr_converting;
 489         struct list_head       lr_waiting;
 490         ldlm_mode_t            lr_most_restr;
 491         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 492         struct ldlm_res_id     lr_name;
 493         atomic_t               lr_refcount;
 494
 495         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
 496
 497         /* Server-side-only lock value block elements */
 498         struct semaphore       lr_lvb_sem;
 499         __u32                  lr_lvb_len;
 500         void                  *lr_lvb_data;
 501
 502         /* when the resource was considered as contended */
 503         cfs_time_t             lr_contention_time;
 504 };
 505
 506 struct ldlm_ast_work {
 507         struct ldlm_lock *w_lock;
 508         int               w_blocking;
 509         struct ldlm_lock_desc w_desc;
 510         struct list_head   w_list;
 511         int w_flags;
 512         void *w_data;
 513         int w_datalen;
 514 };
 515
 516 /* ldlm_enqueue parameters common */
 517 struct ldlm_enqueue_info {
 518         __u32 ei_type;   /* Type of the lock being enqueued. */
 519         __u32 ei_mode;   /* Mode of the lock being enqueued. */
 520         void *ei_cb_bl;  /* Different callbacks for lock handling (blocking, */
 521         void *ei_cb_cp;  /* completion, glimpse) */
 522         void *ei_cb_gl;
 523         void *ei_cbdata; /* Data to be passed into callbacks. */
 524 };
 525
 526 extern struct obd_ops ldlm_obd_ops;
 527
 528 extern char *ldlm_lockname[];
 529 extern char *ldlm_typename[];
 530 extern char *ldlm_it2str(int it);
 531 #ifdef LIBCFS_DEBUG
 532 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
 533         CHECK_STACK();                                                  \
 534                                                                         \
 535         if (((level) & D_CANTMASK) != 0 ||                              \
 536             ((libcfs_debug & (level)) != 0 &&                           \
 537              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
 538                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
 539                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
 540                                     file, func, line);                  \
 541                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
 542                                  ##a );                                 \
 543         }                                                               \
 544 } while(0)
 545
 546 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
 547                       struct libcfs_debug_msg_data *data, const char *fmt,
 548                       ...)
 549         __attribute__ ((format (printf, 4, 5)));
 550
 551 #define LDLM_ERROR(lock, fmt, a...) do {                                \
 552         static cfs_debug_limit_state_t _ldlm_cdls;                      \
 553         ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock,                     \
 554                         __FILE__, __FUNCTION__, __LINE__,               \
 555                         "### " fmt , ##a);                              \
 556 } while (0)
 557
 558 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
 559         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
 560                         __FILE__, __FUNCTION__, __LINE__,               \
 561                          "### " fmt , ##a);                             \
 562 } while (0)
 563 #else
 564 #define LDLM_DEBUG(lock, fmt, a...) ((void)0)
 565 #define LDLM_ERROR(lock, fmt, a...) ((void)0)
 566 #endif
 567
 568 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 569         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
 570
 571 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 572                                       int first_enq, ldlm_error_t *err,
 573                                       struct list_head *work_list);
 574
 575 /*
 576  * Iterators.
 577  */
 578
 579 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 580 #define LDLM_ITER_STOP     2 /* stop iterating */
 581
 582 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 583 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 584
 585 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 586                           void *closure);
 587 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 588                            void *closure);
 589 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
 590                                ldlm_res_iterator_t iter, void *closure);
 591
 592 int ldlm_replay_locks(struct obd_import *imp);
 593 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
 594                            ldlm_iterator_t iter, void *data);
 595
 596 /* ldlm_flock.c */
 597 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 598
 599 /* ldlm_extent.c */
 600 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 601
 602
 603 /* ldlm_lockd.c */
 604 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 605                              void *data, int flag);
 606 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 607 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 608 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 609                         ldlm_blocking_callback, ldlm_glimpse_callback);
 610 int ldlm_handle_convert(struct ptlrpc_request *req);
 611 int ldlm_handle_cancel(struct ptlrpc_request *req);
 612 int ldlm_request_cancel(struct ptlrpc_request *req,
 613                         const struct ldlm_request *dlm_req, int first);
 614 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
 615 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
 616 void ldlm_revoke_export_locks(struct obd_export *exp);
 617 int ldlm_get_ref(void);
 618 void ldlm_put_ref(void);
 619
 620 /* ldlm_lock.c */
 621 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
 622 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
 623 void ldlm_lock2handle(const struct ldlm_lock *lock,
 624                       struct lustre_handle *lockh);
 625 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
 626 void ldlm_cancel_callback(struct ldlm_lock *);
 627 int ldlm_lock_set_data(struct lustre_handle *, void *data);
 628 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
 629 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
 630                                       const struct lustre_handle *);
 631
 632 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
 633 {
 634         return __ldlm_handle2lock(h, 0);
 635 }
 636
 637 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
 638                                        struct lustre_msg *m, int buf_idx,
 639                                        int increase)
 640 {
 641         if (res->lr_namespace->ns_lvbo &&
 642             res->lr_namespace->ns_lvbo->lvbo_update) {
 643                 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
 644                                                                increase);
 645         }
 646         return 0;
 647 }
 648
 649 #define LDLM_LOCK_PUT(lock)                     \
 650 do {                                            \
 651         /*LDLM_DEBUG((lock), "put");*/          \
 652         ldlm_lock_put(lock);                    \
 653 } while (0)
 654
 655 #define LDLM_LOCK_GET(lock)                     \
 656 ({                                              \
 657         ldlm_lock_get(lock);                    \
 658         /*LDLM_DEBUG((lock), "get");*/          \
 659         lock;                                   \
 660 })
 661
 662 #define ldlm_lock_list_put(head, member, count)                 \
 663 ({                                                              \
 664         struct ldlm_lock *_lock, *_next;                        \
 665         int c = count;                                          \
 666         list_for_each_entry_safe(_lock, _next, head, member) {  \
 667                 if (c-- == 0)                                   \
 668                         break;                                  \
 669                 list_del_init(&_lock->member);                  \
 670                 LDLM_LOCK_PUT(_lock);                           \
 671         }                                                       \
 672         LASSERT(c <= 0);                                        \
 673 })
 674
 675 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
 676 void ldlm_lock_put(struct ldlm_lock *lock);
 677 void ldlm_lock_destroy(struct ldlm_lock *lock);
 678 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
 679 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
 680 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
 681 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
 682 void ldlm_lock_allow_match(struct ldlm_lock *lock);
 683 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
 684                             const struct ldlm_res_id *, ldlm_type_t type,
 685                             ldlm_policy_data_t *, ldlm_mode_t mode,
 686                             struct lustre_handle *);
 687 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
 688                                         __u32 *flags);
 689 void ldlm_lock_cancel(struct ldlm_lock *lock);
 690 void ldlm_cancel_locks_for_export(struct obd_export *export);
 691 void ldlm_reprocess_all(struct ldlm_resource *res);
 692 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
 693 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
 694 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
 695 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
 696
 697 /* resource.c */
 698 struct ldlm_namespace *ldlm_namespace_new(char *name, ldlm_side_t client,
 699                                           ldlm_appetite_t apt);
 700 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
 701 void ldlm_namespace_free(struct ldlm_namespace *ns,
 702                          struct obd_import *imp, int force);
 703 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
 704 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
 705 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
 706 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
 707 void ldlm_namespace_get_locked(struct ldlm_namespace *ns);
 708 void ldlm_namespace_put_locked(struct ldlm_namespace *ns, int wakeup);
 709 void ldlm_namespace_get(struct ldlm_namespace *ns);
 710 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
 711 int ldlm_proc_setup(void);
 712 #ifdef LPROCFS
 713 void ldlm_proc_cleanup(void);
 714 #else
 715 static inline void ldlm_proc_cleanup(void) {}
 716 #endif
 717
 718 /* resource.c - internal */
 719 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
 720                                         struct ldlm_resource *parent,
 721                                         const struct ldlm_res_id *,
 722                                         ldlm_type_t type, int create);
 723 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
 724 int ldlm_resource_putref(struct ldlm_resource *res);
 725 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
 726                             struct ldlm_lock *lock);
 727 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
 728 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
 729 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
 730 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
 731 void ldlm_resource_dump(int level, struct ldlm_resource *);
 732 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
 733                               const struct ldlm_res_id *);
 734
 735 struct ldlm_callback_suite {
 736         ldlm_completion_callback lcs_completion;
 737         ldlm_blocking_callback   lcs_blocking;
 738         ldlm_glimpse_callback    lcs_glimpse;
 739 };
 740
 741 /* ldlm_request.c */
 742 int ldlm_expired_completion_wait(void *data);
 743 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 744                       void *data, int flag);
 745 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
 746 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 747 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
 748                      struct ldlm_enqueue_info *einfo,
 749                      const struct ldlm_res_id *res_id,
 750                      ldlm_policy_data_t *policy, int *flags,
 751                      void *lvb, __u32 lvb_len, void *lvb_swabber,
 752                      struct lustre_handle *lockh, int async);
 753 int ldlm_prep_enqueue_req(struct obd_export *exp,
 754                           struct ptlrpc_request *req,
 755                           struct list_head *cancels,
 756                           int count);
 757 int ldlm_prep_elc_req(struct obd_export *exp,
 758                       struct ptlrpc_request *req,
 759                       int version, int opc, int canceloff,
 760                       struct list_head *cancels, int count);
 761 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
 762                          const struct ldlm_request *dlm_req,
 763                          const struct ldlm_callback_suite *cbs);
 764 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
 765                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
 766                           int *flags, void *lvb, __u32 lvb_len,
 767                           void *lvb_swabber, struct lustre_handle *lockh,
 768                           int rc);
 769 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
 770                            const struct ldlm_res_id *res_id,
 771                            ldlm_type_t type, ldlm_policy_data_t *policy,
 772                            ldlm_mode_t mode, int *flags,
 773                            ldlm_blocking_callback blocking,
 774                            ldlm_completion_callback completion,
 775                            ldlm_glimpse_callback glimpse,
 776                            void *data, __u32 lvb_len, void *lvb_swabber,
 777                            struct lustre_handle *lockh);
 778 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
 779                     void *data, __u32 data_len);
 780 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
 781 int ldlm_cli_update_pool(struct ptlrpc_request *req);
 782 int ldlm_handle_convert0(struct ptlrpc_request *req,
 783                          const struct ldlm_request *dlm_req);
 784 int ldlm_cli_cancel(struct lustre_handle *lockh);
 785 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
 786                            int flags, void *opaque);
 787 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
 788                                     const struct ldlm_res_id *res_id,
 789                                     ldlm_policy_data_t *policy,
 790                                     ldlm_mode_t mode, int flags, void *opaque);
 791 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
 792                         int count, int flags);
 793 int ldlm_cli_join_lru(struct ldlm_namespace *,
 794                       const struct ldlm_res_id *, int join);
 795 int ldlm_cancel_resource_local(struct ldlm_resource *res,
 796                                struct list_head *cancels,
 797                                ldlm_policy_data_t *policy,
 798                                ldlm_mode_t mode, int lock_flags,
 799                                int cancel_flags, void *opaque);
 800 int ldlm_cli_cancel_list(struct list_head *head, int count,
 801                          struct ptlrpc_request *req, int flags);
 802
 803 /* mds/handler.c */
 804 /* This has to be here because recursive inclusion sucks. */
 805 int intent_disposition(struct ldlm_reply *rep, int flag);
 806 void intent_set_disposition(struct ldlm_reply *rep, int flag);
 807
 808
 809 /* ioctls for trying requests */
 810 #define IOC_LDLM_TYPE                   'f'
 811 #define IOC_LDLM_MIN_NR                 40
 812
 813 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
 814 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
 815 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
 816 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
 817 #define IOC_LDLM_MAX_NR                 43
 818
 819 static inline void lock_res(struct ldlm_resource *res)
 820 {
 821         spin_lock(&res->lr_lock);
 822 }
 823
 824 static inline void unlock_res(struct ldlm_resource *res)
 825 {
 826         spin_unlock(&res->lr_lock);
 827 }
 828
 829 static inline void check_res_locked(struct ldlm_resource *res)
 830 {
 831         LASSERT_SPIN_LOCKED(&res->lr_lock);
 832 }
 833
 834 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
 835 void unlock_res_and_lock(struct ldlm_lock *lock);
 836
 837 /* ldlm_pool.c */
 838 void ldlm_pools_recalc(ldlm_side_t client);
 839 int ldlm_pools_init(void);
 840 void ldlm_pools_fini(void);
 841 void ldlm_pools_wakeup(void);
 842
 843 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
 844                    int idx, ldlm_side_t client);
 845 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
 846                      unsigned int gfp_mask);
 847 void ldlm_pool_fini(struct ldlm_pool *pl);
 848 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
 849 int ldlm_pool_recalc(struct ldlm_pool *pl);
 850 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
 851 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
 852 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
 853 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
 854 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
 855 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
 856 #endif
 857