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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 /** \defgroup LDLM Lustre Distributed Lock Manager
35 * Lustre DLM is based on VAX DLM.
36 * Its two main roles are:
37 * - To provide locking assuring consistency of data on all Lustre nodes.
38 * - To allow clients to cache state protected by a lock by holding the
39 * lock until a conflicting lock is requested or it is expired by the LRU.
44 #ifndef _LUSTRE_DLM_H__
45 #define _LUSTRE_DLM_H__
47 #include <lustre_lib.h>
48 #include <lustre_net.h>
49 #include <lustre_import.h>
50 #include <lustre_handles.h>
51 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
54 #include "lustre_dlm_flags.h"
59 extern struct kset *ldlm_ns_kset;
60 extern struct kset *ldlm_svc_kset;
62 #define OBD_LDLM_DEVICENAME "ldlm"
64 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
65 #define LDLM_DEFAULT_MAX_ALIVE 3900 /* 3900 seconds ~65 min */
66 #define LDLM_CTIME_AGE_LIMIT (10)
67 /* if client lock is unused for that time it can be cancelled if any other
68 * client shows interest in that lock, e.g. glimpse is occured. */
69 #define LDLM_DIRTY_AGE_LIMIT (10)
70 #define LDLM_DEFAULT_PARALLEL_AST_LIMIT 1024
73 * LDLM non-error return states
77 ELDLM_LOCK_MATCHED = 1,
79 ELDLM_LOCK_CHANGED = 300,
80 ELDLM_LOCK_ABORTED = 301,
81 ELDLM_LOCK_REPLACED = 302,
82 ELDLM_NO_LOCK_DATA = 303,
83 ELDLM_LOCK_WOULDBLOCK = 304,
85 ELDLM_NAMESPACE_EXISTS = 400,
86 ELDLM_BAD_NAMESPACE = 401,
90 * LDLM namespace type.
91 * The "client" type is actually an indication that this is a narrow local view
92 * into complete namespace on the server. Such namespaces cannot make any
93 * decisions about lack of conflicts or do any autonomous lock granting without
94 * first speaking to a server.
97 LDLM_NAMESPACE_SERVER = 0x01,
98 LDLM_NAMESPACE_CLIENT = 0x02
102 * The blocking callback is overloaded to perform two functions. These flags
103 * indicate which operation should be performed.
105 #define LDLM_CB_BLOCKING 1
106 #define LDLM_CB_CANCELING 2
109 * \name Lock Compatibility Matrix.
111 * A lock has both a type (extent, flock, inode bits, or plain) and a mode.
112 * Lock types are described in their respective implementation files:
113 * ldlm_{extent,flock,inodebits,plain}.c.
115 * There are six lock modes along with a compatibility matrix to indicate if
116 * two locks are compatible.
118 * - EX: Exclusive mode. Before a new file is created, MDS requests EX lock
120 * - PW: Protective Write (normal write) mode. When a client requests a write
121 * lock from an OST, a lock with PW mode will be issued.
122 * - PR: Protective Read (normal read) mode. When a client requests a read from
123 * an OST, a lock with PR mode will be issued. Also, if the client opens a
124 * file for execution, it is granted a lock with PR mode.
125 * - CW: Concurrent Write mode. The type of lock that the MDS grants if a client
126 * requests a write lock during a file open operation.
127 * - CR Concurrent Read mode. When a client performs a path lookup, MDS grants
128 * an inodebit lock with the CR mode on the intermediate path component.
142 #define LCK_COMPAT_EX LCK_NL
143 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
144 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
145 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
146 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
147 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
148 #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL)
149 #define LCK_COMPAT_COS (LCK_COS)
150 /** @} Lock Compatibility Matrix */
152 extern enum ldlm_mode lck_compat_array[];
154 static inline void lockmode_verify(enum ldlm_mode mode)
156 LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
159 static inline int lockmode_compat(enum ldlm_mode exist_mode,
160 enum ldlm_mode new_mode)
162 return lck_compat_array[exist_mode] & new_mode;
167 * cluster name spaces
171 #define DLM_OST_NAMESPACE 1
172 #define DLM_MDS_NAMESPACE 2
175 - do we just separate this by security domains and use a prefix for
176 multiple namespaces in the same domain?
181 * Locking rules for LDLM:
186 * waiting_locks_spinlock
201 struct ldlm_resource;
202 struct ldlm_namespace;
205 * Operations on LDLM pools.
206 * LDLM pool is a pool of locks in the namespace without any implicitly
208 * Locks in the pool are organized in LRU.
209 * Local memory pressure or server instructions (e.g. mempressure on server)
210 * can trigger freeing of locks from the pool
212 struct ldlm_pool_ops {
213 /** Recalculate pool \a pl usage */
214 int (*po_recalc)(struct ldlm_pool *pl);
215 /** Cancel at least \a nr locks from pool \a pl */
216 int (*po_shrink)(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
217 int (*po_setup)(struct ldlm_pool *pl, int limit);
220 /** One second for pools thread check interval. Each pool has own period. */
221 #define LDLM_POOLS_THREAD_PERIOD (1)
223 /** ~6% margin for modest pools. See ldlm_pool.c for details. */
224 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
226 /** Default recalc period for server side pools in sec. */
227 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
229 /** Default recalc period for client side pools in sec. */
230 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
233 * LDLM pool structure to track granted locks.
234 * For purposes of determining when to release locks on e.g. memory pressure.
235 * This feature is commonly referred to as lru_resize.
238 /** Pool debugfs directory. */
239 struct dentry *pl_debugfs_entry;
240 /** Pool name, must be long enough to hold compound proc entry name. */
242 /** Lock for protecting SLV/CLV updates. */
244 /** Number of allowed locks in in pool, both, client and server side. */
246 /** Number of granted locks in */
248 /** Grant rate per T. */
249 atomic_t pl_grant_rate;
250 /** Cancel rate per T. */
251 atomic_t pl_cancel_rate;
252 /** Server lock volume (SLV). Protected by pl_lock. */
253 __u64 pl_server_lock_volume;
254 /** Current biggest client lock volume. Protected by pl_lock. */
255 __u64 pl_client_lock_volume;
256 /** Lock volume factor. SLV on client is calculated as following:
257 * server_slv * lock_volume_factor. */
258 atomic_t pl_lock_volume_factor;
259 /** Time when last SLV from server was obtained. */
260 time64_t pl_recalc_time;
261 /** Recalculation period for pool. */
262 time64_t pl_recalc_period;
263 /** Recalculation and shrink operations. */
264 struct ldlm_pool_ops *pl_ops;
265 /** Number of planned locks for next period. */
267 /** Pool statistics. */
268 struct lprocfs_stats *pl_stats;
271 struct kobject pl_kobj;
272 struct completion pl_kobj_unregister;
275 typedef int (*ldlm_res_policy)(const struct lu_env *env,
276 struct ldlm_namespace *,
277 struct ldlm_lock **, void *req_cookie,
278 enum ldlm_mode mode, __u64 flags, void *data);
280 typedef int (*ldlm_cancel_cbt)(struct ldlm_lock *lock);
284 * LVB is Lock Value Block. This is a special opaque (to LDLM) value that could
285 * be associated with an LDLM lock and transferred from client to server and
288 * Currently LVBs are used by:
289 * - OSC-OST code to maintain current object size/times
290 * - layout lock code to return the layout when the layout lock is granted
292 * To ensure delayed LVB initialization, it is highly recommended to use the set
293 * of ldlm_[res_]lvbo_[init,update,fill]() functions.
295 struct ldlm_valblock_ops {
296 int (*lvbo_init)(struct ldlm_resource *res);
297 int (*lvbo_update)(struct ldlm_resource *res, struct ldlm_lock *lock,
298 struct ptlrpc_request *r, int increase);
299 int (*lvbo_free)(struct ldlm_resource *res);
300 /* Return size of lvb data appropriate RPC size can be reserved */
301 int (*lvbo_size)(struct ldlm_lock *lock);
302 /* Called to fill in lvb data to RPC buffer @buf */
303 int (*lvbo_fill)(struct ldlm_lock *lock, void *buf, int *buflen);
307 * LDLM pools related, type of lock pool in the namespace.
308 * Greedy means release cached locks aggressively
311 LDLM_NAMESPACE_GREEDY = 1 << 0,
312 LDLM_NAMESPACE_MODEST = 1 << 1
316 * Default values for the "max_nolock_size", "contention_time" and
317 * "contended_locks" namespace tunables.
319 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
320 #define NS_DEFAULT_CONTENTION_SECONDS 2
321 #define NS_DEFAULT_CONTENDED_LOCKS 32
323 struct ldlm_ns_bucket {
324 /** back pointer to namespace */
325 struct ldlm_namespace *nsb_namespace;
327 * Estimated lock callback time. Used by adaptive timeout code to
328 * avoid spurious client evictions due to unresponsiveness when in
329 * fact the network or overall system load is at fault
331 struct adaptive_timeout nsb_at_estimate;
333 * Which res in the bucket should we start with the reclaim.
335 int nsb_reclaim_start;
336 /* counter of entries in this bucket */
341 /** LDLM namespace lock stats */
347 LDLM_NS_TYPE_UNKNOWN = 0, /**< invalid type */
348 LDLM_NS_TYPE_MDC, /**< MDC namespace */
349 LDLM_NS_TYPE_MDT, /**< MDT namespace */
350 LDLM_NS_TYPE_OSC, /**< OSC namespace */
351 LDLM_NS_TYPE_OST, /**< OST namespace */
352 LDLM_NS_TYPE_MGC, /**< MGC namespace */
353 LDLM_NS_TYPE_MGT, /**< MGT namespace */
359 * Namespace serves to contain locks related to a particular service.
360 * There are two kinds of namespaces:
361 * - Server namespace has knowledge of all locks and is therefore authoritative
362 * to make decisions like what locks could be granted and what conflicts
363 * exist during new lock enqueue.
364 * - Client namespace only has limited knowledge about locks in the namespace,
365 * only seeing locks held by the client.
367 * Every Lustre service has one server namespace present on the server serving
368 * that service. Every client connected to the service has a client namespace
370 * Every lock obtained by client in that namespace is actually represented by
371 * two in-memory locks. One on the server and one on the client. The locks are
372 * linked by a special cookie by which one node can tell to the other which lock
373 * it actually means during communications. Such locks are called remote locks.
374 * The locks held by server only without any reference to a client are called
377 struct ldlm_namespace {
378 /** Backward link to OBD, required for LDLM pool to store new SLV. */
379 struct obd_device *ns_obd;
381 /** Flag indicating if namespace is on client instead of server */
382 enum ldlm_side ns_client;
384 /** name of this namespace */
387 /** Resource hash table for namespace. */
388 struct cfs_hash *ns_rs_hash;
389 struct ldlm_ns_bucket *ns_rs_buckets;
390 unsigned int ns_bucket_bits;
395 /** big refcount (by bucket) */
399 * Namespace connect flags supported by server (may be changed via
400 * /proc, LRU resize may be disabled/enabled).
402 __u64 ns_connect_flags;
404 /** Client side original connect flags supported by server. */
405 __u64 ns_orig_connect_flags;
407 /* namespace debugfs dir entry */
408 struct dentry *ns_debugfs_entry;
411 * Position in global namespace list linking all namespaces on
414 struct list_head ns_list_chain;
417 * List of unused locks for this namespace. This list is also called
419 * Unused locks are locks with zero reader/writer reference counts.
420 * This list is only used on clients for lock caching purposes.
421 * When we want to release some locks voluntarily or if server wants
422 * us to release some locks due to e.g. memory pressure, we take locks
423 * to release from the head of this list.
424 * Locks are linked via l_lru field in \see struct ldlm_lock.
426 struct list_head ns_unused_list;
427 /** Number of locks in the LRU list above */
429 struct list_head *ns_last_pos;
432 * Maximum number of locks permitted in the LRU. If 0, means locks
433 * are managed by pools and there is no preset limit, rather it is all
434 * controlled by available memory on this client and on server.
436 unsigned int ns_max_unused;
438 /** Maximum allowed age (last used time) for locks in the LRU */
442 * Server only: number of times we evicted clients due to lack of reply
445 unsigned int ns_timeouts;
447 * Number of seconds since the file change time after which the
448 * MDT will return an UPDATE lock along with a LOOKUP lock.
449 * This allows the client to start caching negative dentries
450 * for a directory and may save an RPC for a later stat.
452 time64_t ns_ctime_age_limit;
454 * Number of seconds since the lock was last used. The client may
455 * cancel the lock limited by this age and flush related data if
456 * any other client shows interest in it doing glimpse request.
457 * This allows to cache stat data locally for such files early.
459 time64_t ns_dirty_age_limit;
461 * Used to rate-limit ldlm_namespace_dump calls.
462 * \see ldlm_namespace_dump. Increased by 10 seconds every time
465 time64_t ns_next_dump;
467 /** "policy" function that does actual lock conflict determination */
468 ldlm_res_policy ns_policy;
471 * LVB operations for this namespace.
472 * \see struct ldlm_valblock_ops
474 struct ldlm_valblock_ops *ns_lvbo;
477 * Used by filter code to store pointer to OBD of the service.
478 * Should be dropped in favor of \a ns_obd
483 * Wait queue used by __ldlm_namespace_free. Gets woken up every time
484 * a resource is removed.
486 wait_queue_head_t ns_waitq;
487 /** LDLM pool structure for this namespace */
488 struct ldlm_pool ns_pool;
489 /** Definition of how eagerly unused locks will be released from LRU */
490 enum ldlm_appetite ns_appetite;
493 * If more than \a ns_contended_locks are found, the resource is
494 * considered to be contended. Lock enqueues might specify that no
495 * contended locks should be granted
497 unsigned ns_contended_locks;
500 * The resources in this namespace remember contended state during
501 * \a ns_contention_time, in seconds.
503 time64_t ns_contention_time;
506 * Limit size of contended extent locks, in bytes.
507 * If extended lock is requested for more then this many bytes and
508 * caller instructs us not to grant contended locks, we would disregard
511 unsigned ns_max_nolock_size;
513 /** Limit of parallel AST RPC count. */
514 unsigned ns_max_parallel_ast;
517 * Callback to check if a lock is good to be canceled by ELC or
520 ldlm_cancel_cbt ns_cancel;
522 /** LDLM lock stats */
523 struct lprocfs_stats *ns_stats;
526 * Flag to indicate namespace is being freed. Used to determine if
527 * recalculation of LDLM pool statistics should be skipped.
529 unsigned ns_stopping:1;
532 * Which bucket should we start with the lock reclaim.
534 int ns_reclaim_start;
536 struct kobject ns_kobj; /* sysfs object */
537 struct completion ns_kobj_unregister;
541 * Returns 1 if namespace \a ns is a client namespace.
543 static inline int ns_is_client(struct ldlm_namespace *ns)
546 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
547 ns->ns_client == LDLM_NAMESPACE_SERVER);
548 return ns->ns_client == LDLM_NAMESPACE_CLIENT;
552 * Returns 1 if namespace \a ns is a server namespace.
554 static inline int ns_is_server(struct ldlm_namespace *ns)
557 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
558 ns->ns_client == LDLM_NAMESPACE_SERVER);
559 return ns->ns_client == LDLM_NAMESPACE_SERVER;
563 * Returns 1 if namespace \a ns supports early lock cancel (ELC).
565 static inline int ns_connect_cancelset(struct ldlm_namespace *ns)
568 return !!(ns->ns_connect_flags & OBD_CONNECT_CANCELSET);
572 * Returns 1 if this namespace supports lru_resize.
574 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
577 return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
580 static inline void ns_register_cancel(struct ldlm_namespace *ns,
589 /** Type for blocking callback function of a lock. */
590 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
591 struct ldlm_lock_desc *new, void *data,
593 /** Type for completion callback function of a lock. */
594 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, __u64 flags,
596 /** Type for glimpse callback function of a lock. */
597 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
599 /** Type for created callback function of a lock. */
600 typedef void (*ldlm_created_callback)(struct ldlm_lock *lock);
602 /** Work list for sending GL ASTs to multiple locks. */
603 struct ldlm_glimpse_work {
604 struct ldlm_lock *gl_lock; /* lock to glimpse */
605 struct list_head gl_list; /* linkage to other gl work structs */
606 __u32 gl_flags;/* see LDLM_GL_WORK_* below */
607 union ldlm_gl_desc *gl_desc; /* glimpse descriptor to be packed in
608 * glimpse callback request */
609 ptlrpc_interpterer_t gl_interpret_reply;
610 void *gl_interpret_data;
613 struct ldlm_bl_desc {
614 unsigned int bl_same_client:1,
618 struct ldlm_cb_set_arg {
619 struct ptlrpc_request_set *set;
620 int type; /* LDLM_{CP,BL,GL}_CALLBACK */
622 struct list_head *list;
623 union ldlm_gl_desc *gl_desc; /* glimpse AST descriptor */
624 ptlrpc_interpterer_t gl_interpret_reply;
625 void *gl_interpret_data;
626 struct ldlm_bl_desc *bl_desc;
629 struct ldlm_cb_async_args {
630 struct ldlm_cb_set_arg *ca_set_arg;
631 struct ldlm_lock *ca_lock;
634 /** The ldlm_glimpse_work was slab allocated & must be freed accordingly.*/
635 #define LDLM_GL_WORK_SLAB_ALLOCATED 0x1
637 /** Interval node data for each LDLM_EXTENT lock. */
638 struct ldlm_interval {
639 struct interval_node li_node; /* node for tree management */
640 struct list_head li_group; /* the locks which have the same
641 * policy - group of the policy */
643 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
646 * Interval tree for extent locks.
647 * The interval tree must be accessed under the resource lock.
648 * Interval trees are used for granted extent locks to speed up conflicts
649 * lookup. See ldlm/interval_tree.c for more details.
651 struct ldlm_interval_tree {
654 enum ldlm_mode lit_mode; /* lock mode */
655 struct interval_node *lit_root; /* actual ldlm_interval */
659 * Lists of waiting locks for each inodebit type.
660 * A lock can be in several liq_waiting lists and it remains in lr_waiting.
662 struct ldlm_ibits_queues {
663 struct list_head liq_waiting[MDS_INODELOCK_NUMBITS];
666 struct ldlm_ibits_node {
667 struct list_head lin_link[MDS_INODELOCK_NUMBITS];
668 struct ldlm_lock *lock;
671 /** Whether to track references to exports by LDLM locks. */
672 #define LUSTRE_TRACKS_LOCK_EXP_REFS (0)
675 enum ldlm_cancel_flags {
676 LCF_ASYNC = 0x1, /* Cancel locks asynchronously. */
677 LCF_LOCAL = 0x2, /* Cancel locks locally, not notifing server */
678 LCF_BL_AST = 0x4, /* Cancel LDLM_FL_BL_AST locks in the same RPC */
685 __u64 blocking_owner;
686 struct obd_export *blocking_export;
687 atomic_t blocking_refs;
691 union ldlm_policy_data {
692 struct ldlm_extent l_extent;
693 struct ldlm_flock l_flock;
694 struct ldlm_inodebits l_inodebits;
697 void ldlm_convert_policy_to_wire(enum ldlm_type type,
698 const union ldlm_policy_data *lpolicy,
699 union ldlm_wire_policy_data *wpolicy);
700 void ldlm_convert_policy_to_local(struct obd_export *exp, enum ldlm_type type,
701 const union ldlm_wire_policy_data *wpolicy,
702 union ldlm_policy_data *lpolicy);
712 * LDLM_GID_ANY is used to match any group id in ldlm_lock_match().
714 #define LDLM_GID_ANY ((__u64)-1)
717 * LDLM lock structure
719 * Represents a single LDLM lock and its state in memory. Each lock is
720 * associated with a single ldlm_resource, the object which is being
721 * locked. There may be multiple ldlm_locks on a single resource,
722 * depending on the lock type and whether the locks are conflicting or
728 * When remote side wants to tell us about a lock, they address
729 * it by this opaque handle. The handle does not hold a
730 * reference on the ldlm_lock, so it can be safely passed to
731 * other threads or nodes. When the lock needs to be accessed
732 * from the handle, it is looked up again in the lock table, and
733 * may no longer exist.
735 * Must be first in the structure.
737 struct portals_handle l_handle;
739 * Internal spinlock protects l_resource. We should hold this lock
740 * first before taking res_lock.
744 * Pointer to actual resource this lock is in.
745 * ldlm_lock_change_resource() can change this.
747 struct ldlm_resource *l_resource;
749 * List item for client side LRU list.
750 * Protected by ns_lock in struct ldlm_namespace.
752 struct list_head l_lru;
754 * Linkage to resource's lock queues according to current lock state.
755 * (could be granted or waiting)
756 * Protected by lr_lock in struct ldlm_resource.
758 struct list_head l_res_link;
760 * Internal structures per lock type..
763 struct ldlm_interval *l_tree_node;
764 struct ldlm_ibits_node *l_ibits_node;
767 * Per export hash of locks.
768 * Protected by per-bucket exp->exp_lock_hash locks.
770 struct hlist_node l_exp_hash;
772 * Per export hash of flock locks.
773 * Protected by per-bucket exp->exp_flock_hash locks.
775 struct hlist_node l_exp_flock_hash;
778 * Protected by lr_lock.
780 enum ldlm_mode l_req_mode;
782 * Granted mode, also protected by lr_lock.
784 enum ldlm_mode l_granted_mode;
785 /** Lock completion handler pointer. Called when lock is granted. */
786 ldlm_completion_callback l_completion_ast;
788 * Lock blocking AST handler pointer.
789 * It plays two roles:
790 * - as a notification of an attempt to queue a conflicting lock (once)
791 * - as a notification when the lock is being cancelled.
793 * As such it's typically called twice: once for the initial conflict
794 * and then once more when the last user went away and the lock is
795 * cancelled (could happen recursively).
797 ldlm_blocking_callback l_blocking_ast;
799 * Lock glimpse handler.
800 * Glimpse handler is used to obtain LVB updates from a client by
803 ldlm_glimpse_callback l_glimpse_ast;
807 * This is a pointer to actual client export for locks that were granted
808 * to clients. Used server-side.
810 struct obd_export *l_export;
812 * Lock connection export.
813 * Pointer to server export on a client.
815 struct obd_export *l_conn_export;
818 * Remote lock handle.
819 * If the lock is remote, this is the handle of the other side lock
822 struct lustre_handle l_remote_handle;
825 * Representation of private data specific for a lock type.
826 * Examples are: extent range for extent lock or bitmask for ibits locks
828 union ldlm_policy_data l_policy_data;
831 * Lock state flags. Protected by lr_lock.
832 * \see lustre_dlm_flags.h where the bits are defined.
837 * Lock r/w usage counters.
838 * Protected by lr_lock.
843 * If the lock is granted, a process sleeps on this waitq to learn when
844 * it's no longer in use. If the lock is not granted, a process sleeps
845 * on this waitq to learn when it becomes granted.
847 wait_queue_head_t l_waitq;
850 * Time, in nanoseconds, last used by e.g. being matched by lock match.
854 /** Originally requested extent for the extent lock. */
855 struct ldlm_extent l_req_extent;
858 * Client-side-only members.
861 enum lvb_type l_lvb_type;
864 * Temporary storage for a LVB received during an enqueue operation.
865 * May be vmalloc'd, so needs to be freed with OBD_FREE_LARGE().
870 /** Private storage for lock user. Opaque to LDLM. */
875 * Seconds. It will be updated if there is any activity related to
876 * the lock at client, e.g. enqueue the lock. For server it is the
877 * time when blocking ast was sent.
880 time64_t l_blast_sent;
883 /* separate ost_lvb used mostly by Data-on-MDT for now.
884 * It is introduced to don't mix with layout lock data. */
885 struct ost_lvb l_ost_lvb;
887 * Server-side-only members.
891 * Connection cookie for the client originating the operation.
892 * Used by Commit on Share (COS) code. Currently only used for
893 * inodebits locks on MDS.
895 __u64 l_client_cookie;
898 * List item for locks waiting for cancellation from clients.
899 * The lists this could be linked into are:
900 * waiting_locks_list (protected by waiting_locks_spinlock),
901 * then if the lock timed out, it is moved to
902 * expired_lock_list for further processing.
904 struct list_head l_pending_chain;
907 * Set when lock is sent a blocking AST. Time in seconds when timeout
908 * is reached and client holding this lock could be evicted.
909 * This timeout could be further extended by e.g. certain IO activity
911 * \see ost_rw_prolong_locks
913 time64_t l_callback_timeout;
915 /** Local PID of process which created this lock. */
919 * Number of times blocking AST was sent for this lock.
920 * This is for debugging. Valid values are 0 and 1, if there is an
921 * attempt to send blocking AST more than once, an assertion would be
922 * hit. \see ldlm_work_bl_ast_lock
925 /** List item ldlm_add_ast_work_item() for case of blocking ASTs. */
926 struct list_head l_bl_ast;
927 /** List item ldlm_add_ast_work_item() for case of completion ASTs. */
928 struct list_head l_cp_ast;
929 /** For ldlm_add_ast_work_item() for "revoke" AST used in COS. */
930 struct list_head l_rk_ast;
933 * Pointer to a conflicting lock that caused blocking AST to be sent
936 struct ldlm_lock *l_blocking_lock;
939 * Protected by lr_lock, linkages to "skip lists".
940 * For more explanations of skip lists see ldlm/ldlm_inodebits.c
942 struct list_head l_sl_mode;
943 struct list_head l_sl_policy;
945 /** Reference tracking structure to debug leaked locks. */
946 struct lu_ref l_reference;
947 #if LUSTRE_TRACKS_LOCK_EXP_REFS
948 /* Debugging stuff for bug 20498, for tracking export references. */
949 /** number of export references taken */
951 /** link all locks referencing one export */
952 struct list_head l_exp_refs_link;
953 /** referenced export object */
954 struct obd_export *l_exp_refs_target;
957 * export blocking dlm lock list, protected by
958 * l_export->exp_bl_list_lock.
959 * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
960 * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock.
962 struct list_head l_exp_list;
966 * Describe the overlap between two locks. itree_overlap_cb data.
968 struct ldlm_match_data {
969 struct ldlm_lock *lmd_old;
970 struct ldlm_lock *lmd_lock;
971 enum ldlm_mode *lmd_mode;
972 union ldlm_policy_data *lmd_policy;
974 __u64 lmd_skip_flags;
976 bool lmd_has_ast_data;
979 /** For uncommitted cross-MDT lock, store transno this lock belongs to */
980 #define l_transno l_client_cookie
982 /** For uncommitted cross-MDT lock, which is client lock, share with l_rk_ast
983 * which is for server. */
984 #define l_slc_link l_rk_ast
986 #define HANDLE_MAP_SIZE ((LMV_MAX_STRIPE_COUNT + 7) >> 3)
988 struct lustre_handle_array {
989 unsigned int ha_count;
990 /* ha_map is used as bit flag to indicate handle is remote or local */
991 char ha_map[HANDLE_MAP_SIZE];
992 struct lustre_handle ha_handles[0];
996 * LDLM resource description.
997 * Basically, resource is a representation for a single object.
998 * Object has a name which is currently 4 64-bit integers. LDLM user is
999 * responsible for creation of a mapping between objects it wants to be
1000 * protected and resource names.
1002 * A resource can only hold locks of a single lock type, though there may be
1003 * multiple ldlm_locks on a single resource, depending on the lock type and
1004 * whether the locks are conflicting or not.
1006 struct ldlm_resource {
1007 struct ldlm_ns_bucket *lr_ns_bucket;
1010 * List item for list in namespace hash.
1011 * protected by ns_lock
1013 struct hlist_node lr_hash;
1015 /** Reference count for this resource */
1016 atomic_t lr_refcount;
1018 /** Spinlock to protect locks under this resource. */
1022 * protected by lr_lock
1024 /** List of locks in granted state */
1025 struct list_head lr_granted;
1027 * List of locks that could not be granted due to conflicts and
1028 * that are waiting for conflicts to go away */
1029 struct list_head lr_waiting;
1032 /** Resource name */
1033 struct ldlm_res_id lr_name;
1037 * Interval trees (only for extent locks) for all modes of
1040 struct ldlm_interval_tree *lr_itree;
1041 struct ldlm_ibits_queues *lr_ibits_queues;
1046 * When the resource was considered as contended,
1047 * used only on server side.
1049 time64_t lr_contention_time;
1051 * Associated inode, used only on client side.
1053 struct inode *lr_lvb_inode;
1056 /** Type of locks this resource can hold. Only one type per resource. */
1057 enum ldlm_type lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */
1060 * Server-side-only lock value block elements.
1061 * To serialize lvbo_init.
1064 struct mutex lr_lvb_mutex;
1065 /** protected by lr_lock */
1067 /** is lvb initialized ? */
1068 bool lr_lvb_initialized;
1070 /** List of references to this resource. For debugging. */
1071 struct lu_ref lr_reference;
1074 static inline int ldlm_is_granted(struct ldlm_lock *lock)
1076 return lock->l_req_mode == lock->l_granted_mode;
1079 static inline bool ldlm_has_layout(struct ldlm_lock *lock)
1081 return lock->l_resource->lr_type == LDLM_IBITS &&
1082 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_LAYOUT;
1085 static inline bool ldlm_has_dom(struct ldlm_lock *lock)
1087 return lock->l_resource->lr_type == LDLM_IBITS &&
1088 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_DOM;
1091 static inline char *
1092 ldlm_ns_name(struct ldlm_namespace *ns)
1097 static inline struct ldlm_namespace *
1098 ldlm_res_to_ns(struct ldlm_resource *res)
1100 return res->lr_ns_bucket->nsb_namespace;
1103 static inline struct ldlm_namespace *
1104 ldlm_lock_to_ns(struct ldlm_lock *lock)
1106 return ldlm_res_to_ns(lock->l_resource);
1109 static inline char *
1110 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
1112 return ldlm_ns_name(ldlm_lock_to_ns(lock));
1115 static inline struct adaptive_timeout *
1116 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
1118 return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
1121 static inline int ldlm_lvbo_init(struct ldlm_resource *res)
1123 struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1126 if (ns->ns_lvbo == NULL || ns->ns_lvbo->lvbo_init == NULL ||
1127 res->lr_lvb_initialized)
1130 mutex_lock(&res->lr_lvb_mutex);
1131 /* Did we lose the race? */
1132 if (res->lr_lvb_initialized) {
1133 mutex_unlock(&res->lr_lvb_mutex);
1136 rc = ns->ns_lvbo->lvbo_init(res);
1138 CDEBUG(D_DLMTRACE, "lvbo_init failed for resource : rc = %d\n",
1140 if (res->lr_lvb_data != NULL) {
1141 OBD_FREE(res->lr_lvb_data, res->lr_lvb_len);
1142 res->lr_lvb_data = NULL;
1144 res->lr_lvb_len = rc;
1146 res->lr_lvb_initialized = true;
1148 mutex_unlock(&res->lr_lvb_mutex);
1152 static inline int ldlm_lvbo_size(struct ldlm_lock *lock)
1154 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1156 if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_size != NULL)
1157 return ns->ns_lvbo->lvbo_size(lock);
1162 static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int *len)
1164 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1167 if (ns->ns_lvbo != NULL) {
1168 LASSERT(ns->ns_lvbo->lvbo_fill != NULL);
1169 /* init lvb now if not already */
1170 rc = ldlm_lvbo_init(lock->l_resource);
1172 CERROR("lock %p: delayed lvb init failed (rc %d)",
1176 return ns->ns_lvbo->lvbo_fill(lock, buf, len);
1181 struct ldlm_ast_work {
1182 struct ldlm_lock *w_lock;
1184 struct ldlm_lock_desc w_desc;
1185 struct list_head w_list;
1192 * Common ldlm_enqueue parameters
1194 struct ldlm_enqueue_info {
1195 enum ldlm_type ei_type; /** Type of the lock being enqueued. */
1196 enum ldlm_mode ei_mode; /** Mode of the lock being enqueued. */
1197 void *ei_cb_bl; /** blocking lock callback */
1198 void *ei_cb_local_bl; /** blocking local lock callback */
1199 void *ei_cb_cp; /** lock completion callback */
1200 void *ei_cb_gl; /** lock glimpse callback */
1201 ldlm_created_callback ei_cb_created; /** lock created callback */
1202 void *ei_cbdata; /** Data to be passed into callbacks. */
1203 void *ei_namespace; /** lock namespace **/
1204 u64 ei_inodebits; /** lock inode bits **/
1205 unsigned int ei_enq_slave:1; /** whether enqueue slave stripes */
1206 unsigned int ei_enq_slot:1; /** whether acquire rpc slot */
1209 #define ei_res_id ei_cb_gl
1211 extern char *ldlm_lockname[];
1212 extern char *ldlm_typename[];
1213 extern const char *ldlm_it2str(enum ldlm_intent_flags it);
1216 * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG.
1217 * For the cases where we do not have actual lock to print along
1218 * with a debugging message that is ldlm-related
1220 #define LDLM_DEBUG_NOLOCK(format, a...) \
1221 CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
1224 * Support function for lock information printing into debug logs.
1228 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do { \
1229 CFS_CHECK_STACK(msgdata, mask, cdls); \
1231 if (((mask) & D_CANTMASK) != 0 || \
1232 ((libcfs_debug & (mask)) != 0 && \
1233 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1234 _ldlm_lock_debug(lock, msgdata, fmt, ##a); \
1237 void _ldlm_lock_debug(struct ldlm_lock *lock,
1238 struct libcfs_debug_msg_data *data,
1239 const char *fmt, ...)
1240 __attribute__ ((format (printf, 3, 4)));
1243 * Rate-limited version of lock printing function.
1245 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do { \
1246 static struct cfs_debug_limit_state _ldlm_cdls; \
1247 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls); \
1248 ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
1251 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
1252 #define LDLM_WARN(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
1254 /** Non-rate-limited lock printing function for debugging purposes. */
1255 #define LDLM_DEBUG(lock, fmt, a...) do { \
1256 if (likely(lock != NULL)) { \
1257 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL); \
1258 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock, \
1259 "### " fmt , ##a); \
1261 LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a); \
1264 #else /* !LIBCFS_DEBUG */
1265 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
1266 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
1267 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
1271 * Three intentions can be used for the policy functions in
1272 * ldlm_processing_policy.
1274 * LDLM_PROCESS_RESCAN:
1276 * It's used when policy functions are called from ldlm_reprocess_queue() to
1277 * reprocess the wait list and try to grant locks, blocking ASTs
1278 * have already been sent in this situation, completion ASTs need be sent for
1279 * the locks being granted.
1281 * LDLM_PROCESS_ENQUEUE:
1283 * It's used when policy functions are called from ldlm_lock_enqueue() to
1284 * process the wait list for handling an enqueue request, blocking
1285 * ASTs have not been sent yet, so list of conflicting locks would be
1286 * collected and ASTs sent.
1288 * LDLM_PROCESS_RECOVERY:
1290 * It's used when policy functions are called from ldlm_reprocess_queue() to
1291 * reprocess the wait list when recovery done. In case of blocking
1292 * ASTs are lost before recovery, it needs not only to grant locks if
1293 * available, but also send blocking ASTs to the locks doesn't have AST sent
1294 * flag. Completion ASTs need be sent for the locks being granted.
1296 enum ldlm_process_intention {
1297 LDLM_PROCESS_RESCAN = 0,
1298 LDLM_PROCESS_ENQUEUE = 1,
1299 LDLM_PROCESS_RECOVERY = 2,
1302 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags,
1303 enum ldlm_process_intention intention,
1304 enum ldlm_error *err,
1305 struct list_head *work_list);
1307 typedef int (*ldlm_reprocessing_policy)(struct ldlm_resource *res,
1308 struct list_head *queue,
1309 struct list_head *work_list,
1310 enum ldlm_process_intention intention,
1311 struct ldlm_lock *hint);
1314 * Return values for lock iterators.
1315 * Also used during deciding of lock grants and cancellations.
1317 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
1318 #define LDLM_ITER_STOP 2 /* stop iterating */
1320 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
1321 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
1323 /** \defgroup ldlm_iterator Lock iterators
1325 * LDLM provides for a way to iterate through every lock on a resource or
1326 * namespace or every resource in a namespace.
1328 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1330 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1332 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
1333 ldlm_iterator_t iter, void *data);
1334 /** @} ldlm_iterator */
1336 int ldlm_replay_locks(struct obd_import *imp);
1339 int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1342 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
1344 struct ldlm_prolong_args {
1345 struct obd_export *lpa_export;
1346 struct ldlm_res_id lpa_resid;
1347 struct ldlm_extent lpa_extent;
1348 enum ldlm_mode lpa_mode;
1349 time64_t lpa_timeout;
1353 void ldlm_lock_prolong_one(struct ldlm_lock *lock,
1354 struct ldlm_prolong_args *arg);
1355 void ldlm_resource_prolong(struct ldlm_prolong_args *arg);
1357 struct ldlm_callback_suite {
1358 ldlm_completion_callback lcs_completion;
1359 ldlm_blocking_callback lcs_blocking;
1360 ldlm_glimpse_callback lcs_glimpse;
1364 #ifdef HAVE_SERVER_SUPPORT
1365 /** \defgroup ldlm_srv_ast Server AST handlers
1366 * These are AST handlers used by server code.
1367 * Their property is that they are just preparing RPCs to be sent to clients.
1370 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1371 void *data, int flag);
1372 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1373 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
1374 int ldlm_glimpse_locks(struct ldlm_resource *res,
1375 struct list_head *gl_work_list);
1376 /** @} ldlm_srv_ast */
1378 /** \defgroup ldlm_handlers Server LDLM handlers
1379 * These are handler functions that should be called by "frontends" such as
1380 * MDT or OST to pass through LDLM requests to LDLM for handling
1383 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1384 const struct ldlm_request *dlm_req,
1385 const struct ldlm_callback_suite *cbs);
1386 int ldlm_handle_convert0(struct ptlrpc_request *req,
1387 const struct ldlm_request *dlm_req);
1388 int ldlm_handle_cancel(struct ptlrpc_request *req);
1389 int ldlm_request_cancel(struct ptlrpc_request *req,
1390 const struct ldlm_request *dlm_req,
1391 int first, enum lustre_at_flags flags);
1392 /** @} ldlm_handlers */
1394 void ldlm_revoke_export_locks(struct obd_export *exp);
1395 time64_t ldlm_bl_timeout(struct ldlm_lock *lock);
1397 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1398 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, time64_t timeout);
1399 int ldlm_get_ref(void);
1400 void ldlm_put_ref(void);
1401 int ldlm_init_export(struct obd_export *exp);
1402 void ldlm_destroy_export(struct obd_export *exp);
1403 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req);
1406 #ifdef HAVE_SERVER_SUPPORT
1407 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1408 ldlm_reprocessing_policy
1409 ldlm_get_reprocessing_policy(struct ldlm_resource *res);
1411 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1412 void ldlm_lock2handle(const struct ldlm_lock *lock,
1413 struct lustre_handle *lockh);
1414 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags);
1415 void ldlm_cancel_callback(struct ldlm_lock *);
1416 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1417 int ldlm_lock_set_data(const struct lustre_handle *lockh, void *data);
1420 * Obtain a lock reference by its handle.
1422 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1424 return __ldlm_handle2lock(h, 0);
1427 #define LDLM_LOCK_REF_DEL(lock) \
1428 lu_ref_del(&lock->l_reference, "handle", current)
1430 static inline struct ldlm_lock *
1431 ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags)
1433 struct ldlm_lock *lock;
1435 lock = __ldlm_handle2lock(h, flags);
1437 LDLM_LOCK_REF_DEL(lock);
1442 * Update Lock Value Block Operations (LVBO) on a resource taking into account
1443 * data from request \a r
1445 static inline int ldlm_lvbo_update(struct ldlm_resource *res,
1446 struct ldlm_lock *lock,
1447 struct ptlrpc_request *req, int increase)
1449 struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1452 /* delayed lvb init may be required */
1453 rc = ldlm_lvbo_init(res);
1455 CERROR("delayed lvb init failed (rc %d)\n", rc);
1459 if (ns->ns_lvbo && ns->ns_lvbo->lvbo_update)
1460 return ns->ns_lvbo->lvbo_update(res, lock, req, increase);
1465 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1466 struct ptlrpc_request *req,
1469 return ldlm_lvbo_update(res, NULL, req, increase);
1472 int is_granted_or_cancelled_nolock(struct ldlm_lock *lock);
1474 int ldlm_error2errno(enum ldlm_error error);
1475 enum ldlm_error ldlm_errno2error(int err_no); /* don't call it `errno': this
1476 * confuses user-space. */
1477 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1478 void ldlm_dump_export_locks(struct obd_export *exp);
1482 * Release a temporary lock reference obtained by ldlm_handle2lock() or
1483 * __ldlm_handle2lock().
1485 #define LDLM_LOCK_PUT(lock) \
1487 LDLM_LOCK_REF_DEL(lock); \
1488 /*LDLM_DEBUG((lock), "put");*/ \
1489 ldlm_lock_put(lock); \
1493 * Release a lock reference obtained by some other means (see
1496 #define LDLM_LOCK_RELEASE(lock) \
1498 /*LDLM_DEBUG((lock), "put");*/ \
1499 ldlm_lock_put(lock); \
1502 #define LDLM_LOCK_GET(lock) \
1504 ldlm_lock_get(lock); \
1505 /*LDLM_DEBUG((lock), "get");*/ \
1509 #define ldlm_lock_list_put(head, member, count) \
1511 struct ldlm_lock *_lock, *_next; \
1513 list_for_each_entry_safe(_lock, _next, head, member) { \
1516 list_del_init(&_lock->member); \
1517 LDLM_LOCK_RELEASE(_lock); \
1522 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1523 void ldlm_lock_put(struct ldlm_lock *lock);
1524 void ldlm_lock_destroy(struct ldlm_lock *lock);
1525 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1526 void ldlm_lock_addref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1527 int ldlm_lock_addref_try(const struct lustre_handle *lockh,
1528 enum ldlm_mode mode);
1529 void ldlm_lock_decref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1530 void ldlm_lock_decref_and_cancel(const struct lustre_handle *lockh,
1531 enum ldlm_mode mode);
1532 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1533 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1534 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1535 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1536 enum ldlm_mode ldlm_lock_match_with_skip(struct ldlm_namespace *ns,
1537 __u64 flags, __u64 skip_flags,
1538 const struct ldlm_res_id *res_id,
1539 enum ldlm_type type,
1540 union ldlm_policy_data *policy,
1541 enum ldlm_mode mode,
1542 struct lustre_handle *lh,
1544 static inline enum ldlm_mode ldlm_lock_match(struct ldlm_namespace *ns,
1546 const struct ldlm_res_id *res_id,
1547 enum ldlm_type type,
1548 union ldlm_policy_data *policy,
1549 enum ldlm_mode mode,
1550 struct lustre_handle *lh,
1553 return ldlm_lock_match_with_skip(ns, flags, 0, res_id, type, policy,
1556 struct ldlm_lock *search_itree(struct ldlm_resource *res,
1557 struct ldlm_match_data *data);
1558 enum ldlm_mode ldlm_revalidate_lock_handle(const struct lustre_handle *lockh,
1560 void ldlm_lock_mode_downgrade(struct ldlm_lock *lock, enum ldlm_mode new_mode);
1561 void ldlm_lock_cancel(struct ldlm_lock *lock);
1562 void ldlm_reprocess_all(struct ldlm_resource *res, struct ldlm_lock *hint);
1563 void ldlm_reprocess_recovery_done(struct ldlm_namespace *ns);
1564 void ldlm_lock_dump_handle(int level, const struct lustre_handle *lockh);
1565 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1568 struct ldlm_namespace *ldlm_namespace_new(struct obd_device *obd, char *name,
1569 enum ldlm_side client,
1570 enum ldlm_appetite apt,
1571 enum ldlm_ns_type ns_type);
1572 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags);
1573 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
1574 struct obd_import *imp,
1576 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
1577 void ldlm_namespace_free(struct ldlm_namespace *ns,
1578 struct obd_import *imp, int force);
1579 void ldlm_namespace_register(struct ldlm_namespace *ns, enum ldlm_side client);
1580 void ldlm_namespace_unregister(struct ldlm_namespace *ns,
1581 enum ldlm_side client);
1582 void ldlm_namespace_get(struct ldlm_namespace *ns);
1583 void ldlm_namespace_put(struct ldlm_namespace *ns);
1585 int ldlm_debugfs_setup(void);
1586 void ldlm_debugfs_cleanup(void);
1588 static inline void ldlm_svc_get_eopc(const struct ldlm_request *dlm_req,
1589 struct lprocfs_stats *srv_stats)
1591 int lock_type = 0, op = 0;
1593 lock_type = dlm_req->lock_desc.l_resource.lr_type;
1595 switch (lock_type) {
1597 op = PTLRPC_LAST_CNTR + LDLM_PLAIN_ENQUEUE;
1600 op = PTLRPC_LAST_CNTR + LDLM_EXTENT_ENQUEUE;
1603 op = PTLRPC_LAST_CNTR + LDLM_FLOCK_ENQUEUE;
1606 op = PTLRPC_LAST_CNTR + LDLM_IBITS_ENQUEUE;
1614 lprocfs_counter_incr(srv_stats, op);
1617 /* resource.c - internal */
1618 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1619 struct ldlm_resource *parent,
1620 const struct ldlm_res_id *,
1621 enum ldlm_type type, int create);
1622 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1623 int ldlm_resource_putref(struct ldlm_resource *res);
1624 void ldlm_resource_add_lock(struct ldlm_resource *res,
1625 struct list_head *head,
1626 struct ldlm_lock *lock);
1627 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1628 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1629 void ldlm_dump_all_namespaces(enum ldlm_side client, int level);
1630 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1631 void ldlm_resource_dump(int level, struct ldlm_resource *);
1632 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1633 const struct ldlm_res_id *);
1635 #define LDLM_RESOURCE_ADDREF(res) do { \
1636 lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, current); \
1639 #define LDLM_RESOURCE_DELREF(res) do { \
1640 lu_ref_del(&(res)->lr_reference, __FUNCTION__, current); \
1643 /* ldlm_request.c */
1644 int ldlm_expired_completion_wait(void *data);
1645 /** \defgroup ldlm_local_ast Default AST handlers for local locks
1646 * These AST handlers are typically used for server-side local locks and are
1647 * also used by client-side lock handlers to perform minimum level base
1650 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1651 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1652 void *data, int flag);
1653 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1654 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data);
1655 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1656 /** @} ldlm_local_ast */
1658 /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users.
1659 * These are typically used by client and server (*_local versions)
1660 * to obtain and release locks.
1662 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1663 struct ldlm_enqueue_info *einfo,
1664 const struct ldlm_res_id *res_id,
1665 union ldlm_policy_data const *policy, __u64 *flags,
1666 void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
1667 struct lustre_handle *lockh, int async);
1668 int ldlm_prep_enqueue_req(struct obd_export *exp,
1669 struct ptlrpc_request *req,
1670 struct list_head *cancels,
1672 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
1673 int version, int opc, int canceloff,
1674 struct list_head *cancels, int count);
1676 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len);
1677 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1678 const struct ldlm_request *dlm_req,
1679 const struct ldlm_callback_suite *cbs);
1680 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1681 enum ldlm_type type, __u8 with_policy,
1682 enum ldlm_mode mode, __u64 *flags, void *lvb,
1684 const struct lustre_handle *lockh, int rc);
1685 int ldlm_cli_enqueue_local(const struct lu_env *env,
1686 struct ldlm_namespace *ns,
1687 const struct ldlm_res_id *res_id,
1688 enum ldlm_type type, union ldlm_policy_data *policy,
1689 enum ldlm_mode mode, __u64 *flags,
1690 ldlm_blocking_callback blocking,
1691 ldlm_completion_callback completion,
1692 ldlm_glimpse_callback glimpse,
1693 void *data, __u32 lvb_len, enum lvb_type lvb_type,
1694 const __u64 *client_cookie,
1695 struct lustre_handle *lockh);
1696 int ldlm_cli_convert_req(struct ldlm_lock *lock, __u32 *flags, __u64 new_bits);
1697 int ldlm_cli_convert(struct ldlm_lock *lock,
1698 enum ldlm_cancel_flags cancel_flags);
1699 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1700 int ldlm_cli_cancel(const struct lustre_handle *lockh,
1701 enum ldlm_cancel_flags cancel_flags);
1702 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1703 enum ldlm_cancel_flags flags, void *opaque);
1704 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1705 const struct ldlm_res_id *res_id,
1706 union ldlm_policy_data *policy,
1707 enum ldlm_mode mode,
1708 enum ldlm_cancel_flags flags, void *opaque);
1709 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
1710 int count, enum ldlm_cancel_flags flags);
1711 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1712 struct list_head *cancels,
1713 union ldlm_policy_data *policy,
1714 enum ldlm_mode mode, __u64 lock_flags,
1715 enum ldlm_cancel_flags cancel_flags,
1717 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1718 enum ldlm_cancel_flags flags);
1719 int ldlm_cli_cancel_list(struct list_head *head, int count,
1720 struct ptlrpc_request *req,
1721 enum ldlm_cancel_flags flags);
1723 int ldlm_inodebits_drop(struct ldlm_lock *lock, __u64 to_drop);
1724 int ldlm_cli_inodebits_convert(struct ldlm_lock *lock,
1725 enum ldlm_cancel_flags cancel_flags);
1727 /** @} ldlm_cli_api */
1730 /* This has to be here because recursive inclusion sucks. */
1731 int intent_disposition(struct ldlm_reply *rep, int flag);
1732 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1735 * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1736 * than one lock_res is dead-lock safe.
1738 enum lock_res_type {
1743 /** Lock resource. */
1744 static inline void lock_res(struct ldlm_resource *res)
1746 spin_lock(&res->lr_lock);
1749 /** Lock resource with a way to instruct lockdep code about nestedness-safe. */
1750 static inline void lock_res_nested(struct ldlm_resource *res,
1751 enum lock_res_type mode)
1753 spin_lock_nested(&res->lr_lock, mode);
1756 /** Unlock resource. */
1757 static inline void unlock_res(struct ldlm_resource *res)
1759 spin_unlock(&res->lr_lock);
1762 /** Check if resource is already locked, assert if not. */
1763 static inline void check_res_locked(struct ldlm_resource *res)
1765 assert_spin_locked(&res->lr_lock);
1768 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1769 void unlock_res_and_lock(struct ldlm_lock *lock);
1772 /** \defgroup ldlm_pools Various LDLM pool related functions
1773 * There are not used outside of ldlm.
1776 int ldlm_pools_init(void);
1777 void ldlm_pools_fini(void);
1779 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1780 int idx, enum ldlm_side client);
1781 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
1782 void ldlm_pool_fini(struct ldlm_pool *pl);
1783 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1784 time64_t ldlm_pool_recalc(struct ldlm_pool *pl);
1785 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1786 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1787 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1788 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1789 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1790 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1791 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1792 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1793 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1796 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
1797 const struct ldlm_extent *ex2)
1799 return ex1->start <= ex2->end && ex2->start <= ex1->end;
1802 /* check if @ex1 contains @ex2 */
1803 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
1804 const struct ldlm_extent *ex2)
1806 return ex1->start <= ex2->start && ex1->end >= ex2->end;
1809 int ldlm_inodebits_drop(struct ldlm_lock *lock, __u64 to_drop);