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 2008 Sun Microsystems, Inc. All rights reserved.
30 * Use is subject to license terms.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
36 * Implementation of cl_lock for LOV layer.
38 * Author: Nikita Danilov <nikita.danilov@sun.com>
41 #define DEBUG_SUBSYSTEM S_LOV
43 #include "lov_cl_internal.h"
49 static struct cl_lock_closure *lov_closure_get(const struct lu_env *env,
50 struct cl_lock *parent);
52 static int lov_lock_unuse(const struct lu_env *env,
53 const struct cl_lock_slice *slice);
54 /*****************************************************************************
56 * Lov lock operations.
60 static struct lov_sublock_env *lov_sublock_env_get(const struct lu_env *env,
61 struct cl_lock *parent,
62 struct lov_lock_sub *lls)
64 struct lov_sublock_env *subenv;
65 struct lov_io *lio = lov_env_io(env);
66 struct cl_io *io = lio->lis_cl.cis_io;
67 struct lov_io_sub *sub;
69 subenv = &lov_env_session(env)->ls_subenv;
72 * FIXME: We tend to use the subio's env & io to call the sublock
73 * lock operations because osc lock sometimes stores some control
74 * variables in thread's IO infomation(Now only lockless information).
75 * However, if the lock's host(object) is different from the object
76 * for current IO, we have no way to get the subenv and subio because
77 * they are not initialized at all. As a temp fix, in this case,
78 * we still borrow the parent's env to call sublock operations.
80 if (!io || !cl_object_same(io->ci_obj, parent->cll_descr.cld_obj)) {
81 subenv->lse_env = env;
83 subenv->lse_sub = NULL;
85 sub = lov_sub_get(env, lio, lls->sub_stripe);
87 subenv->lse_env = sub->sub_env;
88 subenv->lse_io = sub->sub_io;
89 subenv->lse_sub = sub;
97 static void lov_sublock_env_put(struct lov_sublock_env *subenv)
99 if (subenv && subenv->lse_sub)
100 lov_sub_put(subenv->lse_sub);
103 static void lov_sublock_adopt(const struct lu_env *env, struct lov_lock *lck,
104 struct cl_lock *sublock, int idx,
105 struct lov_lock_link *link)
107 struct lovsub_lock *lsl;
108 struct cl_lock *parent = lck->lls_cl.cls_lock;
111 LASSERT(cl_lock_is_mutexed(parent));
112 LASSERT(cl_lock_is_mutexed(sublock));
115 lsl = cl2sub_lock(sublock);
117 * check that sub-lock doesn't have lock link to this top-lock.
119 LASSERT(lov_lock_link_find(env, lck, lsl) == NULL);
120 LASSERT(idx < lck->lls_nr);
122 lck->lls_sub[idx].sub_lock = lsl;
123 lck->lls_nr_filled++;
124 LASSERT(lck->lls_nr_filled <= lck->lls_nr);
125 list_add_tail(&link->lll_list, &lsl->lss_parents);
127 link->lll_super = lck;
129 lu_ref_add(&parent->cll_reference, "lov-child", sublock);
130 lck->lls_sub[idx].sub_flags |= LSF_HELD;
131 cl_lock_user_add(env, sublock);
133 rc = lov_sublock_modify(env, lck, lsl, &sublock->cll_descr, idx);
134 LASSERT(rc == 0); /* there is no way this can fail, currently */
138 static struct cl_lock *lov_sublock_alloc(const struct lu_env *env,
139 const struct cl_io *io,
140 struct lov_lock *lck,
141 int idx, struct lov_lock_link **out)
143 struct cl_lock *sublock;
144 struct cl_lock *parent;
145 struct lov_lock_link *link;
147 LASSERT(idx < lck->lls_nr);
150 OBD_SLAB_ALLOC_PTR_GFP(link, lov_lock_link_kmem, CFS_ALLOC_IO);
152 struct lov_sublock_env *subenv;
153 struct lov_lock_sub *lls;
154 struct cl_lock_descr *descr;
156 parent = lck->lls_cl.cls_lock;
157 lls = &lck->lls_sub[idx];
158 descr = &lls->sub_descr;
160 subenv = lov_sublock_env_get(env, parent, lls);
161 if (!IS_ERR(subenv)) {
162 /* CAVEAT: Don't try to add a field in lov_lock_sub
163 * to remember the subio. This is because lock is able
164 * to be cached, but this is not true for IO. This
165 * further means a sublock might be referenced in
166 * different io context. -jay */
168 sublock = cl_lock_hold(subenv->lse_env, subenv->lse_io,
169 descr, "lov-parent", parent);
170 lov_sublock_env_put(subenv);
173 sublock = (void*)subenv;
176 if (!IS_ERR(sublock))
179 OBD_SLAB_FREE_PTR(link, lov_lock_link_kmem);
181 sublock = ERR_PTR(-ENOMEM);
185 static void lov_sublock_unlock(const struct lu_env *env,
186 struct lovsub_lock *lsl,
187 struct cl_lock_closure *closure,
188 struct lov_sublock_env *subenv)
191 lov_sublock_env_put(subenv);
192 lsl->lss_active = NULL;
193 cl_lock_disclosure(env, closure);
197 static int lov_sublock_lock(const struct lu_env *env,
198 struct lov_lock *lck,
199 struct lov_lock_sub *lls,
200 struct cl_lock_closure *closure,
201 struct lov_sublock_env **lsep)
203 struct lovsub_lock *sublock;
204 struct cl_lock *child;
208 LASSERT(list_empty(&closure->clc_list));
210 sublock = lls->sub_lock;
211 child = sublock->lss_cl.cls_lock;
212 result = cl_lock_closure_build(env, child, closure);
214 struct cl_lock *parent = closure->clc_origin;
216 LASSERT(cl_lock_is_mutexed(child));
217 sublock->lss_active = parent;
219 if (unlikely((child->cll_state == CLS_FREEING) ||
220 (child->cll_flags & CLF_CANCELLED))) {
221 struct lov_lock_link *link;
223 * we could race with lock deletion which temporarily
224 * put the lock in freeing state, bug 19080.
226 LASSERT(!(lls->sub_flags & LSF_HELD));
228 link = lov_lock_link_find(env, lck, sublock);
229 LASSERT(link != NULL);
230 lov_lock_unlink(env, link, sublock);
231 lov_sublock_unlock(env, sublock, closure, NULL);
232 lck->lls_cancel_race = 1;
235 struct lov_sublock_env *subenv;
236 subenv = lov_sublock_env_get(env, parent, lls);
237 if (IS_ERR(subenv)) {
238 lov_sublock_unlock(env, sublock,
240 result = PTR_ERR(subenv);
250 * Updates the result of a top-lock operation from a result of sub-lock
251 * sub-operations. Top-operations like lov_lock_{enqueue,use,unuse}() iterate
252 * over sub-locks and lov_subresult() is used to calculate return value of a
253 * top-operation. To this end, possible return values of sub-operations are
257 * - CLO_WAIT wait for event
258 * - CLO_REPEAT repeat top-operation
259 * - -ne fundamental error
261 * Top-level return code can only go down through this list. CLO_REPEAT
262 * overwrites CLO_WAIT, because lock mutex was released and sleeping condition
263 * has to be rechecked by the upper layer.
265 static int lov_subresult(int result, int rc)
270 LASSERT(result <= 0 || result == CLO_REPEAT || result == CLO_WAIT);
271 LASSERT(rc <= 0 || rc == CLO_REPEAT || rc == CLO_WAIT);
272 CLASSERT(CLO_WAIT < CLO_REPEAT);
276 /* calculate ranks in the ordering above */
277 result_rank = result < 0 ? 1 + CLO_REPEAT : result;
278 rc_rank = rc < 0 ? 1 + CLO_REPEAT : rc;
280 if (result_rank < rc_rank)
286 * Creates sub-locks for a given lov_lock for the first time.
288 * Goes through all sub-objects of top-object, and creates sub-locks on every
289 * sub-object intersecting with top-lock extent. This is complicated by the
290 * fact that top-lock (that is being created) can be accessed concurrently
291 * through already created sub-locks (possibly shared with other top-locks).
293 static int lov_lock_sub_init(const struct lu_env *env,
294 struct lov_lock *lck, const struct cl_io *io)
304 struct lov_object *loo = cl2lov(lck->lls_cl.cls_obj);
305 struct lov_layout_raid0 *r0 = lov_r0(loo);
306 struct cl_lock *parent = lck->lls_cl.cls_lock;
310 lck->lls_orig = parent->cll_descr;
311 file_start = cl_offset(lov2cl(loo), parent->cll_descr.cld_start);
312 file_end = cl_offset(lov2cl(loo), parent->cll_descr.cld_end + 1) - 1;
314 for (i = 0, nr = 0; i < r0->lo_nr; i++) {
316 * XXX for wide striping smarter algorithm is desirable,
317 * breaking out of the loop, early.
319 if (lov_stripe_intersects(r0->lo_lsm, i,
320 file_start, file_end, &start, &end))
324 OBD_ALLOC(lck->lls_sub, nr * sizeof lck->lls_sub[0]);
325 if (lck->lls_sub == NULL)
330 * First, fill in sub-lock descriptions in
331 * lck->lls_sub[].sub_descr. They are used by lov_sublock_alloc()
332 * (called below in this function, and by lov_lock_enqueue()) to
333 * create sub-locks. At this moment, no other thread can access
336 for (i = 0, nr = 0; i < r0->lo_nr; ++i) {
337 if (lov_stripe_intersects(r0->lo_lsm, i,
338 file_start, file_end, &start, &end)) {
339 struct cl_lock_descr *descr;
341 descr = &lck->lls_sub[nr].sub_descr;
343 LASSERT(descr->cld_obj == NULL);
344 descr->cld_obj = lovsub2cl(r0->lo_sub[i]);
345 descr->cld_start = cl_index(descr->cld_obj, start);
346 descr->cld_end = cl_index(descr->cld_obj, end);
347 descr->cld_mode = parent->cll_descr.cld_mode;
348 descr->cld_gid = parent->cll_descr.cld_gid;
349 descr->cld_enq_flags = parent->cll_descr.cld_enq_flags;
350 /* XXX has no effect */
351 lck->lls_sub[nr].sub_got = *descr;
352 lck->lls_sub[nr].sub_stripe = i;
356 LASSERT(nr == lck->lls_nr);
358 * Then, create sub-locks. Once at least one sub-lock was created,
359 * top-lock can be reached by other threads.
361 for (i = 0; i < lck->lls_nr; ++i) {
362 struct cl_lock *sublock;
363 struct lov_lock_link *link;
365 if (lck->lls_sub[i].sub_lock == NULL) {
366 sublock = lov_sublock_alloc(env, io, lck, i, &link);
367 if (IS_ERR(sublock)) {
368 result = PTR_ERR(sublock);
371 cl_lock_get_trust(sublock);
372 cl_lock_mutex_get(env, sublock);
373 cl_lock_mutex_get(env, parent);
375 * recheck under mutex that sub-lock wasn't created
376 * concurrently, and that top-lock is still alive.
378 if (lck->lls_sub[i].sub_lock == NULL &&
379 parent->cll_state < CLS_FREEING) {
380 lov_sublock_adopt(env, lck, sublock, i, link);
381 cl_lock_mutex_put(env, parent);
383 OBD_SLAB_FREE_PTR(link, lov_lock_link_kmem);
384 cl_lock_mutex_put(env, parent);
385 cl_lock_unhold(env, sublock,
386 "lov-parent", parent);
388 cl_lock_mutex_put(env, sublock);
389 cl_lock_put(env, sublock);
393 * Some sub-locks can be missing at this point. This is not a problem,
394 * because enqueue will create them anyway. Main duty of this function
395 * is to fill in sub-lock descriptions in a race free manner.
400 static int lov_sublock_release(const struct lu_env *env, struct lov_lock *lck,
401 int i, int deluser, int rc)
403 struct cl_lock *parent = lck->lls_cl.cls_lock;
405 LASSERT(cl_lock_is_mutexed(parent));
408 if (lck->lls_sub[i].sub_flags & LSF_HELD) {
409 struct cl_lock *sublock;
412 LASSERT(lck->lls_sub[i].sub_lock != NULL);
413 sublock = lck->lls_sub[i].sub_lock->lss_cl.cls_lock;
414 LASSERT(cl_lock_is_mutexed(sublock));
416 lck->lls_sub[i].sub_flags &= ~LSF_HELD;
418 cl_lock_user_del(env, sublock);
420 * If the last hold is released, and cancellation is pending
421 * for a sub-lock, release parent mutex, to avoid keeping it
422 * while sub-lock is being paged out.
424 dying = (sublock->cll_descr.cld_mode == CLM_PHANTOM ||
425 sublock->cll_descr.cld_mode == CLM_GROUP ||
426 (sublock->cll_flags & (CLF_CANCELPEND|CLF_DOOMED))) &&
427 sublock->cll_holds == 1;
429 cl_lock_mutex_put(env, parent);
430 cl_lock_unhold(env, sublock, "lov-parent", parent);
432 cl_lock_mutex_get(env, parent);
433 rc = lov_subresult(rc, CLO_REPEAT);
436 * From now on lck->lls_sub[i].sub_lock is a "weak" pointer,
437 * not backed by a reference on a
438 * sub-lock. lovsub_lock_delete() will clear
439 * lck->lls_sub[i].sub_lock under semaphores, just before
440 * sub-lock is destroyed.
446 static void lov_sublock_hold(const struct lu_env *env, struct lov_lock *lck,
449 struct cl_lock *parent = lck->lls_cl.cls_lock;
451 LASSERT(cl_lock_is_mutexed(parent));
454 if (!(lck->lls_sub[i].sub_flags & LSF_HELD)) {
455 struct cl_lock *sublock;
457 LASSERT(lck->lls_sub[i].sub_lock != NULL);
458 sublock = lck->lls_sub[i].sub_lock->lss_cl.cls_lock;
459 LASSERT(cl_lock_is_mutexed(sublock));
460 LASSERT(sublock->cll_state != CLS_FREEING);
462 lck->lls_sub[i].sub_flags |= LSF_HELD;
464 cl_lock_get_trust(sublock);
465 cl_lock_hold_add(env, sublock, "lov-parent", parent);
466 cl_lock_user_add(env, sublock);
467 cl_lock_put(env, sublock);
472 static void lov_lock_fini(const struct lu_env *env,
473 struct cl_lock_slice *slice)
475 struct lov_lock *lck;
479 lck = cl2lov_lock(slice);
480 LASSERT(lck->lls_nr_filled == 0);
481 if (lck->lls_sub != NULL) {
482 for (i = 0; i < lck->lls_nr; ++i)
484 * No sub-locks exists at this point, as sub-lock has
485 * a reference on its parent.
487 LASSERT(lck->lls_sub[i].sub_lock == NULL);
488 OBD_FREE(lck->lls_sub, lck->lls_nr * sizeof lck->lls_sub[0]);
490 OBD_SLAB_FREE_PTR(lck, lov_lock_kmem);
495 * Tries to advance a state machine of a given sub-lock toward enqueuing of
498 * \retval 0 if state-transition can proceed
499 * \retval -ve otherwise.
501 static int lov_lock_enqueue_one(const struct lu_env *env, struct lov_lock *lck,
502 struct cl_lock *sublock,
503 struct cl_io *io, __u32 enqflags, int last)
508 /* first, try to enqueue a sub-lock ... */
509 result = cl_enqueue_try(env, sublock, io, enqflags);
510 if (sublock->cll_state == CLS_ENQUEUED)
511 /* if it is enqueued, try to `wait' on it---maybe it's already
513 result = cl_wait_try(env, sublock);
515 * If CEF_ASYNC flag is set, then all sub-locks can be enqueued in
516 * parallel, otherwise---enqueue has to wait until sub-lock is granted
517 * before proceeding to the next one.
519 if (result == CLO_WAIT && sublock->cll_state <= CLS_HELD &&
520 enqflags & CEF_ASYNC && !last)
526 * Helper function for lov_lock_enqueue() that creates missing sub-lock.
528 static int lov_sublock_fill(const struct lu_env *env, struct cl_lock *parent,
529 struct cl_io *io, struct lov_lock *lck, int idx)
531 struct lov_lock_link *link;
532 struct cl_lock *sublock;
535 LASSERT(parent->cll_depth == 1);
536 cl_lock_mutex_put(env, parent);
537 sublock = lov_sublock_alloc(env, io, lck, idx, &link);
538 if (!IS_ERR(sublock))
539 cl_lock_mutex_get(env, sublock);
540 cl_lock_mutex_get(env, parent);
542 if (!IS_ERR(sublock)) {
543 cl_lock_get_trust(sublock);
544 if (parent->cll_state == CLS_QUEUING &&
545 lck->lls_sub[idx].sub_lock == NULL) {
546 lov_sublock_adopt(env, lck, sublock, idx, link);
548 OBD_SLAB_FREE_PTR(link, lov_lock_link_kmem);
549 /* other thread allocated sub-lock, or enqueue is no
551 cl_lock_mutex_put(env, parent);
552 cl_lock_unhold(env, sublock, "lov-parent", parent);
553 cl_lock_mutex_get(env, parent);
555 cl_lock_mutex_put(env, sublock);
556 cl_lock_put(env, sublock);
559 result = PTR_ERR(sublock);
564 * Implementation of cl_lock_operations::clo_enqueue() for lov layer. This
565 * function is rather subtle, as it enqueues top-lock (i.e., advances top-lock
566 * state machine from CLS_QUEUING to CLS_ENQUEUED states) by juggling sub-lock
567 * state machines in the face of sub-locks sharing (by multiple top-locks),
568 * and concurrent sub-lock cancellations.
570 static int lov_lock_enqueue(const struct lu_env *env,
571 const struct cl_lock_slice *slice,
572 struct cl_io *io, __u32 enqflags)
574 struct cl_lock *lock = slice->cls_lock;
575 struct lov_lock *lck = cl2lov_lock(slice);
576 struct cl_lock_closure *closure = lov_closure_get(env, lock);
579 enum cl_lock_state minstate;
583 for (result = 0, minstate = CLS_FREEING, i = 0; i < lck->lls_nr; ++i) {
585 struct lovsub_lock *sub;
586 struct lov_lock_sub *lls;
587 struct cl_lock *sublock;
588 struct lov_sublock_env *subenv;
590 if (lock->cll_state != CLS_QUEUING) {
592 * Lock might have left QUEUING state if previous
593 * iteration released its mutex. Stop enqueing in this
594 * case and let the upper layer to decide what to do.
596 LASSERT(i > 0 && result != 0);
600 lls = &lck->lls_sub[i];
603 * Sub-lock might have been canceled, while top-lock was
607 result = lov_sublock_fill(env, lock, io, lck, i);
608 /* lov_sublock_fill() released @lock mutex,
612 sublock = sub->lss_cl.cls_lock;
613 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
615 lov_sublock_hold(env, lck, i);
616 rc = lov_lock_enqueue_one(subenv->lse_env, lck, sublock,
617 subenv->lse_io, enqflags,
618 i == lck->lls_nr - 1);
619 minstate = min(minstate, sublock->cll_state);
621 * Don't hold a sub-lock in CLS_CACHED state, see
622 * description for lov_lock::lls_sub.
624 if (sublock->cll_state > CLS_HELD)
625 rc = lov_sublock_release(env, lck, i, 1, rc);
626 lov_sublock_unlock(env, sub, closure, subenv);
628 result = lov_subresult(result, rc);
632 cl_lock_closure_fini(closure);
633 RETURN(result ?: minstate >= CLS_ENQUEUED ? 0 : CLO_WAIT);
636 static int lov_lock_unuse(const struct lu_env *env,
637 const struct cl_lock_slice *slice)
639 struct lov_lock *lck = cl2lov_lock(slice);
640 struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
646 for (result = 0, i = 0; i < lck->lls_nr; ++i) {
648 struct lovsub_lock *sub;
649 struct cl_lock *sublock;
650 struct lov_lock_sub *lls;
651 struct lov_sublock_env *subenv;
653 /* top-lock state cannot change concurrently, because single
654 * thread (one that released the last hold) carries unlocking
655 * to the completion. */
656 LASSERT(slice->cls_lock->cll_state == CLS_INTRANSIT);
657 lls = &lck->lls_sub[i];
662 sublock = sub->lss_cl.cls_lock;
663 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
665 if (lls->sub_flags & LSF_HELD) {
666 LASSERT(sublock->cll_state == CLS_HELD);
667 rc = cl_unuse_try(subenv->lse_env, sublock);
668 rc = lov_sublock_release(env, lck, i, 0, rc);
670 lov_sublock_unlock(env, sub, closure, subenv);
672 result = lov_subresult(result, rc);
675 if (result == 0 && lck->lls_cancel_race) {
676 lck->lls_cancel_race = 0;
679 cl_lock_closure_fini(closure);
684 static void lov_lock_cancel(const struct lu_env *env,
685 const struct cl_lock_slice *slice)
687 struct lov_lock *lck = cl2lov_lock(slice);
688 struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
694 for (result = 0, i = 0; i < lck->lls_nr; ++i) {
696 struct lovsub_lock *sub;
697 struct cl_lock *sublock;
698 struct lov_lock_sub *lls;
699 struct lov_sublock_env *subenv;
701 /* top-lock state cannot change concurrently, because single
702 * thread (one that released the last hold) carries unlocking
703 * to the completion. */
704 lls = &lck->lls_sub[i];
709 sublock = sub->lss_cl.cls_lock;
710 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
712 if (!(lls->sub_flags & LSF_HELD)) {
713 lov_sublock_unlock(env, sub, closure, subenv);
717 switch(sublock->cll_state) {
719 rc = cl_unuse_try(subenv->lse_env,
721 lov_sublock_release(env, lck, i, 0, 0);
724 /* TODO: it's not a good idea to cancel this
725 * lock because it's innocent. But it's
726 * acceptable. The better way would be to
727 * define a new lock method to unhold the
729 cl_lock_cancel(env, sublock);
731 lov_sublock_release(env, lck, i, 1, 0);
734 lov_sublock_unlock(env, sub, closure, subenv);
737 if (rc == CLO_REPEAT) {
742 result = lov_subresult(result, rc);
746 CL_LOCK_DEBUG(D_ERROR, env, slice->cls_lock,
747 "lov_lock_cancel fails with %d.\n", result);
749 cl_lock_closure_fini(closure);
752 static int lov_lock_wait(const struct lu_env *env,
753 const struct cl_lock_slice *slice)
755 struct lov_lock *lck = cl2lov_lock(slice);
756 struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
757 enum cl_lock_state minstate;
763 for (result = 0, minstate = CLS_FREEING, i = 0; i < lck->lls_nr; ++i) {
765 struct lovsub_lock *sub;
766 struct cl_lock *sublock;
767 struct lov_lock_sub *lls;
768 struct lov_sublock_env *subenv;
770 lls = &lck->lls_sub[i];
772 LASSERT(sub != NULL);
773 sublock = sub->lss_cl.cls_lock;
774 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
776 LASSERT(sublock->cll_state >= CLS_ENQUEUED);
777 if (sublock->cll_state < CLS_HELD)
778 rc = cl_wait_try(env, sublock);
780 minstate = min(minstate, sublock->cll_state);
781 lov_sublock_unlock(env, sub, closure, subenv);
783 result = lov_subresult(result, rc);
787 cl_lock_closure_fini(closure);
788 RETURN(result ?: minstate >= CLS_HELD ? 0 : CLO_WAIT);
791 static int lov_lock_use(const struct lu_env *env,
792 const struct cl_lock_slice *slice)
794 struct lov_lock *lck = cl2lov_lock(slice);
795 struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
799 LASSERT(slice->cls_lock->cll_state == CLS_INTRANSIT);
802 for (result = 0, i = 0; i < lck->lls_nr; ++i) {
804 struct lovsub_lock *sub;
805 struct cl_lock *sublock;
806 struct lov_lock_sub *lls;
807 struct lov_sublock_env *subenv;
809 LASSERT(slice->cls_lock->cll_state == CLS_INTRANSIT);
811 lls = &lck->lls_sub[i];
815 * Sub-lock might have been canceled, while top-lock was
822 sublock = sub->lss_cl.cls_lock;
823 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
825 LASSERT(sublock->cll_state != CLS_FREEING);
826 lov_sublock_hold(env, lck, i);
827 if (sublock->cll_state == CLS_CACHED) {
828 rc = cl_use_try(subenv->lse_env, sublock, 0);
830 rc = lov_sublock_release(env, lck,
833 lov_sublock_unlock(env, sub, closure, subenv);
835 result = lov_subresult(result, rc);
840 if (lck->lls_cancel_race) {
842 * If there is unlocking happened at the same time, then
843 * sublock_lock state should be FREEING, and lov_sublock_lock
844 * should return CLO_REPEAT. In this case, it should return
845 * ESTALE, and up layer should reset the lock state to be NEW.
847 lck->lls_cancel_race = 0;
848 LASSERT(result != 0);
851 cl_lock_closure_fini(closure);
856 static int lock_lock_multi_match()
858 struct cl_lock *lock = slice->cls_lock;
859 struct cl_lock_descr *subneed = &lov_env_info(env)->lti_ldescr;
860 struct lov_object *loo = cl2lov(lov->lls_cl.cls_obj);
861 struct lov_layout_raid0 *r0 = lov_r0(loo);
862 struct lov_lock_sub *sub;
863 struct cl_object *subobj;
870 fstart = cl_offset(need->cld_obj, need->cld_start);
871 fend = cl_offset(need->cld_obj, need->cld_end + 1) - 1;
872 subneed->cld_mode = need->cld_mode;
873 cl_lock_mutex_get(env, lock);
874 for (i = 0; i < lov->lls_nr; ++i) {
875 sub = &lov->lls_sub[i];
876 if (sub->sub_lock == NULL)
878 subobj = sub->sub_descr.cld_obj;
879 if (!lov_stripe_intersects(r0->lo_lsm, sub->sub_stripe,
880 fstart, fend, &start, &end))
882 subneed->cld_start = cl_index(subobj, start);
883 subneed->cld_end = cl_index(subobj, end);
884 subneed->cld_obj = subobj;
885 if (!cl_lock_ext_match(&sub->sub_got, subneed)) {
890 cl_lock_mutex_put(env, lock);
895 * Check if the extent region \a descr is covered by \a child against the
896 * specific \a stripe.
898 static int lov_lock_stripe_is_matching(const struct lu_env *env,
899 struct lov_object *lov, int stripe,
900 const struct cl_lock_descr *child,
901 const struct cl_lock_descr *descr)
903 struct lov_stripe_md *lsm = lov_r0(lov)->lo_lsm;
908 if (lov_r0(lov)->lo_nr == 1)
909 return cl_lock_ext_match(child, descr);
912 * For a multi-stripes object:
913 * - make sure the descr only covers child's stripe, and
914 * - check if extent is matching.
916 start = cl_offset(&lov->lo_cl, descr->cld_start);
917 end = cl_offset(&lov->lo_cl, descr->cld_end + 1) - 1;
918 result = end - start <= lsm->lsm_stripe_size &&
919 stripe == lov_stripe_number(lsm, start) &&
920 stripe == lov_stripe_number(lsm, end);
922 struct cl_lock_descr *subd = &lov_env_info(env)->lti_ldescr;
926 subd->cld_obj = NULL; /* don't need sub object at all */
927 subd->cld_mode = descr->cld_mode;
928 subd->cld_gid = descr->cld_gid;
929 result = lov_stripe_intersects(lsm, stripe, start, end,
930 &sub_start, &sub_end);
932 subd->cld_start = cl_index(child->cld_obj, sub_start);
933 subd->cld_end = cl_index(child->cld_obj, sub_end);
934 result = cl_lock_ext_match(child, subd);
940 * An implementation of cl_lock_operations::clo_fits_into() method.
942 * Checks whether a lock (given by \a slice) is suitable for \a
943 * io. Multi-stripe locks can be used only for "quick" io, like truncate, or
946 * \see ccc_lock_fits_into().
948 static int lov_lock_fits_into(const struct lu_env *env,
949 const struct cl_lock_slice *slice,
950 const struct cl_lock_descr *need,
951 const struct cl_io *io)
953 struct lov_lock *lov = cl2lov_lock(slice);
954 struct lov_object *obj = cl2lov(slice->cls_obj);
957 LASSERT(cl_object_same(need->cld_obj, slice->cls_obj));
958 LASSERT(lov->lls_nr > 0);
962 if (need->cld_mode == CLM_GROUP)
964 * always allow to match group lock.
966 result = cl_lock_ext_match(&lov->lls_orig, need);
967 else if (lov->lls_nr == 1) {
968 struct cl_lock_descr *got = &lov->lls_sub[0].sub_got;
969 result = lov_lock_stripe_is_matching(env,
970 cl2lov(slice->cls_obj),
971 lov->lls_sub[0].sub_stripe,
973 } else if (io->ci_type != CIT_TRUNC && io->ci_type != CIT_MISC &&
974 !cl_io_is_append(io) && need->cld_mode != CLM_PHANTOM)
976 * Multi-stripe locks are only suitable for `quick' IO and for
982 * Most general case: multi-stripe existing lock, and
983 * (potentially) multi-stripe @need lock. Check that @need is
984 * covered by @lov's sub-locks.
986 * For now, ignore lock expansions made by the server, and
987 * match against original lock extent.
989 result = cl_lock_ext_match(&lov->lls_orig, need);
990 CDEBUG(D_DLMTRACE, DDESCR"/"DDESCR" %i %i/%i: %i\n",
991 PDESCR(&lov->lls_orig), PDESCR(&lov->lls_sub[0].sub_got),
992 lov->lls_sub[0].sub_stripe, lov->lls_nr, lov_r0(obj)->lo_nr,
997 void lov_lock_unlink(const struct lu_env *env,
998 struct lov_lock_link *link, struct lovsub_lock *sub)
1000 struct lov_lock *lck = link->lll_super;
1001 struct cl_lock *parent = lck->lls_cl.cls_lock;
1003 LASSERT(cl_lock_is_mutexed(parent));
1004 LASSERT(cl_lock_is_mutexed(sub->lss_cl.cls_lock));
1007 list_del_init(&link->lll_list);
1008 LASSERT(lck->lls_sub[link->lll_idx].sub_lock == sub);
1009 /* yank this sub-lock from parent's array */
1010 lck->lls_sub[link->lll_idx].sub_lock = NULL;
1011 LASSERT(lck->lls_nr_filled > 0);
1012 lck->lls_nr_filled--;
1013 lu_ref_del(&parent->cll_reference, "lov-child", sub->lss_cl.cls_lock);
1014 cl_lock_put(env, parent);
1015 OBD_SLAB_FREE_PTR(link, lov_lock_link_kmem);
1019 struct lov_lock_link *lov_lock_link_find(const struct lu_env *env,
1020 struct lov_lock *lck,
1021 struct lovsub_lock *sub)
1023 struct lov_lock_link *scan;
1025 LASSERT(cl_lock_is_mutexed(sub->lss_cl.cls_lock));
1028 list_for_each_entry(scan, &sub->lss_parents, lll_list) {
1029 if (scan->lll_super == lck)
1036 * An implementation of cl_lock_operations::clo_delete() method. This is
1037 * invoked for "top-to-bottom" delete, when lock destruction starts from the
1038 * top-lock, e.g., as a result of inode destruction.
1040 * Unlinks top-lock from all its sub-locks. Sub-locks are not deleted there:
1041 * this is done separately elsewhere:
1043 * - for inode destruction, lov_object_delete() calls cl_object_kill() for
1044 * each sub-object, purging its locks;
1046 * - in other cases (e.g., a fatal error with a top-lock) sub-locks are
1047 * left in the cache.
1049 static void lov_lock_delete(const struct lu_env *env,
1050 const struct cl_lock_slice *slice)
1052 struct lov_lock *lck = cl2lov_lock(slice);
1053 struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
1056 LASSERT(slice->cls_lock->cll_state == CLS_FREEING);
1059 for (i = 0; i < lck->lls_nr; ++i) {
1060 struct lov_lock_sub *lls;
1061 struct lovsub_lock *lsl;
1062 struct cl_lock *sublock;
1065 lls = &lck->lls_sub[i];
1066 lsl = lls->sub_lock;
1070 sublock = lsl->lss_cl.cls_lock;
1071 rc = lov_sublock_lock(env, lck, lls, closure, NULL);
1073 if (lls->sub_flags & LSF_HELD)
1074 lov_sublock_release(env, lck, i, 1, 0);
1075 if (sublock->cll_state < CLS_FREEING) {
1076 struct lov_lock_link *link;
1078 link = lov_lock_link_find(env, lck, lsl);
1079 LASSERT(link != NULL);
1080 lov_lock_unlink(env, link, lsl);
1081 LASSERT(lck->lls_sub[i].sub_lock == NULL);
1083 lov_sublock_unlock(env, lsl, closure, NULL);
1084 } else if (rc == CLO_REPEAT) {
1085 --i; /* repeat with this lock */
1087 CL_LOCK_DEBUG(D_ERROR, env, sublock,
1088 "Cannot get sub-lock for delete: %i\n",
1092 cl_lock_closure_fini(closure);
1096 static int lov_lock_print(const struct lu_env *env, void *cookie,
1097 lu_printer_t p, const struct cl_lock_slice *slice)
1099 struct lov_lock *lck = cl2lov_lock(slice);
1102 (*p)(env, cookie, "%d\n", lck->lls_nr);
1103 for (i = 0; i < lck->lls_nr; ++i) {
1104 struct lov_lock_sub *sub;
1106 sub = &lck->lls_sub[i];
1107 (*p)(env, cookie, " %d %x: ", i, sub->sub_flags);
1108 if (sub->sub_lock != NULL)
1109 cl_lock_print(env, cookie, p,
1110 sub->sub_lock->lss_cl.cls_lock);
1112 (*p)(env, cookie, "---\n");
1117 static const struct cl_lock_operations lov_lock_ops = {
1118 .clo_fini = lov_lock_fini,
1119 .clo_enqueue = lov_lock_enqueue,
1120 .clo_wait = lov_lock_wait,
1121 .clo_use = lov_lock_use,
1122 .clo_unuse = lov_lock_unuse,
1123 .clo_cancel = lov_lock_cancel,
1124 .clo_fits_into = lov_lock_fits_into,
1125 .clo_delete = lov_lock_delete,
1126 .clo_print = lov_lock_print
1129 int lov_lock_init_raid0(const struct lu_env *env, struct cl_object *obj,
1130 struct cl_lock *lock, const struct cl_io *io)
1132 struct lov_lock *lck;
1136 OBD_SLAB_ALLOC_PTR_GFP(lck, lov_lock_kmem, CFS_ALLOC_IO);
1138 cl_lock_slice_add(lock, &lck->lls_cl, obj, &lov_lock_ops);
1139 result = lov_lock_sub_init(env, lck, io);
1145 static struct cl_lock_closure *lov_closure_get(const struct lu_env *env,
1146 struct cl_lock *parent)
1148 struct cl_lock_closure *closure;
1150 closure = &lov_env_info(env)->lti_closure;
1151 LASSERT(list_empty(&closure->clc_list));
1152 cl_lock_closure_init(env, closure, parent, 1);