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