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, 2012, Whamcloud, Inc.
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 cfs_atomic_t ldlm_srv_namespace_nr;
40 extern cfs_atomic_t ldlm_cli_namespace_nr;
41 extern cfs_mutex_t ldlm_srv_namespace_lock;
42 extern cfs_list_t ldlm_srv_namespace_list;
43 extern cfs_mutex_t ldlm_cli_namespace_lock;
44 extern cfs_list_t ldlm_cli_namespace_list;
46 static inline cfs_atomic_t *ldlm_namespace_nr(ldlm_side_t client)
48 return client == LDLM_NAMESPACE_SERVER ?
49 &ldlm_srv_namespace_nr : &ldlm_cli_namespace_nr;
52 static inline cfs_list_t *ldlm_namespace_list(ldlm_side_t client)
54 return client == LDLM_NAMESPACE_SERVER ?
55 &ldlm_srv_namespace_list : &ldlm_cli_namespace_list;
58 static inline cfs_mutex_t *ldlm_namespace_lock(ldlm_side_t client)
60 return client == LDLM_NAMESPACE_SERVER ?
61 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
70 /* Cancel lru flag, it indicates we cancel aged locks. */
72 LDLM_CANCEL_AGED = 1 << 0, /* Cancel aged locks (non lru resize). */
73 LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
74 LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
75 LDLM_CANCEL_LRUR = 1 << 3, /* Cancel locks from lru resize. */
76 LDLM_CANCEL_NO_WAIT = 1 << 4 /* Cancel locks w/o blocking (neither
77 * sending nor waiting for any rpcs) */
80 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr, ldlm_sync_t sync,
82 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
83 cfs_list_t *cancels, int count, int max,
84 ldlm_cancel_flags_t cancel_flags, int flags);
85 extern int ldlm_enqueue_min;
86 int ldlm_get_enq_timeout(struct ldlm_lock *lock);
89 int ldlm_resource_putref_locked(struct ldlm_resource *res);
90 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
91 struct ldlm_lock *new);
92 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
93 struct obd_import *imp, int force);
94 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
97 struct ldlm_cb_set_arg {
98 int type; /* LDLM_BL_CALLBACK or LDLM_CP_CALLBACK */
99 unsigned int threshold; /* threshold to wake up the waiting proc */
100 cfs_atomic_t rpcs; /* # of inflight rpcs in set */
101 cfs_atomic_t restart;
102 cfs_atomic_t refcount;
106 static inline void ldlm_csa_put(struct ldlm_cb_set_arg *arg)
108 if (cfs_atomic_dec_and_test(&arg->refcount)) {
109 LASSERT(cfs_atomic_read(&arg->rpcs) == 0);
121 void ldlm_grant_lock(struct ldlm_lock *lock, cfs_list_t *work_list);
123 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
124 ldlm_type_t type, ldlm_mode_t,
125 const struct ldlm_callback_suite *cbs,
126 void *data, __u32 lvb_len);
127 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
128 void *cookie, int *flags);
129 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
130 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
131 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
132 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
133 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
134 cfs_list_t *work_list);
135 #ifdef HAVE_SERVER_SUPPORT
136 int ldlm_reprocess_queue(struct ldlm_resource *res, cfs_list_t *queue,
137 cfs_list_t *work_list);
139 int ldlm_run_ast_work(struct ldlm_namespace *ns, cfs_list_t *rpc_list,
140 ldlm_desc_ast_t ast_type);
141 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
142 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
143 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
144 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
145 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
146 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
148 void ldlm_cancel_locks_for_export(struct obd_export *export);
151 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
152 struct ldlm_lock *lock);
153 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
154 cfs_list_t *cancels, int count, int mode);
156 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
157 struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
159 #ifdef HAVE_SERVER_SUPPORT
161 int ldlm_process_plain_lock(struct ldlm_lock *lock, int *flags, int first_enq,
162 ldlm_error_t *err, cfs_list_t *work_list);
164 /* ldlm_inodebits.c */
165 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, int *flags,
166 int first_enq, ldlm_error_t *err,
167 cfs_list_t *work_list);
171 #ifdef HAVE_SERVER_SUPPORT
172 int ldlm_process_extent_lock(struct ldlm_lock *lock, int *flags, int first_enq,
173 ldlm_error_t *err, cfs_list_t *work_list);
175 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
176 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
179 int ldlm_process_flock_lock(struct ldlm_lock *req, int *flags, int first_enq,
180 ldlm_error_t *err, cfs_list_t *work_list);
183 void l_check_ns_lock(struct ldlm_namespace *ns);
184 void l_check_no_ns_lock(struct ldlm_namespace *ns);
186 extern cfs_proc_dir_entry_t *ldlm_svc_proc_dir;
187 extern cfs_proc_dir_entry_t *ldlm_type_proc_dir;
190 struct ptlrpc_service *ldlm_cb_service;
191 struct ptlrpc_service *ldlm_cancel_service;
192 struct ptlrpc_client *ldlm_client;
193 struct ptlrpc_connection *ldlm_server_conn;
194 struct ldlm_bl_pool *ldlm_bl_pool;
197 /* interval tree, for LDLM_EXTENT. */
198 extern cfs_mem_cache_t *ldlm_interval_slab; /* slab cache for ldlm_interval */
199 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
200 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
201 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
202 extern void ldlm_interval_free(struct ldlm_interval *node);
203 /* this function must be called with res lock held */
204 static inline struct ldlm_extent *
205 ldlm_interval_extent(struct ldlm_interval *node)
207 struct ldlm_lock *lock;
208 LASSERT(!cfs_list_empty(&node->li_group));
210 lock = cfs_list_entry(node->li_group.next, struct ldlm_lock,
212 return &lock->l_policy_data.l_extent;
216 void ldlm_exit(void);
218 enum ldlm_policy_res {
219 LDLM_POLICY_CANCEL_LOCK,
220 LDLM_POLICY_KEEP_LOCK,
221 LDLM_POLICY_SKIP_LOCK
224 typedef enum ldlm_policy_res ldlm_policy_res_t;
226 #define LDLM_POOL_PROC_READER(var, type) \
227 static int lprocfs_rd_##var(char *page, char **start, off_t off, \
228 int count, int *eof, void *data) \
230 struct ldlm_pool *pl = data; \
233 cfs_spin_lock(&pl->pl_lock); \
234 tmp = pl->pl_##var; \
235 cfs_spin_unlock(&pl->pl_lock); \
237 return lprocfs_rd_uint(page, start, off, count, eof, &tmp); \
239 struct __##var##__dummy_read {;} /* semicolon catcher */
241 #define LDLM_POOL_PROC_WRITER(var, type) \
242 int lprocfs_wr_##var(struct file *file, const char *buffer, \
243 unsigned long count, void *data) \
245 struct ldlm_pool *pl = data; \
249 rc = lprocfs_wr_uint(file, buffer, count, &tmp); \
251 CERROR("Can't parse user input, rc = %d\n", rc); \
255 cfs_spin_lock(&pl->pl_lock); \
256 pl->pl_##var = tmp; \
257 cfs_spin_unlock(&pl->pl_lock); \
261 struct __##var##__dummy_write {;} /* semicolon catcher */
263 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
267 lock_res_and_lock(lock);
268 if (((lock->l_req_mode == lock->l_granted_mode) &&
269 !(lock->l_flags & LDLM_FL_CP_REQD)) ||
270 (lock->l_flags & (LDLM_FL_FAILED | LDLM_FL_CANCEL)))
272 unlock_res_and_lock(lock);
277 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
278 ldlm_policy_data_t *);
280 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
281 ldlm_wire_policy_data_t *);
283 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
284 ldlm_policy_data_t *lpolicy);
285 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
286 ldlm_wire_policy_data_t *wpolicy);
287 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
288 ldlm_policy_data_t *lpolicy);
289 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
290 ldlm_wire_policy_data_t *wpolicy);
291 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
292 ldlm_policy_data_t *lpolicy);
293 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
294 ldlm_wire_policy_data_t *wpolicy);
295 void ldlm_flock_policy_wire18_to_local(const ldlm_wire_policy_data_t *wpolicy,
296 ldlm_policy_data_t *lpolicy);
297 void ldlm_flock_policy_wire21_to_local(const ldlm_wire_policy_data_t *wpolicy,
298 ldlm_policy_data_t *lpolicy);
300 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
301 ldlm_wire_policy_data_t *wpolicy);