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