4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2010, 2012, Whamcloud, Inc.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #ifndef _LUSTRE_DLM_H__
38 #define _LUSTRE_DLM_H__
40 /** \defgroup ldlm ldlm
45 #if defined(__linux__)
46 #include <linux/lustre_dlm.h>
47 #elif defined(__APPLE__)
48 #include <darwin/lustre_dlm.h>
49 #elif defined(__WINNT__)
50 #include <winnt/lustre_dlm.h>
52 #error Unsupported operating system.
55 #include <lustre_lib.h>
56 #include <lustre_net.h>
57 #include <lustre_import.h>
58 #include <lustre_handles.h>
59 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
65 #define OBD_LDLM_DEVICENAME "ldlm"
67 #ifdef HAVE_BGL_SUPPORT
68 /* 1.5 times the maximum 128 tasks available in VN mode */
69 #define LDLM_DEFAULT_LRU_SIZE 196
71 #define LDLM_DEFAULT_LRU_SIZE (100 * cfs_num_online_cpus())
73 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
74 #define LDLM_CTIME_AGE_LIMIT (10)
75 #define LDLM_DEFAULT_PARALLEL_AST_LIMIT 1024
80 ELDLM_LOCK_CHANGED = 300,
81 ELDLM_LOCK_ABORTED = 301,
82 ELDLM_LOCK_REPLACED = 302,
83 ELDLM_NO_LOCK_DATA = 303,
85 ELDLM_NAMESPACE_EXISTS = 400,
86 ELDLM_BAD_NAMESPACE = 401
90 LDLM_NAMESPACE_SERVER = 1 << 0,
91 LDLM_NAMESPACE_CLIENT = 1 << 1
94 #define LDLM_FL_LOCK_CHANGED 0x000001 /* extent, mode, or resource changed */
96 /* If the server returns one of these flags, then the lock was put on that list.
97 * If the client sends one of these flags (during recovery ONLY!), it wants the
98 * lock added to the specified list, no questions asked. -p */
99 #define LDLM_FL_BLOCK_GRANTED 0x000002
100 #define LDLM_FL_BLOCK_CONV 0x000004
101 #define LDLM_FL_BLOCK_WAIT 0x000008
103 #define LDLM_FL_CBPENDING 0x000010 /* this lock is being destroyed */
104 #define LDLM_FL_AST_SENT 0x000020 /* blocking or cancel packet was
105 * queued for sending. */
106 #define LDLM_FL_WAIT_NOREPROC 0x000040 /* not a real flag, not saved in lock */
107 #define LDLM_FL_CANCEL 0x000080 /* cancellation callback already run */
109 /* Lock is being replayed. This could probably be implied by the fact that one
110 * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
111 #define LDLM_FL_REPLAY 0x000100
113 #define LDLM_FL_INTENT_ONLY 0x000200 /* don't grant lock, just do intent */
114 #define LDLM_FL_LOCAL_ONLY 0x000400
116 /* don't run the cancel callback under ldlm_cli_cancel_unused */
117 #define LDLM_FL_FAILED 0x000800
119 #define LDLM_FL_HAS_INTENT 0x001000 /* lock request has intent */
120 #define LDLM_FL_CANCELING 0x002000 /* lock cancel has already been sent */
121 #define LDLM_FL_LOCAL 0x004000 /* local lock (ie, no srv/cli split) */
122 #define LDLM_FL_DISCARD_DATA 0x010000 /* discard (no writeback) on cancel */
124 #define LDLM_FL_NO_TIMEOUT 0x020000 /* Blocked by group lock - wait
127 /* file & record locking */
128 #define LDLM_FL_BLOCK_NOWAIT 0x040000 /* server told not to wait if blocked.
129 * For AGL, OST will not send glimpse
131 #define LDLM_FL_TEST_LOCK 0x080000 // return blocking lock
133 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
134 * the LVB filling happens _after_ the lock has been granted, so another thread
135 * can match`t before the LVB has been updated. As a dirty hack, we set
136 * LDLM_FL_LVB_READY only after we've done the LVB poop.
137 * this is only needed on lov/osc now, where lvb is actually used and callers
138 * must set it in input flags.
140 * The proper fix is to do the granting inside of the completion AST, which can
141 * be replaced with a LVB-aware wrapping function for OSC locks. That change is
142 * pretty high-risk, though, and would need a lot more testing. */
144 #define LDLM_FL_LVB_READY 0x100000
146 /* A lock contributes to the kms calculation until it has finished the part
147 * of it's cancelation that performs write back on its dirty pages. It
148 * can remain on the granted list during this whole time. Threads racing
149 * to update the kms after performing their writeback need to know to
150 * exclude each others locks from the calculation as they walk the granted
152 #define LDLM_FL_KMS_IGNORE 0x200000
154 /* Don't put lock into the LRU list, so that it is not canceled due to aging.
155 * Used by MGC locks, they are cancelled only at unmount or by callback. */
156 #define LDLM_FL_NO_LRU 0x400000
158 /* Immediatelly cancel such locks when they block some other locks. Send
159 * cancel notification to original lock holder, but expect no reply. This is
160 * for clients (like liblustre) that cannot be expected to reliably response
161 * to blocking ast. */
162 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
164 /* Flags flags inherited from parent lock when doing intents. */
165 #define LDLM_INHERIT_FLAGS (LDLM_FL_CANCEL_ON_BLOCK)
167 /* completion ast to be executed */
168 #define LDLM_FL_CP_REQD 0x1000000
170 /* cleanup_resource has already handled the lock */
171 #define LDLM_FL_CLEANED 0x2000000
173 /* optimization hint: LDLM can run blocking callback from current context
174 * w/o involving separate thread. in order to decrease cs rate */
175 #define LDLM_FL_ATOMIC_CB 0x4000000
177 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
178 * such that server send blocking ast for conflict locks to this client for
179 * the 1st operation, whereas the 2nd operation has canceled this lock and
180 * is waiting for rpc_lock which is taken by the 1st operation.
181 * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
182 * ELC code to cancel it.
183 * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
184 * droped to let ldlm_callback_handler() return EINVAL to the server. It is
185 * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
186 * to send a separate CANCEL rpc. */
187 #define LDLM_FL_BL_AST 0x10000000
188 #define LDLM_FL_BL_DONE 0x20000000
190 /* measure lock contention and return -EUSERS if locking contention is high */
191 #define LDLM_FL_DENY_ON_CONTENTION 0x40000000
193 /* These are flags that are mapped into the flags and ASTs of blocking locks */
194 #define LDLM_AST_DISCARD_DATA 0x80000000 /* Add FL_DISCARD to blocking ASTs */
196 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
197 #define LDLM_AST_FLAGS (LDLM_FL_DISCARD_DATA)
200 * --------------------------------------------------------------------------
201 * NOTE! Starting from this point, that is, LDLM_FL_* flags with values above
202 * 0x80000000 will not be sent over the wire.
203 * --------------------------------------------------------------------------
206 /* Used for marking lock as an target for -EINTR while cp_ast sleep
207 * emulation + race with upcoming bl_ast. */
208 #define LDLM_FL_FAIL_LOC 0x100000000ULL
210 /* Used while processing the unused list to know that we have already
211 * handled this lock and decided to skip it */
212 #define LDLM_FL_SKIPPED 0x200000000ULL
214 /* The blocking callback is overloaded to perform two functions. These flags
215 * indicate which operation should be performed. */
216 #define LDLM_CB_BLOCKING 1
217 #define LDLM_CB_CANCELING 2
219 /* compatibility matrix */
220 #define LCK_COMPAT_EX LCK_NL
221 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
222 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
223 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
224 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
225 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
226 #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL)
227 #define LCK_COMPAT_COS (LCK_COS)
229 extern ldlm_mode_t lck_compat_array[];
231 static inline void lockmode_verify(ldlm_mode_t mode)
233 LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
236 static inline int lockmode_compat(ldlm_mode_t exist_mode, ldlm_mode_t new_mode)
238 return (lck_compat_array[exist_mode] & new_mode);
243 * cluster name spaces
247 #define DLM_OST_NAMESPACE 1
248 #define DLM_MDS_NAMESPACE 2
251 - do we just separate this by security domains and use a prefix for
252 multiple namespaces in the same domain?
262 * waiting_locks_spinlock
277 struct ldlm_resource;
278 struct ldlm_namespace;
280 struct ldlm_pool_ops {
281 int (*po_recalc)(struct ldlm_pool *pl);
282 int (*po_shrink)(struct ldlm_pool *pl, int nr,
283 unsigned int gfp_mask);
284 int (*po_setup)(struct ldlm_pool *pl, int limit);
288 * One second for pools thread check interval. Each pool has own period.
290 #define LDLM_POOLS_THREAD_PERIOD (1)
293 * ~6% margin for modest pools. See ldlm_pool.c for details.
295 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
298 * Default recalc period for server side pools in sec.
300 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
303 * Default recalc period for client side pools in sec.
305 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
309 * Pool proc directory.
311 cfs_proc_dir_entry_t *pl_proc_dir;
313 * Pool name, should be long enough to contain compound proc entry name.
317 * Lock for protecting slv/clv updates.
319 cfs_spinlock_t pl_lock;
321 * Number of allowed locks in in pool, both, client and server side.
323 cfs_atomic_t pl_limit;
325 * Number of granted locks in
327 cfs_atomic_t pl_granted;
331 cfs_atomic_t pl_grant_rate;
335 cfs_atomic_t pl_cancel_rate;
337 * Server lock volume. Protected by pl_lock.
339 __u64 pl_server_lock_volume;
341 * Current biggest client lock volume. Protected by pl_lock.
343 __u64 pl_client_lock_volume;
345 * Lock volume factor. SLV on client is calculated as following:
346 * server_slv * lock_volume_factor.
348 cfs_atomic_t pl_lock_volume_factor;
350 * Time when last slv from server was obtained.
352 time_t pl_recalc_time;
354 * Recalc period for pool.
356 time_t pl_recalc_period;
358 * Recalc and shrink ops.
360 struct ldlm_pool_ops *pl_ops;
362 * Number of planned locks for next period.
368 struct lprocfs_stats *pl_stats;
371 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
372 void *req_cookie, ldlm_mode_t mode, int flags,
375 typedef int (*ldlm_cancel_for_recovery)(struct ldlm_lock *lock);
377 struct ldlm_valblock_ops {
378 int (*lvbo_init)(struct ldlm_resource *res);
379 int (*lvbo_update)(struct ldlm_resource *res,
380 struct ptlrpc_request *r,
382 int (*lvbo_free)(struct ldlm_resource *res);
386 LDLM_NAMESPACE_GREEDY = 1 << 0,
387 LDLM_NAMESPACE_MODEST = 1 << 1
391 * Default values for the "max_nolock_size", "contention_time" and
392 * "contended_locks" namespace tunables.
394 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
395 #define NS_DEFAULT_CONTENTION_SECONDS 2
396 #define NS_DEFAULT_CONTENDED_LOCKS 32
398 struct ldlm_ns_bucket {
400 struct ldlm_namespace *nsb_namespace;
401 /** estimated lock callback time */
402 struct adaptive_timeout nsb_at_estimate;
406 /** ldlm namespace lock stats */
413 LDLM_NS_TYPE_UNKNOWN = 0,
428 struct ldlm_namespace {
430 * Backward link to obd, required for ldlm pool to store new SLV.
432 struct obd_device *ns_obd;
435 * Is this a client-side lock tree?
437 ldlm_side_t ns_client;
442 cfs_hash_t *ns_rs_hash;
447 cfs_spinlock_t ns_lock;
450 * big refcount (by bucket)
452 cfs_atomic_t ns_bref;
455 * Namespce connect flags supported by server (may be changed via proc,
456 * lru resize may be disabled/enabled).
458 __u64 ns_connect_flags;
461 * Client side orig connect flags supported by server.
463 __u64 ns_orig_connect_flags;
466 * Position in global namespace list.
468 cfs_list_t ns_list_chain;
471 * All root resources in namespace.
473 cfs_list_t ns_unused_list;
476 unsigned int ns_max_unused;
477 unsigned int ns_max_age;
478 unsigned int ns_timeouts;
482 unsigned int ns_ctime_age_limit;
485 * Next debug dump, jiffies.
487 cfs_time_t ns_next_dump;
489 ldlm_res_policy ns_policy;
490 struct ldlm_valblock_ops *ns_lvbo;
492 cfs_waitq_t ns_waitq;
493 struct ldlm_pool ns_pool;
494 ldlm_appetite_t ns_appetite;
497 * If more than \a ns_contended_locks found, the resource is considered
500 unsigned ns_contended_locks;
503 * The resource remembers contended state during \a ns_contention_time,
506 unsigned ns_contention_time;
509 * Limit size of nolock requests, in bytes.
511 unsigned ns_max_nolock_size;
514 * Limit of parallel AST RPC count.
516 unsigned ns_max_parallel_ast;
518 /* callback to cancel locks before replaying it during recovery */
519 ldlm_cancel_for_recovery ns_cancel_for_recovery;
523 struct lprocfs_stats *ns_stats;
525 unsigned ns_stopping:1; /* namespace cleanup */
528 static inline int ns_is_client(struct ldlm_namespace *ns)
531 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
532 LDLM_NAMESPACE_SERVER)));
533 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
534 ns->ns_client == LDLM_NAMESPACE_SERVER);
535 return ns->ns_client == LDLM_NAMESPACE_CLIENT;
538 static inline int ns_is_server(struct ldlm_namespace *ns)
541 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
542 LDLM_NAMESPACE_SERVER)));
543 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
544 ns->ns_client == LDLM_NAMESPACE_SERVER);
545 return ns->ns_client == LDLM_NAMESPACE_SERVER;
548 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
551 return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
554 static inline void ns_register_cancel(struct ldlm_namespace *ns,
555 ldlm_cancel_for_recovery arg)
558 ns->ns_cancel_for_recovery = arg;
563 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
564 struct ldlm_lock_desc *new, void *data,
566 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
568 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
569 typedef unsigned long (*ldlm_weigh_callback)(struct ldlm_lock *lock);
571 /* Interval node data for each LDLM_EXTENT lock */
572 struct ldlm_interval {
573 struct interval_node li_node; /* node for tree mgmt */
574 cfs_list_t li_group; /* the locks which have the same
575 * policy - group of the policy */
577 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
579 /* the interval tree must be accessed inside the resource lock. */
580 struct ldlm_interval_tree {
581 /* tree size, this variable is used to count
582 * granted PW locks in ldlm_extent_policy()*/
584 ldlm_mode_t lit_mode; /* lock mode */
585 struct interval_node *lit_root; /* actually ldlm_interval */
588 #define LUSTRE_TRACKS_LOCK_EXP_REFS (1)
592 LCF_ASYNC = 0x1, /* Cancel locks asynchronously. */
593 LCF_LOCAL = 0x2, /* Cancel locks locally, not notifing server */
594 LCF_BL_AST = 0x4, /* Cancel locks marked as LDLM_FL_BL_AST
596 } ldlm_cancel_flags_t;
602 __u64 blocking_owner;
603 struct obd_export *blocking_export;
608 struct ldlm_extent l_extent;
609 struct ldlm_flock l_flock;
610 struct ldlm_inodebits l_inodebits;
611 } ldlm_policy_data_t;
613 void ldlm_convert_policy_to_wire(ldlm_type_t type,
614 const ldlm_policy_data_t *lpolicy,
615 ldlm_wire_policy_data_t *wpolicy);
616 void ldlm_convert_policy_to_local(struct obd_export *exp, ldlm_type_t type,
617 const ldlm_wire_policy_data_t *wpolicy,
618 ldlm_policy_data_t *lpolicy);
622 * Must be first in the structure.
624 struct portals_handle l_handle;
626 * Lock reference count.
630 * Internal spinlock protects l_resource. we should hold this lock
631 * first before grabbing res_lock.
633 cfs_spinlock_t l_lock;
635 * ldlm_lock_change_resource() can change this.
637 struct ldlm_resource *l_resource;
639 * Protected by ns_hash_lock. List item for client side lru list.
643 * Protected by lr_lock, linkage to resource's lock queues.
645 cfs_list_t l_res_link;
647 * Tree node for ldlm_extent.
649 struct ldlm_interval *l_tree_node;
651 * Protected by per-bucket exp->exp_lock_hash locks. Per export hash
654 cfs_hlist_node_t l_exp_hash;
656 * Protected by lr_lock. Requested mode.
658 ldlm_mode_t l_req_mode;
660 * Granted mode, also protected by lr_lock.
662 ldlm_mode_t l_granted_mode;
664 * Lock enqueue completion handler.
666 ldlm_completion_callback l_completion_ast;
668 * Lock blocking ast handler.
670 ldlm_blocking_callback l_blocking_ast;
672 * Lock glimpse handler.
674 ldlm_glimpse_callback l_glimpse_ast;
675 ldlm_weigh_callback l_weigh_ast;
680 struct obd_export *l_export;
682 * Lock connection export.
684 struct obd_export *l_conn_export;
687 * Remote lock handle.
689 struct lustre_handle l_remote_handle;
691 ldlm_policy_data_t l_policy_data;
694 * Protected by lr_lock. Various counters: readers, writers, etc.
700 * If the lock is granted, a process sleeps on this waitq to learn when
701 * it's no longer in use. If the lock is not granted, a process sleeps
702 * on this waitq to learn when it becomes granted.
707 * Seconds. it will be updated if there is any activity related to
708 * the lock, e.g. enqueue the lock or send block AST.
710 cfs_time_t l_last_activity;
713 * Jiffies. Should be converted to time if needed.
715 cfs_time_t l_last_used;
717 struct ldlm_extent l_req_extent;
719 unsigned int l_failed:1,
721 * Set for locks that were removed from class hash table and will be
722 * destroyed when last reference to them is released. Set by
723 * ldlm_lock_destroy_internal().
725 * Protected by lock and resource locks.
729 * flag whether this is a server namespace lock.
734 * Client-side-only members.
738 * Temporary storage for an LVB received during an enqueue operation.
746 * Server-side-only members.
749 /** connection cookie for the client originated the operation. */
750 __u64 l_client_cookie;
753 * Protected by elt_lock. Callbacks pending.
755 cfs_list_t l_pending_chain;
757 cfs_time_t l_callback_timeout;
760 * Pid which created this lock.
766 * For ldlm_add_ast_work_item().
770 * For ldlm_add_ast_work_item().
774 * For ldlm_add_ast_work_item().
778 struct ldlm_lock *l_blocking_lock;
781 * Protected by lr_lock, linkages to "skip lists".
783 cfs_list_t l_sl_mode;
784 cfs_list_t l_sl_policy;
785 struct lu_ref l_reference;
786 #if LUSTRE_TRACKS_LOCK_EXP_REFS
787 /* Debugging stuff for bug 20498, for tracking export
789 /** number of export references taken */
791 /** link all locks referencing one export */
792 cfs_list_t l_exp_refs_link;
793 /** referenced export object */
794 struct obd_export *l_exp_refs_target;
796 /** export blocking dlm lock list, protected by
797 * l_export->exp_bl_list_lock.
798 * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
799 * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock. */
800 cfs_list_t l_exp_list;
803 struct ldlm_resource {
804 struct ldlm_ns_bucket *lr_ns_bucket;
806 /* protected by ns_hash_lock */
807 cfs_hlist_node_t lr_hash;
808 cfs_spinlock_t lr_lock;
810 /* protected by lr_lock */
811 cfs_list_t lr_granted;
812 cfs_list_t lr_converting;
813 cfs_list_t lr_waiting;
814 ldlm_mode_t lr_most_restr;
815 ldlm_type_t lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
816 struct ldlm_res_id lr_name;
817 cfs_atomic_t lr_refcount;
819 struct ldlm_interval_tree lr_itree[LCK_MODE_NUM]; /* interval trees*/
821 /* Server-side-only lock value block elements */
822 /** to serialize lvbo_init */
823 cfs_mutex_t lr_lvb_mutex;
825 /** protect by lr_lock */
828 /* when the resource was considered as contended */
829 cfs_time_t lr_contention_time;
831 * List of references to this resource. For debugging.
833 struct lu_ref lr_reference;
835 struct inode *lr_lvb_inode;
839 ldlm_ns_name(struct ldlm_namespace *ns)
841 return ns->ns_rs_hash->hs_name;
844 static inline struct ldlm_namespace *
845 ldlm_res_to_ns(struct ldlm_resource *res)
847 return res->lr_ns_bucket->nsb_namespace;
850 static inline struct ldlm_namespace *
851 ldlm_lock_to_ns(struct ldlm_lock *lock)
853 return ldlm_res_to_ns(lock->l_resource);
857 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
859 return ldlm_ns_name(ldlm_lock_to_ns(lock));
862 static inline struct adaptive_timeout *
863 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
865 return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
868 struct ldlm_ast_work {
869 struct ldlm_lock *w_lock;
871 struct ldlm_lock_desc w_desc;
878 /* ldlm_enqueue parameters common */
879 struct ldlm_enqueue_info {
880 __u32 ei_type; /* Type of the lock being enqueued. */
881 __u32 ei_mode; /* Mode of the lock being enqueued. */
882 void *ei_cb_bl; /* blocking lock callback */
883 void *ei_cb_cp; /* lock completion callback */
884 void *ei_cb_gl; /* lock glimpse callback */
885 void *ei_cb_wg; /* lock weigh callback */
886 void *ei_cbdata; /* Data to be passed into callbacks. */
889 extern struct obd_ops ldlm_obd_ops;
891 extern char *ldlm_lockname[];
892 extern char *ldlm_typename[];
893 extern char *ldlm_it2str(int it);
895 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do { \
896 CFS_CHECK_STACK(msgdata, mask, cdls); \
898 if (((mask) & D_CANTMASK) != 0 || \
899 ((libcfs_debug & (mask)) != 0 && \
900 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
901 _ldlm_lock_debug(lock, msgdata, fmt, ##a); \
904 void _ldlm_lock_debug(struct ldlm_lock *lock,
905 struct libcfs_debug_msg_data *data,
906 const char *fmt, ...)
907 __attribute__ ((format (printf, 3, 4)));
909 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do { \
910 static cfs_debug_limit_state_t _ldlm_cdls; \
911 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls); \
912 ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
915 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
916 #define LDLM_WARN(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
918 #define LDLM_DEBUG(lock, fmt, a...) do { \
919 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL); \
920 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock, "### " fmt , ##a);\
922 #else /* !LIBCFS_DEBUG */
923 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
924 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
925 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
928 #define LDLM_DEBUG_NOLOCK(format, a...) \
929 CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
931 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
932 int first_enq, ldlm_error_t *err,
933 cfs_list_t *work_list);
939 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
940 #define LDLM_ITER_STOP 2 /* stop iterating */
942 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
943 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
945 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
947 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
950 int ldlm_replay_locks(struct obd_import *imp);
951 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
952 ldlm_iterator_t iter, void *data);
955 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
958 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
960 struct ldlm_callback_suite {
961 ldlm_completion_callback lcs_completion;
962 ldlm_blocking_callback lcs_blocking;
963 ldlm_glimpse_callback lcs_glimpse;
964 ldlm_weigh_callback lcs_weigh;
968 #ifdef HAVE_SERVER_SUPPORT
969 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
970 void *data, int flag);
971 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
972 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
973 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
974 ldlm_blocking_callback, ldlm_glimpse_callback);
975 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
976 const struct ldlm_request *dlm_req,
977 const struct ldlm_callback_suite *cbs);
978 int ldlm_handle_convert(struct ptlrpc_request *req);
979 int ldlm_handle_convert0(struct ptlrpc_request *req,
980 const struct ldlm_request *dlm_req);
981 int ldlm_handle_cancel(struct ptlrpc_request *req);
982 int ldlm_request_cancel(struct ptlrpc_request *req,
983 const struct ldlm_request *dlm_req, int first);
984 void ldlm_revoke_export_locks(struct obd_export *exp);
986 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
987 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
988 int ldlm_get_ref(void);
989 void ldlm_put_ref(void);
990 int ldlm_init_export(struct obd_export *exp);
991 void ldlm_destroy_export(struct obd_export *exp);
994 #ifdef HAVE_SERVER_SUPPORT
995 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
997 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
998 void ldlm_lock2handle(const struct ldlm_lock *lock,
999 struct lustre_handle *lockh);
1000 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
1001 void ldlm_cancel_callback(struct ldlm_lock *);
1002 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1003 int ldlm_lock_set_data(struct lustre_handle *, void *);
1005 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1007 return __ldlm_handle2lock(h, 0);
1010 #define LDLM_LOCK_REF_DEL(lock) \
1011 lu_ref_del(&lock->l_reference, "handle", cfs_current())
1013 static inline struct ldlm_lock *
1014 ldlm_handle2lock_long(const struct lustre_handle *h, int flags)
1016 struct ldlm_lock *lock;
1018 lock = __ldlm_handle2lock(h, flags);
1020 LDLM_LOCK_REF_DEL(lock);
1024 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1025 struct ptlrpc_request *r, int increase)
1027 if (ldlm_res_to_ns(res)->ns_lvbo &&
1028 ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
1029 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, r,
1035 int ldlm_error2errno(ldlm_error_t error);
1036 ldlm_error_t ldlm_errno2error(int err_no); /* don't call it `errno': this
1037 * confuses user-space. */
1038 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1039 void ldlm_dump_export_locks(struct obd_export *exp);
1043 * Release a temporary lock reference obtained by ldlm_handle2lock() or
1044 * __ldlm_handle2lock().
1046 #define LDLM_LOCK_PUT(lock) \
1048 LDLM_LOCK_REF_DEL(lock); \
1049 /*LDLM_DEBUG((lock), "put");*/ \
1050 ldlm_lock_put(lock); \
1054 * Release a lock reference obtained by some other means (see
1057 #define LDLM_LOCK_RELEASE(lock) \
1059 /*LDLM_DEBUG((lock), "put");*/ \
1060 ldlm_lock_put(lock); \
1063 #define LDLM_LOCK_GET(lock) \
1065 ldlm_lock_get(lock); \
1066 /*LDLM_DEBUG((lock), "get");*/ \
1070 #define ldlm_lock_list_put(head, member, count) \
1072 struct ldlm_lock *_lock, *_next; \
1074 cfs_list_for_each_entry_safe(_lock, _next, head, member) { \
1077 cfs_list_del_init(&_lock->member); \
1078 LDLM_LOCK_RELEASE(_lock); \
1083 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1084 void ldlm_lock_put(struct ldlm_lock *lock);
1085 void ldlm_lock_destroy(struct ldlm_lock *lock);
1086 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1087 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
1088 int ldlm_lock_addref_try(struct lustre_handle *lockh, __u32 mode);
1089 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
1090 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
1091 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1092 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1093 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1094 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1095 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
1096 const struct ldlm_res_id *, ldlm_type_t type,
1097 ldlm_policy_data_t *, ldlm_mode_t mode,
1098 struct lustre_handle *, int unref);
1099 ldlm_mode_t ldlm_revalidate_lock_handle(struct lustre_handle *lockh,
1101 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
1103 void ldlm_lock_downgrade(struct ldlm_lock *lock, int new_mode);
1104 void ldlm_lock_cancel(struct ldlm_lock *lock);
1105 void ldlm_reprocess_all(struct ldlm_resource *res);
1106 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1107 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
1108 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1111 struct ldlm_namespace *
1112 ldlm_namespace_new(struct obd_device *obd, char *name,
1113 ldlm_side_t client, ldlm_appetite_t apt,
1114 ldlm_ns_type_t ns_type);
1115 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
1116 void ldlm_namespace_free(struct ldlm_namespace *ns,
1117 struct obd_import *imp, int force);
1118 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
1119 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
1120 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
1121 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
1122 void ldlm_namespace_get(struct ldlm_namespace *ns);
1123 void ldlm_namespace_put(struct ldlm_namespace *ns);
1124 int ldlm_proc_setup(void);
1126 void ldlm_proc_cleanup(void);
1128 static inline void ldlm_proc_cleanup(void) {}
1131 /* resource.c - internal */
1132 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1133 struct ldlm_resource *parent,
1134 const struct ldlm_res_id *,
1135 ldlm_type_t type, int create);
1136 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1137 int ldlm_resource_putref(struct ldlm_resource *res);
1138 void ldlm_resource_add_lock(struct ldlm_resource *res,
1140 struct ldlm_lock *lock);
1141 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1142 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1143 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
1144 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1145 void ldlm_resource_dump(int level, struct ldlm_resource *);
1146 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1147 const struct ldlm_res_id *);
1149 #define LDLM_RESOURCE_ADDREF(res) do { \
1150 lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, cfs_current()); \
1153 #define LDLM_RESOURCE_DELREF(res) do { \
1154 lu_ref_del(&(res)->lr_reference, __FUNCTION__, cfs_current()); \
1157 /* ldlm_request.c */
1158 int ldlm_expired_completion_wait(void *data);
1159 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1160 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1161 void *data, int flag);
1162 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1163 int ldlm_completion_ast_async(struct ldlm_lock *lock, int flags, void *data);
1164 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
1165 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1166 struct ldlm_enqueue_info *einfo,
1167 const struct ldlm_res_id *res_id,
1168 ldlm_policy_data_t const *policy, int *flags,
1169 void *lvb, __u32 lvb_len, struct lustre_handle *lockh,
1171 int ldlm_prep_enqueue_req(struct obd_export *exp,
1172 struct ptlrpc_request *req,
1173 cfs_list_t *cancels,
1175 int ldlm_prep_elc_req(struct obd_export *exp,
1176 struct ptlrpc_request *req,
1177 int version, int opc, int canceloff,
1178 cfs_list_t *cancels, int count);
1179 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1180 ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
1181 int *flags, void *lvb, __u32 lvb_len,
1182 struct lustre_handle *lockh, int rc);
1183 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1184 const struct ldlm_res_id *res_id,
1185 ldlm_type_t type, ldlm_policy_data_t *policy,
1186 ldlm_mode_t mode, int *flags,
1187 ldlm_blocking_callback blocking,
1188 ldlm_completion_callback completion,
1189 ldlm_glimpse_callback glimpse,
1190 void *data, __u32 lvb_len,
1191 const __u64 *client_cookie,
1192 struct lustre_handle *lockh);
1193 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
1194 void *data, __u32 data_len);
1195 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
1196 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1197 int ldlm_cli_cancel(struct lustre_handle *lockh);
1198 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1199 ldlm_cancel_flags_t flags, void *opaque);
1200 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1201 const struct ldlm_res_id *res_id,
1202 ldlm_policy_data_t *policy,
1204 ldlm_cancel_flags_t flags,
1206 int ldlm_cli_cancel_req(struct obd_export *exp, cfs_list_t *head,
1207 int count, ldlm_cancel_flags_t flags);
1208 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1209 cfs_list_t *cancels,
1210 ldlm_policy_data_t *policy,
1211 ldlm_mode_t mode, int lock_flags,
1212 ldlm_cancel_flags_t cancel_flags, void *opaque);
1213 int ldlm_cli_cancel_list_local(cfs_list_t *cancels, int count,
1214 ldlm_cancel_flags_t flags);
1215 int ldlm_cli_cancel_list(cfs_list_t *head, int count,
1216 struct ptlrpc_request *req, ldlm_cancel_flags_t flags);
1219 /* This has to be here because recursive inclusion sucks. */
1220 int intent_disposition(struct ldlm_reply *rep, int flag);
1221 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1224 /* ioctls for trying requests */
1225 #define IOC_LDLM_TYPE 'f'
1226 #define IOC_LDLM_MIN_NR 40
1228 #define IOC_LDLM_TEST _IOWR('f', 40, long)
1229 #define IOC_LDLM_DUMP _IOWR('f', 41, long)
1230 #define IOC_LDLM_REGRESS_START _IOWR('f', 42, long)
1231 #define IOC_LDLM_REGRESS_STOP _IOWR('f', 43, long)
1232 #define IOC_LDLM_MAX_NR 43
1235 * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1236 * than one lock_res is dead-lock safe.
1238 enum lock_res_type {
1243 static inline void lock_res(struct ldlm_resource *res)
1245 cfs_spin_lock(&res->lr_lock);
1248 static inline void lock_res_nested(struct ldlm_resource *res,
1249 enum lock_res_type mode)
1251 cfs_spin_lock_nested(&res->lr_lock, mode);
1254 static inline void unlock_res(struct ldlm_resource *res)
1256 cfs_spin_unlock(&res->lr_lock);
1259 static inline void check_res_locked(struct ldlm_resource *res)
1261 LASSERT_SPIN_LOCKED(&res->lr_lock);
1264 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1265 void unlock_res_and_lock(struct ldlm_lock *lock);
1268 void ldlm_pools_recalc(ldlm_side_t client);
1269 int ldlm_pools_init(void);
1270 void ldlm_pools_fini(void);
1272 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1273 int idx, ldlm_side_t client);
1274 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
1275 unsigned int gfp_mask);
1276 void ldlm_pool_fini(struct ldlm_pool *pl);
1277 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1278 int ldlm_pool_recalc(struct ldlm_pool *pl);
1279 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1280 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1281 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1282 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1283 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1284 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1285 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1286 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1287 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);