Whamcloud - gitweb
f64b626b89495c453bcf3a6d87b7df5a68eeabaf
[fs/lustre-release.git] / lustre / include / lustre_dlm.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * vim:expandtab:shiftwidth=8:tabstop=8:
3  *
4  * GPL HEADER START
5  *
6  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License version 2 only,
10  * as published by the Free Software Foundation.
11  *
12  * This program is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * General Public License version 2 for more details (a copy is included
16  * in the LICENSE file that accompanied this code).
17  *
18  * You should have received a copy of the GNU General Public License
19  * version 2 along with this program; If not, see
20  * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
21  *
22  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23  * CA 95054 USA or visit www.sun.com if you need additional information or
24  * have any questions.
25  *
26  * GPL HEADER END
27  */
28 /*
29  * Copyright  2008 Sun Microsystems, Inc. All rights reserved
30  * Use is subject to license terms.
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 #ifndef _LUSTRE_DLM_H__
38 #define _LUSTRE_DLM_H__
39
40 #if defined(__linux__)
41 #include <linux/lustre_dlm.h>
42 #elif defined(__APPLE__)
43 #include <darwin/lustre_dlm.h>
44 #elif defined(__WINNT__)
45 #include <winnt/lustre_dlm.h>
46 #else
47 #error Unsupported operating system.
48 #endif
49
50 #include <lustre_lib.h>
51 #include <lustre_net.h>
52 #include <lustre_import.h>
53 #include <lustre_handles.h>
54 #include <lustre_export.h> /* for obd_export, for LDLM_DEBUG */
55 #include <interval_tree.h> /* for interval_node{}, ldlm_extent */
56 #include <lu_ref.h>
57
58 struct obd_ops;
59 struct obd_device;
60
61 #define OBD_LDLM_DEVICENAME  "ldlm"
62
63 #ifdef HAVE_BGL_SUPPORT
64 /* 1.5 times the maximum 128 tasks available in VN mode */
65 #define LDLM_DEFAULT_LRU_SIZE 196
66 #else
67 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
68 #endif
69 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
70 #define LDLM_CTIME_AGE_LIMIT (10)
71
72 typedef enum {
73         ELDLM_OK = 0,
74
75         ELDLM_LOCK_CHANGED = 300,
76         ELDLM_LOCK_ABORTED = 301,
77         ELDLM_LOCK_REPLACED = 302,
78         ELDLM_NO_LOCK_DATA = 303,
79
80         ELDLM_NAMESPACE_EXISTS = 400,
81         ELDLM_BAD_NAMESPACE    = 401
82 } ldlm_error_t;
83
84 typedef enum {
85         LDLM_NAMESPACE_SERVER = 1 << 0,
86         LDLM_NAMESPACE_CLIENT = 1 << 1
87 } ldlm_side_t;
88
89 #define LDLM_FL_LOCK_CHANGED   0x000001 /* extent, mode, or resource changed */
90
91 /* If the server returns one of these flags, then the lock was put on that list.
92  * If the client sends one of these flags (during recovery ONLY!), it wants the
93  * lock added to the specified list, no questions asked. -p */
94 #define LDLM_FL_BLOCK_GRANTED  0x000002
95 #define LDLM_FL_BLOCK_CONV     0x000004
96 #define LDLM_FL_BLOCK_WAIT     0x000008
97
98 #define LDLM_FL_CBPENDING      0x000010 /* this lock is being destroyed */
99 #define LDLM_FL_AST_SENT       0x000020 /* blocking or cancel packet was
100                                          * queued for sending. */
101 #define LDLM_FL_WAIT_NOREPROC  0x000040 /* not a real flag, not saved in lock */
102 #define LDLM_FL_CANCEL         0x000080 /* cancellation callback already run */
103
104 /* Lock is being replayed.  This could probably be implied by the fact that one
105  * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
106 #define LDLM_FL_REPLAY         0x000100
107
108 #define LDLM_FL_INTENT_ONLY    0x000200 /* don't grant lock, just do intent */
109 #define LDLM_FL_LOCAL_ONLY     0x000400 /* see ldlm_cli_cancel_unused */
110
111 /* don't run the cancel callback under ldlm_cli_cancel_unused */
112 #define LDLM_FL_FAILED         0x000800
113
114 #define LDLM_FL_HAS_INTENT     0x001000 /* lock request has intent */
115 #define LDLM_FL_CANCELING      0x002000 /* lock cancel has already been sent */
116 #define LDLM_FL_LOCAL          0x004000 /* local lock (ie, no srv/cli split) */
117 #define LDLM_FL_WARN           0x008000 /* see ldlm_cli_cancel_unused */
118 #define LDLM_FL_DISCARD_DATA   0x010000 /* discard (no writeback) on cancel */
119
120 #define LDLM_FL_NO_TIMEOUT     0x020000 /* Blocked by group lock - wait
121                                          * indefinitely */
122
123 /* file & record locking */
124 #define LDLM_FL_BLOCK_NOWAIT   0x040000 // server told not to wait if blocked
125 #define LDLM_FL_TEST_LOCK      0x080000 // return blocking lock
126
127 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
128  * the LVB filling happens _after_ the lock has been granted, so another thread
129  * can match`t before the LVB has been updated.  As a dirty hack, we set
130  * LDLM_FL_LVB_READY only after we've done the LVB poop.
131  * this is only needed on lov/osc now, where lvb is actually used and callers
132  * must set it in input flags.
133  *
134  * The proper fix is to do the granting inside of the completion AST, which can
135  * be replaced with a LVB-aware wrapping function for OSC locks.  That change is
136  * pretty high-risk, though, and would need a lot more testing. */
137
138 #define LDLM_FL_LVB_READY      0x100000
139
140 /* A lock contributes to the kms calculation until it has finished the part
141  * of it's cancelation that performs write back on its dirty pages.  It
142  * can remain on the granted list during this whole time.  Threads racing
143  * to update the kms after performing their writeback need to know to
144  * exclude each others locks from the calculation as they walk the granted
145  * list. */
146 #define LDLM_FL_KMS_IGNORE     0x200000
147
148 /* Immediatelly cancel such locks when they block some other locks. Send
149  * cancel notification to original lock holder, but expect no reply. This is
150  * for clients (like liblustre) that cannot be expected to reliably response
151  * to blocking ast. */
152 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
153
154 /* Flags flags inherited from parent lock when doing intents. */
155 #define LDLM_INHERIT_FLAGS     (LDLM_FL_CANCEL_ON_BLOCK)
156
157 /* completion ast to be executed */
158 #define LDLM_FL_CP_REQD        0x1000000
159
160 /* cleanup_resource has already handled the lock */
161 #define LDLM_FL_CLEANED        0x2000000
162
163 /* optimization hint: LDLM can run blocking callback from current context
164  * w/o involving separate thread. in order to decrease cs rate */
165 #define LDLM_FL_ATOMIC_CB      0x4000000
166
167 /* Cancel lock asynchronously. See ldlm_cli_cancel_unused_resource. */
168 #define LDLM_FL_ASYNC           0x8000000
169
170 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
171  * such that server send blocking ast for conflict locks to this client for
172  * the 1st operation, whereas the 2nd operation has canceled this lock and
173  * is waiting for rpc_lock which is taken by the 1st operation.
174  * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
175  * ELC code to cancel it.
176  * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
177  * droped to let ldlm_callback_handler() return EINVAL to the server. It is
178  * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
179  * to send a separate CANCEL rpc. */
180 #define LDLM_FL_BL_AST          0x10000000
181 #define LDLM_FL_BL_DONE         0x20000000
182
183 /* measure lock contention and return -EUSERS if locking contention is high */
184 #define LDLM_FL_DENY_ON_CONTENTION 0x40000000
185
186 /* These are flags that are mapped into the flags and ASTs of blocking locks */
187 #define LDLM_AST_DISCARD_DATA  0x80000000 /* Add FL_DISCARD to blocking ASTs */
188
189 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
190 #define LDLM_AST_FLAGS         (LDLM_FL_DISCARD_DATA)
191
192 /* Used for marking lock as an target for -EINTR while cp_ast sleep situation
193  * emulation + race with upcoming bl_ast.  */
194 #define LDLM_FL_FAIL_LOC       0x100000000ULL
195
196 /* The blocking callback is overloaded to perform two functions.  These flags
197  * indicate which operation should be performed. */
198 #define LDLM_CB_BLOCKING    1
199 #define LDLM_CB_CANCELING   2
200
201 /* compatibility matrix */
202 #define LCK_COMPAT_EX  LCK_NL
203 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
204 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
205 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
206 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
207 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
208 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
209 #define LCK_COMPAT_COS (LCK_COS)
210
211 extern ldlm_mode_t lck_compat_array[];
212
213 static inline void lockmode_verify(ldlm_mode_t mode)
214 {
215        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
216 }
217
218 static inline int lockmode_compat(ldlm_mode_t exist_mode, ldlm_mode_t new_mode)
219 {
220        return (lck_compat_array[exist_mode] & new_mode);
221 }
222
223 /*
224  *
225  * cluster name spaces
226  *
227  */
228
229 #define DLM_OST_NAMESPACE 1
230 #define DLM_MDS_NAMESPACE 2
231
232 /* XXX
233    - do we just separate this by security domains and use a prefix for
234      multiple namespaces in the same domain?
235    -
236 */
237
238 /*
239  * Locking rules:
240  *
241  * lr_lock
242  *
243  * lr_lock
244  *     waiting_locks_spinlock
245  *
246  * lr_lock
247  *     led_lock
248  *
249  * lr_lock
250  *     ns_unused_lock
251  *
252  * lr_lvb_sem
253  *     lr_lock
254  *
255  */
256
257 struct ldlm_pool;
258 struct ldlm_lock;
259 struct ldlm_resource;
260 struct ldlm_namespace;
261
262 struct ldlm_pool_ops {
263         int (*po_recalc)(struct ldlm_pool *pl);
264         int (*po_shrink)(struct ldlm_pool *pl, int nr,
265                          unsigned int gfp_mask);
266         int (*po_setup)(struct ldlm_pool *pl, int limit);
267 };
268
269 /**
270  * One second for pools thread check interval. Each pool has own period.
271  */
272 #define LDLM_POOLS_THREAD_PERIOD (1)
273
274 /**
275  * 5% margin for modest pools. See ldlm_pool.c for details.
276  */
277 #define LDLM_POOLS_MODEST_MARGIN (5)
278
279 /**
280  * Default recalc period for server side pools in sec.
281  */
282 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
283
284 /**
285  * Default recalc period for client side pools in sec.
286  */
287 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
288
289 struct ldlm_pool {
290         /**
291          * Pool proc directory.
292          */
293         cfs_proc_dir_entry_t  *pl_proc_dir;
294         /**
295          * Pool name, should be long enough to contain compound proc entry name.
296          */
297         char                   pl_name[100];
298         /**
299          * Lock for protecting slv/clv updates.
300          */
301         spinlock_t             pl_lock;
302         /**
303          * Number of allowed locks in in pool, both, client and server side.
304          */
305         atomic_t               pl_limit;
306         /**
307          * Number of granted locks in
308          */
309         atomic_t               pl_granted;
310         /**
311          * Grant rate per T.
312          */
313         atomic_t               pl_grant_rate;
314         /**
315          * Cancel rate per T.
316          */
317         atomic_t               pl_cancel_rate;
318         /**
319          * Grant speed (GR-CR) per T.
320          */
321         atomic_t               pl_grant_speed;
322         /**
323          * Server lock volume. Protected by pl_lock.
324          */
325         __u64                  pl_server_lock_volume;
326         /**
327          * Current biggest client lock volume. Protected by pl_lock.
328          */
329         __u64                  pl_client_lock_volume;
330         /**
331          * Lock volume factor. SLV on client is calculated as following:
332          * server_slv * lock_volume_factor.
333          */
334         atomic_t               pl_lock_volume_factor;
335         /**
336          * Time when last slv from server was obtained.
337          */
338         time_t                 pl_recalc_time;
339         /**
340           * Recalc period for pool.
341           */
342         time_t                 pl_recalc_period;
343         /**
344          * Recalc and shrink ops.
345          */
346         struct ldlm_pool_ops  *pl_ops;
347         /**
348          * Number of planned locks for next period.
349          */
350         int                    pl_grant_plan;
351         /**
352          * Pool statistics.
353          */
354         struct lprocfs_stats  *pl_stats;
355 };
356
357 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
358                                void *req_cookie, ldlm_mode_t mode, int flags,
359                                void *data);
360
361 struct ldlm_valblock_ops {
362         int (*lvbo_init)(struct ldlm_resource *res);
363         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
364                            int buf_idx, int increase);
365 };
366
367 typedef enum {
368         LDLM_NAMESPACE_GREEDY = 1 << 0,
369         LDLM_NAMESPACE_MODEST = 1 << 1
370 } ldlm_appetite_t;
371
372 /*
373  * Default values for the "max_nolock_size", "contention_time" and
374  * "contended_locks" namespace tunables.
375  */
376 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
377 #define NS_DEFAULT_CONTENTION_SECONDS 2
378 #define NS_DEFAULT_CONTENDED_LOCKS 32
379
380 struct ldlm_namespace {
381         /**
382          * Namespace name. Used for logging, etc.
383          */
384         char                  *ns_name;
385
386         /**
387          * Is this a client-side lock tree?
388          */
389         ldlm_side_t            ns_client;
390
391         /**
392          * Namespce connect flags supported by server (may be changed via proc,
393          * lru resize may be disabled/enabled).
394          */
395         __u64                  ns_connect_flags;
396
397          /**
398           * Client side orig connect flags supported by server.
399           */
400         __u64                  ns_orig_connect_flags;
401
402         /**
403          * Hash table for namespace.
404          */
405         struct list_head      *ns_hash;
406         spinlock_t             ns_hash_lock;
407
408          /**
409           * Count of resources in the hash.
410           */
411         __u32                  ns_refcount;
412
413          /**
414           * All root resources in namespace.
415           */
416         struct list_head       ns_root_list;
417
418         /**
419          * Position in global namespace list.
420          */
421         struct list_head       ns_list_chain;
422
423         /**
424          * All root resources in namespace.
425          */
426         struct list_head       ns_unused_list;
427         int                    ns_nr_unused;
428         spinlock_t             ns_unused_lock;
429
430         unsigned int           ns_max_unused;
431         unsigned int           ns_max_age;
432         unsigned int           ns_timeouts;
433          /**
434           * Seconds.
435           */
436         unsigned int           ns_ctime_age_limit;
437
438         /**
439          * Next debug dump, jiffies.
440          */
441         cfs_time_t             ns_next_dump;
442
443         atomic_t               ns_locks;
444         __u64                  ns_resources;
445         ldlm_res_policy        ns_policy;
446         struct ldlm_valblock_ops *ns_lvbo;
447         void                  *ns_lvbp;
448         cfs_waitq_t            ns_waitq;
449         struct ldlm_pool       ns_pool;
450         ldlm_appetite_t        ns_appetite;
451
452         /**
453          * If more than @ns_contented_locks found, the resource considered
454          * as contended.
455          */
456         unsigned               ns_contended_locks;
457
458         /**
459          * The resource remembers contended state during @ns_contention_time,
460          * in seconds.
461          */
462         unsigned               ns_contention_time;
463
464         /**
465          * Limit size of nolock requests, in bytes.
466          */
467         unsigned               ns_max_nolock_size;
468
469         /**
470          * Backward link to obd, required for ldlm pool to store new SLV.
471          */
472         struct obd_device     *ns_obd;
473
474         struct adaptive_timeout ns_at_estimate;/* estimated lock callback time*/
475 };
476
477 static inline int ns_is_client(struct ldlm_namespace *ns)
478 {
479         LASSERT(ns != NULL);
480         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
481                                     LDLM_NAMESPACE_SERVER)));
482         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
483                 ns->ns_client == LDLM_NAMESPACE_SERVER);
484         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
485 }
486
487 static inline int ns_is_server(struct ldlm_namespace *ns)
488 {
489         LASSERT(ns != NULL);
490         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
491                                     LDLM_NAMESPACE_SERVER)));
492         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
493                 ns->ns_client == LDLM_NAMESPACE_SERVER);
494         return ns->ns_client == LDLM_NAMESPACE_SERVER;
495 }
496
497 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
498 {
499         LASSERT(ns != NULL);
500         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
501 }
502
503 /*
504  *
505  * Resource hash table
506  *
507  */
508
509 #define RES_HASH_BITS 12
510 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
511 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
512
513 struct ldlm_lock;
514
515 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
516                                       struct ldlm_lock_desc *new, void *data,
517                                       int flag);
518 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
519                                         void *data);
520 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
521 typedef unsigned long (*ldlm_weigh_callback)(struct ldlm_lock *lock);
522
523 /* Interval node data for each LDLM_EXTENT lock */
524 struct ldlm_interval {
525         struct interval_node li_node;   /* node for tree mgmt */
526         struct list_head     li_group;  /* the locks which have the same
527                                          * policy - group of the policy */
528 };
529 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
530
531 /* the interval tree must be accessed inside the resource lock. */
532 struct ldlm_interval_tree {
533         /* tree size, this variable is used to count
534          * granted PW locks in ldlm_extent_policy()*/
535         int                   lit_size;
536         ldlm_mode_t           lit_mode; /* lock mode */
537         struct interval_node *lit_root; /* actually ldlm_interval */
538 };
539
540 struct ldlm_lock {
541         /**
542          * Must be first in the structure.
543          */
544         struct portals_handle    l_handle;
545         /**
546          * Lock reference count.
547          */
548         atomic_t                 l_refc;
549         /**
550          * Internal spinlock protects l_resource.  we should hold this lock
551          * first before grabbing res_lock.
552          */
553         spinlock_t               l_lock;
554         /**
555          * ldlm_lock_change_resource() can change this.
556          */
557         struct ldlm_resource    *l_resource;
558         /**
559          * Protected by ns_hash_lock. List item for client side lru list.
560          */
561         struct list_head         l_lru;
562         /**
563          * Protected by lr_lock, linkage to resource's lock queues.
564          */
565         struct list_head         l_res_link;
566         /**
567          * Tree node for ldlm_extent.
568          */
569         struct ldlm_interval    *l_tree_node;
570         /**
571          * Protected by per-bucket exp->exp_lock_hash locks. Per export hash
572          * of locks.
573          */
574         struct hlist_node        l_exp_hash;
575         /**
576          * Protected by lr_lock. Requested mode.
577          */
578         ldlm_mode_t              l_req_mode;
579         /**
580          * Granted mode, also protected by lr_lock.
581          */
582         ldlm_mode_t              l_granted_mode;
583         /**
584          * Lock enqueue completion handler.
585          */
586         ldlm_completion_callback l_completion_ast;
587         /**
588          * Lock blocking ast handler.
589          */
590         ldlm_blocking_callback   l_blocking_ast;
591         /**
592          * Lock glimpse handler.
593          */
594         ldlm_glimpse_callback    l_glimpse_ast;
595         ldlm_weigh_callback      l_weigh_ast;
596
597         /**
598          * Lock export.
599          */
600         struct obd_export       *l_export;
601         /**
602          * Lock connection export.
603          */
604         struct obd_export       *l_conn_export;
605
606         /**
607          * Remote lock handle.
608          */
609         struct lustre_handle     l_remote_handle;
610
611         ldlm_policy_data_t       l_policy_data;
612
613         /*
614          * Protected by lr_lock. Various counters: readers, writers, etc.
615          */
616         __u64                 l_flags;
617         __u32                 l_readers;
618         __u32                 l_writers;
619         /*
620          * Set for locks that were removed from class hash table and will be
621          * destroyed when last reference to them is released. Set by
622          * ldlm_lock_destroy_internal().
623          *
624          * Protected by lock and resource locks.
625          */
626         __u8                  l_destroyed;
627
628         /**
629          * If the lock is granted, a process sleeps on this waitq to learn when
630          * it's no longer in use.  If the lock is not granted, a process sleeps
631          * on this waitq to learn when it becomes granted.
632          */
633         cfs_waitq_t           l_waitq;
634
635         struct timeval        l_enqueued_time;
636
637         /**
638          * Jiffies. Should be converted to time if needed.
639          */
640         cfs_time_t            l_last_used;
641
642         struct ldlm_extent    l_req_extent;
643
644         /*
645          * Client-side-only members.
646          */
647
648         /**
649          * Temporary storage for an LVB received during an enqueue operation.
650          */
651         __u32                 l_lvb_len;
652         void                 *l_lvb_data;
653         void                 *l_lvb_swabber;
654
655         void                 *l_ast_data;
656         spinlock_t            l_extents_list_lock;
657         struct list_head      l_extents_list;
658
659         struct list_head      l_cache_locks_list;
660
661         /*
662          * Server-side-only members.
663          */
664
665         /** connection cookie for the client originated the operation. */
666         __u64                 l_client_cookie;
667
668         /**
669          * Protected by elt_lock. Callbacks pending.
670          */
671         struct list_head      l_pending_chain;
672
673         cfs_time_t            l_callback_timeout;
674
675         /**
676          * Pid which created this lock.
677          */
678         __u32                 l_pid;
679
680         /**
681          * For ldlm_add_ast_work_item().
682          */
683         struct list_head      l_bl_ast;
684         /**
685          * For ldlm_add_ast_work_item().
686          */
687         struct list_head      l_cp_ast;
688         /**
689          * For ldlm_add_ast_work_item().
690          */
691         struct list_head      l_rk_ast;
692
693         struct ldlm_lock     *l_blocking_lock;
694         int                   l_bl_ast_run;
695
696         /**
697          * Protected by lr_lock, linkages to "skip lists".
698          */
699         struct list_head      l_sl_mode;
700         struct list_head      l_sl_policy;
701         struct lu_ref         l_reference;
702 };
703
704 struct ldlm_resource {
705         struct ldlm_namespace *lr_namespace;
706
707         /* protected by ns_hash_lock */
708         struct list_head       lr_hash;
709         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
710         struct list_head       lr_children; /* list head for child resources */
711         struct list_head       lr_childof;  /* part of ns_root_list if root res,
712                                              * part of lr_children if child */
713         spinlock_t             lr_lock;
714
715         /* protected by lr_lock */
716         struct list_head       lr_granted;
717         struct list_head       lr_converting;
718         struct list_head       lr_waiting;
719         ldlm_mode_t            lr_most_restr;
720         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
721         struct ldlm_res_id     lr_name;
722         atomic_t               lr_refcount;
723
724         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
725
726         /* Server-side-only lock value block elements */
727         struct semaphore       lr_lvb_sem;
728         __u32                  lr_lvb_len;
729         void                  *lr_lvb_data;
730
731         /* when the resource was considered as contended */
732         cfs_time_t             lr_contention_time;
733         /**
734          * List of references to this resource. For debugging.
735          */
736         struct lu_ref          lr_reference;
737 };
738
739 struct ldlm_ast_work {
740         struct ldlm_lock *w_lock;
741         int               w_blocking;
742         struct ldlm_lock_desc w_desc;
743         struct list_head   w_list;
744         int w_flags;
745         void *w_data;
746         int w_datalen;
747 };
748
749 /* ldlm_enqueue parameters common */
750 struct ldlm_enqueue_info {
751         __u32 ei_type;   /* Type of the lock being enqueued. */
752         __u32 ei_mode;   /* Mode of the lock being enqueued. */
753         void *ei_cb_bl;  /* blocking lock callback */
754         void *ei_cb_cp;  /* lock completion callback */
755         void *ei_cb_gl;  /* lock glimpse callback */
756         void *ei_cb_wg;  /* lock weigh callback */
757         void *ei_cbdata; /* Data to be passed into callbacks. */
758         short ei_async:1; /* async request */
759 };
760
761 extern struct obd_ops ldlm_obd_ops;
762
763 extern char *ldlm_lockname[];
764 extern char *ldlm_typename[];
765 extern char *ldlm_it2str(int it);
766 #ifdef LIBCFS_DEBUG
767 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
768         CHECK_STACK();                                                  \
769                                                                         \
770         if (((level) & D_CANTMASK) != 0 ||                              \
771             ((libcfs_debug & (level)) != 0 &&                           \
772              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
773                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
774                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
775                                     file, func, line);                  \
776                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
777                                  ##a );                                 \
778         }                                                               \
779 } while(0)
780
781 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
782                       struct libcfs_debug_msg_data *data, const char *fmt,
783                       ...)
784         __attribute__ ((format (printf, 4, 5)));
785
786 #define LDLM_ERROR(lock, fmt, a...) do {                                \
787         static cfs_debug_limit_state_t _ldlm_cdls;                      \
788         ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock,                     \
789                         __FILE__, __FUNCTION__, __LINE__,               \
790                         "### " fmt , ##a);                              \
791 } while (0)
792
793 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
794         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
795                         __FILE__, __FUNCTION__, __LINE__,               \
796                          "### " fmt , ##a);                             \
797 } while (0)
798 #else /* !LIBCFS_DEBUG */
799 # define LDLM_DEBUG(lock, fmt, a...) ((void)0)
800 # define LDLM_ERROR(lock, fmt, a...) ((void)0)
801 # define ldlm_lock_debuf(cdls, level, lock, file, func, line, fmt, a...) \
802          ((void)0)
803 #endif
804
805 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
806         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
807
808 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
809                                       int first_enq, ldlm_error_t *err,
810                                       struct list_head *work_list);
811
812 /*
813  * Iterators.
814  */
815
816 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
817 #define LDLM_ITER_STOP     2 /* stop iterating */
818
819 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
820 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
821
822 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
823                           void *closure);
824 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
825                            void *closure);
826 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
827                                ldlm_res_iterator_t iter, void *closure);
828
829 int ldlm_replay_locks(struct obd_import *imp);
830 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
831                            ldlm_iterator_t iter, void *data);
832
833 /* ldlm_flock.c */
834 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
835
836 /* ldlm_extent.c */
837 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
838
839
840 /* ldlm_lockd.c */
841 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
842                              void *data, int flag);
843 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
844 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
845 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
846                         ldlm_blocking_callback, ldlm_glimpse_callback);
847 int ldlm_handle_convert(struct ptlrpc_request *req);
848 int ldlm_handle_cancel(struct ptlrpc_request *req);
849 int ldlm_request_cancel(struct ptlrpc_request *req,
850                         const struct ldlm_request *dlm_req, int first);
851 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
852 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
853 void ldlm_revoke_export_locks(struct obd_export *exp);
854 int ldlm_get_ref(void);
855 void ldlm_put_ref(void);
856 int ldlm_init_export(struct obd_export *exp);
857 void ldlm_destroy_export(struct obd_export *exp);
858
859 /* ldlm_lock.c */
860 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
861 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
862 void ldlm_lock2handle(const struct ldlm_lock *lock,
863                       struct lustre_handle *lockh);
864 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
865 void ldlm_cancel_callback(struct ldlm_lock *);
866 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
867
868 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
869 {
870         return __ldlm_handle2lock(h, 0);
871 }
872
873 #define LDLM_LOCK_REF_DEL(lock) \
874         lu_ref_del(&lock->l_reference, "handle", cfs_current())
875
876 static inline struct ldlm_lock *
877 ldlm_handle2lock_long(const struct lustre_handle *h, int flags)
878 {
879         struct ldlm_lock *lock;
880
881         lock = __ldlm_handle2lock(h, flags);
882         if (lock != NULL)
883                 LDLM_LOCK_REF_DEL(lock);
884         return lock;
885 }
886
887 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
888                                        struct lustre_msg *m, int buf_idx,
889                                        int increase)
890 {
891         if (res->lr_namespace->ns_lvbo &&
892             res->lr_namespace->ns_lvbo->lvbo_update) {
893                 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
894                                                                increase);
895         }
896         return 0;
897 }
898
899 int ldlm_error2errno(ldlm_error_t error);
900 ldlm_error_t ldlm_errno2error(int err_no); /* don't call it `errno': this
901                                             * confuses user-space. */
902
903 /**
904  * Release a temporary lock reference obtained by ldlm_handle2lock() or
905  * __ldlm_handle2lock().
906  */
907 #define LDLM_LOCK_PUT(lock)                     \
908 do {                                            \
909         LDLM_LOCK_REF_DEL(lock);                \
910         /*LDLM_DEBUG((lock), "put");*/          \
911         ldlm_lock_put(lock);                    \
912 } while (0)
913
914 /**
915  * Release a lock reference obtained by some other means (see
916  * LDLM_LOCK_PUT()).
917  */
918 #define LDLM_LOCK_RELEASE(lock)                 \
919 do {                                            \
920         /*LDLM_DEBUG((lock), "put");*/          \
921         ldlm_lock_put(lock);                    \
922 } while (0)
923
924 #define LDLM_LOCK_GET(lock)                     \
925 ({                                              \
926         ldlm_lock_get(lock);                    \
927         /*LDLM_DEBUG((lock), "get");*/          \
928         lock;                                   \
929 })
930
931 #define ldlm_lock_list_put(head, member, count)                 \
932 ({                                                              \
933         struct ldlm_lock *_lock, *_next;                        \
934         int c = count;                                          \
935         list_for_each_entry_safe(_lock, _next, head, member) {  \
936                 if (c-- == 0)                                   \
937                         break;                                  \
938                 list_del_init(&_lock->member);                  \
939                 LDLM_LOCK_RELEASE(_lock);                       \
940         }                                                       \
941         LASSERT(c <= 0);                                        \
942 })
943
944 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
945 void ldlm_lock_put(struct ldlm_lock *lock);
946 void ldlm_lock_destroy(struct ldlm_lock *lock);
947 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
948 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
949 int  ldlm_lock_addref_try(struct lustre_handle *lockh, __u32 mode);
950 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
951 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
952 void ldlm_lock_allow_match(struct ldlm_lock *lock);
953 void ldlm_lock_allow_match_locked(struct ldlm_lock *lock);
954 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
955                             const struct ldlm_res_id *, ldlm_type_t type,
956                             ldlm_policy_data_t *, ldlm_mode_t mode,
957                             struct lustre_handle *, int unref);
958 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
959                                         __u32 *flags);
960 void ldlm_lock_downgrade(struct ldlm_lock *lock, int new_mode);
961 void ldlm_lock_cancel(struct ldlm_lock *lock);
962 void ldlm_cancel_locks_for_export(struct obd_export *export);
963 void ldlm_reprocess_all(struct ldlm_resource *res);
964 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
965 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
966 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
967 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
968
969 /* resource.c */
970 struct ldlm_namespace *
971 ldlm_namespace_new(struct obd_device *obd, char *name,
972                    ldlm_side_t client, ldlm_appetite_t apt);
973 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
974 void ldlm_namespace_free(struct ldlm_namespace *ns,
975                          struct obd_import *imp, int force);
976 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
977 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
978 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
979 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
980 void ldlm_namespace_get_locked(struct ldlm_namespace *ns);
981 void ldlm_namespace_put_locked(struct ldlm_namespace *ns, int wakeup);
982 void ldlm_namespace_get(struct ldlm_namespace *ns);
983 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
984 int ldlm_proc_setup(void);
985 #ifdef LPROCFS
986 void ldlm_proc_cleanup(void);
987 #else
988 static inline void ldlm_proc_cleanup(void) {}
989 #endif
990
991 /* resource.c - internal */
992 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
993                                         struct ldlm_resource *parent,
994                                         const struct ldlm_res_id *,
995                                         ldlm_type_t type, int create);
996 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
997 int ldlm_resource_putref(struct ldlm_resource *res);
998 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
999                             struct ldlm_lock *lock);
1000 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
1001 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
1002 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
1003 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
1004 void ldlm_resource_dump(int level, struct ldlm_resource *);
1005 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
1006                               const struct ldlm_res_id *);
1007
1008 #define LDLM_RESOURCE_ADDREF(res) do {                                  \
1009         lu_ref_add_atomic(&(res)->lr_reference, __FUNCTION__, cfs_current());  \
1010 } while (0)
1011
1012 #define LDLM_RESOURCE_DELREF(res) do {                                  \
1013         lu_ref_del(&(res)->lr_reference, __FUNCTION__, cfs_current());  \
1014 } while (0)
1015
1016 struct ldlm_callback_suite {
1017         ldlm_completion_callback lcs_completion;
1018         ldlm_blocking_callback   lcs_blocking;
1019         ldlm_glimpse_callback    lcs_glimpse;
1020         ldlm_weigh_callback      lcs_weigh;
1021 };
1022
1023 /* ldlm_request.c */
1024 int ldlm_expired_completion_wait(void *data);
1025 int ldlm_blocking_ast_nocheck(struct ldlm_lock *lock);
1026 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
1027                       void *data, int flag);
1028 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
1029 int ldlm_completion_ast_async(struct ldlm_lock *lock, int flags, void *data);
1030 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
1031 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
1032                      struct ldlm_enqueue_info *einfo,
1033                      const struct ldlm_res_id *res_id,
1034                      ldlm_policy_data_t *policy, int *flags,
1035                      void *lvb, __u32 lvb_len, void *lvb_swabber,
1036                      struct lustre_handle *lockh, int async);
1037 int ldlm_prep_enqueue_req(struct obd_export *exp,
1038                           struct ptlrpc_request *req,
1039                           struct list_head *cancels,
1040                           int count);
1041 int ldlm_prep_elc_req(struct obd_export *exp,
1042                       struct ptlrpc_request *req,
1043                       int version, int opc, int canceloff,
1044                       struct list_head *cancels, int count);
1045 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
1046                          const struct ldlm_request *dlm_req,
1047                          const struct ldlm_callback_suite *cbs);
1048 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
1049                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
1050                           int *flags, void *lvb, __u32 lvb_len,
1051                           void *lvb_swabber, struct lustre_handle *lockh,
1052                           int rc);
1053 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
1054                            const struct ldlm_res_id *res_id,
1055                            ldlm_type_t type, ldlm_policy_data_t *policy,
1056                            ldlm_mode_t mode, int *flags,
1057                            ldlm_blocking_callback blocking,
1058                            ldlm_completion_callback completion,
1059                            ldlm_glimpse_callback glimpse,
1060                            void *data, __u32 lvb_len, void *lvb_swabber,
1061                            const __u64 *client_cookie,
1062                            struct lustre_handle *lockh);
1063 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
1064                     void *data, __u32 data_len);
1065 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
1066 int ldlm_cli_update_pool(struct ptlrpc_request *req);
1067 int ldlm_handle_convert0(struct ptlrpc_request *req,
1068                          const struct ldlm_request *dlm_req);
1069 int ldlm_cli_cancel(struct lustre_handle *lockh);
1070 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
1071                            int flags, void *opaque);
1072 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
1073                                     const struct ldlm_res_id *res_id,
1074                                     ldlm_policy_data_t *policy,
1075                                     ldlm_mode_t mode, int flags, void *opaque);
1076 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
1077                         int count, int flags);
1078 int ldlm_cancel_resource_local(struct ldlm_resource *res,
1079                                struct list_head *cancels,
1080                                ldlm_policy_data_t *policy,
1081                                ldlm_mode_t mode, int lock_flags,
1082                                int cancel_flags, void *opaque);
1083 int ldlm_cli_cancel_list(struct list_head *head, int count,
1084                          struct ptlrpc_request *req, int flags);
1085
1086 /* mds/handler.c */
1087 /* This has to be here because recursive inclusion sucks. */
1088 int intent_disposition(struct ldlm_reply *rep, int flag);
1089 void intent_set_disposition(struct ldlm_reply *rep, int flag);
1090
1091
1092 /* ioctls for trying requests */
1093 #define IOC_LDLM_TYPE                   'f'
1094 #define IOC_LDLM_MIN_NR                 40
1095
1096 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
1097 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
1098 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
1099 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
1100 #define IOC_LDLM_MAX_NR                 43
1101
1102 /**
1103  * "Modes" of acquiring lock_res, necessary to tell lockdep that taking more
1104  * than one lock_res is dead-lock safe.
1105  */
1106 enum lock_res_type {
1107         LRT_NORMAL,
1108         LRT_NEW
1109 };
1110
1111 static inline void lock_res(struct ldlm_resource *res)
1112 {
1113         spin_lock(&res->lr_lock);
1114 }
1115
1116 static inline void lock_res_nested(struct ldlm_resource *res,
1117                                    enum lock_res_type mode)
1118 {
1119         spin_lock_nested(&res->lr_lock, mode);
1120 }
1121
1122
1123 static inline void unlock_res(struct ldlm_resource *res)
1124 {
1125         spin_unlock(&res->lr_lock);
1126 }
1127
1128 static inline void check_res_locked(struct ldlm_resource *res)
1129 {
1130         LASSERT_SPIN_LOCKED(&res->lr_lock);
1131 }
1132
1133 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
1134 void unlock_res_and_lock(struct ldlm_lock *lock);
1135
1136 /* ldlm_pool.c */
1137 void ldlm_pools_recalc(ldlm_side_t client);
1138 int ldlm_pools_init(void);
1139 void ldlm_pools_fini(void);
1140
1141 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
1142                    int idx, ldlm_side_t client);
1143 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
1144                      unsigned int gfp_mask);
1145 void ldlm_pool_fini(struct ldlm_pool *pl);
1146 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
1147 int ldlm_pool_recalc(struct ldlm_pool *pl);
1148 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
1149 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
1150 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
1151 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
1152 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
1153 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
1154 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
1155 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
1156 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
1157 #endif