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          * Grant speed (GR-CR) per T.
 334          */
 335         cfs_atomic_t           pl_grant_speed;
 336         /**
 337          * Server lock volume. Protected by pl_lock.
 338          */
 339         __u64                  pl_server_lock_volume;
 340         /**
 341          * Current biggest client lock volume. Protected by pl_lock.
 342          */
 343         __u64                  pl_client_lock_volume;
 344         /**
 345          * Lock volume factor. SLV on client is calculated as following:
 346          * server_slv * lock_volume_factor.
 347          */
 348         cfs_atomic_t           pl_lock_volume_factor;
 349         /**
 350          * Time when last slv from server was obtained.
 351          */
 352         time_t                 pl_recalc_time;
 353         /**
 354           * Recalc period for pool.
 355           */
 356         time_t                 pl_recalc_period;
 357         /**
 358          * Recalc and shrink ops.
 359          */
 360         struct ldlm_pool_ops  *pl_ops;
 361         /**
 362          * Number of planned locks for next period.
 363          */
 364         int                    pl_grant_plan;
 365         /**
 366          * Pool statistics.
 367          */
 368         struct lprocfs_stats  *pl_stats;
 369 };
 370
 371 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
 372                                void *req_cookie, ldlm_mode_t mode, int flags,
 373                                void *data);
 374
 375 typedef int (*ldlm_cancel_for_recovery)(struct ldlm_lock *lock);
 376
 377 struct ldlm_valblock_ops {
 378         int (*lvbo_init)(struct ldlm_resource *res);
 379         int (*lvbo_update)(struct ldlm_resource *res,
 380                            struct ptlrpc_request *r,
 381                            int increase);
 382         int (*lvbo_free)(struct ldlm_resource *res);
 383 };
 384
 385 typedef enum {
 386         LDLM_NAMESPACE_GREEDY = 1 << 0,
 387         LDLM_NAMESPACE_MODEST = 1 << 1
 388 } ldlm_appetite_t;
 389
 390 /*
 391  * Default values for the "max_nolock_size", "contention_time" and
 392  * "contended_locks" namespace tunables.
 393  */
 394 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
 395 #define NS_DEFAULT_CONTENTION_SECONDS 2
 396 #define NS_DEFAULT_CONTENDED_LOCKS 32
 397
 398 struct ldlm_namespace {
 399         /**
 400          * Namespace name. Used for logging, etc.
 401          */
 402         char                  *ns_name;
 403
 404         /**
 405          * Is this a client-side lock tree?
 406          */
 407         ldlm_side_t            ns_client;
 408
 409         /**
 410          * Namespce connect flags supported by server (may be changed via proc,
 411          * lru resize may be disabled/enabled).
 412          */
 413         __u64                  ns_connect_flags;
 414
 415          /**
 416           * Client side orig connect flags supported by server.
 417           */
 418         __u64                  ns_orig_connect_flags;
 419
 420         /**
 421          * Hash table for namespace.
 422          */
 423         cfs_list_t            *ns_hash;
 424         cfs_spinlock_t         ns_hash_lock;
 425
 426          /**
 427           * Count of resources in the hash.
 428           */
 429         __u32                  ns_refcount;
 430
 431          /**
 432           * All root resources in namespace.
 433           */
 434         cfs_list_t             ns_root_list;
 435
 436         /**
 437          * Position in global namespace list.
 438          */
 439         cfs_list_t             ns_list_chain;
 440
 441         /**
 442          * All root resources in namespace.
 443          */
 444         cfs_list_t             ns_unused_list;
 445         int                    ns_nr_unused;
 446         cfs_spinlock_t         ns_unused_lock;
 447
 448         unsigned int           ns_max_unused;
 449         unsigned int           ns_max_age;
 450         unsigned int           ns_timeouts;
 451          /**
 452           * Seconds.
 453           */
 454         unsigned int           ns_ctime_age_limit;
 455
 456         /**
 457          * Next debug dump, jiffies.
 458          */
 459         cfs_time_t             ns_next_dump;
 460
 461         cfs_atomic_t           ns_locks;
 462         __u64                  ns_resources;
 463         ldlm_res_policy        ns_policy;
 464         struct ldlm_valblock_ops *ns_lvbo;
 465         void                  *ns_lvbp;
 466         cfs_waitq_t            ns_waitq;
 467         struct ldlm_pool       ns_pool;
 468         ldlm_appetite_t        ns_appetite;
 469
 470         /**
 471          * If more than \a ns_contended_locks found, the resource is considered
 472          * to be contended.
 473          */
 474         unsigned               ns_contended_locks;
 475
 476         /**
 477          * The resource remembers contended state during \a ns_contention_time,
 478          * in seconds.
 479          */
 480         unsigned               ns_contention_time;
 481
 482         /**
 483          * Limit size of nolock requests, in bytes.
 484          */
 485         unsigned               ns_max_nolock_size;
 486
 487         /**
 488          * Backward link to obd, required for ldlm pool to store new SLV.
 489          */
 490         struct obd_device     *ns_obd;
 491
 492         struct adaptive_timeout ns_at_estimate;/* estimated lock callback time*/
 493
 494         /* callback to cancel locks before replaying it during recovery */
 495         ldlm_cancel_for_recovery ns_cancel_for_recovery;
 496 };
 497
 498 static inline int ns_is_client(struct ldlm_namespace *ns)
 499 {
 500         LASSERT(ns != NULL);
 501         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 502                                     LDLM_NAMESPACE_SERVER)));
 503         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 504                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 505         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
 506 }
 507
 508 static inline int ns_is_server(struct ldlm_namespace *ns)
 509 {
 510         LASSERT(ns != NULL);
 511         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 512                                     LDLM_NAMESPACE_SERVER)));
 513         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 514                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 515         return ns->ns_client == LDLM_NAMESPACE_SERVER;
 516 }
 517
 518 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
 519 {
 520         LASSERT(ns != NULL);
 521         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
 522 }
 523
 524 static inline void ns_register_cancel(struct ldlm_namespace *ns,
 525                                       ldlm_cancel_for_recovery arg)
 526 {
 527         LASSERT(ns != NULL);
 528         ns->ns_cancel_for_recovery = arg;
 529 }
 530
 531 /*
 532  *
 533  * Resource hash table
 534  *
 535  */
 536
 537 #define RES_HASH_BITS 12
 538 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 539 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 540
 541 struct ldlm_lock;
 542
 543 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 544                                       struct ldlm_lock_desc *new, void *data,
 545                                       int flag);
 546 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
 547                                         void *data);
 548 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
 549 typedef unsigned long (*ldlm_weigh_callback)(struct ldlm_lock *lock);
 550
 551 /* Interval node data for each LDLM_EXTENT lock */
 552 struct ldlm_interval {
 553         struct interval_node li_node;   /* node for tree mgmt */
 554         cfs_list_t           li_group;  /* the locks which have the same
 555                                          * policy - group of the policy */
 556 };
 557 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
 558
 559 /* the interval tree must be accessed inside the resource lock. */
 560 struct ldlm_interval_tree {
 561         /* tree size, this variable is used to count
 562          * granted PW locks in ldlm_extent_policy()*/
 563         int                   lit_size;
 564         ldlm_mode_t           lit_mode; /* lock mode */
 565         struct interval_node *lit_root; /* actually ldlm_interval */
 566 };
 567
 568 #define LUSTRE_TRACKS_LOCK_EXP_REFS (1)
 569
 570 /* Cancel flag. */
 571 typedef enum {
 572         LCF_ASYNC      = 0x1, /* Cancel locks asynchronously. */
 573         LCF_LOCAL      = 0x2, /* Cancel locks locally, not notifing server */
 574         LCF_BL_AST     = 0x4, /* Cancel locks marked as LDLM_FL_BL_AST
 575                                * in the same RPC */
 576 } ldlm_cancel_flags_t;
 577
 578 struct ldlm_lock {
 579         /**
 580          * Must be first in the structure.
 581          */
 582         struct portals_handle    l_handle;
 583         /**
 584          * Lock reference count.
 585          */
 586         cfs_atomic_t             l_refc;
 587         /**
 588          * Internal spinlock protects l_resource.  we should hold this lock
 589          * first before grabbing res_lock.
 590          */
 591         cfs_spinlock_t           l_lock;
 592         /**
 593          * ldlm_lock_change_resource() can change this.
 594          */
 595         struct ldlm_resource    *l_resource;
 596         /**
 597          * Protected by ns_hash_lock. List item for client side lru list.
 598          */
 599         cfs_list_t               l_lru;
 600         /**
 601          * Protected by lr_lock, linkage to resource's lock queues.
 602          */
 603         cfs_list_t               l_res_link;
 604         /**
 605          * Tree node for ldlm_extent.
 606          */
 607         struct ldlm_interval    *l_tree_node;
 608         /**
 609          * Protected by per-bucket exp->exp_lock_hash locks. Per export hash
 610          * of locks.
 611          */
 612         cfs_hlist_node_t         l_exp_hash;
 613         /**
 614          * Protected by lr_lock. Requested mode.
 615          */
 616         ldlm_mode_t              l_req_mode;
 617         /**
 618          * Granted mode, also protected by lr_lock.
 619          */
 620         ldlm_mode_t              l_granted_mode;
 621         /**
 622          * Lock enqueue completion handler.
 623          */
 624         ldlm_completion_callback l_completion_ast;
 625         /**
 626          * Lock blocking ast handler.
 627          */
 628         ldlm_blocking_callback   l_blocking_ast;
 629         /**
 630          * Lock glimpse handler.
 631          */
 632         ldlm_glimpse_callback    l_glimpse_ast;
 633         ldlm_weigh_callback      l_weigh_ast;
 634
 635         /**
 636          * Lock export.
 637          */
 638         struct obd_export       *l_export;
 639         /**
 640          * Lock connection export.
 641          */
 642         struct obd_export       *l_conn_export;
 643
 644         /**
 645          * Remote lock handle.
 646          */
 647         struct lustre_handle     l_remote_handle;
 648
 649         ldlm_policy_data_t       l_policy_data;
 650
 651         /*
 652          * Protected by lr_lock. Various counters: readers, writers, etc.
 653          */
 654         __u64                 l_flags;
 655         __u32                 l_readers;
 656         __u32                 l_writers;
 657         /*
 658          * Set for locks that were removed from class hash table and will be
 659          * destroyed when last reference to them is released. Set by
 660          * ldlm_lock_destroy_internal().
 661          *
 662          * Protected by lock and resource locks.
 663          */
 664         __u8                  l_destroyed;
 665
 666         /**
 667          * If the lock is granted, a process sleeps on this waitq to learn when
 668          * it's no longer in use.  If the lock is not granted, a process sleeps
 669          * on this waitq to learn when it becomes granted.
 670          */
 671         cfs_waitq_t           l_waitq;
 672
 673         /**
 674          * Seconds. it will be updated if there is any activity related to
 675          * the lock, e.g. enqueue the lock or send block AST.
 676          */
 677         cfs_time_t            l_last_activity;
 678
 679         /**
 680          * Jiffies. Should be converted to time if needed.
 681          */
 682         cfs_time_t            l_last_used;
 683
 684         struct ldlm_extent    l_req_extent;
 685
 686         /*
 687          * Client-side-only members.
 688          */
 689
 690         /**
 691          * Temporary storage for an LVB received during an enqueue operation.
 692          */
 693         __u32                 l_lvb_len;
 694         void                 *l_lvb_data;
 695
 696         void                 *l_ast_data;
 697         cfs_spinlock_t        l_extents_list_lock;
 698         cfs_list_t            l_extents_list;
 699
 700         cfs_list_t            l_cache_locks_list;
 701
 702         /*
 703          * Server-side-only members.
 704          */
 705
 706         /** connection cookie for the client originated the operation. */
 707         __u64                 l_client_cookie;
 708
 709         /**
 710          * Protected by elt_lock. Callbacks pending.
 711          */
 712         cfs_list_t            l_pending_chain;
 713
 714         cfs_time_t            l_callback_timeout;
 715
 716         /**
 717          * Pid which created this lock.
 718          */
 719         __u32                 l_pid;
 720
 721         /**
 722          * For ldlm_add_ast_work_item().
 723          */
 724         cfs_list_t            l_bl_ast;
 725         /**
 726          * For ldlm_add_ast_work_item().
 727          */
 728         cfs_list_t            l_cp_ast;
 729         /**
 730          * For ldlm_add_ast_work_item().
 731          */
 732         cfs_list_t            l_rk_ast;
 733
 734         struct ldlm_lock     *l_blocking_lock;
 735         int                   l_bl_ast_run;
 736
 737         /**
 738          * Protected by lr_lock, linkages to "skip lists".
 739          */
 740         cfs_list_t            l_sl_mode;
 741         cfs_list_t            l_sl_policy;
 742         struct lu_ref         l_reference;
 743 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 744         /* Debugging stuff for bug 20498, for tracking export
 745            references. */
 746         /** number of export references taken */
 747         int                   l_exp_refs_nr;
 748         /** link all locks referencing one export */
 749         cfs_list_t            l_exp_refs_link;
 750         /** referenced export object */
 751         struct obd_export    *l_exp_refs_target;
 752 #endif
 753 };
 754
 755 struct ldlm_resource {
 756         struct ldlm_namespace *lr_namespace;
 757
 758         /* protected by ns_hash_lock */
 759         cfs_list_t             lr_hash;
 760         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 761         cfs_list_t             lr_children; /* list head for child resources */
 762         cfs_list_t             lr_childof;  /* part of ns_root_list if root res,
 763                                              * part of lr_children if child */
 764         cfs_spinlock_t         lr_lock;
 765
 766         /* protected by lr_lock */
 767         cfs_list_t             lr_granted;
 768         cfs_list_t             lr_converting;
 769         cfs_list_t             lr_waiting;
 770         ldlm_mode_t            lr_most_restr;
 771         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 772         struct ldlm_res_id     lr_name;
 773         cfs_atomic_t           lr_refcount;
 774
 775         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
 776
 777         /* Server-side-only lock value block elements */
 778         cfs_semaphore_t        lr_lvb_sem;
 779         __u32                  lr_lvb_len;
 780         void                  *lr_lvb_data;
 781
 782         /* when the resource was considered as contended */
 783         cfs_time_t             lr_contention_time;
 784         /**
 785          * List of references to this resource. For debugging.
 786          */
 787         struct lu_ref          lr_reference;
 788
 789         struct inode          *lr_lvb_inode;
 790 };
 791
 792 struct ldlm_ast_work {
 793         struct ldlm_lock      *w_lock;
 794         int                    w_blocking;
 795         struct ldlm_lock_desc  w_desc;
 796         cfs_list_t             w_list;
 797         int                    w_flags;
 798         void                  *w_data;
 799         int                    w_datalen;
 800 };
 801
 802 /* ldlm_enqueue parameters common */
 803 struct ldlm_enqueue_info {
 804         __u32 ei_type;   /* Type of the lock being enqueued. */
 805         __u32 ei_mode;   /* Mode of the lock being enqueued. */
 806         void *ei_cb_bl;  /* blocking lock callback */
 807         void *ei_cb_cp;  /* lock completion callback */
 808         void *ei_cb_gl;  /* lock glimpse callback */
 809         void *ei_cb_wg;  /* lock weigh callback */
 810         void *ei_cbdata; /* Data to be passed into callbacks. */
 811         short ei_async:1; /* async request */
 812 };
 813
 814 extern struct obd_ops ldlm_obd_ops;
 815
 816 extern char *ldlm_lockname[];
 817 extern char *ldlm_typename[];
 818 extern char *ldlm_it2str(int it);
 819 #ifdef LIBCFS_DEBUG
 820 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
 821         CFS_CHECK_STACK();                                              \
 822                                                                         \
 823         if (((level) & D_CANTMASK) != 0 ||                              \
 824             ((libcfs_debug & (level)) != 0 &&                           \
 825              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
 826                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
 827                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
 828                                     file, func, line);                  \
 829                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
 830                                  ##a );                                 \
 831         }                                                               \
 832 } while(0)
 833
 834 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
 835                       struct libcfs_debug_msg_data *data, const char *fmt,
 836                       ...)
 837         __attribute__ ((format (printf, 4, 5)));
 838
 839 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do {                    \
 840         static cfs_debug_limit_state_t _ldlm_cdls;                      \
 841         ldlm_lock_debug(&_ldlm_cdls, mask, lock,                        \
 842                         __FILE__, __FUNCTION__, __LINE__,               \
 843                         "### " fmt , ##a);                              \
 844 } while (0)
 845
 846 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
 847 #define LDLM_WARN(lock, fmt, a...)  LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
 848
 849 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
 850         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
 851                         __FILE__, __FUNCTION__, __LINE__,               \
 852                          "### " fmt , ##a);                             \
 853 } while (0)
 854 #else /* !LIBCFS_DEBUG */
 855 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
 856 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
 857 # define ldlm_lock_debuf(cdls, level, lock, file, func, line, fmt, a...) \
 858          ((void)0)
 859 #endif
 860
 861 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 862         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
 863
 864 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 865                                       int first_enq, ldlm_error_t *err,
 866                                       cfs_list_t *work_list);
 867
 868 /*
 869  * Iterators.
 870  */
 871
 872 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 873 #define LDLM_ITER_STOP     2 /* stop iterating */
 874
 875 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 876 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 877
 878 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 879                           void *closure);
 880 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 881                            void *closure);
 882 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
 883                                ldlm_res_iterator_t iter, void *closure);
 884
 885 int ldlm_replay_locks(struct obd_import *imp);
 886 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
 887                            ldlm_iterator_t iter, void *data);
 888
 889 /* ldlm_flock.c */
 890 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 891
 892 /* ldlm_extent.c */
 893 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 894
 895
 896 /* ldlm_lockd.c */
 897 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 898                              void *data, int flag);
 899 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 900 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 901 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 902                         ldlm_blocking_callback, ldlm_glimpse_callback);
 903 int ldlm_handle_convert(struct ptlrpc_request *req);
 904 int ldlm_handle_cancel(struct ptlrpc_request *req);
 905 int ldlm_request_cancel(struct ptlrpc_request *req,
 906                         const struct ldlm_request *dlm_req, int first);
 907 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
 908 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
 909 void ldlm_revoke_export_locks(struct obd_export *exp);
 910 int ldlm_get_ref(void);
 911 void ldlm_put_ref(void);
 912 int ldlm_init_export(struct obd_export *exp);
 913 void ldlm_destroy_export(struct obd_export *exp);
 914
 915 /* ldlm_lock.c */
 916 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
 917 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
 918 void ldlm_lock2handle(const struct ldlm_lock *lock,
 919                       struct lustre_handle *lockh);
 920 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
 921 void ldlm_cancel_callback(struct ldlm_lock *);
 922 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
 923
 924 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
 925 {
 926         return __ldlm_handle2lock(h, 0);
 927 }
 928
 929 #define LDLM_LOCK_REF_DEL(lock) \
 930         lu_ref_del(&lock->l_reference, "handle", cfs_current())
 931
 932 static inline struct ldlm_lock *
 933 ldlm_handle2lock_long(const struct lustre_handle *h, int flags)
 934 {
 935         struct ldlm_lock *lock;
 936
 937         lock = __ldlm_handle2lock(h, flags);
 938         if (lock != NULL)
 939                 LDLM_LOCK_REF_DEL(lock);
 940         return lock;
 941 }
 942
 943 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
 944                                        struct ptlrpc_request *r, int increase)
 945 {
 946         if (res->lr_namespace->ns_lvbo &&
 947             res->lr_namespace->ns_lvbo->lvbo_update) {
 948                 return res->lr_namespace->ns_lvbo->lvbo_update(res, r,
 949                                                                increase);
 950         }
 951         return 0;
 952 }
 953
 954 int ldlm_error2errno(ldlm_error_t error);
 955 ldlm_error_t ldlm_errno2error(int err_no); /* don't call it `errno': this
 956                                             * confuses user-space. */
 957 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 958 void ldlm_dump_export_locks(struct obd_export *exp);
 959 #endif
 960
 961 /**
 962  * Release a temporary lock reference obtained by ldlm_handle2lock() or
 963  * __ldlm_handle2lock().
 964  */
 965 #define LDLM_LOCK_PUT(lock)                     \
 966 do {                                            \
 967         LDLM_LOCK_REF_DEL(lock);                \
 968         /*LDLM_DEBUG((lock), "put");*/          \
 969         ldlm_lock_put(lock);                    \
 970 } while (0)
 971
 972 /**
 973  * Release a lock reference obtained by some other means (see
 974  * LDLM_LOCK_PUT()).
 975  */
 976 #define LDLM_LOCK_RELEASE(lock)                 \
 977 do {                                            \
 978         /*LDLM_DEBUG((lock), "put");*/          \
 979         ldlm_lock_put(lock);                    \
 980 } while (0)
 981
 982 #define LDLM_LOCK_GET(lock)                     \
 983 ({                                              \
 984         ldlm_lock_get(lock);                    \
 985         /*LDLM_DEBUG((lock), "get");*/          \
 986         lock;                                   \
 987 })
 988
 989 #define ldlm_lock_list_put(head, member, count)                     \
 990 ({                                                                  \
 991         struct ldlm_lock *_lock, *_next;                            \
 992         int c = count;                                              \
 993         cfs_list_for_each_entry_safe(_lock, _next, head, member) {  \
 994                 if (c-- == 0)                                       \
 995                         break;                                      \
 996                 cfs_list_del_init(&_lock->member);                  \
 997                 LDLM_LOCK_RELEASE(_lock);                           \
 998         }                                                           \
 999         LASSERT(c <= 0);                                            \
1000 })
1001
1002 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1003 void ldlm_lock_put(struct ldlm_lock *lock);
1004 void ldlm_lock_destroy(struct ldlm_lock *lock);
1005 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1006 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
1007 int  ldlm_lock_addref_try(struct lustre_handle *lockh, __u32 mode);
1008 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
1009 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
1010 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1011 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1012 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
1013                             const struct ldlm_res_id *, ldlm_type_t type,
1014                             ldlm_policy_data_t *, ldlm_mode_t mode,
1015                             struct lustre_handle *, int unref);
1016 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
1017                                         __u32 *flags);
1018 void ldlm_lock_downgrade(struct ldlm_lock *lock, int new_mode);
1019 void ldlm_lock_cancel(struct ldlm_lock *lock);
1020 void ldlm_reprocess_all(struct ldlm_resource *res);
1021 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1022 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
1023 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
1024 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1025
1026 /* resource.c */
1027 struct ldlm_namespace *
1028 ldlm_namespace_new(struct obd_device *obd, char *name,
1029                    ldlm_side_t client, ldlm_appetite_t apt);
1030 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
1031 void ldlm_namespace_free(struct ldlm_namespace *ns,
1032                          struct obd_import *imp, int force);
1033 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
1034 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
1035 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
1036 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
1037 void ldlm_namespace_get_locked(struct ldlm_namespace *ns);
1038 void ldlm_namespace_put_locked(struct ldlm_namespace *ns, int wakeup);
1039 void ldlm_namespace_get(struct ldlm_namespace *ns);
1040 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
1041 int ldlm_proc_setup(void);
1042 #ifdef LPROCFS
1043 void ldlm_proc_cleanup(void);
1044 #else
1045 static inline void ldlm_proc_cleanup(void) {}
1046 #endif
1047
1048 /* resource.c - internal */
1049 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1050                                         struct ldlm_resource *parent,
1051                                         const struct ldlm_res_id *,
1052                                         ldlm_type_t type, int create);
1053 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1054 int ldlm_resource_putref(struct ldlm_resource *res);
1055 void ldlm_resource_add_lock(struct ldlm_resource *res,
1056                             cfs_list_t *head,
1057                             struct ldlm_lock *lock);
1058 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1059 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1060 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
1061 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1062 void ldlm_resource_dump(int level, struct ldlm_resource *);
1063 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1064                               const struct ldlm_res_id *);
1065
1066 #define LDLM_RESOURCE_ADDREF(res) do {                                  \
1067         lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, cfs_current());  \
1068 } while (0)
1069
1070 #define LDLM_RESOURCE_DELREF(res) do {                                  \
1071         lu_ref_del(&(res)->lr_reference, __FUNCTION__, cfs_current());  \
1072 } while (0)
1073
1074 struct ldlm_callback_suite {
1075         ldlm_completion_callback lcs_completion;
1076         ldlm_blocking_callback   lcs_blocking;
1077         ldlm_glimpse_callback    lcs_glimpse;
1078         ldlm_weigh_callback      lcs_weigh;
1079 };
1080
1081 /* ldlm_request.c */
1082 int ldlm_expired_completion_wait(void *data);
1083 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1084 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1085                       void *data, int flag);
1086 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1087 int ldlm_completion_ast_async(struct ldlm_lock *lock, int flags, void *data);
1088 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
1089 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1090                      struct ldlm_enqueue_info *einfo,
1091                      const struct ldlm_res_id *res_id,
1092                      ldlm_policy_data_t const *policy, int *flags,
1093                      void *lvb, __u32 lvb_len, struct lustre_handle *lockh,
1094                      int async);
1095 int ldlm_prep_enqueue_req(struct obd_export *exp,
1096                           struct ptlrpc_request *req,
1097                           cfs_list_t *cancels,
1098                           int count);
1099 int ldlm_prep_elc_req(struct obd_export *exp,
1100                       struct ptlrpc_request *req,
1101                       int version, int opc, int canceloff,
1102                       cfs_list_t *cancels, int count);
1103 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1104                          const struct ldlm_request *dlm_req,
1105                          const struct ldlm_callback_suite *cbs);
1106 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1107                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
1108                           int *flags, void *lvb, __u32 lvb_len,
1109                           struct lustre_handle *lockh, int rc);
1110 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1111                            const struct ldlm_res_id *res_id,
1112                            ldlm_type_t type, ldlm_policy_data_t *policy,
1113                            ldlm_mode_t mode, int *flags,
1114                            ldlm_blocking_callback blocking,
1115                            ldlm_completion_callback completion,
1116                            ldlm_glimpse_callback glimpse,
1117                            void *data, __u32 lvb_len,
1118                            const __u64 *client_cookie,
1119                            struct lustre_handle *lockh);
1120 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
1121                     void *data, __u32 data_len);
1122 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
1123 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1124 int ldlm_handle_convert0(struct ptlrpc_request *req,
1125                          const struct ldlm_request *dlm_req);
1126 int ldlm_cli_cancel(struct lustre_handle *lockh);
1127 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1128                            ldlm_cancel_flags_t flags, void *opaque);
1129 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1130                                     const struct ldlm_res_id *res_id,
1131                                     ldlm_policy_data_t *policy,
1132                                     ldlm_mode_t mode,
1133                                     ldlm_cancel_flags_t flags,
1134                                     void *opaque);
1135 int ldlm_cli_cancel_req(struct obd_export *exp, cfs_list_t *head,
1136                         int count, ldlm_cancel_flags_t flags);
1137 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1138                                cfs_list_t *cancels,
1139                                ldlm_policy_data_t *policy,
1140                                ldlm_mode_t mode, int lock_flags,
1141                                ldlm_cancel_flags_t cancel_flags, void *opaque);
1142 int ldlm_cli_cancel_list_local(cfs_list_t *cancels, int count,
1143                                ldlm_cancel_flags_t flags);
1144 int ldlm_cli_cancel_list(cfs_list_t *head, int count,
1145                          struct ptlrpc_request *req, ldlm_cancel_flags_t flags);
1146
1147 /* mds/handler.c */
1148 /* This has to be here because recursive inclusion sucks. */
1149 int intent_disposition(struct ldlm_reply *rep, int flag);
1150 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1151
1152
1153 /* ioctls for trying requests */
1154 #define IOC_LDLM_TYPE                   'f'
1155 #define IOC_LDLM_MIN_NR                 40
1156
1157 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
1158 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
1159 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
1160 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
1161 #define IOC_LDLM_MAX_NR                 43
1162
1163 /**
1164  * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1165  * than one lock_res is dead-lock safe.
1166  */
1167 enum lock_res_type {
1168         LRT_NORMAL,
1169         LRT_NEW
1170 };
1171
1172 static inline void lock_res(struct ldlm_resource *res)
1173 {
1174         cfs_spin_lock(&res->lr_lock);
1175 }
1176
1177 static inline void lock_res_nested(struct ldlm_resource *res,
1178                                    enum lock_res_type mode)
1179 {
1180         cfs_spin_lock_nested(&res->lr_lock, mode);
1181 }
1182
1183
1184 static inline void unlock_res(struct ldlm_resource *res)
1185 {
1186         cfs_spin_unlock(&res->lr_lock);
1187 }
1188
1189 static inline void check_res_locked(struct ldlm_resource *res)
1190 {
1191         LASSERT_SPIN_LOCKED(&res->lr_lock);
1192 }
1193
1194 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1195 void unlock_res_and_lock(struct ldlm_lock *lock);
1196
1197 /* ldlm_pool.c */
1198 void ldlm_pools_recalc(ldlm_side_t client);
1199 int ldlm_pools_init(void);
1200 void ldlm_pools_fini(void);
1201
1202 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1203                    int idx, ldlm_side_t client);
1204 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
1205                      unsigned int gfp_mask);
1206 void ldlm_pool_fini(struct ldlm_pool *pl);
1207 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1208 int ldlm_pool_recalc(struct ldlm_pool *pl);
1209 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1210 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1211 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1212 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1213 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1214 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1215 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1216 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1217 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1218
1219 /** @} ldlm */
1220
1221 #endif