Whamcloud - gitweb
LU-8349 ldlm: ASSERTION(flock->blocking_export!=0) failed
[fs/lustre-release.git] / lustre / include / lustre_dlm.h
1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
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
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2007, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2010, 2015, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36
37 /** \defgroup LDLM Lustre Distributed Lock Manager
38  *
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.
44  *
45  * @{
46  */
47
48 #ifndef _LUSTRE_DLM_H__
49 #define _LUSTRE_DLM_H__
50
51 #include <lustre_lib.h>
52 #include <lustre_net.h>
53 #include <lustre_import.h>
54 #include <lustre_handles.h>
55 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
56 #include <lu_ref.h>
57
58 #include "lustre_dlm_flags.h"
59
60 struct obd_ops;
61 struct obd_device;
62
63 #define OBD_LDLM_DEVICENAME  "ldlm"
64
65 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
66 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(3900)) /* 65 min */
67 #define LDLM_CTIME_AGE_LIMIT (10)
68 #define LDLM_DEFAULT_PARALLEL_AST_LIMIT 1024
69
70 /**
71  * LDLM non-error return states
72  */
73 enum ldlm_error {
74         ELDLM_OK                = 0,
75         ELDLM_LOCK_MATCHED      = 1,
76
77         ELDLM_LOCK_CHANGED      = 300,
78         ELDLM_LOCK_ABORTED      = 301,
79         ELDLM_LOCK_REPLACED     = 302,
80         ELDLM_NO_LOCK_DATA      = 303,
81         ELDLM_LOCK_WOULDBLOCK   = 304,
82
83         ELDLM_NAMESPACE_EXISTS  = 400,
84         ELDLM_BAD_NAMESPACE     = 401,
85 };
86
87 /**
88  * LDLM namespace type.
89  * The "client" type is actually an indication that this is a narrow local view
90  * into complete namespace on the server. Such namespaces cannot make any
91  * decisions about lack of conflicts or do any autonomous lock granting without
92  * first speaking to a server.
93  */
94 enum ldlm_side {
95         LDLM_NAMESPACE_SERVER = 0x01,
96         LDLM_NAMESPACE_CLIENT = 0x02
97 };
98
99 /**
100  * The blocking callback is overloaded to perform two functions.  These flags
101  * indicate which operation should be performed.
102  */
103 #define LDLM_CB_BLOCKING    1
104 #define LDLM_CB_CANCELING   2
105
106 /**
107  * \name Lock Compatibility Matrix.
108  *
109  * A lock has both a type (extent, flock, inode bits, or plain) and a mode.
110  * Lock types are described in their respective implementation files:
111  * ldlm_{extent,flock,inodebits,plain}.c.
112  *
113  * There are six lock modes along with a compatibility matrix to indicate if
114  * two locks are compatible.
115  *
116  * - EX: Exclusive mode. Before a new file is created, MDS requests EX lock
117  *   on the parent.
118  * - PW: Protective Write (normal write) mode. When a client requests a write
119  *   lock from an OST, a lock with PW mode will be issued.
120  * - PR: Protective Read (normal read) mode. When a client requests a read from
121  *   an OST, a lock with PR mode will be issued. Also, if the client opens a
122  *   file for execution, it is granted a lock with PR mode.
123  * - CW: Concurrent Write mode. The type of lock that the MDS grants if a client
124  *   requests a write lock during a file open operation.
125  * - CR Concurrent Read mode. When a client performs a path lookup, MDS grants
126  *   an inodebit lock with the CR mode on the intermediate path component.
127  * - NL Null mode.
128  *
129  * <PRE>
130  *       NL  CR  CW  PR  PW  EX
131  *  NL    1   1   1   1   1   1
132  *  CR    1   1   1   1   1   0
133  *  CW    1   1   1   0   0   0
134  *  PR    1   1   0   1   0   0
135  *  PW    1   1   0   0   0   0
136  *  EX    1   0   0   0   0   0
137  * </PRE>
138  */
139 /** @{ */
140 #define LCK_COMPAT_EX  LCK_NL
141 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
142 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
143 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
144 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
145 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
146 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
147 #define LCK_COMPAT_COS (LCK_COS)
148 /** @} Lock Compatibility Matrix */
149
150 extern enum ldlm_mode lck_compat_array[];
151
152 static inline void lockmode_verify(enum ldlm_mode mode)
153 {
154         LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
155 }
156
157 static inline int lockmode_compat(enum ldlm_mode exist_mode,
158                                   enum ldlm_mode new_mode)
159 {
160         return lck_compat_array[exist_mode] & new_mode;
161 }
162
163 /*
164  *
165  * cluster name spaces
166  *
167  */
168
169 #define DLM_OST_NAMESPACE 1
170 #define DLM_MDS_NAMESPACE 2
171
172 /* XXX
173    - do we just separate this by security domains and use a prefix for
174      multiple namespaces in the same domain?
175    -
176 */
177
178 /**
179  * Locking rules for LDLM:
180  *
181  * lr_lock
182  *
183  * lr_lock
184  *     waiting_locks_spinlock
185  *
186  * lr_lock
187  *     led_lock
188  *
189  * lr_lock
190  *     ns_lock
191  *
192  * lr_lvb_mutex
193  *     lr_lock
194  *
195  */
196
197 struct ldlm_pool;
198 struct ldlm_lock;
199 struct ldlm_resource;
200 struct ldlm_namespace;
201
202 /**
203  * Operations on LDLM pools.
204  * LDLM pool is a pool of locks in the namespace without any implicitly
205  * specified limits.
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
209  */
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);
216 };
217
218 /** One second for pools thread check interval. Each pool has own period. */
219 #define LDLM_POOLS_THREAD_PERIOD (1)
220
221 /** ~6% margin for modest pools. See ldlm_pool.c for details. */
222 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
223
224 /** Default recalc period for server side pools in sec. */
225 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
226
227 /** Default recalc period for client side pools in sec. */
228 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
229
230 /**
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.
234  */
235 struct ldlm_pool {
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. */
239         char                    pl_name[100];
240         /** Lock for protecting SLV/CLV updates. */
241         spinlock_t              pl_lock;
242         /** Number of allowed locks in in pool, both, client and server side. */
243         atomic_t                pl_limit;
244         /** Number of granted locks in */
245         atomic_t                pl_granted;
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. */
264         int                     pl_grant_plan;
265         /** Pool statistics. */
266         struct lprocfs_stats    *pl_stats;
267 };
268
269 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
270                                void *req_cookie, enum ldlm_mode mode,
271                                __u64 flags, void *data);
272
273 typedef int (*ldlm_cancel_cbt)(struct ldlm_lock *lock);
274
275 /**
276  * LVB operations.
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
279  * back.
280  *
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
284  *
285  * To ensure delayed LVB initialization, it is highly recommended to use the set
286  * of ldlm_[res_]lvbo_[init,update,fill]() functions.
287  */
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,
292                            int increase);
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);
298 };
299
300 /**
301  * LDLM pools related, type of lock pool in the namespace.
302  * Greedy means release cached locks aggressively
303  */
304 enum ldlm_appetite {
305         LDLM_NAMESPACE_GREEDY = 1 << 0,
306         LDLM_NAMESPACE_MODEST = 1 << 1
307 };
308
309 /**
310  * Default values for the "max_nolock_size", "contention_time" and
311  * "contended_locks" namespace tunables.
312  */
313 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
314 #define NS_DEFAULT_CONTENTION_SECONDS 2
315 #define NS_DEFAULT_CONTENDED_LOCKS 32
316
317 struct ldlm_ns_bucket {
318         /** back pointer to namespace */
319         struct ldlm_namespace      *nsb_namespace;
320         /**
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
324          */
325         struct adaptive_timeout     nsb_at_estimate;
326         /**
327          * Which res in the bucket should we start with the reclaim.
328          */
329         int                         nsb_reclaim_start;
330 };
331
332 enum {
333         /** LDLM namespace lock stats */
334         LDLM_NSS_LOCKS          = 0,
335         LDLM_NSS_LAST
336 };
337
338 enum ldlm_ns_type {
339         LDLM_NS_TYPE_UNKNOWN = 0,       /**< invalid type */
340         LDLM_NS_TYPE_MDC,               /**< MDC namespace */
341         LDLM_NS_TYPE_MDT,               /**< MDT namespace */
342         LDLM_NS_TYPE_OSC,               /**< OSC namespace */
343         LDLM_NS_TYPE_OST,               /**< OST namespace */
344         LDLM_NS_TYPE_MGC,               /**< MGC namespace */
345         LDLM_NS_TYPE_MGT,               /**< MGT namespace */
346 };
347
348 /**
349  * LDLM Namespace.
350  *
351  * Namespace serves to contain locks related to a particular service.
352  * There are two kinds of namespaces:
353  * - Server namespace has knowledge of all locks and is therefore authoritative
354  *   to make decisions like what locks could be granted and what conflicts
355  *   exist during new lock enqueue.
356  * - Client namespace only has limited knowledge about locks in the namespace,
357  *   only seeing locks held by the client.
358  *
359  * Every Lustre service has one server namespace present on the server serving
360  * that service. Every client connected to the service has a client namespace
361  * for it.
362  * Every lock obtained by client in that namespace is actually represented by
363  * two in-memory locks. One on the server and one on the client. The locks are
364  * linked by a special cookie by which one node can tell to the other which lock
365  * it actually means during communications. Such locks are called remote locks.
366  * The locks held by server only without any reference to a client are called
367  * local locks.
368  */
369 struct ldlm_namespace {
370         /** Backward link to OBD, required for LDLM pool to store new SLV. */
371         struct obd_device       *ns_obd;
372
373         /** Flag indicating if namespace is on client instead of server */
374         enum ldlm_side          ns_client;
375
376         /** Resource hash table for namespace. */
377         struct cfs_hash         *ns_rs_hash;
378
379         /** serialize */
380         spinlock_t              ns_lock;
381
382         /** big refcount (by bucket) */
383         atomic_t                ns_bref;
384
385         /**
386          * Namespace connect flags supported by server (may be changed via
387          * /proc, LRU resize may be disabled/enabled).
388          */
389         __u64                   ns_connect_flags;
390
391         /** Client side original connect flags supported by server. */
392         __u64                   ns_orig_connect_flags;
393
394         /* namespace proc dir entry */
395         struct proc_dir_entry   *ns_proc_dir_entry;
396
397         /**
398          * Position in global namespace list linking all namespaces on
399          * the node.
400          */
401         struct list_head        ns_list_chain;
402
403         /**
404          * List of unused locks for this namespace. This list is also called
405          * LRU lock list.
406          * Unused locks are locks with zero reader/writer reference counts.
407          * This list is only used on clients for lock caching purposes.
408          * When we want to release some locks voluntarily or if server wants
409          * us to release some locks due to e.g. memory pressure, we take locks
410          * to release from the head of this list.
411          * Locks are linked via l_lru field in \see struct ldlm_lock.
412          */
413         struct list_head        ns_unused_list;
414         /** Number of locks in the LRU list above */
415         int                     ns_nr_unused;
416
417         /**
418          * Maximum number of locks permitted in the LRU. If 0, means locks
419          * are managed by pools and there is no preset limit, rather it is all
420          * controlled by available memory on this client and on server.
421          */
422         unsigned int            ns_max_unused;
423         /** Maximum allowed age (last used time) for locks in the LRU */
424         unsigned int            ns_max_age;
425         /**
426          * Server only: number of times we evicted clients due to lack of reply
427          * to ASTs.
428          */
429         unsigned int            ns_timeouts;
430         /**
431          * Number of seconds since the file change time after which the
432          * MDT will return an UPDATE lock along with a LOOKUP lock.
433          * This allows the client to start caching negative dentries
434          * for a directory and may save an RPC for a later stat.
435          */
436         unsigned int            ns_ctime_age_limit;
437
438         /**
439          * Used to rate-limit ldlm_namespace_dump calls.
440          * \see ldlm_namespace_dump. Increased by 10 seconds every time
441          * it is called.
442          */
443         cfs_time_t              ns_next_dump;
444
445         /** "policy" function that does actual lock conflict determination */
446         ldlm_res_policy         ns_policy;
447
448         /**
449          * LVB operations for this namespace.
450          * \see struct ldlm_valblock_ops
451          */
452         struct ldlm_valblock_ops *ns_lvbo;
453
454         /**
455          * Used by filter code to store pointer to OBD of the service.
456          * Should be dropped in favor of \a ns_obd
457          */
458         void                    *ns_lvbp;
459
460         /**
461          * Wait queue used by __ldlm_namespace_free. Gets woken up every time
462          * a resource is removed.
463          */
464         wait_queue_head_t       ns_waitq;
465         /** LDLM pool structure for this namespace */
466         struct ldlm_pool        ns_pool;
467         /** Definition of how eagerly unused locks will be released from LRU */
468         enum ldlm_appetite      ns_appetite;
469
470         /**
471          * If more than \a ns_contended_locks are found, the resource is
472          * considered to be contended. Lock enqueues might specify that no
473          * contended locks should be granted
474          */
475         unsigned                ns_contended_locks;
476
477         /**
478          * The resources in this namespace remember contended state during
479          * \a ns_contention_time, in seconds.
480          */
481         unsigned                ns_contention_time;
482
483         /**
484          * Limit size of contended extent locks, in bytes.
485          * If extended lock is requested for more then this many bytes and
486          * caller instructs us not to grant contended locks, we would disregard
487          * such a request.
488          */
489         unsigned                ns_max_nolock_size;
490
491         /** Limit of parallel AST RPC count. */
492         unsigned                ns_max_parallel_ast;
493
494         /**
495          * Callback to check if a lock is good to be canceled by ELC or
496          * during recovery.
497          */
498         ldlm_cancel_cbt         ns_cancel;
499
500         /** LDLM lock stats */
501         struct lprocfs_stats    *ns_stats;
502
503         /**
504          * Flag to indicate namespace is being freed. Used to determine if
505          * recalculation of LDLM pool statistics should be skipped.
506          */
507         unsigned                ns_stopping:1;
508
509         /**
510          * Which bucket should we start with the lock reclaim.
511          */
512         int                     ns_reclaim_start;
513 };
514
515 /**
516  * Returns 1 if namespace \a ns is a client namespace.
517  */
518 static inline int ns_is_client(struct ldlm_namespace *ns)
519 {
520         LASSERT(ns != NULL);
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;
526 }
527
528 /**
529  * Returns 1 if namespace \a ns is a server namespace.
530  */
531 static inline int ns_is_server(struct ldlm_namespace *ns)
532 {
533         LASSERT(ns != NULL);
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;
539 }
540
541 /**
542  * Returns 1 if namespace \a ns supports early lock cancel (ELC).
543  */
544 static inline int ns_connect_cancelset(struct ldlm_namespace *ns)
545 {
546         LASSERT(ns != NULL);
547         return !!(ns->ns_connect_flags & OBD_CONNECT_CANCELSET);
548 }
549
550 /**
551  * Returns 1 if this namespace supports lru_resize.
552  */
553 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
554 {
555         LASSERT(ns != NULL);
556         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
557 }
558
559 static inline void ns_register_cancel(struct ldlm_namespace *ns,
560                                       ldlm_cancel_cbt arg)
561 {
562         LASSERT(ns != NULL);
563         ns->ns_cancel = arg;
564 }
565
566 struct ldlm_lock;
567
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,
571                                       int flag);
572 /** Type for completion callback function of a lock. */
573 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, __u64 flags,
574                                         void *data);
575 /** Type for glimpse callback function of a lock. */
576 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
577
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 */
585 };
586
587 /** The ldlm_glimpse_work is allocated on the stack and should not be freed. */
588 #define LDLM_GL_WORK_NOFREE 0x1
589
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 */
595 };
596 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
597
598 /**
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.
603  */
604 struct ldlm_interval_tree {
605         /** Tree size. */
606         int                     lit_size;
607         enum ldlm_mode          lit_mode;  /* lock mode */
608         struct interval_node    *lit_root; /* actual ldlm_interval */
609 };
610
611 /** Whether to track references to exports by LDLM locks. */
612 #define LUSTRE_TRACKS_LOCK_EXP_REFS (0)
613
614 /** Cancel flags. */
615 enum ldlm_cancel_flags {
616         LCF_ASYNC       = 0x1, /* Cancel locks asynchronously. */
617         LCF_LOCAL       = 0x2, /* Cancel locks locally, not notifing server */
618         LCF_BL_AST      = 0x4, /* Cancel LDLM_FL_BL_AST locks in the same RPC */
619 };
620
621 struct ldlm_flock {
622         __u64 start;
623         __u64 end;
624         __u64 owner;
625         __u64 blocking_owner;
626         struct obd_export *blocking_export;
627         atomic_t blocking_refs;
628         __u32 pid;
629 };
630
631 union ldlm_policy_data {
632         struct ldlm_extent l_extent;
633         struct ldlm_flock l_flock;
634         struct ldlm_inodebits l_inodebits;
635 };
636
637 void ldlm_convert_policy_to_wire(enum ldlm_type type,
638                                  const union ldlm_policy_data *lpolicy,
639                                  union ldlm_wire_policy_data *wpolicy);
640 void ldlm_convert_policy_to_local(struct obd_export *exp, enum ldlm_type type,
641                                   const union ldlm_wire_policy_data *wpolicy,
642                                   union ldlm_policy_data *lpolicy);
643
644 enum lvb_type {
645         LVB_T_NONE      = 0,
646         LVB_T_OST       = 1,
647         LVB_T_LQUOTA    = 2,
648         LVB_T_LAYOUT    = 3,
649 };
650
651 /**
652  * LDLM_GID_ANY is used to match any group id in ldlm_lock_match().
653  */
654 #define LDLM_GID_ANY  ((__u64)-1)
655
656 /**
657  * LDLM lock structure
658  *
659  * Represents a single LDLM lock and its state in memory. Each lock is
660  * associated with a single ldlm_resource, the object which is being
661  * locked. There may be multiple ldlm_locks on a single resource,
662  * depending on the lock type and whether the locks are conflicting or
663  * not.
664  */
665 struct ldlm_lock {
666         /**
667          * Local lock handle.
668          * When remote side wants to tell us about a lock, they address
669          * it by this opaque handle.  The handle does not hold a
670          * reference on the ldlm_lock, so it can be safely passed to
671          * other threads or nodes. When the lock needs to be accessed
672          * from the handle, it is looked up again in the lock table, and
673          * may no longer exist.
674          *
675          * Must be first in the structure.
676          */
677         struct portals_handle   l_handle;
678         /**
679          * Lock reference count.
680          * This is how many users have pointers to actual structure, so that
681          * we do not accidentally free lock structure that is in use.
682          */
683         atomic_t                l_refc;
684         /**
685          * Internal spinlock protects l_resource.  We should hold this lock
686          * first before taking res_lock.
687          */
688         spinlock_t              l_lock;
689         /**
690          * Pointer to actual resource this lock is in.
691          * ldlm_lock_change_resource() can change this.
692          */
693         struct ldlm_resource    *l_resource;
694         /**
695          * List item for client side LRU list.
696          * Protected by ns_lock in struct ldlm_namespace.
697          */
698         struct list_head        l_lru;
699         /**
700          * Linkage to resource's lock queues according to current lock state.
701          * (could be granted, waiting or converting)
702          * Protected by lr_lock in struct ldlm_resource.
703          */
704         struct list_head        l_res_link;
705         /**
706          * Tree node for ldlm_extent.
707          */
708         struct ldlm_interval    *l_tree_node;
709         /**
710          * Per export hash of locks.
711          * Protected by per-bucket exp->exp_lock_hash locks.
712          */
713         struct hlist_node       l_exp_hash;
714         /**
715          * Per export hash of flock locks.
716          * Protected by per-bucket exp->exp_flock_hash locks.
717          */
718         struct hlist_node       l_exp_flock_hash;
719         /**
720          * Requested mode.
721          * Protected by lr_lock.
722          */
723         enum ldlm_mode          l_req_mode;
724         /**
725          * Granted mode, also protected by lr_lock.
726          */
727         enum ldlm_mode          l_granted_mode;
728         /** Lock completion handler pointer. Called when lock is granted. */
729         ldlm_completion_callback l_completion_ast;
730         /**
731          * Lock blocking AST handler pointer.
732          * It plays two roles:
733          * - as a notification of an attempt to queue a conflicting lock (once)
734          * - as a notification when the lock is being cancelled.
735          *
736          * As such it's typically called twice: once for the initial conflict
737          * and then once more when the last user went away and the lock is
738          * cancelled (could happen recursively).
739          */
740         ldlm_blocking_callback  l_blocking_ast;
741         /**
742          * Lock glimpse handler.
743          * Glimpse handler is used to obtain LVB updates from a client by
744          * server
745          */
746         ldlm_glimpse_callback   l_glimpse_ast;
747
748         /**
749          * Lock export.
750          * This is a pointer to actual client export for locks that were granted
751          * to clients. Used server-side.
752          */
753         struct obd_export       *l_export;
754         /**
755          * Lock connection export.
756          * Pointer to server export on a client.
757          */
758         struct obd_export       *l_conn_export;
759
760         /**
761          * Remote lock handle.
762          * If the lock is remote, this is the handle of the other side lock
763          * (l_handle)
764          */
765         struct lustre_handle    l_remote_handle;
766
767         /**
768          * Representation of private data specific for a lock type.
769          * Examples are: extent range for extent lock or bitmask for ibits locks
770          */
771         union ldlm_policy_data  l_policy_data;
772
773         /**
774          * Lock state flags. Protected by lr_lock.
775          * \see lustre_dlm_flags.h where the bits are defined.
776          */
777         __u64                   l_flags;
778
779         /**
780          * Lock r/w usage counters.
781          * Protected by lr_lock.
782          */
783         __u32                   l_readers;
784         __u32                   l_writers;
785         /**
786          * If the lock is granted, a process sleeps on this waitq to learn when
787          * it's no longer in use.  If the lock is not granted, a process sleeps
788          * on this waitq to learn when it becomes granted.
789          */
790         wait_queue_head_t       l_waitq;
791
792         /**
793          * Seconds. It will be updated if there is any activity related to
794          * the lock, e.g. enqueue the lock or send blocking AST.
795          */
796         cfs_time_t              l_last_activity;
797
798         /**
799          * Time last used by e.g. being matched by lock match.
800          * Jiffies. Should be converted to time if needed.
801          */
802         cfs_time_t              l_last_used;
803
804         /** Originally requested extent for the extent lock. */
805         struct ldlm_extent      l_req_extent;
806
807         /*
808          * Client-side-only members.
809          */
810
811         enum lvb_type         l_lvb_type;
812
813         /**
814          * Temporary storage for a LVB received during an enqueue operation.
815          * May be vmalloc'd, so needs to be freed with OBD_FREE_LARGE().
816          */
817         __u32                   l_lvb_len;
818         void                    *l_lvb_data;
819
820         /** Private storage for lock user. Opaque to LDLM. */
821         void                    *l_ast_data;
822
823         /*
824          * Server-side-only members.
825          */
826
827         /**
828          * Connection cookie for the client originating the operation.
829          * Used by Commit on Share (COS) code. Currently only used for
830          * inodebits locks on MDS.
831          */
832         __u64                   l_client_cookie;
833
834         /**
835          * List item for locks waiting for cancellation from clients.
836          * The lists this could be linked into are:
837          * waiting_locks_list (protected by waiting_locks_spinlock),
838          * then if the lock timed out, it is moved to
839          * expired_lock_thread.elt_expired_locks for further processing.
840          * Protected by elt_lock.
841          */
842         struct list_head        l_pending_chain;
843
844         /**
845          * Set when lock is sent a blocking AST. Time in seconds when timeout
846          * is reached and client holding this lock could be evicted.
847          * This timeout could be further extended by e.g. certain IO activity
848          * under this lock.
849          * \see ost_rw_prolong_locks
850          */
851         cfs_time_t              l_callback_timeout;
852
853         /** Local PID of process which created this lock. */
854         __u32                   l_pid;
855
856         /**
857          * Number of times blocking AST was sent for this lock.
858          * This is for debugging. Valid values are 0 and 1, if there is an
859          * attempt to send blocking AST more than once, an assertion would be
860          * hit. \see ldlm_work_bl_ast_lock
861          */
862         int                     l_bl_ast_run;
863         /** List item ldlm_add_ast_work_item() for case of blocking ASTs. */
864         struct list_head        l_bl_ast;
865         /** List item ldlm_add_ast_work_item() for case of completion ASTs. */
866         struct list_head        l_cp_ast;
867         /** For ldlm_add_ast_work_item() for "revoke" AST used in COS. */
868         struct list_head        l_rk_ast;
869
870         /**
871          * Pointer to a conflicting lock that caused blocking AST to be sent
872          * for this lock
873          */
874         struct ldlm_lock        *l_blocking_lock;
875
876         /**
877          * Protected by lr_lock, linkages to "skip lists".
878          * For more explanations of skip lists see ldlm/ldlm_inodebits.c
879          */
880         struct list_head        l_sl_mode;
881         struct list_head        l_sl_policy;
882
883         /** Reference tracking structure to debug leaked locks. */
884         struct lu_ref           l_reference;
885 #if LUSTRE_TRACKS_LOCK_EXP_REFS
886         /* Debugging stuff for bug 20498, for tracking export references. */
887         /** number of export references taken */
888         int                     l_exp_refs_nr;
889         /** link all locks referencing one export */
890         struct list_head        l_exp_refs_link;
891         /** referenced export object */
892         struct obd_export       *l_exp_refs_target;
893 #endif
894         /**
895          * export blocking dlm lock list, protected by
896          * l_export->exp_bl_list_lock.
897          * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
898          * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock.
899          */
900         struct list_head        l_exp_list;
901 };
902
903 /** For uncommitted cross-MDT lock, store transno this lock belongs to */
904 #define l_transno l_client_cookie
905
906 /** For uncommitted cross-MDT lock, which is client lock, share with l_rk_ast
907  *  which is for server. */
908 #define l_slc_link l_rk_ast
909
910 /**
911  * LDLM resource description.
912  * Basically, resource is a representation for a single object.
913  * Object has a name which is currently 4 64-bit integers. LDLM user is
914  * responsible for creation of a mapping between objects it wants to be
915  * protected and resource names.
916  *
917  * A resource can only hold locks of a single lock type, though there may be
918  * multiple ldlm_locks on a single resource, depending on the lock type and
919  * whether the locks are conflicting or not.
920  */
921 struct ldlm_resource {
922         struct ldlm_ns_bucket   *lr_ns_bucket;
923
924         /**
925          * List item for list in namespace hash.
926          * protected by ns_lock
927          */
928         struct hlist_node       lr_hash;
929
930         /** Reference count for this resource */
931         atomic_t                lr_refcount;
932
933         /** Spinlock to protect locks under this resource. */
934         spinlock_t              lr_lock;
935
936         /**
937          * protected by lr_lock
938          * @{ */
939         /** List of locks in granted state */
940         struct list_head        lr_granted;
941         /** List of locks waiting to change their granted mode (converted) */
942         struct list_head        lr_converting;
943         /**
944          * List of locks that could not be granted due to conflicts and
945          * that are waiting for conflicts to go away */
946         struct list_head        lr_waiting;
947         /** @} */
948
949         /** Resource name */
950         struct ldlm_res_id      lr_name;
951
952         /**
953          * Interval trees (only for extent locks) for all modes of this resource
954          */
955         struct ldlm_interval_tree *lr_itree;
956
957         union {
958                 /**
959                  * When the resource was considered as contended,
960                  * used only on server side. */
961                 cfs_time_t      lr_contention_time;
962                 /**
963                  * Associated inode, used only on client side.
964                  */
965                 struct inode    *lr_lvb_inode;
966         };
967
968         /** Type of locks this resource can hold. Only one type per resource. */
969         enum ldlm_type          lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */
970
971         /**
972          * Server-side-only lock value block elements.
973          * To serialize lvbo_init.
974          */
975         int                     lr_lvb_len;
976         struct mutex            lr_lvb_mutex;
977         /** protected by lr_lock */
978         void                    *lr_lvb_data;
979         /** is lvb initialized ? */
980         bool                    lr_lvb_initialized;
981
982         /** List of references to this resource. For debugging. */
983         struct lu_ref           lr_reference;
984 };
985
986 static inline bool ldlm_has_layout(struct ldlm_lock *lock)
987 {
988         return lock->l_resource->lr_type == LDLM_IBITS &&
989                 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_LAYOUT;
990 }
991
992 static inline char *
993 ldlm_ns_name(struct ldlm_namespace *ns)
994 {
995         return ns->ns_rs_hash->hs_name;
996 }
997
998 static inline struct ldlm_namespace *
999 ldlm_res_to_ns(struct ldlm_resource *res)
1000 {
1001         return res->lr_ns_bucket->nsb_namespace;
1002 }
1003
1004 static inline struct ldlm_namespace *
1005 ldlm_lock_to_ns(struct ldlm_lock *lock)
1006 {
1007         return ldlm_res_to_ns(lock->l_resource);
1008 }
1009
1010 static inline char *
1011 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
1012 {
1013         return ldlm_ns_name(ldlm_lock_to_ns(lock));
1014 }
1015
1016 static inline struct adaptive_timeout *
1017 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
1018 {
1019         return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
1020 }
1021
1022 static inline int ldlm_lvbo_init(struct ldlm_resource *res)
1023 {
1024         struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1025         int rc = 0;
1026
1027         if (ns->ns_lvbo == NULL || ns->ns_lvbo->lvbo_init == NULL ||
1028             res->lr_lvb_initialized)
1029                 return 0;
1030
1031         mutex_lock(&res->lr_lvb_mutex);
1032         /* Did we lose the race? */
1033         if (res->lr_lvb_initialized) {
1034                 mutex_unlock(&res->lr_lvb_mutex);
1035                 return 0;
1036         }
1037         rc = ns->ns_lvbo->lvbo_init(res);
1038         if (rc < 0) {
1039                 CDEBUG(D_DLMTRACE, "lvbo_init failed for resource : rc = %d\n",
1040                        rc);
1041                 if (res->lr_lvb_data != NULL) {
1042                         OBD_FREE(res->lr_lvb_data, res->lr_lvb_len);
1043                         res->lr_lvb_data = NULL;
1044                 }
1045                 res->lr_lvb_len = rc;
1046         } else {
1047                 res->lr_lvb_initialized = true;
1048         }
1049         mutex_unlock(&res->lr_lvb_mutex);
1050         return rc;
1051 }
1052
1053 static inline int ldlm_lvbo_size(struct ldlm_lock *lock)
1054 {
1055         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1056
1057         if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_size != NULL)
1058                 return ns->ns_lvbo->lvbo_size(lock);
1059
1060         return 0;
1061 }
1062
1063 static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int len)
1064 {
1065         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1066         int rc;
1067
1068         if (ns->ns_lvbo != NULL) {
1069                 LASSERT(ns->ns_lvbo->lvbo_fill != NULL);
1070                 /* init lvb now if not already */
1071                 rc = ldlm_lvbo_init(lock->l_resource);
1072                 if (rc < 0) {
1073                         CERROR("lock %p: delayed lvb init failed (rc %d)",
1074                                lock, rc);
1075                         return rc;
1076                 }
1077                 return ns->ns_lvbo->lvbo_fill(lock, buf, len);
1078         }
1079         return 0;
1080 }
1081
1082 struct ldlm_ast_work {
1083         struct ldlm_lock       *w_lock;
1084         int                     w_blocking;
1085         struct ldlm_lock_desc   w_desc;
1086         struct list_head        w_list;
1087         int                     w_flags;
1088         void                   *w_data;
1089         int                     w_datalen;
1090 };
1091
1092 /**
1093  * Common ldlm_enqueue parameters
1094  */
1095 struct ldlm_enqueue_info {
1096         enum ldlm_type  ei_type;        /** Type of the lock being enqueued. */
1097         enum ldlm_mode  ei_mode;        /** Mode of the lock being enqueued. */
1098         void            *ei_cb_bl;      /** blocking lock callback */
1099         void            *ei_cb_local_bl; /** blocking local lock callback */
1100         void            *ei_cb_cp;      /** lock completion callback */
1101         void            *ei_cb_gl;      /** lock glimpse callback */
1102         void            *ei_cbdata;     /** Data to be passed into callbacks. */
1103         void            *ei_namespace;  /** lock namespace **/
1104         unsigned int    ei_enq_slave:1, /** whether enqueue slave stripes */
1105                         ei_nonblock:1;  /** non block enqueue */
1106 };
1107
1108 #define ei_res_id       ei_cb_gl
1109
1110 extern struct obd_ops ldlm_obd_ops;
1111
1112 extern char *ldlm_lockname[];
1113 extern char *ldlm_typename[];
1114 extern const char *ldlm_it2str(enum ldlm_intent_flags it);
1115
1116 /**
1117  * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG.
1118  * For the cases where we do not have actual lock to print along
1119  * with a debugging message that is ldlm-related
1120  */
1121 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
1122         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
1123
1124 /**
1125  * Support function for lock information printing into debug logs.
1126  * \see LDLM_DEBUG
1127  */
1128 #ifdef LIBCFS_DEBUG
1129 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do {      \
1130         CFS_CHECK_STACK(msgdata, mask, cdls);                           \
1131                                                                         \
1132         if (((mask) & D_CANTMASK) != 0 ||                               \
1133             ((libcfs_debug & (mask)) != 0 &&                            \
1134              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))          \
1135                 _ldlm_lock_debug(lock, msgdata, fmt, ##a);              \
1136 } while(0)
1137
1138 void _ldlm_lock_debug(struct ldlm_lock *lock,
1139                       struct libcfs_debug_msg_data *data,
1140                       const char *fmt, ...)
1141         __attribute__ ((format (printf, 3, 4)));
1142
1143 /**
1144  * Rate-limited version of lock printing function.
1145  */
1146 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do {                         \
1147         static struct cfs_debug_limit_state _ldlm_cdls;                      \
1148         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls);              \
1149         ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
1150 } while (0)
1151
1152 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
1153 #define LDLM_WARN(lock, fmt, a...)  LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
1154
1155 /** Non-rate-limited lock printing function for debugging purposes. */
1156 #define LDLM_DEBUG(lock, fmt, a...)   do {                                  \
1157         if (likely(lock != NULL)) {                                         \
1158                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL);      \
1159                 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock,           \
1160                                 "### " fmt , ##a);                          \
1161         } else {                                                            \
1162                 LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a);                \
1163         }                                                                   \
1164 } while (0)
1165 #else /* !LIBCFS_DEBUG */
1166 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
1167 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
1168 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
1169 #endif
1170
1171 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags,
1172                                       int first_enq, enum ldlm_error *err,
1173                                       struct list_head *work_list);
1174
1175 /**
1176  * Return values for lock iterators.
1177  * Also used during deciding of lock grants and cancellations.
1178  */
1179 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
1180 #define LDLM_ITER_STOP     2 /* stop iterating */
1181
1182 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
1183 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
1184
1185 /** \defgroup ldlm_iterator Lock iterators
1186  *
1187  * LDLM provides for a way to iterate through every lock on a resource or
1188  * namespace or every resource in a namespace.
1189  * @{ */
1190 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1191                           void *closure);
1192 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1193                             void *closure);
1194 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
1195                           ldlm_iterator_t iter, void *data);
1196 /** @} ldlm_iterator */
1197
1198 int ldlm_replay_locks(struct obd_import *imp);
1199
1200 /* ldlm_flock.c */
1201 int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1202
1203 /* ldlm_extent.c */
1204 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
1205
1206 struct ldlm_prolong_args {
1207         struct obd_export       *lpa_export;
1208         struct ldlm_res_id      lpa_resid;
1209         struct ldlm_extent      lpa_extent;
1210         enum ldlm_mode          lpa_mode;
1211         int                     lpa_timeout;
1212         int                     lpa_locks_cnt;
1213         int                     lpa_blocks_cnt;
1214 };
1215 void ldlm_lock_prolong_one(struct ldlm_lock *lock,
1216                            struct ldlm_prolong_args *arg);
1217 void ldlm_resource_prolong(struct ldlm_prolong_args *arg);
1218
1219 struct ldlm_callback_suite {
1220         ldlm_completion_callback lcs_completion;
1221         ldlm_blocking_callback   lcs_blocking;
1222         ldlm_glimpse_callback    lcs_glimpse;
1223 };
1224
1225 /* ldlm_lockd.c */
1226 #ifdef HAVE_SERVER_SUPPORT
1227 /** \defgroup ldlm_srv_ast Server AST handlers
1228  * These are AST handlers used by server code.
1229  * Their property is that they are just preparing RPCs to be sent to clients.
1230  * @{
1231  */
1232 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1233                              void *data, int flag);
1234 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1235 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
1236 int ldlm_glimpse_locks(struct ldlm_resource *res,
1237                        struct list_head *gl_work_list);
1238 /** @} ldlm_srv_ast */
1239
1240 /** \defgroup ldlm_handlers Server LDLM handlers
1241  * These are handler functions that should be called by "frontends" such as
1242  * MDT or OST to pass through LDLM requests to LDLM for handling
1243  * @{
1244  */
1245 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
1246                         ldlm_blocking_callback, ldlm_glimpse_callback);
1247 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1248                          const struct ldlm_request *dlm_req,
1249                          const struct ldlm_callback_suite *cbs);
1250 int ldlm_handle_convert(struct ptlrpc_request *req);
1251 int ldlm_handle_convert0(struct ptlrpc_request *req,
1252                          const struct ldlm_request *dlm_req);
1253 int ldlm_handle_cancel(struct ptlrpc_request *req);
1254 int ldlm_request_cancel(struct ptlrpc_request *req,
1255                         const struct ldlm_request *dlm_req,
1256                         int first, enum lustre_at_flags flags);
1257 /** @} ldlm_handlers */
1258
1259 void ldlm_revoke_export_locks(struct obd_export *exp);
1260 unsigned int ldlm_bl_timeout(struct ldlm_lock *lock);
1261 #endif
1262 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1263 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
1264 int ldlm_get_ref(void);
1265 void ldlm_put_ref(void);
1266 int ldlm_init_export(struct obd_export *exp);
1267 void ldlm_destroy_export(struct obd_export *exp);
1268 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req);
1269
1270 /* ldlm_lock.c */
1271 #ifdef HAVE_SERVER_SUPPORT
1272 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1273 #endif
1274 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1275 void ldlm_lock2handle(const struct ldlm_lock *lock,
1276                       struct lustre_handle *lockh);
1277 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags);
1278 void ldlm_cancel_callback(struct ldlm_lock *);
1279 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1280 int ldlm_lock_set_data(const struct lustre_handle *lockh, void *data);
1281
1282 /**
1283  * Obtain a lock reference by its handle.
1284  */
1285 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1286 {
1287         return __ldlm_handle2lock(h, 0);
1288 }
1289
1290 #define LDLM_LOCK_REF_DEL(lock) \
1291         lu_ref_del(&lock->l_reference, "handle", current)
1292
1293 static inline struct ldlm_lock *
1294 ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags)
1295 {
1296         struct ldlm_lock *lock;
1297
1298         lock = __ldlm_handle2lock(h, flags);
1299         if (lock != NULL)
1300                 LDLM_LOCK_REF_DEL(lock);
1301         return lock;
1302 }
1303
1304 /**
1305  * Update Lock Value Block Operations (LVBO) on a resource taking into account
1306  * data from request \a r
1307  */
1308 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1309                                        struct ptlrpc_request *req, int increase)
1310 {
1311         int rc;
1312
1313         /* delayed lvb init may be required */
1314         rc = ldlm_lvbo_init(res);
1315         if (rc < 0) {
1316                 CERROR("delayed lvb init failed (rc %d)\n", rc);
1317                 return rc;
1318         }
1319
1320         if (ldlm_res_to_ns(res)->ns_lvbo &&
1321             ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
1322                 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, req,
1323                                                                  increase);
1324         }
1325         return 0;
1326 }
1327
1328 int ldlm_error2errno(enum ldlm_error error);
1329 enum ldlm_error ldlm_errno2error(int err_no); /* don't call it `errno': this
1330                                                * confuses user-space. */
1331 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1332 void ldlm_dump_export_locks(struct obd_export *exp);
1333 #endif
1334
1335 /**
1336  * Release a temporary lock reference obtained by ldlm_handle2lock() or
1337  * __ldlm_handle2lock().
1338  */
1339 #define LDLM_LOCK_PUT(lock)                     \
1340 do {                                            \
1341         LDLM_LOCK_REF_DEL(lock);                \
1342         /*LDLM_DEBUG((lock), "put");*/          \
1343         ldlm_lock_put(lock);                    \
1344 } while (0)
1345
1346 /**
1347  * Release a lock reference obtained by some other means (see
1348  * LDLM_LOCK_PUT()).
1349  */
1350 #define LDLM_LOCK_RELEASE(lock)                 \
1351 do {                                            \
1352         /*LDLM_DEBUG((lock), "put");*/          \
1353         ldlm_lock_put(lock);                    \
1354 } while (0)
1355
1356 #define LDLM_LOCK_GET(lock)                     \
1357 ({                                              \
1358         ldlm_lock_get(lock);                    \
1359         /*LDLM_DEBUG((lock), "get");*/          \
1360         lock;                                   \
1361 })
1362
1363 #define ldlm_lock_list_put(head, member, count)                 \
1364 ({                                                              \
1365         struct ldlm_lock *_lock, *_next;                        \
1366         int c = count;                                          \
1367         list_for_each_entry_safe(_lock, _next, head, member) {  \
1368                 if (c-- == 0)                                   \
1369                         break;                                  \
1370                 list_del_init(&_lock->member);                  \
1371                 LDLM_LOCK_RELEASE(_lock);                       \
1372         }                                                       \
1373         LASSERT(c <= 0);                                        \
1374 })
1375
1376 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1377 void ldlm_lock_put(struct ldlm_lock *lock);
1378 void ldlm_lock_destroy(struct ldlm_lock *lock);
1379 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1380 void ldlm_lock_addref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1381 int  ldlm_lock_addref_try(const struct lustre_handle *lockh,
1382                           enum ldlm_mode mode);
1383 void ldlm_lock_decref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1384 void ldlm_lock_decref_and_cancel(const struct lustre_handle *lockh,
1385                                  enum ldlm_mode mode);
1386 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1387 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1388 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1389 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1390 enum ldlm_mode ldlm_lock_match(struct ldlm_namespace *ns, __u64 flags,
1391                                const struct ldlm_res_id *, enum ldlm_type type,
1392                                union ldlm_policy_data *, enum ldlm_mode mode,
1393                                struct lustre_handle *, int unref);
1394 enum ldlm_mode ldlm_revalidate_lock_handle(const struct lustre_handle *lockh,
1395                                            __u64 *bits);
1396 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock,
1397                                         enum ldlm_mode new_mode, __u32 *flags);
1398 void ldlm_lock_downgrade(struct ldlm_lock *lock, enum ldlm_mode new_mode);
1399 void ldlm_lock_cancel(struct ldlm_lock *lock);
1400 void ldlm_reprocess_all(struct ldlm_resource *res);
1401 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1402 void ldlm_lock_dump_handle(int level, const struct lustre_handle *lockh);
1403 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1404
1405 /* resource.c */
1406 struct ldlm_namespace *ldlm_namespace_new(struct obd_device *obd, char *name,
1407                                           enum ldlm_side client,
1408                                           enum ldlm_appetite apt,
1409                                           enum ldlm_ns_type ns_type);
1410 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags);
1411 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
1412                                struct obd_import *imp,
1413                                int force);
1414 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
1415 void ldlm_namespace_free(struct ldlm_namespace *ns,
1416                          struct obd_import *imp, int force);
1417 void ldlm_namespace_register(struct ldlm_namespace *ns, enum ldlm_side client);
1418 void ldlm_namespace_unregister(struct ldlm_namespace *ns,
1419                                enum ldlm_side client);
1420 void ldlm_namespace_get(struct ldlm_namespace *ns);
1421 void ldlm_namespace_put(struct ldlm_namespace *ns);
1422 int ldlm_proc_setup(void);
1423 #ifdef CONFIG_PROC_FS
1424 void ldlm_proc_cleanup(void);
1425 #else
1426 static inline void ldlm_proc_cleanup(void) {}
1427 #endif
1428
1429 /* resource.c - internal */
1430 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1431                                         struct ldlm_resource *parent,
1432                                         const struct ldlm_res_id *,
1433                                         enum ldlm_type type, int create);
1434 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1435 int ldlm_resource_putref(struct ldlm_resource *res);
1436 void ldlm_resource_add_lock(struct ldlm_resource *res,
1437                             struct list_head *head,
1438                             struct ldlm_lock *lock);
1439 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1440 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1441 void ldlm_dump_all_namespaces(enum ldlm_side client, int level);
1442 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1443 void ldlm_resource_dump(int level, struct ldlm_resource *);
1444 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1445                               const struct ldlm_res_id *);
1446
1447 #define LDLM_RESOURCE_ADDREF(res) do {                                  \
1448         lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, current);  \
1449 } while (0)
1450
1451 #define LDLM_RESOURCE_DELREF(res) do {                                  \
1452         lu_ref_del(&(res)->lr_reference, __FUNCTION__, current);  \
1453 } while (0)
1454
1455 /* ldlm_request.c */
1456 int ldlm_expired_completion_wait(void *data);
1457 /** \defgroup ldlm_local_ast Default AST handlers for local locks
1458  * These AST handlers are typically used for server-side local locks and are
1459  * also used by client-side lock handlers to perform minimum level base
1460  * processing.
1461  * @{ */
1462 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1463 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1464                       void *data, int flag);
1465 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1466 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data);
1467 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1468 /** @} ldlm_local_ast */
1469
1470 /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users.
1471  * These are typically used by client and server (*_local versions)
1472  * to obtain and release locks.
1473  * @{ */
1474 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1475                      struct ldlm_enqueue_info *einfo,
1476                      const struct ldlm_res_id *res_id,
1477                      union ldlm_policy_data const *policy, __u64 *flags,
1478                      void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
1479                      struct lustre_handle *lockh, int async);
1480 int ldlm_prep_enqueue_req(struct obd_export *exp,
1481                           struct ptlrpc_request *req,
1482                           struct list_head *cancels,
1483                           int count);
1484 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
1485                       int version, int opc, int canceloff,
1486                       struct list_head *cancels, int count);
1487
1488 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len);
1489 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1490                          const struct ldlm_request *dlm_req,
1491                          const struct ldlm_callback_suite *cbs);
1492 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1493                           enum ldlm_type type, __u8 with_policy,
1494                           enum ldlm_mode mode, __u64 *flags, void *lvb,
1495                           __u32 lvb_len,
1496                           const struct lustre_handle *lockh, int rc);
1497 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1498                            const struct ldlm_res_id *res_id,
1499                            enum ldlm_type type, union ldlm_policy_data *policy,
1500                            enum ldlm_mode mode, __u64 *flags,
1501                            ldlm_blocking_callback blocking,
1502                            ldlm_completion_callback completion,
1503                            ldlm_glimpse_callback glimpse,
1504                            void *data, __u32 lvb_len, enum lvb_type lvb_type,
1505                            const __u64 *client_cookie,
1506                            struct lustre_handle *lockh);
1507 int ldlm_cli_convert(const struct lustre_handle *lockh, int new_mode,
1508                      __u32 *flags);
1509 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1510 int ldlm_cli_cancel(const struct lustre_handle *lockh,
1511                     enum ldlm_cancel_flags cancel_flags);
1512 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1513                            enum ldlm_cancel_flags flags, void *opaque);
1514 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1515                                     const struct ldlm_res_id *res_id,
1516                                     union ldlm_policy_data *policy,
1517                                     enum ldlm_mode mode,
1518                                     enum ldlm_cancel_flags flags, void *opaque);
1519 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
1520                         int count, enum ldlm_cancel_flags flags);
1521 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1522                                struct list_head *cancels,
1523                                union ldlm_policy_data *policy,
1524                                enum ldlm_mode mode, __u64 lock_flags,
1525                                enum ldlm_cancel_flags cancel_flags,
1526                                void *opaque);
1527 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1528                                enum ldlm_cancel_flags flags);
1529 int ldlm_cli_cancel_list(struct list_head *head, int count,
1530                          struct ptlrpc_request *req,
1531                          enum ldlm_cancel_flags flags);
1532 /** @} ldlm_cli_api */
1533
1534 /* mds/handler.c */
1535 /* This has to be here because recursive inclusion sucks. */
1536 int intent_disposition(struct ldlm_reply *rep, int flag);
1537 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1538
1539 /**
1540  * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1541  * than one lock_res is dead-lock safe.
1542  */
1543 enum lock_res_type {
1544         LRT_NORMAL,
1545         LRT_NEW
1546 };
1547
1548 /** Lock resource. */
1549 static inline void lock_res(struct ldlm_resource *res)
1550 {
1551         spin_lock(&res->lr_lock);
1552 }
1553
1554 /** Lock resource with a way to instruct lockdep code about nestedness-safe. */
1555 static inline void lock_res_nested(struct ldlm_resource *res,
1556                                    enum lock_res_type mode)
1557 {
1558         spin_lock_nested(&res->lr_lock, mode);
1559 }
1560
1561 /** Unlock resource. */
1562 static inline void unlock_res(struct ldlm_resource *res)
1563 {
1564         spin_unlock(&res->lr_lock);
1565 }
1566
1567 /** Check if resource is already locked, assert if not. */
1568 static inline void check_res_locked(struct ldlm_resource *res)
1569 {
1570         assert_spin_locked(&res->lr_lock);
1571 }
1572
1573 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1574 void unlock_res_and_lock(struct ldlm_lock *lock);
1575
1576 /* ldlm_pool.c */
1577 /** \defgroup ldlm_pools Various LDLM pool related functions
1578  * There are not used outside of ldlm.
1579  * @{
1580  */
1581 int ldlm_pools_recalc(enum ldlm_side client);
1582 int ldlm_pools_init(void);
1583 void ldlm_pools_fini(void);
1584
1585 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1586                    int idx, enum ldlm_side client);
1587 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
1588 void ldlm_pool_fini(struct ldlm_pool *pl);
1589 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1590 int ldlm_pool_recalc(struct ldlm_pool *pl);
1591 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1592 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1593 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1594 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1595 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1596 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1597 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1598 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1599 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1600 /** @} */
1601
1602 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
1603                                       const struct ldlm_extent *ex2)
1604 {
1605         return ex1->start <= ex2->end && ex2->start <= ex1->end;
1606 }
1607
1608 /* check if @ex1 contains @ex2 */
1609 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
1610                                       const struct ldlm_extent *ex2)
1611 {
1612         return ex1->start <= ex2->start && ex1->end >= ex2->end;
1613 }
1614
1615 #endif
1616 /** @} LDLM */