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
  32 typedef enum {
  33         ELDLM_OK = 0,
  34
  35         ELDLM_LOCK_CHANGED = 300,
  36         ELDLM_LOCK_ABORTED = 301,
  37         ELDLM_LOCK_REPLACED = 302,
  38         ELDLM_NO_LOCK_DATA = 303,
  39
  40         ELDLM_NAMESPACE_EXISTS = 400,
  41         ELDLM_BAD_NAMESPACE    = 401
  42 } ldlm_error_t;
  43
  44 #define LDLM_NAMESPACE_SERVER 0
  45 #define LDLM_NAMESPACE_CLIENT 1
  46
  47 #define LDLM_FL_LOCK_CHANGED   0x000001 /* extent, mode, or resource changed */
  48
  49 /* If the server returns one of these flags, then the lock was put on that list.
  50  * If the client sends one of these flags (during recovery ONLY!), it wants the
  51  * lock added to the specified list, no questions asked. -p */
  52 #define LDLM_FL_BLOCK_GRANTED  0x000002
  53 #define LDLM_FL_BLOCK_CONV     0x000004
  54 #define LDLM_FL_BLOCK_WAIT     0x000008
  55
  56 #define LDLM_FL_CBPENDING      0x000010 /* this lock is being destroyed */
  57 #define LDLM_FL_AST_SENT       0x000020 /* blocking or cancel packet was sent */
  58 #define LDLM_FL_WAIT_NOREPROC  0x000040 /* not a real flag, not saved in lock */
  59 #define LDLM_FL_CANCEL         0x000080 /* cancellation callback already run */
  60
  61 /* Lock is being replayed.  This could probably be implied by the fact that one
  62  * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
  63 #define LDLM_FL_REPLAY         0x000100
  64
  65 #define LDLM_FL_INTENT_ONLY    0x000200 /* don't grant lock, just do intent */
  66 #define LDLM_FL_LOCAL_ONLY     0x000400 /* see ldlm_cli_cancel_unused */
  67
  68 /* don't run the cancel callback under ldlm_cli_cancel_unused */
  69 #define LDLM_FL_FAILED         0x000800
  70
  71 #define LDLM_FL_HAS_INTENT     0x001000 /* lock request has intent */
  72 #define LDLM_FL_CANCELING      0x002000 /* lock cancel has already been sent */
  73 #define LDLM_FL_LOCAL          0x004000 /* local lock (ie, no srv/cli split) */
  74 #define LDLM_FL_WARN           0x008000 /* see ldlm_cli_cancel_unused */
  75 #define LDLM_FL_DISCARD_DATA   0x010000 /* discard (no writeback) on cancel */
  76
  77 #define LDLM_FL_NO_TIMEOUT     0x020000 /* Blocked by group lock - wait
  78                                          * indefinitely */
  79
  80 /* file & record locking */
  81 #define LDLM_FL_BLOCK_NOWAIT   0x040000 // server told not to wait if blocked
  82 #define LDLM_FL_TEST_LOCK      0x080000 // return blocking lock
  83
  84 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
  85  * the LVB filling happens _after_ the lock has been granted, so another thread
  86  * can match before the LVB has been updated.  As a dirty hack, we set
  87  * LDLM_FL_CAN_MATCH only after we've done the LVB poop.
  88  *
  89  * The proper fix is to do the granting inside of the completion AST, which can
  90  * be replaced with a LVB-aware wrapping function for OSC locks.  That change is
  91  * pretty high-risk, though, and would need a lot more testing. */
  92 #define LDLM_FL_CAN_MATCH      0x100000
  93
  94 /* A lock contributes to the kms calculation until it has finished the part
  95  * of it's cancelation that performs write back on its dirty pages.  It
  96  * can remain on the granted list during this whole time.  Threads racing
  97  * to update the kms after performing their writeback need to know to
  98  * exclude each others locks from the calculation as they walk the granted
  99  * list. */
 100 #define LDLM_FL_KMS_IGNORE     0x200000
 101
 102 /* Don't drop lock covering mmapped file in LRU */
 103 #define LDLM_FL_NO_LRU         0x400000
 104
 105 /* Immediatelly cancel such locks when they block some other locks. Send
 106    cancel notification to original lock holder, but expect no reply. */
 107 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
 108
 109 /* Flags flags inherited from parent lock when doing intents. */
 110 #define LDLM_INHERIT_FLAGS     (LDLM_FL_CANCEL_ON_BLOCK)
 111
 112 /* These are flags that are mapped into the flags and ASTs of blocking locks */
 113 #define LDLM_AST_DISCARD_DATA  0x80000000 /* Add FL_DISCARD to blocking ASTs */
 114 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
 115 #define LDLM_AST_FLAGS         (LDLM_FL_DISCARD_DATA)
 116
 117 /* The blocking callback is overloaded to perform two functions.  These flags
 118  * indicate which operation should be performed. */
 119 #define LDLM_CB_BLOCKING    1
 120 #define LDLM_CB_CANCELING   2
 121
 122 /* compatibility matrix */
 123 #define LCK_COMPAT_EX  LCK_NL
 124 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
 125 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
 126 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
 127 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
 128 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX)
 129 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
 130
 131 extern ldlm_mode_t lck_compat_array[];
 132
 133 static inline void lockmode_verify(ldlm_mode_t mode)
 134 {
 135        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
 136 }
 137
 138 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
 139 {
 140        return (lck_compat_array[exist] & new);
 141 }
 142
 143 /*
 144  *
 145  * cluster name spaces
 146  *
 147  */
 148
 149 #define DLM_OST_NAMESPACE 1
 150 #define DLM_MDS_NAMESPACE 2
 151
 152 /* XXX
 153    - do we just separate this by security domains and use a prefix for
 154      multiple namespaces in the same domain?
 155    -
 156 */
 157
 158 struct ldlm_lock;
 159 struct ldlm_resource;
 160 struct ldlm_namespace;
 161
 162 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
 163                                void *req_cookie, ldlm_mode_t mode, int flags,
 164                                void *data);
 165
 166 struct ldlm_valblock_ops {
 167         int (*lvbo_init)(struct ldlm_resource *res);
 168         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
 169                            int buf_idx, int increase);
 170 };
 171
 172 struct ldlm_namespace {
 173         char                  *ns_name;
 174         __u32                  ns_client; /* is this a client-side lock tree? */
 175         struct list_head      *ns_hash; /* hash table for ns */
 176         cfs_waitq_t            ns_refcount_waitq; /* for cleanup */
 177         atomic_t               ns_refcount; /* count of resources in the hash */
 178         struct list_head       ns_root_list; /* all root resources in ns */
 179         struct lustre_lock     ns_lock; /* protects hash, refcount, list */
 180         struct list_head       ns_list_chain; /* position in global NS list */
 181
 182         struct list_head       ns_unused_list; /* all root resources in ns */
 183         int                    ns_nr_unused;
 184         unsigned int           ns_max_unused;
 185         cfs_time_t             ns_next_dump;   /* next debug dump, jiffies */
 186
 187         spinlock_t             ns_counter_lock;
 188         __u64                  ns_locks;
 189         ldlm_res_policy        ns_policy;
 190         struct ldlm_valblock_ops *ns_lvbo;
 191         void                    *ns_lvbp;
 192 };
 193
 194 /*
 195  *
 196  * Resource hash table
 197  *
 198  */
 199
 200 #define RES_HASH_BITS 10
 201 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
 202 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
 203
 204 struct ldlm_lock;
 205
 206 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
 207                                       struct ldlm_lock_desc *new, void *data,
 208                                       int flag);
 209 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
 210                                         void *data);
 211 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
 212
 213 struct ldlm_lock {
 214         struct portals_handle l_handle; // must be first in the structure
 215         atomic_t              l_refc;
 216         struct ldlm_resource *l_resource;
 217         struct ldlm_lock     *l_parent;
 218         struct list_head      l_children;
 219         struct list_head      l_childof;
 220         struct list_head      l_lru;
 221         struct list_head      l_res_link; // position in one of three res lists
 222         struct list_head      l_export_chain; // per-export chain of locks
 223
 224         ldlm_mode_t           l_req_mode;
 225         ldlm_mode_t           l_granted_mode;
 226
 227         ldlm_completion_callback l_completion_ast;
 228         ldlm_blocking_callback   l_blocking_ast;
 229         ldlm_glimpse_callback    l_glimpse_ast;
 230
 231         struct obd_export    *l_export;
 232         struct obd_export    *l_conn_export;
 233         __u32                 l_flags;
 234         struct lustre_handle  l_remote_handle;
 235         ldlm_policy_data_t    l_policy_data;
 236
 237         __u32                 l_readers;
 238         __u32                 l_writers;
 239         __u8                  l_destroyed;
 240
 241         /* If the lock is granted, a process sleeps on this waitq to learn when
 242          * it's no longer in use.  If the lock is not granted, a process sleeps
 243          * on this waitq to learn when it becomes granted. */
 244         cfs_waitq_t           l_waitq;
 245         struct timeval        l_enqueued_time;
 246
 247         cfs_time_t            l_last_used;      /* jiffies */
 248         struct ldlm_extent    l_req_extent;
 249
 250         /* Client-side-only members */
 251         __u32                 l_lvb_len;        /* temporary storage for */
 252         void                 *l_lvb_data;       /* an LVB received during */
 253         void                 *l_lvb_swabber;    /* an enqueue */
 254         void                 *l_ast_data;
 255
 256         /* Server-side-only members */
 257         struct list_head      l_pending_chain;  /* callbacks pending */
 258         cfs_time_t            l_callback_timeout; /* jiffies */
 259
 260         __u32                 l_pid;            /* pid which created this lock */
 261 };
 262
 263 struct ldlm_resource {
 264         struct ldlm_namespace *lr_namespace;
 265         struct list_head       lr_hash;
 266         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
 267         struct list_head       lr_children; /* list head for child resources */
 268         struct list_head       lr_childof;  /* part of ns_root_list if root res,
 269                                              * part of lr_children if child */
 270
 271         struct list_head       lr_granted;
 272         struct list_head       lr_converting;
 273         struct list_head       lr_waiting;
 274         ldlm_mode_t            lr_most_restr;
 275         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
 276         struct ldlm_resource  *lr_root;
 277         struct ldlm_res_id     lr_name;
 278         atomic_t               lr_refcount;
 279
 280         /* Server-side-only lock value block elements */
 281         struct semaphore       lr_lvb_sem;
 282         __u32                  lr_lvb_len;
 283         void                  *lr_lvb_data;
 284
 285         /* lr_tmp holds a list head temporarily, during the building of a work
 286          * queue.  see ldlm_add_ast_work_item and ldlm_run_ast_work */
 287         void                  *lr_tmp;
 288 };
 289
 290 struct ldlm_ast_work {
 291         struct ldlm_lock *w_lock;
 292         int               w_blocking;
 293         struct ldlm_lock_desc w_desc;
 294         struct list_head   w_list;
 295         int w_flags;
 296         void *w_data;
 297         int w_datalen;
 298 };
 299
 300 extern struct obd_ops ldlm_obd_ops;
 301
 302 extern char *ldlm_lockname[];
 303 extern char *ldlm_typename[];
 304 extern char *ldlm_it2str(int it);
 305
 306 #define __LDLM_DEBUG(level, lock, format, a...)                               \
 307 do {                                                                          \
 308         if (lock->l_resource == NULL) {                                       \
 309                 CDEBUG(level, "### " format                                   \
 310                        " ns: \?\? lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s "\
 311                        "res: \?\? rrc=\?\? type: \?\?\? flags: %x remote: "   \
 312                        LPX64" expref: %d pid: %u\n" , ## a, lock,             \
 313                        lock->l_handle.h_cookie, atomic_read(&lock->l_refc),   \
 314                        lock->l_readers, lock->l_writers,                      \
 315                        ldlm_lockname[lock->l_granted_mode],                   \
 316                        ldlm_lockname[lock->l_req_mode],                       \
 317                        lock->l_flags, lock->l_remote_handle.cookie,           \
 318                        lock->l_export ?                                       \
 319                        atomic_read(&lock->l_export->exp_refcount) : -99,      \
 320                        lock->l_pid);                                          \
 321                 break;                                                        \
 322         }                                                                     \
 323         if (lock->l_resource->lr_type == LDLM_EXTENT) {                       \
 324                 CDEBUG(level, "### " format                                   \
 325                        " ns: %s lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s "  \
 326                        "res: "LPU64"/"LPU64" rrc: %d type: %s ["LPU64"->"LPU64\
 327                        "] (req "LPU64"->"LPU64") flags: %x remote: "LPX64     \
 328                        " expref: %d pid: %u\n" , ## a,                        \
 329                        lock->l_resource->lr_namespace->ns_name, lock,         \
 330                        lock->l_handle.h_cookie, atomic_read(&lock->l_refc),   \
 331                        lock->l_readers, lock->l_writers,                      \
 332                        ldlm_lockname[lock->l_granted_mode],                   \
 333                        ldlm_lockname[lock->l_req_mode],                       \
 334                        lock->l_resource->lr_name.name[0],                     \
 335                        lock->l_resource->lr_name.name[1],                     \
 336                        atomic_read(&lock->l_resource->lr_refcount),           \
 337                        ldlm_typename[lock->l_resource->lr_type],              \
 338                        lock->l_policy_data.l_extent.start,                    \
 339                        lock->l_policy_data.l_extent.end,                      \
 340                        lock->l_req_extent.start, lock->l_req_extent.end,      \
 341                        lock->l_flags, lock->l_remote_handle.cookie,           \
 342                        lock->l_export ?                                       \
 343                        atomic_read(&lock->l_export->exp_refcount) : -99,      \
 344                        lock->l_pid);                                          \
 345                 break;                                                        \
 346         }                                                                     \
 347         if (lock->l_resource->lr_type == LDLM_FLOCK) {                        \
 348                 CDEBUG(level, "### " format                                   \
 349                        " ns: %s lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s "  \
 350                        "res: "LPU64"/"LPU64" rrc: %d type: %s pid: %d "       \
 351                        "["LPU64"->"LPU64"] flags: %x remote: "LPX64           \
 352                        " expref: %d pid: %u\n" , ## a,                        \
 353                        lock->l_resource->lr_namespace->ns_name, lock,         \
 354                        lock->l_handle.h_cookie, atomic_read(&lock->l_refc),   \
 355                        lock->l_readers, lock->l_writers,                      \
 356                        ldlm_lockname[lock->l_granted_mode],                   \
 357                        ldlm_lockname[lock->l_req_mode],                       \
 358                        lock->l_resource->lr_name.name[0],                     \
 359                        lock->l_resource->lr_name.name[1],                     \
 360                        atomic_read(&lock->l_resource->lr_refcount),           \
 361                        ldlm_typename[lock->l_resource->lr_type],              \
 362                        lock->l_policy_data.l_flock.pid,                       \
 363                        lock->l_policy_data.l_flock.start,                     \
 364                        lock->l_policy_data.l_flock.end,                       \
 365                        lock->l_flags, lock->l_remote_handle.cookie,           \
 366                        lock->l_export ?                                       \
 367                        atomic_read(&lock->l_export->exp_refcount) : -99,      \
 368                        lock->l_pid);                                          \
 369                 break;                                                        \
 370         }                                                                     \
 371         if (lock->l_resource->lr_type == LDLM_IBITS) {                        \
 372                 CDEBUG(level, "### " format                                   \
 373                        " ns: %s lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s "  \
 374                        "res: "LPU64"/"LPU64" bits "LPX64" rrc: %d type: %s "  \
 375                        "flags: %x remote: "LPX64" expref: %d "                \
 376                        "pid %u\n" , ## a,                                     \
 377                        lock->l_resource->lr_namespace->ns_name,               \
 378                        lock, lock->l_handle.h_cookie,                         \
 379                        atomic_read (&lock->l_refc),                           \
 380                        lock->l_readers, lock->l_writers,                      \
 381                        ldlm_lockname[lock->l_granted_mode],                   \
 382                        ldlm_lockname[lock->l_req_mode],                       \
 383                        lock->l_resource->lr_name.name[0],                     \
 384                        lock->l_resource->lr_name.name[1],                     \
 385                        lock->l_policy_data.l_inodebits.bits,                  \
 386                        atomic_read(&lock->l_resource->lr_refcount),           \
 387                        ldlm_typename[lock->l_resource->lr_type],              \
 388                        lock->l_flags, lock->l_remote_handle.cookie,           \
 389                        lock->l_export ?                                       \
 390                        atomic_read(&lock->l_export->exp_refcount) : -99,      \
 391                        lock->l_pid);                                          \
 392                 break;                                                        \
 393         }                                                                     \
 394         {                                                                     \
 395                 CDEBUG(level, "### " format                                   \
 396                        " ns: %s lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s "  \
 397                        "res: "LPU64"/"LPU64" rrc: %d type: %s flags: %x "     \
 398                        "remote: "LPX64" expref: %d pid: %u\n" , ## a,         \
 399                        lock->l_resource->lr_namespace->ns_name,               \
 400                        lock, lock->l_handle.h_cookie,                         \
 401                        atomic_read (&lock->l_refc),                           \
 402                        lock->l_readers, lock->l_writers,                      \
 403                        ldlm_lockname[lock->l_granted_mode],                   \
 404                        ldlm_lockname[lock->l_req_mode],                       \
 405                        lock->l_resource->lr_name.name[0],                     \
 406                        lock->l_resource->lr_name.name[1],                     \
 407                        atomic_read(&lock->l_resource->lr_refcount),           \
 408                        ldlm_typename[lock->l_resource->lr_type],              \
 409                        lock->l_flags, lock->l_remote_handle.cookie,           \
 410                        lock->l_export ?                                       \
 411                        atomic_read(&lock->l_export->exp_refcount) : -99,      \
 412                        lock->l_pid);                                          \
 413         }                                                                     \
 414 } while (0)
 415
 416 #define LDLM_DEBUG(lock, format, a...) __LDLM_DEBUG(D_DLMTRACE, lock, \
 417                                                     format, ## a)
 418 #define LDLM_ERROR(lock, format, a...) __LDLM_DEBUG(D_ERROR, lock, format, ## a)
 419
 420 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
 421         CDEBUG(D_DLMTRACE, "### " format "\n" , ## a)
 422
 423 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
 424                                       int first_enq, ldlm_error_t *err);
 425
 426 /*
 427  * Iterators.
 428  */
 429
 430 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
 431 #define LDLM_ITER_STOP     2 /* stop iterating */
 432
 433 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
 434 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
 435
 436 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
 437                           void *closure);
 438 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
 439                            void *closure);
 440 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
 441                                ldlm_res_iterator_t iter, void *closure);
 442
 443 int ldlm_replay_locks(struct obd_import *imp);
 444 void ldlm_change_cbdata(struct ldlm_namespace *, struct ldlm_res_id *,
 445                         ldlm_iterator_t iter, void *data);
 446
 447 /* ldlm_flock.c */
 448 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 449
 450 /* ldlm_extent.c */
 451 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
 452
 453
 454 /* ldlm_lockd.c */
 455 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
 456                              void *data, int flag);
 457 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 458 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
 459 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
 460                         ldlm_blocking_callback, ldlm_glimpse_callback);
 461 int ldlm_handle_convert(struct ptlrpc_request *req);
 462 int ldlm_handle_cancel(struct ptlrpc_request *req);
 463 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
 464 int ldlm_get_ref(void);
 465 void ldlm_put_ref(int force);
 466
 467 /* ldlm_lock.c */
 468 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
 469 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
 470 void ldlm_lock2handle(const struct ldlm_lock *lock,
 471                       struct lustre_handle *lockh);
 472 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
 473 void ldlm_cancel_callback(struct ldlm_lock *);
 474 int ldlm_lock_set_data(struct lustre_handle *, void *data);
 475 void ldlm_lock_remove_from_lru(struct ldlm_lock *);
 476 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
 477                                       const struct lustre_handle *);
 478
 479 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
 480 {
 481         return __ldlm_handle2lock(h, 0);
 482 }
 483
 484 #define LDLM_LOCK_PUT(lock)                     \
 485 do {                                            \
 486         /*LDLM_DEBUG((lock), "put");*/          \
 487         ldlm_lock_put(lock);                    \
 488 } while (0)
 489
 490 #define LDLM_LOCK_GET(lock)                     \
 491 ({                                              \
 492         ldlm_lock_get(lock);                    \
 493         /*LDLM_DEBUG((lock), "get");*/          \
 494         lock;                                   \
 495 })
 496
 497 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
 498 void ldlm_lock_put(struct ldlm_lock *lock);
 499 void ldlm_lock_destroy(struct ldlm_lock *lock);
 500 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
 501 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
 502 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
 503 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
 504 void ldlm_lock_allow_match(struct ldlm_lock *lock);
 505 int ldlm_lock_match(struct ldlm_namespace *ns, int flags, struct ldlm_res_id *,
 506                     ldlm_type_t type, ldlm_policy_data_t *, ldlm_mode_t mode,
 507                     struct lustre_handle *);
 508 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
 509                                         int *flags);
 510 void ldlm_lock_cancel(struct ldlm_lock *lock);
 511 void ldlm_cancel_locks_for_export(struct obd_export *export);
 512 void ldlm_reprocess_all(struct ldlm_resource *res);
 513 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
 514 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
 515 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
 516
 517 /* resource.c */
 518 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
 519 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
 520 int ldlm_namespace_free(struct ldlm_namespace *ns, int force);
 521 int ldlm_proc_setup(void);
 522 #ifdef LPROCFS
 523 void ldlm_proc_cleanup(void);
 524 #else
 525 static inline void ldlm_proc_cleanup(void) {}
 526 #endif
 527
 528 /* resource.c - internal */
 529 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
 530                                         struct ldlm_resource *parent,
 531                                         struct ldlm_res_id, ldlm_type_t type,
 532                                         int create);
 533 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
 534 int ldlm_resource_putref(struct ldlm_resource *res);
 535 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
 536                             struct ldlm_lock *lock);
 537 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
 538 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
 539 void ldlm_dump_all_namespaces(int level);
 540 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
 541 void ldlm_resource_dump(int level, struct ldlm_resource *);
 542 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
 543                               struct ldlm_res_id);
 544
 545 struct ldlm_callback_suite {
 546         ldlm_completion_callback lcs_completion;
 547         ldlm_blocking_callback   lcs_blocking;
 548         ldlm_glimpse_callback    lcs_glimpse;
 549 };
 550
 551 /* ldlm_request.c */
 552 int ldlm_expired_completion_wait(void *data);
 553 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
 554                       void *data, int flag);
 555 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
 556 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
 557 int ldlm_cli_enqueue(struct obd_export *exp,
 558                      struct ptlrpc_request *req,
 559                      struct ldlm_namespace *ns,
 560                      struct ldlm_res_id,
 561                      ldlm_type_t type,
 562                      ldlm_policy_data_t *,
 563                      ldlm_mode_t mode,
 564                      int *flags,
 565                      ldlm_blocking_callback blocking,
 566                      ldlm_completion_callback completion,
 567                      ldlm_glimpse_callback glimpse,
 568                      void *data,
 569                      void *lvb,
 570                      __u32 lvb_len,
 571                      void *lvb_swabber,
 572                      struct lustre_handle *lockh);
 573 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
 574                          const struct ldlm_request *dlm_req,
 575                          const struct ldlm_callback_suite *cbs);
 576 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
 577                     void *data, __u32 data_len);
 578 int ldlm_cli_convert(struct lustre_handle *, int new_mode, int *flags);
 579 int ldlm_handle_convert0(struct ptlrpc_request *req,
 580                          const struct ldlm_request *dlm_req);
 581 int ldlm_cli_cancel(struct lustre_handle *lockh);
 582 int ldlm_cli_cancel_unused(struct ldlm_namespace *, struct ldlm_res_id *,
 583                            int flags, void *opaque);
 584 int ldlm_cli_join_lru(struct ldlm_namespace *, struct ldlm_res_id *,
 585                       int join);
 586
 587 /* mds/handler.c */
 588 /* This has to be here because recursive inclusion sucks. */
 589 int intent_disposition(struct ldlm_reply *rep, int flag);
 590 void intent_set_disposition(struct ldlm_reply *rep, int flag);
 591
 592
 593 /* ioctls for trying requests */
 594 #define IOC_LDLM_TYPE                   'f'
 595 #define IOC_LDLM_MIN_NR                 40
 596
 597 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
 598 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
 599 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
 600 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
 601 #define IOC_LDLM_MAX_NR                 43
 602
 603 #endif