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