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          * it's set in lock_res_and_lock() and unset in unlock_res_and_lock().
 738          *
 739          * NB: compare with check_res_locked(), check this bit is cheaper,
 740          * also, spin_is_locked() is deprecated for kernel code, one reason is
 741          * because it works only for SMP so user needs add extra macros like
 742          * LASSERT_SPIN_LOCKED for uniprocessor kernels.
 743          */
 744                               l_res_locked:1,
 745         /*
 746          * it's set once we call ldlm_add_waiting_lock_res_locked()
 747          * to start the lock-timeout timer and it will never be reset.
 748          *
 749          * Protected by lock_res_and_lock().
 750          */
 751                               l_waited:1,
 752         /**
 753          * flag whether this is a server namespace lock.
 754          */
 755                               l_ns_srv:1;
 756
 757         /*
 758          * Client-side-only members.
 759          */
 760
 761         /**
 762          * Temporary storage for an LVB received during an enqueue operation.
 763          */
 764         __u32                 l_lvb_len;
 765         void                 *l_lvb_data;
 766
 767         void                 *l_ast_data;
 768
 769         /*
 770          * Server-side-only members.
 771          */
 772
 773         /** connection cookie for the client originated the operation. */
 774         __u64                 l_client_cookie;
 775
 776         /**
 777          * Protected by elt_lock. Callbacks pending.
 778          */
 779         cfs_list_t            l_pending_chain;
 780
 781         cfs_time_t            l_callback_timeout;
 782
 783         /**
 784          * Pid which created this lock.
 785          */
 786         __u32                 l_pid;
 787
 788         int                   l_bl_ast_run;
 789         /**
 790          * For ldlm_add_ast_work_item().
 791          */
 792         cfs_list_t            l_bl_ast;
 793         /**
 794          * For ldlm_add_ast_work_item().
 795          */
 796         cfs_list_t            l_cp_ast;
 797         /**
 798          * For ldlm_add_ast_work_item().
 799          */
 800         cfs_list_t            l_rk_ast;
 801
 802         struct ldlm_lock     *l_blocking_lock;
 803
 804         /**
 805          * Protected by lr_lock, linkages to "skip lists".
 806          */
 807         cfs_list_t            l_sl_mode;
 808         cfs_list_t            l_sl_policy;
 809         struct lu_ref         l_reference;
 810 #if LUSTRE_TRACKS_LOCK_EXP_REFS
 811         /* Debugging stuff for bug 20498, for tracking export
 812            references. */
 813         /** number of export references taken */
 814         int                   l_exp_refs_nr;
 815         /** link all locks referencing one export */
 816         cfs_list_t            l_exp_refs_link;
 817         /** referenced export object */
 818         struct obd_export    *l_exp_refs_target;
 819 #endif
 820         /** export blocking dlm lock list, protected by
 821          * l_export->exp_bl_list_lock.
 822          * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
 823          * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock. */
 824         cfs_list_t            l_exp_list;
 825 };
 826
 827 struct ldlm_resource {
 828         struct ldlm_ns_bucket *lr_ns_bucket;
 829
 830         /* protected by ns_hash_lock */
 831         cfs_hlist_node_t       lr_hash;
 832         cfs_spinlock_t         lr_lock;
 833
 834         /* protected by lr_lock */
 835         cfs_list_t             lr_granted;
 836         cfs_list_t             lr_converting;
 837         cfs_list_t             lr_waiting;
 838         ldlm_mode_t            lr_most_restr;
 839         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 840         struct ldlm_res_id     lr_name;
 841         cfs_atomic_t           lr_refcount;
 842
 843         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
 844
 845         /* Server-side-only lock value block elements */
 846         /** to serialize lvbo_init */
 847         cfs_mutex_t            lr_lvb_mutex;
 848         __u32                  lr_lvb_len;
 849         /** protect by lr_lock */
 850         void                  *lr_lvb_data;
 851
 852         /* when the resource was considered as contended */
 853         cfs_time_t             lr_contention_time;
 854         /**
 855          * List of references to this resource. For debugging.
 856          */
 857         struct lu_ref          lr_reference;
 858
 859         struct inode          *lr_lvb_inode;
 860 };
 861
 862 static inline char *
 863 ldlm_ns_name(struct ldlm_namespace *ns)
 864 {
 865         return ns->ns_rs_hash->hs_name;
 866 }
 867
 868 static inline struct ldlm_namespace *
 869 ldlm_res_to_ns(struct ldlm_resource *res)
 870 {
 871         return res->lr_ns_bucket->nsb_namespace;
 872 }
 873
 874 static inline struct ldlm_namespace *
 875 ldlm_lock_to_ns(struct ldlm_lock *lock)
 876 {
 877         return ldlm_res_to_ns(lock->l_resource);
 878 }
 879
 880 static inline char *
 881 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
 882 {
 883         return ldlm_ns_name(ldlm_lock_to_ns(lock));
 884 }
 885
 886 static inline struct adaptive_timeout *
 887 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
 888 {
 889         return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
 890 }
 891
 892 struct ldlm_ast_work {
 893         struct ldlm_lock      *w_lock;
 894         int                    w_blocking;
 895         struct ldlm_lock_desc  w_desc;
 896         cfs_list_t             w_list;
 897         int                    w_flags;
 898         void                  *w_data;
 899         int                    w_datalen;
 900 };
 901
 902 /* ldlm_enqueue parameters common */
 903 struct ldlm_enqueue_info {
 904         __u32 ei_type;   /* Type of the lock being enqueued. */
 905         __u32 ei_mode;   /* Mode of the lock being enqueued. */
 906         void *ei_cb_bl;  /* blocking lock callback */
 907         void *ei_cb_cp;  /* lock completion callback */
 908         void *ei_cb_gl;  /* lock glimpse callback */
 909         void *ei_cb_wg;  /* lock weigh callback */
 910         void *ei_cbdata; /* Data to be passed into callbacks. */
 911 };
 912
 913 extern struct obd_ops ldlm_obd_ops;
 914
 915 extern char *ldlm_lockname[];
 916 extern char *ldlm_typename[];
 917 extern char *ldlm_it2str(int it);
 918 #ifdef LIBCFS_DEBUG
 919 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do {      \
 920         CFS_CHECK_STACK(msgdata, mask, cdls);                           \
 921                                                                         \
 922         if (((mask) & D_CANTMASK) != 0 ||                               \
 923             ((libcfs_debug & (mask)) != 0 &&                            \
 924              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))          \
 925                 _ldlm_lock_debug(lock, msgdata, fmt, ##a);              \
 926 } while(0)
 927
 928 void _ldlm_lock_debug(struct ldlm_lock *lock,
 929                       struct libcfs_debug_msg_data *data,
 930                       const char *fmt, ...)
 931         __attribute__ ((format (printf, 3, 4)));
 932
 933 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do {                         \
 934         static cfs_debug_limit_state_t _ldlm_cdls;                           \
 935         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls);              \
 936         ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
 937 } while (0)
 938
 939 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
 940 #define LDLM_WARN(lock, fmt, a...)  LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
 941
 942 #define LDLM_DEBUG(lock, fmt, a...)   do {                                  \
 943         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL);              \
 944         ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock, "### " fmt , ##a);\
 945 } while (0)
 946 #else /* !LIBCFS_DEBUG */
 947 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
 948 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
 949 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
 950 #endif
 951
 952 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 953         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
 954
 955 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 956                                       int first_enq, ldlm_error_t *err,
 957                                       cfs_list_t *work_list);
 958
 959 /*
 960  * Iterators.
 961  */
 962
 963 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 964 #define LDLM_ITER_STOP     2 /* stop iterating */
 965
 966 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 967 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 968
 969 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 970                           void *closure);
 971 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 972                             void *closure);
 973
 974 int ldlm_replay_locks(struct obd_import *imp);
 975 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
 976                            ldlm_iterator_t iter, void *data);
 977
 978 /* ldlm_flock.c */
 979 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 980
 981 /* ldlm_extent.c */
 982 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 983
 984 struct ldlm_callback_suite {
 985         ldlm_completion_callback lcs_completion;
 986         ldlm_blocking_callback   lcs_blocking;
 987         ldlm_glimpse_callback    lcs_glimpse;
 988         ldlm_weigh_callback      lcs_weigh;
 989 };
 990
 991 /* ldlm_lockd.c */
 992 #ifdef HAVE_SERVER_SUPPORT
 993 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 994                              void *data, int flag);
 995 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 996 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 997 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 998                         ldlm_blocking_callback, ldlm_glimpse_callback);
 999 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1000                          const struct ldlm_request *dlm_req,
