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
  25 struct obd_ops;
  26 struct obd_device;
  27
  28 #define OBD_LDLM_DEVICENAME  "ldlm"
  29
  30 #define LDLM_DEFAULT_LRU_SIZE (100 * smp_num_cpus)
  31 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
  32
  33 typedef enum {
  34         ELDLM_OK = 0,
  35
  36         ELDLM_LOCK_CHANGED = 300,
  37         ELDLM_LOCK_ABORTED = 301,
  38         ELDLM_LOCK_REPLACED = 302,
  39         ELDLM_NO_LOCK_DATA = 303,
  40
  41         ELDLM_NAMESPACE_EXISTS = 400,
  42         ELDLM_BAD_NAMESPACE    = 401
  43 } ldlm_error_t;
  44
  45 #define LDLM_NAMESPACE_SERVER 0
  46 #define LDLM_NAMESPACE_CLIENT 1
  47
  48 #define LDLM_FL_LOCK_CHANGED   0x000001 /* extent, mode, or resource changed */
  49
  50 /* If the server returns one of these flags, then the lock was put on that list.
  51  * If the client sends one of these flags (during recovery ONLY!), it wants the
  52  * lock added to the specified list, no questions asked. -p */
  53 #define LDLM_FL_BLOCK_GRANTED  0x000002
  54 #define LDLM_FL_BLOCK_CONV     0x000004
  55 #define LDLM_FL_BLOCK_WAIT     0x000008
  56
  57 #define LDLM_FL_CBPENDING      0x000010 /* this lock is being destroyed */
  58 #define LDLM_FL_AST_SENT       0x000020 /* blocking or cancel packet was sent */
  59 #define LDLM_FL_WAIT_NOREPROC  0x000040 /* not a real flag, not saved in lock */
  60 #define LDLM_FL_CANCEL         0x000080 /* cancellation callback already run */
  61
  62 /* Lock is being replayed.  This could probably be implied by the fact that one
  63  * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
  64 #define LDLM_FL_REPLAY         0x000100
  65
  66 #define LDLM_FL_INTENT_ONLY    0x000200 /* don't grant lock, just do intent */
  67 #define LDLM_FL_LOCAL_ONLY     0x000400 /* see ldlm_cli_cancel_unused */
  68
  69 /* don't run the cancel callback under ldlm_cli_cancel_unused */
  70 #define LDLM_FL_FAILED         0x000800
  71
  72 #define LDLM_FL_HAS_INTENT     0x001000 /* lock request has intent */
  73 #define LDLM_FL_CANCELING      0x002000 /* lock cancel has already been sent */
  74 #define LDLM_FL_LOCAL          0x004000 /* local lock (ie, no srv/cli split) */
  75 #define LDLM_FL_WARN           0x008000 /* see ldlm_cli_cancel_unused */
  76 #define LDLM_FL_DISCARD_DATA   0x010000 /* discard (no writeback) on cancel */
  77
  78 #define LDLM_FL_NO_TIMEOUT     0x020000 /* Blocked by group lock - wait
  79                                          * indefinitely */
  80
  81 /* file & record locking */
  82 #define LDLM_FL_BLOCK_NOWAIT   0x040000 // server told not to wait if blocked
  83 #define LDLM_FL_TEST_LOCK      0x080000 // return blocking lock
  84
  85 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
  86  * the LVB filling happens _after_ the lock has been granted, so another thread
  87  * can match`t before the LVB has been updated.  As a dirty hack, we set
  88  * LDLM_FL_LVB_READY only after we've done the LVB poop.
  89  * this is only needed on lov/osc now, where lvb is actually used and callers
  90  * must set it in input flags.
  91  *
  92  * The proper fix is to do the granting inside of the completion AST, which can
  93  * be replaced with a LVB-aware wrapping function for OSC locks.  That change is
  94  * pretty high-risk, though, and would need a lot more testing. */
  95
  96 #define LDLM_FL_LVB_READY      0x100000
  97
  98 /* A lock contributes to the kms calculation until it has finished the part
  99  * of it's cancelation that performs write back on its dirty pages.  It
 100  * can remain on the granted list during this whole time.  Threads racing
 101  * to update the kms after performing their writeback need to know to
 102  * exclude each others locks from the calculation as they walk the granted
 103  * list. */
 104 #define LDLM_FL_KMS_IGNORE     0x200000
 105
 106 /* Don't drop lock covering mmapped file in LRU */
 107 #define LDLM_FL_NO_LRU         0x400000
 108
 109 /* Immediatelly cancel such locks when they block some other locks. Send
 110    cancel notification to original lock holder, but expect no reply. */
 111 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
 112
 113 /* Flags flags inherited from parent lock when doing intents. */
 114 #define LDLM_INHERIT_FLAGS     (LDLM_FL_CANCEL_ON_BLOCK)
 115
 116 /* These are flags that are mapped into the flags and ASTs of blocking locks */
 117 #define LDLM_AST_DISCARD_DATA  0x80000000 /* Add FL_DISCARD to blocking ASTs */
 118 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
 119 #define LDLM_AST_FLAGS         (LDLM_FL_DISCARD_DATA)
 120
 121 /* completion ast to be executed */
 122 #define LDLM_FL_CP_REQD        0x1000000
 123
 124 /* cleanup_resource has already handled the lock */
 125 #define LDLM_FL_CLEANED        0x2000000
 126
 127 /* optimization hint: LDLM can run blocking callback from current context
 128  * w/o involving separate thread. in order to decrease cs rate */
 129 #define LDLM_FL_ATOMIC_CB      0x4000000
 130
 131 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
 132  * such that server send blocking ast for conflict locks to this client for
 133  * the 1st operation, whereas the 2nd operation has canceled this lock and
 134  * is waiting for rpc_lock which is taken by the 1st operation.
 135  * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
 136  * ELC code to cancel it.
 137  * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
 138  * droped to let ldlm_callback_handler() return EINVAL to the server. It is
 139  * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
 140  * to send a separate CANCEL rpc. */
 141 #define LDLM_FL_BL_AST          0x10000000
 142 #define LDLM_FL_BL_DONE         0x20000000
 143
 144 /* Cancel lock asynchronously. See ldlm_cli_cancel_unused_resource. */
 145 #define LDLM_FL_ASYNC           0x40000000
 146
 147 /* The blocking callback is overloaded to perform two functions.  These flags
 148  * indicate which operation should be performed. */
 149 #define LDLM_CB_BLOCKING    1
 150 #define LDLM_CB_CANCELING   2
 151
 152 /* position flag of skip list pointers */
 153 #define LDLM_SL_HEAD(skip_list)   ((skip_list)->next != NULL)
 154 #define LDLM_SL_TAIL(skip_list)   ((skip_list)->prev != NULL)
 155 #define LDLM_SL_EMPTY(skip_list)  ((skip_list)->next == NULL && \
 156                                    (skip_list)->prev == NULL)
 157
 158 /* compatibility matrix */
 159 #define LCK_COMPAT_EX  LCK_NL
 160 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
 161 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
 162 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
 163 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
 164 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
 165 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
 166
 167 extern ldlm_mode_t lck_compat_array[];
 168
 169 static inline void lockmode_verify(ldlm_mode_t mode)
 170 {
 171        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
 172 }
 173
 174 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
 175 {
 176        return (lck_compat_array[exist] & new);
 177 }
 178
 179 /*
 180  *
 181  * cluster name spaces
 182  *
 183  */
 184
 185 #define DLM_OST_NAMESPACE 1
 186 #define DLM_MDS_NAMESPACE 2
 187
 188 /* XXX
 189    - do we just separate this by security domains and use a prefix for
 190      multiple namespaces in the same domain?
 191    -
 192 */
 193
 194 /*
 195  * Locking rules:
 196  *
 197  * lr_lock
 198  *
 199  * lr_lock
 200  *     waiting_locks_spinlock
 201  *
 202  * lr_lock
 203  *     led_lock
 204  *
 205  * lr_lock
 206  *     ns_unused_lock
 207  *
 208  * lr_lvb_sem
 209  *     lr_lock
 210  *
 211  */
 212
 213 struct ldlm_lock;
 214 struct ldlm_resource;
 215 struct ldlm_namespace;
 216
 217 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
 218                                void *req_cookie, ldlm_mode_t mode, int flags,
 219                                void *data);
 220
 221 struct ldlm_valblock_ops {
 222         int (*lvbo_init)(struct ldlm_resource *res);
 223         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
 224                            int buf_idx, int increase);
 225 };
 226
 227 struct ldlm_namespace {
 228         char                  *ns_name;
 229         __u32                  ns_client; /* is this a client-side lock tree? */
 230         struct list_head      *ns_hash; /* hash table for ns */
 231         spinlock_t             ns_hash_lock;
 232         __u32                  ns_refcount; /* count of resources in the hash */
 233         struct list_head       ns_root_list; /* all root resources in ns */
 234         struct list_head       ns_list_chain; /* position in global NS list */
 235
 236         struct list_head       ns_unused_list; /* all root resources in ns */
 237         int                    ns_nr_unused;
 238         spinlock_t             ns_unused_lock;
 239
 240         unsigned int           ns_max_unused;
 241         unsigned int           ns_max_age;
 242         cfs_time_t             ns_next_dump;   /* next debug dump, jiffies */
 243
 244         atomic_t               ns_locks;
 245         __u64                  ns_resources;
 246         ldlm_res_policy        ns_policy;
 247         struct ldlm_valblock_ops *ns_lvbo;
 248         void                  *ns_lvbp;
 249         cfs_waitq_t            ns_waitq;
 250 };
 251
 252 /*
 253  *
 254  * Resource hash table
 255  *
 256  */
 257
 258 #define RES_HASH_BITS 10
 259 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 260 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 261
 262 struct ldlm_lock;
 263
 264 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 265                                       struct ldlm_lock_desc *new, void *data,
 266                                       int flag);
 267 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
 268                                         void *data);
 269 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
 270
 271 struct ldlm_lock {
 272         struct portals_handle l_handle; // must be first in the structure
 273         atomic_t              l_refc;
 274
 275         /* internal spinlock protects l_resource.  we should hold this lock
 276          * first before grabbing res_lock.*/
 277         spinlock_t            l_lock;
 278
 279         /* ldlm_lock_change_resource() can change this */
 280         struct ldlm_resource *l_resource;
 281
 282         /* protected by ns_hash_lock. FIXME */
 283         struct list_head      l_lru;
 284
 285         /* protected by lr_lock */
 286         struct list_head      l_res_link; // position in one of three res lists
 287
 288         struct list_head      l_sl_mode;        // skip pointer for request mode
 289         struct list_head      l_sl_policy;      // skip pointer for inodebits
 290
 291         /* protected by led_lock */
 292         struct list_head      l_export_chain; // per-export chain of locks
 293
 294         /* protected by lr_lock */
 295         ldlm_mode_t           l_req_mode;
 296         ldlm_mode_t           l_granted_mode;
 297
 298         ldlm_completion_callback l_completion_ast;
 299         ldlm_blocking_callback   l_blocking_ast;
 300         ldlm_glimpse_callback    l_glimpse_ast;
 301
 302         struct obd_export    *l_export;
 303         struct obd_export    *l_conn_export;
 304
 305         struct lustre_handle  l_remote_handle;
 306         ldlm_policy_data_t    l_policy_data;
 307
 308         /* protected by lr_lock */
 309         __u32                 l_flags;
 310         __u32                 l_readers;
 311         __u32                 l_writers;
 312         __u8                  l_destroyed;
 313
 314         /* If the lock is granted, a process sleeps on this waitq to learn when
 315          * it's no longer in use.  If the lock is not granted, a process sleeps
 316          * on this waitq to learn when it becomes granted. */
 317         cfs_waitq_t           l_waitq;
 318         struct timeval        l_enqueued_time;
 319
 320         cfs_time_t            l_last_used;      /* jiffies */
 321         struct ldlm_extent    l_req_extent;
 322
 323         /* Client-side-only members */
 324         __u32                 l_lvb_len;        /* temporary storage for */
 325         void                 *l_lvb_data;       /* an LVB received during */
 326         void                 *l_lvb_swabber;    /* an enqueue */
 327         void                 *l_ast_data;
 328
 329         /* Server-side-only members */
 330
 331         /* protected by elt_lock */
 332         struct list_head      l_pending_chain;  /* callbacks pending */
 333         cfs_time_t            l_callback_timeout; /* jiffies */
 334
 335         __u32                 l_pid;            /* pid which created this lock */
 336
 337         /* for ldlm_add_ast_work_item() */
 338         struct list_head      l_bl_ast;
 339         struct list_head      l_cp_ast;
 340         struct ldlm_lock     *l_blocking_lock;
 341         int                   l_bl_ast_run;
 342 };
 343
 344 struct ldlm_resource {
 345         struct ldlm_namespace *lr_namespace;
 346
 347         /* protected by ns_hash_lock */
 348         struct list_head       lr_hash;
 349         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 350         struct list_head       lr_children; /* list head for child resources */
 351         struct list_head       lr_childof;  /* part of ns_root_list if root res,
 352                                              * part of lr_children if child */
 353         spinlock_t             lr_lock;
 354
 355         /* protected by lr_lock */
 356         struct list_head       lr_granted;
 357         struct list_head       lr_converting;
 358         struct list_head       lr_waiting;
 359         ldlm_mode_t            lr_most_restr;
 360         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 361         struct ldlm_res_id     lr_name;
 362         atomic_t               lr_refcount;
 363
 364         /* Server-side-only lock value block elements */
 365         struct semaphore       lr_lvb_sem;
 366         __u32                  lr_lvb_len;
 367         void                  *lr_lvb_data;
 368 };
 369
 370 struct ldlm_ast_work {
 371         struct ldlm_lock *w_lock;
 372         int               w_blocking;
 373         struct ldlm_lock_desc w_desc;
 374         struct list_head   w_list;
 375         int w_flags;
 376         void *w_data;
 377         int w_datalen;
 378 };
 379
 380 /* ldlm_enqueue parameters common */
 381 struct ldlm_enqueue_info {
 382         __u32 ei_type;   /* Type of the lock being enqueued. */
 383         __u32 ei_mode;   /* Mode of the lock being enqueued. */
 384         void *ei_cb_bl;  /* Different callbacks for lock handling (blocking, */
 385         void *ei_cb_cp;  /* completion, glimpse) */
 386         void *ei_cb_gl;
 387         void *ei_cbdata; /* Data to be passed into callbacks. */
 388 };
 389
 390 extern struct obd_ops ldlm_obd_ops;
 391
 392 extern char *ldlm_lockname[];
 393 extern char *ldlm_typename[];
 394 extern char *ldlm_it2str(int it);
 395 #ifdef LIBCFS_DEBUG
 396 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
 397         CHECK_STACK();                                                  \
 398                                                                         \
 399         if (((level) & D_CANTMASK) != 0 ||                              \
 400             ((libcfs_debug & (level)) != 0 &&                           \
 401              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
 402                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
 403                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
 404                                     file, func, line);                  \
 405                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
 406                                  ##a );                                 \
 407         }                                                               \
 408 } while(0)
 409
 410 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
 411                       struct libcfs_debug_msg_data *data, const char *fmt,
 412                       ...)
 413         __attribute__ ((format (printf, 4, 5)));
 414
 415 #define LDLM_ERROR(lock, fmt, a...) do {                                \
 416         static cfs_debug_limit_state_t _ldlm_cdls;                      \
 417         ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock,                     \
 418                         __FILE__, __FUNCTION__, __LINE__,               \
 419                         "### " fmt , ##a);                              \
 420 } while (0)
 421
 422 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
 423         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
 424                         __FILE__, __FUNCTION__, __LINE__,               \
 425                          "### " fmt , ##a);                             \
 426 } while (0)
 427 #else
 428 #define LDLM_DEBUG(lock, fmt, a...) ((void)0)
 429 #define LDLM_ERROR(lock, fmt, a...) ((void)0)
 430 #endif
 431
 432 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 433         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
 434
 435 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 436                                       int first_enq, ldlm_error_t *err,
 437                                       struct list_head *work_list);
 438
 439 /*
 440  * Iterators.
 441  */
 442
 443 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 444 #define LDLM_ITER_STOP     2 /* stop iterating */
 445
 446 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 447 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 448
 449 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 450                           void *closure);
 451 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 452                            void *closure);
 453 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
 454                                ldlm_res_iterator_t iter, void *closure);
 455
 456 int ldlm_replay_locks(struct obd_import *imp);
 457 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
 458                            ldlm_iterator_t iter, void *data);
 459
 460 /* ldlm_flock.c */
 461 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 462
 463 /* ldlm_extent.c */
 464 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 465
 466
 467 /* ldlm_lockd.c */
 468 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 469                              void *data, int flag);
 470 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 471 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 472 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 473                         ldlm_blocking_callback, ldlm_glimpse_callback);
 474 int ldlm_handle_convert(struct ptlrpc_request *req);
 475 int ldlm_handle_cancel(struct ptlrpc_request *req);
 476 int ldlm_request_cancel(struct ptlrpc_request *req,
 477                         const struct ldlm_request *dlm_req, int first);
 478 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
 479 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
 480 void ldlm_revoke_export_locks(struct obd_export *exp);
 481 int ldlm_get_ref(void);
 482 void ldlm_put_ref(int force);
 483
 484 /* ldlm_lock.c */
 485 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
 486 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
 487 void ldlm_lock2handle(const struct ldlm_lock *lock,
 488                       struct lustre_handle *lockh);
 489 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
 490 void ldlm_cancel_callback(struct ldlm_lock *);
 491 int ldlm_lock_set_data(struct lustre_handle *, void *data);
 492 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
 493 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
 494                                       const struct lustre_handle *);
 495
 496 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
 497 {
 498         return __ldlm_handle2lock(h, 0);
 499 }
 500
 501 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
 502                                        struct lustre_msg *m, int buf_idx,
 503                                        int increase)
 504 {
 505         if (res->lr_namespace->ns_lvbo &&
 506             res->lr_namespace->ns_lvbo->lvbo_update) {
 507                 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
 508                                                                increase);
 509         }
 510         return 0;
 511 }
 512
 513 #define LDLM_LOCK_PUT(lock)                     \
 514 do {                                            \
 515         /*LDLM_DEBUG((lock), "put");*/          \
 516         ldlm_lock_put(lock);                    \
 517 } while (0)
 518
 519 #define LDLM_LOCK_GET(lock)                     \
 520 ({                                              \
 521         ldlm_lock_get(lock);                    \
 522         /*LDLM_DEBUG((lock), "get");*/          \
 523         lock;                                   \
 524 })
 525
 526 #define ldlm_lock_list_put(head, member, count)                 \
 527 ({                                                              \
 528         struct ldlm_lock *_lock, *_next;                        \
 529         int c = count;                                          \
 530         list_for_each_entry_safe(_lock, _next, head, member) {  \
 531                 list_del_init(&_lock->member);                  \
 532                 LDLM_LOCK_PUT(_lock);                           \
 533                 if (--c == 0)                                   \
 534                         break;                                  \
 535         }                                                       \
 536 })
 537
 538 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
 539 void ldlm_lock_put(struct ldlm_lock *lock);
 540 void ldlm_lock_destroy(struct ldlm_lock *lock);
 541 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
 542 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
 543 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
 544 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
 545 void ldlm_lock_allow_match(struct ldlm_lock *lock);
 546 int ldlm_lock_match(struct ldlm_namespace *ns, int flags,
 547                     const struct ldlm_res_id *,
 548                     ldlm_type_t type, ldlm_policy_data_t *, ldlm_mode_t mode,
 549                     struct lustre_handle *);
 550 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
 551                                         int *flags);
 552 void ldlm_lock_cancel(struct ldlm_lock *lock);
 553 void ldlm_cancel_locks_for_export(struct obd_export *export);
 554 void ldlm_reprocess_all(struct ldlm_resource *res);
 555 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
 556 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
 557 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
 558 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
 559
 560 /* resource.c */
 561 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
 562 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
 563 int ldlm_namespace_free(struct ldlm_namespace *ns, int force);
 564 int ldlm_proc_setup(void);
 565 #ifdef LPROCFS
 566 void ldlm_proc_cleanup(void);
 567 #else
 568 static inline void ldlm_proc_cleanup(void) {}
 569 #endif
 570
 571 /* resource.c - internal */
 572 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
 573                                         struct ldlm_resource *parent,
 574                                         const struct ldlm_res_id *,
 575                                         ldlm_type_t type, int create);
 576 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
 577 int ldlm_resource_putref(struct ldlm_resource *res);
 578 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
 579                             struct ldlm_lock *lock);
 580 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
 581 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
 582 void ldlm_dump_all_namespaces(int level);
 583 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
 584 void ldlm_resource_dump(int level, struct ldlm_resource *);
 585 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
 586                               const struct ldlm_res_id *);
 587
 588 struct ldlm_callback_suite {
 589         ldlm_completion_callback lcs_completion;
 590         ldlm_blocking_callback   lcs_blocking;
 591         ldlm_glimpse_callback    lcs_glimpse;
 592 };
 593
 594 /* ldlm_request.c */
 595 int ldlm_expired_completion_wait(void *data);
 596 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 597                       void *data, int flag);
 598 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
 599 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 600 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
 601                      struct ldlm_enqueue_info *einfo,
 602                      const struct ldlm_res_id *res_id,
 603                      ldlm_policy_data_t *policy, int *flags,
 604                      void *lvb, __u32 lvb_len, void *lvb_swabber,
 605                      struct lustre_handle *lockh, int async);
 606 struct ptlrpc_request *ldlm_prep_enqueue_req(struct obd_export *exp,
 607                                              int bufcount, int *size,
 608                                              struct list_head *head, int count);
 609 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
 610                          const struct ldlm_request *dlm_req,
 611                          const struct ldlm_callback_suite *cbs);
 612 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
 613                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
 614                           int *flags, void *lvb, __u32 lvb_len,
 615                           void *lvb_swabber, struct lustre_handle *lockh,
 616                           int rc);
 617 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
 618                            const struct ldlm_res_id *res_id,
 619                            ldlm_type_t type, ldlm_policy_data_t *policy,
 620                            ldlm_mode_t mode, int *flags,
 621                            ldlm_blocking_callback blocking,
 622                            ldlm_completion_callback completion,
 623                            ldlm_glimpse_callback glimpse,
 624                            void *data, __u32 lvb_len, void *lvb_swabber,
 625                            struct lustre_handle *lockh);
 626 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
 627                     void *data, __u32 data_len);
 628 int ldlm_cli_convert(struct lustre_handle *, int new_mode, int *flags);
 629 int ldlm_handle_convert0(struct ptlrpc_request *req,
 630                          const struct ldlm_request *dlm_req);
 631 int ldlm_cli_cancel(struct lustre_handle *lockh);
 632 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
 633                            int flags, void *opaque);
 634 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
 635                                     const struct ldlm_res_id *res_id,
 636                                     ldlm_policy_data_t *policy,
 637                                     ldlm_mode_t mode, int flags, void *opaque);
 638 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
 639                         int count, int flags);
 640 int ldlm_cli_join_lru(struct ldlm_namespace *,
 641                       const struct ldlm_res_id *, int join);
 642 int ldlm_cancel_resource_local(struct ldlm_resource *res,
 643                                struct list_head *cancels,
 644                                ldlm_policy_data_t *policy,
 645                                ldlm_mode_t mode, int lock_flags,
 646                                int flags, void *opaque);
 647 int ldlm_cli_cancel_list(struct list_head *head, int count,
 648                          struct ptlrpc_request *req, int off, int flags);
 649
 650 /* mds/handler.c */
 651 /* This has to be here because recursive inclusion sucks. */
 652 int intent_disposition(struct ldlm_reply *rep, int flag);
 653 void intent_set_disposition(struct ldlm_reply *rep, int flag);
 654
 655
 656 /* ioctls for trying requests */
 657 #define IOC_LDLM_TYPE                   'f'
 658 #define IOC_LDLM_MIN_NR                 40
 659
 660 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
 661 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
 662 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
 663 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
 664 #define IOC_LDLM_MAX_NR                 43
 665
 666 static inline void lock_res(struct ldlm_resource *res)
 667 {
 668         spin_lock(&res->lr_lock);
 669 }
 670
 671 static inline void unlock_res(struct ldlm_resource *res)
 672 {
 673         spin_unlock(&res->lr_lock);
 674 }
 675
 676 static inline void check_res_locked(struct ldlm_resource *res)
 677 {
 678         LASSERT_SPIN_LOCKED(&res->lr_lock);
 679 }
 680
 681 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
 682 void unlock_res_and_lock(struct ldlm_lock *lock);
 683
 684 #endif