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_LRUR_NO_WAIT = 0x20, /* LRUR + NO_WAIT */
109 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
110 enum ldlm_cancel_flags cancel_flags,
111 enum ldlm_lru_flags lru_flags);
112 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
113 struct list_head *cancels, int count, int max,
114 enum ldlm_cancel_flags cancel_flags,
115 enum ldlm_lru_flags lru_flags);
116 extern unsigned int ldlm_enqueue_min;
117 /* ldlm_resource.c */
118 extern struct kmem_cache *ldlm_resource_slab;
119 extern struct kmem_cache *ldlm_lock_slab;
120 extern struct kmem_cache *ldlm_interval_tree_slab;
122 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
123 struct ldlm_lock *new);
127 struct ldlm_cb_set_arg {
128 struct ptlrpc_request_set *set;
129 int type; /* LDLM_{CP,BL,GL}_CALLBACK */
131 struct list_head *list;
132 union ldlm_gl_desc *gl_desc; /* glimpse AST descriptor */
138 LDLM_WORK_REVOKE_AST,
142 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
143 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
144 enum req_location loc, void *data, int size);
146 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
147 enum ldlm_type type, enum ldlm_mode mode,
148 const struct ldlm_callback_suite *cbs,
149 void *data, __u32 lvb_len, enum lvb_type lvb_type);
150 enum ldlm_error ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
151 void *cookie, __u64 *flags);
152 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
153 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
154 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
155 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
156 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
157 struct list_head *work_list);
158 #ifdef HAVE_SERVER_SUPPORT
159 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
160 struct list_head *work_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,
166 cfs_time_t last_use);
167 #define ldlm_lock_remove_from_lru(lock) ldlm_lock_remove_from_lru_check(lock, 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 int first_enq, enum ldlm_error *err,
193 struct list_head *work_list);
195 /* ldlm_inodebits.c */
196 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
197 int first_enq, enum ldlm_error *err,
198 struct list_head *work_list);
202 #ifdef HAVE_SERVER_SUPPORT
203 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
204 int first_enq, enum ldlm_error *err,
205 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 int first_enq, enum ldlm_error *err,
213 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_PROC_READER_SEQ_SHOW(var, type) \
259 static int lprocfs_##var##_seq_show(struct seq_file *m, void *v)\
261 struct ldlm_pool *pl = m->private; \
264 spin_lock(&pl->pl_lock); \
265 tmp = pl->pl_##var; \
266 spin_unlock(&pl->pl_lock); \
268 return lprocfs_uint_seq_show(m, &tmp); \
270 struct __##var##__dummy_read {;} /* semicolon catcher */
272 #define LDLM_POOL_PROC_WRITER(var, type) \
273 static int lprocfs_wr_##var(struct file *file, \
274 const char __user *buffer, \
275 unsigned long count, void *data) \
277 struct ldlm_pool *pl = data; \
281 rc = lprocfs_wr_uint(file, buffer, count, &tmp); \
283 CERROR("Can't parse user input, rc = %d\n", rc);\
287 spin_lock(&pl->pl_lock); \
288 pl->pl_##var = tmp; \
289 spin_unlock(&pl->pl_lock); \
293 struct __##var##__dummy_write {;} /* semicolon catcher */
296 ldlm_add_var(struct lprocfs_vars *vars, struct proc_dir_entry *proc_dir,
297 const char *name, void *data, const struct file_operations *ops)
299 snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
302 lprocfs_add_vars(proc_dir, vars, NULL);
305 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
309 lock_res_and_lock(lock);
310 if ((lock->l_req_mode == lock->l_granted_mode) &&
311 !ldlm_is_cp_reqd(lock))
313 else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
315 unlock_res_and_lock(lock);
320 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
321 union ldlm_policy_data *);
322 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
323 union ldlm_wire_policy_data *);
324 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
325 union ldlm_policy_data *lpolicy);
326 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
327 union ldlm_wire_policy_data *wpolicy);
328 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
329 union ldlm_policy_data *lpolicy);
330 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
331 union ldlm_wire_policy_data *wpolicy);
332 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
333 union ldlm_policy_data *lpolicy);
334 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
335 union ldlm_wire_policy_data *wpolicy);
336 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
337 union ldlm_policy_data *lpolicy);
338 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
339 union ldlm_wire_policy_data *wpolicy);
342 #ifdef HAVE_SERVER_SUPPORT
343 extern __u64 ldlm_reclaim_threshold;
344 extern __u64 ldlm_lock_limit;
345 extern __u64 ldlm_reclaim_threshold_mb;
346 extern __u64 ldlm_lock_limit_mb;
347 extern struct percpu_counter ldlm_granted_total;
349 int ldlm_reclaim_setup(void);
350 void ldlm_reclaim_cleanup(void);
351 void ldlm_reclaim_add(struct ldlm_lock *lock);
352 void ldlm_reclaim_del(struct ldlm_lock *lock);
353 bool ldlm_reclaim_full(void);
355 static inline bool ldlm_res_eq(const struct ldlm_res_id *res0,
356 const struct ldlm_res_id *res1)
358 return memcmp(res0, res1, sizeof(*res0)) == 0;