Whamcloud - gitweb
6c6a0ec75e5c79ebb3c4c129e8ab046a1f36a310
[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         /* Protected by the hash lock */
628         __u32 blocking_refs;
629         __u32 pid;
630 };
631
632 union ldlm_policy_data {
633         struct ldlm_extent l_extent;
634         struct ldlm_flock l_flock;
635         struct ldlm_inodebits l_inodebits;
636 };
637
638 void ldlm_convert_policy_to_wire(enum ldlm_type type,
639                                  const union ldlm_policy_data *lpolicy,
640                                  union ldlm_wire_policy_data *wpolicy);
641 void ldlm_convert_policy_to_local(struct obd_export *exp, enum ldlm_type type,
642                                   const union ldlm_wire_policy_data *wpolicy,
643                                   union ldlm_policy_data *lpolicy);
644
645 enum lvb_type {
646         LVB_T_NONE      = 0,
647         LVB_T_OST       = 1,
648         LVB_T_LQUOTA    = 2,
649         LVB_T_LAYOUT    = 3,
650 };
651
652 /**
653  * LDLM_GID_ANY is used to match any group id in ldlm_lock_match().
654  */
655 #define LDLM_GID_ANY  ((__u64)-1)
656
657 /**
658  * LDLM lock structure
659  *
660  * Represents a single LDLM lock and its state in memory. Each lock is
661  * associated with a single ldlm_resource, the object which is being
662  * locked. There may be multiple ldlm_locks on a single resource,
663  * depending on the lock type and whether the locks are conflicting or
664  * not.
665  */
666 struct ldlm_lock {
667         /**
668          * Local lock handle.
669          * When remote side wants to tell us about a lock, they address
670          * it by this opaque handle.  The handle does not hold a
671          * reference on the ldlm_lock, so it can be safely passed to
672          * other threads or nodes. When the lock needs to be accessed
673          * from the handle, it is looked up again in the lock table, and
674          * may no longer exist.
675          *
676          * Must be first in the structure.
677          */
678         struct portals_handle   l_handle;
679         /**
680          * Lock reference count.
681          * This is how many users have pointers to actual structure, so that
682          * we do not accidentally free lock structure that is in use.
683          */
684         atomic_t                l_refc;
685         /**
686          * Internal spinlock protects l_resource.  We should hold this lock
687          * first before taking res_lock.
688          */
689         spinlock_t              l_lock;
690         /**
691          * Pointer to actual resource this lock is in.
692          * ldlm_lock_change_resource() can change this.
693          */
694         struct ldlm_resource    *l_resource;
695         /**
696          * List item for client side LRU list.
697          * Protected by ns_lock in struct ldlm_namespace.
698          */
699         struct list_head        l_lru;
700         /**
701          * Linkage to resource's lock queues according to current lock state.
702          * (could be granted, waiting or converting)
703          * Protected by lr_lock in struct ldlm_resource.
704          */
705         struct list_head        l_res_link;
706         /**
707          * Tree node for ldlm_extent.
708          */
709         struct ldlm_interval    *l_tree_node;
710         /**
711          * Per export hash of locks.
712          * Protected by per-bucket exp->exp_lock_hash locks.
713          */
714         struct hlist_node       l_exp_hash;
715         /**
716          * Per export hash of flock locks.
717          * Protected by per-bucket exp->exp_flock_hash locks.
718          */
719         struct hlist_node       l_exp_flock_hash;
720         /**
721          * Requested mode.
722          * Protected by lr_lock.
723          */
724         enum ldlm_mode          l_req_mode;
725         /**
726          * Granted mode, also protected by lr_lock.
727          */
728         enum ldlm_mode          l_granted_mode;
729         /** Lock completion handler pointer. Called when lock is granted. */
730         ldlm_completion_callback l_completion_ast;
731         /**
732          * Lock blocking AST handler pointer.
733          * It plays two roles:
734          * - as a notification of an attempt to queue a conflicting lock (once)
735          * - as a notification when the lock is being cancelled.
736          *
737          * As such it's typically called twice: once for the initial conflict
738          * and then once more when the last user went away and the lock is
739          * cancelled (could happen recursively).
740          */
741         ldlm_blocking_callback  l_blocking_ast;
742         /**
743          * Lock glimpse handler.
744          * Glimpse handler is used to obtain LVB updates from a client by
745          * server
746          */
747         ldlm_glimpse_callback   l_glimpse_ast;
748
749         /**
750          * Lock export.
751          * This is a pointer to actual client export for locks that were granted
752          * to clients. Used server-side.
753          */
754         struct obd_export       *l_export;
755         /**
756          * Lock connection export.
757          * Pointer to server export on a client.
758          */
759         struct obd_export       *l_conn_export;
760
761         /**
762          * Remote lock handle.
763          * If the lock is remote, this is the handle of the other side lock
764          * (l_handle)
765          */
766         struct lustre_handle    l_remote_handle;
767
768         /**
769          * Representation of private data specific for a lock type.
770          * Examples are: extent range for extent lock or bitmask for ibits locks
771          */
772         union ldlm_policy_data  l_policy_data;
773
774         /**
775          * Lock state flags. Protected by lr_lock.
776          * \see lustre_dlm_flags.h where the bits are defined.
777          */
778         __u64                   l_flags;
779
780         /**
781          * Lock r/w usage counters.
782          * Protected by lr_lock.
783          */
784         __u32                   l_readers;
785         __u32                   l_writers;
786         /**
787          * If the lock is granted, a process sleeps on this waitq to learn when
788          * it's no longer in use.  If the lock is not granted, a process sleeps
789          * on this waitq to learn when it becomes granted.
790          */
791         wait_queue_head_t       l_waitq;
792
793         /**
794          * Seconds. It will be updated if there is any activity related to
795          * the lock, e.g. enqueue the lock or send blocking AST.
796          */
797         cfs_time_t              l_last_activity;
798
799         /**
800          * Time last used by e.g. being matched by lock match.
801          * Jiffies. Should be converted to time if needed.
802          */
803         cfs_time_t              l_last_used;
804
805         /** Originally requested extent for the extent lock. */
806         struct ldlm_extent      l_req_extent;
807
808         /*
809          * Client-side-only members.
810          */
811
812         enum lvb_type         l_lvb_type;
813
814         /**
815          * Temporary storage for a LVB received during an enqueue operation.
816          * May be vmalloc'd, so needs to be freed with OBD_FREE_LARGE().
817          */
818         __u32                   l_lvb_len;
819         void                    *l_lvb_data;
820
821         /** Private storage for lock user. Opaque to LDLM. */
822         void                    *l_ast_data;
823
824         /*
825          * Server-side-only members.
826          */
827
828         /**
829          * Connection cookie for the client originating the operation.
830          * Used by Commit on Share (COS) code. Currently only used for
831          * inodebits locks on MDS.
832          */
833         __u64                   l_client_cookie;
834
835         /**
836          * List item for locks waiting for cancellation from clients.
837          * The lists this could be linked into are:
838          * waiting_locks_list (protected by waiting_locks_spinlock),
839          * then if the lock timed out, it is moved to
840          * expired_lock_thread.elt_expired_locks for further processing.
841          * Protected by elt_lock.
842          */
843         struct list_head        l_pending_chain;
844
845         /**
846          * Set when lock is sent a blocking AST. Time in seconds when timeout
847          * is reached and client holding this lock could be evicted.
848          * This timeout could be further extended by e.g. certain IO activity
849          * under this lock.
850          * \see ost_rw_prolong_locks
851          */
852         cfs_time_t              l_callback_timeout;
853
854         /** Local PID of process which created this lock. */
855         __u32                   l_pid;
856
857         /**
858          * Number of times blocking AST was sent for this lock.
859          * This is for debugging. Valid values are 0 and 1, if there is an
860          * attempt to send blocking AST more than once, an assertion would be
861          * hit. \see ldlm_work_bl_ast_lock
862          */
863         int                     l_bl_ast_run;
864         /** List item ldlm_add_ast_work_item() for case of blocking ASTs. */
865         struct list_head        l_bl_ast;
866         /** List item ldlm_add_ast_work_item() for case of completion ASTs. */
867         struct list_head        l_cp_ast;
868         /** For ldlm_add_ast_work_item() for "revoke" AST used in COS. */
869         struct list_head        l_rk_ast;
870
871         /**
872          * Pointer to a conflicting lock that caused blocking AST to be sent
873          * for this lock
874          */
875         struct ldlm_lock        *l_blocking_lock;
876
877         /**
878          * Protected by lr_lock, linkages to "skip lists".
879          * For more explanations of skip lists see ldlm/ldlm_inodebits.c
880          */
881         struct list_head        l_sl_mode;
882         struct list_head        l_sl_policy;
883
884         /** Reference tracking structure to debug leaked locks. */
885         struct lu_ref           l_reference;
886 #if LUSTRE_TRACKS_LOCK_EXP_REFS
887         /* Debugging stuff for bug 20498, for tracking export references. */
888         /** number of export references taken */
889         int                     l_exp_refs_nr;
890         /** link all locks referencing one export */
891         struct list_head        l_exp_refs_link;
892         /** referenced export object */
893         struct obd_export       *l_exp_refs_target;
894 #endif
895         /**
896          * export blocking dlm lock list, protected by
897          * l_export->exp_bl_list_lock.
898          * Lock order of waiting_lists_spinlock, exp_bl_list_lock and res lock
899          * is: res lock -> exp_bl_list_lock -> wanting_lists_spinlock.
900          */
901         struct list_head        l_exp_list;
902 };
903
904 /** For uncommitted cross-MDT lock, store transno this lock belongs to */
905 #define l_transno l_client_cookie
906
907 /** For uncommitted cross-MDT lock, which is client lock, share with l_rk_ast
908  *  which is for server. */
909 #define l_slc_link l_rk_ast
910
911 /**
912  * LDLM resource description.
913  * Basically, resource is a representation for a single object.
914  * Object has a name which is currently 4 64-bit integers. LDLM user is
915  * responsible for creation of a mapping between objects it wants to be
916  * protected and resource names.
917  *
918  * A resource can only hold locks of a single lock type, though there may be
919  * multiple ldlm_locks on a single resource, depending on the lock type and
920  * whether the locks are conflicting or not.
921  */
922 struct ldlm_resource {
923         struct ldlm_ns_bucket   *lr_ns_bucket;
924
925         /**
926          * List item for list in namespace hash.
927          * protected by ns_lock
928          */
929         struct hlist_node       lr_hash;
930
931         /** Reference count for this resource */
932         atomic_t                lr_refcount;
933
934         /** Spinlock to protect locks under this resource. */
935         spinlock_t              lr_lock;
936
937         /**
938          * protected by lr_lock
939          * @{ */
940         /** List of locks in granted state */
941         struct list_head        lr_granted;
942         /** List of locks waiting to change their granted mode (converted) */
943         struct list_head        lr_converting;
944         /**
945          * List of locks that could not be granted due to conflicts and
946          * that are waiting for conflicts to go away */
947         struct list_head        lr_waiting;
948         /** @} */
949
950         /** Resource name */
951         struct ldlm_res_id      lr_name;
952
953         /**
954          * Interval trees (only for extent locks) for all modes of this resource
955          */
956         struct ldlm_interval_tree *lr_itree;
957
958         union {
959                 /**
960                  * When the resource was considered as contended,
961                  * used only on server side. */
962                 cfs_time_t      lr_contention_time;
963                 /**
964                  * Associated inode, used only on client side.
965                  */
966                 struct inode    *lr_lvb_inode;
967         };
968
969         /** Type of locks this resource can hold. Only one type per resource. */
970         enum ldlm_type          lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */
971
972         /**
973          * Server-side-only lock value block elements.
974          * To serialize lvbo_init.
975          */
976         int                     lr_lvb_len;
977         struct mutex            lr_lvb_mutex;
978         /** protected by lr_lock */
979         void                    *lr_lvb_data;
980         /** is lvb initialized ? */
981         bool                    lr_lvb_initialized;
982
983         /** List of references to this resource. For debugging. */
984         struct lu_ref           lr_reference;
985 };
986
987 static inline bool ldlm_has_layout(struct ldlm_lock *lock)
988 {
989         return lock->l_resource->lr_type == LDLM_IBITS &&
990                 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_LAYOUT;
991 }
992
993 static inline char *
994 ldlm_ns_name(struct ldlm_namespace *ns)
995 {
996         return ns->ns_rs_hash->hs_name;
997 }
998
999 static inline struct ldlm_namespace *
1000 ldlm_res_to_ns(struct ldlm_resource *res)
1001 {
1002         return res->lr_ns_bucket->nsb_namespace;
1003 }
1004
1005 static inline struct ldlm_namespace *
1006 ldlm_lock_to_ns(struct ldlm_lock *lock)
1007 {
1008         return ldlm_res_to_ns(lock->l_resource);
1009 }
1010
1011 static inline char *
1012 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
1013 {
1014         return ldlm_ns_name(ldlm_lock_to_ns(lock));
1015 }
1016
1017 static inline struct adaptive_timeout *
1018 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
1019 {
1020         return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
1021 }
1022
1023 static inline int ldlm_lvbo_init(struct ldlm_resource *res)
1024 {
1025         struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1026         int rc = 0;
1027
1028         if (ns->ns_lvbo == NULL || ns->ns_lvbo->lvbo_init == NULL ||
1029             res->lr_lvb_initialized)
1030                 return 0;
1031
1032         mutex_lock(&res->lr_lvb_mutex);
1033         /* Did we lose the race? */
1034         if (res->lr_lvb_initialized) {
1035                 mutex_unlock(&res->lr_lvb_mutex);
1036                 return 0;
1037         }
1038         rc = ns->ns_lvbo->lvbo_init(res);
1039         if (rc < 0) {
1040                 CDEBUG(D_DLMTRACE, "lvbo_init failed for resource : rc = %d\n",
1041                        rc);
1042                 if (res->lr_lvb_data != NULL) {
1043                         OBD_FREE(res->lr_lvb_data, res->lr_lvb_len);
1044                         res->lr_lvb_data = NULL;
1045                 }
1046                 res->lr_lvb_len = rc;
1047         } else {
1048                 res->lr_lvb_initialized = true;
1049         }
1050         mutex_unlock(&res->lr_lvb_mutex);
1051         return rc;
1052 }
1053
1054 static inline int ldlm_lvbo_size(struct ldlm_lock *lock)
1055 {
1056         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1057
1058         if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_size != NULL)
1059                 return ns->ns_lvbo->lvbo_size(lock);
1060
1061         return 0;
1062 }
1063
1064 static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int len)
1065 {
1066         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1067         int rc;
1068
1069         if (ns->ns_lvbo != NULL) {
1070                 LASSERT(ns->ns_lvbo->lvbo_fill != NULL);
1071                 /* init lvb now if not already */
1072                 rc = ldlm_lvbo_init(lock->l_resource);
1073                 if (rc < 0) {
1074                         CERROR("lock %p: delayed lvb init failed (rc %d)",
1075                                lock, rc);
1076                         return rc;
1077                 }
1078                 return ns->ns_lvbo->lvbo_fill(lock, buf, len);
1079         }
1080         return 0;
1081 }
1082
1083 struct ldlm_ast_work {
1084         struct ldlm_lock       *w_lock;
1085         int                     w_blocking;
1086         struct ldlm_lock_desc   w_desc;
1087         struct list_head        w_list;
1088         int                     w_flags;
1089         void                   *w_data;
1090         int                     w_datalen;
1091 };
1092
1093 /**
1094  * Common ldlm_enqueue parameters
1095  */
1096 struct ldlm_enqueue_info {
1097         enum ldlm_type  ei_type;        /** Type of the lock being enqueued. */
1098         enum ldlm_mode  ei_mode;        /** Mode of the lock being enqueued. */
1099         void            *ei_cb_bl;      /** blocking lock callback */
1100         void            *ei_cb_local_bl; /** blocking local lock callback */
1101         void            *ei_cb_cp;      /** lock completion callback */
1102         void            *ei_cb_gl;      /** lock glimpse callback */
1103         void            *ei_cbdata;     /** Data to be passed into callbacks. */
1104         void            *ei_namespace;  /** lock namespace **/
1105         unsigned int    ei_enq_slave:1, /** whether enqueue slave stripes */
1106                         ei_nonblock:1;  /** non block enqueue */
1107 };
1108
1109 #define ei_res_id       ei_cb_gl
1110
1111 extern struct obd_ops ldlm_obd_ops;
1112
1113 extern char *ldlm_lockname[];
1114 extern char *ldlm_typename[];
1115 extern const char *ldlm_it2str(enum ldlm_intent_flags it);
1116
1117 /**
1118  * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG.
1119  * For the cases where we do not have actual lock to print along
1120  * with a debugging message that is ldlm-related
1121  */
1122 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
1123         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
1124
1125 /**
1126  * Support function for lock information printing into debug logs.
1127  * \see LDLM_DEBUG
1128  */
1129 #ifdef LIBCFS_DEBUG
1130 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do {      \
1131         CFS_CHECK_STACK(msgdata, mask, cdls);                           \
1132                                                                         \
1133         if (((mask) & D_CANTMASK) != 0 ||                               \
1134             ((libcfs_debug & (mask)) != 0 &&                            \
1135              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))          \
1136                 _ldlm_lock_debug(lock, msgdata, fmt, ##a);              \
1137 } while(0)
1138
1139 void _ldlm_lock_debug(struct ldlm_lock *lock,
1140                       struct libcfs_debug_msg_data *data,
1141                       const char *fmt, ...)
1142         __attribute__ ((format (printf, 3, 4)));
1143
1144 /**
1145  * Rate-limited version of lock printing function.
1146  */
1147 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do {                         \
1148         static struct cfs_debug_limit_state _ldlm_cdls;                      \
1149         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls);              \
1150         ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
1151 } while (0)
1152
1153 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
1154 #define LDLM_WARN(lock, fmt, a...)  LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
1155
1156 /** Non-rate-limited lock printing function for debugging purposes. */
1157 #define LDLM_DEBUG(lock, fmt, a...)   do {                                  \
1158         if (likely(lock != NULL)) {                                         \
1159                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL);      \
1160                 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock,           \
1161                                 "### " fmt , ##a);                          \
1162         } else {                                                            \
1163                 LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a);                \
1164         }                                                                   \
1165 } while (0)
1166 #else /* !LIBCFS_DEBUG */
1167 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
1168 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
1169 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
1170 #endif
1171
1172 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags,
1173                                       int first_enq, enum ldlm_error *err,
1174                                       struct list_head *work_list);
1175
1176 /**
1177  * Return values for lock iterators.
1178  * Also used during deciding of lock grants and cancellations.
1179  */
1180 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
1181 #define LDLM_ITER_STOP     2 /* stop iterating */
1182
1183 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
1184 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
1185
1186 /** \defgroup ldlm_iterator Lock iterators
1187  *
1188  * LDLM provides for a way to iterate through every lock on a resource or
1189  * namespace or every resource in a namespace.
1190  * @{ */
1191 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1192                           void *closure);
1193 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1194                             void *closure);
1195 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
1196                           ldlm_iterator_t iter, void *data);
1197 /** @} ldlm_iterator */
1198
1199 int ldlm_replay_locks(struct obd_import *imp);
1200
1201 /* ldlm_flock.c */
1202 int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1203
1204 /* ldlm_extent.c */
1205 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
1206
1207 struct ldlm_prolong_args {
1208         struct obd_export       *lpa_export;
1209         struct ldlm_res_id      lpa_resid;
1210         struct ldlm_extent      lpa_extent;
1211         enum ldlm_mode          lpa_mode;
1212         int                     lpa_timeout;
1213         int                     lpa_locks_cnt;
1214         int                     lpa_blocks_cnt;
1215 };
1216 void ldlm_lock_prolong_one(struct ldlm_lock *lock,
1217                            struct ldlm_prolong_args *arg);
1218 void ldlm_resource_prolong(struct ldlm_prolong_args *arg);
1219
1220 struct ldlm_callback_suite {
1221         ldlm_completion_callback lcs_completion;
1222         ldlm_blocking_callback   lcs_blocking;
1223         ldlm_glimpse_callback    lcs_glimpse;
1224 };
1225
1226 /* ldlm_lockd.c */
1227 #ifdef HAVE_SERVER_SUPPORT
1228 /** \defgroup ldlm_srv_ast Server AST handlers
1229  * These are AST handlers used by server code.
1230  * Their property is that they are just preparing RPCs to be sent to clients.
1231  * @{
1232  */
1233 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1234                              void *data, int flag);
1235 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1236 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
1237 int ldlm_glimpse_locks(struct ldlm_resource *res,
1238                        struct list_head *gl_work_list);
1239 /** @} ldlm_srv_ast */
1240
1241 /** \defgroup ldlm_handlers Server LDLM handlers
1242  * These are handler functions that should be called by "frontends" such as
1243  * MDT or OST to pass through LDLM requests to LDLM for handling
1244  * @{
1245  */
1246 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
1247                         ldlm_blocking_callback, ldlm_glimpse_callback);
1248 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1249                          const struct ldlm_request *dlm_req,
1250                          const struct ldlm_callback_suite *cbs);
1251 int ldlm_handle_convert(struct ptlrpc_request *req);
1252 int ldlm_handle_convert0(struct ptlrpc_request *req,
1253                          const struct ldlm_request *dlm_req);
1254 int ldlm_handle_cancel(struct ptlrpc_request *req);
1255 int ldlm_request_cancel(struct ptlrpc_request *req,
1256                         const struct ldlm_request *dlm_req,
1257                         int first, enum lustre_at_flags flags);
1258 /** @} ldlm_handlers */
1259
1260 void ldlm_revoke_export_locks(struct obd_export *exp);
1261 unsigned int ldlm_bl_timeout(struct ldlm_lock *lock);
1262 #endif
1263 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1264 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
1265 int ldlm_get_ref(void);
1266 void ldlm_put_ref(void);
1267 int ldlm_init_export(struct obd_export *exp);
1268 void ldlm_destroy_export(struct obd_export *exp);
1269 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req);
1270
1271 /* ldlm_lock.c */
1272 #ifdef HAVE_SERVER_SUPPORT
1273 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1274 #endif
1275 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1276 void ldlm_lock2handle(const struct ldlm_lock *lock,
1277                       struct lustre_handle *lockh);
1278 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags);
1279 void ldlm_cancel_callback(struct ldlm_lock *);
1280 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1281 int ldlm_lock_set_data(const struct lustre_handle *lockh, void *data);
1282
1283 /**
1284  * Obtain a lock reference by its handle.
1285  */
1286 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1287 {
1288         return __ldlm_handle2lock(h, 0);
1289 }
1290
1291 #define LDLM_LOCK_REF_DEL(lock) \
1292         lu_ref_del(&lock->l_reference, "handle", current)
1293
1294 static inline struct ldlm_lock *
1295 ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags)
1296 {
1297         struct ldlm_lock *lock;
1298
1299         lock = __ldlm_handle2lock(h, flags);
1300         if (lock != NULL)
1301                 LDLM_LOCK_REF_DEL(lock);
1302         return lock;
1303 }
1304
1305 /**
1306  * Update Lock Value Block Operations (LVBO) on a resource taking into account
1307  * data from request \a r
1308  */
1309 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1310                                        struct ptlrpc_request *req, int increase)
1311 {
1312         int rc;
1313
1314         /* delayed lvb init may be required */
1315         rc = ldlm_lvbo_init(res);
1316         if (rc < 0) {
1317                 CERROR("delayed lvb init failed (rc %d)\n", rc);
1318                 return rc;
1319         }
1320
1321         if (ldlm_res_to_ns(res)->ns_lvbo &&
1322             ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
1323                 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, req,
1324                                                                  increase);
1325         }
1326         return 0;
1327 }
1328
1329 int ldlm_error2errno(enum ldlm_error error);
1330 enum ldlm_error ldlm_errno2error(int err_no); /* don't call it `errno': this
1331                                                * confuses user-space. */
1332 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1333 void ldlm_dump_export_locks(struct obd_export *exp);
1334 #endif
1335
1336 /**
1337  * Release a temporary lock reference obtained by ldlm_handle2lock() or
1338  * __ldlm_handle2lock().
1339  */
1340 #define LDLM_LOCK_PUT(lock)                     \
1341 do {                                            \
1342         LDLM_LOCK_REF_DEL(lock);                \
1343         /*LDLM_DEBUG((lock), "put");*/          \
1344         ldlm_lock_put(lock);                    \
1345 } while (0)
1346
1347 /**
1348  * Release a lock reference obtained by some other means (see
1349  * LDLM_LOCK_PUT()).
1350  */
1351 #define LDLM_LOCK_RELEASE(lock)                 \
1352 do {                                            \
1353         /*LDLM_DEBUG((lock), "put");*/          \
1354         ldlm_lock_put(lock);                    \
1355 } while (0)
1356
1357 #define LDLM_LOCK_GET(lock)                     \
1358 ({                                              \
1359         ldlm_lock_get(lock);                    \
1360         /*LDLM_DEBUG((lock), "get");*/          \
1361         lock;                                   \
1362 })
1363
1364 #define ldlm_lock_list_put(head, member, count)                 \
1365 ({                                                              \
1366         struct ldlm_lock *_lock, *_next;                        \
1367         int c = count;                                          \
1368         list_for_each_entry_safe(_lock, _next, head, member) {  \
1369                 if (c-- == 0)                                   \
1370                         break;                                  \
1371                 list_del_init(&_lock->member);                  \
1372                 LDLM_LOCK_RELEASE(_lock);                       \
1373         }                                                       \
1374         LASSERT(c <= 0);                                        \
1375 })
1376
1377 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1378 void ldlm_lock_put(struct ldlm_lock *lock);
1379 void ldlm_lock_destroy(struct ldlm_lock *lock);
1380 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1381 void ldlm_lock_addref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1382 int  ldlm_lock_addref_try(const struct lustre_handle *lockh,
1383                           enum ldlm_mode mode);
1384 void ldlm_lock_decref(const struct lustre_handle *lockh, enum ldlm_mode mode);
1385 void ldlm_lock_decref_and_cancel(const struct lustre_handle *lockh,
1386                                  enum ldlm_mode mode);
1387 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1388 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1389 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1390 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1391 enum ldlm_mode ldlm_lock_match(struct ldlm_namespace *ns, __u64 flags,
1392                                const struct ldlm_res_id *, enum ldlm_type type,
1393                                union ldlm_policy_data *, enum ldlm_mode mode,
1394                                struct lustre_handle *, int unref);
1395 enum ldlm_mode ldlm_revalidate_lock_handle(const struct lustre_handle *lockh,
1396                                            __u64 *bits);
1397 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock,
1398                                         enum ldlm_mode new_mode, __u32 *flags);
1399 void ldlm_lock_downgrade(struct ldlm_lock *lock, enum ldlm_mode new_mode);
1400 void ldlm_lock_cancel(struct ldlm_lock *lock);
1401 void ldlm_reprocess_all(struct ldlm_resource *res);
1402 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1403 void ldlm_lock_dump_handle(int level, const struct lustre_handle *lockh);
1404 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1405
1406 /* resource.c */
1407 struct ldlm_namespace *ldlm_namespace_new(struct obd_device *obd, char *name,
1408                                           enum ldlm_side client,
1409                                           enum ldlm_appetite apt,
1410                                           enum ldlm_ns_type ns_type);
1411 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags);
1412 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
1413                                struct obd_import *imp,
1414                                int force);
1415 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
1416 void ldlm_namespace_free(struct ldlm_namespace *ns,
1417                          struct obd_import *imp, int force);
1418 void ldlm_namespace_register(struct ldlm_namespace *ns, enum ldlm_side client);
1419 void ldlm_namespace_unregister(struct ldlm_namespace *ns,
1420                                enum ldlm_side client);
1421 void ldlm_namespace_get(struct ldlm_namespace *ns);
1422 void ldlm_namespace_put(struct ldlm_namespace *ns);
1423 int ldlm_proc_setup(void);
1424 #ifdef CONFIG_PROC_FS
1425 void ldlm_proc_cleanup(void);
1426 #else
1427 static inline void ldlm_proc_cleanup(void) {}
1428 #endif
1429
1430 /* resource.c - internal */
1431 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1432                                         struct ldlm_resource *parent,
1433                                         const struct ldlm_res_id *,
1434                                         enum ldlm_type type, int create);
1435 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1436 int ldlm_resource_putref(struct ldlm_resource *res);
1437 void ldlm_resource_add_lock(struct ldlm_resource *res,
1438                             struct list_head *head,
1439                             struct ldlm_lock *lock);
1440 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1441 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1442 void ldlm_dump_all_namespaces(enum ldlm_side client, int level);
1443 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1444 void ldlm_resource_dump(int level, struct ldlm_resource *);
1445 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1446                               const struct ldlm_res_id *);
1447
1448 #define LDLM_RESOURCE_ADDREF(res) do {                                  \
1449         lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, current);  \
1450 } while (0)
1451
1452 #define LDLM_RESOURCE_DELREF(res) do {                                  \
1453         lu_ref_del(&(res)->lr_reference, __FUNCTION__, current);  \
1454 } while (0)
1455
1456 /* ldlm_request.c */
1457 int ldlm_expired_completion_wait(void *data);
1458 /** \defgroup ldlm_local_ast Default AST handlers for local locks
1459  * These AST handlers are typically used for server-side local locks and are
1460  * also used by client-side lock handlers to perform minimum level base
1461  * processing.
1462  * @{ */
1463 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1464 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1465                       void *data, int flag);
1466 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1467 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data);
1468 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1469 /** @} ldlm_local_ast */
1470
1471 /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users.
1472  * These are typically used by client and server (*_local versions)
1473  * to obtain and release locks.
1474  * @{ */
1475 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1476                      struct ldlm_enqueue_info *einfo,
1477                      const struct ldlm_res_id *res_id,
1478                      union ldlm_policy_data const *policy, __u64 *flags,
1479                      void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
1480                      struct lustre_handle *lockh, int async);
1481 int ldlm_prep_enqueue_req(struct obd_export *exp,
1482                           struct ptlrpc_request *req,
1483                           struct list_head *cancels,
1484                           int count);
1485 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
1486                       int version, int opc, int canceloff,
1487                       struct list_head *cancels, int count);
1488
1489 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len);
1490 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1491                          const struct ldlm_request *dlm_req,
1492                          const struct ldlm_callback_suite *cbs);
1493 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1494                           enum ldlm_type type, __u8 with_policy,
1495                           enum ldlm_mode mode, __u64 *flags, void *lvb,
1496                           __u32 lvb_len,
1497                           const struct lustre_handle *lockh, int rc);
1498 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1499                            const struct ldlm_res_id *res_id,
1500                            enum ldlm_type type, union ldlm_policy_data *policy,
1501                            enum ldlm_mode mode, __u64 *flags,
1502                            ldlm_blocking_callback blocking,
1503                            ldlm_completion_callback completion,
1504                            ldlm_glimpse_callback glimpse,
1505                            void *data, __u32 lvb_len, enum lvb_type lvb_type,
1506                            const __u64 *client_cookie,
1507                            struct lustre_handle *lockh);
1508 int ldlm_cli_convert(const struct lustre_handle *lockh, int new_mode,
1509                      __u32 *flags);
1510 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1511 int ldlm_cli_cancel(const struct lustre_handle *lockh,
1512                     enum ldlm_cancel_flags cancel_flags);
1513 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1514                            enum ldlm_cancel_flags flags, void *opaque);
1515 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1516                                     const struct ldlm_res_id *res_id,
1517                                     union ldlm_policy_data *policy,
1518                                     enum ldlm_mode mode,
1519                                     enum ldlm_cancel_flags flags, void *opaque);
1520 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
1521                         int count, enum ldlm_cancel_flags flags);
1522 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1523                                struct list_head *cancels,
1524                                union ldlm_policy_data *policy,
1525                                enum ldlm_mode mode, __u64 lock_flags,
1526                                enum ldlm_cancel_flags cancel_flags,
1527                                void *opaque);
1528 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1529                                enum ldlm_cancel_flags flags);
1530 int ldlm_cli_cancel_list(struct list_head *head, int count,
1531                          struct ptlrpc_request *req,
1532                          enum ldlm_cancel_flags flags);
1533 /** @} ldlm_cli_api */
1534
1535 /* mds/handler.c */
1536 /* This has to be here because recursive inclusion sucks. */
1537 int intent_disposition(struct ldlm_reply *rep, int flag);
1538 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1539
1540 /**
1541  * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1542  * than one lock_res is dead-lock safe.
1543  */
1544 enum lock_res_type {
1545         LRT_NORMAL,
1546         LRT_NEW
1547 };
1548
1549 /** Lock resource. */
1550 static inline void lock_res(struct ldlm_resource *res)
1551 {
1552         spin_lock(&res->lr_lock);
1553 }
1554
1555 /** Lock resource with a way to instruct lockdep code about nestedness-safe. */
1556 static inline void lock_res_nested(struct ldlm_resource *res,
1557                                    enum lock_res_type mode)
1558 {
1559         spin_lock_nested(&res->lr_lock, mode);
1560 }
1561
1562 /** Unlock resource. */
1563 static inline void unlock_res(struct ldlm_resource *res)
1564 {
1565         spin_unlock(&res->lr_lock);
1566 }
1567
1568 /** Check if resource is already locked, assert if not. */
1569 static inline void check_res_locked(struct ldlm_resource *res)
1570 {
1571         assert_spin_locked(&res->lr_lock);
1572 }
1573
1574 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1575 void unlock_res_and_lock(struct ldlm_lock *lock);
1576
1577 /* ldlm_pool.c */
1578 /** \defgroup ldlm_pools Various LDLM pool related functions
1579  * There are not used outside of ldlm.
1580  * @{
1581  */
1582 int ldlm_pools_recalc(enum ldlm_side client);
1583 int ldlm_pools_init(void);
1584 void ldlm_pools_fini(void);
1585
1586 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1587                    int idx, enum ldlm_side client);
1588 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
1589 void ldlm_pool_fini(struct ldlm_pool *pl);
1590 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1591 int ldlm_pool_recalc(struct ldlm_pool *pl);
1592 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1593 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1594 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1595 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1596 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1597 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1598 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1599 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1600 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1601 /** @} */
1602
1603 static inline int ldlm_extent_overlap(const struct ldlm_extent *ex1,
1604                                       const struct ldlm_extent *ex2)
1605 {
1606         return ex1->start <= ex2->end && ex2->start <= ex1->end;
1607 }
1608
1609 /* check if @ex1 contains @ex2 */
1610 static inline int ldlm_extent_contain(const struct ldlm_extent *ex1,
1611                                       const struct ldlm_extent *ex2)
1612 {
1613         return ex1->start <= ex2->start && ex1->end >= ex2->end;
1614 }
1615
1616 #endif
1617 /** @} LDLM */