Whamcloud - gitweb
393f9660ef3f19da40b15c87d252ad75f86e611a
[fs/lustre-release.git] / lustre / include / lustre_dlm.h
1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2  * (visit-tags-table FILE)
3  * vim:expandtab:shiftwidth=8:tabstop=8:
4  */
5
6 #ifndef _LUSTRE_DLM_H__
7 #define _LUSTRE_DLM_H__
8
9 #if defined(__linux__)
10 #include <linux/lustre_dlm.h>
11 #elif defined(__APPLE__)
12 #include <darwin/lustre_dlm.h>
13 #elif defined(__WINNT__)
14 #include <winnt/lustre_dlm.h>
15 #else
16 #error Unsupported operating system.
17 #endif
18
19 #include <lustre_lib.h>
20 #include <lustre_net.h>
21 #include <lustre_import.h>
22 #include <lustre_handles.h>
23 #include <lustre_export.h> /* for obd_export, for LDLM_DEBUG */
24
25 struct obd_ops;
26 struct obd_device;
27
28 #define OBD_LDLM_DEVICENAME  "ldlm"
29
30 #define LDLM_DEFAULT_LRU_SIZE (100 * num_online_cpus())
31 #define LDLM_DEFAULT_MAX_ALIVE (cfs_time_seconds(36000))
32
33 typedef enum {
34         ELDLM_OK = 0,
35
36         ELDLM_LOCK_CHANGED = 300,
37         ELDLM_LOCK_ABORTED = 301,
38         ELDLM_LOCK_REPLACED = 302,
39         ELDLM_NO_LOCK_DATA = 303,
40
41         ELDLM_NAMESPACE_EXISTS = 400,
42         ELDLM_BAD_NAMESPACE    = 401
43 } ldlm_error_t;
44
45 typedef enum {
46         LDLM_NAMESPACE_SERVER = 1 << 0,
47         LDLM_NAMESPACE_CLIENT = 1 << 1
48 } ldlm_side_t;
49
50 #define LDLM_FL_LOCK_CHANGED   0x000001 /* extent, mode, or resource changed */
51
52 /* If the server returns one of these flags, then the lock was put on that list.
53  * If the client sends one of these flags (during recovery ONLY!), it wants the
54  * lock added to the specified list, no questions asked. -p */
55 #define LDLM_FL_BLOCK_GRANTED  0x000002
56 #define LDLM_FL_BLOCK_CONV     0x000004
57 #define LDLM_FL_BLOCK_WAIT     0x000008
58
59 #define LDLM_FL_CBPENDING      0x000010 /* this lock is being destroyed */
60 #define LDLM_FL_AST_SENT       0x000020 /* blocking or cancel packet was sent */
61 #define LDLM_FL_WAIT_NOREPROC  0x000040 /* not a real flag, not saved in lock */
62 #define LDLM_FL_CANCEL         0x000080 /* cancellation callback already run */
63
64 /* Lock is being replayed.  This could probably be implied by the fact that one
65  * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
66 #define LDLM_FL_REPLAY         0x000100
67
68 #define LDLM_FL_INTENT_ONLY    0x000200 /* don't grant lock, just do intent */
69 #define LDLM_FL_LOCAL_ONLY     0x000400 /* see ldlm_cli_cancel_unused */
70
71 /* don't run the cancel callback under ldlm_cli_cancel_unused */
72 #define LDLM_FL_FAILED         0x000800
73
74 #define LDLM_FL_HAS_INTENT     0x001000 /* lock request has intent */
75 #define LDLM_FL_CANCELING      0x002000 /* lock cancel has already been sent */
76 #define LDLM_FL_LOCAL          0x004000 /* local lock (ie, no srv/cli split) */
77 #define LDLM_FL_WARN           0x008000 /* see ldlm_cli_cancel_unused */
78 #define LDLM_FL_DISCARD_DATA   0x010000 /* discard (no writeback) on cancel */
79
80 #define LDLM_FL_NO_TIMEOUT     0x020000 /* Blocked by group lock - wait
81                                          * indefinitely */
82
83 /* file & record locking */
84 #define LDLM_FL_BLOCK_NOWAIT   0x040000 // server told not to wait if blocked
85 #define LDLM_FL_TEST_LOCK      0x080000 // return blocking lock
86
87 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
88  * the LVB filling happens _after_ the lock has been granted, so another thread
89  * can match`t before the LVB has been updated.  As a dirty hack, we set
90  * LDLM_FL_LVB_READY only after we've done the LVB poop.
91  * this is only needed on lov/osc now, where lvb is actually used and callers
92  * must set it in input flags.
93  *
94  * The proper fix is to do the granting inside of the completion AST, which can
95  * be replaced with a LVB-aware wrapping function for OSC locks.  That change is
96  * pretty high-risk, though, and would need a lot more testing. */
97
98 #define LDLM_FL_LVB_READY      0x100000
99
100 /* A lock contributes to the kms calculation until it has finished the part
101  * of it's cancelation that performs write back on its dirty pages.  It
102  * can remain on the granted list during this whole time.  Threads racing
103  * to update the kms after performing their writeback need to know to
104  * exclude each others locks from the calculation as they walk the granted
105  * list. */
106 #define LDLM_FL_KMS_IGNORE     0x200000
107
108 /* Don't drop lock covering mmapped file in LRU */
109 #define LDLM_FL_NO_LRU         0x400000
110
111 /* Immediatelly cancel such locks when they block some other locks. Send
112    cancel notification to original lock holder, but expect no reply. */
113 #define LDLM_FL_CANCEL_ON_BLOCK 0x800000
114
115 /* Flags flags inherited from parent lock when doing intents. */
116 #define LDLM_INHERIT_FLAGS     (LDLM_FL_CANCEL_ON_BLOCK)
117
118 /* These are flags that are mapped into the flags and ASTs of blocking locks */
119 #define LDLM_AST_DISCARD_DATA  0x80000000 /* Add FL_DISCARD to blocking ASTs */
120 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
121 #define LDLM_AST_FLAGS         (LDLM_FL_DISCARD_DATA)
122
123 /* completion ast to be executed */
124 #define LDLM_FL_CP_REQD        0x1000000
125
126 /* cleanup_resource has already handled the lock */
127 #define LDLM_FL_CLEANED        0x2000000
128
129 /* optimization hint: LDLM can run blocking callback from current context
130  * w/o involving separate thread. in order to decrease cs rate */
131 #define LDLM_FL_ATOMIC_CB      0x4000000
132
133 /* It may happen that a client initiate 2 operations, e.g. unlink and mkdir,
134  * such that server send blocking ast for conflict locks to this client for
135  * the 1st operation, whereas the 2nd operation has canceled this lock and
136  * is waiting for rpc_lock which is taken by the 1st operation.
137  * LDLM_FL_BL_AST is to be set by ldlm_callback_handler() to the lock not allow
138  * ELC code to cancel it. 
139  * LDLM_FL_BL_DONE is to be set by ldlm_cancel_callback() when lock cache is
140  * droped to let ldlm_callback_handler() return EINVAL to the server. It is
141  * used when ELC rpc is already prepared and is waiting for rpc_lock, too late
142  * to send a separate CANCEL rpc. */
143 #define LDLM_FL_BL_AST          0x10000000
144 #define LDLM_FL_BL_DONE         0x20000000
145
146 /* Cancel lock asynchronously. See ldlm_cli_cancel_unused_resource. */
147 #define LDLM_FL_ASYNC           0x40000000
148
149 /* The blocking callback is overloaded to perform two functions.  These flags
150  * indicate which operation should be performed. */
151 #define LDLM_CB_BLOCKING    1
152 #define LDLM_CB_CANCELING   2
153
154 /* position flag of skip list pointers */
155 #define LDLM_SL_HEAD(skip_list)   ((skip_list)->next != NULL)
156 #define LDLM_SL_TAIL(skip_list)   ((skip_list)->prev != NULL)
157 #define LDLM_SL_EMPTY(skip_list)  ((skip_list)->next == NULL && \
158                                    (skip_list)->prev == NULL)
159
160 /* compatibility matrix */
161 #define LCK_COMPAT_EX  LCK_NL
162 #define LCK_COMPAT_PW  (LCK_COMPAT_EX | LCK_CR)
163 #define LCK_COMPAT_PR  (LCK_COMPAT_PW | LCK_PR)
164 #define LCK_COMPAT_CW  (LCK_COMPAT_PW | LCK_CW)
165 #define LCK_COMPAT_CR  (LCK_COMPAT_CW | LCK_PR | LCK_PW)
166 #define LCK_COMPAT_NL  (LCK_COMPAT_CR | LCK_EX | LCK_GROUP)
167 #define LCK_COMPAT_GROUP  (LCK_GROUP | LCK_NL)
168
169 extern ldlm_mode_t lck_compat_array[];
170
171 static inline void lockmode_verify(ldlm_mode_t mode)
172 {
173        LASSERT(mode > LCK_MINMODE && mode < LCK_MAXMODE);
174 }
175
176 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
177 {
178        return (lck_compat_array[exist] & new);
179 }
180
181 /*
182  *
183  * cluster name spaces
184  *
185  */
186
187 #define DLM_OST_NAMESPACE 1
188 #define DLM_MDS_NAMESPACE 2
189
190 /* XXX
191    - do we just separate this by security domains and use a prefix for
192      multiple namespaces in the same domain?
193    -
194 */
195
196 /*
197  * Locking rules:
198  *
199  * lr_lock
200  *
201  * lr_lock
202  *     waiting_locks_spinlock
203  *
204  * lr_lock
205  *     led_lock
206  *
207  * lr_lock
208  *     ns_unused_lock
209  *
210  * lr_lvb_sem
211  *     lr_lock
212  *
213  */
214
215 struct ldlm_pool;
216 struct ldlm_lock;
217 struct ldlm_resource;
218 struct ldlm_namespace;
219
220 typedef int (*ldlm_pool_recalc_t)(struct ldlm_pool *pl);
221                                   
222 typedef int (*ldlm_pool_shrink_t)(struct ldlm_pool *pl,
223                                   int nr, unsigned int gfp_mask);
224
225 enum {
226         LDLM_POOL_CTL_RECALC = 1 << 0, /* Pool recalc is enabled */
227         LDLM_POOL_CTL_SHRINK = 1 << 1, /* Pool shrink is enabled */
228         LDLM_POOL_CTL_FULL   = (LDLM_POOL_CTL_RECALC | LDLM_POOL_CTL_SHRINK)
229 };
230
231 /* One second for pools thread check interval. */
232 #define LDLM_POOLS_THREAD_PERIOD (1)
233
234 /* 5% margin for modest pools. See ldlm_pool.c for details. */
235 #define LDLM_POOLS_MODEST_MARGIN (5)
236
237 /* A change to SLV in % after which we want to wake up pools thread asap. */
238 #define LDLM_POOLS_FAST_SLV_CHANGE (5)
239
240 struct ldlm_pool {
241         /* Common pool fields */
242         cfs_proc_dir_entry_t  *pl_proc_dir;           /* Pool proc directory. */
243         char                   pl_name[100];          /* Pool name, should be long 
244                                                        * enough to contain complex 
245                                                        * proc entry name. */
246         spinlock_t             pl_lock;               /* Lock for protecting slv/clv 
247                                                        * updates. */
248         atomic_t               pl_limit;              /* Number of allowed locks in
249                                                        * in pool, both, client and 
250                                                        * server side. */
251         atomic_t               pl_granted;            /* Number of granted locks. */
252         atomic_t               pl_grant_rate;         /* Grant rate per T. */
253         atomic_t               pl_cancel_rate;        /* Cancel rate per T. */
254         atomic_t               pl_grant_speed;        /* Grant speed (GR - CR) per T. */
255         __u64                  pl_server_lock_volume; /* Server lock volume. Protected 
256                                                        * by pl_lock. */
257         cfs_time_t             pl_update_time;        /* Time when last slv from server 
258                                                        * was obtained. */
259         ldlm_pool_recalc_t     pl_recalc;             /* Recalc callback func pointer. */
260         ldlm_pool_shrink_t     pl_shrink;             /* Shrink callback func pointer. */
261         int                    pl_control;            /* Pool features mask */
262         
263         /* Server side pool fields */
264         atomic_t               pl_grant_plan;         /* Planned number of granted 
265                                                        * locks for next T. */
266         atomic_t               pl_grant_step;         /* Grant plan step for next T. */
267
268         /* Client side pool related fields */
269         atomic_t               pl_lock_volume_factor; /* Lock volume factor. */
270         struct lprocfs_stats  *pl_stats;              /* Pool statistics. */
271 };
272
273 static inline int pool_recalc_enabled(struct ldlm_pool *pl)
274 {
275         return pl->pl_control & LDLM_POOL_CTL_RECALC;
276 }
277
278 static inline int pool_shrink_enabled(struct ldlm_pool *pl)
279 {
280         return pl->pl_control & LDLM_POOL_CTL_SHRINK;
281 }
282
283 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
284                                void *req_cookie, ldlm_mode_t mode, int flags,
285                                void *data);
286
287 struct ldlm_valblock_ops {
288         int (*lvbo_init)(struct ldlm_resource *res);
289         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
290                            int buf_idx, int increase);
291 };
292
293 typedef enum {
294         LDLM_NAMESPACE_GREEDY = 1 << 0,
295         LDLM_NAMESPACE_MODEST = 1 << 1
296 } ldlm_appetite_t;
297
298 struct ldlm_namespace {
299         char                  *ns_name;
300         ldlm_side_t            ns_client; /* is this a client-side lock tree? */
301         __u64                  ns_connect_flags; /* client side connect flags 
302                                                   * supported by server */
303         struct list_head      *ns_hash; /* hash table for ns */
304         spinlock_t             ns_hash_lock;
305         __u32                  ns_refcount; /* count of resources in the hash */
306         struct list_head       ns_root_list; /* all root resources in ns */
307         struct list_head       ns_list_chain; /* position in global NS list */
308
309         struct list_head       ns_unused_list; /* all root resources in ns */
310         int                    ns_nr_unused;
311         spinlock_t             ns_unused_lock;
312
313         unsigned int           ns_max_unused;
314         unsigned int           ns_max_age;
315         cfs_time_t             ns_next_dump;   /* next debug dump, jiffies */
316
317         atomic_t               ns_locks;
318         __u64                  ns_resources;
319         ldlm_res_policy        ns_policy;
320         struct ldlm_valblock_ops *ns_lvbo;
321         void                  *ns_lvbp;
322         cfs_waitq_t            ns_waitq;
323         struct ldlm_pool       ns_pool;
324         ldlm_appetite_t        ns_appetite;
325 };
326
327 static inline int ns_is_client(struct ldlm_namespace *ns)
328 {
329         LASSERT(ns != NULL);
330         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT | 
331                                     LDLM_NAMESPACE_SERVER)));
332         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
333                 ns->ns_client == LDLM_NAMESPACE_SERVER);
334         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
335 }
336
337 static inline int ns_is_server(struct ldlm_namespace *ns)
338 {
339         LASSERT(ns != NULL);
340         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT | 
341                                     LDLM_NAMESPACE_SERVER)));
342         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
343                 ns->ns_client == LDLM_NAMESPACE_SERVER);
344         return ns->ns_client == LDLM_NAMESPACE_SERVER;
345 }
346
347 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
348 {
349         LASSERT(ns != NULL);
350         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
351 }
352
353 /*
354  *
355  * Resource hash table
356  *
357  */
358
359 #define RES_HASH_BITS 10
360 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
361 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
362
363 struct ldlm_lock;
364
365 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
366                                       struct ldlm_lock_desc *new, void *data,
367                                       int flag);
368 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
369                                         void *data);
370 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
371
372 struct ldlm_lock {
373         struct portals_handle l_handle; // must be first in the structure
374         atomic_t              l_refc;
375
376         /* internal spinlock protects l_resource.  we should hold this lock 
377          * first before grabbing res_lock.*/
378         spinlock_t            l_lock;
379
380         /* ldlm_lock_change_resource() can change this */
381         struct ldlm_resource *l_resource;
382
383         /* protected by ns_hash_lock. FIXME */
384         struct list_head      l_lru;
385
386         /* protected by lr_lock */
387         struct list_head      l_res_link; // position in one of three res lists
388
389         struct list_head      l_sl_mode;        // skip pointer for request mode
390         struct list_head      l_sl_policy;      // skip pointer for inodebits
391
392         /* protected by led_lock */
393         struct list_head      l_export_chain; // per-export chain of locks
394
395         /* protected by lr_lock */
396         ldlm_mode_t           l_req_mode;
397         ldlm_mode_t           l_granted_mode;
398
399         ldlm_completion_callback l_completion_ast;
400         ldlm_blocking_callback   l_blocking_ast;
401         ldlm_glimpse_callback    l_glimpse_ast;
402
403         struct obd_export    *l_export;
404         struct obd_export    *l_conn_export;
405
406         struct lustre_handle  l_remote_handle;
407         ldlm_policy_data_t    l_policy_data;
408
409         /* protected by lr_lock */
410         __u32                 l_flags;
411         __u32                 l_readers;
412         __u32                 l_writers;
413         __u8                  l_destroyed;
414
415         /* If the lock is granted, a process sleeps on this waitq to learn when
416          * it's no longer in use.  If the lock is not granted, a process sleeps
417          * on this waitq to learn when it becomes granted. */
418         cfs_waitq_t           l_waitq;
419         struct timeval        l_enqueued_time;
420
421         cfs_time_t            l_last_used;      /* jiffies */
422         struct ldlm_extent    l_req_extent;
423
424         /* Client-side-only members */
425         __u32                 l_lvb_len;        /* temporary storage for */
426         void                 *l_lvb_data;       /* an LVB received during */
427         void                 *l_lvb_swabber;    /* an enqueue */
428         void                 *l_ast_data;
429
430         /* Server-side-only members */
431
432         /* protected by elt_lock */
433         struct list_head      l_pending_chain;  /* callbacks pending */
434         cfs_time_t            l_callback_timeout; /* jiffies */
435
436         __u32                 l_pid;            /* pid which created this lock */
437
438         /* for ldlm_add_ast_work_item() */
439         struct list_head      l_bl_ast;
440         struct list_head      l_cp_ast;
441         struct ldlm_lock     *l_blocking_lock;
442         int                   l_bl_ast_run;
443 };
444
445 struct ldlm_resource {
446         struct ldlm_namespace *lr_namespace;
447
448         /* protected by ns_hash_lock */
449         struct list_head       lr_hash;
450         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
451         struct list_head       lr_children; /* list head for child resources */
452         struct list_head       lr_childof;  /* part of ns_root_list if root res,
453                                              * part of lr_children if child */
454         spinlock_t             lr_lock;
455
456         /* protected by lr_lock */
457         struct list_head       lr_granted;
458         struct list_head       lr_converting;
459         struct list_head       lr_waiting;
460         ldlm_mode_t            lr_most_restr;
461         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
462         struct ldlm_res_id     lr_name;
463         atomic_t               lr_refcount;
464
465         /* Server-side-only lock value block elements */
466         struct semaphore       lr_lvb_sem;
467         __u32                  lr_lvb_len;
468         void                  *lr_lvb_data;
469 };
470
471 struct ldlm_ast_work {
472         struct ldlm_lock *w_lock;
473         int               w_blocking;
474         struct ldlm_lock_desc w_desc;
475         struct list_head   w_list;
476         int w_flags;
477         void *w_data;
478         int w_datalen;
479 };
480
481 /* ldlm_enqueue parameters common */
482 struct ldlm_enqueue_info {
483         __u32 ei_type;   /* Type of the lock being enqueued. */
484         __u32 ei_mode;   /* Mode of the lock being enqueued. */
485         void *ei_cb_bl;  /* Different callbacks for lock handling (blocking, */
486         void *ei_cb_cp;  /* completion, glimpse) */
487         void *ei_cb_gl;
488         void *ei_cbdata; /* Data to be passed into callbacks. */
489 };
490
491 extern struct obd_ops ldlm_obd_ops;
492
493 extern char *ldlm_lockname[];
494 extern char *ldlm_typename[];
495 extern char *ldlm_it2str(int it);
496 #ifdef LIBCFS_DEBUG
497 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
498         CHECK_STACK();                                                  \
499                                                                         \
500         if (((level) & D_CANTMASK) != 0 ||                              \
501             ((libcfs_debug & (level)) != 0 &&                           \
502              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
503                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
504                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
505                                     file, func, line);                  \
506                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
507                                  ##a );                                 \
508         }                                                               \
509 } while(0)
510
511 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
512                       struct libcfs_debug_msg_data *data, const char *fmt,
513                       ...)
514         __attribute__ ((format (printf, 4, 5)));
515
516 #define LDLM_ERROR(lock, fmt, a...) do {                                \
517         static cfs_debug_limit_state_t _ldlm_cdls;                      \
518         ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock,                     \
519                         __FILE__, __FUNCTION__, __LINE__,               \
520                         "### " fmt , ##a);                              \
521 } while (0)
522
523 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
524         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
525                         __FILE__, __FUNCTION__, __LINE__,               \
526                          "### " fmt , ##a);                             \
527 } while (0)
528 #else
529 #define LDLM_DEBUG(lock, fmt, a...) ((void)0)
530 #define LDLM_ERROR(lock, fmt, a...) ((void)0)
531 #endif
532
533 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
534         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
535
536 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
537                                       int first_enq, ldlm_error_t *err,
538                                       struct list_head *work_list);
539
540 /*
541  * Iterators.
542  */
543
544 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
545 #define LDLM_ITER_STOP     2 /* stop iterating */
546
547 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
548 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
549
550 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
551                           void *closure);
552 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
553                            void *closure);
554 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
555                                ldlm_res_iterator_t iter, void *closure);
556
557 int ldlm_replay_locks(struct obd_import *imp);
558 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
559                            ldlm_iterator_t iter, void *data);
560
561 /* ldlm_flock.c */
562 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
563
564 /* ldlm_extent.c */
565 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
566
567
568 /* ldlm_lockd.c */
569 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
570                              void *data, int flag);
571 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
572 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
573 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
574                         ldlm_blocking_callback, ldlm_glimpse_callback);
575 int ldlm_handle_convert(struct ptlrpc_request *req);
576 int ldlm_handle_cancel(struct ptlrpc_request *req);
577 int ldlm_request_cancel(struct ptlrpc_request *req,
578                         const struct ldlm_request *dlm_req, int first);
579 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
580 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
581 void ldlm_revoke_export_locks(struct obd_export *exp);
582 int ldlm_get_ref(void);
583 void ldlm_put_ref(int force);
584
585 /* ldlm_lock.c */
586 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
587 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
588 void ldlm_lock2handle(const struct ldlm_lock *lock,
589                       struct lustre_handle *lockh);
590 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
591 void ldlm_cancel_callback(struct ldlm_lock *);
592 int ldlm_lock_set_data(struct lustre_handle *, void *data);
593 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
594 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
595                                       const struct lustre_handle *);
596
597 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
598 {
599         return __ldlm_handle2lock(h, 0);
600 }
601
602 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
603                                        struct lustre_msg *m, int buf_idx,
604                                        int increase)
605 {
606         if (res->lr_namespace->ns_lvbo &&
607             res->lr_namespace->ns_lvbo->lvbo_update) {
608                 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
609                                                                increase);
610         }
611         return 0;
612 }
613
614 #define LDLM_LOCK_PUT(lock)                     \
615 do {                                            \
616         /*LDLM_DEBUG((lock), "put");*/          \
617         ldlm_lock_put(lock);                    \
618 } while (0)
619
620 #define LDLM_LOCK_GET(lock)                     \
621 ({                                              \
622         ldlm_lock_get(lock);                    \
623         /*LDLM_DEBUG((lock), "get");*/          \
624         lock;                                   \
625 })
626
627 #define ldlm_lock_list_put(head, member, count)                 \
628 ({                                                              \
629         struct ldlm_lock *_lock, *_next;                        \
630         int c = count;                                          \
631         list_for_each_entry_safe(_lock, _next, head, member) {  \
632                 if (c-- == 0)                                   \
633                         break;                                  \
634                 list_del_init(&_lock->member);                  \
635                 LDLM_LOCK_PUT(_lock);                           \
636         }                                                       \
637         LASSERT(c <= 0);                                        \
638 })
639
640 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
641 void ldlm_lock_put(struct ldlm_lock *lock);
642 void ldlm_lock_destroy(struct ldlm_lock *lock);
643 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
644 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
645 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
646 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
647 void ldlm_lock_allow_match(struct ldlm_lock *lock);
648 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
649                             const struct ldlm_res_id *, ldlm_type_t type,
650                             ldlm_policy_data_t *, ldlm_mode_t mode,
651                             struct lustre_handle *);
652 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
653                                         int *flags);
654 void ldlm_lock_cancel(struct ldlm_lock *lock);
655 void ldlm_cancel_locks_for_export(struct obd_export *export);
656 void ldlm_reprocess_all(struct ldlm_resource *res);
657 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
658 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
659 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
660 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
661
662 /* resource.c */
663 struct ldlm_namespace *ldlm_namespace_new(char *name, ldlm_side_t client, 
664                                           ldlm_appetite_t apt);
665 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
666 int ldlm_namespace_free(struct ldlm_namespace *ns, int force);
667 void ldlm_namespace_move(struct ldlm_namespace *ns, ldlm_side_t client);
668 struct ldlm_namespace *ldlm_namespace_first(ldlm_side_t client);
669 void ldlm_namespace_get(struct ldlm_namespace *ns);
670 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
671 void ldlm_namespace_get_nolock(struct ldlm_namespace *ns);
672 void ldlm_namespace_put_nolock(struct ldlm_namespace *ns, int wakeup);
673 int ldlm_proc_setup(void);
674 #ifdef LPROCFS
675 void ldlm_proc_cleanup(void);
676 #else
677 static inline void ldlm_proc_cleanup(void) {}
678 #endif
679
680 /* resource.c - internal */
681 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
682                                         struct ldlm_resource *parent,
683                                         const struct ldlm_res_id *,
684                                         ldlm_type_t type, int create);
685 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
686 int ldlm_resource_putref(struct ldlm_resource *res);
687 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
688                             struct ldlm_lock *lock);
689 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
690 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
691 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
692 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
693 void ldlm_resource_dump(int level, struct ldlm_resource *);
694 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
695                               const struct ldlm_res_id *);
696
697 struct ldlm_callback_suite {
698         ldlm_completion_callback lcs_completion;
699         ldlm_blocking_callback   lcs_blocking;
700         ldlm_glimpse_callback    lcs_glimpse;
701 };
702
703 /* ldlm_request.c */
704 int ldlm_expired_completion_wait(void *data);
705 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
706                       void *data, int flag);
707 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
708 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
709 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
710                      struct ldlm_enqueue_info *einfo,
711                      const struct ldlm_res_id *res_id,
712                      ldlm_policy_data_t *policy, int *flags,
713                      void *lvb, __u32 lvb_len, void *lvb_swabber,
714                      struct lustre_handle *lockh, int async);
715 struct ptlrpc_request *ldlm_prep_enqueue_req(struct obd_export *exp,
716                                              int bufcount, int *size,
717                                              struct list_head *head, int count);
718 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
719                          const struct ldlm_request *dlm_req,
720                          const struct ldlm_callback_suite *cbs);
721 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
722                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
723                           int *flags, void *lvb, __u32 lvb_len,
724                           void *lvb_swabber, struct lustre_handle *lockh,
725                           int rc);
726 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
727                            const struct ldlm_res_id *res_id,
728                            ldlm_type_t type, ldlm_policy_data_t *policy,
729                            ldlm_mode_t mode, int *flags,
730                            ldlm_blocking_callback blocking,
731                            ldlm_completion_callback completion,
732                            ldlm_glimpse_callback glimpse,
733                            void *data, __u32 lvb_len, void *lvb_swabber,
734                            struct lustre_handle *lockh);
735 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
736                     void *data, __u32 data_len);
737 int ldlm_cli_convert(struct lustre_handle *, int new_mode, int *flags);
738 int ldlm_cli_update_pool(struct ptlrpc_request *req);
739 int ldlm_handle_convert0(struct ptlrpc_request *req,
740                          const struct ldlm_request *dlm_req);
741 int ldlm_cli_cancel(struct lustre_handle *lockh);
742 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
743                            int flags, void *opaque);
744 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
745                                     const struct ldlm_res_id *res_id,
746                                     ldlm_policy_data_t *policy,
747                                     ldlm_mode_t mode, int flags, void *opaque);
748 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
749                         int count, int flags);
750 int ldlm_cli_join_lru(struct ldlm_namespace *,
751                       const struct ldlm_res_id *, int join);
752 int ldlm_cancel_resource_local(struct ldlm_resource *res,
753                                struct list_head *cancels,
754                                ldlm_policy_data_t *policy,
755                                ldlm_mode_t mode, int lock_flags,
756                                int flags, void *opaque);
757 int ldlm_cli_cancel_list(struct list_head *head, int count,
758                          struct ptlrpc_request *req, int off, int flags);
759  
760 /* mds/handler.c */
761 /* This has to be here because recursive inclusion sucks. */
762 int intent_disposition(struct ldlm_reply *rep, int flag);
763 void intent_set_disposition(struct ldlm_reply *rep, int flag);
764
765
766 /* ioctls for trying requests */
767 #define IOC_LDLM_TYPE                   'f'
768 #define IOC_LDLM_MIN_NR                 40
769
770 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
771 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
772 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
773 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
774 #define IOC_LDLM_MAX_NR                 43
775
776 static inline void lock_res(struct ldlm_resource *res)
777 {
778         spin_lock(&res->lr_lock);
779 }
780
781 static inline void unlock_res(struct ldlm_resource *res)
782 {
783         spin_unlock(&res->lr_lock);
784 }
785
786 static inline void check_res_locked(struct ldlm_resource *res)
787 {
788         LASSERT_SPIN_LOCKED(&res->lr_lock);
789 }
790
791 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
792 void unlock_res_and_lock(struct ldlm_lock *lock);
793
794 /* ldlm_pool.c */
795 void ldlm_pools_recalc(ldlm_side_t client);
796 int ldlm_pools_init(void);
797 void ldlm_pools_fini(void);
798 void ldlm_pools_wakeup(void);
799
800 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns, 
801                    int idx, ldlm_side_t client);
802 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, 
803                      unsigned int gfp_mask);
804 void ldlm_pool_fini(struct ldlm_pool *pl);
805 int ldlm_pool_setup(struct ldlm_pool *pl, __u32 limit);
806 int ldlm_pool_recalc(struct ldlm_pool *pl);
807 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
808 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
809 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
810 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
811 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
812 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
813 #endif
814