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