4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2010, 2013, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 /** \defgroup LDLM Lustre Distributed Lock Manager
39 * Lustre DLM is based on VAX DLM.
40 * Its two main roles are:
41 * - To provide locking assuring consistency of data on all Lustre nodes.
42 * - To allow clients to cache state protected by a lock by holding the
43 * lock until a conflicting lock is requested or it is expired by the LRU.
48 #ifndef _LUSTRE_DLM_H__
49 #define _LUSTRE_DLM_H__
51 #if defined(__linux__)
52 #include <linux/lustre_dlm.h>
54 #error Unsupported operating system.
57 #include <lustre_lib.h>
58 #include <lustre_net.h>
59 #include <lustre_import.h>
60 #include <lustre_handles.h>
61 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
64 #include "lustre_dlm_flags.h"
69 #define OBD_LDLM_DEVICENAME "ldlm"
71 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
72 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
73 #define LDLM_CTIME_AGE_LIMIT (10)
74 #define LDLM_DEFAULT_PARALLEL_AST_LIMIT 1024
77 * LDLM non-error return states
82 ELDLM_LOCK_CHANGED = 300,
83 ELDLM_LOCK_ABORTED = 301,
84 ELDLM_LOCK_REPLACED = 302,
85 ELDLM_NO_LOCK_DATA = 303,
86 ELDLM_LOCK_WOULDBLOCK = 304,
88 ELDLM_NAMESPACE_EXISTS = 400,
89 ELDLM_BAD_NAMESPACE = 401
93 * LDLM namespace type.
94 * The "client" type is actually an indication that this is a narrow local view
95 * into complete namespace on the server. Such namespaces cannot make any
96 * decisions about lack of conflicts or do any autonomous lock granting without
97 * first speaking to a server.
100 LDLM_NAMESPACE_SERVER = 1 << 0,
101 LDLM_NAMESPACE_CLIENT = 1 << 1
105 * The blocking callback is overloaded to perform two functions. These flags
106 * indicate which operation should be performed.
108 #define LDLM_CB_BLOCKING 1
109 #define LDLM_CB_CANCELING 2
112 * \name Lock Compatibility Matrix.
114 * A lock has both a type (extent, flock, inode bits, or plain) and a mode.
115 * Lock types are described in their respective implementation files:
116 * ldlm_{extent,flock,inodebits,plain}.c.
118 * There are six lock modes along with a compatibility matrix to indicate if
119 * two locks are compatible.
121 * - EX: Exclusive mode. Before a new file is created, MDS requests EX lock
123 * - PW: Protective Write (normal write) mode. When a client requests a write
124 * lock from an OST, a lock with PW mode will be issued.
125 * - PR: Protective Read (normal read) mode. When a client requests a read from
126 * an OST, a lock with PR mode will be issued. Also, if the client opens a
127 * file for execution, it is granted a lock with PR mode.
128 * - CW: Concurrent Write mode. The type of lock that the MDS grants if a client
129 * requests a write lock during a file open operation.
130 * - CR Concurrent Read mode. When a client performs a path lookup, MDS grants
131 * an inodebit lock with the CR mode on the intermediate path component.
145 #define LCK_COMPAT_EX LCK_NL
146 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
147 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
148 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
149 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
150 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
151 #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL)
152 #define LCK_COMPAT_COS (LCK_COS)
153 /** @} Lock Compatibility Matrix */
155 extern ldlm_mode_t lck_compat_array[];
157 static inline void lockmode_verify(ldlm_mode_t mode)
159 LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
162 static inline int lockmode_compat(ldlm_mode_t exist_mode, ldlm_mode_t new_mode)
164 return (lck_compat_array[exist_mode] & new_mode);
169 * cluster name spaces
173 #define DLM_OST_NAMESPACE 1
174 #define DLM_MDS_NAMESPACE 2
177 - do we just separate this by security domains and use a prefix for
178 multiple namespaces in the same domain?
183 * Locking rules for LDLM:
188 * waiting_locks_spinlock
203 struct ldlm_resource;
204 struct ldlm_namespace;
207 * Operations on LDLM pools.
208 * LDLM pool is a pool of locks in the namespace without any implicitly
210 * Locks in the pool are organized in LRU.
211 * Local memory pressure or server instructions (e.g. mempressure on server)
212 * can trigger freeing of locks from the pool
214 struct ldlm_pool_ops {
215 /** Recalculate pool \a pl usage */
216 int (*po_recalc)(struct ldlm_pool *pl);
217 /** Cancel at least \a nr locks from pool \a pl */
218 int (*po_shrink)(struct ldlm_pool *pl, int nr,
219 unsigned int gfp_mask);
220 int (*po_setup)(struct ldlm_pool *pl, int limit);
223 /** One second for pools thread check interval. Each pool has own period. */
224 #define LDLM_POOLS_THREAD_PERIOD (1)
226 /** ~6% margin for modest pools. See ldlm_pool.c for details. */
227 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
229 /** Default recalc period for server side pools in sec. */
230 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
232 /** Default recalc period for client side pools in sec. */
233 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
236 * LDLM pool structure to track granted locks.
237 * For purposes of determining when to release locks on e.g. memory pressure.
238 * This feature is commonly referred to as lru_resize.
241 /** Pool proc directory. */
242 struct proc_dir_entry *pl_proc_dir;
243 /** Pool name, must be long enough to hold compound proc entry name. */
245 /** Lock for protecting SLV/CLV updates. */
247 /** Number of allowed locks in in pool, both, client and server side. */
249 /** Number of granted locks in */
251 /** Grant rate per T. */
252 atomic_t pl_grant_rate;
253 /** Cancel rate per T. */
254 atomic_t pl_cancel_rate;
255 /** Server lock volume (SLV). Protected by pl_lock. */
256 __u64 pl_server_lock_volume;
257 /** Current biggest client lock volume. Protected by pl_lock. */
258 __u64 pl_client_lock_volume;
259 /** Lock volume factor. SLV on client is calculated as following:
260 * server_slv * lock_volume_factor. */
261 atomic_t pl_lock_volume_factor;
262 /** Time when last SLV from server was obtained. */
263 time_t pl_recalc_time;
264 /** Recalculation period for pool. */
265 time_t pl_recalc_period;
266 /** Recalculation and shrink operations. */
267 struct ldlm_pool_ops *pl_ops;
268 /** Number of planned locks for next period. */
270 /** Pool statistics. */
271 struct lprocfs_stats *pl_stats;
274 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
275 void *req_cookie, ldlm_mode_t mode, __u64 flags,
278 typedef int (*ldlm_cancel_cbt)(struct ldlm_lock *lock);
282 * LVB is Lock Value Block. This is a special opaque (to LDLM) value that could
283 * be associated with an LDLM lock and transferred from client to server and
286 * Currently LVBs are used by:
287 * - OSC-OST code to maintain current object size/times
288 * - layout lock code to return the layout when the layout lock is granted
290 struct ldlm_valblock_ops {
291 int (*lvbo_init)(struct ldlm_resource *res);
292 int (*lvbo_update)(struct ldlm_resource *res,
293 struct ptlrpc_request *r,
295 int (*lvbo_free)(struct ldlm_resource *res);
296 /* Return size of lvb data appropriate RPC size can be reserved */
297 int (*lvbo_size)(struct ldlm_lock *lock);
298 /* Called to fill in lvb data to RPC buffer @buf */
299 int (*lvbo_fill)(struct ldlm_lock *lock, void *buf, int buflen);
303 * LDLM pools related, type of lock pool in the namespace.
304 * Greedy means release cached locks aggressively
307 LDLM_NAMESPACE_GREEDY = 1 << 0,
308 LDLM_NAMESPACE_MODEST = 1 << 1
312 * Default values for the "max_nolock_size", "contention_time" and
313 * "contended_locks" namespace tunables.
315 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
316 #define NS_DEFAULT_CONTENTION_SECONDS 2
317 #define NS_DEFAULT_CONTENDED_LOCKS 32
319 struct ldlm_ns_bucket {
320 /** back pointer to namespace */
321 struct ldlm_namespace *nsb_namespace;
323 * Estimated lock callback time. Used by adaptive timeout code to
324 * avoid spurious client evictions due to unresponsiveness when in
325 * fact the network or overall system load is at fault
327 struct adaptive_timeout nsb_at_estimate;
331 /** LDLM namespace lock stats */
338 LDLM_NS_TYPE_UNKNOWN = 0,
356 * Namespace serves to contain locks related to a particular service.
357 * There are two kinds of namespaces:
358 * - Server namespace has knowledge of all locks and is therefore authoritative
359 * to make decisions like what locks could be granted and what conflicts
360 * exist during new lock enqueue.
361 * - Client namespace only has limited knowledge about locks in the namespace,
362 * only seeing locks held by the client.
364 * Every Lustre service has one server namespace present on the server serving
365 * that service. Every client connected to the service has a client namespace
367 * Every lock obtained by client in that namespace is actually represented by
368 * two in-memory locks. One on the server and one on the client. The locks are
369 * linked by a special cookie by which one node can tell to the other which lock
370 * it actually means during communications. Such locks are called remote locks.
371 * The locks held by server only without any reference to a client are called
374 struct ldlm_namespace {
375 /** Backward link to OBD, required for LDLM pool to store new SLV. */
376 struct obd_device *ns_obd;
378 /** Flag indicating if namespace is on client instead of server */
379 ldlm_side_t ns_client;
381 /** Resource hash table for namespace. */
382 cfs_hash_t *ns_rs_hash;
387 /** big refcount (by bucket) */
391 * Namespace connect flags supported by server (may be changed via
392 * /proc, LRU resize may be disabled/enabled).
394 __u64 ns_connect_flags;
396 /** Client side original connect flags supported by server. */
397 __u64 ns_orig_connect_flags;
399 /* namespace proc dir entry */
400 struct proc_dir_entry *ns_proc_dir_entry;
403 * Position in global namespace list linking all namespaces on
406 struct list_head ns_list_chain;
409 * List of unused locks for this namespace. This list is also called
411 * Unused locks are locks with zero reader/writer reference counts.
412 * This list is only used on clients for lock caching purposes.
413 * When we want to release some locks voluntarily or if server wants
414 * us to release some locks due to e.g. memory pressure, we take locks
415 * to release from the head of this list.
416 * Locks are linked via l_lru field in \see struct ldlm_lock.
418 struct list_head ns_unused_list;
419 /** Number of locks in the LRU list above */
423 * Maximum number of locks permitted in the LRU. If 0, means locks
424 * are managed by pools and there is no preset limit, rather it is all
425 * controlled by available memory on this client and on server.
427 unsigned int ns_max_unused;
428 /** Maximum allowed age (last used time) for locks in the LRU */
429 unsigned int ns_max_age;
431 * Server only: number of times we evicted clients due to lack of reply
434 unsigned int ns_timeouts;
436 * Number of seconds since the file change time after which the
437 * MDT will return an UPDATE lock along with a LOOKUP lock.
438 * This allows the client to start caching negative dentries
439 * for a directory and may save an RPC for a later stat.
441 unsigned int ns_ctime_age_limit;
444 * Used to rate-limit ldlm_namespace_dump calls.
445 * \see ldlm_namespace_dump. Increased by 10 seconds every time
448 cfs_time_t ns_next_dump;
450 /** "policy" function that does actual lock conflict determination */
451 ldlm_res_policy ns_policy;
454 * LVB operations for this namespace.
455 * \see struct ldlm_valblock_ops
457 struct ldlm_valblock_ops *ns_lvbo;
460 * Used by filter code to store pointer to OBD of the service.
461 * Should be dropped in favor of \a ns_obd
466 * Wait queue used by __ldlm_namespace_free. Gets woken up every time
467 * a resource is removed.
469 wait_queue_head_t ns_waitq;
470 /** LDLM pool structure for this namespace */
471 struct ldlm_pool ns_pool;
472 /** Definition of how eagerly unused locks will be released from LRU */
473 ldlm_appetite_t ns_appetite;
476 * If more than \a ns_contended_locks are found, the resource is
477 * considered to be contended. Lock enqueues might specify that no
478 * contended locks should be granted
480 unsigned ns_contended_locks;
483 * The resources in this namespace remember contended state during
484 * \a ns_contention_time, in seconds.
486 unsigned ns_contention_time;
489 * Limit size of contended extent locks, in bytes.
490 * If extended lock is requested for more then this many bytes and
491 * caller instructs us not to grant contended locks, we would disregard
494 unsigned ns_max_nolock_size;
496 /** Limit of parallel AST RPC count. */
497 unsigned ns_max_parallel_ast;
500 * Callback to check if a lock is good to be canceled by ELC or
503 ldlm_cancel_cbt ns_cancel;
505 /** LDLM lock stats */
506 struct lprocfs_stats *ns_stats;
509 * Flag to indicate namespace is being freed. Used to determine if
510 * recalculation of LDLM pool statistics should be skipped.
512 unsigned ns_stopping:1;
516 * Returns 1 if namespace \a ns is a client namespace.
518 static inline int ns_is_client(struct ldlm_namespace *ns)
521 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
522 LDLM_NAMESPACE_SERVER)));
523 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
524 ns->ns_client == LDLM_NAMESPACE_SERVER);
525 return ns->ns_client == LDLM_NAMESPACE_CLIENT;
529 * Returns 1 if namespace \a ns is a server namespace.
531 static inline int ns_is_server(struct ldlm_namespace *ns)
534 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
535 LDLM_NAMESPACE_SERVER)));
536 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
537 ns->ns_client == LDLM_NAMESPACE_SERVER);
538 return ns->ns_client == LDLM_NAMESPACE_SERVER;
542 * Returns 1 if namespace \a ns supports early lock cancel (ELC).
544 static inline int ns_connect_cancelset(struct ldlm_namespace *ns)
547 return !!(ns->ns_connect_flags & OBD_CONNECT_CANCELSET);
551 * Returns 1 if this namespace supports lru_resize.
553 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
556 return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
559 static inline void ns_register_cancel(struct ldlm_namespace *ns,
568 /** Type for blocking callback function of a lock. */
569 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
570 struct ldlm_lock_desc *new, void *data,
572 /** Type for completion callback function of a lock. */
573 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, __u64 flags,
575 /** Type for glimpse callback function of a lock. */
576 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
578 /** Work list for sending GL ASTs to multiple locks. */
579 struct ldlm_glimpse_work {
580 struct ldlm_lock *gl_lock; /* lock to glimpse */
581 struct list_head gl_list; /* linkage to other gl work structs */
582 __u32 gl_flags;/* see LDLM_GL_WORK_* below */
583 union ldlm_gl_desc *gl_desc; /* glimpse descriptor to be packed in
584 * glimpse callback request */
587 /** The ldlm_glimpse_work is allocated on the stack and should not be freed. */
588 #define LDLM_GL_WORK_NOFREE 0x1
590 /** Interval node data for each LDLM_EXTENT lock. */
591 struct ldlm_interval {
592 struct interval_node li_node; /* node for tree management */
593 struct list_head li_group; /* the locks which have the same
594 * policy - group of the policy */
596 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
599 * Interval tree for extent locks.
600 * The interval tree must be accessed under the resource lock.
601 * Interval trees are used for granted extent locks to speed up conflicts
602 * lookup. See ldlm/interval_tree.c for more details.
604 struct ldlm_interval_tree {
607 ldlm_mode_t lit_mode; /* lock mode */
608 struct interval_node *lit_root; /* actual ldlm_interval */
611 /** Whether to track references to exports by LDLM locks. */
612 #define LUSTRE_TRACKS_LOCK_EXP_REFS (0)
616 LCF_ASYNC = 0x1, /* Cancel locks asynchronously. */
617 LCF_LOCAL = 0x2, /* Cancel locks locally, not notifing server */
618 LCF_BL_AST = 0x4, /* Cancel locks marked as LDLM_FL_BL_AST
620 } ldlm_cancel_flags_t;
626 __u64 blocking_owner;
627 struct obd_export *blocking_export;
628 /* Protected by the hash lock */
633 union ldlm_policy_data {
634 struct ldlm_extent l_extent;
635 struct ldlm_flock l_flock;
636 struct ldlm_inodebits l_inodebits;
639 typedef union ldlm_policy_data ldlm_policy_data_t;
641 void ldlm_convert_policy_to_wire(ldlm_type_t type,
642 const ldlm_policy_data_t *lpolicy,
643 ldlm_wire_policy_data_t *wpolicy);
644 void ldlm_convert_policy_to_local(struct obd_export *exp, ldlm_type_t type,
645 const ldlm_wire_policy_data_t *wpolicy,
646 ldlm_policy_data_t *lpolicy);
656 * LDLM lock structure
658 * Represents a single LDLM lock and its state in memory. Each lock is
659 * associated with a single ldlm_resource, the object which is being
660 * locked. There may be multiple ldlm_locks on a single resource,
661 * depending on the lock type and whether the locks are conflicting or
667 * When remote side wants to tell us about a lock, they address
668 * it by this opaque handle. The handle does not hold a
669 * reference on the ldlm_lock, so it can be safely passed to
670 * other threads or nodes. When the lock needs to be accessed
671 * from the handle, it is looked up again in the lock table, and
672 * may no longer exist.
674 * Must be first in the structure.
676 struct portals_handle l_handle;
678 * Lock reference count.
679 * This is how many users have pointers to actual structure, so that
680 * we do not accidentally free lock structure that is in use.
684 * Internal spinlock protects l_resource. We should hold this lock
685 * first before taking res_lock.
689 * Pointer to actual resource this lock is in.
690 * ldlm_lock_change_resource() can change this.
692 struct ldlm_resource *l_resource;
694 * List item for client side LRU list.
695 * Protected by ns_lock in struct ldlm_namespace.
697 struct list_head l_lru;
699 * Linkage to resource's lock queues according to current lock state.
700 * (could be granted, waiting or converting)
701 * Protected by lr_lock in struct ldlm_resource.
703 struct list_head l_res_link;
705 * Tree node for ldlm_extent.
707 struct ldlm_interval *l_tree_node;
709 * Per export hash of locks.
710 * Protected by per-bucket exp->exp_lock_hash locks.
712 struct hlist_node l_exp_hash;
714 * Per export hash of flock locks.
715 * Protected by per-bucket exp->exp_flock_hash locks.
717 struct hlist_node l_exp_flock_hash;
720 * Protected by lr_lock.
722 ldlm_mode_t l_req_mode;
724 * Granted mode, also protected by lr_lock.
726 ldlm_mode_t l_granted_mode;
727 /** Lock completion handler pointer. Called when lock is granted. */
728 ldlm_completion_callback l_completion_ast;
730 * Lock blocking AST handler pointer.
731 * It plays two roles:
732 * - as a notification of an attempt to queue a conflicting lock (once)
733 * - as a notification when the lock is being cancelled.
735 * As such it's typically called twice: once for the initial conflict
736 * and then once more when the last user went away and the lock is
737 * cancelled (could happen recursively).
739 ldlm_blocking_callback l_blocking_ast;
741 * Lock glimpse handler.
742 * Glimpse handler is used to obtain LVB updates from a client by
745 ldlm_glimpse_callback l_glimpse_ast;
749 * This is a pointer to actual client export for locks that were granted
750 * to clients. Used server-side.
752 struct obd_export *l_export;
754 * Lock connection export.
755 * Pointer to server export on a client.
757 struct obd_export *l_conn_export;
760 * Remote lock handle.
761 * If the lock is remote, this is the handle of the other side lock
764 struct lustre_handle l_remote_handle;
767 * Representation of private data specific for a lock type.
768 * Examples are: extent range for extent lock or bitmask for ibits locks
770 ldlm_policy_data_t l_policy_data;
773 * Lock state flags. Protected by lr_lock.
774 * \see lustre_dlm_flags.h where the bits are defined.
779 * Lock r/w usage counters.
780 * Protected by lr_lock.
785 * If the lock is granted, a process sleeps on this waitq to learn when
786 * it's no longer in use. If the lock is not granted, a process sleeps
787 * on this waitq to learn when it becomes granted.
789 wait_queue_head_t l_waitq;
792 * Seconds. It will be updated if there is any activity related to
793 * the lock, e.g. enqueue the lock or send blocking AST.
795 cfs_time_t l_last_activity;
798 * Time last used by e.g. being matched by lock match.
799 * Jiffies. Should be converted to time if needed.
801 cfs_time_t l_last_used;
803 /** Originally requested extent for the extent lock. */
804 struct ldlm_extent l_req_extent;
807 * Client-side-only members.
810 enum lvb_type l_lvb_type;
813 * Temporary storage for a LVB received during an enqueue operation.
818 /** Private storage for lock user. Opaque to LDLM. */
822 * Server-side-only members.
826 * Connection cookie for the client originating the operation.
827 * Used by Commit on Share (COS) code. Currently only used for
828 * inodebits locks on MDS.
830 __u64 l_client_cookie;
833 * List item for locks waiting for cancellation from clients.
834 * The lists this could be linked into are:
835 * waiting_locks_list (protected by waiting_locks_spinlock),
836 * then if the lock timed out, it is moved to
837 * expired_lock_thread.elt_expired_locks for further processing.
838 * Protected by elt_lock.
840 struct list_head l_pending_chain;
843 * Set when lock is sent a blocking AST. Time in seconds when timeout
844 * is reached and client holding this lock could be evicted.
845 * This timeout could be further extended by e.g. certain IO activity
847 * \see ost_rw_prolong_locks
849 cfs_time_t l_callback_timeout;
851 /** Local PID of process which created this lock. */
855 * Number of times blocking AST was sent for this lock.
856 * This is for debugging. Valid values are 0 and 1, if there is an
857 * attempt to send blocking AST more than once, an assertion would be
858 * hit. \see ldlm_work_bl_ast_lock
861 /** List item ldlm_add_ast_work_item() for case of blocking ASTs. */
862 struct list_head l_bl_ast;
863 /** List item ldlm_add_ast_work_item() for case of completion ASTs. */
864 struct list_head l_cp_ast;
865 /** For ldlm_add_ast_work_item() for "revoke" AST used in COS. */
866 struct list_head l_rk_ast;
869 * Pointer to a conflicting lock that caused blocking AST to be sent
872 struct ldlm_lock *l_blocking_lock;
875 * Protected by lr_lock, linkages to "skip lists".
876 * For more explanations of skip lists see ldlm/ldlm_inodebits.c
878 struct list_head l_sl_mode;
879 struct list_head l_sl_policy;
881 /** Reference tracking structure to debug leaked locks. */
882 struct lu_ref l_reference;
883 #if LUSTRE_TRACKS_LOCK_EXP_REFS
884 /* Debugging stuff for bug 20498, for tracking export references. */
885 /** number of export references taken */
887 /** link all locks referencing one export */
888 struct list_head l_exp_refs_link;
889 /** referenced export object */
890 struct obd_export *l_exp_refs_target;
893 * export blocking dlm lock list, protected by
894 * l_export->exp_bl_list_lock.
895 * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
896 * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock.
898 struct list_head l_exp_list;
902 * LDLM resource description.
903 * Basically, resource is a representation for a single object.
904 * Object has a name which is currently 4 64-bit integers. LDLM user is
905 * responsible for creation of a mapping between objects it wants to be
906 * protected and resource names.
908 * A resource can only hold locks of a single lock type, though there may be
909 * multiple ldlm_locks on a single resource, depending on the lock type and
910 * whether the locks are conflicting or not.
912 struct ldlm_resource {
913 struct ldlm_ns_bucket *lr_ns_bucket;
916 * List item for list in namespace hash.
917 * protected by ns_lock
919 struct hlist_node lr_hash;
921 /** Spinlock to protect locks under this resource. */
925 * protected by lr_lock
927 /** List of locks in granted state */
928 struct list_head lr_granted;
929 /** List of locks waiting to change their granted mode (converted) */
930 struct list_head lr_converting;
932 * List of locks that could not be granted due to conflicts and
933 * that are waiting for conflicts to go away */
934 struct list_head lr_waiting;
937 /* XXX No longer needed? Remove ASAP */
938 ldlm_mode_t lr_most_restr;
940 /** Type of locks this resource can hold. Only one type per resource. */
941 ldlm_type_t lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */
944 struct ldlm_res_id lr_name;
945 /** Reference count for this resource */
946 atomic_t lr_refcount;
949 * Interval trees (only for extent locks) for all modes of this resource
951 struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];
954 * Server-side-only lock value block elements.
955 * To serialize lvbo_init.
957 struct mutex lr_lvb_mutex;
959 /** protected by lr_lock */
962 /** When the resource was considered as contended. */
963 cfs_time_t lr_contention_time;
964 /** List of references to this resource. For debugging. */
965 struct lu_ref lr_reference;
967 struct inode *lr_lvb_inode;
970 static inline bool ldlm_has_layout(struct ldlm_lock *lock)
972 return lock->l_resource->lr_type == LDLM_IBITS &&
973 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_LAYOUT;
977 ldlm_ns_name(struct ldlm_namespace *ns)
979 return ns->ns_rs_hash->hs_name;
982 static inline struct ldlm_namespace *
983 ldlm_res_to_ns(struct ldlm_resource *res)
985 return res->lr_ns_bucket->nsb_namespace;
988 static inline struct ldlm_namespace *
989 ldlm_lock_to_ns(struct ldlm_lock *lock)
991 return ldlm_res_to_ns(lock->l_resource);
995 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
997 return ldlm_ns_name(ldlm_lock_to_ns(lock));
1000 static inline struct adaptive_timeout *
1001 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
1003 return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
1006 static inline int ldlm_lvbo_init(struct ldlm_resource *res)
1008 struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1010 if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_init != NULL)
1011 return ns->ns_lvbo->lvbo_init(res);
1016 static inline int ldlm_lvbo_size(struct ldlm_lock *lock)
1018 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1020 if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_size != NULL)
1021 return ns->ns_lvbo->lvbo_size(lock);
1026 static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int len)
1028 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1030 if (ns->ns_lvbo != NULL) {
1031 LASSERT(ns->ns_lvbo->lvbo_fill != NULL);
1032 return ns->ns_lvbo->lvbo_fill(lock, buf, len);
1037 struct ldlm_ast_work {
1038 struct ldlm_lock *w_lock;
1040 struct ldlm_lock_desc w_desc;
1041 struct list_head w_list;
1048 * Common ldlm_enqueue parameters
1050 struct ldlm_enqueue_info {
1051 __u32 ei_type; /** Type of the lock being enqueued. */
1052 __u32 ei_mode; /** Mode of the lock being enqueued. */
1053 void *ei_cb_bl; /** blocking lock callback */
1054 void *ei_cb_cp; /** lock completion callback */
1055 void *ei_cb_gl; /** lock glimpse callback */
1056 void *ei_cbdata; /** Data to be passed into callbacks. */
1057 unsigned int ei_enq_slave:1; /* whether enqueue slave stripes */
1060 #define ei_res_id ei_cb_gl
1062 extern struct obd_ops ldlm_obd_ops;
1064 extern char *ldlm_lockname[];
1065 extern char *ldlm_typename[];
1066 extern char *ldlm_it2str(int it);
1069 * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG.
1070 * For the cases where we do not have actual lock to print along
1071 * with a debugging message that is ldlm-related
1073 #define LDLM_DEBUG_NOLOCK(format, a...) \
1074 CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
1077 * Support function for lock information printing into debug logs.
1081 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do { \
1082 CFS_CHECK_STACK(msgdata, mask, cdls); \
1084 if (((mask) & D_CANTMASK) != 0 || \
1085 ((libcfs_debug & (mask)) != 0 && \
1086 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1087 _ldlm_lock_debug(lock, msgdata, fmt, ##a); \
1090 void _ldlm_lock_debug(struct ldlm_lock *lock,
1091 struct libcfs_debug_msg_data *data,
1092 const char *fmt, ...)
1093 __attribute__ ((format (printf, 3, 4)));
1096 * Rate-limited version of lock printing function.
1098 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do { \
1099 static cfs_debug_limit_state_t _ldlm_cdls; \
1100 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls); \
1101 ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
1104 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
1105 #define LDLM_WARN(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
1107 /** Non-rate-limited lock printing function for debugging purposes. */
1108 #define LDLM_DEBUG(lock, fmt, a...) do { \
1109 if (likely(lock != NULL)) { \
1110 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL); \
1111 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock, \
1112 "### " fmt , ##a); \
1114 LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a); \
1117 #else /* !LIBCFS_DEBUG */
1118 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
1119 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
1120 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
1123 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags,
1124 int first_enq, ldlm_error_t *err,
1125 struct list_head *work_list);
1128 * Return values for lock iterators.
1129 * Also used during deciding of lock grants and cancellations.
1131 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
1132 #define LDLM_ITER_STOP 2 /* stop iterating */
1134 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
1135 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
1137 /** \defgroup ldlm_iterator Lock iterators
1139 * LDLM provides for a way to iterate through every lock on a resource or
1140 * namespace or every resource in a namespace.
1142 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1144 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1146 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
1147 ldlm_iterator_t iter, void *data);
1148 /** @} ldlm_iterator */
1150 int ldlm_replay_locks(struct obd_import *imp);
1153 int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1156 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
1158 struct ldlm_callback_suite {
1159 ldlm_completion_callback lcs_completion;
1160 ldlm_blocking_callback lcs_blocking;
1161 ldlm_glimpse_callback lcs_glimpse;
1165 #ifdef HAVE_SERVER_SUPPORT
1166 /** \defgroup ldlm_srv_ast Server AST handlers
1167 * These are AST handlers used by server code.
1168 * Their property is that they are just preparing RPCs to be sent to clients.
1171 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1172 void *data, int flag);
1173 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1174 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
1175 int ldlm_glimpse_locks(struct ldlm_resource *res,
1176 struct list_head *gl_work_list);
1177 /** @} ldlm_srv_ast */
1179 /** \defgroup ldlm_handlers Server LDLM handlers
1180 * These are handler functions that should be called by "frontends" such as
1181 * MDT or OST to pass through LDLM requests to LDLM for handling
1184 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
1185 ldlm_blocking_callback, ldlm_glimpse_callback);
1186 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1187 const struct ldlm_request *dlm_req,
1188 const struct ldlm_callback_suite *cbs);
1189 int ldlm_handle_convert(struct ptlrpc_request *req);
1190 int ldlm_handle_convert0(struct ptlrpc_request *req,
1191 const struct ldlm_request *dlm_req);
1192 int ldlm_handle_cancel(struct ptlrpc_request *req);
1193 int ldlm_request_cancel(struct ptlrpc_request *req,
1194 const struct ldlm_request *dlm_req, int first);
1195 /** @} ldlm_handlers */
1197 void ldlm_revoke_export_locks(struct obd_export *exp);
1199 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1200 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
1201 int ldlm_get_ref(void);
1202 void ldlm_put_ref(void);
1203 int ldlm_init_export(struct obd_export *exp);
1204 void ldlm_destroy_export(struct obd_export *exp);
1205 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req);
1208 #ifdef HAVE_SERVER_SUPPORT
1209 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1211 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1212 void ldlm_lock2handle(const struct ldlm_lock *lock,
1213 struct lustre_handle *lockh);
1214 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags);
1215 void ldlm_cancel_callback(struct ldlm_lock *);
1216 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1217 int ldlm_lock_set_data(struct lustre_handle *, void *);
1220 * Obtain a lock reference by its handle.
1222 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1224 return __ldlm_handle2lock(h, 0);
1227 #define LDLM_LOCK_REF_DEL(lock) \
1228 lu_ref_del(&lock->l_reference, "handle", current)
1230 static inline struct ldlm_lock *
1231 ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags)
1233 struct ldlm_lock *lock;
1235 lock = __ldlm_handle2lock(h, flags);
1237 LDLM_LOCK_REF_DEL(lock);
1242 * Update Lock Value Block Operations (LVBO) on a resource taking into account
1243 * data from reqest \a r
1245 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1246 struct ptlrpc_request *r, int increase)
1248 if (ldlm_res_to_ns(res)->ns_lvbo &&
1249 ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
1250 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, r,
1256 int ldlm_error2errno(ldlm_error_t error);
1257 ldlm_error_t ldlm_errno2error(int err_no); /* don't call it `errno': this
1258 * confuses user-space. */
1259 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1260 void ldlm_dump_export_locks(struct obd_export *exp);
1264 * Release a temporary lock reference obtained by ldlm_handle2lock() or
1265 * __ldlm_handle2lock().
1267 #define LDLM_LOCK_PUT(lock) \
1269 LDLM_LOCK_REF_DEL(lock); \
1270 /*LDLM_DEBUG((lock), "put");*/ \
1271 ldlm_lock_put(lock); \
1275 * Release a lock reference obtained by some other means (see
1278 #define LDLM_LOCK_RELEASE(lock) \
1280 /*LDLM_DEBUG((lock), "put");*/ \
1281 ldlm_lock_put(lock); \
1284 #define LDLM_LOCK_GET(lock) \
1286 ldlm_lock_get(lock); \
1287 /*LDLM_DEBUG((lock), "get");*/ \
1291 #define ldlm_lock_list_put(head, member, count) \
1293 struct ldlm_lock *_lock, *_next; \
1295 list_for_each_entry_safe(_lock, _next, head, member) { \
1298 list_del_init(&_lock->member); \
1299 LDLM_LOCK_RELEASE(_lock); \
1304 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1305 void ldlm_lock_put(struct ldlm_lock *lock);
1306 void ldlm_lock_destroy(struct ldlm_lock *lock);
1307 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1308 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
1309 int ldlm_lock_addref_try(struct lustre_handle *lockh, __u32 mode);
1310 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
1311 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
1312 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1313 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1314 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1315 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1316 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, __u64 flags,
1317 const struct ldlm_res_id *, ldlm_type_t type,
1318 ldlm_policy_data_t *, ldlm_mode_t mode,
1319 struct lustre_handle *, int unref);
1320 ldlm_mode_t ldlm_revalidate_lock_handle(struct lustre_handle *lockh,
1322 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
1324 void ldlm_lock_downgrade(struct ldlm_lock *lock, int new_mode);
1325 void ldlm_lock_cancel(struct ldlm_lock *lock);
1326 void ldlm_reprocess_all(struct ldlm_resource *res);
1327 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1328 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
1329 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1332 struct ldlm_namespace *
1333 ldlm_namespace_new(struct obd_device *obd, char *name,
1334 ldlm_side_t client, ldlm_appetite_t apt,
1335 ldlm_ns_type_t ns_type);
1336 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags);
1337 void ldlm_namespace_free(struct ldlm_namespace *ns,
1338 struct obd_import *imp, int force);
1339 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
1340 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
1341 void ldlm_namespace_get(struct ldlm_namespace *ns);
1342 void ldlm_namespace_put(struct ldlm_namespace *ns);
1343 int ldlm_proc_setup(void);
1345 void ldlm_proc_cleanup(void);
1347 static inline void ldlm_proc_cleanup(void) {}
1350 /* resource.c - internal */
1351 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1352 struct ldlm_resource *parent,
1353 const struct ldlm_res_id *,
1354 ldlm_type_t type, int create);
1355 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1356 int ldlm_resource_putref(struct ldlm_resource *res);
1357 void ldlm_resource_add_lock(struct ldlm_resource *res,
1358 struct list_head *head,
1359 struct ldlm_lock *lock);
1360 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1361 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1362 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
1363 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1364 void ldlm_resource_dump(int level, struct ldlm_resource *);
1365 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1366 const struct ldlm_res_id *);
1368 #define LDLM_RESOURCE_ADDREF(res) do { \
1369 lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, current); \
1372 #define LDLM_RESOURCE_DELREF(res) do { \
1373 lu_ref_del(&(res)->lr_reference, __FUNCTION__, current); \
1376 /* ldlm_request.c */
1377 int ldlm_expired_completion_wait(void *data);
1378 /** \defgroup ldlm_local_ast Default AST handlers for local locks
1379 * These AST handlers are typically used for server-side local locks and are
1380 * also used by client-side lock handlers to perform minimum level base
1383 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1384 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1385 void *data, int flag);
1386 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1387 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data);
1388 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1389 /** @} ldlm_local_ast */
1391 /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users.
1392 * These are typically used by client and server (*_local versions)
1393 * to obtain and release locks.
1395 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1396 struct ldlm_enqueue_info *einfo,
1397 const struct ldlm_res_id *res_id,
1398 ldlm_policy_data_t const *policy, __u64 *flags,
1399 void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
1400 struct lustre_handle *lockh, int async);
1401 int ldlm_prep_enqueue_req(struct obd_export *exp,
1402 struct ptlrpc_request *req,
1403 struct list_head *cancels,
1405 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
1406 int version, int opc, int canceloff,
1407 struct list_head *cancels, int count);
1409 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len);
1410 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1411 const struct ldlm_request *dlm_req,
1412 const struct ldlm_callback_suite *cbs);
1413 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1414 ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
1415 __u64 *flags, void *lvb, __u32 lvb_len,
1416 struct lustre_handle *lockh, int rc);
1417 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1418 const struct ldlm_res_id *res_id,
1419 ldlm_type_t type, ldlm_policy_data_t *policy,
1420 ldlm_mode_t mode, __u64 *flags,
1421 ldlm_blocking_callback blocking,
1422 ldlm_completion_callback completion,
1423 ldlm_glimpse_callback glimpse,
1424 void *data, __u32 lvb_len, enum lvb_type lvb_type,
1425 const __u64 *client_cookie,
1426 struct lustre_handle *lockh);
1427 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
1428 void *data, __u32 data_len);
1429 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
1430 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1431 int ldlm_cli_cancel(struct lustre_handle *lockh,
1432 ldlm_cancel_flags_t cancel_flags);
1433 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1434 ldlm_cancel_flags_t flags, void *opaque);
1435 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1436 const struct ldlm_res_id *res_id,
1437 ldlm_policy_data_t *policy,
1439 ldlm_cancel_flags_t flags,
1441 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
1442 int count, ldlm_cancel_flags_t flags);
1443 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1444 struct list_head *cancels,
1445 ldlm_policy_data_t *policy,
1446 ldlm_mode_t mode, __u64 lock_flags,
1447 ldlm_cancel_flags_t cancel_flags, void *opaque);
1448 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1449 ldlm_cancel_flags_t flags);
1450 int ldlm_cli_cancel_list(struct list_head *head, int count,
1451 struct ptlrpc_request *req, ldlm_cancel_flags_t flags);
1452 /** @} ldlm_cli_api */
1455 /* This has to be here because recursive inclusion sucks. */
1456 int intent_disposition(struct ldlm_reply *rep, int flag);
1457 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1460 * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1461 * than one lock_res is dead-lock safe.
1463 enum lock_res_type {
1468 /** Lock resource. */
1469 static inline void lock_res(struct ldlm_resource *res)
1471 spin_lock(&res->lr_lock);
1474 /** Lock resource with a way to instruct lockdep code about nestedness-safe. */
1475 static inline void lock_res_nested(struct ldlm_resource *res,
1476 enum lock_res_type mode)
1478 spin_lock_nested(&res->lr_lock, mode);
1481 /** Unlock resource. */
1482 static inline void unlock_res(struct ldlm_resource *res)
1484 spin_unlock(&res->lr_lock);
1487 /** Check if resource is already locked, assert if not. */
1488 static inline void check_res_locked(struct ldlm_resource *res)
1490 assert_spin_locked(&res->lr_lock);
1493 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1494 void unlock_res_and_lock(struct ldlm_lock *lock);
1497 /** \defgroup ldlm_pools Various LDLM pool related functions
1498 * There are not used outside of ldlm.
1501 int ldlm_pools_recalc(ldlm_side_t client);
1502 int ldlm_pools_init(void);
1503 void ldlm_pools_fini(void);
1505 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1506 int idx, ldlm_side_t client);
1507 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
1508 unsigned int gfp_mask);
1509 void ldlm_pool_fini(struct ldlm_pool *pl);
1510 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1511 int ldlm_pool_recalc(struct ldlm_pool *pl);
1512 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1513 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1514 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1515 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1516 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1517 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1518 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1519 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1520 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);