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;
43 extern struct kmem_cache *ldlm_glimpse_work_kmem;
45 static inline int ldlm_namespace_nr_read(enum ldlm_side client)
47 return client == LDLM_NAMESPACE_SERVER ?
48 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
51 static inline void ldlm_namespace_nr_inc(enum ldlm_side client)
53 if (client == LDLM_NAMESPACE_SERVER)
54 ldlm_srv_namespace_nr++;
56 ldlm_cli_namespace_nr++;
59 static inline void ldlm_namespace_nr_dec(enum ldlm_side client)
61 if (client == LDLM_NAMESPACE_SERVER)
62 ldlm_srv_namespace_nr--;
64 ldlm_cli_namespace_nr--;
67 static inline struct list_head *ldlm_namespace_list(enum ldlm_side client)
69 return client == LDLM_NAMESPACE_SERVER ?
70 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
74 struct list_head *ldlm_namespace_inactive_list(enum ldlm_side client)
76 return client == LDLM_NAMESPACE_SERVER ?
77 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
80 static inline struct mutex *ldlm_namespace_lock(enum ldlm_side client)
82 return client == LDLM_NAMESPACE_SERVER ?
83 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
86 /* ns_bref is the number of resources in this namespace */
87 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
89 return atomic_read(&ns->ns_bref) == 0;
92 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *,
94 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
96 struct ldlm_namespace *ldlm_namespace_first_locked(enum ldlm_side);
99 /* Cancel lru flag, it indicates we cancel aged locks. */
100 enum ldlm_lru_flags {
101 LDLM_LRU_FLAG_AGED = 0x01, /* Cancel aged locks (non LRU resize) */
102 LDLM_LRU_FLAG_PASSED = 0x02, /* Cancel passed number of locks */
103 LDLM_LRU_FLAG_SHRINK = 0x04, /* Cancel locks from shrinker */
104 LDLM_LRU_FLAG_LRUR = 0x08, /* Cancel locks from lru resize */
105 LDLM_LRU_FLAG_NO_WAIT = 0x10, /* Cancel locks w/o blocking (neither
106 * sending nor waiting for any RPCs) */
107 LDLM_LRU_FLAG_CLEANUP = 0x20, /* Used when clearing lru, tells
108 * prepare_lru_list to set discard flag
109 * on PR extent locks so we don't waste
110 * time saving pages that will be
111 * discarded momentarily */
114 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
115 enum ldlm_cancel_flags cancel_flags,
116 enum ldlm_lru_flags lru_flags);
117 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
118 struct list_head *cancels, int count, int max,
119 enum ldlm_cancel_flags cancel_flags,
120 enum ldlm_lru_flags lru_flags);
121 extern unsigned int ldlm_enqueue_min;
122 /* ldlm_resource.c */
123 extern struct kmem_cache *ldlm_resource_slab;
124 extern struct kmem_cache *ldlm_lock_slab;
125 extern struct kmem_cache *ldlm_interval_tree_slab;
127 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
128 struct ldlm_lock *new);
135 LDLM_WORK_REVOKE_AST,
139 void ldlm_grant_lock_with_skiplist(struct ldlm_lock *lock);
140 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
141 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
142 enum req_location loc, void *data, int size);
144 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
145 enum ldlm_type type, enum ldlm_mode mode,
146 const struct ldlm_callback_suite *cbs,
147 void *data, __u32 lvb_len, enum lvb_type lvb_type);
148 enum ldlm_error ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
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, __u64 grant_flags);
162 void ldlm_discard_bl_list(struct list_head *bl_list);
164 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
165 ldlm_desc_ast_t ast_type);
166 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
167 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock, ktime_t last_use);
168 #define ldlm_lock_remove_from_lru(lock) \
169 ldlm_lock_remove_from_lru_check(lock, ktime_set(0, 0))
170 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
171 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
172 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
173 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
174 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
176 int ldlm_export_cancel_blocked_locks(struct obd_export *exp);
177 int ldlm_export_cancel_locks(struct obd_export *exp);
180 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
181 struct ldlm_lock *lock);
182 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
183 struct ldlm_lock_desc *ld,
184 struct list_head *cancels, int count,
185 enum ldlm_cancel_flags cancel_flags);
186 int ldlm_bl_thread_wakeup(void);
188 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
189 struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
191 #ifdef HAVE_SERVER_SUPPORT
193 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
194 enum ldlm_process_intention intention,
195 enum ldlm_error *err, struct list_head *work_list);
197 /* ldlm_inodebits.c */
198 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
199 enum ldlm_process_intention intention,
200 enum ldlm_error *err,
201 struct list_head *work_list);
203 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
204 enum ldlm_process_intention intention,
205 enum ldlm_error *err, struct list_head *work_list);
207 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
208 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
211 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
212 enum ldlm_process_intention intention,
213 enum ldlm_error *err, struct list_head *work_list);
214 int ldlm_init_flock_export(struct obd_export *exp);
215 void ldlm_destroy_flock_export(struct obd_export *exp);
218 void l_check_ns_lock(struct ldlm_namespace *ns);
219 void l_check_no_ns_lock(struct ldlm_namespace *ns);
221 extern struct proc_dir_entry *ldlm_svc_proc_dir;
224 struct ptlrpc_service *ldlm_cb_service;
225 struct ptlrpc_service *ldlm_cancel_service;
226 struct ptlrpc_client *ldlm_client;
227 struct ptlrpc_connection *ldlm_server_conn;
228 struct ldlm_bl_pool *ldlm_bl_pool;
231 /* interval tree, for LDLM_EXTENT. */
232 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
233 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
234 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
235 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
236 extern void ldlm_interval_free(struct ldlm_interval *node);
237 /* this function must be called with res lock held */
238 static inline struct ldlm_extent *
239 ldlm_interval_extent(struct ldlm_interval *node)
241 struct ldlm_lock *lock;
242 LASSERT(!list_empty(&node->li_group));
244 lock = list_entry(node->li_group.next, struct ldlm_lock,
246 return &lock->l_policy_data.l_extent;
250 void ldlm_exit(void);
252 enum ldlm_policy_res {
253 LDLM_POLICY_CANCEL_LOCK,
254 LDLM_POLICY_KEEP_LOCK,
255 LDLM_POLICY_SKIP_LOCK
258 #define LDLM_POOL_SYSFS_PRINT_int(v) sprintf(buf, "%d\n", v)
259 #define LDLM_POOL_SYSFS_SET_int(a, b) { a = b; }
260 #define LDLM_POOL_SYSFS_PRINT_u64(v) sprintf(buf, "%lld\n", v)
261 #define LDLM_POOL_SYSFS_SET_u64(a, b) { a = b; }
262 #define LDLM_POOL_SYSFS_PRINT_atomic(v) sprintf(buf, "%d\n", atomic_read(&v))
263 #define LDLM_POOL_SYSFS_SET_atomic(a, b) atomic_set(&a, b)
265 #define LDLM_POOL_SYSFS_READER_SHOW(var, type) \
266 static ssize_t var##_show(struct kobject *kobj, \
267 struct attribute *attr, \
270 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
274 spin_lock(&pl->pl_lock); \
275 tmp = pl->pl_##var; \
276 spin_unlock(&pl->pl_lock); \
278 return LDLM_POOL_SYSFS_PRINT_##type(tmp); \
280 struct __##var##__dummy_read {;} /* semicolon catcher */
282 #define LDLM_POOL_SYSFS_WRITER_STORE(var, type) \
283 static ssize_t var##_store(struct kobject *kobj, \
284 struct attribute *attr, \
285 const char *buffer, \
286 unsigned long count) \
288 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
293 rc = kstrtoul(buffer, 10, &tmp); \
298 spin_lock(&pl->pl_lock); \
299 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
300 spin_unlock(&pl->pl_lock); \
304 struct __##var##__dummy_write {; } /* semicolon catcher */
306 #define LDLM_POOL_SYSFS_READER_NOLOCK_SHOW(var, type) \
307 static ssize_t var##_show(struct kobject *kobj, \
308 struct attribute *attr, \
311 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
314 return LDLM_POOL_SYSFS_PRINT_##type(pl->pl_##var); \
316 struct __##var##__dummy_read {; } /* semicolon catcher */
318 #define LDLM_POOL_SYSFS_WRITER_NOLOCK_STORE(var, type) \
319 static ssize_t var##_store(struct kobject *kobj, \
320 struct attribute *attr, \
321 const char *buffer, \
322 unsigned long count) \
324 struct ldlm_pool *pl = container_of(kobj, struct ldlm_pool,\
329 rc = kstrtoul(buffer, 10, &tmp); \
334 LDLM_POOL_SYSFS_SET_##type(pl->pl_##var, tmp); \
338 struct __##var##__dummy_write {; } /* semicolon catcher */
341 ldlm_add_var(struct lprocfs_vars *vars, struct proc_dir_entry *proc_dir,
342 const char *name, void *data, const struct file_operations *ops)
344 snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
347 lprocfs_add_vars(proc_dir, vars, NULL);
350 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
354 lock_res_and_lock(lock);
355 if ((lock->l_req_mode == lock->l_granted_mode) &&
356 !ldlm_is_cp_reqd(lock))
358 else if (ldlm_is_failed(lock) || ldlm_is_cancel(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 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
379 union ldlm_policy_data *);
380 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
381 union ldlm_wire_policy_data *);
382 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
383 union ldlm_policy_data *lpolicy);
384 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
385 union ldlm_wire_policy_data *wpolicy);
386 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
387 union ldlm_policy_data *lpolicy);
388 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
389 union ldlm_wire_policy_data *wpolicy);
390 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
391 union ldlm_policy_data *lpolicy);
392 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
393 union ldlm_wire_policy_data *wpolicy);
394 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
395 union ldlm_policy_data *lpolicy);
396 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
397 union ldlm_wire_policy_data *wpolicy);
400 #ifdef HAVE_SERVER_SUPPORT
401 extern __u64 ldlm_reclaim_threshold;
402 extern __u64 ldlm_lock_limit;
403 extern __u64 ldlm_reclaim_threshold_mb;
404 extern __u64 ldlm_lock_limit_mb;
405 extern struct percpu_counter ldlm_granted_total;
407 int ldlm_reclaim_setup(void);
408 void ldlm_reclaim_cleanup(void);
409 void ldlm_reclaim_add(struct ldlm_lock *lock);
410 void ldlm_reclaim_del(struct ldlm_lock *lock);
411 bool ldlm_reclaim_full(void);
413 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
414 const struct ldlm_res_id *res1)
416 return memcmp(res0, res1, sizeof(*res0)) == 0;