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,
25 ELDLM_RESOURCE_FREED = 302,
27 ELDLM_NAMESPACE_EXISTS = 400,
28 ELDLM_BAD_NAMESPACE = 401
31 #define LDLM_NAMESPACE_SERVER 0
32 #define LDLM_NAMESPACE_CLIENT 1
34 #define LDLM_FL_LOCK_CHANGED (1 << 0)
35 #define LDLM_FL_BLOCK_GRANTED (1 << 1)
36 #define LDLM_FL_BLOCK_CONV (1 << 2)
37 #define LDLM_FL_BLOCK_WAIT (1 << 3)
38 #define LDLM_FL_CBPENDING (1 << 4)
39 #define LDLM_FL_AST_SENT (1 << 5)
40 #define LDLM_FL_DESTROYED (1 << 6)
41 #define LDLM_FL_WAIT_NOREPROC (1 << 7)
43 #define L2B(c) (1 << c)
45 /* compatibility matrix */
46 #define LCK_COMPAT_EX L2B(LCK_NL)
47 #define LCK_COMPAT_PW (LCK_COMPAT_EX | L2B(LCK_CR))
48 #define LCK_COMPAT_PR (LCK_COMPAT_PW | L2B(LCK_PR))
49 #define LCK_COMPAT_CW (LCK_COMPAT_PW | L2B(LCK_CW))
50 #define LCK_COMPAT_CR (LCK_COMPAT_CW | L2B(LCK_PR) | L2B(LCK_PW))
51 #define LCK_COMPAT_NL (LCK_COMPAT_CR | L2B(LCK_EX))
53 static ldlm_mode_t lck_compat_array[] = {
54 [LCK_EX] LCK_COMPAT_EX,
55 [LCK_PW] LCK_COMPAT_PW,
56 [LCK_PR] LCK_COMPAT_PR,
57 [LCK_CW] LCK_COMPAT_CW,
58 [LCK_CR] LCK_COMPAT_CR,
59 [LCK_NL] LCK_COMPAT_NL
62 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
64 if (exist < LCK_EX || exist > LCK_NL)
66 if (new < LCK_EX || new > LCK_NL)
69 return (lck_compat_array[exist] & L2B(new));
78 #define DLM_OST_NAMESPACE 1
79 #define DLM_MDS_NAMESPACE 2
82 - do we just separate this by security domains and use a prefix for
83 multiple namespaces in the same domain?
87 struct ldlm_namespace {
89 __u32 ns_client; /* is this a client-side lock tree? */
90 struct list_head *ns_hash; /* hash table for ns */
91 __u32 ns_refcount; /* count of resources in the hash */
92 struct list_head ns_root_list; /* all root resources in ns */
93 struct lustre_lock ns_lock; /* protects hash, refcount, list */
94 struct list_head ns_list_chain; /* position in global NS list */
95 struct proc_dir_entry *ns_proc_dir;
100 * Resource hash table
104 #define RES_HASH_BITS 14
105 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
106 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
110 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
111 struct ldlm_lock_desc *new, void *data,
114 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags);
119 struct ldlm_resource *l_resource;
120 struct ldlm_lock *l_parent;
121 struct list_head l_children;
122 struct list_head l_childof;
123 struct list_head l_res_link; /*position in one of three res lists*/
124 struct list_head l_export_chain; /* per-export chain of locks */
125 struct list_head l_pending_chain; /* locks with callbacks pending*/
126 unsigned long l_callback_timeout;
128 ldlm_mode_t l_req_mode;
129 ldlm_mode_t l_granted_mode;
131 ldlm_completion_callback l_completion_ast;
132 ldlm_blocking_callback l_blocking_ast;
134 struct obd_export *l_export;
135 struct lustre_handle *l_connh;
137 struct lustre_handle l_remote_handle;
142 struct ldlm_extent l_extent;
143 __u32 l_version[RES_VERSION_SIZE];
148 /* If the lock is granted, a process sleeps on this waitq to learn when
149 * it's no longer in use. If the lock is not granted, a process sleeps
150 * on this waitq to learn when it becomes granted. */
151 wait_queue_head_t l_waitq;
154 typedef int (*ldlm_res_compat)(struct ldlm_lock *child, struct ldlm_lock *new);
155 typedef int (*ldlm_res_policy)(struct ldlm_lock *lock, void *req_cookie,
156 ldlm_mode_t mode, void *data);
158 #define LDLM_PLAIN 10
159 #define LDLM_EXTENT 11
160 #define LDLM_MDSINTENT 12
162 #define LDLM_MIN_TYPE 10
163 #define LDLM_MAX_TYPE 12
165 extern ldlm_res_compat ldlm_res_compat_table [];
166 extern ldlm_res_policy ldlm_res_policy_table [];
168 struct ldlm_resource {
169 struct ldlm_namespace *lr_namespace;
170 struct list_head lr_hash;
171 struct ldlm_resource *lr_parent; /* 0 for a root resource */
172 struct list_head lr_children; /* list head for child resources */
173 struct list_head lr_childof; /* part of ns_root_list if root res,
174 * part of lr_children if child */
176 struct list_head lr_granted;
177 struct list_head lr_converting;
178 struct list_head lr_waiting;
179 ldlm_mode_t lr_most_restr;
180 __u32 lr_type; /* PLAIN, EXTENT, or MDSINTENT */
181 struct ldlm_resource *lr_root;
182 __u64 lr_name[RES_NAME_SIZE];
183 __u32 lr_version[RES_VERSION_SIZE];
184 atomic_t lr_refcount;
188 struct ldlm_ast_work {
189 struct ldlm_lock *w_lock;
191 struct ldlm_lock_desc w_desc;
192 struct list_head w_list;
198 /* Per-export ldlm state. */
199 struct ldlm_export_data {
200 struct list_head led_held_locks;
201 struct obd_import led_import;
204 static inline struct ldlm_extent *ldlm_res2extent(struct ldlm_resource *res)
206 return (struct ldlm_extent *)(res->lr_name);
209 extern struct obd_ops ldlm_obd_ops;
211 extern char *ldlm_lockname[];
212 extern char *ldlm_typename[];
213 extern char *ldlm_it2str(int it);
215 #define LDLM_DEBUG(lock, format, a...) \
217 if (lock->l_resource == NULL) \
218 CDEBUG(D_DLMTRACE, "### " format \
219 " (UNKNOWN: lock %p(rc=%d/%d,%d) mode %s/%s on " \
220 "res \?\? (rc=\?\?) type \?\?\? remote %Lx)\n" , \
221 ## a, lock, lock->l_refc, lock->l_readers, \
223 ldlm_lockname[lock->l_granted_mode], \
224 ldlm_lockname[lock->l_req_mode], \
225 lock->l_remote_handle.addr); \
227 CDEBUG(D_DLMTRACE, "### " format \
228 " (%s: lock %p(rc=%d/%d,%d) mode %s/%s on res " \
229 "%Lu (rc=%d) type %s remote %Lx)\n" , ## a, \
230 lock->l_resource->lr_namespace->ns_name, lock, \
231 lock->l_refc, lock->l_readers, lock->l_writers, \
232 ldlm_lockname[lock->l_granted_mode], \
233 ldlm_lockname[lock->l_req_mode], \
234 lock->l_resource->lr_name[0], \
235 atomic_read(&lock->l_resource->lr_refcount), \
236 ldlm_typename[lock->l_resource->lr_type], \
237 lock->l_remote_handle.addr); \
240 #define LDLM_DEBUG_NOLOCK(format, a...) \
241 CDEBUG(D_DLMTRACE, "### " format "\n" , ## a)
244 int ldlm_extent_compat(struct ldlm_lock *, struct ldlm_lock *);
245 int ldlm_extent_policy(struct ldlm_lock *, void *, ldlm_mode_t, void *);
248 int ldlm_handle_enqueue(struct ptlrpc_request *req);
249 int ldlm_handle_convert(struct ptlrpc_request *req);
250 int ldlm_handle_cancel(struct ptlrpc_request *req);
253 void ldlm_register_intent(int (*arg)(struct ldlm_lock *lock, void *req_cookie,
254 ldlm_mode_t mode, void *data));
255 void ldlm_unregister_intent(void);
256 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
257 struct ldlm_lock *ldlm_handle2lock(struct lustre_handle *handle);
258 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
260 #define LDLM_LOCK_PUT(lock) \
262 /*LDLM_DEBUG(lock, "put");*/ \
263 ldlm_lock_put(lock); \
266 #define LDLM_LOCK_GET(lock) \
268 ldlm_lock_get(lock); \
269 /*LDLM_DEBUG(lock, "get");*/ \
273 struct ldlm_lock *ldlm_lock_get(struct ldlm_lock *lock);
274 void ldlm_lock_put(struct ldlm_lock *lock);
275 void ldlm_lock_destroy(struct ldlm_lock *lock);
276 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
277 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
278 void ldlm_lock_addref_internal(struct ldlm_lock* , __u32 mode);
279 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
280 void ldlm_grant_lock(struct ldlm_lock *lock);
281 int ldlm_lock_match(struct ldlm_namespace *ns, __u64 *res_id, __u32 type,
282 void *cookie, int cookielen, ldlm_mode_t mode,
283 struct lustre_handle *lockh);
285 ldlm_lock_create(struct ldlm_namespace *ns,
286 struct lustre_handle *parent_lock_handle,
287 __u64 *res_id, __u32 type, ldlm_mode_t mode, void *data,
289 ldlm_error_t ldlm_lock_enqueue(struct ldlm_lock *lock, void *cookie,
290 int cookie_len, int *flags,
291 ldlm_completion_callback completion,
292 ldlm_blocking_callback blocking);
293 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
295 void ldlm_lock_cancel(struct ldlm_lock *lock);
296 void ldlm_run_ast_work(struct list_head *rpc_list);
297 void ldlm_reprocess_all(struct ldlm_resource *res);
298 void ldlm_lock_dump(struct ldlm_lock *lock);
301 int ldlm_test(struct obd_device *device, struct lustre_handle *connh);
302 int ldlm_regression_start(struct obd_device *obddev,
303 struct lustre_handle *connh,
304 unsigned int threads, unsigned int max_locks_in,
305 unsigned int num_resources_in,
306 unsigned int num_extents_in);
307 int ldlm_regression_stop(void);
311 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
312 int ldlm_namespace_free(struct ldlm_namespace *ns);
313 int ldlm_proc_setup(struct obd_device *obd);
314 void ldlm_proc_cleanup(struct obd_device *obd);
316 /* resource.c - internal */
317 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
318 struct ldlm_resource *parent,
319 __u64 *name, __u32 type, int create);
320 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
321 int ldlm_resource_put(struct ldlm_resource *res);
322 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
323 struct ldlm_lock *lock);
324 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
325 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
326 void ldlm_dump_all_namespaces(void);
327 void ldlm_namespace_dump(struct ldlm_namespace *);
328 void ldlm_resource_dump(struct ldlm_resource *);
329 int ldlm_lock_change_resource(struct ldlm_lock *, __u64 new_resid[3]);
332 int ldlm_completion_ast(struct ldlm_lock *lock, int flags);
333 int ldlm_cli_enqueue(struct lustre_handle *conn,
334 struct ptlrpc_request *req,
335 struct ldlm_namespace *ns,
336 struct lustre_handle *parent_lock_handle,
339 void *cookie, int cookielen,
342 ldlm_completion_callback completion,
343 ldlm_blocking_callback callback,
346 struct lustre_handle *lockh);
347 int ldlm_match_or_enqueue(struct lustre_handle *connh,
348 struct ptlrpc_request *req,
349 struct ldlm_namespace *ns,
350 struct lustre_handle *parent_lock_handle,
353 void *cookie, int cookielen,
356 ldlm_completion_callback completion,
357 ldlm_blocking_callback callback,
360 struct lustre_handle *lockh);
361 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
362 void *data, __u32 data_len);
363 int ldlm_cli_convert(struct lustre_handle *, int new_mode, int *flags);
364 int ldlm_cli_cancel(struct lustre_handle *lockh);
365 int ldlm_cli_cancel_unused(struct ldlm_namespace *ns, __u64 *res_id);
368 /* This has to be here because recurisve inclusion sucks. */
369 int mds_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
370 void *data, __u32 data_len);
372 #endif /* __KERNEL__ */
374 /* ioctls for trying requests */
375 #define IOC_LDLM_TYPE 'f'
376 #define IOC_LDLM_MIN_NR 40
378 #define IOC_LDLM_TEST _IOWR('f', 40, long)
379 #define IOC_LDLM_DUMP _IOWR('f', 41, long)
380 #define IOC_LDLM_REGRESS_START _IOWR('f', 42, long)
381 #define IOC_LDLM_REGRESS_STOP _IOWR('f', 43, long)
382 #define IOC_LDLM_MAX_NR 43