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, 2015, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
33 #define MAX_STRING_SIZE 128
35 extern int ldlm_srv_namespace_nr;
36 extern int ldlm_cli_namespace_nr;
37 extern struct mutex ldlm_srv_namespace_lock;
38 extern struct list_head ldlm_srv_namespace_list;
39 extern struct mutex ldlm_cli_namespace_lock;
40 extern struct list_head ldlm_cli_active_namespace_list;
41 extern struct list_head ldlm_cli_inactive_namespace_list;
42 extern unsigned int ldlm_cancel_unused_locks_before_replay;
44 static inline int ldlm_namespace_nr_read(enum ldlm_side client)
46 return client == LDLM_NAMESPACE_SERVER ?
47 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
50 static inline void ldlm_namespace_nr_inc(enum ldlm_side client)
52 if (client == LDLM_NAMESPACE_SERVER)
53 ldlm_srv_namespace_nr++;
55 ldlm_cli_namespace_nr++;
58 static inline void ldlm_namespace_nr_dec(enum ldlm_side client)
60 if (client == LDLM_NAMESPACE_SERVER)
61 ldlm_srv_namespace_nr--;
63 ldlm_cli_namespace_nr--;
66 static inline struct list_head *ldlm_namespace_list(enum ldlm_side client)
68 return client == LDLM_NAMESPACE_SERVER ?
69 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
73 struct list_head *ldlm_namespace_inactive_list(enum ldlm_side client)
75 return client == LDLM_NAMESPACE_SERVER ?
76 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
79 static inline struct mutex *ldlm_namespace_lock(enum ldlm_side client)
81 return client == LDLM_NAMESPACE_SERVER ?
82 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
85 /* ns_bref is the number of resources in this namespace */
86 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
88 return atomic_read(&ns->ns_bref) == 0;
91 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *,
93 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
95 struct ldlm_namespace *ldlm_namespace_first_locked(enum ldlm_side);
98 /* Cancel lru flag, it indicates we cancel aged locks. */
100 LDLM_LRU_FLAG_AGED = 0x01, /* Cancel aged locks (non LRU resize) */
101 LDLM_LRU_FLAG_PASSED = 0x02, /* Cancel passed number of locks */
102 LDLM_LRU_FLAG_SHRINK = 0x04, /* Cancel locks from shrinker */
103 LDLM_LRU_FLAG_LRUR = 0x08, /* Cancel locks from lru resize */
104 LDLM_LRU_FLAG_NO_WAIT = 0x10, /* Cancel locks w/o blocking (neither
105 * sending nor waiting for any RPCs) */
108 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
109 enum ldlm_cancel_flags cancel_flags,
110 enum ldlm_lru_flags lru_flags);
111 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
112 struct list_head *cancels, int count, int max,
113 enum ldlm_cancel_flags cancel_flags,
114 enum ldlm_lru_flags lru_flags);
115 extern unsigned int ldlm_enqueue_min;
116 /* ldlm_resource.c */
117 extern struct kmem_cache *ldlm_resource_slab;
118 extern struct kmem_cache *ldlm_lock_slab;
119 extern struct kmem_cache *ldlm_interval_tree_slab;
121 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
122 struct ldlm_lock *new);
129 LDLM_WORK_REVOKE_AST,
133 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
134 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
135 enum req_location loc, void *data, int size);
137 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
138 enum ldlm_type type, enum ldlm_mode mode,
139 const struct ldlm_callback_suite *cbs,
140 void *data, __u32 lvb_len, enum lvb_type lvb_type);
141 enum ldlm_error ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
142 void *cookie, __u64 *flags);
143 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
144 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
145 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
146 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
147 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
148 struct list_head *work_list);
149 #ifdef HAVE_SERVER_SUPPORT
150 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
151 struct list_head *work_list,
152 enum ldlm_process_intention intention);
153 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
154 struct list_head *rpc_list, __u64 grant_flags);
155 void ldlm_discard_bl_list(struct list_head *bl_list);
157 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
158 ldlm_desc_ast_t ast_type);
159 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
160 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use);
161 #define ldlm_lock_remove_from_lru(lock) \
162 ldlm_lock_remove_from_lru_check(lock, ktime_set(0, 0))
163 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
164 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
165 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
166 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
167 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
169 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
170 int ldlm_export_cancel_locks(struct obd_export *exp);
173 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
174 struct ldlm_lock *lock);
175 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
176 struct ldlm_lock_desc *ld,
177 struct list_head *cancels, int count,
178 enum ldlm_cancel_flags cancel_flags);
179 int ldlm_bl_thread_wakeup(void);
181 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
182 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);
196 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
197 enum ldlm_process_intention intention,
198 enum ldlm_error *err, struct list_head *work_list);
200 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
201 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
204 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
205 enum ldlm_process_intention intention,
206 enum ldlm_error *err, struct list_head *work_list);
207 int ldlm_init_flock_export(struct obd_export *exp);
208 void ldlm_destroy_flock_export(struct obd_export *exp);
211 void l_check_ns_lock(struct ldlm_namespace *ns);
212 void l_check_no_ns_lock(struct ldlm_namespace *ns);
214 extern struct proc_dir_entry *ldlm_svc_proc_dir;
217 struct ptlrpc_service *ldlm_cb_service;
218 struct ptlrpc_service *ldlm_cancel_service;
219 struct ptlrpc_client *ldlm_client;
220 struct ptlrpc_connection *ldlm_server_conn;
221 struct ldlm_bl_pool *ldlm_bl_pool;
224 /* interval tree, for LDLM_EXTENT. */
225 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
226 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
227 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
228 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
229 extern void ldlm_interval_free(struct ldlm_interval *node);
230 /* this function must be called with res lock held */
231 static inline struct ldlm_extent *
232 ldlm_interval_extent(struct ldlm_interval *node)
234 struct ldlm_lock *lock;
235 LASSERT(!list_empty(&node->li_group));
237 lock = list_entry(node->li_group.next, struct ldlm_lock,
239 return &lock->l_policy_data.l_extent;
243 void ldlm_exit(void);
245 enum ldlm_policy_res {
246 LDLM_POLICY_CANCEL_LOCK,
247 LDLM_POLICY_KEEP_LOCK,
248 LDLM_POLICY_SKIP_LOCK
251 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
252 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
253 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
254 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
255 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
256 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
258 #define LDLM_POOL_SYSFS_READER_SHOW(var, type) \
259 static ssize_t var##_show(struct kobject *kobj, \
260 struct attribute *attr, \
263 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
267 spin_lock(&pl->pl_lock); \
268 tmp = pl->pl_##var; \
269 spin_unlock(&pl->pl_lock); \
271 return LDLM_POOL_SYSFS_PRINT_##type(tmp); \
273 struct __##var##__dummy_read {;} /* semicolon catcher */
275 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type) \
276 static ssize_t var##_store(struct kobject *kobj, \
277 struct attribute *attr, \
278 const char *buffer, \
279 unsigned long count) \
281 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
286 rc = kstrtoul(buffer, 10, &tmp); \
291 spin_lock(&pl->pl_lock); \
292 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
293 spin_unlock(&pl->pl_lock); \
297 struct __##var##__dummy_write {; } /* semicolon catcher */
299 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type) \
300 static ssize_t var##_show(struct kobject *kobj, \
301 struct attribute *attr, \
304 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
307 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var); \
309 struct __##var##__dummy_read {; } /* semicolon catcher */
311 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type) \
312 static ssize_t var##_store(struct kobject *kobj, \
313 struct attribute *attr, \
314 const char *buffer, \
315 unsigned long count) \
317 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
322 rc = kstrtoul(buffer, 10, &tmp); \
327 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
331 struct __##var##__dummy_write {; } /* semicolon catcher */
334 ldlm_add_var(struct lprocfs_vars *vars, struct proc_dir_entry *proc_dir,
335 const char *name, void *data, const struct file_operations *ops)
337 snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
340 lprocfs_add_vars(proc_dir, vars, NULL);
343 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
347 lock_res_and_lock(lock);
348 if ((lock->l_req_mode == lock->l_granted_mode) &&
349 !ldlm_is_cp_reqd(lock))
351 else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
353 unlock_res_and_lock(lock);
358 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
359 union ldlm_policy_data *);
360 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
361 union ldlm_wire_policy_data *);
362 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
363 union ldlm_policy_data *lpolicy);
364 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
365 union ldlm_wire_policy_data *wpolicy);
366 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
367 union ldlm_policy_data *lpolicy);
368 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
369 union ldlm_wire_policy_data *wpolicy);
370 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
371 union ldlm_policy_data *lpolicy);
372 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
373 union ldlm_wire_policy_data *wpolicy);
374 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
375 union ldlm_policy_data *lpolicy);
376 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
377 union ldlm_wire_policy_data *wpolicy);
380 #ifdef HAVE_SERVER_SUPPORT
381 extern __u64 ldlm_reclaim_threshold;
382 extern __u64 ldlm_lock_limit;
383 extern __u64 ldlm_reclaim_threshold_mb;
384 extern __u64 ldlm_lock_limit_mb;
385 extern struct percpu_counter ldlm_granted_total;
387 int ldlm_reclaim_setup(void);
388 void ldlm_reclaim_cleanup(void);
389 void ldlm_reclaim_add(struct ldlm_lock *lock);
390 void ldlm_reclaim_del(struct ldlm_lock *lock);
391 bool ldlm_reclaim_full(void);
393 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
394 const struct ldlm_res_id *res1)
396 return memcmp(res0, res1, sizeof(*res0)) == 0;