1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
5 #ifndef _LUSTRE_DLM_H__
6 #define _LUSTRE_DLM_H__
10 #include <linux/proc_fs.h>
11 #include <linux/lustre_lib.h>
12 #include <linux/lustre_net.h>
13 #include <linux/lustre_import.h>
18 #define OBD_LDLM_DEVICENAME "ldlm"
23 ELDLM_LOCK_CHANGED = 300,
24 ELDLM_LOCK_ABORTED = 301,
26 ELDLM_NAMESPACE_EXISTS = 400,
27 ELDLM_BAD_NAMESPACE = 401
30 #define LDLM_NAMESPACE_SERVER 0
31 #define LDLM_NAMESPACE_CLIENT 1
33 #define LDLM_FL_LOCK_CHANGED (1 << 0)
34 #define LDLM_FL_BLOCK_GRANTED (1 << 1)
35 #define LDLM_FL_BLOCK_CONV (1 << 2)
36 #define LDLM_FL_BLOCK_WAIT (1 << 3)
37 #define LDLM_FL_CBPENDING (1 << 4)
38 #define LDLM_FL_AST_SENT (1 << 5)
39 #define LDLM_FL_DESTROYED (1 << 6)
40 #define LDLM_FL_WAIT_NOREPROC (1 << 7)
41 #define LDLM_FL_CANCEL (1 << 8)
42 #define LDLM_FL_REPLAY (1 << 9)
43 #define LDLM_FL_INTENT_ONLY (1 << 10) /* don't grant lock, just do intent */
45 #define LDLM_CB_BLOCKING 1
46 #define LDLM_CB_CANCELING 2
48 #define L2B(c) (1 << c)
50 /* compatibility matrix */
51 #define LCK_COMPAT_EX L2B(LCK_NL)
52 #define LCK_COMPAT_PW (LCK_COMPAT_EX | L2B(LCK_CR))
53 #define LCK_COMPAT_PR (LCK_COMPAT_PW | L2B(LCK_PR))
54 #define LCK_COMPAT_CW (LCK_COMPAT_PW | L2B(LCK_CW))
55 #define LCK_COMPAT_CR (LCK_COMPAT_CW | L2B(LCK_PR) | L2B(LCK_PW))
56 #define LCK_COMPAT_NL (LCK_COMPAT_CR | L2B(LCK_EX))
58 static ldlm_mode_t lck_compat_array[] = {
59 [LCK_EX] LCK_COMPAT_EX,
60 [LCK_PW] LCK_COMPAT_PW,
61 [LCK_PR] LCK_COMPAT_PR,
62 [LCK_CW] LCK_COMPAT_CW,
63 [LCK_CR] LCK_COMPAT_CR,
64 [LCK_NL] LCK_COMPAT_NL
67 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
69 if (exist < LCK_EX || exist > LCK_NL)
71 if (new < LCK_EX || new > LCK_NL)
74 return (lck_compat_array[exist] & L2B(new));
83 #define DLM_OST_NAMESPACE 1
84 #define DLM_MDS_NAMESPACE 2
87 - do we just separate this by security domains and use a prefix for
88 multiple namespaces in the same domain?
92 struct ldlm_namespace {
94 __u32 ns_client; /* is this a client-side lock tree? */
95 struct list_head *ns_hash; /* hash table for ns */
96 __u32 ns_refcount; /* count of resources in the hash */
97 struct list_head ns_root_list; /* all root resources in ns */
98 struct lustre_lock ns_lock; /* protects hash, refcount, list */
99 struct list_head ns_list_chain; /* position in global NS list */
100 struct proc_dir_entry *ns_proc_dir;
102 spinlock_t ns_counter_lock;
109 * Resource hash table
113 #define RES_HASH_BITS 14
114 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
115 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
119 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
120 struct ldlm_lock_desc *new, void *data,
121 __u32 data_len, int flag);
123 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags);
128 struct ldlm_resource *l_resource;
129 struct ldlm_lock *l_parent;
130 struct list_head l_children;
131 struct list_head l_childof;
132 struct list_head l_res_link; /*position in one of three res lists*/
133 struct list_head l_export_chain; /* per-export chain of locks */
134 struct list_head l_pending_chain; /* locks with callbacks pending*/
135 unsigned long l_callback_timeout;
137 ldlm_mode_t l_req_mode;
138 ldlm_mode_t l_granted_mode;
140 ldlm_completion_callback l_completion_ast;
141 ldlm_blocking_callback l_blocking_ast;
143 struct obd_export *l_export;
144 struct lustre_handle *l_connh;
146 struct lustre_handle l_remote_handle;
149 struct ldlm_extent l_extent;
150 __u32 l_version[RES_VERSION_SIZE];
155 /* If the lock is granted, a process sleeps on this waitq to learn when
156 * it's no longer in use. If the lock is not granted, a process sleeps
157 * on this waitq to learn when it becomes granted. */
158 wait_queue_head_t l_waitq;
161 typedef int (*ldlm_res_compat)(struct ldlm_lock *child, struct ldlm_lock *new);
162 typedef int (*ldlm_res_policy)(struct ldlm_lock *lock, void *req_cookie,
163 ldlm_mode_t mode, int flags, void *data);
165 #define LDLM_PLAIN 10
166 #define LDLM_EXTENT 11
167 #define LDLM_MDSINTENT 12
169 #define LDLM_MIN_TYPE 10
170 #define LDLM_MAX_TYPE 12
172 extern ldlm_res_compat ldlm_res_compat_table [];
173 extern ldlm_res_policy ldlm_res_policy_table [];
175 struct ldlm_resource {
176 struct ldlm_namespace *lr_namespace;
177 struct list_head lr_hash;
178 struct ldlm_resource *lr_parent; /* 0 for a root resource */
179 struct list_head lr_children; /* list head for child resources */
180 struct list_head lr_childof; /* part of ns_root_list if root res,
181 * part of lr_children if child */
183 struct list_head lr_granted;
184 struct list_head lr_converting;
185 struct list_head lr_waiting;
186 ldlm_mode_t lr_most_restr;
187 __u32 lr_type; /* PLAIN, EXTENT, or MDSINTENT */
188 struct ldlm_resource *lr_root;
189 __u64 lr_name[RES_NAME_SIZE];
190 __u32 lr_version[RES_VERSION_SIZE];
191 atomic_t lr_refcount;
195 struct ldlm_ast_work {
196 struct ldlm_lock *w_lock;
198 struct ldlm_lock_desc w_desc;
199 struct list_head w_list;
205 /* Per-export ldlm state. */
206 struct ldlm_export_data {
207 struct list_head led_held_locks;
208 struct obd_import led_import;
211 static inline struct ldlm_extent *ldlm_res2extent(struct ldlm_resource *res)
213 return (struct ldlm_extent *)(res->lr_name);
216 extern struct obd_ops ldlm_obd_ops;
218 extern char *ldlm_lockname[];
219 extern char *ldlm_typename[];
220 extern char *ldlm_it2str(int it);
222 #define LDLM_DEBUG(lock, format, a...) \
224 if (lock->l_resource == NULL) { \
225 CDEBUG(D_DLMTRACE, "### " format \
226 " (UNKNOWN: lock %p(rc=%d/%d,%d) mode %s/%s on " \
227 "res \?\? (rc=\?\?) type \?\?\? remote "LPX64")\n" \
228 , ## a, lock, lock->l_refc, lock->l_readers, \
230 ldlm_lockname[lock->l_granted_mode], \
231 ldlm_lockname[lock->l_req_mode], \
232 lock->l_remote_handle.addr); \
235 if (lock->l_resource->lr_type == LDLM_EXTENT) { \
236 CDEBUG(D_DLMTRACE, "### " format \
237 " (%s: lock %p(rc=%d/%d,%d) mode %s/%s on res " \
238 LPU64" (rc=%d) type %s ["LPU64"->"LPU64"] remote " \
240 lock->l_resource->lr_namespace->ns_name, lock, \
241 lock->l_refc, lock->l_readers, lock->l_writers, \
242 ldlm_lockname[lock->l_granted_mode], \
243 ldlm_lockname[lock->l_req_mode], \
244 lock->l_resource->lr_name[0], \
245 atomic_read(&lock->l_resource->lr_refcount), \
246 ldlm_typename[lock->l_resource->lr_type], \
247 lock->l_extent.start, lock->l_extent.end, \
248 lock->l_remote_handle.addr); \
252 CDEBUG(D_DLMTRACE, "### " format \
253 " (%s: lock %p(rc=%d/%d,%d) mode %s/%s on res " \
254 LPU64" (rc=%d) type %s remote "LPX64")\n" , ## a, \
255 lock->l_resource->lr_namespace->ns_name, lock, \
256 lock->l_refc, lock->l_readers, lock->l_writers, \
257 ldlm_lockname[lock->l_granted_mode], \
258 ldlm_lockname[lock->l_req_mode], \
259 lock->l_resource->lr_name[0], \
260 atomic_read(&lock->l_resource->lr_refcount), \
261 ldlm_typename[lock->l_resource->lr_type], \
262 lock->l_remote_handle.addr); \
266 #define LDLM_DEBUG_NOLOCK(format, a...) \
267 CDEBUG(D_DLMTRACE, "### " format "\n" , ## a)
270 int ldlm_extent_compat(struct ldlm_lock *, struct ldlm_lock *);
271 int ldlm_extent_policy(struct ldlm_lock *, void *, ldlm_mode_t, int flags,
275 int ldlm_handle_enqueue(struct ptlrpc_request *req);
276 int ldlm_handle_convert(struct ptlrpc_request *req);
277 int ldlm_handle_cancel(struct ptlrpc_request *req);
278 int ldlm_del_waiting_lock(struct ldlm_lock *lock);
281 void ldlm_register_intent(int (*arg)(struct ldlm_lock *lock, void *req_cookie,
282 ldlm_mode_t mode, int flags, void *data));
283 void ldlm_unregister_intent(void);
284 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
285 struct ldlm_lock *__ldlm_handle2lock(struct lustre_handle *, int strict);
286 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
287 void ldlm_cancel_callback(struct ldlm_lock *lock);
289 static inline struct ldlm_lock *ldlm_handle2lock(struct lustre_handle *h)
291 return __ldlm_handle2lock(h, 1);
294 #define LDLM_LOCK_PUT(lock) \
296 /*LDLM_DEBUG(lock, "put");*/ \
297 ldlm_lock_put(lock); \
300 #define LDLM_LOCK_GET(lock) \
302 ldlm_lock_get(lock); \
303 /*LDLM_DEBUG(lock, "get");*/ \
307 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
308 void ldlm_lock_put(struct ldlm_lock *lock);
309 void ldlm_lock_destroy(struct ldlm_lock *lock);
310 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
311 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
312 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
313 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
314 void ldlm_grant_lock(struct ldlm_lock *lock);
315 int ldlm_lock_match(struct ldlm_namespace *ns, __u64 *res_id, __u32 type,
316 void *cookie, int cookielen, ldlm_mode_t mode,
317 struct lustre_handle *lockh);
319 ldlm_lock_create(struct ldlm_namespace *ns,
320 struct lustre_handle *parent_lock_handle,
321 __u64 *res_id, __u32 type, ldlm_mode_t mode, void *data,
323 ldlm_error_t ldlm_lock_enqueue(struct ldlm_lock *lock, void *cookie,
324 int cookie_len, int *flags,
325 ldlm_completion_callback completion,
326 ldlm_blocking_callback blocking);
327 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
329 void ldlm_lock_cancel(struct ldlm_lock *lock);
330 void ldlm_cancel_locks_for_export(struct obd_export *export);
331 void ldlm_run_ast_work(struct list_head *rpc_list);
332 void ldlm_reprocess_all(struct ldlm_resource *res);
333 void ldlm_lock_dump(struct ldlm_lock *lock);
336 int ldlm_test(struct obd_device *device, struct lustre_handle *connh);
337 int ldlm_regression_start(struct obd_device *obddev,
338 struct lustre_handle *connh,
339 unsigned int threads, unsigned int max_locks_in,
340 unsigned int num_resources_in,
341 unsigned int num_extents_in);
342 int ldlm_regression_stop(void);
346 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
347 int ldlm_namespace_cleanup(struct ldlm_namespace *ns, int local_only);
348 int ldlm_namespace_free(struct ldlm_namespace *ns);
349 int ldlm_proc_setup(struct obd_device *obd);
350 void ldlm_proc_cleanup(struct obd_device *obd);
352 /* resource.c - internal */
353 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
354 struct ldlm_resource *parent,
355 __u64 *name, __u32 type, int create);
356 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
357 int ldlm_resource_put(struct ldlm_resource *res);
358 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
359 struct ldlm_lock *lock);
360 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
361 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
362 void ldlm_dump_all_namespaces(void);
363 void ldlm_namespace_dump(struct ldlm_namespace *);
364 void ldlm_resource_dump(struct ldlm_resource *);
365 int ldlm_lock_change_resource(struct ldlm_lock *, __u64 new_resid[3]);
368 int ldlm_completion_ast(struct ldlm_lock *lock, int flags);
369 int ldlm_cli_enqueue(struct lustre_handle *conn,
370 struct ptlrpc_request *req,
371 struct ldlm_namespace *ns,
372 struct lustre_handle *parent_lock_handle,
375 void *cookie, int cookielen,
378 ldlm_completion_callback completion,
379 ldlm_blocking_callback callback,
382 struct lustre_handle *lockh);
383 int ldlm_match_or_enqueue(struct lustre_handle *connh,
384 struct ptlrpc_request *req,
385 struct ldlm_namespace *ns,
386 struct lustre_handle *parent_lock_handle,
389 void *cookie, int cookielen,
392 ldlm_completion_callback completion,
393 ldlm_blocking_callback callback,
396 struct lustre_handle *lockh);
397 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
398 void *data, __u32 data_len);
399 int ldlm_cli_convert(struct lustre_handle *, int new_mode, int *flags);
400 int ldlm_cli_cancel(struct lustre_handle *lockh);
401 int ldlm_cli_cancel_unused(struct ldlm_namespace *, __u64 *, int local_only);
404 /* This has to be here because recurisve inclusion sucks. */
405 int mds_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
406 void *data, __u32 data_len, int flag);
408 #endif /* __KERNEL__ */
410 /* ioctls for trying requests */
411 #define IOC_LDLM_TYPE 'f'
412 #define IOC_LDLM_MIN_NR 40
414 #define IOC_LDLM_TEST _IOWR('f', 40, long)
415 #define IOC_LDLM_DUMP _IOWR('f', 41, long)
416 #define IOC_LDLM_REGRESS_START _IOWR('f', 42, long)
417 #define IOC_LDLM_REGRESS_STOP _IOWR('f', 43, long)
418 #define IOC_LDLM_MAX_NR 43