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/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 extern int ldlm_srv_namespace_nr;
34 extern int ldlm_cli_namespace_nr;
35 extern struct mutex ldlm_srv_namespace_lock;
36 extern struct list_head ldlm_srv_namespace_list;
37 extern struct mutex ldlm_cli_namespace_lock;
38 extern struct list_head ldlm_cli_active_namespace_list;
39 extern struct list_head ldlm_cli_inactive_namespace_list;
40 extern unsigned int ldlm_cancel_unused_locks_before_replay;
41 extern struct kmem_cache *ldlm_glimpse_work_kmem;
43 static inline int ldlm_namespace_nr_read(enum ldlm_side client)
45 return client == LDLM_NAMESPACE_SERVER ?
46 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
49 static inline void ldlm_namespace_nr_inc(enum ldlm_side client)
51 if (client == LDLM_NAMESPACE_SERVER)
52 ldlm_srv_namespace_nr++;
54 ldlm_cli_namespace_nr++;
57 static inline void ldlm_namespace_nr_dec(enum ldlm_side client)
59 if (client == LDLM_NAMESPACE_SERVER)
60 ldlm_srv_namespace_nr--;
62 ldlm_cli_namespace_nr--;
65 static inline struct list_head *ldlm_namespace_list(enum ldlm_side client)
67 return client == LDLM_NAMESPACE_SERVER ?
68 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
72 struct list_head *ldlm_namespace_inactive_list(enum ldlm_side client)
74 return client == LDLM_NAMESPACE_SERVER ?
75 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
78 static inline struct mutex *ldlm_namespace_lock(enum ldlm_side client)
80 return client == LDLM_NAMESPACE_SERVER ?
81 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
84 /* ns_bref is the number of resources in this namespace */
85 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
87 return atomic_read(&ns->ns_bref) == 0;
90 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *,
92 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
94 struct ldlm_namespace *ldlm_namespace_first_locked(enum ldlm_side);
97 /* Cancel lru flag, it indicates we cancel aged locks. */
99 LDLM_LRU_FLAG_AGED = 0x01, /* Cancel aged locks (non LRU resize) */
100 LDLM_LRU_FLAG_PASSED = 0x02, /* Cancel passed number of locks */
101 LDLM_LRU_FLAG_SHRINK = 0x04, /* Cancel locks from shrinker */
102 LDLM_LRU_FLAG_LRUR = 0x08, /* Cancel locks from lru resize */
103 LDLM_LRU_FLAG_NO_WAIT = 0x10, /* Cancel locks w/o blocking (neither
104 * sending nor waiting for any RPCs) */
105 LDLM_LRU_FLAG_CLEANUP = 0x20, /* Used when clearing lru, tells
106 * prepare_lru_list to set discard flag
107 * on PR extent locks so we don't waste
108 * time saving pages that will be
109 * discarded momentarily */
112 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
113 enum ldlm_cancel_flags cancel_flags,
114 enum ldlm_lru_flags lru_flags);
115 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
116 struct list_head *cancels, int count, int max,
117 enum ldlm_cancel_flags cancel_flags,
118 enum ldlm_lru_flags lru_flags);
119 extern unsigned int ldlm_enqueue_min;
120 /* ldlm_resource.c */
121 extern struct kmem_cache *ldlm_resource_slab;
122 extern struct kmem_cache *ldlm_lock_slab;
123 extern struct kmem_cache *ldlm_interval_tree_slab;
125 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
126 struct ldlm_lock *new);
133 LDLM_WORK_REVOKE_AST,
137 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
138 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
139 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
140 enum req_location loc, void *data, int size);
142 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
143 enum ldlm_type type, enum ldlm_mode mode,
144 const struct ldlm_callback_suite *cbs,
145 void *data, __u32 lvb_len, enum lvb_type lvb_type);
146 enum ldlm_error ldlm_lock_enqueue(const struct lu_env *env,
147 struct ldlm_namespace *,
149 void *cookie, __u64 *flags);
150 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
151 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
152 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
153 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
154 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
155 struct list_head *work_list);
156 #ifdef HAVE_SERVER_SUPPORT
157 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
158 struct list_head *work_list,
159 enum ldlm_process_intention intention);
160 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
161 struct list_head *rpc_list);
162 void ldlm_discard_bl_list(struct list_head *bl_list);
163 void ldlm_clear_blocking_lock(struct ldlm_lock *lock);
164 void ldlm_clear_blocking_data(struct ldlm_lock *lock);
166 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
167 ldlm_desc_ast_t ast_type);
168 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
169 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use);
170 #define ldlm_lock_remove_from_lru(lock) \
171 ldlm_lock_remove_from_lru_check(lock, ktime_set(0, 0))
172 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
173 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
174 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
175 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
176 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
178 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
179 int ldlm_export_cancel_locks(struct obd_export *exp);
180 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
183 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
184 struct ldlm_lock *lock);
185 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
186 struct ldlm_lock_desc *ld,
187 struct list_head *cancels, int count,
188 enum ldlm_cancel_flags cancel_flags);
189 int ldlm_bl_thread_wakeup(void);
191 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
192 struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
194 #ifdef HAVE_SERVER_SUPPORT
196 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
197 enum ldlm_process_intention intention,
198 enum ldlm_error *err, struct list_head *work_list);
200 /* ldlm_inodebits.c */
201 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
202 enum ldlm_process_intention intention,
203 enum ldlm_error *err,
204 struct list_head *work_list);
206 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
207 enum ldlm_process_intention intention,
208 enum ldlm_error *err, struct list_head *work_list);
210 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
211 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
214 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
215 enum ldlm_process_intention intention,
216 enum ldlm_error *err, struct list_head *work_list);
217 int ldlm_init_flock_export(struct obd_export *exp);
218 void ldlm_destroy_flock_export(struct obd_export *exp);
221 void l_check_ns_lock(struct ldlm_namespace *ns);
222 void l_check_no_ns_lock(struct ldlm_namespace *ns);
224 extern struct dentry *ldlm_svc_debugfs_dir;
227 struct ptlrpc_service *ldlm_cb_service;
228 struct ptlrpc_service *ldlm_cancel_service;
229 struct ptlrpc_client *ldlm_client;
230 struct ptlrpc_connection *ldlm_server_conn;
231 struct ldlm_bl_pool *ldlm_bl_pool;
234 /* interval tree, for LDLM_EXTENT. */
235 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
236 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
237 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
238 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
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;
245 LASSERT(!list_empty(&node->li_group));
247 lock = list_entry(node->li_group.next, struct ldlm_lock,
249 return &lock->l_policy_data.l_extent;
253 void ldlm_exit(void);
255 enum ldlm_policy_res {
256 LDLM_POLICY_CANCEL_LOCK,
257 LDLM_POLICY_KEEP_LOCK,
258 LDLM_POLICY_SKIP_LOCK
261 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
262 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
263 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
264 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
265 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
266 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
268 #define LDLM_POOL_SYSFS_READER_SHOW(var, type) \
269 static ssize_t var##_show(struct kobject *kobj, \
270 struct attribute *attr, \
273 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
277 spin_lock(&pl->pl_lock); \
278 tmp = pl->pl_##var; \
279 spin_unlock(&pl->pl_lock); \
281 return LDLM_POOL_SYSFS_PRINT_##type(tmp); \
283 struct __##var##__dummy_read {;} /* semicolon catcher */
285 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type) \
286 static ssize_t var##_store(struct kobject *kobj, \
287 struct attribute *attr, \
288 const char *buffer, \
291 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
296 rc = kstrtoul(buffer, 10, &tmp); \
301 spin_lock(&pl->pl_lock); \
302 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
303 spin_unlock(&pl->pl_lock); \
307 struct __##var##__dummy_write {; } /* semicolon catcher */
309 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type) \
310 static ssize_t var##_show(struct kobject *kobj, \
311 struct attribute *attr, \
314 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
317 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var); \
319 struct __##var##__dummy_read {; } /* semicolon catcher */
321 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type) \
322 static ssize_t var##_store(struct kobject *kobj, \
323 struct attribute *attr, \
324 const char *buffer, \
327 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
332 rc = kstrtoul(buffer, 10, &tmp); \
337 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
341 struct __##var##__dummy_write {; } /* semicolon catcher */
344 ldlm_add_var(struct lprocfs_vars *vars, struct dentry *debugfs_entry,
345 const char *name, void *data, const struct file_operations *ops)
350 ldebugfs_add_vars(debugfs_entry, vars, NULL);
353 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
357 lock_res_and_lock(lock);
358 ret = is_granted_or_cancelled_nolock(lock);
359 unlock_res_and_lock(lock);
364 static inline bool is_bl_done(struct ldlm_lock *lock)
368 if (!ldlm_is_bl_done(lock)) {
369 lock_res_and_lock(lock);
370 bl_done = ldlm_is_bl_done(lock);
371 unlock_res_and_lock(lock);
377 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
378 union ldlm_policy_data *);
379 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
380 union ldlm_wire_policy_data *);
381 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
382 union ldlm_policy_data *lpolicy);
383 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
384 union ldlm_wire_policy_data *wpolicy);
385 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
386 union ldlm_policy_data *lpolicy);
387 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
388 union ldlm_wire_policy_data *wpolicy);
389 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
390 union ldlm_policy_data *lpolicy);
391 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
392 union ldlm_wire_policy_data *wpolicy);
393 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
394 union ldlm_policy_data *lpolicy);
395 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
396 union ldlm_wire_policy_data *wpolicy);
399 #ifdef HAVE_SERVER_SUPPORT
400 extern __u64 ldlm_reclaim_threshold;
401 extern __u64 ldlm_lock_limit;
402 extern __u64 ldlm_reclaim_threshold_mb;
403 extern __u64 ldlm_lock_limit_mb;
404 extern struct percpu_counter ldlm_granted_total;
406 int ldlm_reclaim_setup(void);
407 void ldlm_reclaim_cleanup(void);
408 void ldlm_reclaim_add(struct ldlm_lock *lock);
409 void ldlm_reclaim_del(struct ldlm_lock *lock);
410 bool ldlm_reclaim_full(void);
412 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
413 const struct ldlm_res_id *res1)
415 return memcmp(res0, res1, sizeof(*res0)) == 0;