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/obd_class.h>
11 #include <linux/lustre_net.h>
13 #define OBD_LDLM_DEVICENAME "ldlm"
18 ELDLM_LOCK_CHANGED = 300,
19 ELDLM_LOCK_ABORTED = 301,
20 ELDLM_RESOURCE_FREED = 302,
22 ELDLM_NAMESPACE_EXISTS = 400,
23 ELDLM_BAD_NAMESPACE = 401
26 #define LDLM_NAMESPACE_SERVER 0
27 #define LDLM_NAMESPACE_CLIENT 1
29 #define LDLM_FL_LOCK_CHANGED (1 << 0)
30 #define LDLM_FL_BLOCK_GRANTED (1 << 1)
31 #define LDLM_FL_BLOCK_CONV (1 << 2)
32 #define LDLM_FL_BLOCK_WAIT (1 << 3)
33 #define LDLM_FL_CBPENDING (1 << 4)
34 #define LDLM_FL_AST_SENT (1 << 5)
36 #define L2B(c) (1 << c)
38 /* compatibility matrix */
39 #define LCK_COMPAT_EX L2B(LCK_NL)
40 #define LCK_COMPAT_PW (LCK_COMPAT_EX | L2B(LCK_CR))
41 #define LCK_COMPAT_PR (LCK_COMPAT_PW | L2B(LCK_PR))
42 #define LCK_COMPAT_CW (LCK_COMPAT_PW | L2B(LCK_CW))
43 #define LCK_COMPAT_CR (LCK_COMPAT_CW | L2B(LCK_PR) | L2B(LCK_PW))
44 #define LCK_COMPAT_NL (LCK_COMPAT_CR | L2B(LCK_EX))
46 static ldlm_mode_t lck_compat_array[] = {
47 [LCK_EX] LCK_COMPAT_EX,
48 [LCK_PW] LCK_COMPAT_PW,
49 [LCK_PR] LCK_COMPAT_PR,
50 [LCK_CW] LCK_COMPAT_CW,
51 [LCK_CR] LCK_COMPAT_CR,
52 [LCK_NL] LCK_COMPAT_NL
55 static inline int lockmode_compat(ldlm_mode_t exist, ldlm_mode_t new)
57 if (exist < LCK_EX || exist > LCK_NL)
59 if (new < LCK_EX || new > LCK_NL)
62 return (lck_compat_array[exist] & L2B(new));
71 #define DLM_OST_NAMESPACE 1
72 #define DLM_MDS_NAMESPACE 2
75 - do we just separate this by security domains and use a prefix for
76 multiple namespaces in the same domain?
80 struct ldlm_namespace {
82 struct ptlrpc_client ns_rpc_client; /* used for revocation callbacks */
83 __u32 ns_client; /* is this a client-side lock tree? */
84 struct list_head *ns_hash; /* hash table for ns */
85 __u32 ns_refcount; /* count of resources in the hash */
86 struct list_head ns_root_list; /* all root resources in ns */
87 struct lustre_lock ns_lock; /* protects hash, refcount, list */
96 #define RES_HASH_BITS 14
97 #define RES_HASH_SIZE (1UL << RES_HASH_BITS)
98 #define RES_HASH_MASK (RES_HASH_SIZE - 1)
102 typedef int (*ldlm_lock_callback)(struct ldlm_lock *lock,
103 struct ldlm_lock_desc *new, void *data,
104 __u32 data_len, struct ptlrpc_request **req);
107 struct ldlm_resource *l_resource;
108 struct ldlm_lock *l_parent;
109 struct list_head l_children;
110 struct list_head l_childof;
111 struct list_head l_res_link; /*position in one of three res lists*/
114 ldlm_mode_t l_req_mode;
115 ldlm_mode_t l_granted_mode;
117 ldlm_lock_callback l_completion_ast;
118 ldlm_lock_callback l_blocking_ast;
120 struct ptlrpc_connection *l_connection;
121 struct ptlrpc_client *l_client;
123 struct lustre_handle l_remote_handle;
128 struct ldlm_extent l_extent;
129 __u32 l_version[RES_VERSION_SIZE];
134 /* If the lock is granted, a process sleeps on this waitq to learn when
135 * it's no longer in use. If the lock is not granted, a process sleeps
136 * on this waitq to learn when it becomes granted. */
137 wait_queue_head_t l_waitq;
140 typedef int (*ldlm_res_compat)(struct ldlm_lock *child, struct ldlm_lock *new);
141 typedef int (*ldlm_res_policy)(struct ldlm_lock *lock, void *req_cookie,
142 ldlm_mode_t mode, void *data);
144 #define LDLM_PLAIN 10
145 #define LDLM_EXTENT 11
146 #define LDLM_MDSINTENT 12
148 #define LDLM_MIN_TYPE 10
149 #define LDLM_MAX_TYPE 12
151 extern ldlm_res_compat ldlm_res_compat_table [];
152 extern ldlm_res_policy ldlm_res_policy_table [];
154 struct ldlm_resource {
155 struct ldlm_namespace *lr_namespace;
156 struct list_head lr_hash;
157 struct list_head lr_rootlink; /* link all root resources in NS */
158 struct ldlm_resource *lr_parent; /* 0 for a root resource */
159 struct list_head lr_children; /* list head for child resources */
160 struct list_head lr_childof; /* part of child list of parent */
162 struct list_head lr_granted;
163 struct list_head lr_converting;
164 struct list_head lr_waiting;
165 ldlm_mode_t lr_most_restr;
166 __u32 lr_type; /* PLAIN, EXTENT, or MDSINTENT */
167 struct ldlm_resource *lr_root;
168 __u64 lr_name[RES_NAME_SIZE];
169 __u32 lr_version[RES_VERSION_SIZE];
170 atomic_t lr_refcount;
174 static inline struct ldlm_extent *ldlm_res2extent(struct ldlm_resource *res)
176 return (struct ldlm_extent *)(res->lr_name);
179 extern struct obd_ops ldlm_obd_ops;
181 #define LDLM_DEBUG(lock, format, a...) \
183 CDEBUG(D_DLMTRACE, "### " format \
184 " (%s: lock %p mode %d/%d on res %Lu (rc %d) " \
185 " type %d remote %Lx)\n" , ## a, \
186 lock->l_resource->lr_namespace->ns_name, lock, \
187 lock->l_granted_mode, lock->l_req_mode, \
188 lock->l_resource->lr_name[0], \
189 atomic_read(&lock->l_resource->lr_refcount), \
190 lock->l_resource->lr_type, \
191 lock->l_remote_handle.addr); \
194 #define LDLM_DEBUG_NOLOCK(format, a...) \
195 CDEBUG(D_DLMTRACE, "### " format "\n" , ## a)
198 int ldlm_extent_compat(struct ldlm_lock *, struct ldlm_lock *);
199 int ldlm_extent_policy(struct ldlm_lock *, void *, ldlm_mode_t, void *);
202 struct ldlm_lock *ldlm_handle2lock(struct lustre_handle *handle);
203 void ldlm_lock_put(struct ldlm_lock *lock);
204 void ldlm_lock_free(struct ldlm_lock *lock);
205 void ldlm_lock2desc(struct ldlm_lock *lock, struct ldlm_lock_desc *desc);
206 void ldlm_lock_addref(struct ldlm_lock *lock, __u32 mode);
207 void ldlm_lock_decref(struct ldlm_lock *lock, __u32 mode);
208 void ldlm_grant_lock(struct ldlm_lock *lock);
209 int ldlm_match(struct ldlm_namespace *ns, __u64 *res_id, __u32 type,
210 void *cookie, int cookielen, ldlm_mode_t mode,
211 struct lustre_handle *lockh);
213 ldlm_lock_create(struct ldlm_namespace *ns,
214 struct lustre_handle *parent_lock_handle,
215 __u64 *res_id, __u32 type, ldlm_mode_t mode, void *data,
217 ldlm_error_t ldlm_lock_enqueue(struct ldlm_lock *lock, void *cookie,
218 int cookie_len, int *flags,
219 ldlm_lock_callback completion,
220 ldlm_lock_callback blocking);
221 struct ldlm_resource *ldlm_lock_convert(struct ldlm_lock *lock, int new_mode,
223 struct ldlm_resource *ldlm_lock_cancel(struct ldlm_lock *lock);
224 void ldlm_reprocess_all(struct ldlm_resource *res);
225 void ldlm_lock_dump(struct ldlm_lock *lock);
228 int ldlm_test(struct obd_device *device, struct ptlrpc_connection *conn);
231 struct ldlm_namespace *ldlm_namespace_new(char *name, __u32 local);
232 int ldlm_namespace_free(struct ldlm_namespace *ns);
234 /* resource.c - internal */
235 struct ldlm_resource *ldlm_resource_get(struct ldlm_namespace *ns,
236 struct ldlm_resource *parent,
237 __u64 *name, __u32 type, int create);
238 struct ldlm_resource *ldlm_resource_addref(struct ldlm_resource *res);
239 int ldlm_resource_put(struct ldlm_resource *res);
240 void ldlm_resource_add_lock(struct ldlm_resource *res, struct list_head *head,
241 struct ldlm_lock *lock);
242 void ldlm_resource_del_lock(struct ldlm_lock *lock);
243 void ldlm_res2desc(struct ldlm_resource *res, struct ldlm_resource_desc *desc);
244 void ldlm_resource_dump(struct ldlm_resource *res);
245 int ldlm_lock_change_resource(struct ldlm_lock *lock, __u64 new_resid[3]);
248 int ldlm_cli_enqueue(struct ptlrpc_client *cl,
249 struct ptlrpc_connection *peer,
250 struct ptlrpc_request *req,
251 struct ldlm_namespace *ns,
252 struct lustre_handle *parent_lock_handle,
255 void *cookie, int cookielen,
258 ldlm_lock_callback callback,
261 struct lustre_handle *lockh);
262 int ldlm_cli_callback(struct ldlm_lock *lock, struct ldlm_lock *new,
263 void *data, __u32 data_len, struct ptlrpc_request **reqp);
264 int ldlm_cli_convert(struct ptlrpc_client *, struct lustre_handle *,
265 int new_mode, int *flags);
266 int ldlm_cli_cancel(struct ptlrpc_client *, struct ldlm_lock *);
268 #endif /* __KERNEL__ */
270 /* ioctls for trying requests */
271 #define IOC_LDLM_TYPE 'f'
272 #define IOC_LDLM_MIN_NR 40
274 #define IOC_LDLM_TEST _IOWR('f', 40, long)
275 #define IOC_LDLM_MAX_NR 41