1 /* -*- mode: c; c-basic-offset: 8; indent-tabs-mode: nil; -*-
2 * vim:expandtab:shiftwidth=8:tabstop=8:
6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 only,
10 * as published by the Free Software Foundation.
12 * This program is distributed in the hope that it will be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * General Public License version 2 for more details (a copy is included
16 * in the LICENSE file that accompanied this code).
18 * You should have received a copy of the GNU General Public License
19 * version 2 along with this program; If not, see
20 * http://www.sun.com/software/products/lustre/docs/GPLv2.pdf
22 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
23 * CA 95054 USA or visit www.sun.com if you need additional information or
29 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
30 * Use is subject to license terms.
32 * Copyright (c) 2011, Whamcloud, Inc.
35 * This file is part of Lustre, http://www.lustre.org/
36 * Lustre is a trademark of Sun Microsystems, Inc.
38 * Implementation of cl_lock for LOVSUB layer.
40 * Author: Nikita Danilov <nikita.danilov@sun.com>
43 #define DEBUG_SUBSYSTEM S_LOV
45 #include "lov_cl_internal.h"
51 /*****************************************************************************
53 * Lovsub lock operations.
57 static void lovsub_lock_fini(const struct lu_env *env,
58 struct cl_lock_slice *slice)
60 struct lovsub_lock *lsl;
63 lsl = cl2lovsub_lock(slice);
64 LASSERT(cfs_list_empty(&lsl->lss_parents));
65 OBD_SLAB_FREE_PTR(lsl, lovsub_lock_kmem);
69 static void lovsub_parent_lock(const struct lu_env *env, struct lov_lock *lov)
71 struct cl_lock *parent;
74 parent = lov->lls_cl.cls_lock;
76 lu_ref_add(&parent->cll_reference, "lovsub-parent", cfs_current());
77 cl_lock_mutex_get(env, parent);
81 static void lovsub_parent_unlock(const struct lu_env *env, struct lov_lock *lov)
83 struct cl_lock *parent;
86 parent = lov->lls_cl.cls_lock;
87 cl_lock_mutex_put(env, lov->lls_cl.cls_lock);
88 lu_ref_del(&parent->cll_reference, "lovsub-parent", cfs_current());
89 cl_lock_put(env, parent);
94 * Implements cl_lock_operations::clo_state() method for lovsub layer, which
95 * method is called whenever sub-lock state changes. Propagates state change
98 static void lovsub_lock_state(const struct lu_env *env,
99 const struct cl_lock_slice *slice,
100 enum cl_lock_state state)
102 struct lovsub_lock *sub = cl2lovsub_lock(slice);
103 struct lov_lock_link *scan;
105 LASSERT(cl_lock_is_mutexed(slice->cls_lock));
108 cfs_list_for_each_entry(scan, &sub->lss_parents, lll_list) {
109 struct lov_lock *lov = scan->lll_super;
110 struct cl_lock *parent = lov->lls_cl.cls_lock;
112 if (sub->lss_active != parent) {
113 lovsub_parent_lock(env, lov);
114 cl_lock_signal(env, parent);
115 lovsub_parent_unlock(env, lov);
122 * Implementation of cl_lock_operation::clo_weigh() estimating lock weight by
123 * asking parent lock.
125 static unsigned long lovsub_lock_weigh(const struct lu_env *env,
126 const struct cl_lock_slice *slice)
128 struct lovsub_lock *lock = cl2lovsub_lock(slice);
129 struct lov_lock *lov;
130 unsigned long dumbbell;
134 LASSERT(cl_lock_is_mutexed(slice->cls_lock));
136 if (!cfs_list_empty(&lock->lss_parents)) {
138 * It is not clear whether all parents have to be asked and
139 * their estimations summed, or it is enough to ask one. For
140 * the current usages, one is always enough.
142 lov = container_of(lock->lss_parents.next,
143 struct lov_lock_link, lll_list)->lll_super;
145 lovsub_parent_lock(env, lov);
146 dumbbell = cl_lock_weigh(env, lov->lls_cl.cls_lock);
147 lovsub_parent_unlock(env, lov);
155 * Maps start/end offsets within a stripe, to offsets within a file.
157 static void lovsub_lock_descr_map(const struct cl_lock_descr *in,
158 struct lov_object *obj,
159 int stripe, struct cl_lock_descr *out)
161 struct lov_stripe_md *lsm = lov_r0(obj)->lo_lsm;
162 pgoff_t size; /* stripe size in pages */
163 pgoff_t skip; /* how many pages in every stripe are occupied by
169 start = in->cld_start;
172 if (lsm->lsm_stripe_count > 1) {
173 size = cl_index(lov2cl(obj), lsm->lsm_stripe_size);
174 skip = (lsm->lsm_stripe_count - 1) * size;
176 /* XXX overflow check here? */
177 start += start/size * skip + stripe * size;
179 if (end != CL_PAGE_EOF) {
180 end += end/size * skip + stripe * size;
182 * And check for overflow...
184 if (end < in->cld_end)
188 out->cld_start = start;
194 * Adjusts parent lock extent when a sub-lock is attached to a parent. This is
195 * called in two ways:
197 * - as part of receive call-back, when server returns granted extent to
200 * - when top-lock finds existing sub-lock in the cache.
202 * Note, that lock mode is not propagated to the parent: i.e., if CLM_READ
203 * top-lock matches CLM_WRITE sub-lock, top-lock is still CLM_READ.
205 int lov_sublock_modify(const struct lu_env *env, struct lov_lock *lov,
206 struct lovsub_lock *sublock,
207 const struct cl_lock_descr *d, int idx)
209 struct cl_lock *parent;
210 struct lovsub_object *subobj;
211 struct cl_lock_descr *pd;
212 struct cl_lock_descr *parent_descr;
215 parent = lov->lls_cl.cls_lock;
216 parent_descr = &parent->cll_descr;
217 LASSERT(cl_lock_mode_match(d->cld_mode, parent_descr->cld_mode));
219 subobj = cl2lovsub(sublock->lss_cl.cls_obj);
220 pd = &lov_env_info(env)->lti_ldescr;
222 pd->cld_obj = parent_descr->cld_obj;
223 pd->cld_mode = parent_descr->cld_mode;
224 pd->cld_gid = parent_descr->cld_gid;
225 lovsub_lock_descr_map(d, subobj->lso_super, subobj->lso_index, pd);
226 lov->lls_sub[idx].sub_got = *d;
228 * Notify top-lock about modification, if lock description changes
231 if (!cl_lock_ext_match(parent_descr, pd))
232 result = cl_lock_modify(env, parent, pd);
238 static int lovsub_lock_modify(const struct lu_env *env,
239 const struct cl_lock_slice *s,
240 const struct cl_lock_descr *d)
242 struct lovsub_lock *lock = cl2lovsub_lock(s);
243 struct lov_lock_link *scan;
244 struct lov_lock *lov;
249 LASSERT(cl_lock_mode_match(d->cld_mode,
250 s->cls_lock->cll_descr.cld_mode));
251 cfs_list_for_each_entry(scan, &lock->lss_parents, lll_list) {
254 lov = scan->lll_super;
255 lovsub_parent_lock(env, lov);
256 rc = lov_sublock_modify(env, lov, lock, d, scan->lll_idx);
257 lovsub_parent_unlock(env, lov);
258 result = result ?: rc;
263 static int lovsub_lock_closure(const struct lu_env *env,
264 const struct cl_lock_slice *slice,
265 struct cl_lock_closure *closure)
267 struct lovsub_lock *sub;
268 struct cl_lock *parent;
269 struct lov_lock_link *scan;
272 LASSERT(cl_lock_is_mutexed(slice->cls_lock));
275 sub = cl2lovsub_lock(slice);
278 cfs_list_for_each_entry(scan, &sub->lss_parents, lll_list) {
279 parent = scan->lll_super->lls_cl.cls_lock;
280 result = cl_lock_closure_build(env, parent, closure);
288 * A helper function for lovsub_lock_delete() that deals with a given parent
291 static int lovsub_lock_delete_one(const struct lu_env *env,
292 struct cl_lock *child, struct lov_lock *lov)
294 struct cl_lock *parent;
298 parent = lov->lls_cl.cls_lock;
299 if (parent->cll_error)
303 switch (parent->cll_state) {
306 cl_lock_signal(env, parent);
310 * Here lies a problem: a sub-lock is canceled while top-lock
311 * is being unlocked. Top-lock cannot be moved into CLS_NEW
312 * state, because unlocking has to succeed eventually by
313 * placing lock into CLS_CACHED (or failing it), see
314 * cl_unuse_try(). Nor can top-lock be left in CLS_CACHED
315 * state, because lov maintains an invariant that all
316 * sub-locks exist in CLS_CACHED (this allows cached top-lock
317 * to be reused immediately). Nor can we wait for top-lock
318 * state to change, because this can be synchronous to the
321 * We know for sure that lov_lock_unuse() will be called at
322 * least one more time to finish un-using, so leave a mark on
323 * the top-lock, that will be seen by the next call to
326 if (cl_lock_is_intransit(parent))
327 lov->lls_cancel_race = 1;
331 * if a sub-lock is canceled move its top-lock into CLS_NEW
332 * state to preserve an invariant that a top-lock in
333 * CLS_CACHED is immediately ready for re-use (i.e., has all
334 * sub-locks), and so that next attempt to re-use the top-lock
335 * enqueues missing sub-lock.
337 cl_lock_state_set(env, parent, CLS_NEW);
341 * if last sub-lock is canceled, destroy the top-lock (which
342 * is now `empty') proactively.
344 if (lov->lls_nr_filled == 0) {
345 /* ... but unfortunately, this cannot be done easily,
346 * as cancellation of a top-lock might acquire mutices
347 * of its other sub-locks, violating lock ordering,
348 * see cl_lock_{cancel,delete}() preconditions.
350 * To work around this, the mutex of this sub-lock is
351 * released, top-lock is destroyed, and sub-lock mutex
352 * acquired again. The list of parents has to be
353 * re-scanned from the beginning after this.
355 * Only do this if no mutices other than on @child and
356 * @parent are held by the current thread.
358 * TODO: The lock modal here is too complex, because
359 * the lock may be canceled and deleted by voluntarily:
361 * -> osc_lock_enqueue_wait
362 * -> osc_lock_cancel_wait
364 * -> lovsub_lock_delete
365 * -> cl_lock_cancel/delete
368 * The better choice is to spawn a kernel thread for
371 if (cl_lock_nr_mutexed(env) == 2) {
372 cl_lock_mutex_put(env, child);
373 cl_lock_cancel(env, parent);
374 cl_lock_delete(env, parent);
381 CL_LOCK_DEBUG(D_ERROR, env, parent, "Delete CLS_HELD lock\n");
383 CERROR("Impossible state: %d\n", parent->cll_state);
392 * An implementation of cl_lock_operations::clo_delete() method. This is
393 * invoked in "bottom-to-top" delete, when lock destruction starts from the
394 * sub-lock (e.g, as a result of ldlm lock LRU policy).
396 static void lovsub_lock_delete(const struct lu_env *env,
397 const struct cl_lock_slice *slice)
399 struct cl_lock *child = slice->cls_lock;
400 struct lovsub_lock *sub = cl2lovsub_lock(slice);
403 LASSERT(cl_lock_is_mutexed(child));
407 * Destruction of a sub-lock might take multiple iterations, because
408 * when the last sub-lock of a given top-lock is deleted, top-lock is
409 * canceled proactively, and this requires to release sub-lock
410 * mutex. Once sub-lock mutex has been released, list of its parents
411 * has to be re-scanned from the beginning.
414 struct lov_lock *lov;
415 struct lov_lock_link *scan;
416 struct lov_lock_link *temp;
417 struct lov_lock_sub *subdata;
420 cfs_list_for_each_entry_safe(scan, temp,
421 &sub->lss_parents, lll_list) {
422 lov = scan->lll_super;
423 subdata = &lov->lls_sub[scan->lll_idx];
424 lovsub_parent_lock(env, lov);
425 subdata->sub_got = subdata->sub_descr;
426 lov_lock_unlink(env, scan, sub);
427 restart = lovsub_lock_delete_one(env, child, lov);
428 lovsub_parent_unlock(env, lov);
431 cl_lock_mutex_get(env, child);
439 static int lovsub_lock_print(const struct lu_env *env, void *cookie,
440 lu_printer_t p, const struct cl_lock_slice *slice)
442 struct lovsub_lock *sub = cl2lovsub_lock(slice);
443 struct lov_lock *lov;
444 struct lov_lock_link *scan;
446 cfs_list_for_each_entry(scan, &sub->lss_parents, lll_list) {
447 lov = scan->lll_super;
448 (*p)(env, cookie, "[%d %p ", scan->lll_idx, lov);
450 cl_lock_descr_print(env, cookie, p,
451 &lov->lls_cl.cls_lock->cll_descr);
452 (*p)(env, cookie, "] ");
457 static const struct cl_lock_operations lovsub_lock_ops = {
458 .clo_fini = lovsub_lock_fini,
459 .clo_state = lovsub_lock_state,
460 .clo_delete = lovsub_lock_delete,
461 .clo_modify = lovsub_lock_modify,
462 .clo_closure = lovsub_lock_closure,
463 .clo_weigh = lovsub_lock_weigh,
464 .clo_print = lovsub_lock_print
467 int lovsub_lock_init(const struct lu_env *env, struct cl_object *obj,
468 struct cl_lock *lock, const struct cl_io *io)
470 struct lovsub_lock *lsk;
474 OBD_SLAB_ALLOC_PTR_GFP(lsk, lovsub_lock_kmem, CFS_ALLOC_IO);
476 CFS_INIT_LIST_HEAD(&lsk->lss_parents);
477 cl_lock_slice_add(lock, &lsk->lss_cl, obj, &lovsub_lock_ops);