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 #include <linux/lustre_dlm.h>
53 #include <lustre_lib.h>
54 #include <lustre_net.h>
55 #include <lustre_import.h>
56 #include <lustre_handles.h>
57 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
60 #include "lustre_dlm_flags.h"
65 #define OBD_LDLM_DEVICENAME "ldlm"
67 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
68 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
69 #define LDLM_CTIME_AGE_LIMIT (10)
70 #define LDLM_DEFAULT_PARALLEL_AST_LIMIT 1024
73 * LDLM non-error return states
78 ELDLM_LOCK_CHANGED = 300,
79 ELDLM_LOCK_ABORTED = 301,
80 ELDLM_LOCK_REPLACED = 302,
81 ELDLM_NO_LOCK_DATA = 303,
82 ELDLM_LOCK_WOULDBLOCK = 304,
84 ELDLM_NAMESPACE_EXISTS = 400,
85 ELDLM_BAD_NAMESPACE = 401
89 * LDLM namespace type.
90 * The "client" type is actually an indication that this is a narrow local view
91 * into complete namespace on the server. Such namespaces cannot make any
92 * decisions about lack of conflicts or do any autonomous lock granting without
93 * first speaking to a server.
96 LDLM_NAMESPACE_SERVER = 1 << 0,
97 LDLM_NAMESPACE_CLIENT = 1 << 1
101 * The blocking callback is overloaded to perform two functions. These flags
102 * indicate which operation should be performed.
104 #define LDLM_CB_BLOCKING 1
105 #define LDLM_CB_CANCELING 2
108 * \name Lock Compatibility Matrix.
110 * A lock has both a type (extent, flock, inode bits, or plain) and a mode.
111 * Lock types are described in their respective implementation files:
112 * ldlm_{extent,flock,inodebits,plain}.c.
114 * There are six lock modes along with a compatibility matrix to indicate if
115 * two locks are compatible.
117 * - EX: Exclusive mode. Before a new file is created, MDS requests EX lock
119 * - PW: Protective Write (normal write) mode. When a client requests a write
120 * lock from an OST, a lock with PW mode will be issued.
121 * - PR: Protective Read (normal read) mode. When a client requests a read from
122 * an OST, a lock with PR mode will be issued. Also, if the client opens a
123 * file for execution, it is granted a lock with PR mode.
124 * - CW: Concurrent Write mode. The type of lock that the MDS grants if a client
125 * requests a write lock during a file open operation.
126 * - CR Concurrent Read mode. When a client performs a path lookup, MDS grants
127 * an inodebit lock with the CR mode on the intermediate path component.
141 #define LCK_COMPAT_EX LCK_NL
142 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
143 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
144 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
145 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
146 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
147 #define LCK_COMPAT_GROUP (LCK_GROUP | LCK_NL)
148 #define LCK_COMPAT_COS (LCK_COS)
149 /** @} Lock Compatibility Matrix */
151 extern ldlm_mode_t lck_compat_array[];
153 static inline void lockmode_verify(ldlm_mode_t mode)
155 LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
158 static inline int lockmode_compat(ldlm_mode_t exist_mode, ldlm_mode_t new_mode)
160 return (lck_compat_array[exist_mode] & new_mode);
165 * cluster name spaces
169 #define DLM_OST_NAMESPACE 1
170 #define DLM_MDS_NAMESPACE 2
173 - do we just separate this by security domains and use a prefix for
174 multiple namespaces in the same domain?
179 * Locking rules for LDLM:
184 * waiting_locks_spinlock
199 struct ldlm_resource;
200 struct ldlm_namespace;
203 * Operations on LDLM pools.
204 * LDLM pool is a pool of locks in the namespace without any implicitly
206 * Locks in the pool are organized in LRU.
207 * Local memory pressure or server instructions (e.g. mempressure on server)
208 * can trigger freeing of locks from the pool
210 struct ldlm_pool_ops {
211 /** Recalculate pool \a pl usage */
212 int (*po_recalc)(struct ldlm_pool *pl);
213 /** Cancel at least \a nr locks from pool \a pl */
214 int (*po_shrink)(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
215 int (*po_setup)(struct ldlm_pool *pl, int limit);
218 /** One second for pools thread check interval. Each pool has own period. */
219 #define LDLM_POOLS_THREAD_PERIOD (1)
221 /** ~6% margin for modest pools. See ldlm_pool.c for details. */
222 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
224 /** Default recalc period for server side pools in sec. */
225 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
227 /** Default recalc period for client side pools in sec. */
228 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
231 * LDLM pool structure to track granted locks.
232 * For purposes of determining when to release locks on e.g. memory pressure.
233 * This feature is commonly referred to as lru_resize.
236 /** Pool proc directory. */
237 struct proc_dir_entry *pl_proc_dir;
238 /** Pool name, must be long enough to hold compound proc entry name. */
240 /** Lock for protecting SLV/CLV updates. */
242 /** Number of allowed locks in in pool, both, client and server side. */
244 /** Number of granted locks in */
246 /** Grant rate per T. */
247 atomic_t pl_grant_rate;
248 /** Cancel rate per T. */
249 atomic_t pl_cancel_rate;
250 /** Server lock volume (SLV). Protected by pl_lock. */
251 __u64 pl_server_lock_volume;
252 /** Current biggest client lock volume. Protected by pl_lock. */
253 __u64 pl_client_lock_volume;
254 /** Lock volume factor. SLV on client is calculated as following:
255 * server_slv * lock_volume_factor. */
256 atomic_t pl_lock_volume_factor;
257 /** Time when last SLV from server was obtained. */
258 time_t pl_recalc_time;
259 /** Recalculation period for pool. */
260 time_t pl_recalc_period;
261 /** Recalculation and shrink operations. */
262 struct ldlm_pool_ops *pl_ops;
263 /** Number of planned locks for next period. */
265 /** Pool statistics. */
266 struct lprocfs_stats *pl_stats;
269 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
270 void *req_cookie, ldlm_mode_t mode, __u64 flags,
273 typedef int (*ldlm_cancel_cbt)(struct ldlm_lock *lock);
277 * LVB is Lock Value Block. This is a special opaque (to LDLM) value that could
278 * be associated with an LDLM lock and transferred from client to server and
281 * Currently LVBs are used by:
282 * - OSC-OST code to maintain current object size/times
283 * - layout lock code to return the layout when the layout lock is granted
285 * To ensure delayed LVB initialization, it is highly recommended to use the set
286 * of ldlm_[res_]lvbo_[init,update,fill]() functions.
288 struct ldlm_valblock_ops {
289 int (*lvbo_init)(struct ldlm_resource *res);
290 int (*lvbo_update)(struct ldlm_resource *res,
291 struct ptlrpc_request *r,
293 int (*lvbo_free)(struct ldlm_resource *res);
294 /* Return size of lvb data appropriate RPC size can be reserved */
295 int (*lvbo_size)(struct ldlm_lock *lock);
296 /* Called to fill in lvb data to RPC buffer @buf */
297 int (*lvbo_fill)(struct ldlm_lock *lock, void *buf, int buflen);
301 * LDLM pools related, type of lock pool in the namespace.
302 * Greedy means release cached locks aggressively
305 LDLM_NAMESPACE_GREEDY = 1 << 0,
306 LDLM_NAMESPACE_MODEST = 1 << 1
310 * Default values for the "max_nolock_size", "contention_time" and
311 * "contended_locks" namespace tunables.
313 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
314 #define NS_DEFAULT_CONTENTION_SECONDS 2
315 #define NS_DEFAULT_CONTENDED_LOCKS 32
317 struct ldlm_ns_bucket {
318 /** back pointer to namespace */
319 struct ldlm_namespace *nsb_namespace;
321 * Estimated lock callback time. Used by adaptive timeout code to
322 * avoid spurious client evictions due to unresponsiveness when in
323 * fact the network or overall system load is at fault
325 struct adaptive_timeout nsb_at_estimate;
329 /** LDLM namespace lock stats */
336 LDLM_NS_TYPE_UNKNOWN = 0,
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 ldlm_side_t ns_client;
379 /** Resource hash table for namespace. */
380 cfs_hash_t *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 ldlm_appetite_t 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;
514 * Returns 1 if namespace \a ns is a client namespace.
516 static inline int ns_is_client(struct ldlm_namespace *ns)
519 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
520 LDLM_NAMESPACE_SERVER)));
521 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
522 ns->ns_client == LDLM_NAMESPACE_SERVER);
523 return ns->ns_client == LDLM_NAMESPACE_CLIENT;
527 * Returns 1 if namespace \a ns is a server namespace.
529 static inline int ns_is_server(struct ldlm_namespace *ns)
532 LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
533 LDLM_NAMESPACE_SERVER)));
534 LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
535 ns->ns_client == LDLM_NAMESPACE_SERVER);
536 return ns->ns_client == LDLM_NAMESPACE_SERVER;
540 * Returns 1 if namespace \a ns supports early lock cancel (ELC).
542 static inline int ns_connect_cancelset(struct ldlm_namespace *ns)
545 return !!(ns->ns_connect_flags & OBD_CONNECT_CANCELSET);
549 * Returns 1 if this namespace supports lru_resize.
551 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
554 return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
557 static inline void ns_register_cancel(struct ldlm_namespace *ns,
566 /** Type for blocking callback function of a lock. */
567 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
568 struct ldlm_lock_desc *new, void *data,
570 /** Type for completion callback function of a lock. */
571 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, __u64 flags,
573 /** Type for glimpse callback function of a lock. */
574 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
576 /** Work list for sending GL ASTs to multiple locks. */
577 struct ldlm_glimpse_work {
578 struct ldlm_lock *gl_lock; /* lock to glimpse */
579 struct list_head gl_list; /* linkage to other gl work structs */
580 __u32 gl_flags;/* see LDLM_GL_WORK_* below */
581 union ldlm_gl_desc *gl_desc; /* glimpse descriptor to be packed in
582 * glimpse callback request */
585 /** The ldlm_glimpse_work is allocated on the stack and should not be freed. */
586 #define LDLM_GL_WORK_NOFREE 0x1
588 /** Interval node data for each LDLM_EXTENT lock. */
589 struct ldlm_interval {
590 struct interval_node li_node; /* node for tree management */
591 struct list_head li_group; /* the locks which have the same
592 * policy - group of the policy */
594 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
597 * Interval tree for extent locks.
598 * The interval tree must be accessed under the resource lock.
599 * Interval trees are used for granted extent locks to speed up conflicts
600 * lookup. See ldlm/interval_tree.c for more details.
602 struct ldlm_interval_tree {
605 ldlm_mode_t lit_mode; /* lock mode */
606 struct interval_node *lit_root; /* actual ldlm_interval */
609 /** Whether to track references to exports by LDLM locks. */
610 #define LUSTRE_TRACKS_LOCK_EXP_REFS (0)
614 LCF_ASYNC = 0x1, /* Cancel locks asynchronously. */
615 LCF_LOCAL = 0x2, /* Cancel locks locally, not notifing server */
616 LCF_BL_AST = 0x4, /* Cancel locks marked as LDLM_FL_BL_AST
618 } ldlm_cancel_flags_t;
624 __u64 blocking_owner;
625 struct obd_export *blocking_export;
626 /* Protected by the hash lock */
631 union ldlm_policy_data {
632 struct ldlm_extent l_extent;
633 struct ldlm_flock l_flock;
634 struct ldlm_inodebits l_inodebits;
637 typedef union ldlm_policy_data ldlm_policy_data_t;
639 void ldlm_convert_policy_to_wire(ldlm_type_t type,
640 const ldlm_policy_data_t *lpolicy,
641 ldlm_wire_policy_data_t *wpolicy);
642 void ldlm_convert_policy_to_local(struct obd_export *exp, ldlm_type_t type,
643 const ldlm_wire_policy_data_t *wpolicy,
644 ldlm_policy_data_t *lpolicy);
654 * LDLM lock structure
656 * Represents a single LDLM lock and its state in memory. Each lock is
657 * associated with a single ldlm_resource, the object which is being
658 * locked. There may be multiple ldlm_locks on a single resource,
659 * depending on the lock type and whether the locks are conflicting or
665 * When remote side wants to tell us about a lock, they address
666 * it by this opaque handle. The handle does not hold a
667 * reference on the ldlm_lock, so it can be safely passed to
668 * other threads or nodes. When the lock needs to be accessed
669 * from the handle, it is looked up again in the lock table, and
670 * may no longer exist.
672 * Must be first in the structure.
674 struct portals_handle l_handle;
676 * Lock reference count.
677 * This is how many users have pointers to actual structure, so that
678 * we do not accidentally free lock structure that is in use.
682 * Internal spinlock protects l_resource. We should hold this lock
683 * first before taking res_lock.
687 * Pointer to actual resource this lock is in.
688 * ldlm_lock_change_resource() can change this.
690 struct ldlm_resource *l_resource;
692 * List item for client side LRU list.
693 * Protected by ns_lock in struct ldlm_namespace.
695 struct list_head l_lru;
697 * Linkage to resource's lock queues according to current lock state.
698 * (could be granted, waiting or converting)
699 * Protected by lr_lock in struct ldlm_resource.
701 struct list_head l_res_link;
703 * Tree node for ldlm_extent.
705 struct ldlm_interval *l_tree_node;
707 * Per export hash of locks.
708 * Protected by per-bucket exp->exp_lock_hash locks.
710 struct hlist_node l_exp_hash;
712 * Per export hash of flock locks.
713 * Protected by per-bucket exp->exp_flock_hash locks.
715 struct hlist_node l_exp_flock_hash;
718 * Protected by lr_lock.
720 ldlm_mode_t l_req_mode;
722 * Granted mode, also protected by lr_lock.
724 ldlm_mode_t l_granted_mode;
725 /** Lock completion handler pointer. Called when lock is granted. */
726 ldlm_completion_callback l_completion_ast;
728 * Lock blocking AST handler pointer.
729 * It plays two roles:
730 * - as a notification of an attempt to queue a conflicting lock (once)
731 * - as a notification when the lock is being cancelled.
733 * As such it's typically called twice: once for the initial conflict
734 * and then once more when the last user went away and the lock is
735 * cancelled (could happen recursively).
737 ldlm_blocking_callback l_blocking_ast;
739 * Lock glimpse handler.
740 * Glimpse handler is used to obtain LVB updates from a client by
743 ldlm_glimpse_callback l_glimpse_ast;
747 * This is a pointer to actual client export for locks that were granted
748 * to clients. Used server-side.
750 struct obd_export *l_export;
752 * Lock connection export.
753 * Pointer to server export on a client.
755 struct obd_export *l_conn_export;
758 * Remote lock handle.
759 * If the lock is remote, this is the handle of the other side lock
762 struct lustre_handle l_remote_handle;
765 * Representation of private data specific for a lock type.
766 * Examples are: extent range for extent lock or bitmask for ibits locks
768 ldlm_policy_data_t l_policy_data;
771 * Lock state flags. Protected by lr_lock.
772 * \see lustre_dlm_flags.h where the bits are defined.
777 * Lock r/w usage counters.
778 * Protected by lr_lock.
783 * If the lock is granted, a process sleeps on this waitq to learn when
784 * it's no longer in use. If the lock is not granted, a process sleeps
785 * on this waitq to learn when it becomes granted.
787 wait_queue_head_t l_waitq;
790 * Seconds. It will be updated if there is any activity related to
791 * the lock, e.g. enqueue the lock or send blocking AST.
793 cfs_time_t l_last_activity;
796 * Time last used by e.g. being matched by lock match.
797 * Jiffies. Should be converted to time if needed.
799 cfs_time_t l_last_used;
801 /** Originally requested extent for the extent lock. */
802 struct ldlm_extent l_req_extent;
805 * Client-side-only members.
808 enum lvb_type l_lvb_type;
811 * Temporary storage for a LVB received during an enqueue operation.
816 /** Private storage for lock user. Opaque to LDLM. */
820 * Server-side-only members.
824 * Connection cookie for the client originating the operation.
825 * Used by Commit on Share (COS) code. Currently only used for
826 * inodebits locks on MDS.
828 __u64 l_client_cookie;
831 * List item for locks waiting for cancellation from clients.
832 * The lists this could be linked into are:
833 * waiting_locks_list (protected by waiting_locks_spinlock),
834 * then if the lock timed out, it is moved to
835 * expired_lock_thread.elt_expired_locks for further processing.
836 * Protected by elt_lock.
838 struct list_head l_pending_chain;
841 * Set when lock is sent a blocking AST. Time in seconds when timeout
842 * is reached and client holding this lock could be evicted.
843 * This timeout could be further extended by e.g. certain IO activity
845 * \see ost_rw_prolong_locks
847 cfs_time_t l_callback_timeout;
849 /** Local PID of process which created this lock. */
853 * Number of times blocking AST was sent for this lock.
854 * This is for debugging. Valid values are 0 and 1, if there is an
855 * attempt to send blocking AST more than once, an assertion would be
856 * hit. \see ldlm_work_bl_ast_lock
859 /** List item ldlm_add_ast_work_item() for case of blocking ASTs. */
860 struct list_head l_bl_ast;
861 /** List item ldlm_add_ast_work_item() for case of completion ASTs. */
862 struct list_head l_cp_ast;
863 /** For ldlm_add_ast_work_item() for "revoke" AST used in COS. */
864 struct list_head l_rk_ast;
867 * Pointer to a conflicting lock that caused blocking AST to be sent
870 struct ldlm_lock *l_blocking_lock;
873 * Protected by lr_lock, linkages to "skip lists".
874 * For more explanations of skip lists see ldlm/ldlm_inodebits.c
876 struct list_head l_sl_mode;
877 struct list_head l_sl_policy;
879 /** Reference tracking structure to debug leaked locks. */
880 struct lu_ref l_reference;
881 #if LUSTRE_TRACKS_LOCK_EXP_REFS
882 /* Debugging stuff for bug 20498, for tracking export references. */
883 /** number of export references taken */
885 /** link all locks referencing one export */
886 struct list_head l_exp_refs_link;
887 /** referenced export object */
888 struct obd_export *l_exp_refs_target;
891 * export blocking dlm lock list, protected by
892 * l_export->exp_bl_list_lock.
893 * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
894 * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock.
896 struct list_head l_exp_list;
900 * LDLM resource description.
901 * Basically, resource is a representation for a single object.
902 * Object has a name which is currently 4 64-bit integers. LDLM user is
903 * responsible for creation of a mapping between objects it wants to be
904 * protected and resource names.
906 * A resource can only hold locks of a single lock type, though there may be
907 * multiple ldlm_locks on a single resource, depending on the lock type and
908 * whether the locks are conflicting or not.
910 struct ldlm_resource {
911 struct ldlm_ns_bucket *lr_ns_bucket;
914 * List item for list in namespace hash.
915 * protected by ns_lock
917 struct hlist_node lr_hash;
919 /** Spinlock to protect locks under this resource. */
923 * protected by lr_lock
925 /** List of locks in granted state */
926 struct list_head lr_granted;
927 /** List of locks waiting to change their granted mode (converted) */
928 struct list_head lr_converting;
930 * List of locks that could not be granted due to conflicts and
931 * that are waiting for conflicts to go away */
932 struct list_head lr_waiting;
935 /* XXX No longer needed? Remove ASAP */
936 ldlm_mode_t lr_most_restr;
938 /** Type of locks this resource can hold. Only one type per resource. */
939 ldlm_type_t lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */
942 struct ldlm_res_id lr_name;
943 /** Reference count for this resource */
944 atomic_t lr_refcount;
947 * Interval trees (only for extent locks) for all modes of this resource
949 struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];
952 * Server-side-only lock value block elements.
953 * To serialize lvbo_init.
955 struct mutex lr_lvb_mutex;
957 /** is lvb initialized ? */
958 bool lr_lvb_initialized;
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);
1011 if (ns->ns_lvbo == NULL || ns->ns_lvbo->lvbo_init == NULL ||
1012 res->lr_lvb_initialized)
1015 mutex_lock(&res->lr_lvb_mutex);
1016 /* Did we lose the race? */
1017 if (res->lr_lvb_initialized) {
1018 mutex_unlock(&res->lr_lvb_mutex);
1021 rc = ns->ns_lvbo->lvbo_init(res);
1023 CDEBUG(D_DLMTRACE, "lvbo_init failed for resource : rc = %d\n",
1025 if (res->lr_lvb_data != NULL) {
1026 OBD_FREE(res->lr_lvb_data, res->lr_lvb_len);
1027 res->lr_lvb_data = NULL;
1029 res->lr_lvb_len = rc;
1031 res->lr_lvb_initialized = true;
1033 mutex_unlock(&res->lr_lvb_mutex);
1037 static inline int ldlm_lvbo_size(struct ldlm_lock *lock)
1039 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1041 if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_size != NULL)
1042 return ns->ns_lvbo->lvbo_size(lock);
1047 static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int len)
1049 struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1052 if (ns->ns_lvbo != NULL) {
1053 LASSERT(ns->ns_lvbo->lvbo_fill != NULL);
1054 /* init lvb now if not already */
1055 rc = ldlm_lvbo_init(lock->l_resource);
1057 CERROR("lock %p: delayed lvb init failed (rc %d)",
1061 return ns->ns_lvbo->lvbo_fill(lock, buf, len);
1066 struct ldlm_ast_work {
1067 struct ldlm_lock *w_lock;
1069 struct ldlm_lock_desc w_desc;
1070 struct list_head w_list;
1077 * Common ldlm_enqueue parameters
1079 struct ldlm_enqueue_info {
1080 __u32 ei_type; /** Type of the lock being enqueued. */
1081 __u32 ei_mode; /** Mode of the lock being enqueued. */
1082 void *ei_cb_bl; /** blocking lock callback */
1083 void *ei_cb_cp; /** lock completion callback */
1084 void *ei_cb_gl; /** lock glimpse callback */
1085 void *ei_cbdata; /** Data to be passed into callbacks. */
1086 unsigned int ei_enq_slave:1; /* whether enqueue slave stripes */
1089 #define ei_res_id ei_cb_gl
1091 extern struct obd_ops ldlm_obd_ops;
1093 extern char *ldlm_lockname[];
1094 extern char *ldlm_typename[];
1095 extern char *ldlm_it2str(int it);
1098 * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG.
1099 * For the cases where we do not have actual lock to print along
1100 * with a debugging message that is ldlm-related
1102 #define LDLM_DEBUG_NOLOCK(format, a...) \
1103 CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
1106 * Support function for lock information printing into debug logs.
1110 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do { \
1111 CFS_CHECK_STACK(msgdata, mask, cdls); \
1113 if (((mask) & D_CANTMASK) != 0 || \
1114 ((libcfs_debug & (mask)) != 0 && \
1115 (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) \
1116 _ldlm_lock_debug(lock, msgdata, fmt, ##a); \
1119 void _ldlm_lock_debug(struct ldlm_lock *lock,
1120 struct libcfs_debug_msg_data *data,
1121 const char *fmt, ...)
1122 __attribute__ ((format (printf, 3, 4)));
1125 * Rate-limited version of lock printing function.
1127 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do { \
1128 static cfs_debug_limit_state_t _ldlm_cdls; \
1129 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls); \
1130 ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
1133 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
1134 #define LDLM_WARN(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
1136 /** Non-rate-limited lock printing function for debugging purposes. */
1137 #define LDLM_DEBUG(lock, fmt, a...) do { \
1138 if (likely(lock != NULL)) { \
1139 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL); \
1140 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock, \
1141 "### " fmt , ##a); \
1143 LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a); \
1146 #else /* !LIBCFS_DEBUG */
1147 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
1148 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
1149 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
1152 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags,
1153 int first_enq, ldlm_error_t *err,
1154 struct list_head *work_list);
1157 * Return values for lock iterators.
1158 * Also used during deciding of lock grants and cancellations.
1160 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
1161 #define LDLM_ITER_STOP 2 /* stop iterating */
1163 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
1164 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
1166 /** \defgroup ldlm_iterator Lock iterators
1168 * LDLM provides for a way to iterate through every lock on a resource or
1169 * namespace or every resource in a namespace.
1171 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1173 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1175 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
1176 ldlm_iterator_t iter, void *data);
1177 /** @} ldlm_iterator */
1179 int ldlm_replay_locks(struct obd_import *imp);
1182 int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1185 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
1187 struct ldlm_callback_suite {
1188 ldlm_completion_callback lcs_completion;
1189 ldlm_blocking_callback lcs_blocking;
1190 ldlm_glimpse_callback lcs_glimpse;
1194 #ifdef HAVE_SERVER_SUPPORT
1195 /** \defgroup ldlm_srv_ast Server AST handlers
1196 * These are AST handlers used by server code.
1197 * Their property is that they are just preparing RPCs to be sent to clients.
1200 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1201 void *data, int flag);
1202 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1203 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
1204 int ldlm_glimpse_locks(struct ldlm_resource *res,
1205 struct list_head *gl_work_list);
1206 /** @} ldlm_srv_ast */
1208 /** \defgroup ldlm_handlers Server LDLM handlers
1209 * These are handler functions that should be called by "frontends" such as
1210 * MDT or OST to pass through LDLM requests to LDLM for handling
1213 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
1214 ldlm_blocking_callback, ldlm_glimpse_callback);
1215 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1216 const struct ldlm_request *dlm_req,
1217 const struct ldlm_callback_suite *cbs);
1218 int ldlm_handle_convert(struct ptlrpc_request *req);
1219 int ldlm_handle_convert0(struct ptlrpc_request *req,
1220 const struct ldlm_request *dlm_req);
1221 int ldlm_handle_cancel(struct ptlrpc_request *req);
1222 int ldlm_request_cancel(struct ptlrpc_request *req,
1223 const struct ldlm_request *dlm_req, int first);
1224 /** @} ldlm_handlers */
1226 void ldlm_revoke_export_locks(struct obd_export *exp);
1228 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1229 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
1230 int ldlm_get_ref(void);
1231 void ldlm_put_ref(void);
1232 int ldlm_init_export(struct obd_export *exp);
1233 void ldlm_destroy_export(struct obd_export *exp);
1234 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req);
1237 #ifdef HAVE_SERVER_SUPPORT
1238 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1240 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1241 void ldlm_lock2handle(const struct ldlm_lock *lock,
1242 struct lustre_handle *lockh);
1243 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags);
1244 void ldlm_cancel_callback(struct ldlm_lock *);
1245 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1246 int ldlm_lock_set_data(struct lustre_handle *, void *);
1249 * Obtain a lock reference by its handle.
1251 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1253 return __ldlm_handle2lock(h, 0);
1256 #define LDLM_LOCK_REF_DEL(lock) \
1257 lu_ref_del(&lock->l_reference, "handle", current)
1259 static inline struct ldlm_lock *
1260 ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags)
1262 struct ldlm_lock *lock;
1264 lock = __ldlm_handle2lock(h, flags);
1266 LDLM_LOCK_REF_DEL(lock);
1271 * Update Lock Value Block Operations (LVBO) on a resource taking into account
1272 * data from reqest \a r
1274 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1275 struct ptlrpc_request *r, int increase)
1279 /* delayed lvb init may be required */
1280 rc = ldlm_lvbo_init(res);
1282 CERROR("delayed lvb init failed (rc %d)\n", rc);
1286 if (ldlm_res_to_ns(res)->ns_lvbo &&
1287 ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
1288 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, r,
1294 int ldlm_error2errno(ldlm_error_t error);
1295 ldlm_error_t ldlm_errno2error(int err_no); /* don't call it `errno': this
1296 * confuses user-space. */
1297 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1298 void ldlm_dump_export_locks(struct obd_export *exp);
1302 * Release a temporary lock reference obtained by ldlm_handle2lock() or
1303 * __ldlm_handle2lock().
1305 #define LDLM_LOCK_PUT(lock) \
1307 LDLM_LOCK_REF_DEL(lock); \
1308 /*LDLM_DEBUG((lock), "put");*/ \
1309 ldlm_lock_put(lock); \
1313 * Release a lock reference obtained by some other means (see
1316 #define LDLM_LOCK_RELEASE(lock) \
1318 /*LDLM_DEBUG((lock), "put");*/ \
1319 ldlm_lock_put(lock); \
1322 #define LDLM_LOCK_GET(lock) \
1324 ldlm_lock_get(lock); \
1325 /*LDLM_DEBUG((lock), "get");*/ \
1329 #define ldlm_lock_list_put(head, member, count) \
1331 struct ldlm_lock *_lock, *_next; \
1333 list_for_each_entry_safe(_lock, _next, head, member) { \
1336 list_del_init(&_lock->member); \
1337 LDLM_LOCK_RELEASE(_lock); \
1342 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1343 void ldlm_lock_put(struct ldlm_lock *lock);
1344 void ldlm_lock_destroy(struct ldlm_lock *lock);
1345 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1346 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
1347 int ldlm_lock_addref_try(struct lustre_handle *lockh, __u32 mode);
1348 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
1349 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
1350 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1351 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1352 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1353 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1354 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, __u64 flags,
1355 const struct ldlm_res_id *, ldlm_type_t type,
1356 ldlm_policy_data_t *, ldlm_mode_t mode,
1357 struct lustre_handle *, int unref);
1358 ldlm_mode_t ldlm_revalidate_lock_handle(struct lustre_handle *lockh,
1360 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
1362 void ldlm_lock_downgrade(struct ldlm_lock *lock, int new_mode);
1363 void ldlm_lock_cancel(struct ldlm_lock *lock);
1364 void ldlm_reprocess_all(struct ldlm_resource *res);
1365 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1366 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
1367 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1370 struct ldlm_namespace *
1371 ldlm_namespace_new(struct obd_device *obd, char *name,
1372 ldlm_side_t client, ldlm_appetite_t apt,
1373 ldlm_ns_type_t ns_type);
1374 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags);
1375 void ldlm_namespace_free(struct ldlm_namespace *ns,
1376 struct obd_import *imp, int force);
1377 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
1378 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
1379 void ldlm_namespace_get(struct ldlm_namespace *ns);
1380 void ldlm_namespace_put(struct ldlm_namespace *ns);
1381 int ldlm_proc_setup(void);
1383 void ldlm_proc_cleanup(void);
1385 static inline void ldlm_proc_cleanup(void) {}
1388 /* resource.c - internal */
1389 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1390 struct ldlm_resource *parent,
1391 const struct ldlm_res_id *,
1392 ldlm_type_t type, int create);
1393 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1394 int ldlm_resource_putref(struct ldlm_resource *res);
1395 void ldlm_resource_add_lock(struct ldlm_resource *res,
1396 struct list_head *head,
1397 struct ldlm_lock *lock);
1398 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1399 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1400 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
1401 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1402 void ldlm_resource_dump(int level, struct ldlm_resource *);
1403 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1404 const struct ldlm_res_id *);
1406 #define LDLM_RESOURCE_ADDREF(res) do { \
1407 lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, current); \
1410 #define LDLM_RESOURCE_DELREF(res) do { \
1411 lu_ref_del(&(res)->lr_reference, __FUNCTION__, current); \
1414 /* ldlm_request.c */
1415 int ldlm_expired_completion_wait(void *data);
1416 /** \defgroup ldlm_local_ast Default AST handlers for local locks
1417 * These AST handlers are typically used for server-side local locks and are
1418 * also used by client-side lock handlers to perform minimum level base
1421 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1422 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1423 void *data, int flag);
1424 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1425 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data);
1426 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1427 /** @} ldlm_local_ast */
1429 /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users.
1430 * These are typically used by client and server (*_local versions)
1431 * to obtain and release locks.
1433 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1434 struct ldlm_enqueue_info *einfo,
1435 const struct ldlm_res_id *res_id,
1436 ldlm_policy_data_t const *policy, __u64 *flags,
1437 void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
1438 struct lustre_handle *lockh, int async);
1439 int ldlm_prep_enqueue_req(struct obd_export *exp,
1440 struct ptlrpc_request *req,
1441 struct list_head *cancels,
1443 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
1444 int version, int opc, int canceloff,
1445 struct list_head *cancels, int count);
1447 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len);
1448 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1449 const struct ldlm_request *dlm_req,
1450 const struct ldlm_callback_suite *cbs);
1451 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1452 ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
1453 __u64 *flags, void *lvb, __u32 lvb_len,
1454 struct lustre_handle *lockh, int rc);
1455 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1456 const struct ldlm_res_id *res_id,
1457 ldlm_type_t type, ldlm_policy_data_t *policy,
1458 ldlm_mode_t mode, __u64 *flags,
1459 ldlm_blocking_callback blocking,
1460 ldlm_completion_callback completion,
1461 ldlm_glimpse_callback glimpse,
1462 void *data, __u32 lvb_len, enum lvb_type lvb_type,
1463 const __u64 *client_cookie,
1464 struct lustre_handle *lockh);
1465 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
1466 void *data, __u32 data_len);
1467 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
1468 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1469 int ldlm_cli_cancel(struct lustre_handle *lockh,
1470 ldlm_cancel_flags_t cancel_flags);
1471 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1472 ldlm_cancel_flags_t flags, void *opaque);
1473 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1474 const struct ldlm_res_id *res_id,
1475 ldlm_policy_data_t *policy,
1477 ldlm_cancel_flags_t flags,
1479 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
1480 int count, ldlm_cancel_flags_t flags);
1481 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1482 struct list_head *cancels,
1483 ldlm_policy_data_t *policy,
1484 ldlm_mode_t mode, __u64 lock_flags,
1485 ldlm_cancel_flags_t cancel_flags, void *opaque);
1486 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1487 ldlm_cancel_flags_t flags);
1488 int ldlm_cli_cancel_list(struct list_head *head, int count,
1489 struct ptlrpc_request *req, ldlm_cancel_flags_t flags);
1490 /** @} ldlm_cli_api */
1493 /* This has to be here because recursive inclusion sucks. */
1494 int intent_disposition(struct ldlm_reply *rep, int flag);
1495 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1498 * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1499 * than one lock_res is dead-lock safe.
1501 enum lock_res_type {
1506 /** Lock resource. */
1507 static inline void lock_res(struct ldlm_resource *res)
1509 spin_lock(&res->lr_lock);
1512 /** Lock resource with a way to instruct lockdep code about nestedness-safe. */
1513 static inline void lock_res_nested(struct ldlm_resource *res,
1514 enum lock_res_type mode)
1516 spin_lock_nested(&res->lr_lock, mode);
1519 /** Unlock resource. */
1520 static inline void unlock_res(struct ldlm_resource *res)
1522 spin_unlock(&res->lr_lock);
1525 /** Check if resource is already locked, assert if not. */
1526 static inline void check_res_locked(struct ldlm_resource *res)
1528 assert_spin_locked(&res->lr_lock);
1531 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1532 void unlock_res_and_lock(struct ldlm_lock *lock);
1535 /** \defgroup ldlm_pools Various LDLM pool related functions
1536 * There are not used outside of ldlm.
1539 int ldlm_pools_recalc(ldlm_side_t client);
1540 int ldlm_pools_init(void);
1541 void ldlm_pools_fini(void);
1543 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1544 int idx, ldlm_side_t client);
1545 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
1546 void ldlm_pool_fini(struct ldlm_pool *pl);
1547 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1548 int ldlm_pool_recalc(struct ldlm_pool *pl);
1549 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1550 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1551 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1552 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1553 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1554 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1555 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1556 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1557 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);