lustre/include/lustre_dlm.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef _LUSTRE_DLM_H__
  38 #define _LUSTRE_DLM_H__
  39
  40 /** \defgroup ldlm ldlm
  41  *
  42  * @{
  43  */
  44
  45 #if defined(__linux__)
  46 #include <linux/lustre_dlm.h>
  47 #elif defined(__APPLE__)
  48 #include <darwin/lustre_dlm.h>
  49 #elif defined(__WINNT__)
  50 #include <winnt/lustre_dlm.h>
  51 #else
  52 #error Unsupported operating system.
  53 #endif
  54
  55 #include <lustre_lib.h>
  56 #include <lustre_net.h>
  57 #include <lustre_import.h>
  58 #include <lustre_handles.h>
  59 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
  60 #include <lu_ref.h>
  61
  62 struct obd_ops;
  63 struct obd_device;
  64
  65 #define OBD_LDLM_DEVICENAME  "ldlm"
  66
  67 #ifdef HAVE_BGL_SUPPORT
  68 /* 1.5 times the maximum 128 tasks available in VN mode */
  69 #define LDLM_DEFAULT_LRU_SIZE 196
  70 #else
  71 #define LDLM_DEFAULT_LRU_SIZE (100 * cfs_num_online_cpus())
  72 #endif
  73 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
  74 #define LDLM_CTIME_AGE_LIMIT (10)
  75
  76 typedef enum {
  77         ELDLM_OK = 0,
  78
  79         ELDLM_LOCK_CHANGED = 300,
  80         ELDLM_LOCK_ABORTED = 301,
  81         ELDLM_LOCK_REPLACED = 302,
  82         ELDLM_NO_LOCK_DATA = 303,
  83
  84         ELDLM_NAMESPACE_EXISTS = 400,
  85         ELDLM_BAD_NAMESPACE    = 401
  86 } ldlm_error_t;
  87
  88 typedef enum {
  89         LDLM_NAMESPACE_SERVER = 1 << 0,
  90         LDLM_NAMESPACE_CLIENT = 1 << 1
  91 } ldlm_side_t;
  92
  93 #define LDLM_FL_LOCK_CHANGED   0x000001 /* extent, mode, or resource changed */
  94
  95 /* If the server returns one of these flags, then the lock was put on that list.
  96  * If the client sends one of these flags (during recovery ONLY!), it wants the
  97  * lock added to the specified list, no questions asked. -p */
  98 #define LDLM_FL_BLOCK_GRANTED  0x000002
  99 #define LDLM_FL_BLOCK_CONV     0x000004
 100 #define LDLM_FL_BLOCK_WAIT     0x000008
 101
 102 #define LDLM_FL_CBPENDING      0x000010 /* this lock is being destroyed */
 103 #define LDLM_FL_AST_SENT       0x000020 /* blocking or cancel packet was
 104                                          * queued for sending. */
 105 #define LDLM_FL_WAIT_NOREPROC  0x000040 /* not a real flag, not saved in lock */
 106 #define LDLM_FL_CANCEL         0x000080 /* cancellation callback already run */
 107
 108 /* Lock is being replayed.  This could probably be implied by the fact that one
 109  * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
 110 #define LDLM_FL_REPLAY         0x000100
 111
 112 #define LDLM_FL_INTENT_ONLY    0x000200 /* don't grant lock, just do intent */
 113 #define LDLM_FL_LOCAL_ONLY     0x000400
 114
 115 /* don't run the cancel callback under ldlm_cli_cancel_unused */
 116 #define LDLM_FL_FAILED         0x000800
 117
 118 #define LDLM_FL_HAS_INTENT     0x001000 /* lock request has intent */
 119 #define LDLM_FL_CANCELING      0x002000 /* lock cancel has already been sent */
 120 #define LDLM_FL_LOCAL          0x004000 /* local lock (ie, no srv/cli split) */
 121 /* was LDLM_FL_WARN  until 2.0.0  0x008000 */
 122 #define LDLM_FL_DISCARD_DATA   0x010000 /* discard (no writeback) on cancel */
 123
 124 #define LDLM_FL_NO_TIMEOUT     0x020000 /* Blocked by group lock - wait
 125                                          * indefinitely */
 126
 127 /* file & record locking */
 128 #define LDLM_FL_BLOCK_NOWAIT   0x040000 // server told not to wait if blocked
 129 #define LDLM_FL_TEST_LOCK      0x080000 // return blocking lock
 130
 131 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
 132  * the LVB filling happens _after_ the lock has been granted, so another thread
 133  * can match`t before the LVB has been updated.  As a dirty hack, we set
 134  * LDLM_FL_LVB_READY only after we've done the LVB poop.
 135  * this is only needed on lov/osc now, where lvb is actually used and callers
 136  * must set it in input flags.
 137  *
 138  * The proper fix is to do the granting inside of the completion AST, which can
 139  * be replaced with a LVB-aware wrapping function for OSC locks.  That change is
 140  * pretty high-risk, though, and would need a lot more testing. */
 141
 142 #define LDLM_FL_LVB_READY      0x100000
 143
 144 /* A lock contributes to the kms calculation until it has finished the part
 145  * of it's cancelation that performs write back on its dirty pages.  It
 146  * can remain on the granted list during this whole time.  Threads racing
 147  * to update the kms after performing their writeback need to know to
 148  * exclude each others locks from the calculation as they walk the granted
 149  * list. */
 150 #define LDLM_FL_KMS_IGNORE     0x200000
 151
 152 /* Immediatelly cancel such locks when they block some other locks. Send
 153  * cancel notification to original lock holder, but expect no reply. This is
 154  * for clients (like liblustre) that cannot be expected to reliably response
 155  * to blocking ast. */
 156 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
 157
 158 /* Flags flags inherited from parent lock when doing intents. */
 159 #define LDLM_INHERIT_FLAGS     (LDLM_FL_CANCEL_ON_BLOCK)
 160
 161 /* completion ast to be executed */
 162 #define LDLM_FL_CP_REQD        0x1000000
 163
 164 /* cleanup_resource has already handled the lock */
 165 #define LDLM_FL_CLEANED        0x2000000
 166
 167 /* optimization hint: LDLM can run blocking callback from current context
 168  * w/o involving separate thread. in order to decrease cs rate */
 169 #define LDLM_FL_ATOMIC_CB      0x4000000
 170
 171 /* was LDLM_FL_ASYNC until 2.0.0 0x8000000 */
 172
 173 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
 174  * such that server send blocking ast for conflict locks to this client for
 175  * the 1st operation, whereas the 2nd operation has canceled this lock and
 176  * is waiting for rpc_lock which is taken by the 1st operation.
 177  * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
 178  * ELC code to cancel it.
 179  * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
 180  * droped to let ldlm_callback_handler() return EINVAL to the server. It is
 181  * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
 182  * to send a separate CANCEL rpc. */
 183 #define LDLM_FL_BL_AST          0x10000000
 184 #define LDLM_FL_BL_DONE         0x20000000
 185
 186 /* measure lock contention and return -EUSERS if locking contention is high */
 187 #define LDLM_FL_DENY_ON_CONTENTION 0x40000000
 188
 189 /* These are flags that are mapped into the flags and ASTs of blocking locks */
 190 #define LDLM_AST_DISCARD_DATA  0x80000000 /* Add FL_DISCARD to blocking ASTs */
 191
 192 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
 193 #define LDLM_AST_FLAGS         (LDLM_FL_DISCARD_DATA)
 194
 195 /*
 196  * --------------------------------------------------------------------------
 197  * NOTE! Starting from this point, that is, LDLM_FL_* flags with values above
 198  * 0x80000000 will not be sent over the wire.
 199  * --------------------------------------------------------------------------
 200  */
 201
 202 /* Used for marking lock as an target for -EINTR while cp_ast sleep
 203  * emulation + race with upcoming bl_ast.  */
 204 #define LDLM_FL_FAIL_LOC       0x100000000ULL
 205
 206 /* Used while processing the unused list to know that we have already
 207  * handled this lock and decided to skip it */
 208 #define LDLM_FL_SKIPPED        0x200000000ULL
 209
 210 /* The blocking callback is overloaded to perform two functions.  These flags
 211  * indicate which operation should be performed. */
 212 #define LDLM_CB_BLOCKING    1
 213 #define LDLM_CB_CANCELING   2
 214
 215 /* compatibility matrix */
 216 #define LCK_COMPAT_EX  LCK_NL
 217 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
 218 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
 219 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
 220 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
 221 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
 222 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
 223 #define LCK_COMPAT_COS (LCK_COS)
 224
 225 extern ldlm_mode_t lck_compat_array[];
 226
 227 static inline void lockmode_verify(ldlm_mode_t mode)
 228 {
 229        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
 230 }
 231
 232 static inline int lockmode_compat(ldlm_mode_t exist_mode, ldlm_mode_t new_mode)
 233 {
 234        return (lck_compat_array[exist_mode] & new_mode);
 235 }
 236
 237 /*
 238  *
 239  * cluster name spaces
 240  *
 241  */
 242
 243 #define DLM_OST_NAMESPACE 1
 244 #define DLM_MDS_NAMESPACE 2
 245
 246 /* XXX
 247    - do we just separate this by security domains and use a prefix for
 248      multiple namespaces in the same domain?
 249    -
 250 */
 251
 252 /*
 253  * Locking rules:
 254  *
 255  * lr_lock
 256  *
 257  * lr_lock
 258  *     waiting_locks_spinlock
 259  *
 260  * lr_lock
 261  *     led_lock
 262  *
 263  * lr_lock
 264  *     ns_unused_lock
 265  *
 266  * lr_lvb_sem
 267  *     lr_lock
 268  *
 269  */
 270
 271 struct ldlm_pool;
 272 struct ldlm_lock;
 273 struct ldlm_resource;
 274 struct ldlm_namespace;
 275
 276 struct ldlm_pool_ops {
 277         int (*po_recalc)(struct ldlm_pool *pl);
 278         int (*po_shrink)(struct ldlm_pool *pl, int nr,
 279                          unsigned int gfp_mask);
 280         int (*po_setup)(struct ldlm_pool *pl, int limit);
 281 };
 282
 283 /**
 284  * One second for pools thread check interval. Each pool has own period.
 285  */
 286 #define LDLM_POOLS_THREAD_PERIOD (1)
 287
 288 /**
 289  * ~6% margin for modest pools. See ldlm_pool.c for details.
 290  */
 291 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
 292
 293 /**
 294  * Default recalc period for server side pools in sec.
 295  */
 296 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
 297
 298 /**
 299  * Default recalc period for client side pools in sec.
 300  */
 301 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
 302
 303 struct ldlm_pool {
 304         /**
 305          * Pool proc directory.
 306          */
 307         cfs_proc_dir_entry_t  *pl_proc_dir;
 308         /**
 309          * Pool name, should be long enough to contain compound proc entry name.
 310          */
 311         char                   pl_name[100];
 312         /**
 313          * Lock for protecting slv/clv updates.
 314          */
 315         cfs_spinlock_t         pl_lock;
 316         /**
 317          * Number of allowed locks in in pool, both, client and server side.
 318          */
 319         cfs_atomic_t           pl_limit;
 320         /**
 321          * Number of granted locks in
 322          */
 323         cfs_atomic_t           pl_granted;
 324         /**
 325          * Grant rate per T.
 326          */
 327         cfs_atomic_t           pl_grant_rate;
 328         /**
 329          * Cancel rate per T.
 330          */
 331         cfs_atomic_t           pl_cancel_rate;
 332         /**
 333          * Server lock volume. Protected by pl_lock.
 334          */
 335         __u64                  pl_server_lock_volume;
 336         /**
 337          * Current biggest client lock volume. Protected by pl_lock.
 338          */
 339         __u64                  pl_client_lock_volume;
 340         /**
 341          * Lock volume factor. SLV on client is calculated as following:
 342          * server_slv * lock_volume_factor.
 343          */
 344         cfs_atomic_t           pl_lock_volume_factor;
 345         /**
 346          * Time when last slv from server was obtained.
 347          */
 348         time_t                 pl_recalc_time;
 349         /**
 350           * Recalc period for pool.
 351           */
 352         time_t                 pl_recalc_period;
 353         /**
 354          * Recalc and shrink ops.
 355          */
 356         struct ldlm_pool_ops  *pl_ops;
 357         /**
 358          * Number of planned locks for next period.
 359          */
 360         int                    pl_grant_plan;
 361         /**
 362          * Pool statistics.
 363          */
 364         struct lprocfs_stats  *pl_stats;
 365 };
 366
 367 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
 368                                void *req_cookie, ldlm_mode_t mode, int flags,
 369                                void *data);
 370
 371 typedef int (*ldlm_cancel_for_recovery)(struct ldlm_lock *lock);
 372
 373 struct ldlm_valblock_ops {
 374         int (*lvbo_init)(struct ldlm_resource *res);
 375         int (*lvbo_update)(struct ldlm_resource *res,
 376                            struct ptlrpc_request *r,
 377                            int increase);
 378         int (*lvbo_free)(struct ldlm_resource *res);
 379 };
 380
 381 typedef enum {
 382         LDLM_NAMESPACE_GREEDY = 1 << 0,
 383         LDLM_NAMESPACE_MODEST = 1 << 1
 384 } ldlm_appetite_t;
 385
 386 /*
 387  * Default values for the "max_nolock_size", "contention_time" and
 388  * "contended_locks" namespace tunables.
 389  */
 390 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
 391 #define NS_DEFAULT_CONTENTION_SECONDS 2
 392 #define NS_DEFAULT_CONTENDED_LOCKS 32
 393
 394 struct ldlm_namespace {
 395         /**
 396          * Namespace name. Used for logging, etc.
 397          */
 398         char                  *ns_name;
 399
 400         /**
 401          * Is this a client-side lock tree?
 402          */
 403         ldlm_side_t            ns_client;
 404
 405         /**
 406          * Namespce connect flags supported by server (may be changed via proc,
 407          * lru resize may be disabled/enabled).
 408          */
 409         __u64                  ns_connect_flags;
 410
 411          /**
 412           * Client side orig connect flags supported by server.
 413           */
 414         __u64                  ns_orig_connect_flags;
 415
 416         /**
 417          * Hash table for namespace.
 418          */
 419         cfs_list_t            *ns_hash;
 420         cfs_spinlock_t         ns_hash_lock;
 421
 422          /**
 423           * Count of resources in the hash.
 424           */
 425         __u32                  ns_refcount;
 426
 427          /**
 428           * All root resources in namespace.
 429           */
 430         cfs_list_t             ns_root_list;
 431
 432         /**
 433          * Position in global namespace list.
 434          */
 435         cfs_list_t             ns_list_chain;
 436
 437         /**
 438          * All root resources in namespace.
 439          */
 440         cfs_list_t             ns_unused_list;
 441         int                    ns_nr_unused;
 442         cfs_spinlock_t         ns_unused_lock;
 443
 444         unsigned int           ns_max_unused;
 445         unsigned int           ns_max_age;
 446         unsigned int           ns_timeouts;
 447          /**
 448           * Seconds.
 449           */
 450         unsigned int           ns_ctime_age_limit;
 451
 452         /**
 453          * Next debug dump, jiffies.
 454          */
 455         cfs_time_t             ns_next_dump;
 456
 457         cfs_atomic_t           ns_locks;
 458         __u64                  ns_resources;
 459         ldlm_res_policy        ns_policy;
 460         struct ldlm_valblock_ops *ns_lvbo;
 461         void                  *ns_lvbp;
 462         cfs_waitq_t            ns_waitq;
 463         struct ldlm_pool       ns_pool;
 464         ldlm_appetite_t        ns_appetite;
 465
 466         /**
 467          * If more than \a ns_contended_locks found, the resource is considered
 468          * to be contended.
 469          */
 470         unsigned               ns_contended_locks;
 471
 472         /**
 473          * The resource remembers contended state during \a ns_contention_time,
 474          * in seconds.
 475          */
 476         unsigned               ns_contention_time;
 477
 478         /**
 479          * Limit size of nolock requests, in bytes.
 480          */
 481         unsigned               ns_max_nolock_size;
 482
 483         /**
 484          * Backward link to obd, required for ldlm pool to store new SLV.
 485          */
 486         struct obd_device     *ns_obd;
 487
 488         struct adaptive_timeout ns_at_estimate;/* estimated lock callback time*/
 489
 490         /* callback to cancel locks before replaying it during recovery */
 491         ldlm_cancel_for_recovery ns_cancel_for_recovery;
 492 };
 493
 494 static inline int ns_is_client(struct ldlm_namespace *ns)
 495 {
 496         LASSERT(ns != NULL);
 497         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 498                                     LDLM_NAMESPACE_SERVER)));
 499         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 500                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 501         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
 502 }
 503
 504 static inline int ns_is_server(struct ldlm_namespace *ns)
 505 {
 506         LASSERT(ns != NULL);
 507         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 508                                     LDLM_NAMESPACE_SERVER)));
 509         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 510                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 511         return ns->ns_client == LDLM_NAMESPACE_SERVER;
 512 }
 513
 514 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
 515 {
 516         LASSERT(ns != NULL);
 517         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
 518 }
 519
 520 static inline void ns_register_cancel(struct ldlm_namespace *ns,
 521                                       ldlm_cancel_for_recovery arg)
 522 {
 523         LASSERT(ns != NULL);
 524         ns->ns_cancel_for_recovery = arg;
 525 }
 526
 527 /*
 528  *
 529  * Resource hash table
 530  *
 531  */
 532
 533 #define RES_HASH_BITS 12
 534 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 535 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 536
 537 struct ldlm_lock;
 538
 539 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 540                                       struct ldlm_lock_desc *new, void *data,
 541                                       int flag);
 542 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
 543                                         void *data);
 544 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
 545 typedef unsigned long (*ldlm_weigh_callback)(struct ldlm_lock *lock);
 546
 547 /* Interval node data for each LDLM_EXTENT lock */
 548 struct ldlm_interval {
 549         struct interval_node li_node;   /* node for tree mgmt */
 550         cfs_list_t           li_group;  /* the locks which have the same
 551                                          * policy - group of the policy */
 552 };
 553 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
 554
 555 /* the interval tree must be accessed inside the resource lock. */
 556 struct ldlm_interval_tree {
 557         /* tree size, this variable is used to count
 558          * granted PW locks in ldlm_extent_policy()*/
 559         int                   lit_size;
 560         ldlm_mode_t           lit_mode; /* lock mode */
 561         struct interval_node *lit_root; /* actually ldlm_interval */
 562 };
 563
 564 #define LUSTRE_TRACKS_LOCK_EXP_REFS (1)
 565
 566 /* Cancel flag. */
 567 typedef enum {
 568         LCF_ASYNC      = 0x1, /* Cancel locks asynchronously. */
 569         LCF_LOCAL      = 0x2, /* Cancel locks locally, not notifing server */
 570         LCF_BL_AST     = 0x4, /* Cancel locks marked as LDLM_FL_BL_AST
 571                                * in the same RPC */
 572 } ldlm_cancel_flags_t;
 573
 574 struct ldlm_lock {
 575         /**
 576          * Must be first in the structure.
 577          */
 578         struct portals_handle    l_handle;
 579         /**
 580          * Lock reference count.
 581          */
 582         cfs_atomic_t             l_refc;
 583         /**
 584          * Internal spinlock protects l_resource.  we should hold this lock
 585          * first before grabbing res_lock.
 586          */
 587         cfs_spinlock_t           l_lock;
 588         /**
 589          * ldlm_lock_change_resource() can change this.
 590          */
 591         struct ldlm_resource    *l_resource;
 592         /**
 593          * Protected by ns_hash_lock. List item for client side lru list.
 594          */
 595         cfs_list_t               l_lru;
 596         /**
 597          * Protected by lr_lock, linkage to resource's lock queues.
 598          */
 599         cfs_list_t               l_res_link;
 600         /**
 601          * Tree node for ldlm_extent.
 602          */
 603         struct ldlm_interval    *l_tree_node;
 604         /**
 605          * Protected by per-bucket exp->exp_lock_hash locks. Per export hash
 606          * of locks.
 607          */
 608         cfs_hlist_node_t         l_exp_hash;
 609         /**
 610          * Protected by lr_lock. Requested mode.
 611          */
 612         ldlm_mode_t              l_req_mode;
 613         /**
 614          * Granted mode, also protected by lr_lock.
 615          */
 616         ldlm_mode_t              l_granted_mode;
 617         /**
 618          * Lock enqueue completion handler.
 619          */
 620         ldlm_completion_callback l_completion_ast;
 621         /**
 622          * Lock blocking ast handler.
 623          */
 624         ldlm_blocking_callback   l_blocking_ast;
 625         /**
 626          * Lock glimpse handler.
 627          */
 628         ldlm_glimpse_callback    l_glimpse_ast;
 629         ldlm_weigh_callback      l_weigh_ast;
 630
 631         /**
 632          * Lock export.
 633          */
 634         struct obd_export       *l_export;
 635         /**
 636          * Lock connection export.
 637          */
 638         struct obd_export       *l_conn_export;
 639
 640         /**
 641          * Remote lock handle.
 642          */
 643         struct lustre_handle     l_remote_handle;
 644
 645         ldlm_policy_data_t       l_policy_data;
 646
 647         /*
 648          * Protected by lr_lock. Various counters: readers, writers, etc.
 649          */
 650         __u64                 l_flags;
 651         __u32                 l_readers;
 652         __u32                 l_writers;
 653         /*
 654          * Set for locks that were removed from class hash table and will be
 655          * destroyed when last reference to them is released. Set by
 656          * ldlm_lock_destroy_internal().
 657          *
 658          * Protected by lock and resource locks.
 659          */
 660         __u8                  l_destroyed;
 661         /**
 662          * flag whether this is a server namespace lock
 663          */
 664         __u8                  l_ns_srv;
 665         /**
 666          * If the lock is granted, a process sleeps on this waitq to learn when
 667          * it's no longer in use.  If the lock is not granted, a process sleeps
 668          * on this waitq to learn when it becomes granted.
 669          */
 670         cfs_waitq_t           l_waitq;
 671
 672         /**
 673          * Seconds. it will be updated if there is any activity related to
 674          * the lock, e.g. enqueue the lock or send block AST.
 675          */
 676         cfs_time_t            l_last_activity;
 677
 678         /**
 679          * Jiffies. Should be converted to time if needed.
 680          */
 681         cfs_time_t            l_last_used;
 682
 683         struct ldlm_extent    l_req_extent;
 684
 685         /*
 686          * Client-side-only members.
 687          */
 688
 689         /**
 690          * Temporary storage for an LVB received during an enqueue operation.
 691          */
 692         __u32                 l_lvb_len;
 693         void                 *l_lvb_data;
 694
 695         void                 *l_ast_data;
 696
 697         /*
 698          * Server-side-only members.
 699          */
 700
 701         /** connection cookie for the client originated the operation. */
 702         __u64                 l_client_cookie;
 703
 704         /**
 705          * Protected by elt_lock. Callbacks pending.
 706          */
 707         cfs_list_t            l_pending_chain;
 708
 709         cfs_time_t            l_callback_timeout;
 710
 711         /**
 712          * Pid which created this lock.
 713          */
 714         __u32                 l_pid;
 715
 716         /**
 717          * For ldlm_add_ast_work_item().
 718          */
 719         cfs_list_t            l_bl_ast;
 720         /**
 721          * For ldlm_add_ast_work_item().
 722          */
 723         cfs_list_t            l_cp_ast;
 724         /**
 725          * For ldlm_add_ast_work_item().
 726          */
 727         cfs_list_t            l_rk_ast;
 728
 729         struct ldlm_lock     *l_blocking_lock;
 730         int                   l_bl_ast_run;
 731
 732         /**
 733          * Protected by lr_lock, linkages to "skip lists".
 734          */
 735         cfs_list_t            l_sl_mode;
 736         cfs_list_t            l_sl_policy;
 737         struct lu_ref         l_reference;
 738 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 739         /* Debugging stuff for bug 20498, for tracking export
 740            references. */
 741         /** number of export references taken */
 742         int                   l_exp_refs_nr;
 743         /** link all locks referencing one export */
 744         cfs_list_t            l_exp_refs_link;
 745         /** referenced export object */
 746         struct obd_export    *l_exp_refs_target;
 747 #endif
 748 };
 749
 750 struct ldlm_resource {
 751         struct ldlm_namespace *lr_namespace;
 752
 753         /* protected by ns_hash_lock */
 754         cfs_list_t             lr_hash;
 755         cfs_list_t             lr_childof;  /* part of ns_root_list if root res,
 756                                              * part of lr_children if child */
 757         cfs_spinlock_t         lr_lock;
 758
 759         /* protected by lr_lock */
 760         cfs_list_t             lr_granted;
 761         cfs_list_t             lr_converting;
 762         cfs_list_t             lr_waiting;
 763         ldlm_mode_t            lr_most_restr;
 764         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 765         struct ldlm_res_id     lr_name;
 766         cfs_atomic_t           lr_refcount;
 767
 768         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
 769
 770         /* Server-side-only lock value block elements */
 771         cfs_semaphore_t        lr_lvb_sem;
 772         __u32                  lr_lvb_len;
 773         void                  *lr_lvb_data;
 774
 775         /* when the resource was considered as contended */
 776         cfs_time_t             lr_contention_time;
 777         /**
 778          * List of references to this resource. For debugging.
 779          */
 780         struct lu_ref          lr_reference;
 781
 782         struct inode          *lr_lvb_inode;
 783 };
 784
 785 static inline struct ldlm_namespace *
 786 ldlm_res_to_ns(struct ldlm_resource *res)
 787 {
 788         return res->lr_namespace;
 789 }
 790
 791 static inline struct ldlm_namespace *
 792 ldlm_lock_to_ns(struct ldlm_lock *lock)
 793 {
 794         return ldlm_res_to_ns(lock->l_resource);
 795 }
 796
 797 static inline char *
 798 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
 799 {
 800         return ldlm_lock_to_ns(lock)->ns_name;
 801 }
 802
 803 static inline struct adaptive_timeout *
 804 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
 805 {
 806         return &ldlm_lock_to_ns(lock)->ns_at_estimate;
 807 }
 808
 809 struct ldlm_ast_work {
 810         struct ldlm_lock      *w_lock;
 811         int                    w_blocking;
 812         struct ldlm_lock_desc  w_desc;
 813         cfs_list_t             w_list;
 814         int                    w_flags;
 815         void                  *w_data;
 816         int                    w_datalen;
 817 };
 818
 819 /* ldlm_enqueue parameters common */
 820 struct ldlm_enqueue_info {
 821         __u32 ei_type;   /* Type of the lock being enqueued. */
 822         __u32 ei_mode;   /* Mode of the lock being enqueued. */
 823         void *ei_cb_bl;  /* blocking lock callback */
 824         void *ei_cb_cp;  /* lock completion callback */
 825         void *ei_cb_gl;  /* lock glimpse callback */
 826         void *ei_cb_wg;  /* lock weigh callback */
 827         void *ei_cbdata; /* Data to be passed into callbacks. */
 828         short ei_async:1; /* async request */
 829 };
 830
 831 extern struct obd_ops ldlm_obd_ops;
 832
 833 extern char *ldlm_lockname[];
 834 extern char *ldlm_typename[];
 835 extern char *ldlm_it2str(int it);
 836 #ifdef LIBCFS_DEBUG
 837 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
 838         CFS_CHECK_STACK();                                              \
 839                                                                         \
 840         if (((level) & D_CANTMASK) != 0 ||                              \
 841             ((libcfs_debug & (level)) != 0 &&                           \
 842              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
 843                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
 844                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
 845                                     file, func, line);                  \
 846                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
 847                                  ##a );                                 \
 848         }                                                               \
 849 } while(0)
 850
 851 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
 852                       struct libcfs_debug_msg_data *data, const char *fmt,
 853                       ...)
 854         __attribute__ ((format (printf, 4, 5)));
 855
 856 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do {                    \
 857         static cfs_debug_limit_state_t _ldlm_cdls;                      \
 858         ldlm_lock_debug(&_ldlm_cdls, mask, lock,                        \
 859                         __FILE__, __FUNCTION__, __LINE__,               \
 860                         "### " fmt , ##a);                              \
 861 } while (0)
 862
 863 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
 864 #define LDLM_WARN(lock, fmt, a...)  LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
 865
 866 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
 867         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
 868                         __FILE__, __FUNCTION__, __LINE__,               \
 869                          "### " fmt , ##a);                             \
 870 } while (0)
 871 #else /* !LIBCFS_DEBUG */
 872 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
 873 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
 874 # define ldlm_lock_debuf(cdls, level, lock, file, func, line, fmt, a...) \
 875          ((void)0)
 876 #endif
 877
 878 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 879         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
 880
 881 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 882                                       int first_enq, ldlm_error_t *err,
 883                                       cfs_list_t *work_list);
 884
 885 /*
 886  * Iterators.
 887  */
 888
 889 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 890 #define LDLM_ITER_STOP     2 /* stop iterating */
 891
 892 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 893 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 894
 895 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 896                           void *closure);
 897 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 898                            void *closure);
 899 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
 900                                ldlm_res_iterator_t iter, void *closure);
 901
 902 int ldlm_replay_locks(struct obd_import *imp);
 903 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
 904                            ldlm_iterator_t iter, void *data);
 905
 906 /* ldlm_flock.c */
 907 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 908
 909 /* ldlm_extent.c */
 910 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 911
 912
 913 /* ldlm_lockd.c */
 914 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 915                              void *data, int flag);
 916 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 917 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 918 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 919                         ldlm_blocking_callback, ldlm_glimpse_callback);
 920 int ldlm_handle_convert(struct ptlrpc_request *req);
 921 int ldlm_handle_cancel(struct ptlrpc_request *req);
 922 int ldlm_request_cancel(struct ptlrpc_request *req,
 923                         const struct ldlm_request *dlm_req, int first);
 924 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
 925 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
 926 void ldlm_revoke_export_locks(struct obd_export *exp);
 927 int ldlm_get_ref(void);
 928 void ldlm_put_ref(void);
 929 int ldlm_init_export(struct obd_export *exp);
 930 void ldlm_destroy_export(struct obd_export *exp);
 931
 932 /* ldlm_lock.c */
 933 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
 934 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
 935 void ldlm_lock2handle(const struct ldlm_lock *lock,
 936                       struct lustre_handle *lockh);
 937 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
 938 void ldlm_cancel_callback(struct ldlm_lock *);
 939 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
 940
 941 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
 942 {
 943         return __ldlm_handle2lock(h, 0);
 944 }
 945
 946 #define LDLM_LOCK_REF_DEL(lock) \
 947         lu_ref_del(&lock->l_reference, "handle", cfs_current())
 948
 949 static inline struct ldlm_lock *
 950 ldlm_handle2lock_long(const struct lustre_handle *h, int flags)
 951 {
 952         struct ldlm_lock *lock;
 953
 954         lock = __ldlm_handle2lock(h, flags);
 955         if (lock != NULL)
 956                 LDLM_LOCK_REF_DEL(lock);
 957         return lock;
 958 }
 959
 960 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
 961                                        struct ptlrpc_request *r, int increase)
 962 {
 963         if (ldlm_res_to_ns(res)->ns_lvbo &&
 964             ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
 965                 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, r,
 966                                                                  increase);
 967         }
 968         return 0;
 969 }
 970
 971 int ldlm_error2errno(ldlm_error_t error);
 972 ldlm_error_t ldlm_errno2error(int err_no); /* don't call it `errno': this
 973                                             * confuses user-space. */
 974 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 975 void ldlm_dump_export_locks(struct obd_export *exp);
 976 #endif
 977
 978 /**
 979  * Release a temporary lock reference obtained by ldlm_handle2lock() or
 980  * __ldlm_handle2lock().
 981  */
 982 #define LDLM_LOCK_PUT(lock)                     \
 983 do {                                            \
 984         LDLM_LOCK_REF_DEL(lock);                \
 985         /*LDLM_DEBUG((lock), "put");*/          \
 986         ldlm_lock_put(lock);                    \
 987 } while (0)
 988
 989 /**
 990  * Release a lock reference obtained by some other means (see
 991  * LDLM_LOCK_PUT()).
 992  */
 993 #define LDLM_LOCK_RELEASE(lock)                 \
 994 do {                                            \
 995         /*LDLM_DEBUG((lock), "put");*/          \
 996         ldlm_lock_put(lock);                    \
 997 } while (0)
 998
 999 #define LDLM_LOCK_GET(lock)                     \
