lustre/include/lustre_dlm.h

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