lustre/include/lustre_dlm.h

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