1000 ({                                              \
1001         ldlm_lock_get(lock);                    \
1002         /*LDLM_DEBUG((lock), "get");*/          \
1003         lock;                                   \
1004 })
1005
1006 #define ldlm_lock_list_put(head, member, count)                     \
1007 ({                                                                  \
1008         struct ldlm_lock *_lock, *_next;                            \
1009         int c = count;                                              \
1010         cfs_list_for_each_entry_safe(_lock, _next, head, member) {  \
1011                 if (c-- == 0)                                       \
1012                         break;                                      \
1013                 cfs_list_del_init(&_lock->member);                  \
1014                 LDLM_LOCK_RELEASE(_lock);                           \
1015         }                                                           \
1016         LASSERT(c <= 0);                                            \
1017 })
1018
1019 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1020 void ldlm_lock_put(struct ldlm_lock *lock);
1021 void ldlm_lock_destroy(struct ldlm_lock *lock);
1022 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1023 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
1024 int  ldlm_lock_addref_try(struct lustre_handle *lockh, __u32 mode);
1025 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
1026 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
1027 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1028 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1029 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
1030                             const struct ldlm_res_id *, ldlm_type_t type,
1031                             ldlm_policy_data_t *, ldlm_mode_t mode,
1032                             struct lustre_handle *, int unref);
1033 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
1034                                         __u32 *flags);
1035 void ldlm_lock_downgrade(struct ldlm_lock *lock, int new_mode);
1036 void ldlm_lock_cancel(struct ldlm_lock *lock);
1037 void ldlm_reprocess_all(struct ldlm_resource *res);
1038 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1039 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
1040 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
1041 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1042
1043 /* resource.c */
1044 struct ldlm_namespace *
1045 ldlm_namespace_new(struct obd_device *obd, char *name,
1046                    ldlm_side_t client, ldlm_appetite_t apt);
1047 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
1048 void ldlm_namespace_free(struct ldlm_namespace *ns,
1049                          struct obd_import *imp, int force);
1050 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
1051 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
1052 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
1053 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
1054 void ldlm_namespace_get_locked(struct ldlm_namespace *ns);
1055 void ldlm_namespace_put_locked(struct ldlm_namespace *ns, int wakeup);
1056 void ldlm_namespace_get(struct ldlm_namespace *ns);
1057 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
1058 int ldlm_proc_setup(void);
1059 #ifdef LPROCFS
1060 void ldlm_proc_cleanup(void);
1061 #else
1062 static inline void ldlm_proc_cleanup(void) {}
1063 #endif
1064
1065 /* resource.c - internal */
1066 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1067                                         struct ldlm_resource *parent,
1068                                         const struct ldlm_res_id *,
1069                                         ldlm_type_t type, int create);
1070 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1071 int ldlm_resource_putref(struct ldlm_resource *res);
1072 void ldlm_resource_add_lock(struct ldlm_resource *res,
1073                             cfs_list_t *head,
1074                             struct ldlm_lock *lock);
1075 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1076 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1077 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
1078 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1079 void ldlm_resource_dump(int level, struct ldlm_resource *);
1080 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1081                               const struct ldlm_res_id *);
1082
1083 #define LDLM_RESOURCE_ADDREF(res) do {                                  \
1084         lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, cfs_current());  \
1085 } while (0)
1086
1087 #define LDLM_RESOURCE_DELREF(res) do {                                  \
1088         lu_ref_del(&(res)->lr_reference, __FUNCTION__, cfs_current());  \
1089 } while (0)
1090
1091 struct ldlm_callback_suite {
1092         ldlm_completion_callback lcs_completion;
1093         ldlm_blocking_callback   lcs_blocking;
1094         ldlm_glimpse_callback    lcs_glimpse;
1095         ldlm_weigh_callback      lcs_weigh;
1096 };
1097
1098 /* ldlm_request.c */
1099 int ldlm_expired_completion_wait(void *data);
1100 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1101 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1102                       void *data, int flag);
1103 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1104 int ldlm_completion_ast_async(struct ldlm_lock *lock, int flags, void *data);
1105 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
1106 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1107                      struct ldlm_enqueue_info *einfo,
1108                      const struct ldlm_res_id *res_id,
1109                      ldlm_policy_data_t const *policy, int *flags,
1110                      void *lvb, __u32 lvb_len, struct lustre_handle *lockh,
1111                      int async);
1112 int ldlm_prep_enqueue_req(struct obd_export *exp,
1113                           struct ptlrpc_request *req,
1114                           cfs_list_t *cancels,
1115                           int count);
1116 int ldlm_prep_elc_req(struct obd_export *exp,
1117                       struct ptlrpc_request *req,
1118                       int version, int opc, int canceloff,
1119                       cfs_list_t *cancels, int count);
1120 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1121                          const struct ldlm_request *dlm_req,
1122                          const struct ldlm_callback_suite *cbs);
1123 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1124                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
1125                           int *flags, void *lvb, __u32 lvb_len,
1126                           struct lustre_handle *lockh, int rc);
1127 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1128                            const struct ldlm_res_id *res_id,
1129                            ldlm_type_t type, ldlm_policy_data_t *policy,
1130                            ldlm_mode_t mode, int *flags,
1131                            ldlm_blocking_callback blocking,
1132                            ldlm_completion_callback completion,
1133                            ldlm_glimpse_callback glimpse,
1134                            void *data, __u32 lvb_len,
1135                            const __u64 *client_cookie,
1136                            struct lustre_handle *lockh);
1137 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
1138                     void *data, __u32 data_len);
1139 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
1140 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1141 int ldlm_handle_convert0(struct ptlrpc_request *req,
1142                          const struct ldlm_request *dlm_req);
1143 int ldlm_cli_cancel(struct lustre_handle *lockh);
1144 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1145                            ldlm_cancel_flags_t flags, void *opaque);
1146 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1147                                     const struct ldlm_res_id *res_id,
1148                                     ldlm_policy_data_t *policy,
1149                                     ldlm_mode_t mode,
1150                                     ldlm_cancel_flags_t flags,
1151                                     void *opaque);
1152 int ldlm_cli_cancel_req(struct obd_export *exp, cfs_list_t *head,
1153                         int count, ldlm_cancel_flags_t flags);
1154 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1155                                cfs_list_t *cancels,
1156                                ldlm_policy_data_t *policy,
1157                                ldlm_mode_t mode, int lock_flags,
1158                                ldlm_cancel_flags_t cancel_flags, void *opaque);
1159 int ldlm_cli_cancel_list_local(cfs_list_t *cancels, int count,
1160                                ldlm_cancel_flags_t flags);
1161 int ldlm_cli_cancel_list(cfs_list_t *head, int count,
1162                          struct ptlrpc_request *req, ldlm_cancel_flags_t flags);
1163
1164 /* mds/handler.c */
1165 /* This has to be here because recursive inclusion sucks. */
1166 int intent_disposition(struct ldlm_reply *rep, int flag);
1167 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1168
1169
1170 /* ioctls for trying requests */
1171 #define IOC_LDLM_TYPE                   'f'
1172 #define IOC_LDLM_MIN_NR                 40
1173
1174 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
1175 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
1176 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
1177 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
1178 #define IOC_LDLM_MAX_NR                 43
1179
1180 /**
1181  * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1182  * than one lock_res is dead-lock safe.
1183  */
1184 enum lock_res_type {
1185         LRT_NORMAL,
1186         LRT_NEW
1187 };
1188
1189 static inline void lock_res(struct ldlm_resource *res)
1190 {
1191         cfs_spin_lock(&res->lr_lock);
1192 }
1193
1194 static inline void lock_res_nested(struct ldlm_resource *res,
1195                                    enum lock_res_type mode)
1196 {
1197         cfs_spin_lock_nested(&res->lr_lock, mode);
1198 }
1199
1200
1201 static inline void unlock_res(struct ldlm_resource *res)
1202 {
1203         cfs_spin_unlock(&res->lr_lock);
1204 }
1205
1206 static inline void check_res_locked(struct ldlm_resource *res)
1207 {
1208         LASSERT_SPIN_LOCKED(&res->lr_lock);
1209 }
1210
1211 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1212 void unlock_res_and_lock(struct ldlm_lock *lock);
1213
1214 /* ldlm_pool.c */
1215 void ldlm_pools_recalc(ldlm_side_t client);
1216 int ldlm_pools_init(void);
1217 void ldlm_pools_fini(void);
1218
1219 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1220                    int idx, ldlm_side_t client);
1221 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
1222                      unsigned int gfp_mask);
1223 void ldlm_pool_fini(struct ldlm_pool *pl);
1224 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1225 int ldlm_pool_recalc(struct ldlm_pool *pl);
1226 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1227 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1228 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1229 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1230 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1231 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1232 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1233 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1234 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1235
1236 /** @} ldlm */
1237
1238 #endif