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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2015, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
37 #define MAX_STRING_SIZE 128
39 extern int ldlm_srv_namespace_nr;
40 extern int ldlm_cli_namespace_nr;
41 extern struct mutex ldlm_srv_namespace_lock;
42 extern struct list_head ldlm_srv_namespace_list;
43 extern struct mutex ldlm_cli_namespace_lock;
44 extern struct list_head ldlm_cli_active_namespace_list;
45 extern struct list_head ldlm_cli_inactive_namespace_list;
46 extern unsigned int ldlm_cancel_unused_locks_before_replay;
48 static inline int ldlm_namespace_nr_read(enum ldlm_side client)
50 return client == LDLM_NAMESPACE_SERVER ?
51 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
54 static inline void ldlm_namespace_nr_inc(enum ldlm_side client)
56 if (client == LDLM_NAMESPACE_SERVER)
57 ldlm_srv_namespace_nr++;
59 ldlm_cli_namespace_nr++;
62 static inline void ldlm_namespace_nr_dec(enum ldlm_side client)
64 if (client == LDLM_NAMESPACE_SERVER)
65 ldlm_srv_namespace_nr--;
67 ldlm_cli_namespace_nr--;
70 static inline struct list_head *ldlm_namespace_list(enum ldlm_side client)
72 return client == LDLM_NAMESPACE_SERVER ?
73 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
77 struct list_head *ldlm_namespace_inactive_list(enum ldlm_side client)
79 return client == LDLM_NAMESPACE_SERVER ?
80 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
83 static inline struct mutex *ldlm_namespace_lock(enum ldlm_side client)
85 return client == LDLM_NAMESPACE_SERVER ?
86 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
89 /* ns_bref is the number of resources in this namespace */
90 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
92 return atomic_read(&ns->ns_bref) == 0;
95 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *,
97 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
99 struct ldlm_namespace *ldlm_namespace_first_locked(enum ldlm_side);
102 /* Cancel lru flag, it indicates we cancel aged locks. */
103 enum ldlm_lru_flags {
104 LDLM_LRU_FLAG_AGED = 0x01, /* Cancel aged locks (non LRU resize) */
105 LDLM_LRU_FLAG_PASSED = 0x02, /* Cancel passed number of locks */
106 LDLM_LRU_FLAG_SHRINK = 0x04, /* Cancel locks from shrinker */
107 LDLM_LRU_FLAG_LRUR = 0x08, /* Cancel locks from lru resize */
108 LDLM_LRU_FLAG_NO_WAIT = 0x10, /* Cancel locks w/o blocking (neither
109 * sending nor waiting for any RPCs) */
110 LDLM_LRU_FLAG_LRUR_NO_WAIT = 0x20, /* LRUR + NO_WAIT */
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);
131 struct ldlm_cb_set_arg {
132 struct ptlrpc_request_set *set;
133 int type; /* LDLM_{CP,BL,GL}_CALLBACK */
135 struct list_head *list;
136 union ldlm_gl_desc *gl_desc; /* glimpse AST descriptor */
142 LDLM_WORK_REVOKE_AST,
146 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
147 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
148 enum req_location loc, void *data, int size);
150 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
151 enum ldlm_type type, enum ldlm_mode mode,
152 const struct ldlm_callback_suite *cbs,
153 void *data, __u32 lvb_len, enum lvb_type lvb_type);
154 enum ldlm_error ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
155 void *cookie, __u64 *flags);
156 void ldlm_lock_addref_internal(struct ldlm_lock *, enum ldlm_mode mode);
157 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
158 void ldlm_lock_decref_internal(struct ldlm_lock *, enum ldlm_mode mode);
159 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, enum ldlm_mode mode);
160 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
161 struct list_head *work_list);
162 #ifdef HAVE_SERVER_SUPPORT
163 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
164 struct list_head *work_list);
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,
170 cfs_time_t last_use);
171 #define ldlm_lock_remove_from_lru(lock) ldlm_lock_remove_from_lru_check(lock, 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);
182 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
183 struct ldlm_lock *lock);
184 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
185 struct ldlm_lock_desc *ld,
186 struct list_head *cancels, int count,
187 enum ldlm_cancel_flags cancel_flags);
188 int ldlm_bl_thread_wakeup(void);
190 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
191 struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
193 #ifdef HAVE_SERVER_SUPPORT
195 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
196 int first_enq, enum ldlm_error *err,
197 struct list_head *work_list);
199 /* ldlm_inodebits.c */
200 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
201 int first_enq, enum ldlm_error *err,
202 struct list_head *work_list);
206 #ifdef HAVE_SERVER_SUPPORT
207 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
208 int first_enq, enum ldlm_error *err,
209 struct list_head *work_list);
211 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
212 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
215 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
216 int first_enq, enum ldlm_error *err,
217 struct list_head *work_list);
218 int ldlm_init_flock_export(struct obd_export *exp);
219 void ldlm_destroy_flock_export(struct obd_export *exp);
222 void l_check_ns_lock(struct ldlm_namespace *ns);
223 void l_check_no_ns_lock(struct ldlm_namespace *ns);
225 extern struct proc_dir_entry *ldlm_svc_proc_dir;
228 struct ptlrpc_service *ldlm_cb_service;
229 struct ptlrpc_service *ldlm_cancel_service;
230 struct ptlrpc_client *ldlm_client;
231 struct ptlrpc_connection *ldlm_server_conn;
232 struct ldlm_bl_pool *ldlm_bl_pool;
235 /* interval tree, for LDLM_EXTENT. */
236 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
237 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
238 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
239 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
240 extern void ldlm_interval_free(struct ldlm_interval *node);
241 /* this function must be called with res lock held */
242 static inline struct ldlm_extent *
243 ldlm_interval_extent(struct ldlm_interval *node)
245 struct ldlm_lock *lock;
246 LASSERT(!list_empty(&node->li_group));
248 lock = list_entry(node->li_group.next, struct ldlm_lock,
250 return &lock->l_policy_data.l_extent;
254 void ldlm_exit(void);
256 enum ldlm_policy_res {
257 LDLM_POLICY_CANCEL_LOCK,
258 LDLM_POLICY_KEEP_LOCK,
259 LDLM_POLICY_SKIP_LOCK
262 #define LDLM_POOL_PROC_READER_SEQ_SHOW(var, type) \
263 static int lprocfs_##var##_seq_show(struct seq_file *m, void *v)\
265 struct ldlm_pool *pl = m->private; \
268 spin_lock(&pl->pl_lock); \
269 tmp = pl->pl_##var; \
270 spin_unlock(&pl->pl_lock); \
272 return lprocfs_uint_seq_show(m, &tmp); \
274 struct __##var##__dummy_read {;} /* semicolon catcher */
276 #define LDLM_POOL_PROC_WRITER(var, type) \
277 static int lprocfs_wr_##var(struct file *file, \
278 const char __user *buffer, \
279 unsigned long count, void *data) \
281 struct ldlm_pool *pl = data; \
285 rc = lprocfs_wr_uint(file, buffer, count, &tmp); \
287 CERROR("Can't parse user input, rc = %d\n", rc);\
291 spin_lock(&pl->pl_lock); \
292 pl->pl_##var = tmp; \
293 spin_unlock(&pl->pl_lock); \
297 struct __##var##__dummy_write {;} /* semicolon catcher */
300 ldlm_add_var(struct lprocfs_vars *vars, struct proc_dir_entry *proc_dir,
301 const char *name, void *data, const struct file_operations *ops)
303 snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
306 lprocfs_add_vars(proc_dir, vars, NULL);
309 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
313 lock_res_and_lock(lock);
314 if ((lock->l_req_mode == lock->l_granted_mode) &&
315 !ldlm_is_cp_reqd(lock))
317 else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
319 unlock_res_and_lock(lock);
324 typedef void (*ldlm_policy_wire_to_local_t)(const union ldlm_wire_policy_data *,
325 union ldlm_policy_data *);
326 typedef void (*ldlm_policy_local_to_wire_t)(const union ldlm_policy_data *,
327 union ldlm_wire_policy_data *);
328 void ldlm_plain_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
329 union ldlm_policy_data *lpolicy);
330 void ldlm_plain_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
331 union ldlm_wire_policy_data *wpolicy);
332 void ldlm_ibits_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
333 union ldlm_policy_data *lpolicy);
334 void ldlm_ibits_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
335 union ldlm_wire_policy_data *wpolicy);
336 void ldlm_extent_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
337 union ldlm_policy_data *lpolicy);
338 void ldlm_extent_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
339 union ldlm_wire_policy_data *wpolicy);
340 void ldlm_flock_policy_wire_to_local(const union ldlm_wire_policy_data *wpolicy,
341 union ldlm_policy_data *lpolicy);
342 void ldlm_flock_policy_local_to_wire(const union ldlm_policy_data *lpolicy,
343 union ldlm_wire_policy_data *wpolicy);
346 #ifdef HAVE_SERVER_SUPPORT
347 extern __u64 ldlm_reclaim_threshold;
348 extern __u64 ldlm_lock_limit;
349 extern __u64 ldlm_reclaim_threshold_mb;
350 extern __u64 ldlm_lock_limit_mb;
351 extern struct percpu_counter ldlm_granted_total;
353 int ldlm_reclaim_setup(void);
354 void ldlm_reclaim_cleanup(void);
355 void ldlm_reclaim_add(struct ldlm_lock *lock);
356 void ldlm_reclaim_del(struct ldlm_lock *lock);
357 bool ldlm_reclaim_full(void);