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