1001                          const struct ldlm_callback_suite *cbs);
1002 int ldlm_handle_convert(struct ptlrpc_request *req);
1003 int ldlm_handle_convert0(struct ptlrpc_request *req,
1004                          const struct ldlm_request *dlm_req);
1005 int ldlm_handle_cancel(struct ptlrpc_request *req);
1006 int ldlm_request_cancel(struct ptlrpc_request *req,
1007                         const struct ldlm_request *dlm_req, int first);
1008 void ldlm_revoke_export_locks(struct obd_export *exp);
1009 #endif
1010 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1011 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
1012 int ldlm_get_ref(void);
1013 void ldlm_put_ref(void);
1014 int ldlm_init_export(struct obd_export *exp);
1015 void ldlm_destroy_export(struct obd_export *exp);
1016
1017 /* ldlm_lock.c */
1018 #ifdef HAVE_SERVER_SUPPORT
1019 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1020 #endif
1021 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1022 void ldlm_lock2handle(const struct ldlm_lock *lock,
1023                       struct lustre_handle *lockh);
1024 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
1025 void ldlm_cancel_callback(struct ldlm_lock *);
1026 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1027 int ldlm_lock_set_data(struct lustre_handle *, void *);
1028
1029 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1030 {
1031         return __ldlm_handle2lock(h, 0);
1032 }
1033
1034 #define LDLM_LOCK_REF_DEL(lock) \
1035         lu_ref_del(&lock->l_reference, "handle", cfs_current())
1036
1037 static inline struct ldlm_lock *
1038 ldlm_handle2lock_long(const struct lustre_handle *h, int flags)
1039 {
1040         struct ldlm_lock *lock;
1041
1042         lock = __ldlm_handle2lock(h, flags);
1043         if (lock != NULL)
1044                 LDLM_LOCK_REF_DEL(lock);
1045         return lock;
1046 }
1047
1048 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1049                                        struct ptlrpc_request *r, int increase)
1050 {
1051         if (ldlm_res_to_ns(res)->ns_lvbo &&
1052             ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
1053                 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, r,
1054                                                                  increase);
1055         }
1056         return 0;
1057 }
1058
1059 int ldlm_error2errno(ldlm_error_t error);
1060 ldlm_error_t ldlm_errno2error(int err_no); /* don't call it `errno': this
1061                                             * confuses user-space. */
1062 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1063 void ldlm_dump_export_locks(struct obd_export *exp);
1064 #endif
1065
1066 /**
1067  * Release a temporary lock reference obtained by ldlm_handle2lock() or
1068  * __ldlm_handle2lock().
1069  */
1070 #define LDLM_LOCK_PUT(lock)                     \
1071 do {                                            \
1072         LDLM_LOCK_REF_DEL(lock);                \
1073         /*LDLM_DEBUG((lock), "put");*/          \
1074         ldlm_lock_put(lock);                    \
1075 } while (0)
1076
1077 /**
1078  * Release a lock reference obtained by some other means (see
1079  * LDLM_LOCK_PUT()).
1080  */
1081 #define LDLM_LOCK_RELEASE(lock)                 \
1082 do {                                            \
1083         /*LDLM_DEBUG((lock), "put");*/          \
1084         ldlm_lock_put(lock);                    \
1085 } while (0)
1086
1087 #define LDLM_LOCK_GET(lock)                     \
1088 ({                                              \
1089         ldlm_lock_get(lock);                    \
1090         /*LDLM_DEBUG((lock), "get");*/          \
1091         lock;                                   \
1092 })
1093
1094 #define ldlm_lock_list_put(head, member, count)                     \
1095 ({                                                                  \
1096         struct ldlm_lock *_lock, *_next;                            \
1097         int c = count;                                              \
1098         cfs_list_for_each_entry_safe(_lock, _next, head, member) {  \
1099                 if (c-- == 0)                                       \
1100                         break;                                      \
1101                 cfs_list_del_init(&_lock->member);                  \
1102                 LDLM_LOCK_RELEASE(_lock);                           \
1103         }                                                           \
1104         LASSERT(c <= 0);                                            \
1105 })
1106
1107 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1108 void ldlm_lock_put(struct ldlm_lock *lock);
1109 void ldlm_lock_destroy(struct ldlm_lock *lock);
1110 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1111 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
1112 int  ldlm_lock_addref_try(struct lustre_handle *lockh, __u32 mode);
1113 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
1114 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
1115 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1116 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1117 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1118 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1119 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
1120                             const struct ldlm_res_id *, ldlm_type_t type,
1121                             ldlm_policy_data_t *, ldlm_mode_t mode,
1122                             struct lustre_handle *, int unref);
1123 ldlm_mode_t ldlm_revalidate_lock_handle(struct lustre_handle *lockh,
1124                                         __u64 *bits);
1125 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
1126                                         __u32 *flags);
1127 void ldlm_lock_downgrade(struct ldlm_lock *lock, int new_mode);
1128 void ldlm_lock_cancel(struct ldlm_lock *lock);
1129 void ldlm_reprocess_all(struct ldlm_resource *res);
1130 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1131 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
1132 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1133
1134 /* resource.c */
1135 struct ldlm_namespace *
1136 ldlm_namespace_new(struct obd_device *obd, char *name,
1137                    ldlm_side_t client, ldlm_appetite_t apt,
1138                    ldlm_ns_type_t ns_type);
1139 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
1140 void ldlm_namespace_free(struct ldlm_namespace *ns,
1141                          struct obd_import *imp, int force);
1142 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
1143 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
1144 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
1145 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
1146 void ldlm_namespace_get(struct ldlm_namespace *ns);
1147 void ldlm_namespace_put(struct ldlm_namespace *ns);
1148 int ldlm_proc_setup(void);
1149 #ifdef LPROCFS
1150 void ldlm_proc_cleanup(void);
1151 #else
1152 static inline void ldlm_proc_cleanup(void) {}
1153 #endif
1154
1155 /* resource.c - internal */
1156 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1157                                         struct ldlm_resource *parent,
1158                                         const struct ldlm_res_id *,
1159                                         ldlm_type_t type, int create);
1160 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1161 int ldlm_resource_putref(struct ldlm_resource *res);
1162 void ldlm_resource_add_lock(struct ldlm_resource *res,
1163                             cfs_list_t *head,
1164                             struct ldlm_lock *lock);
1165 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1166 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1167 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
1168 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1169 void ldlm_resource_dump(int level, struct ldlm_resource *);
1170 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1171                               const struct ldlm_res_id *);
1172
1173 #define LDLM_RESOURCE_ADDREF(res) do {                                  \
1174         lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, cfs_current());  \
1175 } while (0)
1176
1177 #define LDLM_RESOURCE_DELREF(res) do {                                  \
1178         lu_ref_del(&(res)->lr_reference, __FUNCTION__, cfs_current());  \
1179 } while (0)
1180
1181 /* ldlm_request.c */
1182 int ldlm_expired_completion_wait(void *data);
1183 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1184 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1185                       void *data, int flag);
1186 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1187 int ldlm_completion_ast_async(struct ldlm_lock *lock, int flags, void *data);
1188 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
1189 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1190                      struct ldlm_enqueue_info *einfo,
1191                      const struct ldlm_res_id *res_id,
1192                      ldlm_policy_data_t const *policy, int *flags,
1193                      void *lvb, __u32 lvb_len, struct lustre_handle *lockh,
1194                      int async);
1195 int ldlm_prep_enqueue_req(struct obd_export *exp,
1196                           struct ptlrpc_request *req,
1197                           cfs_list_t *cancels,
1198                           int count);
1199 int ldlm_prep_elc_req(struct obd_export *exp,
1200                       struct ptlrpc_request *req,
1201                       int version, int opc, int canceloff,
1202                       cfs_list_t *cancels, int count);
1203 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1204                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
1205                           int *flags, void *lvb, __u32 lvb_len,
1206                           struct lustre_handle *lockh, int rc);
1207 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1208                            const struct ldlm_res_id *res_id,
1209                            ldlm_type_t type, ldlm_policy_data_t *policy,
1210                            ldlm_mode_t mode, int *flags,
1211                            ldlm_blocking_callback blocking,
1212                            ldlm_completion_callback completion,
1213                            ldlm_glimpse_callback glimpse,
1214                            void *data, __u32 lvb_len,
1215                            const __u64 *client_cookie,
1216                            struct lustre_handle *lockh);
1217 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
1218                     void *data, __u32 data_len);
1219 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
1220 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1221 int ldlm_cli_cancel(struct lustre_handle *lockh);
1222 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1223                            ldlm_cancel_flags_t flags, void *opaque);
1224 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1225                                     const struct ldlm_res_id *res_id,
1226                                     ldlm_policy_data_t *policy,
1227                                     ldlm_mode_t mode,
1228                                     ldlm_cancel_flags_t flags,
1229                                     void *opaque);
1230 int ldlm_cli_cancel_req(struct obd_export *exp, cfs_list_t *head,
1231                         int count, ldlm_cancel_flags_t flags);
1232 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1233                                cfs_list_t *cancels,
1234                                ldlm_policy_data_t *policy,
1235                                ldlm_mode_t mode, int lock_flags,
1236                                ldlm_cancel_flags_t cancel_flags, void *opaque);
1237 int ldlm_cli_cancel_list_local(cfs_list_t *cancels, int count,
1238                                ldlm_cancel_flags_t flags);
1239 int ldlm_cli_cancel_list(cfs_list_t *head, int count,
1240                          struct ptlrpc_request *req, ldlm_cancel_flags_t flags);
1241
1242 /* mds/handler.c */
1243 /* This has to be here because recursive inclusion sucks. */
1244 int intent_disposition(struct ldlm_reply *rep, int flag);
1245 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1246
1247
1248 /* ioctls for trying requests */
1249 #define IOC_LDLM_TYPE                   'f'
1250 #define IOC_LDLM_MIN_NR                 40
1251
1252 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
1253 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
1254 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
1255 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
1256 #define IOC_LDLM_MAX_NR                 43
1257
1258 /**
1259  * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1260  * than one lock_res is dead-lock safe.
1261  */
1262 enum lock_res_type {
1263         LRT_NORMAL,
1264         LRT_NEW
1265 };
1266
1267 static inline void lock_res(struct ldlm_resource *res)
1268 {
1269         cfs_spin_lock(&res->lr_lock);
1270 }
1271
1272 static inline void lock_res_nested(struct ldlm_resource *res,
1273                                    enum lock_res_type mode)
1274 {
1275         cfs_spin_lock_nested(&res->lr_lock, mode);
1276 }
1277
1278 static inline void unlock_res(struct ldlm_resource *res)
1279 {
1280         cfs_spin_unlock(&res->lr_lock);
1281 }
1282
1283 static inline void check_res_locked(struct ldlm_resource *res)
1284 {
1285         LASSERT_SPIN_LOCKED(&res->lr_lock);
1286 }
1287
1288 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1289 void unlock_res_and_lock(struct ldlm_lock *lock);
1290
1291 /* ldlm_pool.c */
1292 void ldlm_pools_recalc(ldlm_side_t client);
1293 int ldlm_pools_init(void);
1294 void ldlm_pools_fini(void);
1295
1296 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1297                    int idx, ldlm_side_t client);
1298 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
1299                      unsigned int gfp_mask);
1300 void ldlm_pool_fini(struct ldlm_pool *pl);
1301 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1302 int ldlm_pool_recalc(struct ldlm_pool *pl);
1303 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1304 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1305 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1306 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1307 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1308 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1309 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1310 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1311 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1312
1313 /** @} ldlm */
1314
1315 #endif