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.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2010, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 /** \defgroup LDLM Lustre Distributed Lock Manager
34 * Lustre DLM is based on VAX DLM.
35 * Its two main roles are:
36 * - To provide locking assuring consistency of data on all Lustre nodes.
37 * - To allow clients to cache state protected by a lock by holding the
38 * lock until a conflicting lock is requested or it is expired by the LRU.
43 #ifndef _LUSTRE_DLM_H__
44 #define _LUSTRE_DLM_H__
46 #include <lustre_lib.h>
47 #include <lustre_net.h>
48 #include <lustre_import.h>
49 #include <lustre_handles.h>
50 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
53 #include "lustre_dlm_flags.h"
58 extern struct kset *ldlm_ns_kset;
59 extern struct kset *ldlm_svc_kset;
61 #define OBD_LDLM_DEVICENAME "ldlm"
63 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
64 #define LDLM_DEFAULT_MAX_ALIVE 3900 /* 3900 seconds ~65 min */
65 #define LDLM_CTIME_AGE_LIMIT (10)
66 /* if client lock is unused for that time it can be cancelled if any other
67 * client shows interest in that lock, e.g. glimpse is occured. */
68 #define LDLM_DIRTY_AGE_LIMIT (10)
69 #define LDLM_DEFAULT_PARALLEL_AST_LIMIT 1024
70 #define LDLM_DEFAULT_LRU_SHRINK_BATCH (16)
71 #define LDLM_DEFAULT_SLV_RECALC_PCT (10)
74 * LDLM non-error return states
78 ELDLM_LOCK_MATCHED = 1,
80 ELDLM_LOCK_CHANGED = 300,
81 ELDLM_LOCK_ABORTED = 301,
82 ELDLM_LOCK_REPLACED = 302,
83 ELDLM_NO_LOCK_DATA = 303,
84 ELDLM_LOCK_WOULDBLOCK = 304,
86 ELDLM_NAMESPACE_EXISTS = 400,
87 ELDLM_BAD_NAMESPACE = 401,
91 * LDLM namespace type.
92 * The "client" type is actually an indication that this is a narrow local view
93 * into complete namespace on the server. Such namespaces cannot make any
94 * decisions about lack of conflicts or do any autonomous lock granting without
95 * first speaking to a server.
98 LDLM_NAMESPACE_SERVER = 0x01,
99 LDLM_NAMESPACE_CLIENT = 0x02
103 * The blocking callback is overloaded to perform two functions. These flags
104 * indicate which operation should be performed.
106 #define LDLM_CB_BLOCKING 1
107 #define LDLM_CB_CANCELING 2
110 * \name Lock Compatibility Matrix.
112 * A lock has both a type (extent, flock, inode bits, or plain) and a mode.
113 * Lock types are described in their respective implementation files:
114 * ldlm_{extent,flock,inodebits,plain}.c.
116 * There are six lock modes along with a compatibility matrix to indicate if
117 * two locks are compatible.
119 * - EX: Exclusive mode. Before a new file is created, MDS requests EX lock
121 * - PW: Protective Write (normal write) mode. When a client requests a write
122 * lock from an OST, a lock with PW mode will be issued.
123 * - PR: Protective Read (normal read) mode. When a client requests a read from
124 * an OST, a lock with PR mode will be issued. Also, if the client opens a
125 * file for execution, it is granted a lock with PR mode.
126 * - CW: Concurrent Write mode. The type of lock that the MDS grants if a client
127 * requests a write lock during a file open operation.
128 * - CR Concurrent Read mode. When a client performs a path lookup, MDS grants
129 * an inodebit lock with the CR mode on the intermediate path component.
143 #define LCK_COMPAT_EX LCK_NL
144 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
145 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
146 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
147 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
148 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
149 #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL)
150 #define LCK_COMPAT_COS (LCK_COS)
151 /** @} Lock Compatibility Matrix */
153 extern enum ldlm_mode lck_compat_array[];
155 static inline void lockmode_verify(enum ldlm_mode mode)
157 LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
160 static inline int lockmode_compat(enum ldlm_mode exist_mode,
161 enum ldlm_mode new_mode)
163 return lck_compat_array[exist_mode] & new_mode;
168 * cluster name spaces
172 #define DLM_OST_NAMESPACE 1
173 #define DLM_MDS_NAMESPACE 2
176 - do we just separate this by security domains and use a prefix for
177 multiple namespaces in the same domain?
182 * Locking rules for LDLM:
187 * waiting_locks_spinlock
200 /* Cancel lru flag, it indicates we cancel aged locks. */
201 enum ldlm_lru_flags {
202 LDLM_LRU_FLAG_NO_WAIT = 0x1, /* Cancel locks w/o blocking (neither
203 * sending nor waiting for any RPCs) */
204 LDLM_LRU_FLAG_CLEANUP = 0x2, /* Used when clearing lru, tells
205 * prepare_lru_list to set discard flag
206 * on PR extent locks so we don't waste
207 * time saving pages that will be
208 * discarded momentarily */
213 struct ldlm_resource;
214 struct ldlm_namespace;
217 * Operations on LDLM pools.
218 * LDLM pool is a pool of locks in the namespace without any implicitly
220 * Locks in the pool are organized in LRU.
221 * Local memory pressure or server instructions (e.g. mempressure on server)
222 * can trigger freeing of locks from the pool
224 struct ldlm_pool_ops {
225 /** Recalculate pool \a pl usage */
226 int (*po_recalc)(struct ldlm_pool *pl, bool force);
227 /** Cancel at least \a nr locks from pool \a pl */
228 int (*po_shrink)(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
229 int (*po_setup)(struct ldlm_pool *pl, int limit);
232 /** One second for pools thread check interval. Each pool has own period. */
233 #define LDLM_POOLS_THREAD_PERIOD (1)
235 /** ~6% margin for modest pools. See ldlm_pool.c for details. */
236 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
238 /** Default recalc period for server side pools in sec. */
239 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
241 /** Default recalc period for client side pools in sec. */
242 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
245 * LDLM pool structure to track granted locks.
246 * For purposes of determining when to release locks on e.g. memory pressure.
247 * This feature is commonly referred to as lru_resize.
250 /** Pool debugfs directory. */
251 struct dentry *pl_debugfs_entry;
252 /** Pool name, must be long enough to hold compound proc entry name. */
254 /** Lock for protecting SLV/CLV updates. */
256 /** Number of allowed locks in in pool, both, client and server side. */
258 /** Number of granted locks in */
260 /** Grant rate per T. */
261 atomic_t pl_grant_rate;
262 /** Cancel rate per T. */
263 atomic_t pl_cancel_rate;
264 /** Server lock volume (SLV). Protected by pl_lock. */
265 __u64 pl_server_lock_volume;
266 /** Current biggest client lock volume. Protected by pl_lock. */
267 __u64 pl_client_lock_volume;
268 /** Lock volume factor, shown in percents in procfs, but internally
269 * Client SLV calculated as: server_slv * lock_volume_factor >> 8.
271 atomic_t pl_lock_volume_factor;
272 /** Time when last SLV from server was obtained. */
273 time64_t pl_recalc_time;
274 /** Recalculation period for pool. */
275 time64_t pl_recalc_period;
276 /** Recalculation and shrink operations. */
277 struct ldlm_pool_ops *pl_ops;
278 /** Number of planned locks for next period. */
280 /** Pool statistics. */
281 struct lprocfs_stats *pl_stats;
284 struct kobject pl_kobj;
285 struct completion pl_kobj_unregister;
288 typedef int (*ldlm_res_policy)(const struct lu_env *env,
289 struct ldlm_namespace *,
290 struct ldlm_lock **, void *req_cookie,
291 enum ldlm_mode mode, __u64 flags, void *data);
293 typedef int (*ldlm_cancel_cbt)(struct ldlm_lock *lock);
297 * LVB is Lock Value Block. This is a special opaque (to LDLM) value that could
298 * be associated with an LDLM lock and transferred from client to server and
301 * Currently LVBs are used by:
302 * - OSC-OST code to maintain current object size/times
303 * - layout lock code to return the layout when the layout lock is granted
305 * To ensure delayed LVB initialization, it is highly recommended to use the set
306 * of ldlm_[res_]lvbo_[init,update,fill]() functions.
308 struct ldlm_valblock_ops {
309 int (*lvbo_init)(struct ldlm_resource *res);
310 int (*lvbo_update)(struct ldlm_resource *res, struct ldlm_lock *lock,
311 struct ptlrpc_request *r, int increase);
312 int (*lvbo_free)(struct ldlm_resource *res);
313 /* Return size of lvb data appropriate RPC size can be reserved */
314 int (*lvbo_size)(struct ldlm_lock *lock);
315 /* Called to fill in lvb data to RPC buffer @buf */
316 int (*lvbo_fill)(struct ldlm_lock *lock, void *buf, int *buflen);
320 * LDLM pools related, type of lock pool in the namespace.
321 * Greedy means release cached locks aggressively
324 LDLM_NAMESPACE_GREEDY = BIT(0),
325 LDLM_NAMESPACE_MODEST = BIT(1),
329 * Default values for the "max_nolock_size", "contention_time" and
330 * "contended_locks" namespace tunables.
332 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
333 #define NS_DEFAULT_CONTENTION_SECONDS 2
334 #define NS_DEFAULT_CONTENDED_LOCKS 32
336 struct ldlm_ns_bucket {
337 /** back pointer to namespace */
338 struct ldlm_namespace *nsb_namespace;
340 * Estimated lock callback time. Used by adaptive timeout code to
341 * avoid spurious client evictions due to unresponsiveness when in
342 * fact the network or overall system load is at fault
344 struct adaptive_timeout nsb_at_estimate;
346 * Which res in the bucket should we start with the reclaim.
348 int nsb_reclaim_start;
349 /* counter of entries in this bucket */
354 /** LDLM namespace lock stats */
360 LDLM_NS_TYPE_UNKNOWN = 0, /**< invalid type */
361 LDLM_NS_TYPE_MDC, /**< MDC namespace */
362 LDLM_NS_TYPE_MDT, /**< MDT namespace */
363 LDLM_NS_TYPE_OSC, /**< OSC namespace */
364 LDLM_NS_TYPE_OST, /**< OST namespace */
365 LDLM_NS_TYPE_MGC, /**< MGC namespace */
366 LDLM_NS_TYPE_MGT, /**< MGT namespace */
369 enum ldlm_namespace_flags {
371 * Flag to indicate the LRU cancel is in progress.
372 * Used to limit the process by 1 thread only.
380 * Namespace serves to contain locks related to a particular service.
381 * There are two kinds of namespaces:
382 * - Server namespace has knowledge of all locks and is therefore authoritative
383 * to make decisions like what locks could be granted and what conflicts
384 * exist during new lock enqueue.
385 * - Client namespace only has limited knowledge about locks in the namespace,
386 * only seeing locks held by the client.
388 * Every Lustre service has one server namespace present on the server serving
389 * that service. Every client connected to the service has a client namespace
391 * Every lock obtained by client in that namespace is actually represented by
392 * two in-memory locks. One on the server and one on the client. The locks are
393 * linked by a special cookie by which one node can tell to the other which lock
394 * it actually means during communications. Such locks are called remote locks.
395 * The locks held by server only without any reference to a client are called
398 struct ldlm_namespace {
399 /** Backward link to OBD, required for LDLM pool to store new SLV. */
400 struct obd_device *ns_obd;
402 /** Flag indicating if namespace is on client instead of server */
403 enum ldlm_side ns_client;
405 /** name of this namespace */
408 /** Resource hash table for namespace. */
409 struct cfs_hash *ns_rs_hash;
410 struct ldlm_ns_bucket *ns_rs_buckets;
411 unsigned int ns_bucket_bits;
416 /** big refcount (by bucket) */
420 * Namespace connect flags supported by server (may be changed via
421 * /proc, LRU resize may be disabled/enabled).
423 __u64 ns_connect_flags;
425 /** Client side original connect flags supported by server. */
426 __u64 ns_orig_connect_flags;
428 /* namespace debugfs dir entry */
429 struct dentry *ns_debugfs_entry;
432 * Position in global namespace list linking all namespaces on
435 struct list_head ns_list_chain;
438 * List of unused locks for this namespace. This list is also called
440 * Unused locks are locks with zero reader/writer reference counts.
441 * This list is only used on clients for lock caching purposes.
442 * When we want to release some locks voluntarily or if server wants
443 * us to release some locks due to e.g. memory pressure, we take locks
444 * to release from the head of this list.
445 * Locks are linked via l_lru field in \see struct ldlm_lock.
447 struct list_head ns_unused_list;
448 /** Number of locks in the LRU list above */
450 struct list_head *ns_last_pos;
453 * Maximum number of locks permitted in the LRU. If 0, means locks
454 * are managed by pools and there is no preset limit, rather it is all
455 * controlled by available memory on this client and on server.
457 unsigned int ns_max_unused;
460 * Cancel batch, if unused lock count exceed lru_size
461 * Only be used if LRUR disable.
463 unsigned int ns_cancel_batch;
466 * How much the SLV should decrease in %% to trigger LRU cancel urgently.
468 unsigned int ns_recalc_pct;
470 /** Maximum allowed age (last used time) for locks in the LRU. Set in
471 * seconds from userspace, but stored in ns to avoid repeat conversions.
476 * Server only: number of times we evicted clients due to lack of reply
479 unsigned int ns_timeouts;
481 * Number of seconds since the file change time after which
482 * the MDT will return an UPDATE lock along with a LOOKUP lock.
483 * This allows the client to start caching negative dentries
484 * for a directory and may save an RPC for a later stat.
486 timeout_t ns_ctime_age_limit;
488 * Number of (nano)seconds since the lock was last used. The client
489 * may cancel the lock older than this age and flush related data if
490 * another client shows interest in this lock by doing glimpse request.
491 * This allows to cache stat data locally for such files early. Set in
492 * seconds from userspace, but stored in ns to avoid repeat conversions.
494 ktime_t ns_dirty_age_limit;
496 * Used to rate-limit ldlm_namespace_dump calls.
497 * \see ldlm_namespace_dump. Increased by 10 seconds every time
500 time64_t ns_next_dump;
502 /** "policy" function that does actual lock conflict determination */
503 ldlm_res_policy ns_policy;
506 * LVB operations for this namespace.
507 * \see struct ldlm_valblock_ops
509 struct ldlm_valblock_ops *ns_lvbo;
512 * Used by filter code to store pointer to OBD of the service.
513 * Should be dropped in favor of \a ns_obd
518 * Wait queue used by __ldlm_namespace_free. Gets woken up every time
519 * a resource is removed.
521 wait_queue_head_t ns_waitq;
522 /** LDLM pool structure for this namespace */
523 struct ldlm_pool ns_pool;
524 /** Definition of how eagerly unused locks will be released from LRU */
525 enum ldlm_appetite ns_appetite;
528 * If more than \a ns_contended_locks are found, the resource is
529 * considered to be contended. Lock enqueues might specify that no
530 * contended locks should be granted
532 unsigned ns_contended_locks;
535 * The resources in this namespace remember contended state during
536 * \a ns_contention_time, in seconds.
538 timeout_t ns_contention_time;
541 * Limit size of contended extent locks, in bytes.
542 * If extended lock is requested for more then this many bytes and
543 * caller instructs us not to grant contended locks, we would disregard
546 unsigned ns_max_nolock_size;
548 /** Limit of parallel AST RPC count. */
549 unsigned ns_max_parallel_ast;
552 * Callback to check if a lock is good to be canceled by ELC or
555 ldlm_cancel_cbt ns_cancel;
557 /** LDLM lock stats */
558 struct lprocfs_stats *ns_stats;
561 * Flag to indicate namespace is being freed. Used to determine if
562 * recalculation of LDLM pool statistics should be skipped.
564 unsigned ns_stopping:1,
567 * Flag to indicate the LRU recalc on RPC reply is in progress.
568 * Used to limit the process by 1 thread only.
573 * Which bucket should we start with the lock reclaim.
575 int ns_reclaim_start;
577 struct kobject ns_kobj; /* sysfs object */
578 struct completion ns_kobj_unregister;
581 * To avoid another ns_lock usage, a separate bitops field.
583 unsigned long ns_flags;
587 * Returns 1 if namespace \a ns is a client namespace.
589 static inline int ns_is_client(struct ldlm_namespace *ns)
592 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
593 ns->ns_client == LDLM_NAMESPACE_SERVER);
594 return ns->ns_client == LDLM_NAMESPACE_CLIENT;
598 * Returns 1 if namespace \a ns is a server namespace.
600 static inline int ns_is_server(struct ldlm_namespace *ns)
603 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
604 ns->ns_client == LDLM_NAMESPACE_SERVER);
605 return ns->ns_client == LDLM_NAMESPACE_SERVER;
609 * Returns 1 if namespace \a ns supports early lock cancel (ELC).
611 static inline int ns_connect_cancelset(struct ldlm_namespace *ns)
614 return !!(ns->ns_connect_flags & OBD_CONNECT_CANCELSET);
618 * Returns 1 if this namespace supports lru_resize.
620 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
623 return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
626 static inline void ns_register_cancel(struct ldlm_namespace *ns,
635 /** Type for blocking callback function of a lock. */
636 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
637 struct ldlm_lock_desc *new, void *data,
639 /** Type for completion callback function of a lock. */
640 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, __u64 flags,
642 /** Type for glimpse callback function of a lock. */
643 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
645 /** Type for created callback function of a lock. */
646 typedef void (*ldlm_created_callback)(struct ldlm_lock *lock);
648 /** Work list for sending GL ASTs to multiple locks. */
649 struct ldlm_glimpse_work {
650 struct ldlm_lock *gl_lock; /* lock to glimpse */
651 struct list_head gl_list; /* linkage to other gl work structs */
652 __u32 gl_flags;/* see LDLM_GL_WORK_* below */
653 union ldlm_gl_desc *gl_desc; /* glimpse descriptor to be packed in
654 * glimpse callback request */
655 ptlrpc_interpterer_t gl_interpret_reply;
656 void *gl_interpret_data;
659 struct ldlm_bl_desc {
660 unsigned int bl_same_client:1,
664 struct ldlm_cb_set_arg {
665 struct ptlrpc_request_set *set;
666 int type; /* LDLM_{CP,BL,GL}_CALLBACK */
668 struct list_head *list;
669 union ldlm_gl_desc *gl_desc; /* glimpse AST descriptor */
670 ptlrpc_interpterer_t gl_interpret_reply;
671 void *gl_interpret_data;
672 struct ldlm_bl_desc *bl_desc;
675 struct ldlm_cb_async_args {
676 struct ldlm_cb_set_arg *ca_set_arg;
677 struct ldlm_lock *ca_lock;
680 /** The ldlm_glimpse_work was slab allocated & must be freed accordingly.*/
681 #define LDLM_GL_WORK_SLAB_ALLOCATED 0x1
683 /** Interval node data for each LDLM_EXTENT lock. */
684 struct ldlm_interval {
685 struct interval_node li_node; /* node for tree management */
686 struct list_head li_group; /* the locks which have the same
687 * policy - group of the policy */
689 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
692 * Interval tree for extent locks.
693 * The interval tree must be accessed under the resource lock.
694 * Interval trees are used for granted extent locks to speed up conflicts
695 * lookup. See ldlm/interval_tree.c for more details.
697 struct ldlm_interval_tree {
700 enum ldlm_mode lit_mode; /* lock mode */
701 struct interval_node *lit_root; /* actual ldlm_interval */
705 * Lists of waiting locks for each inodebit type.
706 * A lock can be in several liq_waiting lists and it remains in lr_waiting.
708 struct ldlm_ibits_queues {
709 struct list_head liq_waiting[MDS_INODELOCK_NUMBITS];
712 struct ldlm_ibits_node {
713 struct list_head lin_link[MDS_INODELOCK_NUMBITS];
714 struct ldlm_lock *lock;
717 struct ldlm_flock_node {
718 atomic_t lfn_unlock_pending;
719 bool lfn_needs_reprocess;
722 /** Whether to track references to exports by LDLM locks. */
723 #define LUSTRE_TRACKS_LOCK_EXP_REFS (0)
726 enum ldlm_cancel_flags {
727 LCF_ASYNC = 0x1, /* Cancel locks asynchronously. */
728 LCF_LOCAL = 0x2, /* Cancel locks locally, not notifing server */
729 LCF_BL_AST = 0x4, /* Cancel LDLM_FL_BL_AST locks in the same RPC */
736 __u64 blocking_owner;
737 struct obd_export *blocking_export;
738 atomic_t blocking_refs;
742 union ldlm_policy_data {
743 struct ldlm_extent l_extent;
744 struct ldlm_flock l_flock;
745 struct ldlm_inodebits l_inodebits;
748 void ldlm_convert_policy_to_wire(enum ldlm_type type,
749 const union ldlm_policy_data *lpolicy,
750 union ldlm_wire_policy_data *wpolicy);
751 void ldlm_convert_policy_to_local(struct obd_export *exp, enum ldlm_type type,
752 const union ldlm_wire_policy_data *wpolicy,
753 union ldlm_policy_data *lpolicy);
763 * LDLM_GID_ANY is used to match any group id in ldlm_lock_match().
765 #define LDLM_GID_ANY ((__u64)-1)
768 * LDLM lock structure
770 * Represents a single LDLM lock and its state in memory. Each lock is
771 * associated with a single ldlm_resource, the object which is being
772 * locked. There may be multiple ldlm_locks on a single resource,
773 * depending on the lock type and whether the locks are conflicting or
779 * When remote side wants to tell us about a lock, they address
780 * it by this opaque handle. The handle does not hold a
781 * reference on the ldlm_lock, so it can be safely passed to
782 * other threads or nodes. When the lock needs to be accessed
783 * from the handle, it is looked up again in the lock table, and
784 * may no longer exist.
786 * Must be first in the structure.
788 struct portals_handle l_handle;
790 * Pointer to actual resource this lock is in.
791 * ldlm_lock_change_resource() can change this on the client.
792 * When this is possible, rcu must be used to stablise
793 * the resource while we lock and check it hasn't been changed.
795 struct ldlm_resource *l_resource;
797 * List item for client side LRU list.
798 * Protected by ns_lock in struct ldlm_namespace.
800 struct list_head l_lru;
802 * Linkage to resource's lock queues according to current lock state.
803 * (could be granted or waiting)
804 * Protected by lr_lock in struct ldlm_resource.
806 struct list_head l_res_link;
808 * Internal structures per lock type..
811 struct ldlm_interval *l_tree_node;
812 struct ldlm_ibits_node *l_ibits_node;
815 * Per export hash of locks.
816 * Protected by per-bucket exp->exp_lock_hash locks.
818 struct hlist_node l_exp_hash;
820 * Per export hash of flock locks.
821 * Protected by per-bucket exp->exp_flock_hash locks.
823 struct hlist_node l_exp_flock_hash;
826 * Protected by lr_lock.
828 enum ldlm_mode l_req_mode;
830 * Granted mode, also protected by lr_lock.
832 enum ldlm_mode l_granted_mode;
833 /** Lock completion handler pointer. Called when lock is granted. */
834 ldlm_completion_callback l_completion_ast;
836 * Lock blocking AST handler pointer.
837 * It plays two roles:
838 * - as a notification of an attempt to queue a conflicting lock (once)
839 * - as a notification when the lock is being cancelled.
841 * As such it's typically called twice: once for the initial conflict
842 * and then once more when the last user went away and the lock is
843 * cancelled (could happen recursively).
845 ldlm_blocking_callback l_blocking_ast;
847 * Lock glimpse handler.
848 * Glimpse handler is used to obtain LVB updates from a client by
851 ldlm_glimpse_callback l_glimpse_ast;
855 * This is a pointer to actual client export for locks that were granted
856 * to clients. Used server-side.
858 struct obd_export *l_export;
860 * Lock connection export.
861 * Pointer to server export on a client.
863 struct obd_export *l_conn_export;
866 * Remote lock handle.
867 * If the lock is remote, this is the handle of the other side lock
870 struct lustre_handle l_remote_handle;
873 * Representation of private data specific for a lock type.
874 * Examples are: extent range for extent lock or bitmask for ibits locks
876 union ldlm_policy_data l_policy_data;
879 * Lock state flags. Protected by lr_lock.
880 * \see lustre_dlm_flags.h where the bits are defined.
885 * Lock r/w usage counters.
886 * Protected by lr_lock.
891 * If the lock is granted, a process sleeps on this waitq to learn when
892 * it's no longer in use. If the lock is not granted, a process sleeps
893 * on this waitq to learn when it becomes granted.
895 wait_queue_head_t l_waitq;
898 * Time, in nanoseconds, last used by e.g. being matched by lock match.
902 /** Originally requested extent for the extent lock. */
903 struct ldlm_extent l_req_extent;
906 * Client-side-only members.
909 enum lvb_type l_lvb_type;
912 * Temporary storage for a LVB received during an enqueue operation.
913 * May be vmalloc'd, so needs to be freed with OBD_FREE_LARGE().
918 /** Private storage for lock user. Opaque to LDLM. */
923 * Seconds. It will be updated if there is any activity related to
924 * the lock at client, e.g. enqueue the lock. For server it is the
925 * time when blocking ast was sent.
928 time64_t l_blast_sent;
931 /* separate ost_lvb used mostly by Data-on-MDT for now.
932 * It is introduced to don't mix with layout lock data. */
933 struct ost_lvb l_ost_lvb;
935 * Server-side-only members.
939 * Connection cookie for the client originating the operation.
940 * Used by Commit on Share (COS) code. Currently only used for
941 * inodebits locks on MDS.
943 __u64 l_client_cookie;
946 * List item for locks waiting for cancellation from clients.
947 * The lists this could be linked into are:
948 * waiting_locks_list (protected by waiting_locks_spinlock),
949 * then if the lock timed out, it is moved to
950 * expired_lock_list for further processing.
952 struct list_head l_pending_chain;
955 * Set when lock is sent a blocking AST. Time in seconds when timeout
956 * is reached and client holding this lock could be evicted.
957 * This timeout could be further extended by e.g. certain IO activity
959 * \see ost_rw_prolong_locks
961 time64_t l_callback_timestamp;
963 /** Local PID of process which created this lock. */
967 * Number of times blocking AST was sent for this lock.
968 * This is for debugging. Valid values are 0 and 1, if there is an
969 * attempt to send blocking AST more than once, an assertion would be
970 * hit. \see ldlm_work_bl_ast_lock
973 /** List item ldlm_add_ast_work_item() for case of blocking ASTs. */
974 struct list_head l_bl_ast;
975 /** List item ldlm_add_ast_work_item() for case of completion ASTs. */
976 struct list_head l_cp_ast;
977 /** For ldlm_add_ast_work_item() for "revoke" AST used in COS. */
978 struct list_head l_rk_ast;
981 * Pointer to a conflicting lock that caused blocking AST to be sent
984 struct ldlm_lock *l_blocking_lock;
987 * Protected by lr_lock, linkages to "skip lists".
988 * For more explanations of skip lists see ldlm/ldlm_inodebits.c
990 struct list_head l_sl_mode;
991 struct list_head l_sl_policy;
993 /** Reference tracking structure to debug leaked locks. */
994 struct lu_ref l_reference;
995 #if LUSTRE_TRACKS_LOCK_EXP_REFS
996 /* Debugging stuff for bug 20498, for tracking export references. */
997 /** number of export references taken */
999 /** link all locks referencing one export */
1000 struct list_head l_exp_refs_link;
1001 /** referenced export object */
1002 struct obd_export *l_exp_refs_target;
1005 * export blocking dlm lock list, protected by
1006 * l_export->exp_bl_list_lock.
1007 * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
1008 * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock.
1010 struct list_head l_exp_list;
1013 enum ldlm_match_flags {
1014 LDLM_MATCH_UNREF = BIT(0),
1015 LDLM_MATCH_AST = BIT(1),
1016 LDLM_MATCH_AST_ANY = BIT(2),
1017 LDLM_MATCH_RIGHT = BIT(3),
1018 LDLM_MATCH_GROUP = BIT(4),
1022 * Describe the overlap between two locks. itree_overlap_cb data.
1024 struct ldlm_match_data {
1025 struct ldlm_lock *lmd_old;
1026 struct ldlm_lock *lmd_lock;
1027 enum ldlm_mode *lmd_mode;
1028 union ldlm_policy_data *lmd_policy;
1030 __u64 lmd_skip_flags;
1031 enum ldlm_match_flags lmd_match;
1034 /** For uncommitted cross-MDT lock, store transno this lock belongs to */
1035 #define l_transno l_client_cookie
1037 /** For uncommitted cross-MDT lock, which is client lock, share with l_rk_ast
1038 * which is for server. */
1039 #define l_slc_link l_rk_ast
1041 struct lustre_handle_array {
1042 unsigned int ha_count;
1043 /* ha_map is used as bit flag to indicate handle is remote or local */
1044 DECLARE_BITMAP(ha_map, LMV_MAX_STRIPE_COUNT);
1045 struct lustre_handle ha_handles[0];
1049 * LDLM resource description.
1050 * Basically, resource is a representation for a single object.
1051 * Object has a name which is currently 4 64-bit integers. LDLM user is
1052 * responsible for creation of a mapping between objects it wants to be
1053 * protected and resource names.
1055 * A resource can only hold locks of a single lock type, though there may be
1056 * multiple ldlm_locks on a single resource, depending on the lock type and
1057 * whether the locks are conflicting or not.
1059 struct ldlm_resource {
1060 struct ldlm_ns_bucket *lr_ns_bucket;
1063 * List item for list in namespace hash.
1064 * protected by ns_lock.
1065 * Shared with linkage for RCU-delayed free.
1068 struct hlist_node lr_hash;
1069 struct rcu_head lr_rcu;
1072 /** Reference count for this resource */
1073 atomic_t lr_refcount;
1075 /** Spinlock to protect locks under this resource. */
1079 * protected by lr_lock
1081 /** List of locks in granted state */
1082 struct list_head lr_granted;
1084 * List of locks that could not be granted due to conflicts and
1085 * that are waiting for conflicts to go away */
1086 struct list_head lr_waiting;
1089 /** Resource name */
1090 struct ldlm_res_id lr_name;
1094 * Interval trees (only for extent locks) for all modes of
1097 struct ldlm_interval_tree *lr_itree;
1098 struct ldlm_ibits_queues *lr_ibits_queues;
1099 struct ldlm_flock_node lr_flock_node;
1104 * When the resource was considered as contended,
1105 * used only on server side.
1107 time64_t lr_contention_time;
1109 * Associated inode, used only on client side.
1111 struct inode *lr_lvb_inode;
1114 /** Type of locks this resource can hold. Only one type per resource. */
1115 enum ldlm_type lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */
1118 * Server-side-only lock value block elements.
1119 * To serialize lvbo_init.
1122 struct mutex lr_lvb_mutex;
1123 /** protected by lr_lock */
1125 /** is lvb initialized ? */
1126 bool lr_lvb_initialized;
1128 /** List of references to this resource. For debugging. */
1129 struct lu_ref lr_reference;
1132 static inline int ldlm_is_granted(struct ldlm_lock *lock)
1134 return lock->l_req_mode == lock->l_granted_mode;
1137 static inline bool ldlm_has_layout(struct ldlm_lock *lock)
1139 return lock->l_resource->lr_type == LDLM_IBITS &&
1140 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_LAYOUT;
1143 static inline bool ldlm_has_dom(struct ldlm_lock *lock)
1145 return lock->l_resource->lr_type == LDLM_IBITS &&
1146 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_DOM;
1149 static inline char *
1150 ldlm_ns_name(struct ldlm_namespace *ns)
1155 static inline struct ldlm_namespace *
1156 ldlm_res_to_ns(struct ldlm_resource *res)
1158 return res->lr_ns_bucket->nsb_namespace;
1161 static inline struct ldlm_namespace *
1162 ldlm_lock_to_ns(struct ldlm_lock *lock)
1164 return ldlm_res_to_ns(lock->l_resource);
1167 static inline char *
1168 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
1170 return ldlm_ns_name(ldlm_lock_to_ns(lock));
1173 static inline struct adaptive_timeout *
1174 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
1176 return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
1179 static inline int ldlm_lvbo_init(struct ldlm_resource *res)
1181 struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1184 if (ns->ns_lvbo == NULL || ns->ns_lvbo->lvbo_init == NULL ||
1185 res->lr_lvb_initialized)
1188 mutex_lock(&res->lr_lvb_mutex);
1189 /* Did we lose the race? */
1190 if (res->lr_lvb_initialized) {
1191 mutex_unlock(&res->lr_lvb_mutex);
1194 rc = ns->ns_lvbo->lvbo_init(res);
1196 CDEBUG(D_DLMTRACE, "lvbo_init failed for resource : rc = %d\n",
1198 if (res->lr_lvb_data != NULL) {
1199 OBD_FREE(res->lr_lvb_data, res->lr_lvb_len);
1200 res->lr_lvb_data = NULL;
1202 res->lr_lvb_len = rc;
1204 res->lr_lvb_initialized = true;
1206 mutex_unlock(&res->lr_lvb_mutex);
1210 static inline int ldlm_lvbo_size(struct ldlm_lock *lock)
1212 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1214 if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_size != NULL)
1215 return ns->ns_lvbo->lvbo_size(lock);
1220 static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int *len)
1222 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1225 if (ns->ns_lvbo != NULL) {
1226 LASSERT(ns->ns_lvbo->lvbo_fill != NULL);
1227 /* init lvb now if not already */
1228 rc = ldlm_lvbo_init(lock->l_resource);
1230 CERROR("lock %p: delayed lvb init failed (rc %d)\n",
1234 return ns->ns_lvbo->lvbo_fill(lock, buf, len);
1239 struct ldlm_ast_work {
1240 struct ldlm_lock *w_lock;
1242 struct ldlm_lock_desc w_desc;
1243 struct list_head w_list;
1250 * Common ldlm_enqueue parameters
1252 struct ldlm_enqueue_info {
1253 enum ldlm_type ei_type; /** Type of the lock being enqueued. */
1254 enum ldlm_mode ei_mode; /** Mode of the lock being enqueued. */
1255 void *ei_cb_bl; /** blocking lock callback */
1256 void *ei_cb_local_bl; /** blocking local lock callback */
1257 void *ei_cb_cp; /** lock completion callback */
1258 void *ei_cb_gl; /** lock glimpse callback */
1259 ldlm_created_callback ei_cb_created; /** lock created callback */
1260 void *ei_cbdata; /** Data to be passed into callbacks. */
1261 void *ei_namespace; /** lock namespace **/
1262 u64 ei_inodebits; /** lock inode bits **/
1263 unsigned int ei_enq_slave:1; /** whether enqueue slave stripes */
1264 unsigned int ei_req_slot:1; /** whether acquire rpc slot */
1265 unsigned int ei_mod_slot:1; /** whether acquire mod rpc slot */
1268 #define ei_res_id ei_cb_gl
1270 extern char *ldlm_lockname[];
1271 extern char *ldlm_typename[];
1272 extern const char *ldlm_it2str(enum ldlm_intent_flags it);
1275 * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG.
1276 * For the cases where we do not have actual lock to print along
1277 * with a debugging message that is ldlm-related
1279 #define LDLM_DEBUG_NOLOCK(format, a...) \
1280 CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
1283 * Support function for lock information printing into debug logs.
1287 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do { \
1288 CFS_CHECK_STACK(msgdata, mask, cdls); \
1290 if (((mask) & D_CANTMASK) != 0 || \
1291 ((libcfs_debug & (mask)) != 0 && \
1292 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1293 _ldlm_lock_debug(lock, msgdata, fmt, ##a); \
1296 void _ldlm_lock_debug(struct ldlm_lock *lock,
1297 struct libcfs_debug_msg_data *data,
1298 const char *fmt, ...)
1299 __attribute__ ((format (printf, 3, 4)));
1302 * Rate-limited version of lock printing function.
1304 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do { \
1305 static struct cfs_debug_limit_state _ldlm_cdls; \
1306 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls); \
1307 ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
1310 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
1311 #define LDLM_WARN(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
1313 /** Non-rate-limited lock printing function for debugging purposes. */
1314 #define LDLM_DEBUG(lock, fmt, a...) do { \
1315 if (likely(lock != NULL)) { \
1316 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL); \
1317 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock, \
1318 "### " fmt , ##a); \
1320 LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a); \
1323 #else /* !LIBCFS_DEBUG */
1324 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
1325 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
1326 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
1330 * Three intentions can be used for the policy functions in
1331 * ldlm_processing_policy.
1333 * LDLM_PROCESS_RESCAN:
1335 * It's used when policy functions are called from ldlm_reprocess_queue() to
1336 * reprocess the wait list and try to grant locks, blocking ASTs
1337 * have already been sent in this situation, completion ASTs need be sent for
1338 * the locks being granted.
1340 * LDLM_PROCESS_ENQUEUE:
1342 * It's used when policy functions are called from ldlm_lock_enqueue() to
1343 * process the wait list for handling an enqueue request, blocking
1344 * ASTs have not been sent yet, so list of conflicting locks would be
1345 * collected and ASTs sent.
1347 * LDLM_PROCESS_RECOVERY:
1349 * It's used when policy functions are called from ldlm_reprocess_queue() to
1350 * reprocess the wait list when recovery done. In case of blocking
1351 * ASTs are lost before recovery, it needs not only to grant locks if
1352 * available, but also send blocking ASTs to the locks doesn't have AST sent
1353 * flag. Completion ASTs need be sent for the locks being granted.
1355 enum ldlm_process_intention {
1356 LDLM_PROCESS_RESCAN = 0,
1357 LDLM_PROCESS_ENQUEUE = 1,
1358 LDLM_PROCESS_RECOVERY = 2,
1361 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags,
1362 enum ldlm_process_intention intention,
1363 enum ldlm_error *err,
1364 struct list_head *work_list);
1366 typedef int (*ldlm_reprocessing_policy)(struct ldlm_resource *res,
1367 struct list_head *queue,
1368 struct list_head *work_list,
1369 enum ldlm_process_intention intention,
1373 * Return values for lock iterators.
1374 * Also used during deciding of lock grants and cancellations.
1376 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
1377 #define LDLM_ITER_STOP 2 /* stop iterating */
1379 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
1380 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
1382 /** \defgroup ldlm_iterator Lock iterators
1384 * LDLM provides for a way to iterate through every lock on a resource or
1385 * namespace or every resource in a namespace.
1387 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1389 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1391 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
1392 ldlm_iterator_t iter, void *data);
1393 /** @} ldlm_iterator */
1395 int ldlm_replay_locks(struct obd_import *imp);
1398 int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1401 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
1403 struct ldlm_prolong_args {
1404 struct obd_export *lpa_export;
1405 struct ptlrpc_request *lpa_req;
1406 struct ldlm_res_id lpa_resid;
1407 struct ldlm_extent lpa_extent;
1408 enum ldlm_mode lpa_mode;
1412 void ldlm_lock_prolong_one(struct ldlm_lock *lock,
1413 struct ldlm_prolong_args *arg);
1414 void ldlm_resource_prolong(struct ldlm_prolong_args *arg);
1416 struct ldlm_callback_suite {
1417 ldlm_completion_callback lcs_completion;
1418 ldlm_blocking_callback lcs_blocking;
1419 ldlm_glimpse_callback lcs_glimpse;
1423 #ifdef HAVE_SERVER_SUPPORT
1424 /** \defgroup ldlm_srv_ast Server AST handlers
1425 * These are AST handlers used by server code.
1426 * Their property is that they are just preparing RPCs to be sent to clients.
1429 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1430 void *data, int flag);
1431 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1432 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
1433 int ldlm_glimpse_locks(struct ldlm_resource *res,
1434 struct list_head *gl_work_list);
1435 /** @} ldlm_srv_ast */
1437 /** \defgroup ldlm_handlers Server LDLM handlers
1438 * These are handler functions that should be called by "frontends" such as
1439 * MDT or OST to pass through LDLM requests to LDLM for handling
1442 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1443 const struct ldlm_request *dlm_req,
1444 const struct ldlm_callback_suite *cbs);
1445 int ldlm_handle_convert0(struct ptlrpc_request *req,
1446 const struct ldlm_request *dlm_req);
1447 int ldlm_handle_cancel(struct ptlrpc_request *req);
1448 int ldlm_request_cancel(struct ptlrpc_request *req,
1449 const struct ldlm_request *dlm_req,
1450 int first, enum lustre_at_flags flags);
1451 /** @} ldlm_handlers */
1453 void ldlm_revoke_export_locks(struct obd_export *exp);
1454 timeout_t ldlm_bl_timeout(struct ldlm_lock *lock);
1455 timeout_t ldlm_bl_timeout_by_rpc(struct ptlrpc_request *req);
1457 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1458 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, timeout_t timeout);
1459 int ldlm_get_ref(void);
1460 void ldlm_put_ref(void);
1461 int ldlm_init_export(struct obd_export *exp);
1462 void ldlm_destroy_export(struct obd_export *exp);
1463 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req);
1466 #ifdef HAVE_SERVER_SUPPORT
1467 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1468 ldlm_reprocessing_policy
1469 ldlm_get_reprocessing_policy(struct ldlm_resource *res);
1471 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1472 void ldlm_lock2handle(const struct ldlm_lock *lock,
1473 struct lustre_handle *lockh);
1474 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags);
1475 void ldlm_cancel_callback(struct ldlm_lock *);
1476 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1477 int ldlm_lock_set_data(const struct lustre_handle *lockh, void *data);
1480 * Obtain a lock reference by its handle.
1482 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1484 return __ldlm_handle2lock(h, 0);
1487 #define LDLM_LOCK_REF_DEL(lock) \
1488 lu_ref_del(&lock->l_reference, "handle", lock)
1490 static inline struct ldlm_lock *
1491 ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags)
1493 struct ldlm_lock *lock;
1495 lock = __ldlm_handle2lock(h, flags);
1497 LDLM_LOCK_REF_DEL(lock);
1502 * Update Lock Value Block Operations (LVBO) on a resource taking into account
1503 * data from request \a r
1505 static inline int ldlm_lvbo_update(struct ldlm_resource *res,
1506 struct ldlm_lock *lock,
1507 struct ptlrpc_request *req, int increase)
1509 struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1512 /* delayed lvb init may be required */
1513 rc = ldlm_lvbo_init(res);
1515 CERROR("delayed lvb init failed (rc %d)\n", rc);
1519 if (ns->ns_lvbo && ns->ns_lvbo->lvbo_update)
1520 return ns->ns_lvbo->lvbo_update(res, lock, req, increase);
1525 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1526 struct ptlrpc_request *req,
1529 return ldlm_lvbo_update(res, NULL, req, increase);
1532 int is_granted_or_cancelled_nolock(struct ldlm_lock *lock);
1534 int ldlm_error2errno(enum ldlm_error error);
1535 enum ldlm_error ldlm_errno2error(int err_no); /* don't call it `errno': this
1536 * confuses user-space. */
1537 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1538 void ldlm_dump_export_locks(struct obd_export *exp);
1542 * Release a temporary lock reference obtained by ldlm_handle2lock() or
1543 * __ldlm_handle2lock().
1545 #define LDLM_LOCK_PUT(lock) \
1547 LDLM_LOCK_REF_DEL(lock); \
1548 /*LDLM_DEBUG((lock), "put");*/ \
1549 ldlm_lock_put(lock); \
1553 * Release a lock reference obtained by some other means (see
1556 #define LDLM_LOCK_RELEASE(lock) \
1558 /*LDLM_DEBUG((lock), "put");*/ \
1559 ldlm_lock_put(lock); \
1562 #define LDLM_LOCK_GET(lock) \
1564 ldlm_lock_get(lock); \
1565 /*LDLM_DEBUG((lock), "get");*/ \
1569 #define ldlm_lock_list_put(head, member, count) \
1571 struct ldlm_lock *_lock, *_next; \
1573 list_for_each_entry_safe(_lock, _next, head, member) { \
1576 list_del_init(&_lock->member); \
1577 LDLM_LOCK_RELEASE(_lock); \
1582 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1583 void ldlm_lock_put(struct ldlm_lock *lock);
1584 void ldlm_lock_destroy(struct ldlm_lock *lock);
1585 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1586 void ldlm_lock_addref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1587 int ldlm_lock_addref_try(const struct lustre_handle *lockh,
1588 enum ldlm_mode mode);
1589 void ldlm_lock_decref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1590 void ldlm_lock_decref_and_cancel(const struct lustre_handle *lockh,
1591 enum ldlm_mode mode);
1592 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1593 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1594 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1595 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1597 enum ldlm_mode ldlm_lock_match_with_skip(struct ldlm_namespace *ns,
1598 __u64 flags, __u64 skip_flags,
1599 const struct ldlm_res_id *res_id,
1600 enum ldlm_type type,
1601 union ldlm_policy_data *policy,
1602 enum ldlm_mode mode,
1603 struct lustre_handle *lh,
1604 enum ldlm_match_flags match_flags);
1605 static inline enum ldlm_mode ldlm_lock_match(struct ldlm_namespace *ns,
1607 const struct ldlm_res_id *res_id,
1608 enum ldlm_type type,
1609 union ldlm_policy_data *policy,
1610 enum ldlm_mode mode,
1611 struct lustre_handle *lh)
1613 return ldlm_lock_match_with_skip(ns, flags, 0, res_id, type, policy,
1616 struct ldlm_lock *search_itree(struct ldlm_resource *res,
1617 struct ldlm_match_data *data);
1618 enum ldlm_mode ldlm_revalidate_lock_handle(const struct lustre_handle *lockh,
1620 void ldlm_lock_mode_downgrade(struct ldlm_lock *lock, enum ldlm_mode new_mode);
1621 void ldlm_lock_cancel(struct ldlm_lock *lock);
1622 void ldlm_reprocess_all(struct ldlm_resource *res, __u64 hint);
1623 void ldlm_reprocess_recovery_done(struct ldlm_namespace *ns);
1624 void ldlm_lock_dump_handle(int level, const struct lustre_handle *lockh);
1625 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1628 struct ldlm_namespace *ldlm_namespace_new(struct obd_device *obd, char *name,
1629 enum ldlm_side client,
1630 enum ldlm_appetite apt,
1631 enum ldlm_ns_type ns_type);
1632 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags);
1633 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
1634 struct obd_import *imp,
1636 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
1637 void ldlm_namespace_free(struct ldlm_namespace *ns,
1638 struct obd_import *imp, int force);
1639 void ldlm_namespace_register(struct ldlm_namespace *ns, enum ldlm_side client);
1640 void ldlm_namespace_unregister(struct ldlm_namespace *ns,
1641 enum ldlm_side client);
1642 void ldlm_namespace_get(struct ldlm_namespace *ns);
1643 void ldlm_namespace_put(struct ldlm_namespace *ns);
1645 int ldlm_debugfs_setup(void);
1646 void ldlm_debugfs_cleanup(void);
1648 static inline void ldlm_svc_get_eopc(const struct ldlm_request *dlm_req,
1649 struct lprocfs_stats *srv_stats)
1651 int lock_type = 0, op = 0;
1653 lock_type = dlm_req->lock_desc.l_resource.lr_type;
1655 switch (lock_type) {
1657 op = PTLRPC_LAST_CNTR + LDLM_PLAIN_ENQUEUE;
1660 op = PTLRPC_LAST_CNTR + LDLM_EXTENT_ENQUEUE;
1663 op = PTLRPC_LAST_CNTR + LDLM_FLOCK_ENQUEUE;
1666 op = PTLRPC_LAST_CNTR + LDLM_IBITS_ENQUEUE;
1674 lprocfs_counter_incr(srv_stats, op);
1677 /* resource.c - internal */
1678 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1679 const struct ldlm_res_id *,
1680 enum ldlm_type type, int create);
1681 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1682 int ldlm_resource_putref(struct ldlm_resource *res);
1683 void ldlm_resource_add_lock(struct ldlm_resource *res,
1684 struct list_head *head,
1685 struct ldlm_lock *lock);
1686 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1687 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1688 void ldlm_dump_all_namespaces(enum ldlm_side client, int level);
1689 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1690 void ldlm_resource_dump(int level, struct ldlm_resource *);
1691 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1692 const struct ldlm_res_id *);
1694 #define LDLM_RESOURCE_ADDREF(res) do { \
1695 lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, current); \
1698 #define LDLM_RESOURCE_DELREF(res) do { \
1699 lu_ref_del(&(res)->lr_reference, __FUNCTION__, current); \
1702 /* ldlm_request.c */
1703 /** \defgroup ldlm_local_ast Default AST handlers for local locks
1704 * These AST handlers are typically used for server-side local locks and are
1705 * also used by client-side lock handlers to perform minimum level base
1708 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1709 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1710 void *data, int flag);
1711 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1712 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data);
1713 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1714 /** @} ldlm_local_ast */
1716 /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users.
1717 * These are typically used by client and server (*_local versions)
1718 * to obtain and release locks.
1720 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1721 struct ldlm_enqueue_info *einfo,
1722 const struct ldlm_res_id *res_id,
1723 union ldlm_policy_data const *policy, __u64 *flags,
1724 void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
1725 struct lustre_handle *lockh, int async);
1726 int ldlm_prep_enqueue_req(struct obd_export *exp,
1727 struct ptlrpc_request *req,
1728 struct list_head *cancels,
1730 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
1731 int version, int opc, int canceloff,
1732 struct list_head *cancels, int count);
1734 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len);
1735 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1736 const struct ldlm_request *dlm_req,
1737 const struct ldlm_callback_suite *cbs);
1738 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1739 struct ldlm_enqueue_info *einfo, __u8 with_policy,
1740 __u64 *flags, void *lvb, __u32 lvb_len,
1741 const struct lustre_handle *lockh, int rc,
1743 int ldlm_cli_enqueue_local(const struct lu_env *env,
1744 struct ldlm_namespace *ns,
1745 const struct ldlm_res_id *res_id,
1746 enum ldlm_type type, union ldlm_policy_data *policy,
1747 enum ldlm_mode mode, __u64 *flags,
1748 ldlm_blocking_callback blocking,
1749 ldlm_completion_callback completion,
1750 ldlm_glimpse_callback glimpse,
1751 void *data, __u32 lvb_len, enum lvb_type lvb_type,
1752 const __u64 *client_cookie,
1753 struct lustre_handle *lockh);
1754 int ldlm_cli_convert_req(struct ldlm_lock *lock, __u32 *flags, __u64 new_bits);
1755 int ldlm_cli_convert(struct ldlm_lock *lock,
1756 enum ldlm_cancel_flags cancel_flags);
1757 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1758 int ldlm_cli_cancel(const struct lustre_handle *lockh,
1759 enum ldlm_cancel_flags cancel_flags);
1760 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1761 enum ldlm_cancel_flags flags, void *opaque);
1762 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1763 const struct ldlm_res_id *res_id,
1764 union ldlm_policy_data *policy,
1765 enum ldlm_mode mode,
1766 enum ldlm_cancel_flags flags, void *opaque);
1767 int ldlm_cli_cancel_req(struct obd_export *exp, struct ldlm_lock *lock,
1768 struct list_head *head, int count,
1769 enum ldlm_cancel_flags flags);
1770 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1771 struct list_head *cancels,
1772 union ldlm_policy_data *policy,
1773 enum ldlm_mode mode, __u64 lock_flags,
1774 enum ldlm_cancel_flags cancel_flags,
1776 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1777 enum ldlm_cancel_flags flags);
1778 int ldlm_cli_cancel_list(struct list_head *head, int count,
1779 struct ptlrpc_request *req,
1780 enum ldlm_cancel_flags flags);
1782 int ldlm_inodebits_drop(struct ldlm_lock *lock, __u64 to_drop);
1783 int ldlm_cli_inodebits_convert(struct ldlm_lock *lock,
1784 enum ldlm_cancel_flags cancel_flags);
1786 /** @} ldlm_cli_api */
1788 extern unsigned int ldlm_enqueue_min;
1791 /* This has to be here because recursive inclusion sucks. */
1792 int intent_disposition(struct ldlm_reply *rep, int flag);
1793 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1796 * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1797 * than one lock_res is dead-lock safe.
1799 enum lock_res_type {
1804 /** Lock resource. */
1805 static inline void lock_res(struct ldlm_resource *res)
1807 spin_lock(&res->lr_lock);
1810 /** Lock resource with a way to instruct lockdep code about nestedness-safe. */
1811 static inline void lock_res_nested(struct ldlm_resource *res,
1812 enum lock_res_type mode)
1814 spin_lock_nested(&res->lr_lock, mode);
1817 /** Unlock resource. */
1818 static inline void unlock_res(struct ldlm_resource *res)
1820 spin_unlock(&res->lr_lock);
1823 /** Check if resource is already locked, assert if not. */
1824 static inline void check_res_locked(struct ldlm_resource *res)
1826 assert_spin_locked(&res->lr_lock);
1829 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1830 void unlock_res_and_lock(struct ldlm_lock *lock);
1833 /** \defgroup ldlm_pools Various LDLM pool related functions
1834 * There are not used outside of ldlm.
1837 int ldlm_pools_init(void);
1838 void ldlm_pools_fini(void);
1840 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1841 int idx, enum ldlm_side client);
1842 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
1843 void ldlm_pool_fini(struct ldlm_pool *pl);
1844 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1845 time64_t ldlm_pool_recalc(struct ldlm_pool *pl, bool force);
1846 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1847 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1848 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1849 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1850 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1851 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1852 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1853 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1854 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1857 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
1858 const struct ldlm_extent *ex2)
1860 return ex1->start <= ex2->end && ex2->start <= ex1->end;
1863 /* check if @ex1 contains @ex2 */
1864 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
1865 const struct ldlm_extent *ex2)
1867 return ex1->start <= ex2->start && ex1->end >= ex2->end;
1870 int ldlm_inodebits_drop(struct ldlm_lock *lock, __u64 to_drop);