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 /* One second for pools thread check interval. */
 263 #define LDLM_POOLS_THREAD_PERIOD (1)
 264
 265 /* 5% margin for modest pools. See ldlm_pool.c for details. */
 266 #define LDLM_POOLS_MODEST_MARGIN (5)
 267
 268 /* A change to SLV in % after which we want to wake up pools thread asap. */
 269 #define LDLM_POOLS_FAST_SLV_CHANGE (50)
 270
 271 struct ldlm_pool {
 272         /**
 273          * Pool proc directory.
 274          */
 275         cfs_proc_dir_entry_t  *pl_proc_dir;
 276         /**
 277          * Pool name, should be long enough to contain compound proc entry name.
 278          */
 279         char                   pl_name[100];
 280         /**
 281          * Lock for protecting slv/clv updates.
 282          */
 283         spinlock_t             pl_lock;
 284         /**
 285          * Number of allowed locks in in pool, both, client and server side.
 286          */
 287         atomic_t               pl_limit;
 288         /**
 289          * Number of granted locks in
 290          */
 291         atomic_t               pl_granted;
 292         /**
 293          * Grant rate per T.
 294          */
 295         atomic_t               pl_grant_rate;
 296         /**
 297          * Cancel rate per T.
 298          */
 299         atomic_t               pl_cancel_rate;
 300         /**
 301          * Grant speed (GR-CR) per T.
 302          */
 303         atomic_t               pl_grant_speed;
 304         /**
 305          * Server lock volume. Protected by pl_lock.
 306          */
 307         __u64                  pl_server_lock_volume;
 308         /**
 309          * Current biggest client lock volume. Protected by pl_lock.
 310          */
 311         __u64                  pl_client_lock_volume;
 312         /**
 313          * Lock volume factor. SLV on client is calculated as following:
 314          * server_slv * lock_volume_factor.
 315          */
 316         atomic_t               pl_lock_volume_factor;
 317         /**
 318          * Time when last slv from server was obtained.
 319          */
 320         time_t                 pl_recalc_time;
 321         /**
 322          * Recalc and shrink ops.
 323          */
 324         struct ldlm_pool_ops  *pl_ops;
 325         /**
 326          * Planned number of granted locks for next T.
 327          */
 328         int                    pl_grant_plan;
 329         /**
 330          * Grant plan step for next T.
 331          */
 332         int                    pl_grant_step;
 333         /**
 334          * Pool statistics.
 335          */
 336         struct lprocfs_stats  *pl_stats;
 337 };
 338
 339 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
 340                                void *req_cookie, ldlm_mode_t mode, int flags,
 341                                void *data);
 342
 343 struct ldlm_valblock_ops {
 344         int (*lvbo_init)(struct ldlm_resource *res);
 345         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
 346                            int buf_idx, int increase);
 347 };
 348
 349 typedef enum {
 350         LDLM_NAMESPACE_GREEDY = 1 << 0,
 351         LDLM_NAMESPACE_MODEST = 1 << 1
 352 } ldlm_appetite_t;
 353
 354 /*
 355  * Default value for ->ns_shrink_thumb. If lock is not extent one its cost
 356  * is one page. Here we have 256 pages which is 1M on i386. Thus by default
 357  * all extent locks which have more than 1M long extent will be kept in lru,
 358  * others (including ibits locks) will be canceled on memory pressure event.
 359  */
 360 #define LDLM_LOCK_SHRINK_THUMB 256
 361
 362 /*
 363  * Default values for the "max_nolock_size", "contention_time" and
 364  * "contended_locks" namespace tunables.
 365  */
 366 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
 367 #define NS_DEFAULT_CONTENTION_SECONDS 2
 368 #define NS_DEFAULT_CONTENDED_LOCKS 32
 369
 370 struct ldlm_namespace {
 371         /**
 372          * Namespace name. Used for logging, etc.
 373          */
 374         char                  *ns_name;
 375
 376         /**
 377          * Is this a client-side lock tree?
 378          */
 379         ldlm_side_t            ns_client;
 380
 381         /**
 382          * Namespce connect flags supported by server (may be changed via proc,
 383          * lru resize may be disabled/enabled).
 384          */
 385         __u64                  ns_connect_flags;
 386
 387          /**
 388           * Client side orig connect flags supported by server.
 389           */
 390         __u64                  ns_orig_connect_flags;
 391
 392         /**
 393          * Hash table for namespace.
 394          */
 395         struct list_head      *ns_hash;
 396         spinlock_t             ns_hash_lock;
 397
 398          /**
 399           * Count of resources in the hash.
 400           */
 401         __u32                  ns_refcount;
 402
 403          /**
 404           * All root resources in namespace.
 405           */
 406         struct list_head       ns_root_list;
 407
 408         /**
 409          * Position in global namespace list.
 410          */
 411         struct list_head       ns_list_chain;
 412
 413         /**
 414          * All root resources in namespace.
 415          */
 416         struct list_head       ns_unused_list;
 417         int                    ns_nr_unused;
 418         spinlock_t             ns_unused_lock;
 419
 420         unsigned int           ns_max_unused;
 421         unsigned int           ns_max_age;
 422
 423          /**
 424           * Seconds.
 425           */
 426         unsigned int           ns_ctime_age_limit;
 427
 428         /**
 429          * Lower limit to number of pages in lock to keep it in cache.
 430          */
 431         unsigned int           ns_shrink_thumb;
 432
 433         /**
 434          * Next debug dump, jiffies.
 435          */
 436         cfs_time_t             ns_next_dump;
 437
 438         atomic_t               ns_locks;
 439         __u64                  ns_resources;
 440         ldlm_res_policy        ns_policy;
 441         struct ldlm_valblock_ops *ns_lvbo;
 442         void                  *ns_lvbp;
 443         cfs_waitq_t            ns_waitq;
 444         struct ldlm_pool       ns_pool;
 445         ldlm_appetite_t        ns_appetite;
 446
 447         /**
 448          * If more than @ns_contented_locks found, the resource considered
 449          * as contended.
 450          */
 451         unsigned               ns_contended_locks;
 452
 453         /**
 454          * The resource remembers contended state during @ns_contention_time,
 455          * in seconds.
 456          */
 457         unsigned               ns_contention_time;
 458
 459         /**
 460          * Limit size of nolock requests, in bytes.
 461          */
 462         unsigned               ns_max_nolock_size;
 463
 464         /**
 465          * Backward link to obd, required for ldlm pool to store new SLV.
 466          */
 467         struct obd_device     *ns_obd;
 468
 469         struct adaptive_timeout ns_at_estimate;/* estimated lock callback time*/
 470 };
 471
 472 static inline int ns_is_client(struct ldlm_namespace *ns)
 473 {
 474         LASSERT(ns != NULL);
 475         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 476                                     LDLM_NAMESPACE_SERVER)));
 477         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 478                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 479         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
 480 }
 481
 482 static inline int ns_is_server(struct ldlm_namespace *ns)
 483 {
 484         LASSERT(ns != NULL);
 485         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
 486                                     LDLM_NAMESPACE_SERVER)));
 487         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
 488                 ns->ns_client == LDLM_NAMESPACE_SERVER);
 489         return ns->ns_client == LDLM_NAMESPACE_SERVER;
 490 }
 491
 492 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
 493 {
 494         LASSERT(ns != NULL);
 495         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
 496 }
 497
 498 /*
 499  *
 500  * Resource hash table
 501  *
 502  */
 503
 504 #define RES_HASH_BITS 10
 505 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 506 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 507
 508 struct ldlm_lock;
 509
 510 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 511                                       struct ldlm_lock_desc *new, void *data,
 512                                       int flag);
 513 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
 514                                         void *data);
 515 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
 516
 517 /* Interval node data for each LDLM_EXTENT lock */
 518 struct ldlm_interval {
 519         struct interval_node li_node;   /* node for tree mgmt */
 520         struct list_head     li_group;  /* the locks which have the same
 521                                          * policy - group of the policy */
 522 };
 523 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
 524
 525 /* the interval tree must be accessed inside the resource lock. */
 526 struct ldlm_interval_tree {
 527         /* tree size, this variable is used to count
 528          * granted PW locks in ldlm_extent_policy()*/
 529         int                   lit_size;
 530         ldlm_mode_t           lit_mode; /* lock mode */
 531         struct interval_node *lit_root; /* actually ldlm_interval */
 532 };
 533
 534 struct ldlm_lock {
 535         struct portals_handle l_handle; // must be first in the structure
 536         atomic_t              l_refc;
 537
 538         /* internal spinlock protects l_resource.  we should hold this lock
 539          * first before grabbing res_lock.*/
 540         spinlock_t            l_lock;
 541
 542         /* ldlm_lock_change_resource() can change this */
 543         struct ldlm_resource *l_resource;
 544
 545         /* protected by ns_hash_lock. FIXME */
 546         struct list_head      l_lru;
 547
 548         /* protected by lr_lock, linkage to resource's lock queues */
 549         struct list_head      l_res_link;
 550
 551         struct ldlm_interval *l_tree_node;      /* tree node for ldlm_extent */
 552
 553         /* protected by led_lock */
 554         struct list_head      l_export_chain; // per-export chain of locks
 555
 556         /* protected by lr_lock */
 557         ldlm_mode_t           l_req_mode;
 558         ldlm_mode_t           l_granted_mode;
 559
 560         ldlm_completion_callback l_completion_ast;
 561         ldlm_blocking_callback   l_blocking_ast;
 562         ldlm_glimpse_callback    l_glimpse_ast;
 563
 564         struct obd_export    *l_export;
 565         struct obd_export    *l_conn_export;
 566
 567         struct lustre_handle  l_remote_handle;
 568         ldlm_policy_data_t    l_policy_data;
 569
 570         /* protected by lr_lock */
 571         __u32                 l_flags;
 572         __u32                 l_readers;
 573         __u32                 l_writers;
 574         __u8                  l_destroyed;
 575
 576         /* If the lock is granted, a process sleeps on this waitq to learn when
 577          * it's no longer in use.  If the lock is not granted, a process sleeps
 578          * on this waitq to learn when it becomes granted. */
 579         cfs_waitq_t           l_waitq;
 580         struct timeval        l_enqueued_time;
 581
 582         cfs_time_t            l_last_used;      /* jiffies */
 583         struct ldlm_extent    l_req_extent;
 584
 585         /* Client-side-only members */
 586         __u32                 l_lvb_len;        /* temporary storage for */
 587         void                 *l_lvb_data;       /* an LVB received during */
 588         void                 *l_lvb_swabber;    /* an enqueue */
 589         void                 *l_ast_data;
 590         spinlock_t            l_extents_list_lock;
 591         struct list_head      l_extents_list;
 592
 593         struct list_head      l_cache_locks_list;
 594
 595         /* Server-side-only members */
 596
 597         /* protected by elt_lock */
 598         struct list_head      l_pending_chain;  /* callbacks pending */
 599         cfs_time_t            l_callback_timeout; /* jiffies */
 600
 601         __u32                 l_pid;            /* pid which created this lock */
 602
 603         /* for ldlm_add_ast_work_item() */
 604         struct list_head      l_bl_ast;
 605         struct list_head      l_cp_ast;
 606         struct ldlm_lock     *l_blocking_lock;
 607         int                   l_bl_ast_run;
 608
 609         /* protected by lr_lock, linkages to "skip lists" */
 610         struct list_head      l_sl_mode;
 611         struct list_head      l_sl_policy;
 612 };
 613
 614 struct ldlm_resource {
 615         struct ldlm_namespace *lr_namespace;
 616
 617         /* protected by ns_hash_lock */
 618         struct list_head       lr_hash;
 619         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 620         struct list_head       lr_children; /* list head for child resources */
 621         struct list_head       lr_childof;  /* part of ns_root_list if root res,
 622                                              * part of lr_children if child */
 623         spinlock_t             lr_lock;
 624
 625         /* protected by lr_lock */
 626         struct list_head       lr_granted;
 627         struct list_head       lr_converting;
 628         struct list_head       lr_waiting;
 629         ldlm_mode_t            lr_most_restr;
 630         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 631         struct ldlm_res_id     lr_name;
 632         atomic_t               lr_refcount;
 633
 634         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
 635
 636         /* Server-side-only lock value block elements */
 637         struct semaphore       lr_lvb_sem;
 638         __u32                  lr_lvb_len;
 639         void                  *lr_lvb_data;
 640
 641         /* when the resource was considered as contended */
 642         cfs_time_t             lr_contention_time;
 643 };
 644
 645 struct ldlm_ast_work {
 646         struct ldlm_lock *w_lock;
 647         int               w_blocking;
 648         struct ldlm_lock_desc w_desc;
 649         struct list_head   w_list;
 650         int w_flags;
 651         void *w_data;
 652         int w_datalen;
 653 };
 654
 655 /* ldlm_enqueue parameters common */
 656 struct ldlm_enqueue_info {
 657         __u32 ei_type;   /* Type of the lock being enqueued. */
 658         __u32 ei_mode;   /* Mode of the lock being enqueued. */
 659         void *ei_cb_bl;  /* blocking lock callback */
 660         void *ei_cb_cp;  /* lock completion callback */
 661         void *ei_cb_gl;  /* lock glimpse callback */
 662         void *ei_cbdata; /* Data to be passed into callbacks. */
 663 };
 664
 665 extern struct obd_ops ldlm_obd_ops;
 666
 667 extern char *ldlm_lockname[];
 668 extern char *ldlm_typename[];
 669 extern char *ldlm_it2str(int it);
 670 #ifdef LIBCFS_DEBUG
 671 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
 672         CHECK_STACK();                                                  \
 673                                                                         \
 674         if (((level) & D_CANTMASK) != 0 ||                              \
 675             ((libcfs_debug & (level)) != 0 &&                           \
 676              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
 677                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
 678                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
 679                                     file, func, line);                  \
 680                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
 681                                  ##a );                                 \
 682         }                                                               \
 683 } while(0)
 684
 685 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
 686                       struct libcfs_debug_msg_data *data, const char *fmt,
 687                       ...)
 688         __attribute__ ((format (printf, 4, 5)));
 689
 690 #define LDLM_ERROR(lock, fmt, a...) do {                                \
 691         static cfs_debug_limit_state_t _ldlm_cdls;                      \
 692         ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock,                     \
 693                         __FILE__, __FUNCTION__, __LINE__,               \
 694                         "### " fmt , ##a);                              \
 695 } while (0)
 696
 697 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
 698         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
 699                         __FILE__, __FUNCTION__, __LINE__,               \
 700                          "### " fmt , ##a);                             \
 701 } while (0)
 702 #else
 703 #define LDLM_DEBUG(lock, fmt, a...) ((void)0)
 704 #define LDLM_ERROR(lock, fmt, a...) ((void)0)
 705 #endif
 706
 707 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 708         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
 709
 710 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 711                                       int first_enq, ldlm_error_t *err,
 712                                       struct list_head *work_list);
 713
 714 /*
 715  * Iterators.
 716  */
 717
 718 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 719 #define LDLM_ITER_STOP     2 /* stop iterating */
 720
 721 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 722 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 723
 724 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 725                           void *closure);
 726 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 727                            void *closure);
 728 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
 729                                ldlm_res_iterator_t iter, void *closure);
 730
 731 int ldlm_replay_locks(struct obd_import *imp);
 732 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
 733                            ldlm_iterator_t iter, void *data);
 734
 735 /* ldlm_flock.c */
 736 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 737
 738 /* ldlm_extent.c */
 739 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 740
 741
 742 /* ldlm_lockd.c */
 743 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 744                              void *data, int flag);
 745 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 746 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 747 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 748                         ldlm_blocking_callback, ldlm_glimpse_callback);
 749 int ldlm_handle_convert(struct ptlrpc_request *req);
 750 int ldlm_handle_cancel(struct ptlrpc_request *req);
 751 int ldlm_request_cancel(struct ptlrpc_request *req,
 752                         const struct ldlm_request *dlm_req, int first);
 753 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
 754 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
 755 void ldlm_revoke_export_locks(struct obd_export *exp);
 756 int ldlm_get_ref(void);
 757 void ldlm_put_ref(void);
 758
 759 /* ldlm_lock.c */
 760 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
 761 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
 762 void ldlm_lock2handle(const struct ldlm_lock *lock,
 763                       struct lustre_handle *lockh);
 764 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
 765 void ldlm_cancel_callback(struct ldlm_lock *);
 766 int ldlm_lock_set_data(struct lustre_handle *, void *data);
 767 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
 768 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
 769                                       const struct lustre_handle *);
 770
 771 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
 772 {
 773         return __ldlm_handle2lock(h, 0);
 774 }
 775
 776 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
 777                                        struct lustre_msg *m, int buf_idx,
 778                                        int increase)
 779 {
 780         if (res->lr_namespace->ns_lvbo &&
 781             res->lr_namespace->ns_lvbo->lvbo_update) {
 782                 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
 783                                                                increase);
 784         }
 785         return 0;
 786 }
 787
 788 #define LDLM_LOCK_PUT(lock)                     \
 789 do {                                            \
 790         /*LDLM_DEBUG((lock), "put");*/          \
 791         ldlm_lock_put(lock);                    \
 792 } while (0)
 793
 794 #define LDLM_LOCK_GET(lock)                     \
 795 ({                                              \
 796         ldlm_lock_get(lock);                    \
 797         /*LDLM_DEBUG((lock), "get");*/          \
 798         lock;                                   \
 799 })
 800
 801 #define ldlm_lock_list_put(head, member, count)                 \
 802 ({                                                              \
 803         struct ldlm_lock *_lock, *_next;                        \
 804         int c = count;                                          \
 805         list_for_each_entry_safe(_lock, _next, head, member) {  \
 806                 if (c-- == 0)                                   \
 807                         break;                                  \
 808                 list_del_init(&_lock->member);                  \
 809                 LDLM_LOCK_PUT(_lock);                           \
 810         }                                                       \
 811         LASSERT(c <= 0);                                        \
 812 })
 813
 814 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
 815 void ldlm_lock_put(struct ldlm_lock *lock);
 816 void ldlm_lock_destroy(struct ldlm_lock *lock);
 817 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
 818 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
 819 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
 820 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
 821 void ldlm_lock_allow_match(struct ldlm_lock *lock);
 822 int ldlm_lock_fast_match(struct ldlm_lock *, int, obd_off, obd_off, void **);
 823 void ldlm_lock_fast_release(void *, int);
 824 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
 825                             const struct ldlm_res_id *, ldlm_type_t type,
 826                             ldlm_policy_data_t *, ldlm_mode_t mode,
 827                             struct lustre_handle *);
 828 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
 829                                         __u32 *flags);
 830 void ldlm_lock_cancel(struct ldlm_lock *lock);
 831 void ldlm_cancel_locks_for_export(struct obd_export *export);
 832 void ldlm_reprocess_all(struct ldlm_resource *res);
 833 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
 834 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
 835 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
 836 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
 837
 838 /* resource.c */
 839 struct ldlm_namespace *
 840 ldlm_namespace_new(struct obd_device *obd, char *name,
 841                    ldlm_side_t client, ldlm_appetite_t apt);
 842 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
 843 void ldlm_namespace_free(struct ldlm_namespace *ns,
 844                          struct obd_import *imp, int force);
 845 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
 846 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
 847 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
 848 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
 849 void ldlm_namespace_get_locked(struct ldlm_namespace *ns);
 850 void ldlm_namespace_put_locked(struct ldlm_namespace *ns, int wakeup);
 851 void ldlm_namespace_get(struct ldlm_namespace *ns);
 852 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
 853 int ldlm_proc_setup(void);
 854 #ifdef LPROCFS
 855 void ldlm_proc_cleanup(void);
 856 #else
 857 static inline void ldlm_proc_cleanup(void) {}
 858 #endif
 859
 860 /* resource.c - internal */
 861 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
 862                                         struct ldlm_resource *parent,
 863                                         const struct ldlm_res_id *,
 864                                         ldlm_type_t type, int create);
 865 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
 866 int ldlm_resource_putref(struct ldlm_resource *res);
 867 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
 868                             struct ldlm_lock *lock);
 869 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
 870 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
 871 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
 872 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
 873 void ldlm_resource_dump(int level, struct ldlm_resource *);
 874 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
 875                               const struct ldlm_res_id *);
 876
 877 struct ldlm_callback_suite {
 878         ldlm_completion_callback lcs_completion;
 879         ldlm_blocking_callback   lcs_blocking;
 880         ldlm_glimpse_callback    lcs_glimpse;
 881 };
 882
 883 /* ldlm_request.c */
 884 int ldlm_expired_completion_wait(void *data);
 885 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 886                       void *data, int flag);
 887 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
 888 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 889 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
 890                      struct ldlm_enqueue_info *einfo,
 891                      const struct ldlm_res_id *res_id,
 892                      ldlm_policy_data_t *policy, int *flags,
 893                      void *lvb, __u32 lvb_len, void *lvb_swabber,
 894                      struct lustre_handle *lockh, int async);
 895 int ldlm_prep_enqueue_req(struct obd_export *exp,
 896                           struct ptlrpc_request *req,
 897                           struct list_head *cancels,
 898                           int count);
 899 int ldlm_prep_elc_req(struct obd_export *exp,
 900                       struct ptlrpc_request *req,
 901                       int version, int opc, int canceloff,
 902                       struct list_head *cancels, int count);
 903 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
 904                          const struct ldlm_request *dlm_req,
 905                          const struct ldlm_callback_suite *cbs);
 906 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
 907                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
 908                           int *flags, void *lvb, __u32 lvb_len,
 909                           void *lvb_swabber, struct lustre_handle *lockh,
 910                           int rc);
 911 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
 912                            const struct ldlm_res_id *res_id,
 913                            ldlm_type_t type, ldlm_policy_data_t *policy,
 914                            ldlm_mode_t mode, int *flags,
 915                            ldlm_blocking_callback blocking,
 916                            ldlm_completion_callback completion,
 917                            ldlm_glimpse_callback glimpse,
 918                            void *data, __u32 lvb_len, void *lvb_swabber,
 919                            struct lustre_handle *lockh);
 920 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
 921                     void *data, __u32 data_len);
 922 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
 923 int ldlm_cli_update_pool(struct ptlrpc_request *req);
 924 int ldlm_handle_convert0(struct ptlrpc_request *req,
 925                          const struct ldlm_request *dlm_req);
 926 int ldlm_cli_cancel(struct lustre_handle *lockh);
 927 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
 928                            int flags, void *opaque);
 929 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
 930                                     const struct ldlm_res_id *res_id,
 931                                     ldlm_policy_data_t *policy,
 932                                     ldlm_mode_t mode, int flags, void *opaque);
 933 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
 934                         int count, int flags);
 935 int ldlm_cli_join_lru(struct ldlm_namespace *,
 936                       const struct ldlm_res_id *, int join);
 937 int ldlm_cancel_resource_local(struct ldlm_resource *res,
 938                                struct list_head *cancels,
 939                                ldlm_policy_data_t *policy,
 940                                ldlm_mode_t mode, int lock_flags,
 941                                int cancel_flags, void *opaque);
 942 int ldlm_cli_cancel_list(struct list_head *head, int count,
 943                          struct ptlrpc_request *req, int flags);
 944
 945 /* mds/handler.c */
 946 /* This has to be here because recursive inclusion sucks. */
 947 int intent_disposition(struct ldlm_reply *rep, int flag);
 948 void intent_set_disposition(struct ldlm_reply *rep, int flag);
 949
 950
 951 /* ioctls for trying requests */
 952 #define IOC_LDLM_TYPE                   'f'
 953 #define IOC_LDLM_MIN_NR                 40
 954
 955 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
 956 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
 957 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
 958 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
 959 #define IOC_LDLM_MAX_NR                 43
 960
 961 static inline void lock_res(struct ldlm_resource *res)
 962 {
 963         spin_lock(&res->lr_lock);
 964 }
 965
 966 static inline void unlock_res(struct ldlm_resource *res)
 967 {
 968         spin_unlock(&res->lr_lock);
 969 }
 970
 971 static inline void check_res_locked(struct ldlm_resource *res)
 972 {
 973         LASSERT_SPIN_LOCKED(&res->lr_lock);
 974 }
 975
 976 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
 977 void unlock_res_and_lock(struct ldlm_lock *lock);
 978
 979 /* ldlm_pool.c */
 980 void ldlm_pools_recalc(ldlm_side_t client);
 981 int ldlm_pools_init(void);
 982 void ldlm_pools_fini(void);
 983 void ldlm_pools_wakeup(void);
 984
 985 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
 986                    int idx, ldlm_side_t client);
 987 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
 988                      unsigned int gfp_mask);
 989 void ldlm_pool_fini(struct ldlm_pool *pl);
 990 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
 991 int ldlm_pool_recalc(struct ldlm_pool *pl);
 992 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
 993 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
 994 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
 995 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
 996 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
 997 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
 998 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
 999 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1000 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1001 #endif