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) */
106 LDLM_LRU_FLAG_CLEANUP = 0x20, /* Used when clearing lru, tells
107 * prepare_lru_list to set discard flag
108 * on PR extent locks so we don't waste
109 * time saving pages that will be
110 * discarded momentarily */
113 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
114 enum ldlm_cancel_flags cancel_flags,
115 enum ldlm_lru_flags lru_flags);
116 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
117 struct list_head *cancels, int count, int max,
118 enum ldlm_cancel_flags cancel_flags,
119 enum ldlm_lru_flags lru_flags);
120 extern unsigned int ldlm_enqueue_min;
121 /* ldlm_resource.c */
122 extern struct kmem_cache *ldlm_resource_slab;
123 extern struct kmem_cache *ldlm_lock_slab;
124 extern struct kmem_cache *ldlm_interval_tree_slab;
126 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
127 struct ldlm_lock *new);
134 LDLM_WORK_REVOKE_AST,
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(struct ldlm_namespace *, struct ldlm_lock **,
147 void *cookie, __u64 *flags);
148 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
149 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
150 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
151 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
152 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
153 struct list_head *work_list);
154 #ifdef HAVE_SERVER_SUPPORT
155 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
156 struct list_head *work_list,
157 enum ldlm_process_intention intention);
158 int ldlm_handle_conflict_lock(struct ldlm_lock *lock, __u64 *flags,
159 struct list_head *rpc_list, __u64 grant_flags);
160 void ldlm_discard_bl_list(struct list_head *bl_list);
162 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
163 ldlm_desc_ast_t ast_type);
164 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
165 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use);
166 #define ldlm_lock_remove_from_lru(lock) \
167 ldlm_lock_remove_from_lru_check(lock, ktime_set(0, 0))
168 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
169 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
170 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
171 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
172 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
174 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
175 int ldlm_export_cancel_locks(struct obd_export *exp);
178 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
179 struct ldlm_lock *lock);
180 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
181 struct ldlm_lock_desc *ld,
182 struct list_head *cancels, int count,
183 enum ldlm_cancel_flags cancel_flags);
184 int ldlm_bl_thread_wakeup(void);
186 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
187 struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
189 #ifdef HAVE_SERVER_SUPPORT
191 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
192 enum ldlm_process_intention intention,
193 enum ldlm_error *err, struct list_head *work_list);
195 /* ldlm_inodebits.c */
196 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
197 enum ldlm_process_intention intention,
198 enum ldlm_error *err,
199 struct list_head *work_list);
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 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
206 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
209 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
210 enum ldlm_process_intention intention,
211 enum ldlm_error *err, struct list_head *work_list);
212 int ldlm_init_flock_export(struct obd_export *exp);
213 void ldlm_destroy_flock_export(struct obd_export *exp);
216 void l_check_ns_lock(struct ldlm_namespace *ns);
217 void l_check_no_ns_lock(struct ldlm_namespace *ns);
219 extern struct proc_dir_entry *ldlm_svc_proc_dir;
222 struct ptlrpc_service *ldlm_cb_service;
223 struct ptlrpc_service *ldlm_cancel_service;
224 struct ptlrpc_client *ldlm_client;
225 struct ptlrpc_connection *ldlm_server_conn;
226 struct ldlm_bl_pool *ldlm_bl_pool;
229 /* interval tree, for LDLM_EXTENT. */
230 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
231 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
232 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
233 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
234 extern void ldlm_interval_free(struct ldlm_interval *node);
235 /* this function must be called with res lock held */
236 static inline struct ldlm_extent *
237 ldlm_interval_extent(struct ldlm_interval *node)
239 struct ldlm_lock *lock;
240 LASSERT(!list_empty(&node->li_group));
242 lock = list_entry(node->li_group.next, struct ldlm_lock,
244 return &lock->l_policy_data.l_extent;
248 void ldlm_exit(void);
250 enum ldlm_policy_res {
251 LDLM_POLICY_CANCEL_LOCK,
252 LDLM_POLICY_KEEP_LOCK,
253 LDLM_POLICY_SKIP_LOCK
256 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
257 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
258 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
259 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
260 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
261 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
263 #define LDLM_POOL_SYSFS_READER_SHOW(var, type) \
264 static ssize_t var##_show(struct kobject *kobj, \
265 struct attribute *attr, \
268 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
272 spin_lock(&pl->pl_lock); \
273 tmp = pl->pl_##var; \
274 spin_unlock(&pl->pl_lock); \
276 return LDLM_POOL_SYSFS_PRINT_##type(tmp); \
278 struct __##var##__dummy_read {;} /* semicolon catcher */
280 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type) \
281 static ssize_t var##_store(struct kobject *kobj, \
282 struct attribute *attr, \
283 const char *buffer, \
284 unsigned long count) \
286 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
291 rc = kstrtoul(buffer, 10, &tmp); \
296 spin_lock(&pl->pl_lock); \
297 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
298 spin_unlock(&pl->pl_lock); \
302 struct __##var##__dummy_write {; } /* semicolon catcher */
304 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type) \
305 static ssize_t var##_show(struct kobject *kobj, \
306 struct attribute *attr, \
309 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
312 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var); \
314 struct __##var##__dummy_read {; } /* semicolon catcher */
316 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type) \
317 static ssize_t var##_store(struct kobject *kobj, \
318 struct attribute *attr, \
319 const char *buffer, \
320 unsigned long count) \
322 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
327 rc = kstrtoul(buffer, 10, &tmp); \
332 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
336 struct __##var##__dummy_write {; } /* semicolon catcher */
339 ldlm_add_var(struct lprocfs_vars *vars, struct proc_dir_entry *proc_dir,
340 const char *name, void *data, const struct file_operations *ops)
342 snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
345 lprocfs_add_vars(proc_dir, vars, NULL);
348 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
352 lock_res_and_lock(lock);
353 if ((lock->l_req_mode == lock->l_granted_mode) &&
354 !ldlm_is_cp_reqd(lock))
356 else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
358 unlock_res_and_lock(lock);
363 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
364 union ldlm_policy_data *);
365 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
366 union ldlm_wire_policy_data *);
367 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
368 union ldlm_policy_data *lpolicy);
369 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
370 union ldlm_wire_policy_data *wpolicy);
371 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
372 union ldlm_policy_data *lpolicy);
373 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
374 union ldlm_wire_policy_data *wpolicy);
375 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
376 union ldlm_policy_data *lpolicy);
377 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
378 union ldlm_wire_policy_data *wpolicy);
379 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
380 union ldlm_policy_data *lpolicy);
381 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
382 union ldlm_wire_policy_data *wpolicy);
385 #ifdef HAVE_SERVER_SUPPORT
386 extern __u64 ldlm_reclaim_threshold;
387 extern __u64 ldlm_lock_limit;
388 extern __u64 ldlm_reclaim_threshold_mb;
389 extern __u64 ldlm_lock_limit_mb;
390 extern struct percpu_counter ldlm_granted_total;
392 int ldlm_reclaim_setup(void);
393 void ldlm_reclaim_cleanup(void);
394 void ldlm_reclaim_add(struct ldlm_lock *lock);
395 void ldlm_reclaim_del(struct ldlm_lock *lock);
396 bool ldlm_reclaim_full(void);
398 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
399 const struct ldlm_res_id *res1)
401 return memcmp(res0, res1, sizeof(*res0)) == 0;