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