Whamcloud - gitweb
b=13766
[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 struct ldlm_pool_ops {
221         int (*po_recalc)(struct ldlm_pool *pl);
222         int (*po_shrink)(struct ldlm_pool *pl, int nr, 
223                          unsigned int gfp_mask);
224         int (*po_setup)(struct ldlm_pool *pl, int limit);
225 };
226
227 /* One second for pools thread check interval. */
228 #define LDLM_POOLS_THREAD_PERIOD (1)
229
230 /* 5% margin for modest pools. See ldlm_pool.c for details. */
231 #define LDLM_POOLS_MODEST_MARGIN (5)
232
233 /* A change to SLV in % after which we want to wake up pools thread asap. */
234 #define LDLM_POOLS_FAST_SLV_CHANGE (50)
235
236 struct ldlm_pool {
237         /* Common pool fields */
238         cfs_proc_dir_entry_t  *pl_proc_dir;      /* Pool proc directory. */
239         char                   pl_name[100];     /* Pool name, should be long 
240                                                   * enough to contain complex
241                                                   * proc entry name. */
242         spinlock_t             pl_lock;          /* Lock for protecting slv/clv 
243                                                   * updates. */
244         atomic_t               pl_limit;         /* Number of allowed locks in
245                                                   * in pool, both, client and 
246                                                   * server side. */
247         atomic_t               pl_granted;       /* Number of granted locks. */
248         atomic_t               pl_grant_rate;    /* Grant rate per T. */
249         atomic_t               pl_cancel_rate;   /* Cancel rate per T. */
250         atomic_t               pl_grant_speed;   /* Grant speed (GR-CR) per T. */
251         __u64                  pl_server_lock_volume; /* Server lock volume. 
252                                                   * Protected by pl_lock */
253         atomic_t               pl_lock_volume_factor; /* Lock volume factor. */
254
255         time_t                 pl_recalc_time;   /* Time when last slv from 
256                                                   * server was obtained. */
257         struct ldlm_pool_ops  *pl_ops;           /* Recalc and shrink ops. */ 
258
259         int                    pl_grant_plan;    /* Planned number of granted 
260                                                   * locks for next T. */
261         int                    pl_grant_step;    /* Grant plan step for next 
262                                                   * T. */
263
264         struct lprocfs_stats  *pl_stats;         /* Pool statistics. */
265 };
266
267 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
268                                void *req_cookie, ldlm_mode_t mode, int flags,
269                                void *data);
270
271 struct ldlm_valblock_ops {
272         int (*lvbo_init)(struct ldlm_resource *res);
273         int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
274                            int buf_idx, int increase);
275 };
276
277 typedef enum {
278         LDLM_NAMESPACE_GREEDY = 1 << 0,
279         LDLM_NAMESPACE_MODEST = 1 << 1
280 } ldlm_appetite_t;
281
282 /* Default value for ->ns_shrink_thumb. If lock is not extent one its cost 
283  * is one page. Here we have 256 pages which is 1M on i386. Thus by default
284  * all extent locks which have more than 1M long extent will be kept in lru,
285  * others (including ibits locks) will be canceled on memory pressure event. */
286 #define LDLM_LOCK_SHRINK_THUMB 256
287
288 struct ldlm_namespace {
289         char                  *ns_name;
290         ldlm_side_t            ns_client; /* is this a client-side lock tree? */
291         __u64                  ns_connect_flags; /* ns connect flags supported
292                                            * by server (may be changed via proc,
293                                            * lru resize may be disabled/enabled) */
294         __u64                  ns_orig_connect_flags; /* client side orig connect
295                                            * flags supported by server */
296         struct list_head      *ns_hash;   /* hash table for ns */
297         spinlock_t             ns_hash_lock;
298         __u32                  ns_refcount; /* count of resources in the hash */
299         struct list_head       ns_root_list; /* all root resources in ns */
300         struct list_head       ns_list_chain; /* position in global NS list */
301
302         struct list_head       ns_unused_list; /* all root resources in ns */
303         int                    ns_nr_unused;
304         spinlock_t             ns_unused_lock;
305
306         unsigned int           ns_max_unused;
307         unsigned int           ns_max_age;
308         
309         /* Lower limit to number of pages in lock to keep it in cache */
310         unsigned int           ns_shrink_thumb;
311         cfs_time_t             ns_next_dump;   /* next debug dump, jiffies */
312
313         atomic_t               ns_locks;
314         __u64                  ns_resources;
315         ldlm_res_policy        ns_policy;
316         struct ldlm_valblock_ops *ns_lvbo;
317         void                  *ns_lvbp;
318         cfs_waitq_t            ns_waitq;
319         struct ldlm_pool       ns_pool;
320         ldlm_appetite_t        ns_appetite;
321 };
322
323 static inline int ns_is_client(struct ldlm_namespace *ns)
324 {
325         LASSERT(ns != NULL);
326         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT | 
327                                     LDLM_NAMESPACE_SERVER)));
328         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
329                 ns->ns_client == LDLM_NAMESPACE_SERVER);
330         return ns->ns_client == LDLM_NAMESPACE_CLIENT;
331 }
332
333 static inline int ns_is_server(struct ldlm_namespace *ns)
334 {
335         LASSERT(ns != NULL);
336         LASSERT(!(ns->ns_client & ~(LDLM_NAMESPACE_CLIENT | 
337                                     LDLM_NAMESPACE_SERVER)));
338         LASSERT(ns->ns_client == LDLM_NAMESPACE_CLIENT ||
339                 ns->ns_client == LDLM_NAMESPACE_SERVER);
340         return ns->ns_client == LDLM_NAMESPACE_SERVER;
341 }
342
343 static inline int ns_connect_lru_resize(struct ldlm_namespace *ns)
344 {
345         LASSERT(ns != NULL);
346         return !!(ns->ns_connect_flags & OBD_CONNECT_LRU_RESIZE);
347 }
348
349 /*
350  *
351  * Resource hash table
352  *
353  */
354
355 #define RES_HASH_BITS 10
356 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
357 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
358
359 struct ldlm_lock;
360
361 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
362                                       struct ldlm_lock_desc *new, void *data,
363                                       int flag);
364 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
365                                         void *data);
366 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
367
368 struct ldlm_lock {
369         struct portals_handle l_handle; // must be first in the structure
370         atomic_t              l_refc;
371
372         /* internal spinlock protects l_resource.  we should hold this lock 
373          * first before grabbing res_lock.*/
374         spinlock_t            l_lock;
375
376         /* ldlm_lock_change_resource() can change this */
377         struct ldlm_resource *l_resource;
378
379         /* protected by ns_hash_lock. FIXME */
380         struct list_head      l_lru;
381
382         /* protected by lr_lock */
383         struct list_head      l_res_link; // position in one of three res lists
384
385         struct list_head      l_sl_mode;        // skip pointer for request mode
386         struct list_head      l_sl_policy;      // skip pointer for inodebits
387
388         /* protected by led_lock */
389         struct list_head      l_export_chain; // per-export chain of locks
390
391         /* protected by lr_lock */
392         ldlm_mode_t           l_req_mode;
393         ldlm_mode_t           l_granted_mode;
394
395         ldlm_completion_callback l_completion_ast;
396         ldlm_blocking_callback   l_blocking_ast;
397         ldlm_glimpse_callback    l_glimpse_ast;
398
399         struct obd_export    *l_export;
400         struct obd_export    *l_conn_export;
401
402         struct lustre_handle  l_remote_handle;
403         ldlm_policy_data_t    l_policy_data;
404
405         /* protected by lr_lock */
406         __u32                 l_flags;
407         __u32                 l_readers;
408         __u32                 l_writers;
409         __u8                  l_destroyed;
410
411         /* If the lock is granted, a process sleeps on this waitq to learn when
412          * it's no longer in use.  If the lock is not granted, a process sleeps
413          * on this waitq to learn when it becomes granted. */
414         cfs_waitq_t           l_waitq;
415         struct timeval        l_enqueued_time;
416
417         cfs_time_t            l_last_used;      /* jiffies */
418         struct ldlm_extent    l_req_extent;
419
420         /* Client-side-only members */
421         __u32                 l_lvb_len;        /* temporary storage for */
422         void                 *l_lvb_data;       /* an LVB received during */
423         void                 *l_lvb_swabber;    /* an enqueue */
424         void                 *l_ast_data;
425
426         /* Server-side-only members */
427
428         /* protected by elt_lock */
429         struct list_head      l_pending_chain;  /* callbacks pending */
430         cfs_time_t            l_callback_timeout; /* jiffies */
431
432         __u32                 l_pid;            /* pid which created this lock */
433
434         /* for ldlm_add_ast_work_item() */
435         struct list_head      l_bl_ast;
436         struct list_head      l_cp_ast;
437         struct ldlm_lock     *l_blocking_lock;
438         int                   l_bl_ast_run;
439 };
440
441 struct ldlm_resource {
442         struct ldlm_namespace *lr_namespace;
443
444         /* protected by ns_hash_lock */
445         struct list_head       lr_hash;
446         struct ldlm_resource  *lr_parent;   /* 0 for a root resource */
447         struct list_head       lr_children; /* list head for child resources */
448         struct list_head       lr_childof;  /* part of ns_root_list if root res,
449                                              * part of lr_children if child */
450         spinlock_t             lr_lock;
451
452         /* protected by lr_lock */
453         struct list_head       lr_granted;
454         struct list_head       lr_converting;
455         struct list_head       lr_waiting;
456         ldlm_mode_t            lr_most_restr;
457         ldlm_type_t            lr_type; /* LDLM_{PLAIN,EXTENT,FLOCK} */
458         struct ldlm_res_id     lr_name;
459         atomic_t               lr_refcount;
460
461         /* Server-side-only lock value block elements */
462         struct semaphore       lr_lvb_sem;
463         __u32                  lr_lvb_len;
464         void                  *lr_lvb_data;
465 };
466
467 struct ldlm_ast_work {
468         struct ldlm_lock *w_lock;
469         int               w_blocking;
470         struct ldlm_lock_desc w_desc;
471         struct list_head   w_list;
472         int w_flags;
473         void *w_data;
474         int w_datalen;
475 };
476
477 /* ldlm_enqueue parameters common */
478 struct ldlm_enqueue_info {
479         __u32 ei_type;   /* Type of the lock being enqueued. */
480         __u32 ei_mode;   /* Mode of the lock being enqueued. */
481         void *ei_cb_bl;  /* Different callbacks for lock handling (blocking, */
482         void *ei_cb_cp;  /* completion, glimpse) */
483         void *ei_cb_gl;
484         void *ei_cbdata; /* Data to be passed into callbacks. */
485 };
486
487 extern struct obd_ops ldlm_obd_ops;
488
489 extern char *ldlm_lockname[];
490 extern char *ldlm_typename[];
491 extern char *ldlm_it2str(int it);
492 #ifdef LIBCFS_DEBUG
493 #define ldlm_lock_debug(cdls, level, lock, file, func, line, fmt, a...) do { \
494         CHECK_STACK();                                                  \
495                                                                         \
496         if (((level) & D_CANTMASK) != 0 ||                              \
497             ((libcfs_debug & (level)) != 0 &&                           \
498              (libcfs_subsystem_debug & DEBUG_SUBSYSTEM) != 0)) {        \
499                 static struct libcfs_debug_msg_data _ldlm_dbg_data =    \
500                 DEBUG_MSG_DATA_INIT(cdls, DEBUG_SUBSYSTEM,              \
501                                     file, func, line);                  \
502                 _ldlm_lock_debug(lock, level, &_ldlm_dbg_data, fmt,     \
503                                  ##a );                                 \
504         }                                                               \
505 } while(0)
506
507 void _ldlm_lock_debug(struct ldlm_lock *lock, __u32 mask,
508                       struct libcfs_debug_msg_data *data, const char *fmt,
509                       ...)
510         __attribute__ ((format (printf, 4, 5)));
511
512 #define LDLM_ERROR(lock, fmt, a...) do {                                \
513         static cfs_debug_limit_state_t _ldlm_cdls;                      \
514         ldlm_lock_debug(&_ldlm_cdls, D_ERROR, lock,                     \
515                         __FILE__, __FUNCTION__, __LINE__,               \
516                         "### " fmt , ##a);                              \
517 } while (0)
518
519 #define LDLM_DEBUG(lock, fmt, a...)   do {                              \
520         ldlm_lock_debug(NULL, D_DLMTRACE, lock,                         \
521                         __FILE__, __FUNCTION__, __LINE__,               \
522                          "### " fmt , ##a);                             \
523 } while (0)
524 #else
525 #define LDLM_DEBUG(lock, fmt, a...) ((void)0)
526 #define LDLM_ERROR(lock, fmt, a...) ((void)0)
527 #endif
528
529 #define LDLM_DEBUG_NOLOCK(format, a...)                 \
530         CDEBUG(D_DLMTRACE, "### " format "\n" , ##a)
531
532 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
533                                       int first_enq, ldlm_error_t *err,
534                                       struct list_head *work_list);
535
536 /*
537  * Iterators.
538  */
539
540 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
541 #define LDLM_ITER_STOP     2 /* stop iterating */
542
543 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
544 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
545
546 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
547                           void *closure);
548 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
549                            void *closure);
550 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
551                                ldlm_res_iterator_t iter, void *closure);
552
553 int ldlm_replay_locks(struct obd_import *imp);
554 void ldlm_resource_iterate(struct ldlm_namespace *, const struct ldlm_res_id *,
555                            ldlm_iterator_t iter, void *data);
556
557 /* ldlm_flock.c */
558 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
559
560 /* ldlm_extent.c */
561 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
562
563
564 /* ldlm_lockd.c */
565 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
566                              void *data, int flag);
567 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
568 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
569 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
570                         ldlm_blocking_callback, ldlm_glimpse_callback);
571 int ldlm_handle_convert(struct ptlrpc_request *req);
572 int ldlm_handle_cancel(struct ptlrpc_request *req);
573 int ldlm_request_cancel(struct ptlrpc_request *req,
574                         const struct ldlm_request *dlm_req, int first);
575 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
576 int ldlm_refresh_waiting_lock(struct ldlm_lock *lock);
577 void ldlm_revoke_export_locks(struct obd_export *exp);
578 int ldlm_get_ref(void);
579 void ldlm_put_ref(int force);
580
581 /* ldlm_lock.c */
582 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
583 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
584 void ldlm_lock2handle(const struct ldlm_lock *lock,
585                       struct lustre_handle *lockh);
586 struct ldlm_lock *__ldlm_handle2lock(const struct lustre_handle *, int flags);
587 void ldlm_cancel_callback(struct ldlm_lock *);
588 int ldlm_lock_set_data(struct lustre_handle *, void *data);
589 int ldlm_lock_remove_from_lru(struct ldlm_lock *);
590 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
591                                       const struct lustre_handle *);
592
593 static inline struct ldlm_lock *ldlm_handle2lock(const struct lustre_handle *h)
594 {
595         return __ldlm_handle2lock(h, 0);
596 }
597
598 static inline int ldlm_res_lvbo_update(struct ldlm_resource *res,
599                                        struct lustre_msg *m, int buf_idx,
600                                        int increase)
601 {
602         if (res->lr_namespace->ns_lvbo &&
603             res->lr_namespace->ns_lvbo->lvbo_update) {
604                 return res->lr_namespace->ns_lvbo->lvbo_update(res, m, buf_idx,
605                                                                increase);
606         }
607         return 0;
608 }
609
610 #define LDLM_LOCK_PUT(lock)                     \
611 do {                                            \
612         /*LDLM_DEBUG((lock), "put");*/          \
613         ldlm_lock_put(lock);                    \
614 } while (0)
615
616 #define LDLM_LOCK_GET(lock)                     \
617 ({                                              \
618         ldlm_lock_get(lock);                    \
619         /*LDLM_DEBUG((lock), "get");*/          \
620         lock;                                   \
621 })
622
623 #define ldlm_lock_list_put(head, member, count)                 \
624 ({                                                              \
625         struct ldlm_lock *_lock, *_next;                        \
626         int c = count;                                          \
627         list_for_each_entry_safe(_lock, _next, head, member) {  \
628                 if (c-- == 0)                                   \
629                         break;                                  \
630                 list_del_init(&_lock->member);                  \
631                 LDLM_LOCK_PUT(_lock);                           \
632         }                                                       \
633         LASSERT(c <= 0);                                        \
634 })
635
636 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
637 void ldlm_lock_put(struct ldlm_lock *lock);
638 void ldlm_lock_destroy(struct ldlm_lock *lock);
639 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
640 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
641 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
642 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
643 void ldlm_lock_allow_match(struct ldlm_lock *lock);
644 ldlm_mode_t ldlm_lock_match(struct ldlm_namespace *ns, int flags,
645                             const struct ldlm_res_id *, ldlm_type_t type,
646                             ldlm_policy_data_t *, ldlm_mode_t mode,
647                             struct lustre_handle *);
648 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
649                                         __u32 *flags);
650 void ldlm_lock_cancel(struct ldlm_lock *lock);
651 void ldlm_cancel_locks_for_export(struct obd_export *export);
652 void ldlm_reprocess_all(struct ldlm_resource *res);
653 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
654 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
655 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
656 void ldlm_unlink_lock_skiplist(struct ldlm_lock *req);
657
658 /* resource.c */
659 struct ldlm_namespace *ldlm_namespace_new(char *name, ldlm_side_t client, 
660                                           ldlm_appetite_t apt);
661 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
662 int ldlm_namespace_free(struct ldlm_namespace *ns, int force);
663 void ldlm_namespace_move(struct ldlm_namespace *ns, ldlm_side_t client);
664 struct ldlm_namespace *ldlm_namespace_first(ldlm_side_t client);
665 void ldlm_namespace_get(struct ldlm_namespace *ns);
666 void ldlm_namespace_put(struct ldlm_namespace *ns, int wakeup);
667 void ldlm_namespace_get_nolock(struct ldlm_namespace *ns);
668 void ldlm_namespace_put_nolock(struct ldlm_namespace *ns, int wakeup);
669 int ldlm_proc_setup(void);
670 #ifdef LPROCFS
671 void ldlm_proc_cleanup(void);
672 #else
673 static inline void ldlm_proc_cleanup(void) {}
674 #endif
675
676 /* resource.c - internal */
677 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
678                                         struct ldlm_resource *parent,
679                                         const struct ldlm_res_id *,
680                                         ldlm_type_t type, int create);
681 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
682 int ldlm_resource_putref(struct ldlm_resource *res);
683 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
684                             struct ldlm_lock *lock);
685 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
686 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
687 void ldlm_dump_all_namespaces(ldlm_side_t client, int level);
688 void ldlm_namespace_dump(int level, struct ldlm_namespace *);
689 void ldlm_resource_dump(int level, struct ldlm_resource *);
690 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
691                               const struct ldlm_res_id *);
692
693 struct ldlm_callback_suite {
694         ldlm_completion_callback lcs_completion;
695         ldlm_blocking_callback   lcs_blocking;
696         ldlm_glimpse_callback    lcs_glimpse;
697 };
698
699 /* ldlm_request.c */
700 int ldlm_expired_completion_wait(void *data);
701 int ldlm_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
702                       void *data, int flag);
703 int ldlm_glimpse_ast(struct ldlm_lock *lock, void *reqp);
704 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
705 int ldlm_cli_enqueue(struct obd_export *exp, struct ptlrpc_request **reqp,
706                      struct ldlm_enqueue_info *einfo,
707                      const struct ldlm_res_id *res_id,
708                      ldlm_policy_data_t *policy, int *flags,
709                      void *lvb, __u32 lvb_len, void *lvb_swabber,
710                      struct lustre_handle *lockh, int async);
711 int ldlm_prep_enqueue_req(struct obd_export *exp,
712                           struct ptlrpc_request *req,
713                           struct list_head *cancels,
714                           int count);
715 int ldlm_prep_elc_req(struct obd_export *exp,
716                       struct ptlrpc_request *req,
717                       int version, int opc, int canceloff,
718                       struct list_head *cancels, int count);
719 int ldlm_handle_enqueue0(struct ldlm_namespace *ns, struct ptlrpc_request *req,
720                          const struct ldlm_request *dlm_req,
721                          const struct ldlm_callback_suite *cbs);
722 int ldlm_cli_enqueue_fini(struct obd_export *exp, struct ptlrpc_request *req,
723                           ldlm_type_t type, __u8 with_policy, ldlm_mode_t mode,
724                           int *flags, void *lvb, __u32 lvb_len,
725                           void *lvb_swabber, struct lustre_handle *lockh,
726                           int rc);
727 int ldlm_cli_enqueue_local(struct ldlm_namespace *ns,
728                            const struct ldlm_res_id *res_id,
729                            ldlm_type_t type, ldlm_policy_data_t *policy,
730                            ldlm_mode_t mode, int *flags,
731                            ldlm_blocking_callback blocking,
732                            ldlm_completion_callback completion,
733                            ldlm_glimpse_callback glimpse,
734                            void *data, __u32 lvb_len, void *lvb_swabber,
735                            struct lustre_handle *lockh);
736 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
737                     void *data, __u32 data_len);
738 int ldlm_cli_convert(struct lustre_handle *, int new_mode, __u32 *flags);
739 int ldlm_cli_update_pool(struct ptlrpc_request *req);
740 int ldlm_handle_convert0(struct ptlrpc_request *req,
741                          const struct ldlm_request *dlm_req);
742 int ldlm_cli_cancel(struct lustre_handle *lockh);
743 int ldlm_cli_cancel_unused(struct ldlm_namespace *, const struct ldlm_res_id *,
744                            int flags, void *opaque);
745 int ldlm_cli_cancel_unused_resource(struct ldlm_namespace *ns,
746                                     const struct ldlm_res_id *res_id,
747                                     ldlm_policy_data_t *policy,
748                                     ldlm_mode_t mode, int flags, void *opaque);
749 int ldlm_cli_cancel_req(struct obd_export *exp, struct list_head *head,
750                         int count, int flags);
751 int ldlm_cli_join_lru(struct ldlm_namespace *,
752                       const struct ldlm_res_id *, int join);
753 int ldlm_cancel_resource_local(struct ldlm_resource *res,
754                                struct list_head *cancels,
755                                ldlm_policy_data_t *policy,
756                                ldlm_mode_t mode, int lock_flags,
757                                int cancel_flags, void *opaque);
758 int ldlm_cli_cancel_list(struct list_head *head, int count,
759                          struct ptlrpc_request *req, int flags);
760  
761 /* mds/handler.c */
762 /* This has to be here because recursive inclusion sucks. */
763 int intent_disposition(struct ldlm_reply *rep, int flag);
764 void intent_set_disposition(struct ldlm_reply *rep, int flag);
765
766
767 /* ioctls for trying requests */
768 #define IOC_LDLM_TYPE                   'f'
769 #define IOC_LDLM_MIN_NR                 40
770
771 #define IOC_LDLM_TEST                   _IOWR('f', 40, long)
772 #define IOC_LDLM_DUMP                   _IOWR('f', 41, long)
773 #define IOC_LDLM_REGRESS_START          _IOWR('f', 42, long)
774 #define IOC_LDLM_REGRESS_STOP           _IOWR('f', 43, long)
775 #define IOC_LDLM_MAX_NR                 43
776
777 static inline void lock_res(struct ldlm_resource *res)
778 {
779         spin_lock(&res->lr_lock);
780 }
781
782 static inline void unlock_res(struct ldlm_resource *res)
783 {
784         spin_unlock(&res->lr_lock);
785 }
786
787 static inline void check_res_locked(struct ldlm_resource *res)
788 {
789         LASSERT_SPIN_LOCKED(&res->lr_lock);
790 }
791
792 struct ldlm_resource * lock_res_and_lock(struct ldlm_lock *lock);
793 void unlock_res_and_lock(struct ldlm_lock *lock);
794
795 /* ldlm_pool.c */
796 void ldlm_pools_recalc(ldlm_side_t client);
797 int ldlm_pools_init(void);
798 void ldlm_pools_fini(void);
799 void ldlm_pools_wakeup(void);
800
801 int ldlm_pool_init(struct ldlm_pool *pl, struct ldlm_namespace *ns, 
802                    int idx, ldlm_side_t client);
803 int ldlm_pool_shrink(struct ldlm_pool *pl, int nr, 
804                      unsigned int gfp_mask);
805 void ldlm_pool_fini(struct ldlm_pool *pl);
806 int ldlm_pool_setup(struct ldlm_pool *pl, int limit);
807 int ldlm_pool_recalc(struct ldlm_pool *pl);
808 __u64 ldlm_pool_get_slv(struct ldlm_pool *pl);
809 __u32 ldlm_pool_get_limit(struct ldlm_pool *pl);
810 void ldlm_pool_set_slv(struct ldlm_pool *pl, __u64 slv);
811 void ldlm_pool_set_limit(struct ldlm_pool *pl, __u32 limit);
812 void ldlm_pool_add(struct ldlm_pool *pl, struct ldlm_lock *lock);
813 void ldlm_pool_del(struct ldlm_pool *pl, struct ldlm_lock *lock);
814 #endif
815