Whamcloud - gitweb
1935e2fd265649a025231a6d512e95bdae034032
[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, 2014, 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(36000))
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 typedef enum {
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 } ldlm_error_t;
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 typedef enum {
95         LDLM_NAMESPACE_SERVER = 1 << 0,
96         LDLM_NAMESPACE_CLIENT = 1 << 1
97 } ldlm_side_t;
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 ldlm_mode_t lck_compat_array[];
151
152 static inline void lockmode_verify(ldlm_mode_t mode)
153 {
154        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
155 }
156
157 static inline int lockmode_compat(ldlm_mode_t exist_mode, ldlm_mode_t new_mode)
158 {
159        return (lck_compat_array[exist_mode] & new_mode);
160 }
161
162 /*
163  *
164  * cluster name spaces
165  *
166  */
167
168 #define DLM_OST_NAMESPACE 1
169 #define DLM_MDS_NAMESPACE 2
170
171 /* XXX
172    - do we just separate this by security domains and use a prefix for
173      multiple namespaces in the same domain?
174    -
175 */
176
177 /**
178  * Locking rules for LDLM:
179  *
180  * lr_lock
181  *
182  * lr_lock
183  *     waiting_locks_spinlock
184  *
185  * lr_lock
186  *     led_lock
187  *
188  * lr_lock
189  *     ns_lock
190  *
191  * lr_lvb_mutex
192  *     lr_lock
193  *
194  */
195
196 struct ldlm_pool;
197 struct ldlm_lock;
198 struct ldlm_resource;
199 struct ldlm_namespace;
200
201 /**
202  * Operations on LDLM pools.
203  * LDLM pool is a pool of locks in the namespace without any implicitly
204  * specified limits.
205  * Locks in the pool are organized in LRU.
206  * Local memory pressure or server instructions (e.g. mempressure on server)
207  * can trigger freeing of locks from the pool
208  */
209 struct ldlm_pool_ops {
210         /** Recalculate pool \a pl usage */
211         int (*po_recalc)(struct ldlm_pool *pl);
212         /** Cancel at least \a nr locks from pool \a pl */
213         int (*po_shrink)(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
214         int (*po_setup)(struct ldlm_pool *pl, int limit);
215 };
216
217 /** One second for pools thread check interval. Each pool has own period. */
218 #define LDLM_POOLS_THREAD_PERIOD (1)
219
220 /** ~6% margin for modest pools. See ldlm_pool.c for details. */
221 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
222
223 /** Default recalc period for server side pools in sec. */
224 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
225
226 /** Default recalc period for client side pools in sec. */
227 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
228
229 /**
230  * LDLM pool structure to track granted locks.
231  * For purposes of determining when to release locks on e.g. memory pressure.
232  * This feature is commonly referred to as lru_resize.
233  */
234 struct ldlm_pool {
235         /** Pool proc directory. */
236         struct proc_dir_entry   *pl_proc_dir;
237         /** Pool name, must be long enough to hold compound proc entry name. */
238         char                    pl_name[100];
239         /** Lock for protecting SLV/CLV updates. */
240         spinlock_t              pl_lock;
241         /** Number of allowed locks in in pool, both, client and server side. */
242         atomic_t                pl_limit;
243         /** Number of granted locks in */
244         atomic_t                pl_granted;
245         /** Grant rate per T. */
246         atomic_t                pl_grant_rate;
247         /** Cancel rate per T. */
248         atomic_t                pl_cancel_rate;
249         /** Server lock volume (SLV). Protected by pl_lock. */
250         __u64                   pl_server_lock_volume;
251         /** Current biggest client lock volume. Protected by pl_lock. */
252         __u64                   pl_client_lock_volume;
253         /** Lock volume factor. SLV on client is calculated as following:
254          *  server_slv * lock_volume_factor. */
255         atomic_t                pl_lock_volume_factor;
256         /** Time when last SLV from server was obtained. */
257         time_t                  pl_recalc_time;
258         /** Recalculation period for pool. */
259         time_t                  pl_recalc_period;
260         /** Recalculation and shrink operations. */
261         struct ldlm_pool_ops    *pl_ops;
262         /** Number of planned locks for next period. */
263         int                     pl_grant_plan;
264         /** Pool statistics. */
265         struct lprocfs_stats    *pl_stats;
266 };
267
268 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
269                                void *req_cookie, ldlm_mode_t mode, __u64 flags,
270                                void *data);
271
272 typedef int (*ldlm_cancel_cbt)(struct ldlm_lock *lock);
273
274 /**
275  * LVB operations.
276  * LVB is Lock Value Block. This is a special opaque (to LDLM) value that could
277  * be associated with an LDLM lock and transferred from client to server and
278  * back.
279  *
280  * Currently LVBs are used by:
281  *  - OSC-OST code to maintain current object size/times
282  *  - layout lock code to return the layout when the layout lock is granted
283  *
284  * To ensure delayed LVB initialization, it is highly recommended to use the set
285  * of ldlm_[res_]lvbo_[init,update,fill]() functions.
286  */
287 struct ldlm_valblock_ops {
288         int (*lvbo_init)(struct ldlm_resource *res);
289         int (*lvbo_update)(struct ldlm_resource *res,
290                            struct ptlrpc_request *r,
291                            int increase);
292         int (*lvbo_free)(struct ldlm_resource *res);
293         /* Return size of lvb data appropriate RPC size can be reserved */
294         int (*lvbo_size)(struct ldlm_lock *lock);
295         /* Called to fill in lvb data to RPC buffer @buf */
296         int (*lvbo_fill)(struct ldlm_lock *lock, void *buf, int buflen);
297 };
298
299 /**
300  * LDLM pools related, type of lock pool in the namespace.
301  * Greedy means release cached locks aggressively
302  */
303 typedef enum {
304         LDLM_NAMESPACE_GREEDY = 1 << 0,
305         LDLM_NAMESPACE_MODEST = 1 << 1
306 } ldlm_appetite_t;
307
308 /**
309  * Default values for the "max_nolock_size", "contention_time" and
310  * "contended_locks" namespace tunables.
311  */
312 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
313 #define NS_DEFAULT_CONTENTION_SECONDS 2
314 #define NS_DEFAULT_CONTENDED_LOCKS 32
315
316 struct ldlm_ns_bucket {
317         /** back pointer to namespace */
318         struct ldlm_namespace      *nsb_namespace;
319         /**
320          * Estimated lock callback time.  Used by adaptive timeout code to
321          * avoid spurious client evictions due to unresponsiveness when in
322          * fact the network or overall system load is at fault
323          */
324         struct adaptive_timeout     nsb_at_estimate;
325 };
326
327 enum {
328         /** LDLM namespace lock stats */
329         LDLM_NSS_LOCKS          = 0,
330         LDLM_NSS_LAST
331 };
332
333 typedef enum {
334         /** invalide type */
335         LDLM_NS_TYPE_UNKNOWN    = 0,
336         /** mdc namespace */
337         LDLM_NS_TYPE_MDC,
338         /** mds namespace */
339         LDLM_NS_TYPE_MDT,
340         /** osc namespace */
341         LDLM_NS_TYPE_OSC,
342         /** ost namespace */
343         LDLM_NS_TYPE_OST,
344         /** mgc namespace */
345         LDLM_NS_TYPE_MGC,
346         /** mgs namespace */
347         LDLM_NS_TYPE_MGT,
348 } ldlm_ns_type_t;
349
350 /**
351  * LDLM Namespace.
352  *
353  * Namespace serves to contain locks related to a particular service.
354  * There are two kinds of namespaces:
355  * - Server namespace has knowledge of all locks and is therefore authoritative
356  *   to make decisions like what locks could be granted and what conflicts
357  *   exist during new lock enqueue.
358  * - Client namespace only has limited knowledge about locks in the namespace,
359  *   only seeing locks held by the client.
360  *
361  * Every Lustre service has one server namespace present on the server serving
362  * that service. Every client connected to the service has a client namespace
363  * for it.
364  * Every lock obtained by client in that namespace is actually represented by
365  * two in-memory locks. One on the server and one on the client. The locks are
366  * linked by a special cookie by which one node can tell to the other which lock
367  * it actually means during communications. Such locks are called remote locks.
368  * The locks held by server only without any reference to a client are called
369  * local locks.
370  */
371 struct ldlm_namespace {
372         /** Backward link to OBD, required for LDLM pool to store new SLV. */
373         struct obd_device       *ns_obd;
374
375         /** Flag indicating if namespace is on client instead of server */
376         ldlm_side_t             ns_client;
377
378         /** Resource hash table for namespace. */
379         cfs_hash_t              *ns_rs_hash;
380
381         /** serialize */
382         spinlock_t              ns_lock;
383
384         /** big refcount (by bucket) */
385         atomic_t                ns_bref;
386
387         /**
388          * Namespace connect flags supported by server (may be changed via
389          * /proc, LRU resize may be disabled/enabled).
390          */
391         __u64                   ns_connect_flags;
392
393         /** Client side original connect flags supported by server. */
394         __u64                   ns_orig_connect_flags;
395
396         /* namespace proc dir entry */
397         struct proc_dir_entry   *ns_proc_dir_entry;
398
399         /**
400          * Position in global namespace list linking all namespaces on
401          * the node.
402          */
403         struct list_head        ns_list_chain;
404
405         /**
406          * List of unused locks for this namespace. This list is also called
407          * LRU lock list.
408          * Unused locks are locks with zero reader/writer reference counts.
409          * This list is only used on clients for lock caching purposes.
410          * When we want to release some locks voluntarily or if server wants
411          * us to release some locks due to e.g. memory pressure, we take locks
412          * to release from the head of this list.
413          * Locks are linked via l_lru field in \see struct ldlm_lock.
414          */
415         struct list_head        ns_unused_list;
416         /** Number of locks in the LRU list above */
417         int                     ns_nr_unused;
418
419         /**
420          * Maximum number of locks permitted in the LRU. If 0, means locks
421          * are managed by pools and there is no preset limit, rather it is all
422          * controlled by available memory on this client and on server.
423          */
424         unsigned int            ns_max_unused;
425         /** Maximum allowed age (last used time) for locks in the LRU */
426         unsigned int            ns_max_age;
427         /**
428          * Server only: number of times we evicted clients due to lack of reply
429          * to ASTs.
430          */
431         unsigned int            ns_timeouts;
432         /**
433          * Number of seconds since the file change time after which the
434          * MDT will return an UPDATE lock along with a LOOKUP lock.
435          * This allows the client to start caching negative dentries
436          * for a directory and may save an RPC for a later stat.
437          */
438         unsigned int            ns_ctime_age_limit;
439
440         /**
441          * Used to rate-limit ldlm_namespace_dump calls.
442          * \see ldlm_namespace_dump. Increased by 10 seconds every time
443          * it is called.
444          */
445         cfs_time_t              ns_next_dump;
446
447         /** "policy" function that does actual lock conflict determination */
448         ldlm_res_policy         ns_policy;
449
450         /**
451          * LVB operations for this namespace.
452          * \see struct ldlm_valblock_ops
453          */
454         struct ldlm_valblock_ops *ns_lvbo;
455
456         /**
457          * Used by filter code to store pointer to OBD of the service.
458          * Should be dropped in favor of \a ns_obd
459          */
460         void                    *ns_lvbp;
461
462         /**
463          * Wait queue used by __ldlm_namespace_free. Gets woken up every time
464          * a resource is removed.
465          */
466         wait_queue_head_t       ns_waitq;
467         /** LDLM pool structure for this namespace */
468         struct ldlm_pool        ns_pool;
469         /** Definition of how eagerly unused locks will be released from LRU */
470         ldlm_appetite_t         ns_appetite;
471
472         /**
473          * If more than \a ns_contended_locks are found, the resource is
474          * considered to be contended. Lock enqueues might specify that no
475          * contended locks should be granted
476          */
477         unsigned                ns_contended_locks;
478
479         /**
480          * The resources in this namespace remember contended state during
481          * \a ns_contention_time, in seconds.
482          */
483         unsigned                ns_contention_time;
484
485         /**
486          * Limit size of contended extent locks, in bytes.
487          * If extended lock is requested for more then this many bytes and
488          * caller instructs us not to grant contended locks, we would disregard
489          * such a request.
490          */
491         unsigned                ns_max_nolock_size;
492
493         /** Limit of parallel AST RPC count. */
494         unsigned                ns_max_parallel_ast;
495
496         /**
497          * Callback to check if a lock is good to be canceled by ELC or
498          * during recovery.
499          */
500         ldlm_cancel_cbt         ns_cancel;
501
502         /** LDLM lock stats */
503         struct lprocfs_stats    *ns_stats;
504
505         /**
506          * Flag to indicate namespace is being freed. Used to determine if
507          * recalculation of LDLM pool statistics should be skipped.
508          */
509         unsigned                ns_stopping:1;
510 };
511
512 /**
513  * Returns 1 if namespace \a ns is a client namespace.
514  */
515 static inline int ns_is_client(struct ldlm_namespace *ns)
516 {
517         LASSERT(ns != NULL);
518         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
519                                     LDLM_NAMESPACE_SERVER)));
520         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
521                 ns->ns_client == LDLM_NAMESPACE_SERVER);
522         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
523 }
524
525 /**
526  * Returns 1 if namespace \a ns is a server namespace.
527  */
528 static inline int ns_is_server(struct ldlm_namespace *ns)
529 {
530         LASSERT(ns != NULL);
531         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
532                                     LDLM_NAMESPACE_SERVER)));
533         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
534                 ns->ns_client == LDLM_NAMESPACE_SERVER);
535         return ns->ns_client == LDLM_NAMESPACE_SERVER;
536 }
537
538 /**
539  * Returns 1 if namespace \a ns supports early lock cancel (ELC).
540  */
541 static inline int ns_connect_cancelset(struct ldlm_namespace *ns)
542 {
543         LASSERT(ns != NULL);
544         return !!(ns->ns_connect_flags & OBD_CONNECT_CANCELSET);
545 }
546
547 /**
548  * Returns 1 if this namespace supports lru_resize.
549  */
550 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
551 {
552         LASSERT(ns != NULL);
553         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
554 }
555
556 static inline void ns_register_cancel(struct ldlm_namespace *ns,
557                                       ldlm_cancel_cbt arg)
558 {
559         LASSERT(ns != NULL);
560         ns->ns_cancel = arg;
561 }
562
563 struct ldlm_lock;
564
565 /** Type for blocking callback function of a lock. */
566 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
567                                       struct ldlm_lock_desc *new, void *data,
568                                       int flag);
569 /** Type for completion callback function of a lock. */
570 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, __u64 flags,
571                                         void *data);
572 /** Type for glimpse callback function of a lock. */
573 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
574
575 /** Work list for sending GL ASTs to multiple locks. */
576 struct ldlm_glimpse_work {
577         struct ldlm_lock        *gl_lock; /* lock to glimpse */
578         struct list_head         gl_list; /* linkage to other gl work structs */
579         __u32                    gl_flags;/* see LDLM_GL_WORK_* below */
580         union ldlm_gl_desc      *gl_desc; /* glimpse descriptor to be packed in
581                                            * glimpse callback request */
582 };
583
584 /** The ldlm_glimpse_work is allocated on the stack and should not be freed. */
585 #define LDLM_GL_WORK_NOFREE 0x1
586
587 /** Interval node data for each LDLM_EXTENT lock. */
588 struct ldlm_interval {
589         struct interval_node    li_node;  /* node for tree management */
590         struct list_head        li_group; /* the locks which have the same
591                                            * policy - group of the policy */
592 };
593 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
594
595 /**
596  * Interval tree for extent locks.
597  * The interval tree must be accessed under the resource lock.
598  * Interval trees are used for granted extent locks to speed up conflicts
599  * lookup. See ldlm/interval_tree.c for more details.
600  */
601 struct ldlm_interval_tree {
602         /** Tree size. */
603         int                     lit_size;
604         ldlm_mode_t             lit_mode;  /* lock mode */
605         struct interval_node    *lit_root; /* actual ldlm_interval */
606 };
607
608 /** Whether to track references to exports by LDLM locks. */
609 #define LUSTRE_TRACKS_LOCK_EXP_REFS (0)
610
611 /** Cancel flags. */
612 typedef enum {
613         LCF_ASYNC      = 0x1, /* Cancel locks asynchronously. */
614         LCF_LOCAL      = 0x2, /* Cancel locks locally, not notifing server */
615         LCF_BL_AST     = 0x4, /* Cancel locks marked as LDLM_FL_BL_AST
616                                * in the same RPC */
617 } ldlm_cancel_flags_t;
618
619 struct ldlm_flock {
620         __u64 start;
621         __u64 end;
622         __u64 owner;
623         __u64 blocking_owner;
624         struct obd_export *blocking_export;
625         /* Protected by the hash lock */
626         __u32 blocking_refs;
627         __u32 pid;
628 };
629
630 union ldlm_policy_data {
631         struct ldlm_extent l_extent;
632         struct ldlm_flock l_flock;
633         struct ldlm_inodebits l_inodebits;
634 };
635
636 typedef union ldlm_policy_data ldlm_policy_data_t;
637
638 void ldlm_convert_policy_to_wire(ldlm_type_t type,
639                                  const ldlm_policy_data_t *lpolicy,
640                                  ldlm_wire_policy_data_t *wpolicy);
641 void ldlm_convert_policy_to_local(struct obd_export *exp, ldlm_type_t type,
642                                   const ldlm_wire_policy_data_t *wpolicy,
643                                   ldlm_policy_data_t *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         ldlm_mode_t             l_req_mode;
725         /**
726          * Granted mode, also protected by lr_lock.
727          */
728         ldlm_mode_t             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         ldlm_policy_data_t      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          */
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 /**
904  * LDLM resource description.
905  * Basically, resource is a representation for a single object.
906  * Object has a name which is currently 4 64-bit integers. LDLM user is
907  * responsible for creation of a mapping between objects it wants to be
908  * protected and resource names.
909  *
910  * A resource can only hold locks of a single lock type, though there may be
911  * multiple ldlm_locks on a single resource, depending on the lock type and
912  * whether the locks are conflicting or not.
913  */
914 struct ldlm_resource {
915         struct ldlm_ns_bucket   *lr_ns_bucket;
916
917         /**
918          * List item for list in namespace hash.
919          * protected by ns_lock
920          */
921         struct hlist_node       lr_hash;
922
923         /** Spinlock to protect locks under this resource. */
924         spinlock_t              lr_lock;
925
926         /**
927          * protected by lr_lock
928          * @{ */
929         /** List of locks in granted state */
930         struct list_head        lr_granted;
931         /** List of locks waiting to change their granted mode (converted) */
932         struct list_head        lr_converting;
933         /**
934          * List of locks that could not be granted due to conflicts and
935          * that are waiting for conflicts to go away */
936         struct list_head        lr_waiting;
937         /** @} */
938
939         /* XXX No longer needed? Remove ASAP */
940         ldlm_mode_t             lr_most_restr;
941
942         /** Type of locks this resource can hold. Only one type per resource. */
943         ldlm_type_t             lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK,IBITS} */
944
945         /** Resource name */
946         struct ldlm_res_id      lr_name;
947         /** Reference count for this resource */
948         atomic_t                lr_refcount;
949
950         /**
951          * Interval trees (only for extent locks) for all modes of this resource
952          */
953         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];
954
955         /**
956          * Server-side-only lock value block elements.
957          * To serialize lvbo_init.
958          */
959         struct mutex            lr_lvb_mutex;
960         int                     lr_lvb_len;
961         /** is lvb initialized ? */
962         bool                    lr_lvb_initialized;
963         /** protected by lr_lock */
964         void                    *lr_lvb_data;
965
966         /** When the resource was considered as contended. */
967         cfs_time_t              lr_contention_time;
968         /** List of references to this resource. For debugging. */
969         struct lu_ref           lr_reference;
970
971         struct inode            *lr_lvb_inode;
972 };
973
974 static inline bool ldlm_has_layout(struct ldlm_lock *lock)
975 {
976         return lock->l_resource->lr_type == LDLM_IBITS &&
977                 lock->l_policy_data.l_inodebits.bits & MDS_INODELOCK_LAYOUT;
978 }
979
980 static inline char *
981 ldlm_ns_name(struct ldlm_namespace *ns)
982 {
983         return ns->ns_rs_hash->hs_name;
984 }
985
986 static inline struct ldlm_namespace *
987 ldlm_res_to_ns(struct ldlm_resource *res)
988 {
989         return res->lr_ns_bucket->nsb_namespace;
990 }
991
992 static inline struct ldlm_namespace *
993 ldlm_lock_to_ns(struct ldlm_lock *lock)
994 {
995         return ldlm_res_to_ns(lock->l_resource);
996 }
997
998 static inline char *
999 ldlm_lock_to_ns_name(struct ldlm_lock *lock)
1000 {
1001         return ldlm_ns_name(ldlm_lock_to_ns(lock));
1002 }
1003
1004 static inline struct adaptive_timeout *
1005 ldlm_lock_to_ns_at(struct ldlm_lock *lock)
1006 {
1007         return &lock->l_resource->lr_ns_bucket->nsb_at_estimate;
1008 }
1009
1010 static inline int ldlm_lvbo_init(struct ldlm_resource *res)
1011 {
1012         struct ldlm_namespace *ns = ldlm_res_to_ns(res);
1013         int rc = 0;
1014
1015         if (ns->ns_lvbo == NULL || ns->ns_lvbo->lvbo_init == NULL ||
1016             res->lr_lvb_initialized)
1017                 return 0;
1018
1019         mutex_lock(&res->lr_lvb_mutex);
1020         /* Did we lose the race? */
1021         if (res->lr_lvb_initialized) {
1022                 mutex_unlock(&res->lr_lvb_mutex);
1023                 return 0;
1024         }
1025         rc = ns->ns_lvbo->lvbo_init(res);
1026         if (rc < 0) {
1027                 CDEBUG(D_DLMTRACE, "lvbo_init failed for resource : rc = %d\n",
1028                        rc);
1029                 if (res->lr_lvb_data != NULL) {
1030                         OBD_FREE(res->lr_lvb_data, res->lr_lvb_len);
1031                         res->lr_lvb_data = NULL;
1032                 }
1033                 res->lr_lvb_len = rc;
1034         } else {
1035                 res->lr_lvb_initialized = true;
1036         }
1037         mutex_unlock(&res->lr_lvb_mutex);
1038         return rc;
1039 }
1040
1041 static inline int ldlm_lvbo_size(struct ldlm_lock *lock)
1042 {
1043         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1044
1045         if (ns->ns_lvbo != NULL && ns->ns_lvbo->lvbo_size != NULL)
1046                 return ns->ns_lvbo->lvbo_size(lock);
1047
1048         return 0;
1049 }
1050
1051 static inline int ldlm_lvbo_fill(struct ldlm_lock *lock, void *buf, int len)
1052 {
1053         struct ldlm_namespace *ns = ldlm_lock_to_ns(lock);
1054         int rc;
1055
1056         if (ns->ns_lvbo != NULL) {
1057                 LASSERT(ns->ns_lvbo->lvbo_fill != NULL);
1058                 /* init lvb now if not already */
1059                 rc = ldlm_lvbo_init(lock->l_resource);
1060                 if (rc < 0) {
1061                         CERROR("lock %p: delayed lvb init failed (rc %d)",
1062                                lock, rc);
1063                         return rc;
1064                 }
1065                 return ns->ns_lvbo->lvbo_fill(lock, buf, len);
1066         }
1067         return 0;
1068 }
1069
1070 struct ldlm_ast_work {
1071         struct ldlm_lock       *w_lock;
1072         int                     w_blocking;
1073         struct ldlm_lock_desc   w_desc;
1074         struct list_head        w_list;
1075         int                     w_flags;
1076         void                   *w_data;
1077         int                     w_datalen;
1078 };
1079
1080 /**
1081  * Common ldlm_enqueue parameters
1082  */
1083 struct ldlm_enqueue_info {
1084         __u32 ei_type;   /** Type of the lock being enqueued. */
1085         __u32 ei_mode;   /** Mode of the lock being enqueued. */
1086         void *ei_cb_bl;  /** blocking lock callback */
1087         void *ei_cb_cp;  /** lock completion callback */
1088         void *ei_cb_gl;  /** lock glimpse callback */
1089         void *ei_cbdata; /** Data to be passed into callbacks. */
1090         unsigned int ei_enq_slave:1; /* whether enqueue slave stripes */
1091 };
1092
1093 #define ei_res_id       ei_cb_gl
1094
1095 extern struct obd_ops ldlm_obd_ops;
1096
1097 extern char *ldlm_lockname[];
1098 extern char *ldlm_typename[];
1099 extern char *ldlm_it2str(int it);
1100
1101 /**
1102  * Just a fancy CDEBUG call with log level preset to LDLM_DEBUG.
1103  * For the cases where we do not have actual lock to print along
1104  * with a debugging message that is ldlm-related
1105  */
1106 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
1107         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
1108
1109 /**
1110  * Support function for lock information printing into debug logs.
1111  * \see LDLM_DEBUG
1112  */
1113 #ifdef LIBCFS_DEBUG
1114 #define ldlm_lock_debug(msgdata, mask, cdls, lock, fmt, a...) do {      \
1115         CFS_CHECK_STACK(msgdata, mask, cdls);                           \
1116                                                                         \
1117         if (((mask) & D_CANTMASK) != 0 ||                               \
1118             ((libcfs_debug & (mask)) != 0 &&                            \
1119              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0))          \
1120                 _ldlm_lock_debug(lock, msgdata, fmt, ##a);              \
1121 } while(0)
1122
1123 void _ldlm_lock_debug(struct ldlm_lock *lock,
1124                       struct libcfs_debug_msg_data *data,
1125                       const char *fmt, ...)
1126         __attribute__ ((format (printf, 3, 4)));
1127
1128 /**
1129  * Rate-limited version of lock printing function.
1130  */
1131 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do {                         \
1132         static cfs_debug_limit_state_t _ldlm_cdls;                           \
1133         LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, mask, &_ldlm_cdls);              \
1134         ldlm_lock_debug(&msgdata, mask, &_ldlm_cdls, lock, "### " fmt , ##a);\
1135 } while (0)
1136
1137 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
1138 #define LDLM_WARN(lock, fmt, a...)  LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
1139
1140 /** Non-rate-limited lock printing function for debugging purposes. */
1141 #define LDLM_DEBUG(lock, fmt, a...)   do {                                  \
1142         if (likely(lock != NULL)) {                                         \
1143                 LIBCFS_DEBUG_MSG_DATA_DECL(msgdata, D_DLMTRACE, NULL);      \
1144                 ldlm_lock_debug(&msgdata, D_DLMTRACE, NULL, lock,           \
1145                                 "### " fmt , ##a);                          \
1146         } else {                                                            \
1147                 LDLM_DEBUG_NOLOCK("no dlm lock: " fmt, ##a);                \
1148         }                                                                   \
1149 } while (0)
1150 #else /* !LIBCFS_DEBUG */
1151 # define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) ((void)0)
1152 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
1153 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
1154 #endif
1155
1156 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, __u64 *flags,
1157                                       int first_enq, ldlm_error_t *err,
1158                                       struct list_head *work_list);
1159
1160 /**
1161  * Return values for lock iterators.
1162  * Also used during deciding of lock grants and cancellations.
1163  */
1164 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
1165 #define LDLM_ITER_STOP     2 /* stop iterating */
1166
1167 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
1168 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
1169
1170 /** \defgroup ldlm_iterator Lock iterators
1171  *
1172  * LDLM provides for a way to iterate through every lock on a resource or
1173  * namespace or every resource in a namespace.
1174  * @{ */
1175 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
1176                           void *closure);
1177 void ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
1178                             void *closure);
1179 int ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
1180                           ldlm_iterator_t iter, void *data);
1181 /** @} ldlm_iterator */
1182
1183 int ldlm_replay_locks(struct obd_import *imp);
1184
1185 /* ldlm_flock.c */
1186 int ldlm_flock_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1187
1188 /* ldlm_extent.c */
1189 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
1190
1191 struct ldlm_callback_suite {
1192         ldlm_completion_callback lcs_completion;
1193         ldlm_blocking_callback   lcs_blocking;
1194         ldlm_glimpse_callback    lcs_glimpse;
1195 };
1196
1197 /* ldlm_lockd.c */
1198 #ifdef HAVE_SERVER_SUPPORT
1199 /** \defgroup ldlm_srv_ast Server AST handlers
1200  * These are AST handlers used by server code.
1201  * Their property is that they are just preparing RPCs to be sent to clients.
1202  * @{
1203  */
1204 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
1205                              void *data, int flag);
1206 int ldlm_server_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1207 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
1208 int ldlm_glimpse_locks(struct ldlm_resource *res,
1209                        struct list_head *gl_work_list);
1210 /** @} ldlm_srv_ast */
1211
1212 /** \defgroup ldlm_handlers Server LDLM handlers
1213  * These are handler functions that should be called by "frontends" such as
1214  * MDT or OST to pass through LDLM requests to LDLM for handling
1215  * @{
1216  */
1217 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
1218                         ldlm_blocking_callback, ldlm_glimpse_callback);
1219 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1220                          const struct ldlm_request *dlm_req,
1221                          const struct ldlm_callback_suite *cbs);
1222 int ldlm_handle_convert(struct ptlrpc_request *req);
1223 int ldlm_handle_convert0(struct ptlrpc_request *req,
1224                          const struct ldlm_request *dlm_req);
1225 int ldlm_handle_cancel(struct ptlrpc_request *req);
1226 int ldlm_request_cancel(struct ptlrpc_request *req,
1227                         const struct ldlm_request *dlm_req,
1228                         int first, enum lustre_at_flags flags);
1229 /** @} ldlm_handlers */
1230
1231 void ldlm_revoke_export_locks(struct obd_export *exp);
1232 unsigned int ldlm_bl_timeout(struct ldlm_lock *lock);
1233 #endif
1234 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
1235 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
1236 int ldlm_get_ref(void);
1237 void ldlm_put_ref(void);
1238 int ldlm_init_export(struct obd_export *exp);
1239 void ldlm_destroy_export(struct obd_export *exp);
1240 struct ldlm_lock *ldlm_request_lock(struct ptlrpc_request *req);
1241
1242 /* ldlm_lock.c */
1243 #ifdef HAVE_SERVER_SUPPORT
1244 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
1245 #endif
1246 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
1247 void ldlm_lock2handle(const struct ldlm_lock *lock,
1248                       struct lustre_handle *lockh);
1249 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, __u64 flags);
1250 void ldlm_cancel_callback(struct ldlm_lock *);
1251 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
1252 int ldlm_lock_set_data(struct lustre_handle *, void *);
1253
1254 /**
1255  * Obtain a lock reference by its handle.
1256  */
1257 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
1258 {
1259         return __ldlm_handle2lock(h, 0);
1260 }
1261
1262 #define LDLM_LOCK_REF_DEL(lock) \
1263         lu_ref_del(&lock->l_reference, "handle", current)
1264
1265 static inline struct ldlm_lock *
1266 ldlm_handle2lock_long(const struct lustre_handle *h, __u64 flags)
1267 {
1268         struct ldlm_lock *lock;
1269
1270         lock = __ldlm_handle2lock(h, flags);
1271         if (lock != NULL)
1272                 LDLM_LOCK_REF_DEL(lock);
1273         return lock;
1274 }
1275
1276 /**
1277  * Update Lock Value Block Operations (LVBO) on a resource taking into account
1278  * data from request \a r
1279  */
1280 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
1281                                        struct ptlrpc_request *r, int increase)
1282 {
1283         int rc;
1284
1285         /* delayed lvb init may be required */
1286         rc = ldlm_lvbo_init(res);
1287         if (rc < 0) {
1288                 CERROR("delayed lvb init failed (rc %d)\n", rc);
1289                 return rc;
1290         }
1291
1292         if (ldlm_res_to_ns(res)->ns_lvbo &&
1293             ldlm_res_to_ns(res)->ns_lvbo->lvbo_update) {
1294                 return ldlm_res_to_ns(res)->ns_lvbo->lvbo_update(res, r,
1295                                                                  increase);
1296         }
1297         return 0;
1298 }
1299
1300 int ldlm_error2errno(ldlm_error_t error);
1301 ldlm_error_t ldlm_errno2error(int err_no); /* don't call it `errno': this
1302                                             * confuses user-space. */
1303 #if LUSTRE_TRACKS_LOCK_EXP_REFS
1304 void ldlm_dump_export_locks(struct obd_export *exp);
1305 #endif
1306
1307 /**
1308  * Release a temporary lock reference obtained by ldlm_handle2lock() or
1309  * __ldlm_handle2lock().
1310  */
1311 #define LDLM_LOCK_PUT(lock)                     \
1312 do {                                            \
1313         LDLM_LOCK_REF_DEL(lock);                \
1314         /*LDLM_DEBUG((lock), "put");*/          \
1315         ldlm_lock_put(lock);                    \
1316 } while (0)
1317
1318 /**
1319  * Release a lock reference obtained by some other means (see
1320  * LDLM_LOCK_PUT()).
1321  */
1322 #define LDLM_LOCK_RELEASE(lock)                 \
1323 do {                                            \
1324         /*LDLM_DEBUG((lock), "put");*/          \
1325         ldlm_lock_put(lock);                    \
1326 } while (0)
1327
1328 #define LDLM_LOCK_GET(lock)                     \
1329 ({                                              \
1330         ldlm_lock_get(lock);                    \
1331         /*LDLM_DEBUG((lock), "get");*/          \
1332         lock;                                   \
1333 })
1334
1335 #define ldlm_lock_list_put(head, member, count)                 \
1336 ({                                                              \
1337         struct ldlm_lock *_lock, *_next;                        \
1338         int c = count;                                          \
1339         list_for_each_entry_safe(_lock, _next, head, member) {  \
1340                 if (c-- == 0)                                   \
1341                         break;                                  \
1342                 list_del_init(&_lock->member);                  \
1343                 LDLM_LOCK_RELEASE(_lock);                       \
1344         }                                                       \
1345         LASSERT(c <= 0);                                        \
1346 })
1347
1348 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
1349 void ldlm_lock_put(struct ldlm_lock *lock);
1350 void ldlm_lock_destroy(struct ldlm_lock *lock);
1351 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
1352 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
1353 int  ldlm_lock_addref_try(struct lustre_handle *lockh, __u32 mode);
1354 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
1355 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
1356 void ldlm_lock_fail_match_locked(struct ldlm_lock *lock);
1357 void ldlm_lock_fail_match(struct ldlm_lock *lock);
1358 void ldlm_lock_allow_match(struct ldlm_lock *lock);
1359 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
1360 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, __u64 flags,
1361                             const struct ldlm_res_id *, ldlm_type_t type,
1362                             ldlm_policy_data_t *, ldlm_mode_t mode,
1363                             struct lustre_handle *, int unref);
1364 ldlm_mode_t ldlm_revalidate_lock_handle(struct lustre_handle *lockh,
1365                                         __u64 *bits);
1366 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
1367                                         __u32 *flags);
1368 void ldlm_lock_downgrade(struct ldlm_lock *lock, int new_mode);
1369 void ldlm_lock_cancel(struct ldlm_lock *lock);
1370 void ldlm_reprocess_all(struct ldlm_resource *res);
1371 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
1372 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
1373 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
1374
1375 /* resource.c */
1376 struct ldlm_namespace *
1377 ldlm_namespace_new(struct obd_device *obd, char *name,
1378                    ldlm_side_t client, ldlm_appetite_t apt,
1379                    ldlm_ns_type_t ns_type);
1380 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, __u64 flags);
1381 void ldlm_namespace_free(struct ldlm_namespace *ns,
1382                          struct obd_import *imp, int force);
1383 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
1384 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
1385 void ldlm_namespace_get(struct ldlm_namespace *ns);
1386 void ldlm_namespace_put(struct ldlm_namespace *ns);
1387 int ldlm_proc_setup(void);
1388 #ifdef CONFIG_PROC_FS
1389 void ldlm_proc_cleanup(void);
1390 #else
1391 static inline void ldlm_proc_cleanup(void) {}
1392 #endif
1393
1394 /* resource.c - internal */
1395 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
1396                                         struct ldlm_resource *parent,
1397                                         const struct ldlm_res_id *,
1398                                         ldlm_type_t type, int create);
1399 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
1400 int ldlm_resource_putref(struct ldlm_resource *res);
1401 void ldlm_resource_add_lock(struct ldlm_resource *res,
1402                             struct list_head *head,
1403                             struct ldlm_lock *lock);
1404 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1405 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1406 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
1407 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1408 void ldlm_resource_dump(int level, struct ldlm_resource *);
1409 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1410                               const struct ldlm_res_id *);
1411
1412 #define LDLM_RESOURCE_ADDREF(res) do {                                  \
1413         lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, current);  \
1414 } while (0)
1415
1416 #define LDLM_RESOURCE_DELREF(res) do {                                  \
1417         lu_ref_del(&(res)->lr_reference, __FUNCTION__, current);  \
1418 } while (0)
1419
1420 /* ldlm_request.c */
1421 int ldlm_expired_completion_wait(void *data);
1422 /** \defgroup ldlm_local_ast Default AST handlers for local locks
1423  * These AST handlers are typically used for server-side local locks and are
1424  * also used by client-side lock handlers to perform minimum level base
1425  * processing.
1426  * @{ */
1427 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1428 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1429                       void *data, int flag);
1430 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1431 int ldlm_completion_ast_async(struct ldlm_lock *lock, __u64 flags, void *data);
1432 int ldlm_completion_ast(struct ldlm_lock *lock, __u64 flags, void *data);
1433 /** @} ldlm_local_ast */
1434
1435 /** \defgroup ldlm_cli_api API to operate on locks from actual LDLM users.
1436  * These are typically used by client and server (*_local versions)
1437  * to obtain and release locks.
1438  * @{ */
1439 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1440                      struct ldlm_enqueue_info *einfo,
1441                      const struct ldlm_res_id *res_id,
1442                      ldlm_policy_data_t const *policy, __u64 *flags,
1443                      void *lvb, __u32 lvb_len, enum lvb_type lvb_type,
1444                      struct lustre_handle *lockh, int async);
1445 int ldlm_prep_enqueue_req(struct obd_export *exp,
1446                           struct ptlrpc_request *req,
1447                           struct list_head *cancels,
1448                           int count);
1449 int ldlm_prep_elc_req(struct obd_export *exp, struct ptlrpc_request *req,
1450                       int version, int opc, int canceloff,
1451                       struct list_head *cancels, int count);
1452
1453 struct ptlrpc_request *ldlm_enqueue_pack(struct obd_export *exp, int lvb_len);
1454 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1455                          const struct ldlm_request *dlm_req,
1456                          const struct ldlm_callback_suite *cbs);
1457 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1458                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
1459                           __u64 *flags, void *lvb, __u32 lvb_len,
1460                           struct lustre_handle *lockh, int rc);
1461 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1462                            const struct ldlm_res_id *res_id,
1463                            ldlm_type_t type, ldlm_policy_data_t *policy,
1464                            ldlm_mode_t mode, __u64 *flags,
1465                            ldlm_blocking_callback blocking,
1466                            ldlm_completion_callback completion,
1467                            ldlm_glimpse_callback glimpse,
1468                            void *data, __u32 lvb_len, enum lvb_type lvb_type,
1469                            const __u64 *client_cookie,
1470                            struct lustre_handle *lockh);
1471 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
1472                     void *data, __u32 data_len);
1473 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
1474 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1475 int ldlm_cli_cancel(struct lustre_handle *lockh,
1476                     ldlm_cancel_flags_t cancel_flags);
1477 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1478                            ldlm_cancel_flags_t flags, void *opaque);
1479 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1480                                     const struct ldlm_res_id *res_id,
1481                                     ldlm_policy_data_t *policy,
1482                                     ldlm_mode_t mode,
1483                                     ldlm_cancel_flags_t flags,
1484                                     void *opaque);
1485 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
1486                         int count, ldlm_cancel_flags_t flags);
1487 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1488                                struct list_head *cancels,
1489                                ldlm_policy_data_t *policy,
1490                                ldlm_mode_t mode, __u64 lock_flags,
1491                                ldlm_cancel_flags_t cancel_flags, void *opaque);
1492 int ldlm_cli_cancel_list_local(struct list_head *cancels, int count,
1493                                ldlm_cancel_flags_t flags);
1494 int ldlm_cli_cancel_list(struct list_head *head, int count,
1495                          struct ptlrpc_request *req, ldlm_cancel_flags_t flags);
1496 /** @} ldlm_cli_api */
1497
1498 /* mds/handler.c */
1499 /* This has to be here because recursive inclusion sucks. */
1500 int intent_disposition(struct ldlm_reply *rep, int flag);
1501 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1502
1503 /**
1504  * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1505  * than one lock_res is dead-lock safe.
1506  */
1507 enum lock_res_type {
1508         LRT_NORMAL,
1509         LRT_NEW
1510 };
1511
1512 /** Lock resource. */
1513 static inline void lock_res(struct ldlm_resource *res)
1514 {
1515         spin_lock(&res->lr_lock);
1516 }
1517
1518 /** Lock resource with a way to instruct lockdep code about nestedness-safe. */
1519 static inline void lock_res_nested(struct ldlm_resource *res,
1520                                    enum lock_res_type mode)
1521 {
1522         spin_lock_nested(&res->lr_lock, mode);
1523 }
1524
1525 /** Unlock resource. */
1526 static inline void unlock_res(struct ldlm_resource *res)
1527 {
1528         spin_unlock(&res->lr_lock);
1529 }
1530
1531 /** Check if resource is already locked, assert if not. */
1532 static inline void check_res_locked(struct ldlm_resource *res)
1533 {
1534         assert_spin_locked(&res->lr_lock);
1535 }
1536
1537 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1538 void unlock_res_and_lock(struct ldlm_lock *lock);
1539
1540 /* ldlm_pool.c */
1541 /** \defgroup ldlm_pools Various LDLM pool related functions
1542  * There are not used outside of ldlm.
1543  * @{
1544  */
1545 int ldlm_pools_recalc(ldlm_side_t client);
1546 int ldlm_pools_init(void);
1547 void ldlm_pools_fini(void);
1548
1549 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1550                    int idx, ldlm_side_t client);
1551 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, gfp_t gfp_mask);
1552 void ldlm_pool_fini(struct ldlm_pool *pl);
1553 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1554 int ldlm_pool_recalc(struct ldlm_pool *pl);
1555 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1556 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1557 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1558 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1559 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1560 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1561 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1562 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1563 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1564 /** @} */
1565
1566 #endif
1567 /** @} LDLM */