1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * (visit-tags-table FILE)
3 * vim:expandtab:shiftwidth=8:tabstop=8:
6 #ifndef _LUSTRE_DLM_H__
7 #define _LUSTRE_DLM_H__
10 # include <linux/proc_fs.h>
13 #include <linux/lustre_lib.h>
14 #include <linux/lustre_net.h>
15 #include <linux/lustre_import.h>
16 #include <linux/lustre_handles.h>
17 #include <linux/lustre_export.h> /* for obd_export, for LDLM_DEBUG */
22 #define OBD_LDLM_DEVICENAME "ldlm"
24 #define LDLM_DEFAULT_LRU_SIZE 100
29 ELDLM_LOCK_CHANGED = 300,
30 ELDLM_LOCK_ABORTED = 301,
31 ELDLM_LOCK_REPLACED = 302,
33 ELDLM_NAMESPACE_EXISTS = 400,
34 ELDLM_BAD_NAMESPACE = 401
37 #define LDLM_NAMESPACE_SERVER 0
38 #define LDLM_NAMESPACE_CLIENT 1
40 #define LDLM_FL_LOCK_CHANGED 0x000001 /* extent, mode, or resource changed */
42 /* If the server returns one of these flags, then the lock was put on that list.
43 * If the client sends one of these flags (during recovery ONLY!), it wants the
44 * lock added to the specified list, no questions asked. -p */
45 #define LDLM_FL_BLOCK_GRANTED 0x000002
46 #define LDLM_FL_BLOCK_CONV 0x000004
47 #define LDLM_FL_BLOCK_WAIT 0x000008
49 #define LDLM_FL_CBPENDING 0x000010 /* this lock is being destroyed */
50 #define LDLM_FL_AST_SENT 0x000020 /* blocking or cancel packet was sent */
51 #define LDLM_FL_WAIT_NOREPROC 0x000040 /* not a real flag, not saved in lock */
52 #define LDLM_FL_CANCEL 0x000080 /* cancellation callback already run */
54 /* Lock is being replayed. This could probably be implied by the fact that one
55 * of BLOCK_{GRANTED,CONV,WAIT} is set, but that is pretty dangerous. */
56 #define LDLM_FL_REPLAY 0x000100
58 #define LDLM_FL_INTENT_ONLY 0x000200 /* don't grant lock, just do intent */
59 #define LDLM_FL_LOCAL_ONLY 0x000400 /* see ldlm_cli_cancel_unused */
61 /* don't run the cancel callback under ldlm_cli_cancel_unused */
62 #define LDLM_FL_NO_CALLBACK 0x000800
64 #define LDLM_FL_HAS_INTENT 0x001000 /* lock request has intent */
65 #define LDLM_FL_CANCELING 0x002000 /* lock cancel has already been sent */
66 #define LDLM_FL_LOCAL 0x004000 /* local lock (ie, no srv/cli split) */
67 #define LDLM_FL_WARN 0x008000 /* see ldlm_cli_cancel_unused */
68 #define LDLM_FL_DISCARD_DATA 0x010000 /* discard (no writeback) on cancel */
70 /* file & record locking */
71 #define LDLM_FL_BLOCK_NOWAIT 0x040000 // server told not to wait if blocked
72 #define LDLM_FL_TEST_LOCK 0x080000 // return blocking lock
74 /* These are flags that are mapped into the flags and ASTs of blocking locks */
75 #define LDLM_AST_DISCARD_DATA 0x80000000 /* Add FL_DISCARD to blocking ASTs */
76 /* Flags sent in AST lock_flags to be mapped into the receiving lock. */
77 #define LDLM_AST_FLAGS (LDLM_FL_DISCARD_DATA)
79 /* XXX FIXME: This is being added to b_size as a low-risk fix to the fact that
80 * the LVB filling happens _after_ the lock has been granted, so another thread
81 * can match before the LVB has been updated. As a dirty hack, we set
82 * LDLM_FL_CAN_MATCH only after we've done the LVB poop.
84 * The proper fix is to do the granting inside of the completion AST, which can
85 * be replaced with a LVB-aware wrapping function for OSC locks. That change is
86 * pretty high-risk, though, and would need a lot more testing. */
87 #define LDLM_FL_CAN_MATCH 0x100000
89 /* The blocking callback is overloaded to perform two functions. These flags
90 * indicate which operation should be performed. */
91 #define LDLM_CB_BLOCKING 1
92 #define LDLM_CB_CANCELING 2
94 /* compatibility matrix */
95 #define LCK_COMPAT_EX LCK_NL
96 #define LCK_COMPAT_PW (LCK_COMPAT_EX | LCK_CR)
97 #define LCK_COMPAT_PR (LCK_COMPAT_PW | LCK_PR)
98 #define LCK_COMPAT_CW (LCK_COMPAT_PW | LCK_CW)
99 #define LCK_COMPAT_CR (LCK_COMPAT_CW | LCK_PR | LCK_PW)
100 #define LCK_COMPAT_NL (LCK_COMPAT_CR | LCK_EX)
102 static ldlm_mode_t lck_compat_array[] = {
103 [LCK_EX] LCK_COMPAT_EX,
104 [LCK_PW] LCK_COMPAT_PW,
105 [LCK_PR] LCK_COMPAT_PR,
106 [LCK_CW] LCK_COMPAT_CW,
107 [LCK_CR] LCK_COMPAT_CR,
108 [LCK_NL] LCK_COMPAT_NL
111 static inline void lockmode_verify(ldlm_mode_t mode)
113 LASSERT(mode >= LCK_EX && mode <= LCK_NL);
116 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
118 return (lck_compat_array[exist] & new);
123 * cluster name spaces
127 #define DLM_OST_NAMESPACE 1
128 #define DLM_MDS_NAMESPACE 2
131 - do we just separate this by security domains and use a prefix for
132 multiple namespaces in the same domain?
137 struct ldlm_resource;
138 struct ldlm_namespace;
140 typedef int (*ldlm_res_policy)(struct ldlm_namespace *, struct ldlm_lock **,
141 void *req_cookie, ldlm_mode_t mode, int flags,
144 struct ldlm_valblock_ops {
145 int (*lvbo_init)(struct ldlm_resource *res);
146 int (*lvbo_update)(struct ldlm_resource *res, struct lustre_msg *m,
150 struct ldlm_namespace {
152 __u32 ns_client; /* is this a client-side lock tree? */
153 struct list_head *ns_hash; /* hash table for ns */
154 __u32 ns_refcount; /* count of resources in the hash */
155 struct list_head ns_root_list; /* all root resources in ns */
156 struct lustre_lock ns_lock; /* protects hash, refcount, list */
157 struct list_head ns_list_chain; /* position in global NS list */
159 struct proc_dir_entry *ns_proc_dir;
162 struct list_head ns_unused_list; /* all root resources in ns */
164 unsigned int ns_max_unused;
166 spinlock_t ns_counter_lock;
169 ldlm_res_policy ns_policy;
170 struct ldlm_valblock_ops *ns_lvbo;
176 * Resource hash table
180 #define RES_HASH_BITS 10
181 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
182 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
186 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
187 struct ldlm_lock_desc *new, void *data,
189 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags,
191 typedef int (*ldlm_glimpse_callback)(struct ldlm_lock *lock, void *data);
194 struct portals_handle l_handle; // must be first in the structure
196 struct ldlm_resource *l_resource;
197 struct ldlm_lock *l_parent;
198 struct list_head l_children;
199 struct list_head l_childof;
200 struct list_head l_lru;
201 struct list_head l_res_link; // position in one of three res lists
202 struct list_head l_export_chain; // per-export chain of locks
204 ldlm_mode_t l_req_mode;
205 ldlm_mode_t l_granted_mode;
207 ldlm_completion_callback l_completion_ast;
208 ldlm_blocking_callback l_blocking_ast;
209 ldlm_glimpse_callback l_glimpse_ast;
211 struct obd_export *l_export;
212 struct obd_export *l_conn_export;
214 struct lustre_handle l_remote_handle;
215 ldlm_policy_data_t l_policy_data;
221 /* If the lock is granted, a process sleeps on this waitq to learn when
222 * it's no longer in use. If the lock is not granted, a process sleeps
223 * on this waitq to learn when it becomes granted. */
224 wait_queue_head_t l_waitq;
225 struct timeval l_enqueued_time;
227 unsigned long l_last_used; /* jiffies */
228 struct ldlm_extent l_req_extent;
230 /* Client-side-only members */
231 __u32 l_lvb_len; /* temporary storage for */
232 void *l_lvb_data; /* an LVB received during */
233 void *l_lvb_swabber; /* an enqueue */
236 /* Server-side-only members */
237 struct list_head l_pending_chain; /* callbacks pending */
238 unsigned long l_callback_timeout;
241 #define LDLM_PLAIN 10
242 #define LDLM_EXTENT 11
243 #define LDLM_FLOCK 12
245 #define LDLM_MIN_TYPE 10
246 #define LDLM_MAX_TYPE 12
248 struct ldlm_resource {
249 struct ldlm_namespace *lr_namespace;
250 struct list_head lr_hash;
251 struct ldlm_resource *lr_parent; /* 0 for a root resource */
252 struct list_head lr_children; /* list head for child resources */
253 struct list_head lr_childof; /* part of ns_root_list if root res,
254 * part of lr_children if child */
256 struct list_head lr_granted;
257 struct list_head lr_converting;
258 struct list_head lr_waiting;
259 ldlm_mode_t lr_most_restr;
260 __u32 lr_type; /* LDLM_PLAIN or LDLM_EXTENT */
261 struct ldlm_resource *lr_root;
262 struct ldlm_res_id lr_name;
263 atomic_t lr_refcount;
265 /* Server-side-only lock value block elements */
266 struct semaphore lr_lvb_sem;
270 /* lr_tmp holds a list head temporarily, during the building of a work
271 * queue. see ldlm_add_ast_work_item and ldlm_run_ast_work */
275 struct ldlm_ast_work {
276 struct ldlm_lock *w_lock;
278 struct ldlm_lock_desc w_desc;
279 struct list_head w_list;
285 extern struct obd_ops ldlm_obd_ops;
287 extern char *ldlm_lockname[];
288 extern char *ldlm_typename[];
289 extern char *ldlm_it2str(int it);
291 #define __LDLM_DEBUG(level, lock, format, a...) \
293 if (lock->l_resource == NULL) { \
294 CDEBUG(level, "### " format \
295 " ns: \?\? lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s "\
296 "res: \?\? rrc=\?\? type: \?\?\? flags: %x remote: " \
297 LPX64" expref: %d\n" , ## a, lock, \
298 lock->l_handle.h_cookie, atomic_read(&lock->l_refc), \
299 lock->l_readers, lock->l_writers, \
300 ldlm_lockname[lock->l_granted_mode], \
301 ldlm_lockname[lock->l_req_mode], \
302 lock->l_flags, lock->l_remote_handle.cookie, \
304 atomic_read(&lock->l_export->exp_refcount) : -99); \
307 if (lock->l_resource->lr_type == LDLM_EXTENT) { \
308 CDEBUG(level, "### " format \
309 " ns: %s lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s " \
310 "res: "LPU64"/"LPU64" rrc: %d type: %s ["LPU64"->"LPU64\
311 "] (req "LPU64"->"LPU64") flags: %x remote: "LPX64 \
312 " expref: %d\n" , ## a, \
313 lock->l_resource->lr_namespace->ns_name, lock, \
314 lock->l_handle.h_cookie, atomic_read(&lock->l_refc), \
315 lock->l_readers, lock->l_writers, \
316 ldlm_lockname[lock->l_granted_mode], \
317 ldlm_lockname[lock->l_req_mode], \
318 lock->l_resource->lr_name.name[0], \
319 lock->l_resource->lr_name.name[1], \
320 atomic_read(&lock->l_resource->lr_refcount), \
321 ldlm_typename[lock->l_resource->lr_type], \
322 lock->l_policy_data.l_extent.start, \
323 lock->l_policy_data.l_extent.end, \
324 lock->l_req_extent.start, lock->l_req_extent.end, \
325 lock->l_flags, lock->l_remote_handle.cookie, \
327 atomic_read(&lock->l_export->exp_refcount) : -99); \
330 if (lock->l_resource->lr_type == LDLM_FLOCK) { \
331 CDEBUG(level, "### " format \
332 " ns: %s lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s " \
333 "res: "LPU64"/"LPU64" rrc: %d type: %s pid: %d " \
334 "["LPU64"->"LPU64"] flags: %x remote: "LPX64 \
335 " expref: %d\n" , ## a, \
336 lock->l_resource->lr_namespace->ns_name, lock, \
337 lock->l_handle.h_cookie, atomic_read(&lock->l_refc), \
338 lock->l_readers, lock->l_writers, \
339 ldlm_lockname[lock->l_granted_mode], \
340 ldlm_lockname[lock->l_req_mode], \
341 lock->l_resource->lr_name.name[0], \
342 lock->l_resource->lr_name.name[1], \
343 atomic_read(&lock->l_resource->lr_refcount), \
344 ldlm_typename[lock->l_resource->lr_type], \
345 lock->l_policy_data.l_flock.pid, \
346 lock->l_policy_data.l_flock.start, \
347 lock->l_policy_data.l_flock.end, \
348 lock->l_flags, lock->l_remote_handle.cookie, \
350 atomic_read(&lock->l_export->exp_refcount) : -99); \
354 CDEBUG(level, "### " format \
355 " ns: %s lock: %p/"LPX64" lrc: %d/%d,%d mode: %s/%s " \
356 "res: "LPU64"/"LPU64" rrc: %d type: %s flags: %x " \
357 "remote: "LPX64" expref: %d\n" , ## a, \
358 lock->l_resource->lr_namespace->ns_name, \
359 lock, lock->l_handle.h_cookie, \
360 atomic_read (&lock->l_refc), \
361 lock->l_readers, lock->l_writers, \
362 ldlm_lockname[lock->l_granted_mode], \
363 ldlm_lockname[lock->l_req_mode], \
364 lock->l_resource->lr_name.name[0], \
365 lock->l_resource->lr_name.name[1], \
366 atomic_read(&lock->l_resource->lr_refcount), \
367 ldlm_typename[lock->l_resource->lr_type], \
368 lock->l_flags, lock->l_remote_handle.cookie, \
370 atomic_read(&lock->l_export->exp_refcount) : -99); \
374 #define LDLM_DEBUG(lock, format, a...) __LDLM_DEBUG(D_DLMTRACE, lock, \
376 #define LDLM_ERROR(lock, format, a...) __LDLM_DEBUG(D_ERROR, lock, format, ## a)
378 #define LDLM_DEBUG_NOLOCK(format, a...) \
379 CDEBUG(D_DLMTRACE, "### " format "\n" , ## a)
381 typedef int (*ldlm_processing_policy)(struct ldlm_lock *lock, int *flags,
382 int first_enq, ldlm_error_t *err);
388 #define LDLM_ITER_CONTINUE 1 /* keep iterating */
389 #define LDLM_ITER_STOP 2 /* stop iterating */
391 typedef int (*ldlm_iterator_t)(struct ldlm_lock *, void *);
392 typedef int (*ldlm_res_iterator_t)(struct ldlm_resource *, void *);
394 int ldlm_resource_foreach(struct ldlm_resource *res, ldlm_iterator_t iter,
396 int ldlm_namespace_foreach(struct ldlm_namespace *ns, ldlm_iterator_t iter,
398 int ldlm_namespace_foreach_res(struct ldlm_namespace *ns,
399 ldlm_res_iterator_t iter, void *closure);
401 int ldlm_replay_locks(struct obd_import *imp);
402 void ldlm_change_cbdata(struct ldlm_namespace *, struct ldlm_res_id *,
403 ldlm_iterator_t iter, void *data);
406 int ldlm_flock_completion_ast(struct ldlm_lock *lock, int flags, void *data);
409 __u64 ldlm_extent_shift_kms(struct ldlm_lock *lock, __u64 old_kms);
413 int ldlm_server_blocking_ast(struct ldlm_lock *, struct ldlm_lock_desc *,
414 void *data, int flag);
415 int ldlm_server_completion_ast(struct ldlm_lock *lock, int flags, void *data);
416 int ldlm_server_glimpse_ast(struct ldlm_lock *lock, void *data);
417 int ldlm_handle_enqueue(struct ptlrpc_request *req, ldlm_completion_callback,
418 ldlm_blocking_callback, ldlm_glimpse_callback);
419 int ldlm_handle_convert(struct ptlrpc_request *req);
420 int ldlm_handle_cancel(struct ptlrpc_request *req);
421 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
422 int ldlm_get_ref(void);
423 void ldlm_put_ref(int force);
426 ldlm_processing_policy ldlm_get_processing_policy(struct ldlm_resource *res);
427 void ldlm_register_intent(struct ldlm_namespace *ns, ldlm_res_policy arg);
428 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
429 struct ldlm_lock *__ldlm_handle2lock(struct lustre_handle *, int flags);
430 void ldlm_cancel_callback(struct ldlm_lock *);
431 int ldlm_lock_set_data(struct lustre_handle *, void *data);
432 void ldlm_lock_remove_from_lru(struct ldlm_lock *);
433 struct ldlm_lock *ldlm_handle2lock_ns(struct ldlm_namespace *,
434 struct lustre_handle *);
436 static inline struct ldlm_lock *ldlm_handle2lock(struct lustre_handle *h)
438 return __ldlm_handle2lock(h, 0);
441 #define LDLM_LOCK_PUT(lock) \
443 /*LDLM_DEBUG((lock), "put");*/ \
444 ldlm_lock_put(lock); \
447 #define LDLM_LOCK_GET(lock) \
449 ldlm_lock_get(lock); \
450 /*LDLM_DEBUG((lock), "get");*/ \
454 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
455 void ldlm_lock_put(struct ldlm_lock *lock);
456 void ldlm_lock_destroy(struct ldlm_lock *lock);
457 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
458 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
459 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
460 void ldlm_lock_decref_and_cancel(struct lustre_handle *lockh, __u32 mode);
461 void ldlm_lock_allow_match(struct ldlm_lock *lock);
462 int ldlm_lock_match(struct ldlm_namespace *ns, int flags, struct ldlm_res_id *,
463 __u32 type, ldlm_policy_data_t *, ldlm_mode_t mode,
464 struct lustre_handle *);
465 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
467 void ldlm_lock_cancel(struct ldlm_lock *lock);
468 void ldlm_cancel_locks_for_export(struct obd_export *export);
469 void ldlm_reprocess_all(struct ldlm_resource *res);
470 void ldlm_reprocess_all_ns(struct ldlm_namespace *ns);
471 void ldlm_lock_dump(int level, struct ldlm_lock *lock, int pos);
472 void ldlm_lock_dump_handle(int level, struct lustre_handle *);
475 int ldlm_test(struct obd_device *device, struct lustre_handle *connh);
476 int ldlm_regression_start(struct obd_device *obddev,
477 struct lustre_handle *connh,
478 unsigned int threads, unsigned int max_locks_in,
479 unsigned int num_resources_in,
480 unsigned int num_extents_in);
481 int ldlm_regression_stop(void);
485 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
486 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int flags);
487 int ldlm_namespace_free(struct ldlm_namespace *ns, int force);
488 int ldlm_proc_setup(void);
489 void ldlm_proc_cleanup(void);
491 /* resource.c - internal */
492 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
493 struct ldlm_resource *parent,
494 struct ldlm_res_id, __u32 type,
496 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
497 int ldlm_resource_putref(struct ldlm_resource *res);
498 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
499 struct ldlm_lock *lock);
500 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
501 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
502 void ldlm_dump_all_namespaces(void);
503 void ldlm_namespace_dump(struct ldlm_namespace *);
504 void ldlm_resource_dump(struct ldlm_resource *);
505 int ldlm_lock_change_resource(struct ldlm_namespace *, struct ldlm_lock *,
509 int ldlm_expired_completion_wait(void *data);
510 int ldlm_completion_ast(struct ldlm_lock *lock, int flags, void *data);
511 int ldlm_cli_enqueue(struct obd_export *exp,
512 struct ptlrpc_request *req,
513 struct ldlm_namespace *ns,
516 ldlm_policy_data_t *,
519 ldlm_blocking_callback blocking,
520 ldlm_completion_callback completion,
521 ldlm_glimpse_callback glimpse,
526 struct lustre_handle *lockh);
527 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
528 void *data, __u32 data_len);
529 int ldlm_cli_convert(struct lustre_handle *, int new_mode, int *flags);
530 int ldlm_cli_cancel(struct lustre_handle *lockh);
531 int ldlm_cli_cancel_unused(struct ldlm_namespace *, struct ldlm_res_id *,
532 int flags, void *opaque);
535 /* This has to be here because recursive inclusion sucks. */
536 int intent_disposition(struct ldlm_reply *rep, int flag);
537 void intent_set_disposition(struct ldlm_reply *rep, int flag);
538 int mds_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
539 void *data, int flag);
542 /* ioctls for trying requests */
543 #define IOC_LDLM_TYPE 'f'
544 #define IOC_LDLM_MIN_NR 40
546 #define IOC_LDLM_TEST _IOWR('f', 40, long)
547 #define IOC_LDLM_DUMP _IOWR('f', 41, long)
548 #define IOC_LDLM_REGRESS_START _IOWR('f', 42, long)
549 #define IOC_LDLM_REGRESS_STOP _IOWR('f', 43, long)
550 #define IOC_LDLM_MAX_NR 43