1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * (visit-tags-table FILE)
3 * vim:expandtab:shiftwidth=8:tabstop=8:
6 #ifndef _LUSTRE_DLM_H__
7 #define _LUSTRE_DLM_H__
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>
16 #error Unsupported operating system.
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 */
28 #define OBD_LDLM_DEVICENAME "ldlm"
30 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
31 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
36 ELDLM_LOCK_CHANGED = 300,
37 ELDLM_LOCK_ABORTED = 301,
38 ELDLM_LOCK_REPLACED = 302,
39 ELDLM_NO_LOCK_DATA = 303,
41 ELDLM_NAMESPACE_EXISTS = 400,
42 ELDLM_BAD_NAMESPACE = 401
46 LDLM_NAMESPACE_SERVER = 1 << 0,
47 LDLM_NAMESPACE_CLIENT = 1 << 1
50 #define LDLM_FL_LOCK_CHANGED 0x000001 /* extent, mode, or resource changed */
52 /* If the server returns one of these flags, then the lock was put on that list.
53 * If the client sends one of these flags (during recovery ONLY!), it wants the
54 * lock added to the specified list, no questions asked. -p */
55 #define LDLM_FL_BLOCK_GRANTED 0x000002
56 #define LDLM_FL_BLOCK_CONV 0x000004
57 #define LDLM_FL_BLOCK_WAIT 0x000008
59 #define LDLM_FL_CBPENDING 0x000010 /* this lock is being destroyed */
60 #define LDLM_FL_AST_SENT 0x000020 /* blocking or cancel packet was sent */
61 #define LDLM_FL_WAIT_NOREPROC 0x000040 /* not a real flag, not saved in lock */
62 #define LDLM_FL_CANCEL 0x000080 /* cancellation callback already run */
64 /* Lock is being replayed. This could probably be implied by the fact that one
65 * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
66 #define LDLM_FL_REPLAY 0x000100
68 #define LDLM_FL_INTENT_ONLY 0x000200 /* don't grant lock, just do intent */
69 #define LDLM_FL_LOCAL_ONLY 0x000400 /* see ldlm_cli_cancel_unused */
71 /* don't run the cancel callback under ldlm_cli_cancel_unused */
72 #define LDLM_FL_FAILED 0x000800
74 #define LDLM_FL_HAS_INTENT 0x001000 /* lock request has intent */
75 #define LDLM_FL_CANCELING 0x002000 /* lock cancel has already been sent */
76 #define LDLM_FL_LOCAL 0x004000 /* local lock (ie, no srv/cli split) */
77 #define LDLM_FL_WARN 0x008000 /* see ldlm_cli_cancel_unused */
78 #define LDLM_FL_DISCARD_DATA 0x010000 /* discard (no writeback) on cancel */
80 #define LDLM_FL_NO_TIMEOUT 0x020000 /* Blocked by group lock - wait
83 /* file & record locking */
84 #define LDLM_FL_BLOCK_NOWAIT 0x040000 // server told not to wait if blocked
85 #define LDLM_FL_TEST_LOCK 0x080000 // return blocking lock
87 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
88 * the LVB filling happens _after_ the lock has been granted, so another thread
89 * can match`t before the LVB has been updated. As a dirty hack, we set
90 * LDLM_FL_LVB_READY only after we've done the LVB poop.
91 * this is only needed on lov/osc now, where lvb is actually used and callers
92 * must set it in input flags.
94 * The proper fix is to do the granting inside of the completion AST, which can
95 * be replaced with a LVB-aware wrapping function for OSC locks. That change is
96 * pretty high-risk, though, and would need a lot more testing. */
98 #define LDLM_FL_LVB_READY 0x100000
100 /* A lock contributes to the kms calculation until it has finished the part
101 * of it's cancelation that performs write back on its dirty pages. It
102 * can remain on the granted list during this whole time. Threads racing
103 * to update the kms after performing their writeback need to know to
104 * exclude each others locks from the calculation as they walk the granted
106 #define LDLM_FL_KMS_IGNORE 0x200000
108 /* Don't drop lock covering mmapped file in LRU */
109 #define LDLM_FL_NO_LRU 0x400000
111 /* Immediatelly cancel such locks when they block some other locks. Send
112 cancel notification to original lock holder, but expect no reply. */
113 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
115 /* Flags flags inherited from parent lock when doing intents. */
116 #define LDLM_INHERIT_FLAGS (LDLM_FL_CANCEL_ON_BLOCK)
118 /* These are flags that are mapped into the flags and ASTs of blocking locks */
119 #define LDLM_AST_DISCARD_DATA 0x80000000 /* Add FL_DISCARD to blocking ASTs */
120 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
121 #define LDLM_AST_FLAGS (LDLM_FL_DISCARD_DATA)
123 /* completion ast to be executed */
124 #define LDLM_FL_CP_REQD 0x1000000
126 /* cleanup_resource has already handled the lock */
127 #define LDLM_FL_CLEANED 0x2000000
129 /* optimization hint: LDLM can run blocking callback from current context
130 * w/o involving separate thread. in order to decrease cs rate */
131 #define LDLM_FL_ATOMIC_CB 0x4000000
133 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
134 * such that server send blocking ast for conflict locks to this client for
135 * the 1st operation, whereas the 2nd operation has canceled this lock and
136 * is waiting for rpc_lock which is taken by the 1st operation.
137 * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
138 * ELC code to cancel it.
139 * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
140 * droped to let ldlm_callback_handler() return EINVAL to the server. It is
141 * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
142 * to send a separate CANCEL rpc. */
143 #define LDLM_FL_BL_AST 0x10000000
144 #define LDLM_FL_BL_DONE 0x20000000
146 /* Cancel lock asynchronously. See ldlm_cli_cancel_unused_resource. */
147 #define LDLM_FL_ASYNC 0x40000000
149 /* The blocking callback is overloaded to perform two functions. These flags
150 * indicate which operation should be performed. */
151 #define LDLM_CB_BLOCKING 1
152 #define LDLM_CB_CANCELING 2
154 /* position flag of skip list pointers */
155 #define LDLM_SL_HEAD(skip_list) ((skip_list)->next != NULL)
156 #define LDLM_SL_TAIL(skip_list) ((skip_list)->prev != NULL)
157 #define LDLM_SL_EMPTY(skip_list) ((skip_list)->next == NULL && \
158 (skip_list)->prev == NULL)
160 /* compatibility matrix */
161 #define LCK_COMPAT_EX LCK_NL
162 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
163 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
164 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
165 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
166 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
167 #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL)
169 extern ldlm_mode_t lck_compat_array[];
171 static inline void lockmode_verify(ldlm_mode_t mode)
173 LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
176 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
178 return (lck_compat_array[exist] & new);
183 * cluster name spaces
187 #define DLM_OST_NAMESPACE 1
188 #define DLM_MDS_NAMESPACE 2
191 - do we just separate this by security domains and use a prefix for
192 multiple namespaces in the same domain?
202 * waiting_locks_spinlock
217 struct ldlm_resource;
218 struct ldlm_namespace;
220 struct ldlm_pool_ops {
221 int (*po_recalc)(struct ldlm_pool *pl);
222 int (*po_shrink)(struct ldlm_pool *pl, int nr,
223 unsigned int gfp_mask);
224 int (*po_setup)(struct ldlm_pool *pl, int limit);
228 LDLM_POOL_CTL_RECALC = 1 << 0, /* Pool recalc is enabled */
229 LDLM_POOL_CTL_SHRINK = 1 << 1, /* Pool shrink is enabled */
230 LDLM_POOL_CTL_FULL = (LDLM_POOL_CTL_RECALC | LDLM_POOL_CTL_SHRINK)
233 /* One second for pools thread check interval. */
234 #define LDLM_POOLS_THREAD_PERIOD (1)
236 /* 5% margin for modest pools. See ldlm_pool.c for details. */
237 #define LDLM_POOLS_MODEST_MARGIN (5)
239 /* A change to SLV in % after which we want to wake up pools thread asap. */
240 #define LDLM_POOLS_FAST_SLV_CHANGE (50)
243 /* Common pool fields */
244 cfs_proc_dir_entry_t *pl_proc_dir; /* Pool proc directory. */
245 char pl_name[100]; /* Pool name, should be long
246 * enough to contain complex
247 * proc entry name. */
248 spinlock_t pl_lock; /* Lock for protecting slv/clv
250 atomic_t pl_limit; /* Number of allowed locks in
251 * in pool, both, client and
253 atomic_t pl_granted; /* Number of granted locks. */
254 atomic_t pl_grant_rate; /* Grant rate per T. */
255 atomic_t pl_cancel_rate; /* Cancel rate per T. */
256 atomic_t pl_grant_speed; /* Grant speed (GR-CR) per T. */
257 __u64 pl_server_lock_volume; /* Server lock volume.
258 * Protected by pl_lock */
259 atomic_t pl_lock_volume_factor; /* Lock volume factor. */
261 time_t pl_recalc_time; /* Time when last slv from
262 * server was obtained. */
263 struct ldlm_pool_ops *pl_ops; /* Recalc and shrink ops. */
265 int pl_control; /* Pool features mask */
267 atomic_t pl_grant_plan; /* Planned number of granted
268 * locks for next T. */
269 atomic_t pl_grant_step; /* Grant plan step for next
272 struct lprocfs_stats *pl_stats; /* Pool statistics. */
275 static inline int pool_recalc_enabled(struct ldlm_pool *pl)
277 return pl->pl_control & LDLM_POOL_CTL_RECALC;
280 static inline int pool_shrink_enabled(struct ldlm_pool *pl)
282 return pl->pl_control & LDLM_POOL_CTL_SHRINK;
285 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
286 void *req_cookie, ldlm_mode_t mode, int flags,
289 struct ldlm_valblock_ops {
290 int (*lvbo_init)(struct ldlm_resource *res);
291 int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
292 int buf_idx, int increase);
296 LDLM_NAMESPACE_GREEDY = 1 << 0,
297 LDLM_NAMESPACE_MODEST = 1 << 1
300 /* Default value for ->ns_shrink_thumb. If lock is not extent one its cost
301 * is one page. Here we have 256 pages which is 1M on i386. Thus by default
302 * all extent locks which have more than 1M long extent will be kept in lru,
303 * others (including ibits locks) will be canceled on memory pressure event. */
304 #define LDLM_LOCK_SHRINK_THUMB 256
306 struct ldlm_namespace {
308 ldlm_side_t ns_client; /* is this a client-side lock tree? */
309 __u64 ns_connect_flags; /* ns connect flags supported
310 * by server (may be changed via proc,
311 * lru resize may be disabled/enabled) */
312 __u64 ns_orig_connect_flags; /* client side orig connect
313 * flags supported by server */
314 struct list_head *ns_hash; /* hash table for ns */
315 spinlock_t ns_hash_lock;
316 __u32 ns_refcount; /* count of resources in the hash */
317 struct list_head ns_root_list; /* all root resources in ns */
318 struct list_head ns_list_chain; /* position in global NS list */
320 struct list_head ns_unused_list; /* all root resources in ns */
322 spinlock_t ns_unused_lock;
324 unsigned int ns_max_unused;
325 unsigned int ns_max_age;
327 /* Lower limit to number of pages in lock to keep it in cache */
328 unsigned int ns_shrink_thumb;
329 cfs_time_t ns_next_dump; /* next debug dump, jiffies */
333 ldlm_res_policy ns_policy;
334 struct ldlm_valblock_ops *ns_lvbo;
336 cfs_waitq_t ns_waitq;
337 struct ldlm_pool ns_pool;
338 ldlm_appetite_t ns_appetite;
341 static inline int ns_is_client(struct ldlm_namespace *ns)
344 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
345 LDLM_NAMESPACE_SERVER)));
346 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
347 ns->ns_client == LDLM_NAMESPACE_SERVER);
348 return ns->ns_client == LDLM_NAMESPACE_CLIENT;
351 static inline int ns_is_server(struct ldlm_namespace *ns)
354 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
355 LDLM_NAMESPACE_SERVER)));
356 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
357 ns->ns_client == LDLM_NAMESPACE_SERVER);
358 return ns->ns_client == LDLM_NAMESPACE_SERVER;
361 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
364 return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
369 * Resource hash table
373 #define RES_HASH_BITS 10
374 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
375 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
379 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
380 struct ldlm_lock_desc *new, void *data,
382 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
384 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
387 struct portals_handle l_handle; // must be first in the structure
390 /* internal spinlock protects l_resource. we should hold this lock
391 * first before grabbing res_lock.*/
394 /* ldlm_lock_change_resource() can change this */
395 struct ldlm_resource *l_resource;
397 /* protected by ns_hash_lock. FIXME */
398 struct list_head l_lru;
400 /* protected by lr_lock */
401 struct list_head l_res_link; // position in one of three res lists
403 struct list_head l_sl_mode; // skip pointer for request mode
404 struct list_head l_sl_policy; // skip pointer for inodebits
406 /* protected by led_lock */
407 struct list_head l_export_chain; // per-export chain of locks
409 /* protected by lr_lock */
410 ldlm_mode_t l_req_mode;
411 ldlm_mode_t l_granted_mode;
413 ldlm_completion_callback l_completion_ast;
414 ldlm_blocking_callback l_blocking_ast;
415 ldlm_glimpse_callback l_glimpse_ast;
417 struct obd_export *l_export;
418 struct obd_export *l_conn_export;
420 struct lustre_handle l_remote_handle;
421 ldlm_policy_data_t l_policy_data;
423 /* protected by lr_lock */
429 /* If the lock is granted, a process sleeps on this waitq to learn when
430 * it's no longer in use. If the lock is not granted, a process sleeps
431 * on this waitq to learn when it becomes granted. */
433 struct timeval l_enqueued_time;
435 cfs_time_t l_last_used; /* jiffies */
436 struct ldlm_extent l_req_extent;
438 /* Client-side-only members */
439 __u32 l_lvb_len; /* temporary storage for */
440 void *l_lvb_data; /* an LVB received during */
441 void *l_lvb_swabber; /* an enqueue */
444 /* Server-side-only members */
446 /* protected by elt_lock */
447 struct list_head l_pending_chain; /* callbacks pending */
448 cfs_time_t l_callback_timeout; /* jiffies */
450 __u32 l_pid; /* pid which created this lock */
452 /* for ldlm_add_ast_work_item() */
453 struct list_head l_bl_ast;
454 struct list_head l_cp_ast;
455 struct ldlm_lock *l_blocking_lock;
459 struct ldlm_resource {
460 struct ldlm_namespace *lr_namespace;
462 /* protected by ns_hash_lock */
463 struct list_head lr_hash;
464 struct ldlm_resource *lr_parent; /* 0 for a root resource */
465 struct list_head lr_children; /* list head for child resources */
466 struct list_head lr_childof; /* part of ns_root_list if root res,
467 * part of lr_children if child */
470 /* protected by lr_lock */
471 struct list_head lr_granted;
472 struct list_head lr_converting;
473 struct list_head lr_waiting;
474 ldlm_mode_t lr_most_restr;
475 ldlm_type_t lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
476 struct ldlm_res_id lr_name;
477 atomic_t lr_refcount;
479 /* Server-side-only lock value block elements */
480 struct semaphore lr_lvb_sem;
485 struct ldlm_ast_work {
486 struct ldlm_lock *w_lock;
488 struct ldlm_lock_desc w_desc;
489 struct list_head w_list;
495 /* ldlm_enqueue parameters common */
496 struct ldlm_enqueue_info {
497 __u32 ei_type; /* Type of the lock being enqueued. */
498 __u32 ei_mode; /* Mode of the lock being enqueued. */
499 void *ei_cb_bl; /* Different callbacks for lock handling (blocking, */
500 void *ei_cb_cp; /* completion, glimpse) */
502 void *ei_cbdata; /* Data to be passed into callbacks. */
505 extern struct obd_ops ldlm_obd_ops;
507 extern char *ldlm_lockname[];
508 extern char *ldlm_typename[];
509 extern char *ldlm_it2str(int it);
511 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
514 if (((level) & D_CANTMASK) != 0 || \
515 ((libcfs_debug & (level)) != 0 && \
516 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) { \
517 static struct libcfs_debug_msg_data _ldlm_dbg_data = \
518 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM, \
520 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt, \
525 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
526 struct libcfs_debug_msg_data *data, const char *fmt,
528 __attribute__ ((format (printf, 4, 5)));
530 #define LDLM_ERROR(lock, fmt, a...) do { \
531 static cfs_debug_limit_state_t _ldlm_cdls; \
532 ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock, \
533 __FILE__, __FUNCTION__, __LINE__, \
537 #define LDLM_DEBUG(lock, fmt, a...) do { \
538 ldlm_lock_debug(NULL, D_DLMTRACE, lock, \
539 __FILE__, __FUNCTION__, __LINE__, \
543 #define LDLM_DEBUG(lock, fmt, a...) ((void)0)
544 #define LDLM_ERROR(lock, fmt, a...) ((void)0)
547 #define LDLM_DEBUG_NOLOCK(format, a...) \
548 CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
550 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
551 int first_enq, ldlm_error_t *err,
552 struct list_head *work_list);
558 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
559 #define LDLM_ITER_STOP 2 /* stop iterating */
561 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
562 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
564 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
566 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
568 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
569 ldlm_res_iterator_t iter, void *closure);
571 int ldlm_replay_locks(struct obd_import *imp);
572 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
573 ldlm_iterator_t iter, void *data);
576 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
579 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
583 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
584 void *data, int flag);
585 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
586 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
587 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
588 ldlm_blocking_callback, ldlm_glimpse_callback);
589 int ldlm_handle_convert(struct ptlrpc_request *req);
590 int ldlm_handle_cancel(struct ptlrpc_request *req);
591 int ldlm_request_cancel(struct ptlrpc_request *req,
592 const struct ldlm_request *dlm_req, int first);
593 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
594 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
595 void ldlm_revoke_export_locks(struct obd_export *exp);
596 int ldlm_get_ref(void);
597 void ldlm_put_ref(int force);
600 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
601 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
602 void ldlm_lock2handle(const struct ldlm_lock *lock,
603 struct lustre_handle *lockh);
604 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
605 void ldlm_cancel_callback(struct ldlm_lock *);
606 int ldlm_lock_set_data(struct lustre_handle *, void *data);
607 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
608 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
609 const struct lustre_handle *);
611 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
613 return __ldlm_handle2lock(h, 0);
616 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
617 struct lustre_msg *m, int buf_idx,
620 if (res->lr_namespace->ns_lvbo &&
621 res->lr_namespace->ns_lvbo->lvbo_update) {
622 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
628 #define LDLM_LOCK_PUT(lock) \
630 /*LDLM_DEBUG((lock), "put");*/ \
631 ldlm_lock_put(lock); \
634 #define LDLM_LOCK_GET(lock) \
636 ldlm_lock_get(lock); \
637 /*LDLM_DEBUG((lock), "get");*/ \
641 #define ldlm_lock_list_put(head, member, count) \
643 struct ldlm_lock *_lock, *_next; \
645 list_for_each_entry_safe(_lock, _next, head, member) { \
648 list_del_init(&_lock->member); \
649 LDLM_LOCK_PUT(_lock); \
654 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
655 void ldlm_lock_put(struct ldlm_lock *lock);
656 void ldlm_lock_destroy(struct ldlm_lock *lock);
657 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
658 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
659 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
660 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
661 void ldlm_lock_allow_match(struct ldlm_lock *lock);
662 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
663 const struct ldlm_res_id *, ldlm_type_t type,
664 ldlm_policy_data_t *, ldlm_mode_t mode,
665 struct lustre_handle *);
666 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
668 void ldlm_lock_cancel(struct ldlm_lock *lock);
669 void ldlm_cancel_locks_for_export(struct obd_export *export);
670 void ldlm_reprocess_all(struct ldlm_resource *res);
671 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
672 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
673 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
674 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
677 struct ldlm_namespace *ldlm_namespace_new(char *name, ldlm_side_t client,
678 ldlm_appetite_t apt);
679 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
680 int ldlm_namespace_free(struct ldlm_namespace *ns, int force);
681 void ldlm_namespace_move(struct ldlm_namespace *ns, ldlm_side_t client);
682 struct ldlm_namespace *ldlm_namespace_first(ldlm_side_t client);
683 void ldlm_namespace_get(struct ldlm_namespace *ns);
684 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
685 void ldlm_namespace_get_nolock(struct ldlm_namespace *ns);
686 void ldlm_namespace_put_nolock(struct ldlm_namespace *ns, int wakeup);
687 int ldlm_proc_setup(void);
689 void ldlm_proc_cleanup(void);
691 static inline void ldlm_proc_cleanup(void) {}
694 /* resource.c - internal */
695 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
696 struct ldlm_resource *parent,
697 const struct ldlm_res_id *,
698 ldlm_type_t type, int create);
699 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
700 int ldlm_resource_putref(struct ldlm_resource *res);
701 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
702 struct ldlm_lock *lock);
703 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
704 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
705 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
706 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
707 void ldlm_resource_dump(int level, struct ldlm_resource *);
708 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
709 const struct ldlm_res_id *);
711 struct ldlm_callback_suite {
712 ldlm_completion_callback lcs_completion;
713 ldlm_blocking_callback lcs_blocking;
714 ldlm_glimpse_callback lcs_glimpse;
718 int ldlm_expired_completion_wait(void *data);
719 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
720 void *data, int flag);
721 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
722 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
723 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
724 struct ldlm_enqueue_info *einfo,
725 const struct ldlm_res_id *res_id,
726 ldlm_policy_data_t *policy, int *flags,
727 void *lvb, __u32 lvb_len, void *lvb_swabber,
728 struct lustre_handle *lockh, int async);
729 int ldlm_prep_enqueue_req(struct obd_export *exp,
730 struct ptlrpc_request *req,
731 struct list_head *cancels,
733 int ldlm_prep_elc_req(struct obd_export *exp,
734 struct ptlrpc_request *req,
735 int version, int opc, int canceloff,
736 struct list_head *cancels, int count);
737 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
738 const struct ldlm_request *dlm_req,
739 const struct ldlm_callback_suite *cbs);
740 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
741 ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
742 int *flags, void *lvb, __u32 lvb_len,
743 void *lvb_swabber, struct lustre_handle *lockh,
745 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
746 const struct ldlm_res_id *res_id,
747 ldlm_type_t type, ldlm_policy_data_t *policy,
748 ldlm_mode_t mode, int *flags,
749 ldlm_blocking_callback blocking,
750 ldlm_completion_callback completion,
751 ldlm_glimpse_callback glimpse,
752 void *data, __u32 lvb_len, void *lvb_swabber,
753 struct lustre_handle *lockh);
754 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
755 void *data, __u32 data_len);
756 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
757 int ldlm_cli_update_pool(struct ptlrpc_request *req);
758 int ldlm_handle_convert0(struct ptlrpc_request *req,
759 const struct ldlm_request *dlm_req);
760 int ldlm_cli_cancel(struct lustre_handle *lockh);
761 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
762 int flags, void *opaque);
763 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
764 const struct ldlm_res_id *res_id,
765 ldlm_policy_data_t *policy,
766 ldlm_mode_t mode, int flags, void *opaque);
767 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
768 int count, int flags);
769 int ldlm_cli_join_lru(struct ldlm_namespace *,
770 const struct ldlm_res_id *, int join);
771 int ldlm_cancel_resource_local(struct ldlm_resource *res,
772 struct list_head *cancels,
773 ldlm_policy_data_t *policy,
774 ldlm_mode_t mode, int lock_flags,
775 int cancel_flags, void *opaque);
776 int ldlm_cli_cancel_list(struct list_head *head, int count,
777 struct ptlrpc_request *req, int flags);
780 /* This has to be here because recursive inclusion sucks. */
781 int intent_disposition(struct ldlm_reply *rep, int flag);
782 void intent_set_disposition(struct ldlm_reply *rep, int flag);
785 /* ioctls for trying requests */
786 #define IOC_LDLM_TYPE 'f'
787 #define IOC_LDLM_MIN_NR 40
789 #define IOC_LDLM_TEST _IOWR('f', 40, long)
790 #define IOC_LDLM_DUMP _IOWR('f', 41, long)
791 #define IOC_LDLM_REGRESS_START _IOWR('f', 42, long)
792 #define IOC_LDLM_REGRESS_STOP _IOWR('f', 43, long)
793 #define IOC_LDLM_MAX_NR 43
795 static inline void lock_res(struct ldlm_resource *res)
797 spin_lock(&res->lr_lock);
800 static inline void unlock_res(struct ldlm_resource *res)
802 spin_unlock(&res->lr_lock);
805 static inline void check_res_locked(struct ldlm_resource *res)
807 LASSERT_SPIN_LOCKED(&res->lr_lock);
810 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
811 void unlock_res_and_lock(struct ldlm_lock *lock);
814 void ldlm_pools_recalc(ldlm_side_t client);
815 int ldlm_pools_init(void);
816 void ldlm_pools_fini(void);
817 void ldlm_pools_wakeup(void);
819 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
820 int idx, ldlm_side_t client);
821 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
822 unsigned int gfp_mask);
823 void ldlm_pool_fini(struct ldlm_pool *pl);
824 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
825 int ldlm_pool_recalc(struct ldlm_pool *pl);
826 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
827 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
828 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
829 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
830 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
831 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);