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