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/obd_class.h>
12 #include <linux/lustre_net.h>
14 #define OBD_LDLM_DEVICENAME "ldlm"
19 ELDLM_LOCK_CHANGED = 300,
20 ELDLM_LOCK_ABORTED = 301,
21 ELDLM_RESOURCE_FREED = 302,
23 ELDLM_NAMESPACE_EXISTS = 400,
24 ELDLM_BAD_NAMESPACE = 401
27 #define LDLM_NAMESPACE_SERVER 0
28 #define LDLM_NAMESPACE_CLIENT 1
30 #define LDLM_FL_LOCK_CHANGED (1 << 0)
31 #define LDLM_FL_BLOCK_GRANTED (1 << 1)
32 #define LDLM_FL_BLOCK_CONV (1 << 2)
33 #define LDLM_FL_BLOCK_WAIT (1 << 3)
34 #define LDLM_FL_CBPENDING (1 << 4)
35 #define LDLM_FL_AST_SENT (1 << 5)
36 #define LDLM_FL_DESTROYED (1 << 6)
37 #define LDLM_FL_WAIT_NOREPROC (1 << 7)
39 #define L2B(c) (1 << c)
41 /* compatibility matrix */
42 #define LCK_COMPAT_EX L2B(LCK_NL)
43 #define LCK_COMPAT_PW (LCK_COMPAT_EX | L2B(LCK_CR))
44 #define LCK_COMPAT_PR (LCK_COMPAT_PW | L2B(LCK_PR))
45 #define LCK_COMPAT_CW (LCK_COMPAT_PW | L2B(LCK_CW))
46 #define LCK_COMPAT_CR (LCK_COMPAT_CW | L2B(LCK_PR) | L2B(LCK_PW))
47 #define LCK_COMPAT_NL (LCK_COMPAT_CR | L2B(LCK_EX))
49 static ldlm_mode_t lck_compat_array[] = {
50 [LCK_EX] LCK_COMPAT_EX,
51 [LCK_PW] LCK_COMPAT_PW,
52 [LCK_PR] LCK_COMPAT_PR,
53 [LCK_CW] LCK_COMPAT_CW,
54 [LCK_CR] LCK_COMPAT_CR,
55 [LCK_NL] LCK_COMPAT_NL
58 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
60 if (exist < LCK_EX || exist > LCK_NL)
62 if (new < LCK_EX || new > LCK_NL)
65 return (lck_compat_array[exist] & L2B(new));
74 #define DLM_OST_NAMESPACE 1
75 #define DLM_MDS_NAMESPACE 2
78 - do we just separate this by security domains and use a prefix for
79 multiple namespaces in the same domain?
83 struct ldlm_namespace {
85 struct ptlrpc_client ns_rpc_client;/* used for revocation callbacks */
86 __u32 ns_client; /* is this a client-side lock tree? */
87 struct list_head *ns_hash; /* hash table for ns */
88 __u32 ns_refcount; /* count of resources in the hash */
89 struct list_head ns_root_list; /* all root resources in ns */
90 struct lustre_lock ns_lock; /* protects hash, refcount, list */
91 struct list_head ns_list_chain; /* position in global NS list */
92 struct proc_dir_entry *ns_proc_dir;
101 #define RES_HASH_BITS 14
102 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
103 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
107 typedef int (*ldlm_blocking_callback)(struct ldlm_lock *lock,
108 struct ldlm_lock_desc *new, void *data,
111 typedef int (*ldlm_completion_callback)(struct ldlm_lock *lock, int flags);
116 struct ldlm_resource *l_resource;
117 struct ldlm_lock *l_parent;
118 struct list_head l_children;
119 struct list_head l_childof;
120 struct list_head l_res_link; /*position in one of three res lists*/
122 ldlm_mode_t l_req_mode;
123 ldlm_mode_t l_granted_mode;
125 ldlm_completion_callback l_completion_ast;
126 ldlm_blocking_callback l_blocking_ast;
128 struct ptlrpc_connection *l_connection;
129 struct ptlrpc_client *l_client;
130 struct lustre_handle *l_connh;
132 struct lustre_handle l_remote_handle;
137 struct ldlm_extent l_extent;
138 __u32 l_version[RES_VERSION_SIZE];
143 /* If the lock is granted, a process sleeps on this waitq to learn when
144 * it's no longer in use. If the lock is not granted, a process sleeps
145 * on this waitq to learn when it becomes granted. */
146 wait_queue_head_t l_waitq;
149 typedef int (*ldlm_res_compat)(struct ldlm_lock *child, struct ldlm_lock *new);
150 typedef int (*ldlm_res_policy)(struct ldlm_lock *lock, void *req_cookie,
151 ldlm_mode_t mode, void *data);
153 #define LDLM_PLAIN 10
154 #define LDLM_EXTENT 11
155 #define LDLM_MDSINTENT 12
157 #define LDLM_MIN_TYPE 10
158 #define LDLM_MAX_TYPE 12
160 extern ldlm_res_compat ldlm_res_compat_table [];
161 extern ldlm_res_policy ldlm_res_policy_table [];
163 struct ldlm_resource {
164 struct ldlm_namespace *lr_namespace;
165 struct list_head lr_hash;
166 struct ldlm_resource *lr_parent; /* 0 for a root resource */
167 struct list_head lr_children; /* list head for child resources */
168 struct list_head lr_childof; /* part of ns_root_list if root res,
169 * part of lr_children if child */
171 struct list_head lr_granted;
172 struct list_head lr_converting;
173 struct list_head lr_waiting;
174 ldlm_mode_t lr_most_restr;
175 __u32 lr_type; /* PLAIN, EXTENT, or MDSINTENT */
176 struct ldlm_resource *lr_root;
177 __u64 lr_name[RES_NAME_SIZE];
178 __u32 lr_version[RES_VERSION_SIZE];
179 atomic_t lr_refcount;
183 struct ldlm_ast_work {
184 struct ldlm_lock *w_lock;
186 struct ldlm_lock_desc w_desc;
187 struct list_head w_list;
193 static inline struct ldlm_extent *ldlm_res2extent(struct ldlm_resource *res)
195 return (struct ldlm_extent *)(res->lr_name);
198 extern struct obd_ops ldlm_obd_ops;
201 extern char *ldlm_lockname[];
202 extern char *ldlm_typename[];
203 extern char *ldlm_it2str(int it);
205 #define LDLM_DEBUG(lock, format, a...) \
207 if (lock->l_resource == NULL) \
208 CDEBUG(D_DLMTRACE, "### " format \
209 " (UNKNOWN: lock %p(rc=%d/%d,%d) mode %s/%s on " \
210 "res \?\? (rc=\?\?) type \?\?\? remote %Lx)\n" , \
211 ## a, lock, lock->l_refc, lock->l_readers, \
213 ldlm_lockname[lock->l_granted_mode], \
214 ldlm_lockname[lock->l_req_mode], \
215 lock->l_remote_handle.addr); \
217 CDEBUG(D_DLMTRACE, "### " format \
218 " (%s: lock %p(rc=%d/%d,%d) mode %s/%s on res " \
219 "%Lu (rc=%d) type %s remote %Lx)\n" , ## a, \
220 lock->l_resource->lr_namespace->ns_name, lock, \
221 lock->l_refc, lock->l_readers, lock->l_writers, \
222 ldlm_lockname[lock->l_granted_mode], \
223 ldlm_lockname[lock->l_req_mode], \
224 lock->l_resource->lr_name[0], \
225 atomic_read(&lock->l_resource->lr_refcount), \
226 ldlm_typename[lock->l_resource->lr_type], \
227 lock->l_remote_handle.addr); \
230 #define LDLM_DEBUG_NOLOCK(format, a...) \
231 CDEBUG(D_DLMTRACE, "### " format "\n" , ## a)
234 int ldlm_extent_compat(struct ldlm_lock *, struct ldlm_lock *);
235 int ldlm_extent_policy(struct ldlm_lock *, void *, ldlm_mode_t, void *);
238 int ldlm_handle_enqueue(struct ptlrpc_request *req);
239 int ldlm_handle_convert(struct ptlrpc_request *req);
240 int ldlm_handle_cancel(struct ptlrpc_request *req);
243 void ldlm_register_intent(int (*arg)(struct ldlm_lock *lock, void *req_cookie,
244 ldlm_mode_t mode, void *data));
245 void ldlm_unregister_intent(void);
246 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
247 struct ldlm_lock *ldlm_handle2lock(struct lustre_handle *handle);
248 void ldlm_lock2handle(struct ldlm_lock *lock, struct lustre_handle *lockh);
250 #define LDLM_LOCK_PUT(lock) \
252 LDLM_DEBUG(lock, "put"); \
253 ldlm_lock_put(lock); \
256 #define LDLM_LOCK_GET(lock) \
258 ldlm_lock_get(lock); \
259 LDLM_DEBUG(lock, "get"); \
263 void ldlm_lock_put(struct ldlm_lock *lock);
264 void ldlm_lock_destroy(struct ldlm_lock *lock);
265 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
266 void ldlm_lock_addref(struct lustre_handle *lockh, __u32 mode);
267 void ldlm_lock_addref_internal(struct ldlm_lock* , __u32 mode);
268 void ldlm_lock_decref(struct lustre_handle *lockh, __u32 mode);
269 void ldlm_grant_lock(struct ldlm_lock *lock);
270 int ldlm_lock_match(struct ldlm_namespace *ns, __u64 *res_id, __u32 type,
271 void *cookie, int cookielen, ldlm_mode_t mode,
272 struct lustre_handle *lockh);
274 ldlm_lock_create(struct ldlm_namespace *ns,
275 struct lustre_handle *parent_lock_handle,
276 __u64 *res_id, __u32 type, ldlm_mode_t mode, void *data,
278 ldlm_error_t ldlm_lock_enqueue(struct ldlm_lock *lock, void *cookie,
279 int cookie_len, int *flags,
280 ldlm_completion_callback completion,
281 ldlm_blocking_callback blocking);
282 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
284 void ldlm_lock_cancel(struct ldlm_lock *lock);
285 void ldlm_run_ast_work(struct list_head *rpc_list);
286 void ldlm_reprocess_all(struct ldlm_resource *res);
287 void ldlm_lock_dump(struct ldlm_lock *lock);
290 int ldlm_test(struct obd_device *device, struct ptlrpc_connection *conn);
293 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
294 int ldlm_namespace_free(struct ldlm_namespace *ns);
295 int ldlm_proc_setup(struct obd_device *obd);
296 void ldlm_proc_cleanup(struct obd_device *obd);
298 /* resource.c - internal */
299 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
300 struct ldlm_resource *parent,
301 __u64 *name, __u32 type, int create);
302 struct ldlm_resource *ldlm_resource_getref(struct ldlm_resource *res);
303 int ldlm_resource_put(struct ldlm_resource *res);
304 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
305 struct ldlm_lock *lock);
306 void ldlm_resource_unlink_lock(struct ldlm_lock *lock);
307 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
308 void ldlm_dump_all_namespaces(void);
309 void ldlm_namespace_dump(struct ldlm_namespace *);
310 void ldlm_resource_dump(struct ldlm_resource *);
311 int ldlm_lock_change_resource(struct ldlm_lock *, __u64 new_resid[3]);
314 int ldlm_completion_ast(struct ldlm_lock *lock, int flags);
315 int ldlm_cli_enqueue(struct lustre_handle *conn,
316 struct ptlrpc_request *req,
317 struct ldlm_namespace *ns,
318 struct lustre_handle *parent_lock_handle,
321 void *cookie, int cookielen,
324 ldlm_completion_callback completion,
325 ldlm_blocking_callback callback,
328 struct lustre_handle *lockh);
329 int ldlm_match_or_enqueue(struct lustre_handle *connh,
330 struct ptlrpc_request *req,
331 struct ldlm_namespace *ns,
332 struct lustre_handle *parent_lock_handle,
335 void *cookie, int cookielen,
338 ldlm_completion_callback completion,
339 ldlm_blocking_callback callback,
342 struct lustre_handle *lockh);
343 int ldlm_server_ast(struct lustre_handle *lockh, struct ldlm_lock_desc *new,
344 void *data, __u32 data_len);
345 int ldlm_cli_convert(struct lustre_handle *, int new_mode, int *flags);
346 int ldlm_cli_cancel(struct lustre_handle *lockh);
349 /* This has to be here because recurisve inclusion sucks. */
350 int mds_blocking_ast(struct ldlm_lock *lock, struct ldlm_lock_desc *desc,
351 void *data, __u32 data_len);
353 #endif /* __KERNEL__ */
355 /* ioctls for trying requests */
356 #define IOC_LDLM_TYPE 'f'
357 #define IOC_LDLM_MIN_NR 40
359 #define IOC_LDLM_TEST _IOWR('f', 40, long)
360 #define IOC_LDLM_DUMP _IOWR('f', 41, long)
361 #define IOC_LDLM_MAX_NR 41