lustre/include/lustre_dlm.h

   1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
   2  * vim:expandtab:shiftwidth=8:tabstop=8:
   3  *
   4  * GPL HEADER START
   5  *
   6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This program is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * General Public License version 2 for more details (a copy is included
  16  * in the LICENSE file that accompanied this code).
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * version 2 along with this program; If not, see
  20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
  21  *
  22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
  23  * CA 95054 USA or visit www.sun.com if you need additional information or
  24  * have any questions.
  25  *
  26  * GPL HEADER END
  27  */
  28 /*
  29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
  30  * Use is subject to license terms.
  31  */
  32 /*
  33  * This file is part of Lustre, http://www.lustre.org/
  34  * Lustre is a trademark of Sun Microsystems, Inc.
  35  */
  36
  37 #ifndef _LUSTRE_DLM_H__
  38 #define _LUSTRE_DLM_H__
  39
  40 #if defined(__linux__)
  41 #include <linux/lustre_dlm.h>
  42 #elif defined(__APPLE__)
  43 #include <darwin/lustre_dlm.h>
  44 #elif defined(__WINNT__)
  45 #include <winnt/lustre_dlm.h>
  46 #else
  47 #error Unsupported operating system.
  48 #endif
  49
  50 #include <lustre_lib.h>
  51 #include <lustre_net.h>
  52 #include <lustre_import.h>
  53 #include <lustre_handles.h>
  54 #include <lustre_export.h> /* for obd_export, for LDLM_DEBUG */
  55 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
  56
  57 struct obd_ops;
  58 struct obd_device;
  59
  60 #define OBD_LDLM_DEVICENAME  "ldlm"
  61
  62 #ifdef HAVE_BGL_SUPPORT
  63 /* 1.5 times the maximum 128 tasks available in VN mode */
  64 #define LDLM_DEFAULT_LRU_SIZE 196
  65 #else
  66 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
  67 #endif
  68 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
  69 #define LDLM_CTIME_AGE_LIMIT (10)
  70
  71 typedef enum {
  72         ELDLM_OK = 0,
  73
  74         ELDLM_LOCK_CHANGED = 300,
  75         ELDLM_LOCK_ABORTED = 301,
  76         ELDLM_LOCK_REPLACED = 302,
  77         ELDLM_NO_LOCK_DATA = 303,
  78
  79         ELDLM_NAMESPACE_EXISTS = 400,
  80         ELDLM_BAD_NAMESPACE    = 401
  81 } ldlm_error_t;
  82
  83 typedef enum {
  84         LDLM_NAMESPACE_SERVER = 1 << 0,
  85         LDLM_NAMESPACE_CLIENT = 1 << 1
  86 } ldlm_side_t;
  87
  88 #define LDLM_FL_LOCK_CHANGED   0x000001 /* extent, mode, or resource changed */
  89
  90 /* If the server returns one of these flags, then the lock was put on that list.
  91  * If the client sends one of these flags (during recovery ONLY!), it wants the
  92  * lock added to the specified list, no questions asked. -p */
  93 #define LDLM_FL_BLOCK_GRANTED  0x000002
  94 #define LDLM_FL_BLOCK_CONV     0x000004
  95 #define LDLM_FL_BLOCK_WAIT     0x000008
  96
  97 #define LDLM_FL_CBPENDING      0x000010 /* this lock is being destroyed */
  98 #define LDLM_FL_AST_SENT       0x000020 /* blocking or cancel packet was sent */
  99 #define LDLM_FL_WAIT_NOREPROC  0x000040 /* not a real flag, not saved in lock */
 100 #define LDLM_FL_CANCEL         0x000080 /* cancellation callback already run */
 101
 102 /* Lock is being replayed.  This could probably be implied by the fact that one
 103  * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
 104 #define LDLM_FL_REPLAY         0x000100
 105
 106 #define LDLM_FL_INTENT_ONLY    0x000200 /* don't grant lock, just do intent */
 107 #define LDLM_FL_LOCAL_ONLY     0x000400 /* see ldlm_cli_cancel_unused */
 108
 109 /* don't run the cancel callback under ldlm_cli_cancel_unused */
 110 #define LDLM_FL_FAILED         0x000800
 111
 112 #define LDLM_FL_HAS_INTENT     0x001000 /* lock request has intent */
 113 #define LDLM_FL_CANCELING      0x002000 /* lock cancel has already been sent */
 114 #define LDLM_FL_LOCAL          0x004000 /* local lock (ie, no srv/cli split) */
 115 #define LDLM_FL_WARN           0x008000 /* see ldlm_cli_cancel_unused */
 116 #define LDLM_FL_DISCARD_DATA   0x010000 /* discard (no writeback) on cancel */
 117
 118 #define LDLM_FL_NO_TIMEOUT     0x020000 /* Blocked by group lock - wait
 119                                          * indefinitely */
 120
 121 /* file & record locking */
 122 #define LDLM_FL_BLOCK_NOWAIT   0x040000 // server told not to wait if blocked
 123 #define LDLM_FL_TEST_LOCK      0x080000 // return blocking lock
 124
 125 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
 126  * the LVB filling happens _after_ the lock has been granted, so another thread
 127  * can match`t before the LVB has been updated.  As a dirty hack, we set
 128  * LDLM_FL_LVB_READY only after we've done the LVB poop.
 129  * this is only needed on lov/osc now, where lvb is actually used and callers
 130  * must set it in input flags.
 131  *
 132  * The proper fix is to do the granting inside of the completion AST, which can
 133  * be replaced with a LVB-aware wrapping function for OSC locks.  That change is
 134  * pretty high-risk, though, and would need a lot more testing. */
 135
 136 #define LDLM_FL_LVB_READY      0x100000
 137
 138 /* A lock contributes to the kms calculation until it has finished the part
 139  * of it's cancelation that performs write back on its dirty pages.  It
 140  * can remain on the granted list during this whole time.  Threads racing
 141  * to update the kms after performing their writeback need to know to
 142  * exclude each others locks from the calculation as they walk the granted
 143  * list. */
 144 #define LDLM_FL_KMS_IGNORE     0x200000
 145
 146 /* Don't drop lock covering mmapped file in LRU */
 147 #define LDLM_FL_NO_LRU         0x400000
 148
 149 /* Immediatelly cancel such locks when they block some other locks. Send
 150    cancel notification to original lock holder, but expect no reply. */
 151 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
 152
 153 /* Flags flags inherited from parent lock when doing intents. */
 154 #define LDLM_INHERIT_FLAGS     (LDLM_FL_CANCEL_ON_BLOCK)
 155
 156 /* These are flags that are mapped into the flags and ASTs of blocking locks */
 157 #define LDLM_AST_DISCARD_DATA  0x80000000 /* Add FL_DISCARD to blocking ASTs */
 158 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
 159 #define LDLM_AST_FLAGS         (LDLM_FL_DISCARD_DATA)
 160
 161 /* completion ast to be executed */
 162 #define LDLM_FL_CP_REQD        0x1000000
 163
 164 /* cleanup_resource has already handled the lock */
 165 #define LDLM_FL_CLEANED        0x2000000
 166
 167 /* optimization hint: LDLM can run blocking callback from current context
 168  * w/o involving separate thread. in order to decrease cs rate */
 169 #define LDLM_FL_ATOMIC_CB      0x4000000
 170
 171 /* Cancel lock asynchronously. See ldlm_cli_cancel_unused_resource. */
 172 #define LDLM_FL_ASYNC           0x8000000
 173
 174 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
 175  * such that server send blocking ast for conflict locks to this client for
 176  * the 1st operation, whereas the 2nd operation has canceled this lock and
 177  * is waiting for rpc_lock which is taken by the 1st operation.
 178  * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
 179  * ELC code to cancel it.
 180  * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
 181  * droped to let ldlm_callback_handler() return EINVAL to the server. It is
 182  * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
 183  * to send a separate CANCEL rpc. */
 184 #define LDLM_FL_BL_AST          0x10000000
 185 #define LDLM_FL_BL_DONE         0x20000000
 186
 187 /* measure lock contention and return -EUSERS if locking contention is high */
 188 #define LDLM_FL_DENY_ON_CONTENTION 0x40000000
 189
 190 /* The blocking callback is overloaded to perform two functions.  These flags
 191  * indicate which operation should be performed. */
 192 #define LDLM_CB_BLOCKING    1
 193 #define LDLM_CB_CANCELING   2
 194
 195 /* compatibility matrix */
 196 #define LCK_COMPAT_EX  LCK_NL
 197 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
 198 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
 199 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
 200 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
 201 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
 202 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
 203
 204 extern ldlm_mode_t lck_compat_array[];
 205
 206 static inline void lockmode_verify(ldlm_mode_t mode)
 207 {
 208        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
 209 }
 210
 211 static inline int lockmode_compat(ldlm_mode_t exist_mode, ldlm_mode_t new_mode)
 212 {
 213        return (lck_compat_array[exist_mode] & new_mode);
 214 }
 215
 216 /*
 217  *
 218  * cluster name spaces
 219  *
 220  */
 221
 222 #define DLM_OST_NAMESPACE 1
 223 #define DLM_MDS_NAMESPACE 2
 224
 225 /* XXX
 226    - do we just separate this by security domains and use a prefix for
 227      multiple namespaces in the same domain?
 228    -
 229 */
 230
 231 /*
 232  * Locking rules:
 233  *
 234  * lr_lock
 235  *
 236  * lr_lock
 237  *     waiting_locks_spinlock
 238  *
 239  * lr_lock
 240  *     led_lock
 241  *
 242  * lr_lock
 243  *     ns_unused_lock
 244  *
 245  * lr_lvb_sem
 246  *     lr_lock
 247  *
 248  */
 249
 250 struct ldlm_pool;
 251 struct ldlm_lock;
 252 struct ldlm_resource;
 253 struct ldlm_namespace;
 254
 255 struct ldlm_pool_ops {
 256         int (*po_recalc)(struct ldlm_pool *pl);
 257         int (*po_shrink)(struct ldlm_pool *pl, int nr,
 258                          unsigned int gfp_mask);
 259         int (*po_setup)(struct ldlm_pool *pl, int limit);
 260 };
 261
 262 /**
 263  * One second for pools thread check interval. Each pool has own period.
 264  */
 265 #define LDLM_POOLS_THREAD_PERIOD (1)
 266
 267 /**
 268  * 5% margin for modest pools. See ldlm_pool.c for details.
 269  */
 270 #define LDLM_POOLS_MODEST_MARGIN (5)
 271
 272 /**
 273  * Default recalc period for server side pools in sec.
 274  */
 275 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
 276
 277 /**
 278  * Default recalc period for client side pools in sec.
 279  */
 280 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
 281
 282 struct ldlm_pool {
 283         /**
 284          * Pool proc directory.
 285          */
 286         cfs_proc_dir_entry_t  *pl_proc_dir;
 287         /**
 288          * Pool name, should be long enough to contain compound proc entry name.
 289          */
 290         char                   pl_name[100];
 291         /**
 292          * Lock for protecting slv/clv updates.
 293          */
 294         spinlock_t             pl_lock;
 295         /**
 296          * Number of allowed locks in in pool, both, client and server side.
 297          */
 298         atomic_t               pl_limit;
 299         /**
 300          * Number of granted locks in
 301          */
 302         atomic_t               pl_granted;
 303         /**
 304          * Grant rate per T.
 305          */
 306         atomic_t               pl_grant_rate;
 307         /**
 308          * Cancel rate per T.
 309          */
 310         atomic_t               pl_cancel_rate;
 311         /**
 312          * Grant speed (GR-CR) per T.
 313          */
 314         atomic_t               pl_grant_speed;
 315         /**
 316          * Server lock volume. Protected by pl_lock.
 317          */
 318         __u64                  pl_server_lock_volume;
 319         /**
 320          * Current biggest client lock volume. Protected by pl_lock.
 321          */
 322         __u64                  pl_client_lock_volume;
 323         /**
 324          * Lock volume factor. SLV on client is calculated as following:
 325          * server_slv * lock_volume_factor.
 326          */
 327         atomic_t               pl_lock_volume_factor;
 328         /**
 329          * Time when last slv from server was obtained.
 330          */
 331         time_t                 pl_recalc_time;
 332         /**
 333           * Recalc period for pool.
 334           */
 335         time_t                 pl_recalc_period;
 336         /**
 337          * Recalc and shrink ops.
 338          */
 339         struct ldlm_pool_ops  *pl_ops;
 340         /**
 341          * Number of planned locks for next period.
 342          */
 343         int                    pl_grant_plan;
 344         /**
 345          * Pool statistics.
 346          */
 347         struct lprocfs_stats  *pl_stats;
 348 };
 349
 350 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
 351                                void *req_cookie, ldlm_mode_t mode, int flags,
 352                                void *data);
 353
 354 struct ldlm_valblock_ops {
 355         int (*lvbo_init)(struct ldlm_resource *res);
 356         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
 357                            int buf_idx, int increase);
 358 };
 359
 360 typedef enum {
 361         LDLM_NAMESPACE_GREEDY = 1 << 0,
 362         LDLM_NAMESPACE_MODEST = 1 << 1
 363 } ldlm_appetite_t;
 364
 365 /*
 366  * Default value for ->ns_shrink_thumb. If lock is not extent one its cost
 367  * is one page. Here we have 256 pages which is 1M on i386. Thus by default
 368  * all extent locks which have more than 1M long extent will be kept in lru,
 369  * others (including ibits locks) will be canceled on memory pressure event.
 370  */
 371 #define LDLM_LOCK_SHRINK_THUMB 256
 372
 373 /*
 374  * Default values for the "max_nolock_size", "contention_time" and
 375  * "contended_locks" namespace tunables.
 376  */
 377 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
 378 #define NS_DEFAULT_CONTENTION_SECONDS 2
 379 #define NS_DEFAULT_CONTENDED_LOCKS 32
 380
 381 struct ldlm_namespace {
 382         /**
 383          * Namespace name. Used for logging, etc.
 384          */
 385         char                  *ns_name;
 386
 387         /**
 388          * Is this a client-side lock tree?
 389          */
 390         ldlm_side_t            ns_client;
 391
 392         /**
 393          * Namespce connect flags supported by server (may be changed via proc,
 394          * lru resize may be disabled/enabled).
 395          */
 396         __u64                  ns_connect_flags;
 397
 398          /**
 399           * Client side orig connect flags supported by server.
 400           */
 401         __u64                  ns_orig_connect_flags;
 402
 403         /**
 404          * Hash table for namespace.
 405          */
 406         struct list_head      *ns_hash;
 407         spinlock_t             ns_hash_lock;
 408
 409          /**
 410           * Count of resources in the hash.
 411           */
 412         __u32                  ns_refcount;
 413
 414          /**
 415           * All root resources in namespace.
 416           */
 417         struct list_head       ns_root_list;
 418
 419         /**
 420          * Position in global namespace list.
 421          */
 422         struct list_head       ns_list_chain;
 423
 424         /**
 425          * All root resources in namespace.
 426          */
 427         struct list_head       ns_unused_list;
 428         int                    ns_nr_unused;
 429         spinlock_t             ns_unused_lock;
 430
 431         unsigned int           ns_max_unused;
 432         unsigned int           ns_max_age;
 433
 434          /**
 435           * Seconds.
 436           */
 437         unsigned int           ns_ctime_age_limit;
 438
 439         /**
 440          * Lower limit to number of pages in lock to keep it in cache.
 441          */
 442         unsigned int           ns_shrink_thumb;
 443
 444         /**
 445          * Next debug dump, jiffies.
 446          */
 447         cfs_time_t             ns_next_dump;
 448
 449         atomic_t               ns_locks;
 450         __u64                  ns_resources;
 451         ldlm_res_policy        ns_policy;
 452         struct ldlm_valblock_ops *ns_lvbo;
 453         void                  *ns_lvbp;
 454         cfs_waitq_t            ns_waitq;
 455         struct ldlm_pool       ns_pool;
 456         ldlm_appetite_t        ns_appetite;
 457
 458         /**
 459          * If more than @ns_contented_locks found, the resource considered
 460          * as contended.
 461          */
 462         unsigned               ns_contended_locks;
 463
 464         /**
 465          * The resource remembers contended state during @ns_contention_time,
 466          * in seconds.
 467          */
 468         unsigned               ns_contention_time;
 469
 470         /**
 471          * Limit size of nolock requests, in bytes.
 472          */
 473         unsigned               ns_max_nolock_size;
 474
 475         /**
 476          * Backward link to obd, required for ldlm pool to store new SLV.
 477          */
 478         struct obd_device     *ns_obd;
 479
 480         struct adaptive_timeout ns_at_estimate;/* estimated lock callback time*/
 481 };
 482
 483 static inline int ns_is_client(struct ldlm_namespace *ns)
 484 {
 485         LASSERT(ns != NULL);
 486         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 487                                     LDLM_NAMESPACE_SERVER)));
 488         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 489                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 490         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
 491 }
 492
 493 static inline int ns_is_server(struct ldlm_namespace *ns)
 494 {
 495         LASSERT(ns != NULL);
 496         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 497                                     LDLM_NAMESPACE_SERVER)));
 498         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 499                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 500         return ns->ns_client == LDLM_NAMESPACE_SERVER;
 501 }
 502
 503 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
 504 {
 505         LASSERT(ns != NULL);
 506         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
 507 }
 508
 509 /*
 510  *
 511  * Resource hash table
 512  *
 513  */
 514
 515 #define RES_HASH_BITS 10
 516 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 517 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 518
 519 struct ldlm_lock;
 520
 521 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 522                                       struct ldlm_lock_desc *new, void *data,
 523                                       int flag);
 524 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
 525                                         void *data);
 526 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
 527
 528 /* Interval node data for each LDLM_EXTENT lock */
 529 struct ldlm_interval {
 530         struct interval_node li_node;   /* node for tree mgmt */
 531         struct list_head     li_group;  /* the locks which have the same
 532                                          * policy - group of the policy */
 533 };
 534 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
 535
 536 /* the interval tree must be accessed inside the resource lock. */
 537 struct ldlm_interval_tree {
 538         /* tree size, this variable is used to count
 539          * granted PW locks in ldlm_extent_policy()*/
 540         int                   lit_size;
 541         ldlm_mode_t           lit_mode; /* lock mode */
 542         struct interval_node *lit_root; /* actually ldlm_interval */
 543 };
 544
 545 struct ldlm_lock {
 546         struct portals_handle l_handle; // must be first in the structure
 547         atomic_t              l_refc;
 548
 549         /* internal spinlock protects l_resource.  we should hold this lock
 550          * first before grabbing res_lock.*/
 551         spinlock_t            l_lock;
 552
 553         /* ldlm_lock_change_resource() can change this */
 554         struct ldlm_resource *l_resource;
 555
 556         /* protected by ns_hash_lock. FIXME */
 557         struct list_head      l_lru;
 558
 559         /* protected by lr_lock, linkage to resource's lock queues */
 560         struct list_head      l_res_link;
 561
 562         struct ldlm_interval *l_tree_node;      /* tree node for ldlm_extent */
 563
 564         /* protected by led_lock */
 565         struct list_head      l_export_chain; // per-export chain of locks
 566
 567         /* protected by lr_lock */
 568         ldlm_mode_t           l_req_mode;
 569         ldlm_mode_t           l_granted_mode;
 570
 571         ldlm_completion_callback l_completion_ast;
 572         ldlm_blocking_callback   l_blocking_ast;
 573         ldlm_glimpse_callback    l_glimpse_ast;
 574
 575         struct obd_export    *l_export;
 576         struct obd_export    *l_conn_export;
 577
 578         struct lustre_handle  l_remote_handle;
 579         ldlm_policy_data_t    l_policy_data;
 580
 581         /* protected by lr_lock */
 582         __u32                 l_flags;
 583         __u32                 l_readers;
 584         __u32                 l_writers;
 585         __u8                  l_destroyed;
 586
 587         /* If the lock is granted, a process sleeps on this waitq to learn when
 588          * it's no longer in use.  If the lock is not granted, a process sleeps
 589          * on this waitq to learn when it becomes granted. */
 590         cfs_waitq_t           l_waitq;
 591         struct timeval        l_enqueued_time;
 592
 593         cfs_time_t            l_last_used;      /* jiffies */
 594         struct ldlm_extent    l_req_extent;
 595
 596         /* Client-side-only members */
 597         __u32                 l_lvb_len;        /* temporary storage for */
 598         void                 *l_lvb_data;       /* an LVB received during */
 599         void                 *l_lvb_swabber;    /* an enqueue */
 600         void                 *l_ast_data;
 601         spinlock_t            l_extents_list_lock;
 602         struct list_head      l_extents_list;
 603
 604         struct list_head      l_cache_locks_list;
 605
 606         /* Server-side-only members */
 607
 608         /* protected by elt_lock */
 609         struct list_head      l_pending_chain;  /* callbacks pending */
 610         cfs_time_t            l_callback_timeout; /* jiffies */
 611
 612         __u32                 l_pid;            /* pid which created this lock */
 613
 614         /* for ldlm_add_ast_work_item() */
 615         struct list_head      l_bl_ast;
 616         struct list_head      l_cp_ast;
 617         struct ldlm_lock     *l_blocking_lock;
 618         int                   l_bl_ast_run;
 619
 620         /* protected by lr_lock, linkages to "skip lists" */
 621         struct list_head      l_sl_mode;
 622         struct list_head      l_sl_policy;
 623 };
 624
 625 struct ldlm_resource {
 626         struct ldlm_namespace *lr_namespace;
 627
 628         /* protected by ns_hash_lock */
 629         struct list_head       lr_hash;
 630         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 631         struct list_head       lr_children; /* list head for child resources */
 632         struct list_head       lr_childof;  /* part of ns_root_list if root res,
 633                                              * part of lr_children if child */
 634         spinlock_t             lr_lock;
 635
 636         /* protected by lr_lock */
 637         struct list_head       lr_granted;
 638         struct list_head       lr_converting;
 639         struct list_head       lr_waiting;
 640         ldlm_mode_t            lr_most_restr;
 641         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 642         struct ldlm_res_id     lr_name;
 643         atomic_t               lr_refcount;
 644
 645         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
 646
 647         /* Server-side-only lock value block elements */
 648         struct semaphore       lr_lvb_sem;
 649         __u32                  lr_lvb_len;
 650         void                  *lr_lvb_data;
 651
 652         /* when the resource was considered as contended */
 653         cfs_time_t             lr_contention_time;
 654 };
 655
 656 struct ldlm_ast_work {
 657         struct ldlm_lock *w_lock;
 658         int               w_blocking;
 659         struct ldlm_lock_desc w_desc;
 660         struct list_head   w_list;
 661         int w_flags;
 662         void *w_data;
 663         int w_datalen;
 664 };
 665
 666 /* ldlm_enqueue parameters common */
 667 struct ldlm_enqueue_info {
 668         __u32 ei_type;   /* Type of the lock being enqueued. */
 669         __u32 ei_mode;   /* Mode of the lock being enqueued. */
 670         void *ei_cb_bl;  /* blocking lock callback */
 671         void *ei_cb_cp;  /* lock completion callback */
 672         void *ei_cb_gl;  /* lock glimpse callback */
 673         void *ei_cbdata; /* Data to be passed into callbacks. */
 674 };
 675
 676 extern struct obd_ops ldlm_obd_ops;
 677
 678 extern char *ldlm_lockname[];
 679 extern char *ldlm_typename[];
 680 extern char *ldlm_it2str(int it);
 681 #ifdef LIBCFS_DEBUG
 682 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
 683         CHECK_STACK();                                                  \
 684                                                                         \
 685         if (((level) & D_CANTMASK) != 0 ||                              \
 686             ((libcfs_debug & (level)) != 0 &&                           \
 687              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
 688                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
 689                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
 690                                     file, func, line);                  \
 691                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
 692                                  ##a );                                 \
 693         }                                                               \
 694 } while(0)
 695
 696 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
 697                       struct libcfs_debug_msg_data *data, const char *fmt,
 698                       ...)
 699         __attribute__ ((format (printf, 4, 5)));
 700
 701 #define LDLM_ERROR(lock, fmt, a...) do {                                \
 702         static cfs_debug_limit_state_t _ldlm_cdls;                      \
 703         ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock,                     \
 704                         __FILE__, __FUNCTION__, __LINE__,               \
 705                         "### " fmt , ##a);                              \
 706 } while (0)
 707
 708 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
 709         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
 710                         __FILE__, __FUNCTION__, __LINE__,               \
 711                          "### " fmt , ##a);                             \
 712 } while (0)
 713 #else
 714 #define LDLM_DEBUG(lock, fmt, a...) ((void)0)
 715 #define LDLM_ERROR(lock, fmt, a...) ((void)0)
 716 #endif
 717
 718 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 719         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
 720
 721 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 722                                       int first_enq, ldlm_error_t *err,
 723                                       struct list_head *work_list);
 724
 725 /*
 726  * Iterators.
 727  */
 728
 729 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 730 #define LDLM_ITER_STOP     2 /* stop iterating */
 731
 732 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 733 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 734
 735 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 736                           void *closure);
 737 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 738                            void *closure);
 739 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
 740                                ldlm_res_iterator_t iter, void *closure);
 741
 742 int ldlm_replay_locks(struct obd_import *imp);
 743 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
 744                            ldlm_iterator_t iter, void *data);
 745
 746 /* ldlm_flock.c */
 747 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 748
 749 /* ldlm_extent.c */
 750 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 751
 752
 753 /* ldlm_lockd.c */
 754 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 755                              void *data, int flag);
 756 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 757 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 758 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 759                         ldlm_blocking_callback, ldlm_glimpse_callback);
 760 int ldlm_handle_convert(struct ptlrpc_request *req);
 761 int ldlm_handle_cancel(struct ptlrpc_request *req);
 762 int ldlm_request_cancel(struct ptlrpc_request *req,
 763                         const struct ldlm_request *dlm_req, int first);
 764 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
 765 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
 766 void ldlm_revoke_export_locks(struct obd_export *exp);
 767 int ldlm_get_ref(void);
 768 void ldlm_put_ref(void);
 769
 770 /* ldlm_lock.c */
 771 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
 772 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
 773 void ldlm_lock2handle(const struct ldlm_lock *lock,
 774                       struct lustre_handle *lockh);
 775 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
 776 void ldlm_cancel_callback(struct ldlm_lock *);
 777 int ldlm_lock_set_data(struct lustre_handle *, void *data);
 778 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
 779 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
 780                                       const struct lustre_handle *);
 781
 782 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
 783 {
 784         return __ldlm_handle2lock(h, 0);
 785 }
 786
 787 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
 788                                        struct lustre_msg *m, int buf_idx,
 789                                        int increase)
 790 {
 791         if (res->lr_namespace->ns_lvbo &&
 792             res->lr_namespace->ns_lvbo->lvbo_update) {
 793                 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
 794                                                                increase);
 795         }
 796         return 0;
 797 }
 798
 799 #define LDLM_LOCK_PUT(lock)                     \
 800 do {                                            \
 801         /*LDLM_DEBUG((lock), "put");*/          \
 802         ldlm_lock_put(lock);                    \
 803 } while (0)
 804
 805 #define LDLM_LOCK_GET(lock)                     \
 806 ({                                              \
 807         ldlm_lock_get(lock);                    \
 808         /*LDLM_DEBUG((lock), "get");*/          \
 809         lock;                                   \
 810 })
 811
 812 #define ldlm_lock_list_put(head, member, count)                 \
 813 ({                                                              \
 814         struct ldlm_lock *_lock, *_next;                        \
 815         int c = count;                                          \
 816         list_for_each_entry_safe(_lock, _next, head, member) {  \
 817                 if (c-- == 0)                                   \
 818                         break;                                  \
 819                 list_del_init(&_lock->member);                  \
 820                 LDLM_LOCK_PUT(_lock);                           \
 821         }                                                       \
 822         LASSERT(c <= 0);                                        \
 823 })
 824
 825 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
 826 void ldlm_lock_put(struct ldlm_lock *lock);
 827 void ldlm_lock_destroy(struct ldlm_lock *lock);
 828 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
 829 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
 830 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
 831 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
 832 void ldlm_lock_allow_match(struct ldlm_lock *lock);
 833 int ldlm_lock_fast_match(struct ldlm_lock *, int, obd_off, obd_off, void **);
 834 void ldlm_lock_fast_release(void *, int);
 835 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
 836                             const struct ldlm_res_id *, ldlm_type_t type,
 837                             ldlm_policy_data_t *, ldlm_mode_t mode,
 838                             struct lustre_handle *);
 839 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
 840                                         __u32 *flags);
 841 void ldlm_lock_cancel(struct ldlm_lock *lock);
 842 void ldlm_cancel_locks_for_export(struct obd_export *export);
 843 void ldlm_reprocess_all(struct ldlm_resource *res);
 844 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
 845 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
 846 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
 847 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
 848
 849 /* resource.c */
 850 struct ldlm_namespace *
 851 ldlm_namespace_new(struct obd_device *obd, char *name,
 852                    ldlm_side_t client, ldlm_appetite_t apt);
 853 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
 854 void ldlm_namespace_free(struct ldlm_namespace *ns,
 855                          struct obd_import *imp, int force);
 856 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
 857 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
 858 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
 859 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
 860 void ldlm_namespace_get_locked(struct ldlm_namespace *ns);
 861 void ldlm_namespace_put_locked(struct ldlm_namespace *ns, int wakeup);
 862 void ldlm_namespace_get(struct ldlm_namespace *ns);
 863 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
 864 int ldlm_proc_setup(void);
 865 #ifdef LPROCFS
 866 void ldlm_proc_cleanup(void);
 867 #else
 868 static inline void ldlm_proc_cleanup(void) {}
 869 #endif
 870
 871 /* resource.c - internal */
 872 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
 873                                         struct ldlm_resource *parent,
 874                                         const struct ldlm_res_id *,
 875                                         ldlm_type_t type, int create);
 876 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
 877 int ldlm_resource_putref(struct ldlm_resource *res);
 878 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
 879                             struct ldlm_lock *lock);
 880 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
 881 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
 882 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
 883 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
 884 void ldlm_resource_dump(int level, struct ldlm_resource *);
 885 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
 886                               const struct ldlm_res_id *);
 887
 888 struct ldlm_callback_suite {
 889         ldlm_completion_callback lcs_completion;
 890         ldlm_blocking_callback   lcs_blocking;
 891         ldlm_glimpse_callback    lcs_glimpse;
 892 };
 893
 894 /* ldlm_request.c */
 895 int ldlm_expired_completion_wait(void *data);
 896 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 897                       void *data, int flag);
 898 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
 899 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 900 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
 901                      struct ldlm_enqueue_info *einfo,
 902                      const struct ldlm_res_id *res_id,
 903                      ldlm_policy_data_t *policy, int *flags,
 904                      void *lvb, __u32 lvb_len, void *lvb_swabber,
 905                      struct lustre_handle *lockh, int async);
 906 int ldlm_prep_enqueue_req(struct obd_export *exp,
 907                           struct ptlrpc_request *req,
 908                           struct list_head *cancels,
 909                           int count);
 910 int ldlm_prep_elc_req(struct obd_export *exp,
 911                       struct ptlrpc_request *req,
 912                       int version, int opc, int canceloff,
 913                       struct list_head *cancels, int count);
 914 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
 915                          const struct ldlm_request *dlm_req,
 916                          const struct ldlm_callback_suite *cbs);
 917 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
 918                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
 919                           int *flags, void *lvb, __u32 lvb_len,
 920                           void *lvb_swabber, struct lustre_handle *lockh,
 921                           int rc);
 922 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
 923                            const struct ldlm_res_id *res_id,
 924                            ldlm_type_t type, ldlm_policy_data_t *policy,
 925                            ldlm_mode_t mode, int *flags,
 926                            ldlm_blocking_callback blocking,
 927                            ldlm_completion_callback completion,
 928                            ldlm_glimpse_callback glimpse,
 929                            void *data, __u32 lvb_len, void *lvb_swabber,
 930                            struct lustre_handle *lockh);
 931 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
 932                     void *data, __u32 data_len);
 933 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
 934 int ldlm_cli_update_pool(struct ptlrpc_request *req);
 935 int ldlm_handle_convert0(struct ptlrpc_request *req,
 936                          const struct ldlm_request *dlm_req);
 937 int ldlm_cli_cancel(struct lustre_handle *lockh);
 938 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
 939                            int flags, void *opaque);
 940 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
 941                                     const struct ldlm_res_id *res_id,
 942                                     ldlm_policy_data_t *policy,
 943                                     ldlm_mode_t mode, int flags, void *opaque);
 944 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
 945                         int count, int flags);
 946 int ldlm_cli_join_lru(struct ldlm_namespace *,
 947                       const struct ldlm_res_id *, int join);
 948 int ldlm_cancel_resource_local(struct ldlm_resource *res,
 949                                struct list_head *cancels,
 950                                ldlm_policy_data_t *policy,
 951                                ldlm_mode_t mode, int lock_flags,
 952                                int cancel_flags, void *opaque);
 953 int ldlm_cli_cancel_list(struct list_head *head, int count,
 954                          struct ptlrpc_request *req, int flags);
 955
 956 /* mds/handler.c */
 957 /* This has to be here because recursive inclusion sucks. */
 958 int intent_disposition(struct ldlm_reply *rep, int flag);
 959 void intent_set_disposition(struct ldlm_reply *rep, int flag);
 960
 961
 962 /* ioctls for trying requests */
 963 #define IOC_LDLM_TYPE                   'f'
 964 #define IOC_LDLM_MIN_NR                 40
 965
 966 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
 967 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
 968 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
 969 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
 970 #define IOC_LDLM_MAX_NR                 43
 971
 972 static inline void lock_res(struct ldlm_resource *res)
 973 {
 974         spin_lock(&res->lr_lock);
 975 }
 976
 977 static inline void unlock_res(struct ldlm_resource *res)
 978 {
 979         spin_unlock(&res->lr_lock);
 980 }
 981
 982 static inline void check_res_locked(struct ldlm_resource *res)
 983 {
 984         LASSERT_SPIN_LOCKED(&res->lr_lock);
 985 }
 986
 987 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
 988 void unlock_res_and_lock(struct ldlm_lock *lock);
 989
 990 /* ldlm_pool.c */
 991 void ldlm_pools_recalc(ldlm_side_t client);
 992 int ldlm_pools_init(void);
 993 void ldlm_pools_fini(void);
 994
 995 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
 996                    int idx, ldlm_side_t client);
 997 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
 998                      unsigned int gfp_mask);
 999 void ldlm_pool_fini(struct ldlm_pool *pl);
1000 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1001 int ldlm_pool_recalc(struct ldlm_pool *pl);
1002 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1003 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1004 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1005 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1006 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1007 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1008 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1009 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1010 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1011 #endif