Whamcloud - gitweb
3939a23a4093aaabd896ba46fa6a876cf56c5394
[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
57 struct obd_ops;
58 struct obd_device;
59
60 #define OBD_LDLM_DEVICENAME  "ldlm"
61
62 #ifdef HAVE_BGL_SUPPORT
63 /* 1.5 times the maximum 128 tasks available in VN mode */
64 #define LDLM_DEFAULT_LRU_SIZE 196
65 #else
66 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
67 #endif
68 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
69
70 typedef enum {
71         ELDLM_OK = 0,
72
73         ELDLM_LOCK_CHANGED = 300,
74         ELDLM_LOCK_ABORTED = 301,
75         ELDLM_LOCK_REPLACED = 302,
76         ELDLM_NO_LOCK_DATA = 303,
77
78         ELDLM_NAMESPACE_EXISTS = 400,
79         ELDLM_BAD_NAMESPACE    = 401
80 } ldlm_error_t;
81
82 typedef enum {
83         LDLM_NAMESPACE_SERVER = 1 << 0,
84         LDLM_NAMESPACE_CLIENT = 1 << 1
85 } ldlm_side_t;
86
87 #define LDLM_FL_LOCK_CHANGED   0x000001 /* extent, mode, or resource changed */
88
89 /* If the server returns one of these flags, then the lock was put on that list.
90  * If the client sends one of these flags (during recovery ONLY!), it wants the
91  * lock added to the specified list, no questions asked. -p */
92 #define LDLM_FL_BLOCK_GRANTED  0x000002
93 #define LDLM_FL_BLOCK_CONV     0x000004
94 #define LDLM_FL_BLOCK_WAIT     0x000008
95
96 #define LDLM_FL_CBPENDING      0x000010 /* this lock is being destroyed */
97 #define LDLM_FL_AST_SENT       0x000020 /* blocking or cancel packet was sent */
98 #define LDLM_FL_WAIT_NOREPROC  0x000040 /* not a real flag, not saved in lock */
99 #define LDLM_FL_CANCEL         0x000080 /* cancellation callback already run */
100
101 /* Lock is being replayed.  This could probably be implied by the fact that one
102  * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
103 #define LDLM_FL_REPLAY         0x000100
104
105 #define LDLM_FL_INTENT_ONLY    0x000200 /* don't grant lock, just do intent */
106 #define LDLM_FL_LOCAL_ONLY     0x000400 /* see ldlm_cli_cancel_unused */
107
108 /* don't run the cancel callback under ldlm_cli_cancel_unused */
109 #define LDLM_FL_FAILED         0x000800
110
111 #define LDLM_FL_HAS_INTENT     0x001000 /* lock request has intent */
112 #define LDLM_FL_CANCELING      0x002000 /* lock cancel has already been sent */
113 #define LDLM_FL_LOCAL          0x004000 /* local lock (ie, no srv/cli split) */
114 #define LDLM_FL_WARN           0x008000 /* see ldlm_cli_cancel_unused */
115 #define LDLM_FL_DISCARD_DATA   0x010000 /* discard (no writeback) on cancel */
116
117 #define LDLM_FL_NO_TIMEOUT     0x020000 /* Blocked by group lock - wait
118                                          * indefinitely */
119
120 /* file & record locking */
121 #define LDLM_FL_BLOCK_NOWAIT   0x040000 // server told not to wait if blocked
122 #define LDLM_FL_TEST_LOCK      0x080000 // return blocking lock
123
124 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
125  * the LVB filling happens _after_ the lock has been granted, so another thread
126  * can match`t before the LVB has been updated.  As a dirty hack, we set
127  * LDLM_FL_LVB_READY only after we've done the LVB poop.
128  * this is only needed on lov/osc now, where lvb is actually used and callers
129  * must set it in input flags.
130  *
131  * The proper fix is to do the granting inside of the completion AST, which can
132  * be replaced with a LVB-aware wrapping function for OSC locks.  That change is
133  * pretty high-risk, though, and would need a lot more testing. */
134
135 #define LDLM_FL_LVB_READY      0x100000
136
137 /* A lock contributes to the kms calculation until it has finished the part
138  * of it's cancelation that performs write back on its dirty pages.  It
139  * can remain on the granted list during this whole time.  Threads racing
140  * to update the kms after performing their writeback need to know to
141  * exclude each others locks from the calculation as they walk the granted
142  * list. */
143 #define LDLM_FL_KMS_IGNORE     0x200000
144
145 /* Don't drop lock covering mmapped file in LRU */
146 #define LDLM_FL_NO_LRU         0x400000
147
148 /* Immediatelly cancel such locks when they block some other locks. Send
149    cancel notification to original lock holder, but expect no reply. */
150 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
151
152 /* Flags flags inherited from parent lock when doing intents. */
153 #define LDLM_INHERIT_FLAGS     (LDLM_FL_CANCEL_ON_BLOCK)
154
155 /* completion ast to be executed */
156 #define LDLM_FL_CP_REQD        0x1000000
157
158 /* cleanup_resource has already handled the lock */
159 #define LDLM_FL_CLEANED        0x2000000
160
161 /* optimization hint: LDLM can run blocking callback from current context
162  * w/o involving separate thread. in order to decrease cs rate */
163 #define LDLM_FL_ATOMIC_CB      0x4000000
164
165 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
166  * such that server send blocking ast for conflict locks to this client for
167  * the 1st operation, whereas the 2nd operation has canceled this lock and
168  * is waiting for rpc_lock which is taken by the 1st operation.
169  * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
170  * ELC code to cancel it.
171  * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
172  * droped to let ldlm_callback_handler() return EINVAL to the server. It is
173  * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
174  * to send a separate CANCEL rpc. */
175 #define LDLM_FL_BL_AST          0x10000000
176 #define LDLM_FL_BL_DONE         0x20000000
177
178 /* measure lock contention and return -EUSERS if locking contention is high */
179 #define LDLM_FL_DENY_ON_CONTENTION 0x40000000
180
181 /* These are flags that are mapped into the flags and ASTs of blocking locks */
182 #define LDLM_AST_DISCARD_DATA  0x80000000 /* Add FL_DISCARD to blocking ASTs */
183
184 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
185 #define LDLM_AST_FLAGS         (LDLM_FL_DISCARD_DATA)
186
187 /*
188  * --------------------------------------------------------------------------
189  * NOTE! Starting from this point, that is, LDLM_FL_* flags with values above
190  * 0x80000000 will not be sent over the wire.
191  * --------------------------------------------------------------------------
192  */
193
194 /* Used for marking lock as an target for -EINTR while cp_ast sleep
195  * emulation + race with upcoming bl_ast.  */
196 #define LDLM_FL_FAIL_LOC       0x100000000ULL
197
198 /* Used while processing the unused list to know that we have already
199  * handled this lock and decided to skip it */
200 #define LDLM_FL_SKIPPED        0x200000000ULL
201
202 /* The blocking callback is overloaded to perform two functions.  These flags
203  * indicate which operation should be performed. */
204 #define LDLM_CB_BLOCKING    1
205 #define LDLM_CB_CANCELING   2
206
207 /* compatibility matrix */
208 #define LCK_COMPAT_EX  LCK_NL
209 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
210 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
211 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
212 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
213 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
214 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
215
216 extern ldlm_mode_t lck_compat_array[];
217
218 static inline void lockmode_verify(ldlm_mode_t mode)
219 {
220        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
221 }
222
223 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
224 {
225        return (lck_compat_array[exist] & new);
226 }
227
228 /*
229  *
230  * cluster name spaces
231  *
232  */
233
234 #define DLM_OST_NAMESPACE 1
235 #define DLM_MDS_NAMESPACE 2
236
237 /* XXX
238    - do we just separate this by security domains and use a prefix for
239      multiple namespaces in the same domain?
240    -
241 */
242
243 /*
244  * Locking rules:
245  *
246  * lr_lock
247  *
248  * lr_lock
249  *     waiting_locks_spinlock
250  *
251  * lr_lock
252  *     led_lock
253  *
254  * lr_lock
255  *     ns_unused_lock
256  *
257  * lr_lvb_sem
258  *     lr_lock
259  *
260  */
261
262 struct ldlm_pool;
263 struct ldlm_lock;
264 struct ldlm_resource;
265 struct ldlm_namespace;
266
267 struct ldlm_pool_ops {
268         int (*po_recalc)(struct ldlm_pool *pl);
269         int (*po_shrink)(struct ldlm_pool *pl, int nr,
270                          unsigned int gfp_mask);
271         int (*po_setup)(struct ldlm_pool *pl, int limit);
272 };
273
274 /**
275  * One second for pools thread check interval. Each pool has own period.
276  */
277 #define LDLM_POOLS_THREAD_PERIOD (1)
278
279 /**
280  * ~6% margin for modest pools. See ldlm_pool.c for details.
281  */
282 #define LDLM_POOLS_MODEST_MARGIN_SHIFT (4)
283
284 /**
285  * Default recalc period for server side pools in sec.
286  */
287 #define LDLM_POOL_SRV_DEF_RECALC_PERIOD (1)
288
289 /**
290  * Default recalc period for client side pools in sec.
291  */
292 #define LDLM_POOL_CLI_DEF_RECALC_PERIOD (10)
293
294 struct ldlm_pool {
295         /**
296          * Pool proc directory.
297          */
298         cfs_proc_dir_entry_t  *pl_proc_dir;
299         /**
300          * Pool name, should be long enough to contain compound proc entry name.
301          */
302         char                   pl_name[100];
303         /**
304          * Lock for protecting slv/clv updates.
305          */
306         spinlock_t             pl_lock;
307         /**
308          * Number of allowed locks in in pool, both, client and server side.
309          */
310         atomic_t               pl_limit;
311         /**
312          * Number of granted locks in
313          */
314         atomic_t               pl_granted;
315         /**
316          * Grant rate per T.
317          */
318         atomic_t               pl_grant_rate;
319         /**
320          * Cancel rate per T.
321          */
322         atomic_t               pl_cancel_rate;
323         /**
324          * Grant speed (GR-CR) per T.
325          */
326         atomic_t               pl_grant_speed;
327         /**
328          * Server lock volume. Protected by pl_lock.
329          */
330         __u64                  pl_server_lock_volume;
331         /**
332          * Current biggest client lock volume. Protected by pl_lock.
333          */
334         __u64                  pl_client_lock_volume;
335         /**
336          * Lock volume factor. SLV on client is calculated as following:
337          * server_slv * lock_volume_factor.
338          */
339         atomic_t               pl_lock_volume_factor;
340         /**
341          * Time when last slv from server was obtained.
342          */
343         time_t                 pl_recalc_time;
344         /**
345           * Recalc period for pool.
346           */
347         time_t                 pl_recalc_period;
348         /**
349          * Recalc and shrink ops.
350          */
351         struct ldlm_pool_ops  *pl_ops;
352         /**
353          * Number of planned locks for next period.
354          */
355         int                    pl_grant_plan;
356         /**
357          * Pool statistics.
358          */
359         struct lprocfs_stats  *pl_stats;
360 };
361 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
362                                void *req_cookie, ldlm_mode_t mode, int flags,
363                                void *data);
364
365 typedef int (*ldlm_cancel_for_recovery)(struct ldlm_lock *lock);
366
367 struct ldlm_valblock_ops {
368         int (*lvbo_init)(struct ldlm_resource *res);
369         int (*lvbo_update)(struct ldlm_resource *res, struct ptlrpc_request *r,
370                            int buf_idx, int increase);
371 };
372
373 typedef enum {
374         LDLM_NAMESPACE_GREEDY = 1 << 0,
375         LDLM_NAMESPACE_MODEST = 1 << 1
376 } ldlm_appetite_t;
377
378 /* default values for the "max_nolock_size", "contention_time"
379  * and "contended_locks" namespace tunables */
380 #define NS_DEFAULT_MAX_NOLOCK_BYTES 0
381 #define NS_DEFAULT_CONTENTION_SECONDS 2
382 #define NS_DEFAULT_CONTENDED_LOCKS 32
383
384 struct ldlm_namespace {
385         char                  *ns_name;
386         ldlm_side_t            ns_client; /* is this a client-side lock tree? */
387         __u64                  ns_connect_flags; /* ns connect flags supported
388                                            * by server (may be changed via proc,
389                                            * lru resize may be disabled/enabled) */
390         __u64                  ns_orig_connect_flags; /* client side orig connect
391                                            * flags supported by server */
392         struct list_head      *ns_hash;   /* hash table for ns */
393         spinlock_t             ns_hash_lock;
394         __u32                  ns_refcount; /* count of resources in the hash */
395         struct list_head       ns_root_list; /* all root resources in ns */
396         struct list_head       ns_list_chain; /* position in global NS list */
397
398         struct list_head       ns_unused_list; /* all root resources in ns */
399         int                    ns_nr_unused;
400         spinlock_t             ns_unused_lock;
401
402         unsigned int           ns_max_unused;
403         unsigned int           ns_max_age;
404         unsigned int           ns_timeouts;
405
406         cfs_time_t             ns_next_dump;   /* next debug dump, jiffies */
407
408         atomic_t               ns_locks;
409         __u64                  ns_resources;
410         ldlm_res_policy        ns_policy;
411         struct ldlm_valblock_ops *ns_lvbo;
412         void                  *ns_lvbp;
413         cfs_waitq_t            ns_waitq;
414         struct ldlm_pool       ns_pool;
415         ldlm_appetite_t        ns_appetite;
416
417         /* if more than @ns_contented_locks found, the resource considered
418          * as contended */
419         unsigned               ns_contended_locks;
420         /* the resource remembers contended state during @ns_contention_time,
421          * in seconds */
422         unsigned               ns_contention_time;
423         /* limit size of nolock requests, in bytes */
424         unsigned               ns_max_nolock_size;
425
426         struct adaptive_timeout ns_at_estimate;/* estimated lock callback time*/
427         /* backward link to obd, required for ldlm pool to store new SLV. */
428         struct obd_device     *ns_obd;
429
430         /* callback to cancel locks before replaying it during recovery */
431         ldlm_cancel_for_recovery ns_cancel_for_recovery;
432 };
433
434 static inline int ns_is_client(struct ldlm_namespace *ns)
435 {
436         LASSERT(ns != NULL);
437         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
438                                     LDLM_NAMESPACE_SERVER)));
439         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
440                 ns->ns_client == LDLM_NAMESPACE_SERVER);
441         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
442 }
443
444 static inline int ns_is_server(struct ldlm_namespace *ns)
445 {
446         LASSERT(ns != NULL);
447         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT |
448                                     LDLM_NAMESPACE_SERVER)));
449         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
450                 ns->ns_client == LDLM_NAMESPACE_SERVER);
451         return ns->ns_client == LDLM_NAMESPACE_SERVER;
452 }
453
454 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
455 {
456         LASSERT(ns != NULL);
457         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
458 }
459
460 static inline void ns_register_cancel(struct ldlm_namespace *ns,
461                                       ldlm_cancel_for_recovery arg)
462 {
463         LASSERT(ns != NULL);
464         ns->ns_cancel_for_recovery = arg;
465 }
466 /*
467  *
468  * Resource hash table
469  *
470  */
471
472 #define RES_HASH_BITS 12
473 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
474 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
475
476 struct ldlm_lock;
477
478 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
479                                       struct ldlm_lock_desc *new, void *data,
480                                       int flag);
481 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
482                                         void *data);
483 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
484
485 /* Interval node data for each LDLM_EXTENT lock */
486 struct ldlm_interval {
487         struct interval_node li_node;   /* node for tree mgmt */
488         struct list_head     li_group;  /* the locks which have the same
489                                          * policy - group of the policy */
490 };
491 #define to_ldlm_interval(n) container_of(n, struct ldlm_interval, li_node)
492
493 /* the interval tree must be accessed inside the resource lock. */
494 struct ldlm_interval_tree {
495         /* tree size, this variable is used to count
496          * granted PW locks in ldlm_extent_policy()*/
497         int                   lit_size;
498         ldlm_mode_t           lit_mode; /* lock mode */
499         struct interval_node *lit_root; /* actually ldlm_interval */
500 };
501
502 struct ldlm_lock {
503         struct portals_handle l_handle; // must be first in the structure
504         atomic_t              l_refc;
505
506         /* internal spinlock protects l_resource.  we should hold this lock
507          * first before grabbing res_lock.*/
508         spinlock_t            l_lock;
509
510         /* ldlm_lock_change_resource() can change this */
511         struct ldlm_resource *l_resource;
512
513         /* protected by ns_hash_lock. FIXME */
514         struct list_head      l_lru;
515
516         /* protected by lr_lock, linkage to resource's lock queues */
517         struct list_head      l_res_link;
518
519         struct ldlm_interval *l_tree_node;      /* tree node for ldlm_extent */
520
521         /* protected by per-bucket exp->exp_lock_hash locks */
522         struct hlist_node     l_exp_hash;       /* per export hash of locks */
523
524         /* protected by lr_lock */
525         ldlm_mode_t           l_req_mode;
526         ldlm_mode_t           l_granted_mode;
527
528         ldlm_completion_callback l_completion_ast;
529         ldlm_blocking_callback   l_blocking_ast;
530         ldlm_glimpse_callback    l_glimpse_ast;
531
532         struct obd_export    *l_export;
533         struct obd_export    *l_conn_export;
534
535         struct lustre_handle  l_remote_handle;
536         ldlm_policy_data_t    l_policy_data;
537
538         /* protected by lr_lock */
539         __u64                 l_flags;
540         __u32                 l_readers;
541         __u32                 l_writers;
542         __u8                  l_destroyed;
543
544         /* If the lock is granted, a process sleeps on this waitq to learn when
545          * it's no longer in use.  If the lock is not granted, a process sleeps
546          * on this waitq to learn when it becomes granted. */
547         cfs_waitq_t           l_waitq;
548
549         cfs_time_t            l_last_activity;  /* seconds */
550         cfs_time_t            l_last_used;      /* jiffies */
551         struct ldlm_extent    l_req_extent;
552
553         /* Client-side-only members */
554         __u32                 l_lvb_len;        /* temporary storage for */
555         void                 *l_lvb_data;       /* an LVB received during */
556         void                 *l_lvb_swabber;    /* an enqueue */
557         void                 *l_ast_data;
558         spinlock_t            l_extents_list_lock;
559         struct list_head      l_extents_list;
560
561         struct list_head      l_cache_locks_list;
562
563         /* Server-side-only members */
564
565         /* protected by elt_lock */
566         struct list_head      l_pending_chain;  /* callbacks pending */
567         cfs_time_t            l_callback_timeout; /* jiffies */
568
569         __u32                 l_pid;            /* pid which created this lock */
570
571         /* for ldlm_add_ast_work_item() */
572         struct list_head      l_bl_ast;
573         struct list_head      l_cp_ast;
574         struct ldlm_lock     *l_blocking_lock;
575         int                   l_bl_ast_run;
576
577         /* protected by lr_lock, linkages to "skip lists" */
578         struct list_head      l_sl_mode;
579         struct list_head      l_sl_policy;
580 };
581
582 struct ldlm_resource {
583         struct ldlm_namespace *lr_namespace;
584
585         /* protected by ns_hash_lock */
586         struct list_head       lr_hash;
587         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
588         struct list_head       lr_children; /* list head for child resources */
589         struct list_head       lr_childof;  /* part of ns_root_list if root res,
590                                              * part of lr_children if child */
591         spinlock_t             lr_lock;
592
593         /* protected by lr_lock */
594         struct list_head       lr_granted;
595         struct list_head       lr_converting;
596         struct list_head       lr_waiting;
597         ldlm_mode_t            lr_most_restr;
598         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
599         struct ldlm_res_id     lr_name;
600         atomic_t               lr_refcount;
601
602         struct ldlm_interval_tree lr_itree[LCK_MODE_NUM];  /* interval trees*/
603
604         /* Server-side-only lock value block elements */
605         struct semaphore       lr_lvb_sem;
606         __u32                  lr_lvb_len;
607         void                  *lr_lvb_data;
608
609         /* when the resource was considered as contended */
610         cfs_time_t             lr_contention_time;
611 };
612
613 struct ldlm_ast_work {
614         struct ldlm_lock *w_lock;
615         int               w_blocking;
616         struct ldlm_lock_desc w_desc;
617         struct list_head   w_list;
618         int w_flags;
619         void *w_data;
620         int w_datalen;
621 };
622
623 /* ldlm_enqueue parameters common */
624 struct ldlm_enqueue_info {
625         __u32 ei_type;   /* Type of the lock being enqueued. */
626         __u32 ei_mode;   /* Mode of the lock being enqueued. */
627         void *ei_cb_bl;  /* Different callbacks for lock handling (blocking, */
628         void *ei_cb_cp;  /* completion, glimpse) */
629         void *ei_cb_gl;
630         void *ei_cbdata; /* Data to be passed into callbacks. */
631 };
632
633 extern struct obd_ops ldlm_obd_ops;
634
635 extern char *ldlm_lockname[];
636 extern char *ldlm_typename[];
637 extern char *ldlm_it2str(int it);
638
639 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do {  \
640         CHECK_STACK();                                                  \
641                                                                         \
642         if (((level) & D_CANTMASK) != 0 ||                              \
643             ((libcfs_debug & (level)) != 0 &&                           \
644              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
645                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
646                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
647                                     file, func, line);                  \
648                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
649                                  ##a );                                 \
650         }                                                               \
651 } while(0)
652
653 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
654                       struct libcfs_debug_msg_data *data, const char *fmt,
655                       ...)
656         __attribute__ ((format (printf, 4, 5)));
657
658 #define LDLM_DEBUG_LIMIT(mask, lock, fmt, a...) do {                     \
659         static cfs_debug_limit_state_t _ldlm_cdls;                       \
660         ldlm_lock_debug(&_ldlm_cdls, mask, lock,                         \
661                         __FILE__, __FUNCTION__, __LINE__,                \
662                         "### " fmt , ##a);                               \
663 } while (0)
664
665 #define LDLM_ERROR(lock, fmt, a...) LDLM_DEBUG_LIMIT(D_ERROR, lock, fmt, ## a)
666 #define LDLM_WARN(lock, fmt, a...)  LDLM_DEBUG_LIMIT(D_WARNING, lock, fmt, ## a)
667
668 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
669         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
670                         __FILE__, __FUNCTION__, __LINE__,               \
671                          "### " fmt , ##a);                             \
672 } while (0)
673
674 #define LDLM_DEBUG_NOLOCK(format, a...)                                 \
675         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
676
677 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
678                                       int first_enq, ldlm_error_t *err,
679                                       struct list_head *work_list);
680
681 /*
682  * Iterators.
683  */
684
685 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
686 #define LDLM_ITER_STOP     2 /* stop iterating */
687
688 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
689 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
690
691 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
692                           void *closure);
693 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
694                            void *closure);
695 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
696                                ldlm_res_iterator_t iter, void *closure);
697
698 int ldlm_replay_locks(struct obd_import *imp);
699 int ldlm_resource_iterate(struct ldlm_namespace *, struct ldlm_res_id *,
700                           ldlm_iterator_t iter, void *data);
701
702 /* ldlm_flock.c */
703 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
704
705 /* ldlm_extent.c */
706 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
707
708
709 /* ldlm_lockd.c */
710 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
711                              void *data, int flag);
712 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
713 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
714 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
715                         ldlm_blocking_callback, ldlm_glimpse_callback);
716 int ldlm_handle_convert(struct ptlrpc_request *req);
717 int ldlm_handle_cancel(struct ptlrpc_request *req);
718 int ldlm_request_cancel(struct ptlrpc_request *req,
719                         struct ldlm_request *dlm_req, int first);
720 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
721 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock, int timeout);
722 int ldlm_get_ref(void);
723 void ldlm_put_ref(void);
724 int ldlm_init_export(struct obd_export *exp);
725 void ldlm_destroy_export(struct obd_export *exp);
726
727 /* ldlm_lock.c */
728 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
729 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
730 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
731 struct ldlm_lock *__ldlm_handle2lock(struct lustre_handle *, int flags);
732 void ldlm_cancel_callback(struct ldlm_lock *);
733 int ldlm_lock_set_data(struct lustre_handle *, void *data);
734 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
735 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
736                                       struct lustre_handle *);
737
738 static inline struct ldlm_lock *ldlm_handle2lock(struct lustre_handle *h)
739 {
740         return __ldlm_handle2lock(h, 0);
741 }
742
743 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
744                                        struct ptlrpc_request *r, int buf_idx,
745                                        int increase)
746 {
747         if (res->lr_namespace->ns_lvbo &&
748             res->lr_namespace->ns_lvbo->lvbo_update) {
749                 return res->lr_namespace->ns_lvbo->lvbo_update(res, r, buf_idx,
750                                                                increase);
751         }
752         return 0;
753 }
754
755 #define LDLM_LOCK_PUT(lock)                     \
756 do {                                            \
757         /*LDLM_DEBUG((lock), "put");*/          \
758         ldlm_lock_put(lock);                    \
759 } while (0)
760
761 #define LDLM_LOCK_GET(lock)                     \
762 ({                                              \
763         ldlm_lock_get(lock);                    \
764         /*LDLM_DEBUG((lock), "get");*/          \
765         lock;                                   \
766 })
767
768 #define ldlm_lock_list_put(head, member, count)                 \
769 ({                                                              \
770         struct ldlm_lock *_lock, *_next;                        \
771         int c = count;                                          \
772         list_for_each_entry_safe(_lock, _next, head, member) {  \
773                 if (c-- == 0)                                   \
774                         break;                                  \
775                 list_del_init(&_lock->member);                  \
776                 LDLM_LOCK_PUT(_lock);                           \
777         }                                                       \
778         LASSERT(c <= 0);                                       \
779 })
780
781 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
782 void ldlm_lock_put(struct ldlm_lock *lock);
783 void ldlm_lock_destroy(struct ldlm_lock *lock);
784 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
785 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
786 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
787 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
788 void ldlm_lock_allow_match(struct ldlm_lock *lock);
789 int ldlm_lock_fast_match(struct ldlm_lock *, int, obd_off, obd_off,
790                          struct lustre_handle *);
791 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
792                             struct ldlm_res_id *, ldlm_type_t type,
793                             ldlm_policy_data_t *, ldlm_mode_t mode,
794                             struct lustre_handle *);
795 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
796                                         __u32 *flags);
797 void ldlm_lock_cancel(struct ldlm_lock *lock);
798 void ldlm_reprocess_all(struct ldlm_resource *res);
799 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
800 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
801 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
802 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
803
804 /* resource.c */
805 struct ldlm_namespace *
806 ldlm_namespace_new(struct obd_device *obd, char *name,
807                    ldlm_side_t client, ldlm_appetite_t apt);
808 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
809 void ldlm_namespace_free(struct ldlm_namespace *ns,
810                          struct obd_import *imp, int force);
811 void ldlm_namespace_register(struct ldlm_namespace *ns, ldlm_side_t client);
812 void ldlm_namespace_unregister(struct ldlm_namespace *ns, ldlm_side_t client);
813 void ldlm_namespace_move_locked(struct ldlm_namespace *ns, ldlm_side_t client);
814 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t client);
815 void ldlm_namespace_get_locked(struct ldlm_namespace *ns);
816 void ldlm_namespace_put_locked(struct ldlm_namespace *ns, int wakeup);
817 void ldlm_namespace_get(struct ldlm_namespace *ns);
818 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
819 int ldlm_proc_setup(void);
820 #ifdef LPROCFS
821 void ldlm_proc_cleanup(void);
822 #else
823 static inline void ldlm_proc_cleanup(void) {}
824 #endif
825
826 /* resource.c - internal */
827 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
828                                         struct ldlm_resource *parent,
829                                         struct ldlm_res_id, ldlm_type_t type,
830                                         int create);
831 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
832 int ldlm_resource_putref(struct ldlm_resource *res);
833 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
834                             struct ldlm_lock *lock);
835 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
836 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
837 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
838 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
839 void ldlm_resource_dump(int level, struct ldlm_resource *);
840 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
841                               struct ldlm_res_id);
842
843 /* ldlm_request.c */
844 int ldlm_expired_completion_wait(void *data);
845 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
846                       void *data, int flag);
847 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
848 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
849 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **req,
850                      struct ldlm_enqueue_info *einfo, struct ldlm_res_id res_id,
851                      ldlm_policy_data_t *policy, int *flags,
852                      void *lvb, __u32 lvb_len, void *lvb_swabber,
853                      struct lustre_handle *lockh, int async);
854 struct ptlrpc_request *ldlm_prep_enqueue_req(struct obd_export *exp,
855                                              int bufcount, __u32 *size,
856                                              struct list_head *head, int count);
857 struct ptlrpc_request *ldlm_prep_elc_req(struct obd_export *exp, int version,
858                                          int opc, int bufcount, __u32 *size,
859                                          int bufoff, int canceloff,
860                                          struct list_head *cancels, int count);
861 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
862                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
863                           int *flags, void *lvb, __u32 lvb_len,
864                           void *lvb_swabber, struct lustre_handle *lockh,
865                           int rc);
866 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
867                            struct ldlm_res_id *res_id,
868                            ldlm_type_t type, ldlm_policy_data_t *policy,
869                            ldlm_mode_t mode, int *flags,
870                            ldlm_blocking_callback blocking,
871                            ldlm_completion_callback completion,
872                            ldlm_glimpse_callback glimpse,
873                            void *data, __u32 lvb_len, void *lvb_swabber,
874                            struct lustre_handle *lockh);
875 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
876                     void *data, __u32 data_len);
877 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
878 int ldlm_cli_update_pool(struct ptlrpc_request *req);
879 int ldlm_cli_cancel(struct lustre_handle *lockh);
880 int ldlm_cli_cancel_unused(struct ldlm_namespace *, struct ldlm_res_id *,
881                            int flags, void *opaque);
882 int ldlm_cli_cancel_req(struct obd_export *exp,
883                         struct list_head *head, int count);
884 int ldlm_cli_join_lru(struct ldlm_namespace *, struct ldlm_res_id *, int join);
885 int ldlm_cancel_resource_local(struct ldlm_resource *res,
886                                struct list_head *cancels,
887                                ldlm_policy_data_t *policy, ldlm_mode_t mode,
888                                int lock_flags, int cancel_flags, void *opaque);
889 int ldlm_cli_cancel_list(struct list_head *head, int count,
890                          struct ptlrpc_request *req, int off);
891
892 /* ioctls for trying requests */
893 #define IOC_LDLM_TYPE                   'f'
894 #define IOC_LDLM_MIN_NR                 40
895
896 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
897 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
898 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
899 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
900 #define IOC_LDLM_MAX_NR                 43
901
902 static inline void lock_res(struct ldlm_resource *res)
903 {
904         spin_lock(&res->lr_lock);
905 }
906
907 static inline void unlock_res(struct ldlm_resource *res)
908 {
909         spin_unlock(&res->lr_lock);
910 }
911
912 static inline void check_res_locked(struct ldlm_resource *res)
913 {
914         LASSERT_SPIN_LOCKED(&res->lr_lock);
915 }
916
917 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
918 void unlock_res_and_lock(struct ldlm_lock *lock);
919
920 /* ldlm_pool.c */
921 void ldlm_pools_recalc(ldlm_side_t client);
922 int ldlm_pools_init(void);
923 void ldlm_pools_fini(void);
924
925 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns,
926                    int idx, ldlm_side_t client);
927 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr,
928                      unsigned int gfp_mask);
929 void ldlm_pool_fini(struct ldlm_pool *pl);
930 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
931 int ldlm_pool_recalc(struct ldlm_pool *pl);
932 __u32 ldlm_pool_get_lvf(struct ldlm_pool *pl);
933 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
934 __u64 ldlm_pool_get_clv(struct ldlm_pool *pl);
935 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
936 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
937 void ldlm_pool_set_clv(struct ldlm_pool *pl, __u64 clv);
938 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
939 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
940 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
941 #endif