4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
32 extern int ldlm_srv_namespace_nr;
33 extern int ldlm_cli_namespace_nr;
34 extern struct mutex ldlm_srv_namespace_lock;
35 extern struct list_head ldlm_srv_namespace_list;
36 extern struct mutex ldlm_cli_namespace_lock;
37 extern struct list_head ldlm_cli_active_namespace_list;
38 extern struct list_head ldlm_cli_inactive_namespace_list;
39 extern unsigned int ldlm_cancel_unused_locks_before_replay;
40 extern struct kmem_cache *ldlm_glimpse_work_kmem;
42 static inline int ldlm_namespace_nr_read(enum ldlm_side client)
44 return client == LDLM_NAMESPACE_SERVER ?
45 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
48 static inline void ldlm_namespace_nr_inc(enum ldlm_side client)
50 if (client == LDLM_NAMESPACE_SERVER)
51 ldlm_srv_namespace_nr++;
53 ldlm_cli_namespace_nr++;
56 static inline void ldlm_namespace_nr_dec(enum ldlm_side client)
58 if (client == LDLM_NAMESPACE_SERVER)
59 ldlm_srv_namespace_nr--;
61 ldlm_cli_namespace_nr--;
64 static inline struct list_head *ldlm_namespace_list(enum ldlm_side client)
66 return client == LDLM_NAMESPACE_SERVER ?
67 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
71 struct list_head *ldlm_namespace_inactive_list(enum ldlm_side client)
73 return client == LDLM_NAMESPACE_SERVER ?
74 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
77 static inline struct mutex *ldlm_namespace_lock(enum ldlm_side client)
79 return client == LDLM_NAMESPACE_SERVER ?
80 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
83 /* ns_bref is the number of resources in this namespace */
84 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
86 return atomic_read(&ns->ns_bref) == 0;
89 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *l,
91 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *l,
93 struct ldlm_namespace *ldlm_namespace_first_locked(enum ldlm_side);
96 int ldlm_cancel_lru(struct ldlm_namespace *ns, int min,
97 enum ldlm_cancel_flags cancel_flags,
98 enum ldlm_lru_flags lru_flags);
99 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
100 struct list_head *cancels, int min, int max,
101 enum ldlm_cancel_flags cancel_flags,
102 enum ldlm_lru_flags lru_flags);
103 extern unsigned int ldlm_enqueue_min;
104 /* ldlm_resource.c */
105 extern struct kmem_cache *ldlm_resource_slab;
106 extern struct kmem_cache *ldlm_lock_slab;
107 extern struct kmem_cache *ldlm_inodebits_slab;
108 extern struct kmem_cache *ldlm_interval_tree_slab;
110 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
111 struct ldlm_lock *new);
112 void ldlm_resource_insert_lock_before(struct ldlm_lock *original,
113 struct ldlm_lock *new);
120 LDLM_WORK_REVOKE_AST,
124 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
125 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
126 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
127 enum req_location loc, void *data, int size);
128 struct ldlm_lock *ldlm_lock_create(struct ldlm_namespace *ns,
129 const struct ldlm_res_id *res,
130 enum ldlm_type type, enum ldlm_mode mode,
131 const struct ldlm_callback_suite *cbs,
132 void *data, __u32 lvb_len,
133 enum lvb_type lvb_type);
134 enum ldlm_error ldlm_lock_enqueue(const struct lu_env *env,
135 struct ldlm_namespace *l,
136 struct ldlm_lock **lock,
137 void *cookie, __u64 *flags);
138 void ldlm_lock_addref_internal(struct ldlm_lock *l, enum ldlm_mode mode);
139 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *l, enum ldlm_mode mode);
140 void ldlm_lock_decref_internal(struct ldlm_lock *l, enum ldlm_mode mode);
141 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *l,
142 enum ldlm_mode mode);
143 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
144 struct list_head *work_list);
145 #ifdef HAVE_SERVER_SUPPORT
146 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
147 struct list_head *work_list,
148 enum ldlm_process_intention intention, __u64 hint);
149 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
150 struct list_head *rpc_list);
151 void ldlm_discard_bl_list(struct list_head *bl_list);
152 void ldlm_clear_blocking_lock(struct ldlm_lock *lock);
153 void ldlm_clear_blocking_data(struct ldlm_lock *lock);
155 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
156 ldlm_desc_ast_t ast_type);
157 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
158 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use);
159 #define ldlm_lock_remove_from_lru(lock) \
160 ldlm_lock_remove_from_lru_check(lock, ktime_set(0, 0))
161 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
162 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
163 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
164 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
166 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
167 int ldlm_export_cancel_locks(struct obd_export *exp);
168 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
171 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
172 struct ldlm_lock *lock);
173 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
174 struct ldlm_lock_desc *ld,
175 struct list_head *cancels, int count,
176 enum ldlm_cancel_flags cancel_flags);
177 int ldlm_bl_to_thread_ns(struct ldlm_namespace *ns);
178 int ldlm_bl_thread_wakeup(void);
180 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
181 struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
182 void ldlm_bl_desc2lock(const struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
184 #ifdef HAVE_SERVER_SUPPORT
186 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
187 enum ldlm_process_intention intention,
188 enum ldlm_error *err, struct list_head *work_list);
190 /* ldlm_inodebits.c */
191 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
192 enum ldlm_process_intention intention,
193 enum ldlm_error *err,
194 struct list_head *work_list);
195 int ldlm_reprocess_inodebits_queue(struct ldlm_resource *res,
196 struct list_head *queue,
197 struct list_head *work_list,
198 enum ldlm_process_intention intention,
201 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
202 enum ldlm_process_intention intention,
203 enum ldlm_error *err, struct list_head *work_list);
205 int ldlm_extent_alloc_lock(struct ldlm_lock *lock);
206 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
207 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
209 int ldlm_inodebits_alloc_lock(struct ldlm_lock *lock);
210 void ldlm_inodebits_add_lock(struct ldlm_resource *res, struct list_head *head,
211 struct ldlm_lock *lock, bool tail);
212 void ldlm_inodebits_unlink_lock(struct ldlm_lock *lock);
215 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
216 enum ldlm_process_intention intention,
217 enum ldlm_error *err, struct list_head *work_list);
218 int ldlm_init_flock_export(struct obd_export *exp);
219 void ldlm_destroy_flock_export(struct obd_export *exp);
220 void ldlm_flock_unlink_lock(struct ldlm_lock *lock);
223 void l_check_ns_lock(struct ldlm_namespace *ns);
224 void l_check_no_ns_lock(struct ldlm_namespace *ns);
226 extern struct dentry *ldlm_svc_debugfs_dir;
229 struct ptlrpc_service *ldlm_cb_service;
230 struct ptlrpc_service *ldlm_cancel_service;
231 struct ptlrpc_client *ldlm_client;
232 struct ldlm_bl_pool *ldlm_bl_pool;
235 /* interval tree, for LDLM_EXTENT. */
236 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
237 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
238 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
239 extern void ldlm_interval_free(struct ldlm_interval *node);
240 /* this function must be called with res lock held */
241 static inline struct ldlm_extent *
242 ldlm_interval_extent(struct ldlm_interval *node)
244 struct ldlm_lock *lock;
246 LASSERT(!list_empty(&node->li_group));
248 lock = list_first_entry(&node->li_group, struct ldlm_lock,
250 return &lock->l_policy_data.l_extent;
254 void ldlm_exit(void);
256 enum ldlm_policy_res {
257 LDLM_POLICY_CANCEL_LOCK,
258 LDLM_POLICY_KEEP_LOCK,
259 LDLM_POLICY_SKIP_LOCK
262 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
263 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
264 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
265 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
266 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
267 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
269 #define LDLM_POOL_SYSFS_READER_SHOW(var, type) \
270 static ssize_t var##_show(struct kobject *kobj, \
271 struct attribute *attr, \
274 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
278 spin_lock(&pl->pl_lock); \
279 tmp = pl->pl_##var; \
280 spin_unlock(&pl->pl_lock); \
282 return LDLM_POOL_SYSFS_PRINT_##type(tmp); \
284 struct __##var##__dummy_read { ; } /* semicolon catcher */
286 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type) \
287 static ssize_t var##_store(struct kobject *kobj, \
288 struct attribute *attr, \
289 const char *buffer, \
292 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
297 rc = kstrtoul(buffer, 10, &tmp); \
302 spin_lock(&pl->pl_lock); \
303 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
304 spin_unlock(&pl->pl_lock); \
308 struct __##var##__dummy_write {; } /* semicolon catcher */
310 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type) \
311 static ssize_t var##_show(struct kobject *kobj, \
312 struct attribute *attr, \
315 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
318 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var); \
320 struct __##var##__dummy_read {; } /* semicolon catcher */
322 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type) \
323 static ssize_t var##_store(struct kobject *kobj, \
324 struct attribute *attr, \
325 const char *buffer, \
328 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
333 rc = kstrtoul(buffer, 10, &tmp); \
338 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
342 struct __##var##__dummy_write {; } /* semicolon catcher */
345 ldlm_add_var(struct ldebugfs_vars *vars, struct dentry *debugfs_entry,
346 const char *name, void *data, const struct file_operations *ops)
351 ldebugfs_add_vars(debugfs_entry, vars, NULL);
354 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
358 lock_res_and_lock(lock);
359 ret = is_granted_or_cancelled_nolock(lock);
360 unlock_res_and_lock(lock);
365 static inline bool is_bl_done(struct ldlm_lock *lock)
369 if (!ldlm_is_bl_done(lock)) {
370 lock_res_and_lock(lock);
371 bl_done = ldlm_is_bl_done(lock);
372 unlock_res_and_lock(lock);
378 static inline bool is_lock_converted(struct ldlm_lock *lock)
382 lock_res_and_lock(lock);
383 ret = (lock->l_policy_data.l_inodebits.cancel_bits == 0);
384 unlock_res_and_lock(lock);
389 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
390 union ldlm_policy_data *);
391 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
392 union ldlm_wire_policy_data *);
393 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
394 union ldlm_policy_data *lpolicy);
395 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
396 union ldlm_wire_policy_data *wpolicy);
397 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
398 union ldlm_policy_data *lpolicy);
399 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
400 union ldlm_wire_policy_data *wpolicy);
401 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpol,
402 union ldlm_policy_data *lpolicy);
403 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
404 union ldlm_wire_policy_data *wpolicy);
405 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
406 union ldlm_policy_data *lpolicy);
407 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
408 union ldlm_wire_policy_data *wpolicy);
411 #ifdef HAVE_SERVER_SUPPORT
412 extern __u64 ldlm_reclaim_threshold;
413 extern __u64 ldlm_lock_limit;
414 extern __u64 ldlm_reclaim_threshold_mb;
415 extern __u64 ldlm_lock_limit_mb;
416 extern struct percpu_counter ldlm_granted_total;
418 int ldlm_reclaim_setup(void);
419 void ldlm_reclaim_cleanup(void);
420 void ldlm_reclaim_add(struct ldlm_lock *lock);
421 void ldlm_reclaim_del(struct ldlm_lock *lock);
422 bool ldlm_reclaim_full(void);
424 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
425 const struct ldlm_res_id *res1)
427 return memcmp(res0, res1, sizeof(*res0)) == 0;
430 /* exports for testing */
431 struct ldlm_lock *ldlm_lock_new_testing(struct ldlm_resource *resource);