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, 2016, 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 (cfs_time_seconds(3900)) /* 65 min */
66 #define LDLM_CTIME_AGE_LIMIT (10)
67 #define LDLM_DEFAULT_PARALLEL_AST_LIMIT 1024
70 * LDLM non-error return states
74 ELDLM_LOCK_MATCHED = 1,
76 ELDLM_LOCK_CHANGED = 300,
77 ELDLM_LOCK_ABORTED = 301,
78 ELDLM_LOCK_REPLACED = 302,
79 ELDLM_NO_LOCK_DATA = 303,
80 ELDLM_LOCK_WOULDBLOCK = 304,
82 ELDLM_NAMESPACE_EXISTS = 400,
83 ELDLM_BAD_NAMESPACE = 401,
87 * LDLM namespace type.
88 * The "client" type is actually an indication that this is a narrow local view
89 * into complete namespace on the server. Such namespaces cannot make any
90 * decisions about lack of conflicts or do any autonomous lock granting without
91 * first speaking to a server.
94 LDLM_NAMESPACE_SERVER = 0x01,
95 LDLM_NAMESPACE_CLIENT = 0x02
99 * The blocking callback is overloaded to perform two functions. These flags
100 * indicate which operation should be performed.
102 #define LDLM_CB_BLOCKING 1
103 #define LDLM_CB_CANCELING 2
106 * \name Lock Compatibility Matrix.
108 * A lock has both a type (extent, flock, inode bits, or plain) and a mode.
109 * Lock types are described in their respective implementation files:
110 * ldlm_{extent,flock,inodebits,plain}.c.
112 * There are six lock modes along with a compatibility matrix to indicate if
113 * two locks are compatible.
115 * - EX: Exclusive mode. Before a new file is created, MDS requests EX lock
117 * - PW: Protective Write (normal write) mode. When a client requests a write
118 * lock from an OST, a lock with PW mode will be issued.
119 * - PR: Protective Read (normal read) mode. When a client requests a read from
120 * an OST, a lock with PR mode will be issued. Also, if the client opens a
121 * file for execution, it is granted a lock with PR mode.
122 * - CW: Concurrent Write mode. The type of lock that the MDS grants if a client
123 * requests a write lock during a file open operation.
124 * - CR Concurrent Read mode. When a client performs a path lookup, MDS grants
125 * an inodebit lock with the CR mode on the intermediate path component.
139 #define LCK_COMPAT_EX LCK_NL
140 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
141 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
142 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
143 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
144 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
145 #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL)
146 #define LCK_COMPAT_COS (LCK_COS)
147 /** @} Lock Compatibility Matrix */
149 extern enum ldlm_mode lck_compat_array[];
151 static inline void lockmode_verify(enum ldlm_mode mode)
153 LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
156 static inline int lockmode_compat(enum ldlm_mode exist_mode,
157 enum ldlm_mode new_mode)
159 return lck_compat_array[exist_mode] & new_mode;
164 * cluster name spaces
168 #define DLM_OST_NAMESPACE 1
169 #define DLM_MDS_NAMESPACE 2
172 - do we just separate this by security domains and use a prefix for
173 multiple namespaces in the same domain?
178 * Locking rules for LDLM:
183 * waiting_locks_spinlock
198 struct ldlm_resource;
199 struct ldlm_namespace;
202 * Operations on LDLM pools.
203 * LDLM pool is a pool of locks in the namespace without any implicitly
205 * Locks in the pool are organized in LRU.
206 * Local memory pressure or server instructions (e.g. mempressure on server)
207 * can trigger freeing of locks from the pool
209 struct ldlm_pool_ops {
210 /** Recalculate pool \a pl usage */
211 int (*po_recalc)(struct ldlm_pool *pl);
212 /** Cancel at least \a nr locks from pool \a pl */
213 int (*po_shrink)(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
214 int (*po_setup)(struct ldlm_pool *pl, int limit);
217 /** One second for pools thread check interval. Each pool has own period. */
218 #define LDLM_POOLS_THREAD_PERIOD (1)
220 /** ~6% margin for modest pools. See ldlm_pool.c for details. */
221 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
223 /** Default recalc period for server side pools in sec. */
224 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
226 /** Default recalc period for client side pools in sec. */
227 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
230 * LDLM pool structure to track granted locks.
231 * For purposes of determining when to release locks on e.g. memory pressure.
232 * This feature is commonly referred to as lru_resize.
235 /** Pool proc directory. */
236 struct proc_dir_entry *pl_proc_dir;
237 /** Pool name, must be long enough to hold compound proc entry name. */
239 /** Lock for protecting SLV/CLV updates. */
241 /** Number of allowed locks in in pool, both, client and server side. */
243 /** Number of granted locks in */
245 /** Grant rate per T. */
246 atomic_t pl_grant_rate;
247 /** Cancel rate per T. */
248 atomic_t pl_cancel_rate;
249 /** Server lock volume (SLV). Protected by pl_lock. */
250 __u64 pl_server_lock_volume;
251 /** Current biggest client lock volume. Protected by pl_lock. */
252 __u64 pl_client_lock_volume;
253 /** Lock volume factor. SLV on client is calculated as following:
254 * server_slv * lock_volume_factor. */
255 atomic_t pl_lock_volume_factor;
256 /** Time when last SLV from server was obtained. */
257 time64_t pl_recalc_time;
258 /** Recalculation period for pool. */
259 time64_t pl_recalc_period;
260 /** Recalculation and shrink operations. */
261 struct ldlm_pool_ops *pl_ops;
262 /** Number of planned locks for next period. */
264 /** Pool statistics. */
265 struct lprocfs_stats *pl_stats;
268 struct kobject pl_kobj;
269 struct completion pl_kobj_unregister;
272 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
273 void *req_cookie, enum ldlm_mode mode,
274 __u64 flags, void *data);
276 typedef int (*ldlm_cancel_cbt)(struct ldlm_lock *lock);
280 * LVB is Lock Value Block. This is a special opaque (to LDLM) value that could
281 * be associated with an LDLM lock and transferred from client to server and
284 * Currently LVBs are used by:
285 * - OSC-OST code to maintain current object size/times
286 * - layout lock code to return the layout when the layout lock is granted
288 * To ensure delayed LVB initialization, it is highly recommended to use the set
289 * of ldlm_[res_]lvbo_[init,update,fill]() functions.
291 struct ldlm_valblock_ops {
292 int (*lvbo_init)(struct ldlm_resource *res);
293 int (*lvbo_update)(struct ldlm_resource *res,
294 struct ptlrpc_request *r,
296 int (*lvbo_free)(struct ldlm_resource *res);
297 /* Return size of lvb data appropriate RPC size can be reserved */
298 int (*lvbo_size)(struct ldlm_lock *lock);
299 /* Called to fill in lvb data to RPC buffer @buf */
300 int (*lvbo_fill)(struct ldlm_lock *lock, void *buf, int buflen);
304 * LDLM pools related, type of lock pool in the namespace.
305 * Greedy means release cached locks aggressively
308 LDLM_NAMESPACE_GREEDY = 1 << 0,
309 LDLM_NAMESPACE_MODEST = 1 << 1
313 * Default values for the "max_nolock_size", "contention_time" and
314 * "contended_locks" namespace tunables.
316 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
317 #define NS_DEFAULT_CONTENTION_SECONDS 2
318 #define NS_DEFAULT_CONTENDED_LOCKS 32
320 struct ldlm_ns_bucket {
321 /** back pointer to namespace */
322 struct ldlm_namespace *nsb_namespace;
324 * Estimated lock callback time. Used by adaptive timeout code to
325 * avoid spurious client evictions due to unresponsiveness when in
326 * fact the network or overall system load is at fault
328 struct adaptive_timeout nsb_at_estimate;
330 * Which res in the bucket should we start with the reclaim.
332 int nsb_reclaim_start;
336 /** LDLM namespace lock stats */
342 LDLM_NS_TYPE_UNKNOWN = 0, /**< invalid type */
343 LDLM_NS_TYPE_MDC, /**< MDC namespace */
344 LDLM_NS_TYPE_MDT, /**< MDT namespace */
345 LDLM_NS_TYPE_OSC, /**< OSC namespace */
346 LDLM_NS_TYPE_OST, /**< OST namespace */
347 LDLM_NS_TYPE_MGC, /**< MGC namespace */
348 LDLM_NS_TYPE_MGT, /**< MGT namespace */
354 * Namespace serves to contain locks related to a particular service.
355 * There are two kinds of namespaces:
356 * - Server namespace has knowledge of all locks and is therefore authoritative
357 * to make decisions like what locks could be granted and what conflicts
358 * exist during new lock enqueue.
359 * - Client namespace only has limited knowledge about locks in the namespace,
360 * only seeing locks held by the client.
362 * Every Lustre service has one server namespace present on the server serving
363 * that service. Every client connected to the service has a client namespace
365 * Every lock obtained by client in that namespace is actually represented by
366 * two in-memory locks. One on the server and one on the client. The locks are
367 * linked by a special cookie by which one node can tell to the other which lock
368 * it actually means during communications. Such locks are called remote locks.
369 * The locks held by server only without any reference to a client are called
372 struct ldlm_namespace {
373 /** Backward link to OBD, required for LDLM pool to store new SLV. */
374 struct obd_device *ns_obd;
376 /** Flag indicating if namespace is on client instead of server */
377 enum ldlm_side ns_client;
379 /** Resource hash table for namespace. */
380 struct cfs_hash *ns_rs_hash;
385 /** big refcount (by bucket) */
389 * Namespace connect flags supported by server (may be changed via
390 * /proc, LRU resize may be disabled/enabled).
392 __u64 ns_connect_flags;
394 /** Client side original connect flags supported by server. */
395 __u64 ns_orig_connect_flags;
397 /* namespace proc dir entry */
398 struct proc_dir_entry *ns_proc_dir_entry;
401 * Position in global namespace list linking all namespaces on
404 struct list_head ns_list_chain;
407 * List of unused locks for this namespace. This list is also called
409 * Unused locks are locks with zero reader/writer reference counts.
410 * This list is only used on clients for lock caching purposes.
411 * When we want to release some locks voluntarily or if server wants
412 * us to release some locks due to e.g. memory pressure, we take locks
413 * to release from the head of this list.
414 * Locks are linked via l_lru field in \see struct ldlm_lock.
416 struct list_head ns_unused_list;
417 /** Number of locks in the LRU list above */
421 * Maximum number of locks permitted in the LRU. If 0, means locks
422 * are managed by pools and there is no preset limit, rather it is all
423 * controlled by available memory on this client and on server.
425 unsigned int ns_max_unused;
426 /** Maximum allowed age (last used time) for locks in the LRU */
427 unsigned int ns_max_age;
429 * Server only: number of times we evicted clients due to lack of reply
432 unsigned int ns_timeouts;
434 * Number of seconds since the file change time after which the
435 * MDT will return an UPDATE lock along with a LOOKUP lock.
436 * This allows the client to start caching negative dentries
437 * for a directory and may save an RPC for a later stat.
439 unsigned int ns_ctime_age_limit;
442 * Used to rate-limit ldlm_namespace_dump calls.
443 * \see ldlm_namespace_dump. Increased by 10 seconds every time
446 cfs_time_t ns_next_dump;
448 /** "policy" function that does actual lock conflict determination */
449 ldlm_res_policy ns_policy;
452 * LVB operations for this namespace.
453 * \see struct ldlm_valblock_ops
455 struct ldlm_valblock_ops *ns_lvbo;
458 * Used by filter code to store pointer to OBD of the service.
459 * Should be dropped in favor of \a ns_obd
464 * Wait queue used by __ldlm_namespace_free. Gets woken up every time
465 * a resource is removed.
467 wait_queue_head_t ns_waitq;
468 /** LDLM pool structure for this namespace */
469 struct ldlm_pool ns_pool;
470 /** Definition of how eagerly unused locks will be released from LRU */
471 enum ldlm_appetite ns_appetite;
474 * If more than \a ns_contended_locks are found, the resource is
475 * considered to be contended. Lock enqueues might specify that no
476 * contended locks should be granted
478 unsigned ns_contended_locks;
481 * The resources in this namespace remember contended state during
482 * \a ns_contention_time, in seconds.
484 unsigned ns_contention_time;
487 * Limit size of contended extent locks, in bytes.
488 * If extended lock is requested for more then this many bytes and
489 * caller instructs us not to grant contended locks, we would disregard
492 unsigned ns_max_nolock_size;
494 /** Limit of parallel AST RPC count. */
495 unsigned ns_max_parallel_ast;
498 * Callback to check if a lock is good to be canceled by ELC or
501 ldlm_cancel_cbt ns_cancel;
503 /** LDLM lock stats */
504 struct lprocfs_stats *ns_stats;
507 * Flag to indicate namespace is being freed. Used to determine if
508 * recalculation of LDLM pool statistics should be skipped.
510 unsigned ns_stopping:1;
513 * Which bucket should we start with the lock reclaim.
515 int ns_reclaim_start;
517 struct kobject ns_kobj; /* sysfs object */
518 struct completion ns_kobj_unregister;
522 * Returns 1 if namespace \a ns is a client namespace.
524 static inline int ns_is_client(struct ldlm_namespace *ns)
527 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
528 LDLM_NAMESPACE_SERVER)));
529 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
530 ns->ns_client == LDLM_NAMESPACE_SERVER);
531 return ns->ns_client == LDLM_NAMESPACE_CLIENT;
535 * Returns 1 if namespace \a ns is a server namespace.
537 static inline int ns_is_server(struct ldlm_namespace *ns)
540 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
541 LDLM_NAMESPACE_SERVER)));
542 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
543 ns->ns_client == LDLM_NAMESPACE_SERVER);
544 return ns->ns_client == LDLM_NAMESPACE_SERVER;
548 * Returns 1 if namespace \a ns supports early lock cancel (ELC).
550 static inline int ns_connect_cancelset(struct ldlm_namespace *ns)
553 return !!(ns->ns_connect_flags & OBD_CONNECT_CANCELSET);
557 * Returns 1 if this namespace supports lru_resize.
559 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
562 return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
565 static inline void ns_register_cancel(struct ldlm_namespace *ns,
574 /** Type for blocking callback function of a lock. */
575 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
576 struct ldlm_lock_desc *new, void *data,
578 /** Type for completion callback function of a lock. */
579 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, __u64 flags,
581 /** Type for glimpse callback function of a lock. */
582 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
584 /** Work list for sending GL ASTs to multiple locks. */
585 struct ldlm_glimpse_work {
586 struct ldlm_lock *gl_lock; /* lock to glimpse */
587 struct list_head gl_list; /* linkage to other gl work structs */
588 __u32 gl_flags;/* see LDLM_GL_WORK_* below */
589 union ldlm_gl_desc *gl_desc; /* glimpse descriptor to be packed in
590 * glimpse callback request */
591 ptlrpc_interpterer_t gl_interpret_reply;
592 void *gl_interpret_data;
595 struct ldlm_cb_set_arg {
596 struct ptlrpc_request_set *set;
597 int type; /* LDLM_{CP,BL,GL}_CALLBACK */
599 struct list_head *list;
600 union ldlm_gl_desc *gl_desc; /* glimpse AST descriptor */
601 ptlrpc_interpterer_t gl_interpret_reply;
602 void *gl_interpret_data;
605 struct ldlm_cb_async_args {
606 struct ldlm_cb_set_arg *ca_set_arg;
607 struct ldlm_lock *ca_lock;
610 /** The ldlm_glimpse_work is allocated on the stack and should not be freed. */
611 #define LDLM_GL_WORK_NOFREE 0x1
613 /** Interval node data for each LDLM_EXTENT lock. */
614 struct ldlm_interval {
615 struct interval_node li_node; /* node for tree management */
616 struct list_head li_group; /* the locks which have the same
617 * policy - group of the policy */
619 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
622 * Interval tree for extent locks.
623 * The interval tree must be accessed under the resource lock.
624 * Interval trees are used for granted extent locks to speed up conflicts
625 * lookup. See ldlm/interval_tree.c for more details.
627 struct ldlm_interval_tree {
630 enum ldlm_mode lit_mode; /* lock mode */
631 struct interval_node *lit_root; /* actual ldlm_interval */
634 /** Whether to track references to exports by LDLM locks. */
635 #define LUSTRE_TRACKS_LOCK_EXP_REFS (0)
638 enum ldlm_cancel_flags {
639 LCF_ASYNC = 0x1, /* Cancel locks asynchronously. */
640 LCF_LOCAL = 0x2, /* Cancel locks locally, not notifing server */
641 LCF_BL_AST = 0x4, /* Cancel LDLM_FL_BL_AST locks in the same RPC */
648 __u64 blocking_owner;
649 struct obd_export *blocking_export;
650 atomic_t blocking_refs;
654 union ldlm_policy_data {
655 struct ldlm_extent l_extent;
656 struct ldlm_flock l_flock;
657 struct ldlm_inodebits l_inodebits;
660 void ldlm_convert_policy_to_wire(enum ldlm_type type,
661 const union ldlm_policy_data *lpolicy,
662 union ldlm_wire_policy_data *wpolicy);
663 void ldlm_convert_policy_to_local(struct obd_export *exp, enum ldlm_type type,
664 const union ldlm_wire_policy_data *wpolicy,
665 union ldlm_policy_data *lpolicy);
675 * LDLM_GID_ANY is used to match any group id in ldlm_lock_match().
677 #define LDLM_GID_ANY ((__u64)-1)
680 * LDLM lock structure
682 * Represents a single LDLM lock and its state in memory. Each lock is
683 * associated with a single ldlm_resource, the object which is being
684 * locked. There may be multiple ldlm_locks on a single resource,
685 * depending on the lock type and whether the locks are conflicting or
691 * When remote side wants to tell us about a lock, they address
692 * it by this opaque handle. The handle does not hold a
693 * reference on the ldlm_lock, so it can be safely passed to
694 * other threads or nodes. When the lock needs to be accessed
695 * from the handle, it is looked up again in the lock table, and
696 * may no longer exist.
698 * Must be first in the structure.
700 struct portals_handle l_handle;
702 * Lock reference count.
703 * This is how many users have pointers to actual structure, so that
704 * we do not accidentally free lock structure that is in use.
708 * Internal spinlock protects l_resource. We should hold this lock
709 * first before taking res_lock.
713 * Pointer to actual resource this lock is in.
714 * ldlm_lock_change_resource() can change this.
716 struct ldlm_resource *l_resource;
718 * List item for client side LRU list.
719 * Protected by ns_lock in struct ldlm_namespace.
721 struct list_head l_lru;
723 * Linkage to resource's lock queues according to current lock state.
724 * (could be granted, waiting or converting)
725 * Protected by lr_lock in struct ldlm_resource.
727 struct list_head l_res_link;
729 * Tree node for ldlm_extent.
731 struct ldlm_interval *l_tree_node;
733 * Per export hash of locks.
734 * Protected by per-bucket exp->exp_lock_hash locks.
736 struct hlist_node l_exp_hash;
738 * Per export hash of flock locks.
739 * Protected by per-bucket exp->exp_flock_hash locks.
741 struct hlist_node l_exp_flock_hash;
744 * Protected by lr_lock.
746 enum ldlm_mode l_req_mode;
748 * Granted mode, also protected by lr_lock.
750 enum ldlm_mode l_granted_mode;
751 /** Lock completion handler pointer. Called when lock is granted. */
752 ldlm_completion_callback l_completion_ast;
754 * Lock blocking AST handler pointer.
755 * It plays two roles:
756 * - as a notification of an attempt to queue a conflicting lock (once)
757 * - as a notification when the lock is being cancelled.
759 * As such it's typically called twice: once for the initial conflict
760 * and then once more when the last user went away and the lock is
761 * cancelled (could happen recursively).
763 ldlm_blocking_callback l_blocking_ast;
765 * Lock glimpse handler.
766 * Glimpse handler is used to obtain LVB updates from a client by
769 ldlm_glimpse_callback l_glimpse_ast;
773 * This is a pointer to actual client export for locks that were granted
774 * to clients. Used server-side.
776 struct obd_export *l_export;
778 * Lock connection export.
779 * Pointer to server export on a client.
781 struct obd_export *l_conn_export;
784 * Remote lock handle.
785 * If the lock is remote, this is the handle of the other side lock
788 struct lustre_handle l_remote_handle;
791 * Representation of private data specific for a lock type.
792 * Examples are: extent range for extent lock or bitmask for ibits locks
794 union ldlm_policy_data l_policy_data;
797 * Lock state flags. Protected by lr_lock.
798 * \see lustre_dlm_flags.h where the bits are defined.
803 * Lock r/w usage counters.
804 * Protected by lr_lock.
809 * If the lock is granted, a process sleeps on this waitq to learn when
810 * it's no longer in use. If the lock is not granted, a process sleeps
811 * on this waitq to learn when it becomes granted.
813 wait_queue_head_t l_waitq;
816 * Seconds. It will be updated if there is any activity related to
817 * the lock, e.g. enqueue the lock or send blocking AST.
819 time64_t l_last_activity;
822 * Time last used by e.g. being matched by lock match.
823 * Jiffies. Should be converted to time if needed.
825 cfs_time_t l_last_used;
827 /** Originally requested extent for the extent lock. */
828 struct ldlm_extent l_req_extent;
831 * Client-side-only members.
834 enum lvb_type l_lvb_type;
837 * Temporary storage for a LVB received during an enqueue operation.
838 * May be vmalloc'd, so needs to be freed with OBD_FREE_LARGE().
843 /** Private storage for lock user. Opaque to LDLM. */
847 * Server-side-only members.
851 * Connection cookie for the client originating the operation.
852 * Used by Commit on Share (COS) code. Currently only used for
853 * inodebits locks on MDS.
855 __u64 l_client_cookie;
858 * List item for locks waiting for cancellation from clients.
859 * The lists this could be linked into are:
860 * waiting_locks_list (protected by waiting_locks_spinlock),
861 * then if the lock timed out, it is moved to
862 * expired_lock_list for further processing.
864 struct list_head l_pending_chain;
867 * Set when lock is sent a blocking AST. Time in seconds when timeout
868 * is reached and client holding this lock could be evicted.
869 * This timeout could be further extended by e.g. certain IO activity
871 * \see ost_rw_prolong_locks
873 cfs_time_t l_callback_timeout;
875 /** Local PID of process which created this lock. */
879 * Number of times blocking AST was sent for this lock.
880 * This is for debugging. Valid values are 0 and 1, if there is an
881 * attempt to send blocking AST more than once, an assertion would be
882 * hit. \see ldlm_work_bl_ast_lock
885 /** List item ldlm_add_ast_work_item() for case of blocking ASTs. */
886 struct list_head l_bl_ast;
887 /** List item ldlm_add_ast_work_item() for case of completion ASTs. */
888 struct list_head l_cp_ast;
889 /** For ldlm_add_ast_work_item() for "revoke" AST used in COS. */
890 struct list_head l_rk_ast;
893 * Pointer to a conflicting lock that caused blocking AST to be sent
896 struct ldlm_lock *l_blocking_lock;
899 * Protected by lr_lock, linkages to "skip lists".
900 * For more explanations of skip lists see ldlm/ldlm_inodebits.c
902 struct list_head l_sl_mode;
903 struct list_head l_sl_policy;
905 /** Reference tracking structure to debug leaked locks. */
906 struct lu_ref l_reference;
907 #if LUSTRE_TRACKS_LOCK_EXP_REFS
908 /* Debugging stuff for bug 20498, for tracking export references. */
909 /** number of export references taken */
911 /** link all locks referencing one export */
912 struct list_head l_exp_refs_link;
913 /** referenced export object */
914 struct obd_export *l_exp_refs_target;
917 * export blocking dlm lock list, protected by
918 * l_export->exp_bl_list_lock.
919 * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
920 * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock.
922 struct list_head l_exp_list;
925 /** For uncommitted cross-MDT lock, store transno this lock belongs to */
926 #define l_transno l_client_cookie
928 /** For uncommitted cross-MDT lock, which is client lock, share with l_rk_ast
929 * which is for server. */
930 #define l_slc_link l_rk_ast
933 * LDLM resource description.
934 * Basically, resource is a representation for a single object.
935 * Object has a name which is currently 4 64-bit integers. LDLM user is
936 * responsible for creation of a mapping between objects it wants to be
937 * protected and resource names.
939 * A resource can only hold locks of a single lock type, though there may be
940 * multiple ldlm_locks on a single resource, depending on the lock type and
941 * whether the locks are conflicting or not.
943 struct ldlm_resource {
944 struct ldlm_ns_bucket *lr_ns_bucket;
947 * List item for list in namespace hash.
948 * protected by ns_lock
950 struct hlist_node lr_hash;
952 /** Reference count for this resource */
953 atomic_t lr_refcount;
955 /** Spinlock to protect locks under this resource. */
959 * protected by lr_lock
961 /** List of locks in granted state */
962 struct list_head lr_granted;
963 /** List of locks waiting to change their granted mode (converted) */
964 struct list_head lr_converting;
966 * List of locks that could not be granted due to conflicts and
967 * that are waiting for conflicts to go away */
968 struct list_head lr_waiting;
972 struct ldlm_res_id lr_name;
975 * Interval trees (only for extent locks) for all modes of this resource
977 struct ldlm_interval_tree *lr_itree;
981 * When the resource was considered as contended,
982 * used only on server side. */
983 cfs_time_t lr_contention_time;
985 * Associated inode, used only on client side.
987 struct inode *lr_lvb_inode;
990 /** Type of locks this resource can hold. Only one type per resource. */
991 enum ldlm_type lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */
994 * Server-side-only lock value block elements.
995 * To serialize lvbo_init.
998 struct mutex lr_lvb_mutex;
999 /** protected by lr_lock */
1001 /** is lvb initialized ? */
1002 bool lr_lvb_initialized;
1004 /** List of references to this resource. For debugging. */
1005 struct lu_ref lr_reference;
1008 static inline bool ldlm_has_layout(struct ldlm_lock *lock)
1010 return lock->l_resource->lr_type == LDLM_IBITS &&
1011 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_LAYOUT;
1014 static inline char *
1015 ldlm_ns_name(struct ldlm_namespace *ns)
1017 return ns->ns_rs_hash->hs_name;
1020 static inline struct ldlm_namespace *
1021 ldlm_res_to_ns(struct ldlm_resource *res)
1023 return res->lr_ns_bucket->nsb_namespace;
1026 static inline struct ldlm_namespace *
1027 ldlm_lock_to_ns(struct ldlm_lock *lock)
1029 return ldlm_res_to_ns(lock->l_resource);
1032 static inline char *
1033 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
1035 return ldlm_ns_name(ldlm_lock_to_ns(lock));
1038 static inline struct adaptive_timeout *
1039 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
1041 return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
1044 static inline int ldlm_lvbo_init(struct ldlm_resource *res)
1046 struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1049 if (ns->ns_lvbo == NULL || ns->ns_lvbo->lvbo_init == NULL ||
1050 res->lr_lvb_initialized)
1053 mutex_lock(&res->lr_lvb_mutex);
1054 /* Did we lose the race? */
1055 if (res->lr_lvb_initialized) {
1056 mutex_unlock(&res->lr_lvb_mutex);
1059 rc = ns->ns_lvbo->lvbo_init(res);
1061 CDEBUG(D_DLMTRACE, "lvbo_init failed for resource : rc = %d\n",
1063 if (res->lr_lvb_data != NULL) {
1064 OBD_FREE(res->lr_lvb_data, res->lr_lvb_len);
1065 res->lr_lvb_data = NULL;
1067 res->lr_lvb_len = rc;
1069 res->lr_lvb_initialized = true;
1071 mutex_unlock(&res->lr_lvb_mutex);
1075 static inline int ldlm_lvbo_size(struct ldlm_lock *lock)
1077 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1079 if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_size != NULL)
1080 return ns->ns_lvbo->lvbo_size(lock);
1085 static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int len)
1087 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1090 if (ns->ns_lvbo != NULL) {
1091 LASSERT(ns->ns_lvbo->lvbo_fill != NULL);
1092 /* init lvb now if not already */
1093 rc = ldlm_lvbo_init(lock->l_resource);
1095 CERROR("lock %p: delayed lvb init failed (rc %d)",
1099 return ns->ns_lvbo->lvbo_fill(lock, buf, len);
1104 struct ldlm_ast_work {
1105 struct ldlm_lock *w_lock;
1107 struct ldlm_lock_desc w_desc;
1108 struct list_head w_list;
1115 * Common ldlm_enqueue parameters
1117 struct ldlm_enqueue_info {
1118 enum ldlm_type ei_type; /** Type of the lock being enqueued. */
1119 enum ldlm_mode ei_mode; /** Mode of the lock being enqueued. */
1120 void *ei_cb_bl; /** blocking lock callback */
1121 void *ei_cb_local_bl; /** blocking local lock callback */
1122 void *ei_cb_cp; /** lock completion callback */
1123 void *ei_cb_gl; /** lock glimpse callback */
1124 void *ei_cbdata; /** Data to be passed into callbacks. */
1125 void *ei_namespace; /** lock namespace **/
1126 unsigned int ei_enq_slave:1; /** whether enqueue slave stripes */
1129 #define ei_res_id ei_cb_gl
1131 extern struct obd_ops ldlm_obd_ops;
1133 extern char *ldlm_lockname[];
1134 extern char *ldlm_typename[];
1135 extern const char *ldlm_it2str(enum ldlm_intent_flags it);
1138 * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG.
1139 * For the cases where we do not have actual lock to print along
1140 * with a debugging message that is ldlm-related
1142 #define LDLM_DEBUG_NOLOCK(format, a...) \
1143 CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
1146 * Support function for lock information printing into debug logs.
1150 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do { \
1151 CFS_CHECK_STACK(msgdata, mask, cdls); \
1153 if (((mask) & D_CANTMASK) != 0 || \
1154 ((libcfs_debug & (mask)) != 0 && \
1155 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1156 _ldlm_lock_debug(lock, msgdata, fmt, ##a); \
1159 void _ldlm_lock_debug(struct ldlm_lock *lock,
1160 struct libcfs_debug_msg_data *data,
1161 const char *fmt, ...)
1162 __attribute__ ((format (printf, 3, 4)));
1165 * Rate-limited version of lock printing function.
1167 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do { \
1168 static struct cfs_debug_limit_state _ldlm_cdls; \
1169 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls); \
1170 ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
1173 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
1174 #define LDLM_WARN(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
1176 /** Non-rate-limited lock printing function for debugging purposes. */
1177 #define LDLM_DEBUG(lock, fmt, a...) do { \
1178 if (likely(lock != NULL)) { \
1179 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL); \
1180 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock, \
1181 "### " fmt , ##a); \
1183 LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a); \
1186 #else /* !LIBCFS_DEBUG */
1187 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
1188 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
1189 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
1193 * Three intentions can be used for the policy functions in
1194 * ldlm_processing_policy.
1196 * LDLM_PROCESS_RESCAN:
1198 * It's used when policy functions are called from ldlm_reprocess_queue() to
1199 * reprocess the wait & convert list and try to grant locks, blocking ASTs
1200 * have already been sent in this situation, completion ASTs need be sent for
1201 * the locks being granted.
1203 * LDLM_PROCESS_ENQUEUE:
1205 * It's used when policy functions are called from ldlm_lock_enqueue() to
1206 * process the wait & convert list for handling an enqueue request, blocking
1207 * ASTs have not been sent yet, so list of conflicting locks would be
1208 * collected and ASTs sent.
1210 * LDLM_PROCESS_RECOVERY:
1212 * It's used when policy functions are called from ldlm_reprocess_queue() to
1213 * reprocess the wait & convert list when recovery done. In case of blocking
1214 * ASTs are lost before recovery, it needs not only to grant locks if
1215 * available, but also send blocking ASTs to the locks doesn't have AST sent
1216 * flag. Completion ASTs need be sent for the locks being granted.
1218 enum ldlm_process_intention {
1219 LDLM_PROCESS_RESCAN = 0,
1220 LDLM_PROCESS_ENQUEUE = 1,
1221 LDLM_PROCESS_RECOVERY = 2,
1224 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags,
1225 enum ldlm_process_intention intention,
1226 enum ldlm_error *err,
1227 struct list_head *work_list);
1230 * Return values for lock iterators.
1231 * Also used during deciding of lock grants and cancellations.
1233 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
1234 #define LDLM_ITER_STOP 2 /* stop iterating */
1236 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
1237 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
1239 /** \defgroup ldlm_iterator Lock iterators
1241 * LDLM provides for a way to iterate through every lock on a resource or
1242 * namespace or every resource in a namespace.
1244 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1246 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1248 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
1249 ldlm_iterator_t iter, void *data);
1250 /** @} ldlm_iterator */
1252 int ldlm_replay_locks(struct obd_import *imp);
1255 int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1258 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
1260 struct ldlm_prolong_args {
1261 struct obd_export *lpa_export;
1262 struct ldlm_res_id lpa_resid;
1263 struct ldlm_extent lpa_extent;
1264 enum ldlm_mode lpa_mode;
1269 void ldlm_lock_prolong_one(struct ldlm_lock *lock,
1270 struct ldlm_prolong_args *arg);
1271 void ldlm_resource_prolong(struct ldlm_prolong_args *arg);
1273 struct ldlm_callback_suite {
1274 ldlm_completion_callback lcs_completion;
1275 ldlm_blocking_callback lcs_blocking;
1276 ldlm_glimpse_callback lcs_glimpse;
1280 #ifdef HAVE_SERVER_SUPPORT
1281 /** \defgroup ldlm_srv_ast Server AST handlers
1282 * These are AST handlers used by server code.
1283 * Their property is that they are just preparing RPCs to be sent to clients.
1286 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1287 void *data, int flag);
1288 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1289 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
1290 int ldlm_glimpse_locks(struct ldlm_resource *res,
1291 struct list_head *gl_work_list);
1292 /** @} ldlm_srv_ast */
1294 /** \defgroup ldlm_handlers Server LDLM handlers
1295 * These are handler functions that should be called by "frontends" such as
1296 * MDT or OST to pass through LDLM requests to LDLM for handling
1299 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
1300 ldlm_blocking_callback, ldlm_glimpse_callback);
1301 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1302 const struct ldlm_request *dlm_req,
1303 const struct ldlm_callback_suite *cbs);
1304 int ldlm_handle_convert(struct ptlrpc_request *req);
1305 int ldlm_handle_convert0(struct ptlrpc_request *req,
1306 const struct ldlm_request *dlm_req);
1307 int ldlm_handle_cancel(struct ptlrpc_request *req);
1308 int ldlm_request_cancel(struct ptlrpc_request *req,
1309 const struct ldlm_request *dlm_req,
1310 int first, enum lustre_at_flags flags);
1311 /** @} ldlm_handlers */
1313 void ldlm_revoke_export_locks(struct obd_export *exp);
1314 unsigned int ldlm_bl_timeout(struct ldlm_lock *lock);
1316 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1317 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
1318 int ldlm_get_ref(void);
1319 void ldlm_put_ref(void);
1320 int ldlm_init_export(struct obd_export *exp);
1321 void ldlm_destroy_export(struct obd_export *exp);
1322 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req);
1325 #ifdef HAVE_SERVER_SUPPORT
1326 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1328 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1329 void ldlm_lock2handle(const struct ldlm_lock *lock,
1330 struct lustre_handle *lockh);
1331 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags);
1332 void ldlm_cancel_callback(struct ldlm_lock *);
1333 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1334 int ldlm_lock_set_data(const struct lustre_handle *lockh, void *data);
1337 * Obtain a lock reference by its handle.
1339 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1341 return __ldlm_handle2lock(h, 0);
1344 #define LDLM_LOCK_REF_DEL(lock) \
1345 lu_ref_del(&lock->l_reference, "handle", current)
1347 static inline struct ldlm_lock *
1348 ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags)
1350 struct ldlm_lock *lock;
1352 lock = __ldlm_handle2lock(h, flags);
1354 LDLM_LOCK_REF_DEL(lock);
1359 * Update Lock Value Block Operations (LVBO) on a resource taking into account
1360 * data from request \a r
1362 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1363 struct ptlrpc_request *req, int increase)
1367 /* delayed lvb init may be required */
1368 rc = ldlm_lvbo_init(res);
1370 CERROR("delayed lvb init failed (rc %d)\n", rc);
1374 if (ldlm_res_to_ns(res)->ns_lvbo &&
1375 ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
1376 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, req,
1382 int ldlm_error2errno(enum ldlm_error error);
1383 enum ldlm_error ldlm_errno2error(int err_no); /* don't call it `errno': this
1384 * confuses user-space. */
1385 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1386 void ldlm_dump_export_locks(struct obd_export *exp);
1390 * Release a temporary lock reference obtained by ldlm_handle2lock() or
1391 * __ldlm_handle2lock().
1393 #define LDLM_LOCK_PUT(lock) \
1395 LDLM_LOCK_REF_DEL(lock); \
1396 /*LDLM_DEBUG((lock), "put");*/ \
1397 ldlm_lock_put(lock); \
1401 * Release a lock reference obtained by some other means (see
1404 #define LDLM_LOCK_RELEASE(lock) \
1406 /*LDLM_DEBUG((lock), "put");*/ \
1407 ldlm_lock_put(lock); \
1410 #define LDLM_LOCK_GET(lock) \
1412 ldlm_lock_get(lock); \
1413 /*LDLM_DEBUG((lock), "get");*/ \
1417 #define ldlm_lock_list_put(head, member, count) \
1419 struct ldlm_lock *_lock, *_next; \
1421 list_for_each_entry_safe(_lock, _next, head, member) { \
1424 list_del_init(&_lock->member); \
1425 LDLM_LOCK_RELEASE(_lock); \
1430 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1431 void ldlm_lock_put(struct ldlm_lock *lock);
1432 void ldlm_lock_destroy(struct ldlm_lock *lock);
1433 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1434 void ldlm_lock_addref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1435 int ldlm_lock_addref_try(const struct lustre_handle *lockh,
1436 enum ldlm_mode mode);
1437 void ldlm_lock_decref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1438 void ldlm_lock_decref_and_cancel(const struct lustre_handle *lockh,
1439 enum ldlm_mode mode);
1440 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1441 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1442 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1443 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1444 enum ldlm_mode ldlm_lock_match(struct ldlm_namespace *ns, __u64 flags,
1445 const struct ldlm_res_id *, enum ldlm_type type,
1446 union ldlm_policy_data *, enum ldlm_mode mode,
1447 struct lustre_handle *, int unref);
1448 enum ldlm_mode ldlm_revalidate_lock_handle(const struct lustre_handle *lockh,
1450 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock,
1451 enum ldlm_mode new_mode, __u32 *flags);
1452 void ldlm_lock_downgrade(struct ldlm_lock *lock, enum ldlm_mode new_mode);
1453 void ldlm_lock_cancel(struct ldlm_lock *lock);
1454 void ldlm_reprocess_all(struct ldlm_resource *res);
1455 void ldlm_reprocess_recovery_done(struct ldlm_namespace *ns);
1456 void ldlm_lock_dump_handle(int level, const struct lustre_handle *lockh);
1457 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1460 struct ldlm_namespace *ldlm_namespace_new(struct obd_device *obd, char *name,
1461 enum ldlm_side client,
1462 enum ldlm_appetite apt,
1463 enum ldlm_ns_type ns_type);
1464 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags);
1465 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
1466 struct obd_import *imp,
1468 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
1469 void ldlm_namespace_free(struct ldlm_namespace *ns,
1470 struct obd_import *imp, int force);
1471 void ldlm_namespace_register(struct ldlm_namespace *ns, enum ldlm_side client);
1472 void ldlm_namespace_unregister(struct ldlm_namespace *ns,
1473 enum ldlm_side client);
1474 void ldlm_namespace_get(struct ldlm_namespace *ns);
1475 void ldlm_namespace_put(struct ldlm_namespace *ns);
1476 int ldlm_proc_setup(void);
1477 #ifdef CONFIG_PROC_FS
1478 void ldlm_proc_cleanup(void);
1480 static inline void ldlm_proc_cleanup(void) {}
1483 /* resource.c - internal */
1484 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1485 struct ldlm_resource *parent,
1486 const struct ldlm_res_id *,
1487 enum ldlm_type type, int create);
1488 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1489 int ldlm_resource_putref(struct ldlm_resource *res);
1490 void ldlm_resource_add_lock(struct ldlm_resource *res,
1491 struct list_head *head,
1492 struct ldlm_lock *lock);
1493 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1494 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1495 void ldlm_dump_all_namespaces(enum ldlm_side client, int level);
1496 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1497 void ldlm_resource_dump(int level, struct ldlm_resource *);
1498 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1499 const struct ldlm_res_id *);
1501 #define LDLM_RESOURCE_ADDREF(res) do { \
1502 lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, current); \
1505 #define LDLM_RESOURCE_DELREF(res) do { \
1506 lu_ref_del(&(res)->lr_reference, __FUNCTION__, current); \
1509 /* ldlm_request.c */
1510 int ldlm_expired_completion_wait(void *data);
1511 /** \defgroup ldlm_local_ast Default AST handlers for local locks
1512 * These AST handlers are typically used for server-side local locks and are
1513 * also used by client-side lock handlers to perform minimum level base
1516 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1517 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1518 void *data, int flag);
1519 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1520 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data);
1521 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1522 /** @} ldlm_local_ast */
1524 /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users.
1525 * These are typically used by client and server (*_local versions)
1526 * to obtain and release locks.
1528 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1529 struct ldlm_enqueue_info *einfo,
1530 const struct ldlm_res_id *res_id,
1531 union ldlm_policy_data const *policy, __u64 *flags,
1532 void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
1533 struct lustre_handle *lockh, int async);
1534 int ldlm_prep_enqueue_req(struct obd_export *exp,
1535 struct ptlrpc_request *req,
1536 struct list_head *cancels,
1538 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
1539 int version, int opc, int canceloff,
1540 struct list_head *cancels, int count);
1542 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len);
1543 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1544 const struct ldlm_request *dlm_req,
1545 const struct ldlm_callback_suite *cbs);
1546 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1547 enum ldlm_type type, __u8 with_policy,
1548 enum ldlm_mode mode, __u64 *flags, void *lvb,
1550 const struct lustre_handle *lockh, int rc);
1551 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1552 const struct ldlm_res_id *res_id,
1553 enum ldlm_type type, union ldlm_policy_data *policy,
1554 enum ldlm_mode mode, __u64 *flags,
1555 ldlm_blocking_callback blocking,
1556 ldlm_completion_callback completion,
1557 ldlm_glimpse_callback glimpse,
1558 void *data, __u32 lvb_len, enum lvb_type lvb_type,
1559 const __u64 *client_cookie,
1560 struct lustre_handle *lockh);
1561 int ldlm_cli_convert(const struct lustre_handle *lockh, int new_mode,
1563 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1564 int ldlm_cli_cancel(const struct lustre_handle *lockh,
1565 enum ldlm_cancel_flags cancel_flags);
1566 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1567 enum ldlm_cancel_flags flags, void *opaque);
1568 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1569 const struct ldlm_res_id *res_id,
1570 union ldlm_policy_data *policy,
1571 enum ldlm_mode mode,
1572 enum ldlm_cancel_flags flags, void *opaque);
1573 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
1574 int count, enum ldlm_cancel_flags flags);
1575 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1576 struct list_head *cancels,
1577 union ldlm_policy_data *policy,
1578 enum ldlm_mode mode, __u64 lock_flags,
1579 enum ldlm_cancel_flags cancel_flags,
1581 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1582 enum ldlm_cancel_flags flags);
1583 int ldlm_cli_cancel_list(struct list_head *head, int count,
1584 struct ptlrpc_request *req,
1585 enum ldlm_cancel_flags flags);
1586 /** @} ldlm_cli_api */
1589 /* This has to be here because recursive inclusion sucks. */
1590 int intent_disposition(struct ldlm_reply *rep, int flag);
1591 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1594 * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1595 * than one lock_res is dead-lock safe.
1597 enum lock_res_type {
1602 /** Lock resource. */
1603 static inline void lock_res(struct ldlm_resource *res)
1605 spin_lock(&res->lr_lock);
1608 /** Lock resource with a way to instruct lockdep code about nestedness-safe. */
1609 static inline void lock_res_nested(struct ldlm_resource *res,
1610 enum lock_res_type mode)
1612 spin_lock_nested(&res->lr_lock, mode);
1615 /** Unlock resource. */
1616 static inline void unlock_res(struct ldlm_resource *res)
1618 spin_unlock(&res->lr_lock);
1621 /** Check if resource is already locked, assert if not. */
1622 static inline void check_res_locked(struct ldlm_resource *res)
1624 assert_spin_locked(&res->lr_lock);
1627 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1628 void unlock_res_and_lock(struct ldlm_lock *lock);
1631 /** \defgroup ldlm_pools Various LDLM pool related functions
1632 * There are not used outside of ldlm.
1635 int ldlm_pools_recalc(enum ldlm_side client);
1636 int ldlm_pools_init(void);
1637 void ldlm_pools_fini(void);
1639 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1640 int idx, enum ldlm_side client);
1641 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
1642 void ldlm_pool_fini(struct ldlm_pool *pl);
1643 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1644 int ldlm_pool_recalc(struct ldlm_pool *pl);
1645 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1646 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1647 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1648 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1649 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1650 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1651 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1652 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1653 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1656 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
1657 const struct ldlm_extent *ex2)
1659 return ex1->start <= ex2->end && ex2->start <= ex1->end;
1662 /* check if @ex1 contains @ex2 */
1663 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
1664 const struct ldlm_extent *ex2)
1666 return ex1->start <= ex2->start && ex1->end >= ex2->end;