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 */
24 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
29 #define OBD_LDLM_DEVICENAME "ldlm"
31 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
32 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
37 ELDLM_LOCK_CHANGED = 300,
38 ELDLM_LOCK_ABORTED = 301,
39 ELDLM_LOCK_REPLACED = 302,
40 ELDLM_NO_LOCK_DATA = 303,
42 ELDLM_NAMESPACE_EXISTS = 400,
43 ELDLM_BAD_NAMESPACE = 401
47 LDLM_NAMESPACE_SERVER = 1 << 0,
48 LDLM_NAMESPACE_CLIENT = 1 << 1
51 #define LDLM_FL_LOCK_CHANGED 0x000001 /* extent, mode, or resource changed */
53 /* If the server returns one of these flags, then the lock was put on that list.
54 * If the client sends one of these flags (during recovery ONLY!), it wants the
55 * lock added to the specified list, no questions asked. -p */
56 #define LDLM_FL_BLOCK_GRANTED 0x000002
57 #define LDLM_FL_BLOCK_CONV 0x000004
58 #define LDLM_FL_BLOCK_WAIT 0x000008
60 #define LDLM_FL_CBPENDING 0x000010 /* this lock is being destroyed */
61 #define LDLM_FL_AST_SENT 0x000020 /* blocking or cancel packet was sent */
62 #define LDLM_FL_WAIT_NOREPROC 0x000040 /* not a real flag, not saved in lock */
63 #define LDLM_FL_CANCEL 0x000080 /* cancellation callback already run */
65 /* Lock is being replayed. This could probably be implied by the fact that one
66 * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
67 #define LDLM_FL_REPLAY 0x000100
69 #define LDLM_FL_INTENT_ONLY 0x000200 /* don't grant lock, just do intent */
70 #define LDLM_FL_LOCAL_ONLY 0x000400 /* see ldlm_cli_cancel_unused */
72 /* don't run the cancel callback under ldlm_cli_cancel_unused */
73 #define LDLM_FL_FAILED 0x000800
75 #define LDLM_FL_HAS_INTENT 0x001000 /* lock request has intent */
76 #define LDLM_FL_CANCELING 0x002000 /* lock cancel has already been sent */
77 #define LDLM_FL_LOCAL 0x004000 /* local lock (ie, no srv/cli split) */
78 #define LDLM_FL_WARN 0x008000 /* see ldlm_cli_cancel_unused */
79 #define LDLM_FL_DISCARD_DATA 0x010000 /* discard (no writeback) on cancel */
81 #define LDLM_FL_NO_TIMEOUT 0x020000 /* Blocked by group lock - wait
84 /* file & record locking */
85 #define LDLM_FL_BLOCK_NOWAIT 0x040000 // server told not to wait if blocked
86 #define LDLM_FL_TEST_LOCK 0x080000 // return blocking lock
88 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
89 * the LVB filling happens _after_ the lock has been granted, so another thread
90 * can match`t before the LVB has been updated. As a dirty hack, we set
91 * LDLM_FL_LVB_READY only after we've done the LVB poop.
92 * this is only needed on lov/osc now, where lvb is actually used and callers
93 * must set it in input flags.
95 * The proper fix is to do the granting inside of the completion AST, which can
96 * be replaced with a LVB-aware wrapping function for OSC locks. That change is
97 * pretty high-risk, though, and would need a lot more testing. */
99 #define LDLM_FL_LVB_READY 0x100000
101 /* A lock contributes to the kms calculation until it has finished the part
102 * of it's cancelation that performs write back on its dirty pages. It
103 * can remain on the granted list during this whole time. Threads racing
104 * to update the kms after performing their writeback need to know to
105 * exclude each others locks from the calculation as they walk the granted
107 #define LDLM_FL_KMS_IGNORE 0x200000
109 /* Don't drop lock covering mmapped file in LRU */
110 #define LDLM_FL_NO_LRU 0x400000
112 /* Immediatelly cancel such locks when they block some other locks. Send
113 cancel notification to original lock holder, but expect no reply. */
114 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
116 /* Flags flags inherited from parent lock when doing intents. */
117 #define LDLM_INHERIT_FLAGS (LDLM_FL_CANCEL_ON_BLOCK)
119 /* These are flags that are mapped into the flags and ASTs of blocking locks */
120 #define LDLM_AST_DISCARD_DATA 0x80000000 /* Add FL_DISCARD to blocking ASTs */
121 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
122 #define LDLM_AST_FLAGS (LDLM_FL_DISCARD_DATA)
124 /* completion ast to be executed */
125 #define LDLM_FL_CP_REQD 0x1000000
127 /* cleanup_resource has already handled the lock */
128 #define LDLM_FL_CLEANED 0x2000000
130 /* optimization hint: LDLM can run blocking callback from current context
131 * w/o involving separate thread. in order to decrease cs rate */
132 #define LDLM_FL_ATOMIC_CB 0x4000000
134 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
135 * such that server send blocking ast for conflict locks to this client for
136 * the 1st operation, whereas the 2nd operation has canceled this lock and
137 * is waiting for rpc_lock which is taken by the 1st operation.
138 * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
139 * ELC code to cancel it.
140 * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
141 * droped to let ldlm_callback_handler() return EINVAL to the server. It is
142 * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
143 * to send a separate CANCEL rpc. */
144 #define LDLM_FL_BL_AST 0x10000000
145 #define LDLM_FL_BL_DONE 0x20000000
147 /* measure lock contention and return -EUSERS if locking contention is high */
148 #define LDLM_FL_DENY_ON_CONTENTION 0x40000000
150 /* The blocking callback is overloaded to perform two functions. These flags
151 * indicate which operation should be performed. */
152 #define LDLM_CB_BLOCKING 1
153 #define LDLM_CB_CANCELING 2
155 /* position flag of skip list pointers */
156 #define LDLM_SL_HEAD(skip_list) ((skip_list)->next != NULL)
157 #define LDLM_SL_TAIL(skip_list) ((skip_list)->prev != NULL)
158 #define LDLM_SL_EMPTY(skip_list) ((skip_list)->next == NULL && \
159 (skip_list)->prev == NULL)
161 /* compatibility matrix */
162 #define LCK_COMPAT_EX LCK_NL
163 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
164 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
165 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
166 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
167 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
168 #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL)
170 extern ldlm_mode_t lck_compat_array[];
172 static inline void lockmode_verify(ldlm_mode_t mode)
174 LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
177 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
179 return (lck_compat_array[exist] & new);
184 * cluster name spaces
188 #define DLM_OST_NAMESPACE 1
189 #define DLM_MDS_NAMESPACE 2
192 - do we just separate this by security domains and use a prefix for
193 multiple namespaces in the same domain?
203 * waiting_locks_spinlock
218 struct ldlm_resource;
219 struct ldlm_namespace;
221 struct ldlm_pool_ops {
222 int (*po_recalc)(struct ldlm_pool *pl);
223 int (*po_shrink)(struct ldlm_pool *pl, int nr,
224 unsigned int gfp_mask);
225 int (*po_setup)(struct ldlm_pool *pl, int limit);
228 /* One second for pools thread check interval. */
229 #define LDLM_POOLS_THREAD_PERIOD (1)
231 /* 5% margin for modest pools. See ldlm_pool.c for details. */
232 #define LDLM_POOLS_MODEST_MARGIN (5)
234 /* A change to SLV in % after which we want to wake up pools thread asap. */
235 #define LDLM_POOLS_FAST_SLV_CHANGE (50)
238 /* Common pool fields */
239 cfs_proc_dir_entry_t *pl_proc_dir; /* Pool proc directory. */
240 char pl_name[100]; /* Pool name, should be long
241 * enough to contain complex
242 * proc entry name. */
243 spinlock_t pl_lock; /* Lock for protecting slv/clv
245 atomic_t pl_limit; /* Number of allowed locks in
246 * in pool, both, client and
248 atomic_t pl_granted; /* Number of granted locks. */
249 atomic_t pl_grant_rate; /* Grant rate per T. */
250 atomic_t pl_cancel_rate; /* Cancel rate per T. */
251 atomic_t pl_grant_speed; /* Grant speed (GR-CR) per T. */
252 __u64 pl_server_lock_volume; /* Server lock volume.
253 * Protected by pl_lock */
254 atomic_t pl_lock_volume_factor; /* Lock volume factor. */
256 time_t pl_recalc_time; /* Time when last slv from
257 * server was obtained. */
258 struct ldlm_pool_ops *pl_ops; /* Recalc and shrink ops. */
260 int pl_grant_plan; /* Planned number of granted
261 * locks for next T. */
262 int pl_grant_step; /* Grant plan step for next
265 struct lprocfs_stats *pl_stats; /* Pool statistics. */
268 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
269 void *req_cookie, ldlm_mode_t mode, int flags,
272 struct ldlm_valblock_ops {
273 int (*lvbo_init)(struct ldlm_resource *res);
274 int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
275 int buf_idx, int increase);
279 LDLM_NAMESPACE_GREEDY = 1 << 0,
280 LDLM_NAMESPACE_MODEST = 1 << 1
283 /* default values for the "max_nolock_size", "contention_time"
284 * and "contended_locks" namespace tunables */
285 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
286 #define NS_DEFAULT_CONTENTION_SECONDS 2
287 #define NS_DEFAULT_CONTENDED_LOCKS 32
289 /* Default value for ->ns_shrink_thumb. If lock is not extent one its cost
290 * is one page. Here we have 256 pages which is 1M on i386. Thus by default
291 * all extent locks which have more than 1M long extent will be kept in lru,
292 * others (including ibits locks) will be canceled on memory pressure event. */
293 #define LDLM_LOCK_SHRINK_THUMB 256
295 struct ldlm_namespace {
297 ldlm_side_t ns_client; /* is this a client-side lock tree? */
298 __u64 ns_connect_flags; /* ns connect flags supported
299 * by server (may be changed via proc,
300 * lru resize may be disabled/enabled) */
301 __u64 ns_orig_connect_flags; /* client side orig connect
302 * flags supported by server */
303 struct list_head *ns_hash; /* hash table for ns */
304 spinlock_t ns_hash_lock;
305 __u32 ns_refcount; /* count of resources in the hash */
306 struct list_head ns_root_list; /* all root resources in ns */
307 struct list_head ns_list_chain; /* position in global NS list */
309 struct list_head ns_unused_list; /* all root resources in ns */
311 spinlock_t ns_unused_lock;
313 unsigned int ns_max_unused;
314 unsigned int ns_max_age;
316 /* Lower limit to number of pages in lock to keep it in cache */
317 unsigned int ns_shrink_thumb;
318 cfs_time_t ns_next_dump; /* next debug dump, jiffies */
322 ldlm_res_policy ns_policy;
323 struct ldlm_valblock_ops *ns_lvbo;
325 cfs_waitq_t ns_waitq;
326 struct ldlm_pool ns_pool;
327 ldlm_appetite_t ns_appetite;
329 /* if more than @ns_contented_locks found, the resource considered
331 unsigned ns_contended_locks;
332 /* the resource remembers contended state during @ns_contention_time,
334 unsigned ns_contention_time;
335 /* limit size of nolock requests, in bytes */
336 unsigned ns_max_nolock_size;
338 struct adaptive_timeout ns_at_estimate;/* estimated lock callback time*/
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);
386 /* Interval node data for each LDLM_EXTENT lock */
387 struct ldlm_interval {
388 struct interval_node li_node; /* node for tree mgmt */
389 struct list_head li_group; /* the locks which have the same
390 * policy - group of the policy */
392 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
394 /* the interval tree must be accessed inside the resource lock. */
395 struct ldlm_interval_tree {
396 /* tree size, this variable is used to count
397 * granted PW locks in ldlm_extent_policy()*/
399 ldlm_mode_t lit_mode; /* lock mode */
400 struct interval_node *lit_root; /* actually ldlm_interval */
404 struct portals_handle l_handle; // must be first in the structure
407 /* internal spinlock protects l_resource. we should hold this lock
408 * first before grabbing res_lock.*/
411 /* ldlm_lock_change_resource() can change this */
412 struct ldlm_resource *l_resource;
414 /* protected by ns_hash_lock. FIXME */
415 struct list_head l_lru;
417 /* protected by lr_lock */
418 struct list_head l_res_link; // position in one of three res lists
420 struct list_head l_sl_mode; // skip pointer for request mode
421 struct list_head l_sl_policy; // skip pointer for inodebits
423 struct ldlm_interval *l_tree_node; /* tree node for ldlm_extent */
425 /* protected by led_lock */
426 struct list_head l_export_chain; // per-export chain of locks
428 /* protected by lr_lock */
429 ldlm_mode_t l_req_mode;
430 ldlm_mode_t l_granted_mode;
432 ldlm_completion_callback l_completion_ast;
433 ldlm_blocking_callback l_blocking_ast;
434 ldlm_glimpse_callback l_glimpse_ast;
436 struct obd_export *l_export;
437 struct obd_export *l_conn_export;
439 struct lustre_handle l_remote_handle;
440 ldlm_policy_data_t l_policy_data;
442 /* protected by lr_lock */
448 /* If the lock is granted, a process sleeps on this waitq to learn when
449 * it's no longer in use. If the lock is not granted, a process sleeps
450 * on this waitq to learn when it becomes granted. */
452 struct timeval l_enqueued_time;
454 cfs_time_t l_last_used; /* jiffies */
455 struct ldlm_extent l_req_extent;
457 /* Client-side-only members */
458 __u32 l_lvb_len; /* temporary storage for */
459 void *l_lvb_data; /* an LVB received during */
460 void *l_lvb_swabber; /* an enqueue */
462 spinlock_t l_extents_list_lock;
463 struct list_head l_extents_list;
465 struct list_head l_cache_locks_list;
467 /* Server-side-only members */
469 /* protected by elt_lock */
470 struct list_head l_pending_chain; /* callbacks pending */
471 cfs_time_t l_callback_timeout; /* jiffies */
473 __u32 l_pid; /* pid which created this lock */
475 /* for ldlm_add_ast_work_item() */
476 struct list_head l_bl_ast;
477 struct list_head l_cp_ast;
478 struct ldlm_lock *l_blocking_lock;
482 struct ldlm_resource {
483 struct ldlm_namespace *lr_namespace;
485 /* protected by ns_hash_lock */
486 struct list_head lr_hash;
487 struct ldlm_resource *lr_parent; /* 0 for a root resource */
488 struct list_head lr_children; /* list head for child resources */
489 struct list_head lr_childof; /* part of ns_root_list if root res,
490 * part of lr_children if child */
493 /* protected by lr_lock */
494 struct list_head lr_granted;
495 struct list_head lr_converting;
496 struct list_head lr_waiting;
497 ldlm_mode_t lr_most_restr;
498 ldlm_type_t lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
499 struct ldlm_res_id lr_name;
500 atomic_t lr_refcount;
502 struct ldlm_interval_tree lr_itree[LCK_MODE_NUM]; /* interval trees*/
504 /* Server-side-only lock value block elements */
505 struct semaphore lr_lvb_sem;
509 /* when the resource was considered as contended */
510 cfs_time_t lr_contention_time;
513 struct ldlm_ast_work {
514 struct ldlm_lock *w_lock;
516 struct ldlm_lock_desc w_desc;
517 struct list_head w_list;
523 /* ldlm_enqueue parameters common */
524 struct ldlm_enqueue_info {
525 __u32 ei_type; /* Type of the lock being enqueued. */
526 __u32 ei_mode; /* Mode of the lock being enqueued. */
527 void *ei_cb_bl; /* Different callbacks for lock handling (blocking, */
528 void *ei_cb_cp; /* completion, glimpse) */
530 void *ei_cbdata; /* Data to be passed into callbacks. */
533 extern struct obd_ops ldlm_obd_ops;
535 extern char *ldlm_lockname[];
536 extern char *ldlm_typename[];
537 extern char *ldlm_it2str(int it);
539 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
542 if (((level) & D_CANTMASK) != 0 || \
543 ((libcfs_debug & (level)) != 0 && \
544 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) { \
545 static struct libcfs_debug_msg_data _ldlm_dbg_data = \
546 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM, \
548 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt, \
553 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
554 struct libcfs_debug_msg_data *data, const char *fmt,
556 __attribute__ ((format (printf, 4, 5)));
558 #define LDLM_ERROR(lock, fmt, a...) do { \
559 static cfs_debug_limit_state_t _ldlm_cdls; \
560 ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock, \
561 __FILE__, __FUNCTION__, __LINE__, \
565 #define LDLM_DEBUG(lock, fmt, a...) do { \
566 ldlm_lock_debug(NULL, D_DLMTRACE, lock, \
567 __FILE__, __FUNCTION__, __LINE__, \
571 #define LDLM_DEBUG_NOLOCK(format, a...) \
572 CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
574 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
575 int first_enq, ldlm_error_t *err,
576 struct list_head *work_list);
582 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
583 #define LDLM_ITER_STOP 2 /* stop iterating */
585 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
586 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
588 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
590 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
592 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
593 ldlm_res_iterator_t iter, void *closure);
595 int ldlm_replay_locks(struct obd_import *imp);
596 void ldlm_resource_iterate(struct ldlm_namespace *, struct ldlm_res_id *,
597 ldlm_iterator_t iter, void *data);
600 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
603 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
607 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
608 void *data, int flag);
609 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
610 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
611 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
612 ldlm_blocking_callback, ldlm_glimpse_callback);
613 int ldlm_handle_convert(struct ptlrpc_request *req);
614 int ldlm_handle_cancel(struct ptlrpc_request *req);
615 int ldlm_request_cancel(struct ptlrpc_request *req,
616 struct ldlm_request *dlm_req, int first);
617 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
618 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
619 int ldlm_get_ref(void);
620 void ldlm_put_ref(void);
623 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
624 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
625 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
626 struct ldlm_lock *__ldlm_handle2lock(struct lustre_handle *, int flags);
627 void ldlm_cancel_callback(struct ldlm_lock *);
628 int ldlm_lock_set_data(struct lustre_handle *, void *data);
629 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
630 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
631 struct lustre_handle *);
633 static inline struct ldlm_lock *ldlm_handle2lock(struct lustre_handle *h)
635 return __ldlm_handle2lock(h, 0);
638 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
639 struct lustre_msg *m, int buf_idx,
642 if (res->lr_namespace->ns_lvbo &&
643 res->lr_namespace->ns_lvbo->lvbo_update) {
644 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
650 #define LDLM_LOCK_PUT(lock) \
652 /*LDLM_DEBUG((lock), "put");*/ \
653 ldlm_lock_put(lock); \
656 #define LDLM_LOCK_GET(lock) \
658 ldlm_lock_get(lock); \
659 /*LDLM_DEBUG((lock), "get");*/ \
663 #define ldlm_lock_list_put(head, member, count) \
665 struct ldlm_lock *_lock, *_next; \
667 list_for_each_entry_safe(_lock, _next, head, member) { \
670 list_del_init(&_lock->member); \
671 LDLM_LOCK_PUT(_lock); \
676 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
677 void ldlm_lock_put(struct ldlm_lock *lock);
678 void ldlm_lock_destroy(struct ldlm_lock *lock);
679 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
680 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
681 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
682 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
683 void ldlm_lock_allow_match(struct ldlm_lock *lock);
684 int ldlm_lock_fast_match(struct ldlm_lock *, int, loff_t, loff_t, void **);
685 void ldlm_lock_fast_release(void *, int);
686 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
687 struct ldlm_res_id *, ldlm_type_t type,
688 ldlm_policy_data_t *, ldlm_mode_t mode,
689 struct lustre_handle *);
690 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
692 void ldlm_lock_cancel(struct ldlm_lock *lock);
693 void ldlm_cancel_locks_for_export(struct obd_export *export);
694 void ldlm_reprocess_all(struct ldlm_resource *res);
695 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
696 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
697 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
698 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
701 struct ldlm_namespace *ldlm_namespace_new(char *name, ldlm_side_t client,
702 ldlm_appetite_t apt);
703 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
704 void ldlm_namespace_free(struct ldlm_namespace *ns,
705 struct obd_import *imp, int force);
706 void ldlm_namespace_move(struct ldlm_namespace *ns, ldlm_side_t client);
707 struct ldlm_namespace *ldlm_namespace_first(ldlm_side_t client);
708 void ldlm_namespace_get(struct ldlm_namespace *ns);
709 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
710 void ldlm_namespace_get_nolock(struct ldlm_namespace *ns);
711 void ldlm_namespace_put_nolock(struct ldlm_namespace *ns, int wakeup);
712 int ldlm_proc_setup(void);
714 void ldlm_proc_cleanup(void);
716 static inline void ldlm_proc_cleanup(void) {}
719 /* resource.c - internal */
720 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
721 struct ldlm_resource *parent,
722 struct ldlm_res_id, ldlm_type_t type,
724 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
725 int ldlm_resource_putref(struct ldlm_resource *res);
726 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
727 struct ldlm_lock *lock);
728 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
729 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
730 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
731 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
732 void ldlm_resource_dump(int level, struct ldlm_resource *);
733 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
737 int ldlm_expired_completion_wait(void *data);
738 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
739 void *data, int flag);
740 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
741 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
742 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **req,
743 struct ldlm_enqueue_info *einfo, struct ldlm_res_id res_id,
744 ldlm_policy_data_t *policy, int *flags,
745 void *lvb, __u32 lvb_len, void *lvb_swabber,
746 struct lustre_handle *lockh, int async);
747 struct ptlrpc_request *ldlm_prep_enqueue_req(struct obd_export *exp,
748 int bufcount, int *size,
749 struct list_head *head, int count);
750 struct ptlrpc_request *ldlm_prep_elc_req(struct obd_export *exp, int version,
751 int opc, int bufcount, int *size,
752 int bufoff, int canceloff,
753 struct list_head *cancels, int count);
754 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
755 ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
756 int *flags, void *lvb, __u32 lvb_len,
757 void *lvb_swabber, struct lustre_handle *lockh,
759 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
760 struct ldlm_res_id *res_id,
761 ldlm_type_t type, ldlm_policy_data_t *policy,
762 ldlm_mode_t mode, int *flags,
763 ldlm_blocking_callback blocking,
764 ldlm_completion_callback completion,
765 ldlm_glimpse_callback glimpse,
766 void *data, __u32 lvb_len, void *lvb_swabber,
767 struct lustre_handle *lockh);
768 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
769 void *data, __u32 data_len);
770 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
771 int ldlm_cli_update_pool(struct ptlrpc_request *req);
772 int ldlm_cli_cancel(struct lustre_handle *lockh);
773 int ldlm_cli_cancel_unused(struct ldlm_namespace *, struct ldlm_res_id *,
774 int flags, void *opaque);
775 int ldlm_cli_cancel_req(struct obd_export *exp,
776 struct list_head *head, int count);
777 int ldlm_cli_join_lru(struct ldlm_namespace *, struct ldlm_res_id *, int join);
778 int ldlm_cancel_resource_local(struct ldlm_resource *res,
779 struct list_head *cancels,
780 ldlm_policy_data_t *policy, ldlm_mode_t mode,
781 int lock_flags, int cancel_flags, void *opaque);
782 int ldlm_cli_cancel_list(struct list_head *head, int count,
783 struct ptlrpc_request *req, int off);
785 /* This has to be here because recursive inclusion sucks. */
786 int intent_disposition(struct ldlm_reply *rep, int flag);
787 void intent_set_disposition(struct ldlm_reply *rep, int flag);
790 /* ioctls for trying requests */
791 #define IOC_LDLM_TYPE 'f'
792 #define IOC_LDLM_MIN_NR 40
794 #define IOC_LDLM_TEST _IOWR('f', 40, long)
795 #define IOC_LDLM_DUMP _IOWR('f', 41, long)
796 #define IOC_LDLM_REGRESS_START _IOWR('f', 42, long)
797 #define IOC_LDLM_REGRESS_STOP _IOWR('f', 43, long)
798 #define IOC_LDLM_MAX_NR 43
800 static inline void lock_res(struct ldlm_resource *res)
802 spin_lock(&res->lr_lock);
805 static inline void unlock_res(struct ldlm_resource *res)
807 spin_unlock(&res->lr_lock);
810 static inline void check_res_locked(struct ldlm_resource *res)
812 LASSERT_SPIN_LOCKED(&res->lr_lock);
815 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
816 void unlock_res_and_lock(struct ldlm_lock *lock);
819 void ldlm_pools_recalc(ldlm_side_t client);
820 int ldlm_pools_init(void);
821 void ldlm_pools_fini(void);
822 void ldlm_pools_wakeup(void);
824 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
825 int idx, ldlm_side_t client);
826 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
827 unsigned int gfp_mask);
828 void ldlm_pool_fini(struct ldlm_pool *pl);
829 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
830 int ldlm_pool_recalc(struct ldlm_pool *pl);
831 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
832 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
833 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
834 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
835 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
836 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);