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, 2013, 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(ldlm_side_t client)
50 return client == LDLM_NAMESPACE_SERVER ?
51 ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
54 static inline void ldlm_namespace_nr_inc(ldlm_side_t 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(ldlm_side_t 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(ldlm_side_t client)
72 return client == LDLM_NAMESPACE_SERVER ?
73 &ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
76 static inline struct list_head *ldlm_namespace_inactive_list(ldlm_side_t client)
78 return client == LDLM_NAMESPACE_SERVER ?
79 &ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
82 static inline struct mutex *ldlm_namespace_lock(ldlm_side_t client)
84 return client == LDLM_NAMESPACE_SERVER ?
85 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
88 /* ns_bref is the number of resources in this namespace */
89 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
91 return atomic_read(&ns->ns_bref) == 0;
94 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *, ldlm_side_t);
95 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *, ldlm_side_t);
96 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t);
99 /* Cancel lru flag, it indicates we cancel aged locks. */
101 LDLM_CANCEL_AGED = 1 << 0, /* Cancel aged locks (non lru resize). */
102 LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
103 LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
104 LDLM_CANCEL_LRUR = 1 << 3, /* Cancel locks from lru resize. */
105 LDLM_CANCEL_NO_WAIT = 1 << 4,/* Cancel locks w/o blocking (neither
106 * sending nor waiting for any rpcs) */
107 LDLM_CANCEL_LRUR_NO_WAIT = 1 << 5, /* LRUR + NO_WAIT */
110 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
111 ldlm_cancel_flags_t sync, int flags);
112 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
113 struct list_head *cancels, int count, int max,
114 ldlm_cancel_flags_t cancel_flags, int 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 int ldlm_resource_putref_locked(struct ldlm_resource *res);
122 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
123 struct ldlm_lock *new);
124 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
125 struct obd_import *imp, int force);
126 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
130 struct ldlm_cb_set_arg {
131 struct ptlrpc_request_set *set;
132 int type; /* LDLM_{CP,BL,GL}_CALLBACK */
134 struct list_head *list;
135 union ldlm_gl_desc *gl_desc; /* glimpse AST descriptor */
141 LDLM_WORK_REVOKE_AST,
145 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
146 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
147 enum req_location loc, void *data, int size);
149 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
150 ldlm_type_t type, ldlm_mode_t,
151 const struct ldlm_callback_suite *cbs,
152 void *data, __u32 lvb_len, enum lvb_type lvb_type);
153 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
154 void *cookie, __u64 *flags);
155 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
156 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
157 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
158 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
159 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
160 struct list_head *work_list);
161 #ifdef HAVE_SERVER_SUPPORT
162 int ldlm_reprocess_queue(struct ldlm_resource *res, struct list_head *queue,
163 struct list_head *work_list);
165 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
166 ldlm_desc_ast_t ast_type);
167 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
168 int ldlm_lock_remove_from_lru_check(struct ldlm_lock *lock,
169 cfs_time_t last_use);
170 #define ldlm_lock_remove_from_lru(lock) ldlm_lock_remove_from_lru_check(lock, 0)
171 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
172 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
173 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
174 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
175 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
177 void ldlm_cancel_locks_for_export(struct obd_export *export);
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 ldlm_cancel_flags_t cancel_flags);
187 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
188 struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
190 #ifdef HAVE_SERVER_SUPPORT
192 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
193 int first_enq, ldlm_error_t *err,
194 struct list_head *work_list);
196 /* ldlm_inodebits.c */
197 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
198 int first_enq, ldlm_error_t *err,
199 struct list_head *work_list);
203 #ifdef HAVE_SERVER_SUPPORT
204 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
205 int first_enq, ldlm_error_t *err,
206 struct list_head *work_list);
208 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
209 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
212 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
213 int first_enq, ldlm_error_t *err,
214 struct list_head *work_list);
215 int ldlm_init_flock_export(struct obd_export *exp);
216 void ldlm_destroy_flock_export(struct obd_export *exp);
219 void l_check_ns_lock(struct ldlm_namespace *ns);
220 void l_check_no_ns_lock(struct ldlm_namespace *ns);
222 extern struct proc_dir_entry *ldlm_svc_proc_dir;
225 struct ptlrpc_service *ldlm_cb_service;
226 struct ptlrpc_service *ldlm_cancel_service;
227 struct ptlrpc_client *ldlm_client;
228 struct ptlrpc_connection *ldlm_server_conn;
229 struct ldlm_bl_pool *ldlm_bl_pool;
232 /* interval tree, for LDLM_EXTENT. */
233 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
234 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
235 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
236 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
237 extern void ldlm_interval_free(struct ldlm_interval *node);
238 /* this function must be called with res lock held */
239 static inline struct ldlm_extent *
240 ldlm_interval_extent(struct ldlm_interval *node)
242 struct ldlm_lock *lock;
243 LASSERT(!list_empty(&node->li_group));
245 lock = list_entry(node->li_group.next, struct ldlm_lock,
247 return &lock->l_policy_data.l_extent;
251 void ldlm_exit(void);
253 enum ldlm_policy_res {
254 LDLM_POLICY_CANCEL_LOCK,
255 LDLM_POLICY_KEEP_LOCK,
256 LDLM_POLICY_SKIP_LOCK
259 typedef enum ldlm_policy_res ldlm_policy_res_t;
261 #define LDLM_POOL_PROC_READER_SEQ_SHOW(var, type) \
262 static int lprocfs_##var##_seq_show(struct seq_file *m, void *v)\
264 struct ldlm_pool *pl = m->private; \
267 spin_lock(&pl->pl_lock); \
268 tmp = pl->pl_##var; \
269 spin_unlock(&pl->pl_lock); \
271 return lprocfs_uint_seq_show(m, &tmp); \
273 struct __##var##__dummy_read {;} /* semicolon catcher */
275 #define LDLM_POOL_PROC_WRITER(var, type) \
276 static int lprocfs_wr_##var(struct file *file, \
277 const char __user *buffer, \
278 unsigned long count, void *data) \
280 struct ldlm_pool *pl = data; \
284 rc = lprocfs_wr_uint(file, buffer, count, &tmp); \
286 CERROR("Can't parse user input, rc = %d\n", rc);\
290 spin_lock(&pl->pl_lock); \
291 pl->pl_##var = tmp; \
292 spin_unlock(&pl->pl_lock); \
296 struct __##var##__dummy_write {;} /* semicolon catcher */
299 ldlm_add_var(struct lprocfs_vars *vars, struct proc_dir_entry *proc_dir,
300 const char *name, void *data, const struct file_operations *ops)
302 snprintf((char *)vars->name, MAX_STRING_SIZE, "%s", name);
305 lprocfs_add_vars(proc_dir, vars, NULL);
308 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
312 lock_res_and_lock(lock);
313 if ((lock->l_req_mode == lock->l_granted_mode) &&
314 !ldlm_is_cp_reqd(lock))
316 else if (ldlm_is_failed(lock) || ldlm_is_cancel(lock))
318 unlock_res_and_lock(lock);
323 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
324 ldlm_policy_data_t *);
326 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
327 ldlm_wire_policy_data_t *);
329 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
330 ldlm_policy_data_t *lpolicy);
331 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
332 ldlm_wire_policy_data_t *wpolicy);
333 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
334 ldlm_policy_data_t *lpolicy);
335 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
336 ldlm_wire_policy_data_t *wpolicy);
337 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
338 ldlm_policy_data_t *lpolicy);
339 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
340 ldlm_wire_policy_data_t *wpolicy);
341 void ldlm_flock_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
342 ldlm_policy_data_t *lpolicy);
344 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
345 ldlm_wire_policy_data_t *wpolicy);
348 extern __u64 ldlm_watermark_low;
349 extern __u64 ldlm_watermark_high;
350 int ldlm_reclaim_setup(void);
351 void ldlm_reclaim_cleanup(void);
352 void ldlm_reclaim_add(struct ldlm_lock *lock);
353 void ldlm_reclaim_del(struct ldlm_lock *lock);
354 bool ldlm_reclaim_full(void);