1 /*
2  * GPL HEADER START
3  *
4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5  *
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.
9  *
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).
15  *
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
19  *
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
22  * have any questions.
23  *
24  * GPL HEADER END
25  */
26 /*
27  * Copyright (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  */
36 
37 #define MAX_STRING_SIZE 128
38 
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 
ldlm_namespace_nr_read(ldlm_side_t client)47 static inline int ldlm_namespace_nr_read(ldlm_side_t client)
48 {
49 	return client == LDLM_NAMESPACE_SERVER ?
50 		ldlm_srv_namespace_nr : ldlm_cli_namespace_nr;
51 }
52 
ldlm_namespace_nr_inc(ldlm_side_t client)53 static inline void ldlm_namespace_nr_inc(ldlm_side_t client)
54 {
55 	if (client == LDLM_NAMESPACE_SERVER)
56 		ldlm_srv_namespace_nr++;
57 	else
58 		ldlm_cli_namespace_nr++;
59 }
60 
ldlm_namespace_nr_dec(ldlm_side_t client)61 static inline void ldlm_namespace_nr_dec(ldlm_side_t client)
62 {
63 	if (client == LDLM_NAMESPACE_SERVER)
64 		ldlm_srv_namespace_nr--;
65 	else
66 		ldlm_cli_namespace_nr--;
67 }
68 
ldlm_namespace_list(ldlm_side_t client)69 static inline struct list_head *ldlm_namespace_list(ldlm_side_t client)
70 {
71 	return client == LDLM_NAMESPACE_SERVER ?
72 		&ldlm_srv_namespace_list : &ldlm_cli_active_namespace_list;
73 }
74 
ldlm_namespace_inactive_list(ldlm_side_t client)75 static inline struct list_head *ldlm_namespace_inactive_list(ldlm_side_t client)
76 {
77 	return client == LDLM_NAMESPACE_SERVER ?
78 		&ldlm_srv_namespace_list : &ldlm_cli_inactive_namespace_list;
79 }
80 
ldlm_namespace_lock(ldlm_side_t client)81 static inline struct mutex *ldlm_namespace_lock(ldlm_side_t client)
82 {
83 	return client == LDLM_NAMESPACE_SERVER ?
84 		&ldlm_srv_namespace_lock : &ldlm_cli_namespace_lock;
85 }
86 
87 /* ns_bref is the number of resources in this namespace */
ldlm_ns_empty(struct ldlm_namespace * ns)88 static inline int ldlm_ns_empty(struct ldlm_namespace *ns)
89 {
90 	return atomic_read(&ns->ns_bref) == 0;
91 }
92 
93 void ldlm_namespace_move_to_active_locked(struct ldlm_namespace *, ldlm_side_t);
94 void ldlm_namespace_move_to_inactive_locked(struct ldlm_namespace *,
95 					    ldlm_side_t);
96 struct ldlm_namespace *ldlm_namespace_first_locked(ldlm_side_t);
97 
98 /* ldlm_request.c */
99 /* Cancel lru flag, it indicates we cancel aged locks. */
100 enum {
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 };
108 
109 int ldlm_cancel_lru(struct ldlm_namespace *ns, int nr,
110 		    ldlm_cancel_flags_t sync, int flags);
111 int ldlm_cancel_lru_local(struct ldlm_namespace *ns,
112 			  struct list_head *cancels, int count, int max,
113 			  ldlm_cancel_flags_t cancel_flags, int flags);
114 extern int ldlm_enqueue_min;
115 int ldlm_get_enq_timeout(struct ldlm_lock *lock);
116 
117 /* ldlm_resource.c */
118 int ldlm_resource_putref_locked(struct ldlm_resource *res);
119 void ldlm_resource_insert_lock_after(struct ldlm_lock *original,
120 				     struct ldlm_lock *new);
121 void ldlm_namespace_free_prior(struct ldlm_namespace *ns,
122 			       struct obd_import *imp, int force);
123 void ldlm_namespace_free_post(struct ldlm_namespace *ns);
124 /* ldlm_lock.c */
125 
126 struct ldlm_cb_set_arg {
127 	struct ptlrpc_request_set	*set;
128 	int				 type; /* LDLM_{CP,BL,GL}_CALLBACK */
129 	atomic_t			 restart;
130 	struct list_head			*list;
131 	union ldlm_gl_desc		*gl_desc; /* glimpse AST descriptor */
132 };
133 
134 enum ldlm_desc_ast_t {
135 	LDLM_WORK_BL_AST,
136 	LDLM_WORK_CP_AST,
137 	LDLM_WORK_REVOKE_AST,
138 	LDLM_WORK_GL_AST
139 };
140 
141 void ldlm_grant_lock(struct ldlm_lock *lock, struct list_head *work_list);
142 int ldlm_fill_lvb(struct ldlm_lock *lock, struct req_capsule *pill,
143 		  enum req_location loc, void *data, int size);
144 struct ldlm_lock *
145 ldlm_lock_create(struct ldlm_namespace *ns, const struct ldlm_res_id *,
146 		 ldlm_type_t type, ldlm_mode_t,
147 		 const struct ldlm_callback_suite *cbs,
148 		 void *data, __u32 lvb_len, enum lvb_type lvb_type);
149 ldlm_error_t ldlm_lock_enqueue(struct ldlm_namespace *, struct ldlm_lock **,
150 			       void *cookie, __u64 *flags);
151 void ldlm_lock_addref_internal(struct ldlm_lock *, __u32 mode);
152 void ldlm_lock_addref_internal_nolock(struct ldlm_lock *, __u32 mode);
153 void ldlm_lock_decref_internal(struct ldlm_lock *, __u32 mode);
154 void ldlm_lock_decref_internal_nolock(struct ldlm_lock *, __u32 mode);
155 void ldlm_add_ast_work_item(struct ldlm_lock *lock, struct ldlm_lock *new,
156 			    struct list_head *work_list);
157 int ldlm_run_ast_work(struct ldlm_namespace *ns, struct list_head *rpc_list,
158 		      enum ldlm_desc_ast_t ast_type);
159 int ldlm_work_gl_ast_lock(struct ptlrpc_request_set *rqset, void *opaq);
160 int ldlm_lock_remove_from_lru(struct ldlm_lock *lock);
161 int ldlm_lock_remove_from_lru_nolock(struct ldlm_lock *lock);
162 void ldlm_lock_add_to_lru_nolock(struct ldlm_lock *lock);
163 void ldlm_lock_add_to_lru(struct ldlm_lock *lock);
164 void ldlm_lock_touch_in_lru(struct ldlm_lock *lock);
165 void ldlm_lock_destroy_nolock(struct ldlm_lock *lock);
166 
167 void ldlm_cancel_locks_for_export(struct obd_export *export);
168 
169 /* ldlm_lockd.c */
170 int ldlm_bl_to_thread_lock(struct ldlm_namespace *ns, struct ldlm_lock_desc *ld,
171 			   struct ldlm_lock *lock);
172 int ldlm_bl_to_thread_list(struct ldlm_namespace *ns,
173 			   struct ldlm_lock_desc *ld,
174 			   struct list_head *cancels, int count,
175 			   ldlm_cancel_flags_t cancel_flags);
176 
177 void ldlm_handle_bl_callback(struct ldlm_namespace *ns,
178 			     struct ldlm_lock_desc *ld, struct ldlm_lock *lock);
179 
180 extern struct kmem_cache *ldlm_resource_slab;
181 
182 /* ldlm_lockd.c & ldlm_lock.c */
183 extern struct kmem_cache *ldlm_lock_slab;
184 
185 /* ldlm_extent.c */
186 void ldlm_extent_add_lock(struct ldlm_resource *res, struct ldlm_lock *lock);
187 void ldlm_extent_unlink_lock(struct ldlm_lock *lock);
188 
189 /* ldlm_flock.c */
190 int ldlm_process_flock_lock(struct ldlm_lock *req, __u64 *flags,
191 			    int first_enq, ldlm_error_t *err,
192 			    struct list_head *work_list);
193 int ldlm_init_flock_export(struct obd_export *exp);
194 void ldlm_destroy_flock_export(struct obd_export *exp);
195 
196 /* l_lock.c */
197 void l_check_ns_lock(struct ldlm_namespace *ns);
198 void l_check_no_ns_lock(struct ldlm_namespace *ns);
199 
200 extern struct proc_dir_entry *ldlm_svc_proc_dir;
201 extern struct proc_dir_entry *ldlm_type_proc_dir;
202 
203 struct ldlm_state {
204 	struct ptlrpc_service *ldlm_cb_service;
205 	struct ptlrpc_service *ldlm_cancel_service;
206 	struct ptlrpc_client *ldlm_client;
207 	struct ptlrpc_connection *ldlm_server_conn;
208 	struct ldlm_bl_pool *ldlm_bl_pool;
209 };
210 
211 /* interval tree, for LDLM_EXTENT. */
212 extern struct kmem_cache *ldlm_interval_slab; /* slab cache for ldlm_interval */
213 extern void ldlm_interval_attach(struct ldlm_interval *n, struct ldlm_lock *l);
214 struct ldlm_interval *ldlm_interval_detach(struct ldlm_lock *l);
215 struct ldlm_interval *ldlm_interval_alloc(struct ldlm_lock *lock);
216 void ldlm_interval_free(struct ldlm_interval *node);
217 /* this function must be called with res lock held */
218 static inline struct ldlm_extent *
ldlm_interval_extent(struct ldlm_interval * node)219 ldlm_interval_extent(struct ldlm_interval *node)
220 {
221 	struct ldlm_lock *lock;
222 
223 	LASSERT(!list_empty(&node->li_group));
224 
225 	lock = list_entry(node->li_group.next, struct ldlm_lock,
226 			      l_sl_policy);
227 	return &lock->l_policy_data.l_extent;
228 }
229 
230 int ldlm_init(void);
231 void ldlm_exit(void);
232 
233 enum ldlm_policy_res {
234 	LDLM_POLICY_CANCEL_LOCK,
235 	LDLM_POLICY_KEEP_LOCK,
236 	LDLM_POLICY_SKIP_LOCK
237 };
238 
239 typedef enum ldlm_policy_res ldlm_policy_res_t;
240 
241 #define LDLM_POOL_PROC_READER_SEQ_SHOW(var, type)			    \
242 	static int lprocfs_##var##_seq_show(struct seq_file *m, void *v) \
243 	{								    \
244 		struct ldlm_pool *pl = m->private;			    \
245 		type tmp;						    \
246 									    \
247 		spin_lock(&pl->pl_lock);				    \
248 		tmp = pl->pl_##var;					    \
249 		spin_unlock(&pl->pl_lock);				    \
250 									    \
251 		return lprocfs_rd_uint(m, &tmp);			    \
252 	}								    \
253 	struct __##var##__dummy_read {; } /* semicolon catcher */
254 
255 #define LDLM_POOL_PROC_WRITER(var, type)				    \
256 	static int lprocfs_wr_##var(struct file *file,			    \
257 				const char __user *buffer,		    \
258 				unsigned long count, void *data)	    \
259 	{								    \
260 		struct ldlm_pool *pl = data;				    \
261 		type tmp;						    \
262 		int rc;							    \
263 									    \
264 		rc = lprocfs_wr_uint(file, buffer, count, &tmp);	    \
265 		if (rc < 0) {						    \
266 			CERROR("Can't parse user input, rc = %d\n", rc);    \
267 			return rc;					    \
268 		}							    \
269 									    \
270 		spin_lock(&pl->pl_lock);				    \
271 		pl->pl_##var = tmp;					    \
272 		spin_unlock(&pl->pl_lock);				    \
273 									    \
274 		return rc;						    \
275 	}								    \
276 	struct __##var##__dummy_write {; } /* semicolon catcher */
277 
is_granted_or_cancelled(struct ldlm_lock * lock)278 static inline int is_granted_or_cancelled(struct ldlm_lock *lock)
279 {
280 	int ret = 0;
281 
282 	lock_res_and_lock(lock);
283 	if (((lock->l_req_mode == lock->l_granted_mode) &&
284 	     !(lock->l_flags & LDLM_FL_CP_REQD)) ||
285 	    (lock->l_flags & (LDLM_FL_FAILED | LDLM_FL_CANCEL)))
286 		ret = 1;
287 	unlock_res_and_lock(lock);
288 
289 	return ret;
290 }
291 
292 typedef void (*ldlm_policy_wire_to_local_t)(const ldlm_wire_policy_data_t *,
293 					    ldlm_policy_data_t *);
294 
295 typedef void (*ldlm_policy_local_to_wire_t)(const ldlm_policy_data_t *,
296 					    ldlm_wire_policy_data_t *);
297 
298 void ldlm_plain_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
299 				     ldlm_policy_data_t *lpolicy);
300 void ldlm_plain_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
301 				     ldlm_wire_policy_data_t *wpolicy);
302 void ldlm_ibits_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
303 				     ldlm_policy_data_t *lpolicy);
304 void ldlm_ibits_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
305 				     ldlm_wire_policy_data_t *wpolicy);
306 void ldlm_extent_policy_wire_to_local(const ldlm_wire_policy_data_t *wpolicy,
307 				     ldlm_policy_data_t *lpolicy);
308 void ldlm_extent_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
309 				     ldlm_wire_policy_data_t *wpolicy);
310 void ldlm_flock_policy_wire18_to_local(const ldlm_wire_policy_data_t *wpolicy,
311 				     ldlm_policy_data_t *lpolicy);
312 void ldlm_flock_policy_wire21_to_local(const ldlm_wire_policy_data_t *wpolicy,
313 				     ldlm_policy_data_t *lpolicy);
314 
315 void ldlm_flock_policy_local_to_wire(const ldlm_policy_data_t *lpolicy,
316 				     ldlm_wire_policy_data_t *wpolicy);
317