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, 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 cfs_atomic_t ldlm_srv_namespace_nr;
40 extern cfs_atomic_t ldlm_cli_namespace_nr;
41 extern struct mutex ldlm_srv_namespace_lock;
42 extern cfs_list_t ldlm_srv_namespace_list;
43 extern struct mutex 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 struct mutex *ldlm_namespace_lock(ldlm_side_t client)
60 return client == LDLM_NAMESPACE_SERVER ?
61 &ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
65 /* Cancel lru flag, it indicates we cancel aged locks. */
67 LDLM_CANCEL_AGED = 1 << 0, /* Cancel aged locks (non lru resize). */
68 LDLM_CANCEL_PASSED = 1 << 1, /* Cancel passed number of locks. */
69 LDLM_CANCEL_SHRINK = 1 << 2, /* Cancel locks from shrinker. */
70 LDLM_CANCEL_LRUR = 1 << 3, /* Cancel locks from lru resize. */
71 LDLM_CANCEL_NO_WAIT = 1 << 4 /* Cancel locks w/o blocking (neither
72 * sending nor waiting for any rpcs) */
75 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
76 ldlm_cancel_flags_t sync, int flags);
77 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
78 cfs_list_t *cancels, int count, int max,
79 ldlm_cancel_flags_t cancel_flags, int flags);
80 extern int ldlm_enqueue_min;
81 int ldlm_get_enq_timeout(struct ldlm_lock *lock);
84 int ldlm_resource_putref_locked(struct ldlm_resource *res);
85 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
86 struct ldlm_lock *new);
87 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
88 struct obd_import *imp, int force);
89 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
92 struct ldlm_cb_set_arg {
93 struct ptlrpc_request_set *set;
94 int type; /* LDLM_{CP,BL,GL}_CALLBACK */
97 union ldlm_gl_desc *gl_desc; /* glimpse AST descriptor */
103 LDLM_WORK_REVOKE_AST,
107 void ldlm_grant_lock(struct ldlm_lock *lock, cfs_list_t *work_list);
108 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
109 enum req_location loc, void *data, int size);
111 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
112 ldlm_type_t type, ldlm_mode_t,
113 const struct ldlm_callback_suite *cbs,
114 void *data, __u32 lvb_len, enum lvb_type lvb_type);
115 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
116 void *cookie, __u64 *flags);
117 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
118 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
119 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
120 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
121 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
122 cfs_list_t *work_list);
123 #ifdef HAVE_SERVER_SUPPORT
124 int ldlm_reprocess_queue(struct ldlm_resource *res, cfs_list_t *queue,
125 cfs_list_t *work_list);
127 int ldlm_run_ast_work(struct ldlm_namespace *ns, cfs_list_t *rpc_list,
128 ldlm_desc_ast_t ast_type);
129 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
130 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
131 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
132 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
133 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
134 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
135 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
137 void ldlm_cancel_locks_for_export(struct obd_export *export);
140 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
141 struct ldlm_lock *lock);
142 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
143 struct ldlm_lock_desc *ld,
144 cfs_list_t *cancels, int count,
145 ldlm_cancel_flags_t cancel_flags);
147 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
148 struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
150 #ifdef HAVE_SERVER_SUPPORT
152 int ldlm_process_plain_lock(struct ldlm_lock *lock, __u64 *flags,
153 int first_enq, ldlm_error_t *err,
154 cfs_list_t *work_list);
156 /* ldlm_inodebits.c */
157 int ldlm_process_inodebits_lock(struct ldlm_lock *lock, __u64 *flags,
158 int first_enq, ldlm_error_t *err,
159 cfs_list_t *work_list);
163 #ifdef HAVE_SERVER_SUPPORT
164 int ldlm_process_extent_lock(struct ldlm_lock *lock, __u64 *flags,
165 int first_enq, ldlm_error_t *err,
166 cfs_list_t *work_list);
168 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
169 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
172 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
173 int first_enq, ldlm_error_t *err,
174 cfs_list_t *work_list);
175 int ldlm_init_flock_export(struct obd_export *exp);
176 void ldlm_destroy_flock_export(struct obd_export *exp);
179 void l_check_ns_lock(struct ldlm_namespace *ns);
180 void l_check_no_ns_lock(struct ldlm_namespace *ns);
182 extern cfs_proc_dir_entry_t *ldlm_svc_proc_dir;
183 extern cfs_proc_dir_entry_t *ldlm_type_proc_dir;
186 struct ptlrpc_service *ldlm_cb_service;
187 struct ptlrpc_service *ldlm_cancel_service;
188 struct ptlrpc_client *ldlm_client;
189 struct ptlrpc_connection *ldlm_server_conn;
190 struct ldlm_bl_pool *ldlm_bl_pool;
193 /* interval tree, for LDLM_EXTENT. */
194 extern cfs_mem_cache_t *ldlm_interval_slab; /* slab cache for ldlm_interval */
195 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
196 extern struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
197 extern struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
198 extern void ldlm_interval_free(struct ldlm_interval *node);
199 /* this function must be called with res lock held */
200 static inline struct ldlm_extent *
201 ldlm_interval_extent(struct ldlm_interval *node)
203 struct ldlm_lock *lock;
204 LASSERT(!cfs_list_empty(&node->li_group));
206 lock = cfs_list_entry(node->li_group.next, struct ldlm_lock,
208 return &lock->l_policy_data.l_extent;
212 void ldlm_exit(void);
214 enum ldlm_policy_res {
215 LDLM_POLICY_CANCEL_LOCK,
216 LDLM_POLICY_KEEP_LOCK,
217 LDLM_POLICY_SKIP_LOCK
220 typedef enum ldlm_policy_res ldlm_policy_res_t;
222 #define LDLM_POOL_PROC_READER(var, type) \
223 static int lprocfs_rd_##var(char *page, char **start, off_t off, \
224 int count, int *eof, void *data) \
226 struct ldlm_pool *pl = data; \
229 spin_lock(&pl->pl_lock); \
230 tmp = pl->pl_##var; \
231 spin_unlock(&pl->pl_lock); \
233 return lprocfs_rd_uint(page, start, off, count, eof, &tmp); \
235 struct __##var##__dummy_read {;} /* semicolon catcher */
237 #define LDLM_POOL_PROC_WRITER(var, type) \
238 int lprocfs_wr_##var(struct file *file, const char *buffer, \
239 unsigned long count, void *data) \
241 struct ldlm_pool *pl = data; \
245 rc = lprocfs_wr_uint(file, buffer, count, &tmp); \
247 CERROR("Can't parse user input, rc = %d\n", rc); \
251 spin_lock(&pl->pl_lock); \
252 pl->pl_##var = tmp; \
253 spin_unlock(&pl->pl_lock); \
257 struct __##var##__dummy_write {;} /* semicolon catcher */
259 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
263 lock_res_and_lock(lock);
264 if (((lock->l_req_mode == lock->l_granted_mode) &&
265 !(lock->l_flags & LDLM_FL_CP_REQD)) ||
266 (lock->l_flags & (LDLM_FL_FAILED | LDLM_FL_CANCEL)))
268 unlock_res_and_lock(lock);
273 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
274 ldlm_policy_data_t *);
276 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
277 ldlm_wire_policy_data_t *);
279 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
280 ldlm_policy_data_t *lpolicy);
281 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
282 ldlm_wire_policy_data_t *wpolicy);
283 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
284 ldlm_policy_data_t *lpolicy);
285 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
286 ldlm_wire_policy_data_t *wpolicy);
287 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
288 ldlm_policy_data_t *lpolicy);
289 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
290 ldlm_wire_policy_data_t *wpolicy);
291 void ldlm_flock_policy_wire18_to_local(const ldlm_wire_policy_data_t *wpolicy,
292 ldlm_policy_data_t *lpolicy);
293 void ldlm_flock_policy_wire21_to_local(const ldlm_wire_policy_data_t *wpolicy,
294 ldlm_policy_data_t *lpolicy);
296 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
297 ldlm_wire_policy_data_t *wpolicy);