Whamcloud - gitweb
LU-1347 build: remove the vim/emacs modelines
[fs/lustre-release.git] / lustre / lov / lov_lock.c
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) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
28  * Use is subject to license terms.
29  *
30  * Copyright (c) 2011, 2012, Whamcloud, Inc.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * Implementation of cl_lock for LOV layer.
37  *
38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
39  */
40
41 #define DEBUG_SUBSYSTEM S_LOV
42
43 #include "lov_cl_internal.h"
44
45 /** \addtogroup lov
46  *  @{
47  */
48
49 static struct cl_lock_closure *lov_closure_get(const struct lu_env *env,
50                                                struct cl_lock *parent);
51
52 static int lov_lock_unuse(const struct lu_env *env,
53                           const struct cl_lock_slice *slice);
54 /*****************************************************************************
55  *
56  * Lov lock operations.
57  *
58  */
59
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)
63 {
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;
68
69         subenv = &lov_env_session(env)->ls_subenv;
70
71         /*
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.
79          */
80         if (!io || !cl_object_same(io->ci_obj, parent->cll_descr.cld_obj)) {
81                 subenv->lse_env = env;
82                 subenv->lse_io  = io;
83                 subenv->lse_sub = NULL;
84         } else {
85                 sub = lov_sub_get(env, lio, lls->sub_stripe);
86                 if (!IS_ERR(sub)) {
87                         subenv->lse_env = sub->sub_env;
88                         subenv->lse_io  = sub->sub_io;
89                         subenv->lse_sub = sub;
90                 } else {
91                         subenv = (void*)sub;
92                 }
93         }
94         return subenv;
95 }
96
97 static void lov_sublock_env_put(struct lov_sublock_env *subenv)
98 {
99         if (subenv && subenv->lse_sub)
100                 lov_sub_put(subenv->lse_sub);
101 }
102
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)
106 {
107         struct lovsub_lock *lsl;
108         struct cl_lock     *parent = lck->lls_cl.cls_lock;
109         int                 rc;
110
111         LASSERT(cl_lock_is_mutexed(parent));
112         LASSERT(cl_lock_is_mutexed(sublock));
113         ENTRY;
114
115         lsl = cl2sub_lock(sublock);
116         /*
117          * check that sub-lock doesn't have lock link to this top-lock.
118          */
119         LASSERT(lov_lock_link_find(env, lck, lsl) == NULL);
120         LASSERT(idx < lck->lls_nr);
121
122         lck->lls_sub[idx].sub_lock = lsl;
123         lck->lls_nr_filled++;
124         LASSERT(lck->lls_nr_filled <= lck->lls_nr);
125         cfs_list_add_tail(&link->lll_list, &lsl->lss_parents);
126         link->lll_idx = idx;
127         link->lll_super = lck;
128         cl_lock_get(parent);
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);
132
133         rc = lov_sublock_modify(env, lck, lsl, &sublock->cll_descr, idx);
134         LASSERT(rc == 0); /* there is no way this can fail, currently */
135         EXIT;
136 }
137
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)
142 {
143         struct cl_lock       *sublock;
144         struct cl_lock       *parent;
145         struct lov_lock_link *link;
146
147         LASSERT(idx < lck->lls_nr);
148         ENTRY;
149
150         OBD_SLAB_ALLOC_PTR_GFP(link, lov_lock_link_kmem, CFS_ALLOC_IO);
151         if (link != NULL) {
152                 struct lov_sublock_env *subenv;
153                 struct lov_lock_sub  *lls;
154                 struct cl_lock_descr *descr;
155
156                 parent = lck->lls_cl.cls_lock;
157                 lls    = &lck->lls_sub[idx];
158                 descr  = &lls->sub_descr;
159
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 */
167
168                         sublock = cl_lock_hold(subenv->lse_env, subenv->lse_io,
169                                                descr, "lov-parent", parent);
170                         lov_sublock_env_put(subenv);
171                 } else {
172                         /* error occurs. */
173                         sublock = (void*)subenv;
174                 }
175
176                 if (!IS_ERR(sublock))
177                         *out = link;
178                 else
179                         OBD_SLAB_FREE_PTR(link, lov_lock_link_kmem);
180         } else
181                 sublock = ERR_PTR(-ENOMEM);
182         RETURN(sublock);
183 }
184
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)
189 {
190         ENTRY;
191         lov_sublock_env_put(subenv);
192         lsl->lss_active = NULL;
193         cl_lock_disclosure(env, closure);
194         EXIT;
195 }
196
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)
202 {
203         struct lovsub_lock *sublock;
204         struct cl_lock     *child;
205         int                 result = 0;
206         ENTRY;
207
208         LASSERT(cfs_list_empty(&closure->clc_list));
209
210         sublock = lls->sub_lock;
211         child = sublock->lss_cl.cls_lock;
212         result = cl_lock_closure_build(env, child, closure);
213         if (result == 0) {
214                 struct cl_lock *parent = closure->clc_origin;
215
216                 LASSERT(cl_lock_is_mutexed(child));
217                 sublock->lss_active = parent;
218
219                 if (unlikely((child->cll_state == CLS_FREEING) ||
220                              (child->cll_flags & CLF_CANCELLED))) {
221                         struct lov_lock_link *link;
222                         /*
223                          * we could race with lock deletion which temporarily
224                          * put the lock in freeing state, bug 19080.
225                          */
226                         LASSERT(!(lls->sub_flags & LSF_HELD));
227
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;
233                         result = CLO_REPEAT;
234                 } else if (lsep) {
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,
239                                                    closure, NULL);
240                                 result = PTR_ERR(subenv);
241                         } else {
242                                 *lsep = subenv;
243                         }
244                 }
245         }
246         RETURN(result);
247 }
248
249 /**
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
254  * ordered as
255  *
256  *     - 0                  success
257  *     - CLO_WAIT           wait for event
258  *     - CLO_REPEAT         repeat top-operation
259  *     - -ne                fundamental error
260  *
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.
264  */
265 static int lov_subresult(int result, int rc)
266 {
267         int result_rank;
268         int rc_rank;
269
270         ENTRY;
271
272         LASSERT(result <= 0 || result == CLO_REPEAT || result == CLO_WAIT);
273         LASSERT(rc <= 0 || rc == CLO_REPEAT || rc == CLO_WAIT);
274         CLASSERT(CLO_WAIT < CLO_REPEAT);
275
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;
279
280         if (result_rank < rc_rank)
281                 result = rc;
282         RETURN(result);
283 }
284
285 /**
286  * Creates sub-locks for a given lov_lock for the first time.
287  *
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).
292  */
293 static int lov_lock_sub_init(const struct lu_env *env,
294                              struct lov_lock *lck, const struct cl_io *io)
295 {
296         int result = 0;
297         int i;
298         int nr;
299         obd_off start;
300         obd_off end;
301         obd_off file_start;
302         obd_off file_end;
303
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;
307
308         ENTRY;
309
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;
313
314         for (i = 0, nr = 0; i < r0->lo_nr; i++) {
315                 /*
316                  * XXX for wide striping smarter algorithm is desirable,
317                  * breaking out of the loop, early.
318                  */
319                 if (lov_stripe_intersects(r0->lo_lsm, i,
320                                           file_start, file_end, &start, &end))
321                         nr++;
322         }
323         LASSERT(nr > 0);
324         OBD_ALLOC_LARGE(lck->lls_sub, nr * sizeof lck->lls_sub[0]);
325         if (lck->lls_sub == NULL)
326                 RETURN(-ENOMEM);
327
328         lck->lls_nr = nr;
329         /*
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
334          * top-lock.
335          */
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;
340
341                         descr = &lck->lls_sub[nr].sub_descr;
342
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;
353                         nr++;
354                 }
355         }
356         LASSERT(nr == lck->lls_nr);
357         /*
358          * Then, create sub-locks. Once at least one sub-lock was created,
359          * top-lock can be reached by other threads.
360          */
361         for (i = 0; i < lck->lls_nr; ++i) {
362                 struct cl_lock       *sublock;
363                 struct lov_lock_link *link;
364
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);
369                                 break;
370                         }
371                         cl_lock_get_trust(sublock);
372                         cl_lock_mutex_get(env, sublock);
373                         cl_lock_mutex_get(env, parent);
374                         /*
375                          * recheck under mutex that sub-lock wasn't created
376                          * concurrently, and that top-lock is still alive.
377                          */
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);
382                         } else {
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);
387                         }
388                         cl_lock_mutex_put(env, sublock);
389                         cl_lock_put(env, sublock);
390                 }
391         }
392         /*
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.
396          */
397         RETURN(result);
398 }
399
400 static int lov_sublock_release(const struct lu_env *env, struct lov_lock *lck,
401                                int i, int deluser, int rc)
402 {
403         struct cl_lock *parent = lck->lls_cl.cls_lock;
404
405         LASSERT(cl_lock_is_mutexed(parent));
406         ENTRY;
407
408         if (lck->lls_sub[i].sub_flags & LSF_HELD) {
409                 struct cl_lock    *sublock;
410                 int dying;
411
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));
415
416                 lck->lls_sub[i].sub_flags &= ~LSF_HELD;
417                 if (deluser)
418                         cl_lock_user_del(env, sublock);
419                 /*
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.
423                  */
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;
428                 if (dying)
429                         cl_lock_mutex_put(env, parent);
430                 cl_lock_unhold(env, sublock, "lov-parent", parent);
431                 if (dying) {
432                         cl_lock_mutex_get(env, parent);
433                         rc = lov_subresult(rc, CLO_REPEAT);
434                 }
435                 /*
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.
441                  */
442         }
443         RETURN(rc);
444 }
445
446 static void lov_sublock_hold(const struct lu_env *env, struct lov_lock *lck,
447                              int i)
448 {
449         struct cl_lock *parent = lck->lls_cl.cls_lock;
450
451         LASSERT(cl_lock_is_mutexed(parent));
452         ENTRY;
453
454         if (!(lck->lls_sub[i].sub_flags & LSF_HELD)) {
455                 struct cl_lock *sublock;
456
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);
461
462                 lck->lls_sub[i].sub_flags |= LSF_HELD;
463
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);
468         }
469         EXIT;
470 }
471
472 static void lov_lock_fini(const struct lu_env *env,
473                           struct cl_lock_slice *slice)
474 {
475         struct lov_lock *lck;
476         int i;
477
478         ENTRY;
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)
483                         /*
484                          * No sub-locks exists at this point, as sub-lock has
485                          * a reference on its parent.
486                          */
487                         LASSERT(lck->lls_sub[i].sub_lock == NULL);
488                 OBD_FREE_LARGE(lck->lls_sub,
489                                lck->lls_nr * sizeof lck->lls_sub[0]);
490         }
491         OBD_SLAB_FREE_PTR(lck, lov_lock_kmem);
492         EXIT;
493 }
494
495 static int lov_lock_enqueue_wait(const struct lu_env *env,
496                                  struct lov_lock *lck,
497                                  struct cl_lock *sublock)
498 {
499         struct cl_lock *lock = lck->lls_cl.cls_lock;
500         int             result;
501         ENTRY;
502
503         LASSERT(cl_lock_is_mutexed(lock));
504
505         cl_lock_mutex_put(env, lock);
506         result = cl_lock_enqueue_wait(env, sublock, 0);
507         cl_lock_mutex_get(env, lock);
508         RETURN(result ?: CLO_REPEAT);
509 }
510
511 /**
512  * Tries to advance a state machine of a given sub-lock toward enqueuing of
513  * the top-lock.
514  *
515  * \retval 0 if state-transition can proceed
516  * \retval -ve otherwise.
517  */
518 static int lov_lock_enqueue_one(const struct lu_env *env, struct lov_lock *lck,
519                                 struct cl_lock *sublock,
520                                 struct cl_io *io, __u32 enqflags, int last)
521 {
522         int result;
523         ENTRY;
524
525         /* first, try to enqueue a sub-lock ... */
526         result = cl_enqueue_try(env, sublock, io, enqflags);
527         if ((sublock->cll_state == CLS_ENQUEUED) && !(enqflags & CEF_AGL))
528                 /* if it is enqueued, try to `wait' on it---maybe it's already
529                  * granted */
530                 result = cl_wait_try(env, sublock);
531         /*
532          * If CEF_ASYNC flag is set, then all sub-locks can be enqueued in
533          * parallel, otherwise---enqueue has to wait until sub-lock is granted
534          * before proceeding to the next one.
535          */
536         if ((result == CLO_WAIT) && (sublock->cll_state <= CLS_HELD) &&
537             (enqflags & CEF_ASYNC) && (!last || (enqflags & CEF_AGL)))
538                 result = 0;
539         RETURN(result);
540 }
541
542 /**
543  * Helper function for lov_lock_enqueue() that creates missing sub-lock.
544  */
545 static int lov_sublock_fill(const struct lu_env *env, struct cl_lock *parent,
546                             struct cl_io *io, struct lov_lock *lck, int idx)
547 {
548         struct lov_lock_link *link;
549         struct cl_lock       *sublock;
550         int                   result;
551
552         LASSERT(parent->cll_depth == 1);
553         cl_lock_mutex_put(env, parent);
554         sublock = lov_sublock_alloc(env, io, lck, idx, &link);
555         if (!IS_ERR(sublock))
556                 cl_lock_mutex_get(env, sublock);
557         cl_lock_mutex_get(env, parent);
558
559         if (!IS_ERR(sublock)) {
560                 cl_lock_get_trust(sublock);
561                 if (parent->cll_state == CLS_QUEUING &&
562                     lck->lls_sub[idx].sub_lock == NULL) {
563                         lov_sublock_adopt(env, lck, sublock, idx, link);
564                 } else {
565                         OBD_SLAB_FREE_PTR(link, lov_lock_link_kmem);
566                         /* other thread allocated sub-lock, or enqueue is no
567                          * longer going on */
568                         cl_lock_mutex_put(env, parent);
569                         cl_lock_unhold(env, sublock, "lov-parent", parent);
570                         cl_lock_mutex_get(env, parent);
571                 }
572                 cl_lock_mutex_put(env, sublock);
573                 cl_lock_put(env, sublock);
574                 result = CLO_REPEAT;
575         } else
576                 result = PTR_ERR(sublock);
577         return result;
578 }
579
580 /**
581  * Implementation of cl_lock_operations::clo_enqueue() for lov layer. This
582  * function is rather subtle, as it enqueues top-lock (i.e., advances top-lock
583  * state machine from CLS_QUEUING to CLS_ENQUEUED states) by juggling sub-lock
584  * state machines in the face of sub-locks sharing (by multiple top-locks),
585  * and concurrent sub-lock cancellations.
586  */
587 static int lov_lock_enqueue(const struct lu_env *env,
588                             const struct cl_lock_slice *slice,
589                             struct cl_io *io, __u32 enqflags)
590 {
591         struct cl_lock         *lock    = slice->cls_lock;
592         struct lov_lock        *lck     = cl2lov_lock(slice);
593         struct cl_lock_closure *closure = lov_closure_get(env, lock);
594         int i;
595         int result;
596         enum cl_lock_state minstate;
597
598         ENTRY;
599
600         for (result = 0, minstate = CLS_FREEING, i = 0; i < lck->lls_nr; ++i) {
601                 int rc;
602                 struct lovsub_lock     *sub;
603                 struct lov_lock_sub    *lls;
604                 struct cl_lock         *sublock;
605                 struct lov_sublock_env *subenv;
606
607                 if (lock->cll_state != CLS_QUEUING) {
608                         /*
609                          * Lock might have left QUEUING state if previous
610                          * iteration released its mutex. Stop enqueing in this
611                          * case and let the upper layer to decide what to do.
612                          */
613                         LASSERT(i > 0 && result != 0);
614                         break;
615                 }
616
617                 lls = &lck->lls_sub[i];
618                 sub = lls->sub_lock;
619                 /*
620                  * Sub-lock might have been canceled, while top-lock was
621                  * cached.
622                  */
623                 if (sub == NULL) {
624                         result = lov_sublock_fill(env, lock, io, lck, i);
625                         /* lov_sublock_fill() released @lock mutex,
626                          * restart. */
627                         break;
628                 }
629                 sublock = sub->lss_cl.cls_lock;
630                 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
631                 if (rc == 0) {
632                         lov_sublock_hold(env, lck, i);
633                         rc = lov_lock_enqueue_one(subenv->lse_env, lck, sublock,
634                                                   subenv->lse_io, enqflags,
635                                                   i == lck->lls_nr - 1);
636                         minstate = min(minstate, sublock->cll_state);
637                         if (rc == CLO_WAIT) {
638                                 switch (sublock->cll_state) {
639                                 case CLS_QUEUING:
640                                         /* take recursive mutex, the lock is
641                                          * released in lov_lock_enqueue_wait.
642                                          */
643                                         cl_lock_mutex_get(env, sublock);
644                                         lov_sublock_unlock(env, sub, closure,
645                                                            subenv);
646                                         rc = lov_lock_enqueue_wait(env, lck,
647                                                                    sublock);
648                                         break;
649                                 case CLS_CACHED:
650                                         rc = lov_sublock_release(env, lck, i,
651                                                                  1, rc);
652                                 default:
653                                         lov_sublock_unlock(env, sub, closure,
654                                                            subenv);
655                                         break;
656                                 }
657                         } else {
658                                 LASSERT(sublock->cll_conflict == NULL);
659                                 lov_sublock_unlock(env, sub, closure, subenv);
660                         }
661                 }
662                 result = lov_subresult(result, rc);
663                 if (result != 0)
664                         break;
665         }
666         cl_lock_closure_fini(closure);
667         RETURN(result ?: minstate >= CLS_ENQUEUED ? 0 : CLO_WAIT);
668 }
669
670 static int lov_lock_unuse(const struct lu_env *env,
671                           const struct cl_lock_slice *slice)
672 {
673         struct lov_lock        *lck     = cl2lov_lock(slice);
674         struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
675         int i;
676         int result;
677
678         ENTRY;
679
680         for (result = 0, i = 0; i < lck->lls_nr; ++i) {
681                 int rc;
682                 struct lovsub_lock     *sub;
683                 struct cl_lock         *sublock;
684                 struct lov_lock_sub    *lls;
685                 struct lov_sublock_env *subenv;
686
687                 /* top-lock state cannot change concurrently, because single
688                  * thread (one that released the last hold) carries unlocking
689                  * to the completion. */
690                 LASSERT(slice->cls_lock->cll_state == CLS_INTRANSIT);
691                 lls = &lck->lls_sub[i];
692                 sub = lls->sub_lock;
693                 if (sub == NULL)
694                         continue;
695
696                 sublock = sub->lss_cl.cls_lock;
697                 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
698                 if (rc == 0) {
699                         if (lls->sub_flags & LSF_HELD) {
700                                 LASSERT(sublock->cll_state == CLS_HELD ||
701                                         sublock->cll_state == CLS_ENQUEUED);
702                                 rc = cl_unuse_try(subenv->lse_env, sublock);
703                                 rc = lov_sublock_release(env, lck, i, 0, rc);
704                         }
705                         lov_sublock_unlock(env, sub, closure, subenv);
706                 }
707                 result = lov_subresult(result, rc);
708         }
709
710         if (result == 0 && lck->lls_cancel_race) {
711                 lck->lls_cancel_race = 0;
712                 result = -ESTALE;
713         }
714         cl_lock_closure_fini(closure);
715         RETURN(result);
716 }
717
718
719 static void lov_lock_cancel(const struct lu_env *env,
720                            const struct cl_lock_slice *slice)
721 {
722         struct lov_lock        *lck     = cl2lov_lock(slice);
723         struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
724         int i;
725         int result;
726
727         ENTRY;
728
729         for (result = 0, i = 0; i < lck->lls_nr; ++i) {
730                 int rc;
731                 struct lovsub_lock     *sub;
732                 struct cl_lock         *sublock;
733                 struct lov_lock_sub    *lls;
734                 struct lov_sublock_env *subenv;
735
736                 /* top-lock state cannot change concurrently, because single
737                  * thread (one that released the last hold) carries unlocking
738                  * to the completion. */
739                 lls = &lck->lls_sub[i];
740                 sub = lls->sub_lock;
741                 if (sub == NULL)
742                         continue;
743
744                 sublock = sub->lss_cl.cls_lock;
745                 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
746                 if (rc == 0) {
747                         if (!(lls->sub_flags & LSF_HELD)) {
748                                 lov_sublock_unlock(env, sub, closure, subenv);
749                                 continue;
750                         }
751
752                         switch(sublock->cll_state) {
753                         case CLS_HELD:
754                                 rc = cl_unuse_try(subenv->lse_env,
755                                                   sublock);
756                                 lov_sublock_release(env, lck, i, 0, 0);
757                                 break;
758                         case CLS_ENQUEUED:
759                                 /* TODO: it's not a good idea to cancel this
760                                  * lock because it's innocent. But it's
761                                  * acceptable. The better way would be to
762                                  * define a new lock method to unhold the
763                                  * dlm lock. */
764                                 cl_lock_cancel(env, sublock);
765                         default:
766                                 lov_sublock_release(env, lck, i, 1, 0);
767                                 break;
768                         }
769                         lov_sublock_unlock(env, sub, closure, subenv);
770                 }
771
772                 if (rc == CLO_REPEAT) {
773                         --i;
774                         continue;
775                 }
776
777                 result = lov_subresult(result, rc);
778         }
779
780         if (result)
781                 CL_LOCK_DEBUG(D_ERROR, env, slice->cls_lock,
782                               "lov_lock_cancel fails with %d.\n", result);
783
784         cl_lock_closure_fini(closure);
785 }
786
787 static int lov_lock_wait(const struct lu_env *env,
788                          const struct cl_lock_slice *slice)
789 {
790         struct lov_lock        *lck     = cl2lov_lock(slice);
791         struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
792         enum cl_lock_state      minstate;
793         int                     reenqueued;
794         int                     result;
795         int                     i;
796
797         ENTRY;
798
799 again:
800         for (result = 0, minstate = CLS_FREEING, i = 0, reenqueued = 0;
801              i < lck->lls_nr; ++i) {
802                 int rc;
803                 struct lovsub_lock     *sub;
804                 struct cl_lock         *sublock;
805                 struct lov_lock_sub    *lls;
806                 struct lov_sublock_env *subenv;
807
808                 lls = &lck->lls_sub[i];
809                 sub = lls->sub_lock;
810                 LASSERT(sub != NULL);
811                 sublock = sub->lss_cl.cls_lock;
812                 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
813                 if (rc == 0) {
814                         LASSERT(sublock->cll_state >= CLS_ENQUEUED);
815                         if (sublock->cll_state < CLS_HELD)
816                                 rc = cl_wait_try(env, sublock);
817
818                         minstate = min(minstate, sublock->cll_state);
819                         lov_sublock_unlock(env, sub, closure, subenv);
820                 }
821                 if (rc == CLO_REENQUEUED) {
822                         reenqueued++;
823                         rc = 0;
824                 }
825                 result = lov_subresult(result, rc);
826                 if (result != 0)
827                         break;
828         }
829         /* Each sublock only can be reenqueued once, so will not loop for
830          * ever. */
831         if (result == 0 && reenqueued != 0)
832                 goto again;
833         cl_lock_closure_fini(closure);
834         RETURN(result ?: minstate >= CLS_HELD ? 0 : CLO_WAIT);
835 }
836
837 static int lov_lock_use(const struct lu_env *env,
838                         const struct cl_lock_slice *slice)
839 {
840         struct lov_lock        *lck     = cl2lov_lock(slice);
841         struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
842         int                     result;
843         int                     i;
844
845         LASSERT(slice->cls_lock->cll_state == CLS_INTRANSIT);
846         ENTRY;
847
848         for (result = 0, i = 0; i < lck->lls_nr; ++i) {
849                 int rc;
850                 struct lovsub_lock     *sub;
851                 struct cl_lock         *sublock;
852                 struct lov_lock_sub    *lls;
853                 struct lov_sublock_env *subenv;
854
855                 LASSERT(slice->cls_lock->cll_state == CLS_INTRANSIT);
856
857                 lls = &lck->lls_sub[i];
858                 sub = lls->sub_lock;
859                 if (sub == NULL) {
860                         /*
861                          * Sub-lock might have been canceled, while top-lock was
862                          * cached.
863                          */
864                         result = -ESTALE;
865                         break;
866                 }
867
868                 sublock = sub->lss_cl.cls_lock;
869                 rc = lov_sublock_lock(env, lck, lls, closure, &subenv);
870                 if (rc == 0) {
871                         LASSERT(sublock->cll_state != CLS_FREEING);
872                         lov_sublock_hold(env, lck, i);
873                         if (sublock->cll_state == CLS_CACHED) {
874                                 rc = cl_use_try(subenv->lse_env, sublock, 0);
875                                 if (rc != 0)
876                                         rc = lov_sublock_release(env, lck,
877                                                                  i, 1, rc);
878                         } else if (sublock->cll_state == CLS_NEW) {
879                                 /* Sub-lock might have been canceled, while
880                                  * top-lock was cached. */
881                                 result = -ESTALE;
882                                 lov_sublock_release(env, lck, i, 1, result);
883                         }
884                         lov_sublock_unlock(env, sub, closure, subenv);
885                 }
886                 result = lov_subresult(result, rc);
887                 if (result != 0)
888                         break;
889         }
890
891         if (lck->lls_cancel_race) {
892                 /*
893                  * If there is unlocking happened at the same time, then
894                  * sublock_lock state should be FREEING, and lov_sublock_lock
895                  * should return CLO_REPEAT. In this case, it should return
896                  * ESTALE, and up layer should reset the lock state to be NEW.
897                  */
898                 lck->lls_cancel_race = 0;
899                 LASSERT(result != 0);
900                 result = -ESTALE;
901         }
902         cl_lock_closure_fini(closure);
903         RETURN(result);
904 }
905
906 #if 0
907 static int lock_lock_multi_match()
908 {
909         struct cl_lock          *lock    = slice->cls_lock;
910         struct cl_lock_descr    *subneed = &lov_env_info(env)->lti_ldescr;
911         struct lov_object       *loo     = cl2lov(lov->lls_cl.cls_obj);
912         struct lov_layout_raid0 *r0      = lov_r0(loo);
913         struct lov_lock_sub     *sub;
914         struct cl_object        *subobj;
915         obd_off  fstart;
916         obd_off  fend;
917         obd_off  start;
918         obd_off  end;
919         int i;
920
921         fstart = cl_offset(need->cld_obj, need->cld_start);
922         fend   = cl_offset(need->cld_obj, need->cld_end + 1) - 1;
923         subneed->cld_mode = need->cld_mode;
924         cl_lock_mutex_get(env, lock);
925         for (i = 0; i < lov->lls_nr; ++i) {
926                 sub = &lov->lls_sub[i];
927                 if (sub->sub_lock == NULL)
928                         continue;
929                 subobj = sub->sub_descr.cld_obj;
930                 if (!lov_stripe_intersects(r0->lo_lsm, sub->sub_stripe,
931                                            fstart, fend, &start, &end))
932                         continue;
933                 subneed->cld_start = cl_index(subobj, start);
934                 subneed->cld_end   = cl_index(subobj, end);
935                 subneed->cld_obj   = subobj;
936                 if (!cl_lock_ext_match(&sub->sub_got, subneed)) {
937                         result = 0;
938                         break;
939                 }
940         }
941         cl_lock_mutex_put(env, lock);
942 }
943 #endif
944
945 /**
946  * Check if the extent region \a descr is covered by \a child against the
947  * specific \a stripe.
948  */
949 static int lov_lock_stripe_is_matching(const struct lu_env *env,
950                                        struct lov_object *lov, int stripe,
951                                        const struct cl_lock_descr *child,
952                                        const struct cl_lock_descr *descr)
953 {
954         struct lov_stripe_md *lsm = lov_r0(lov)->lo_lsm;
955         obd_off start;
956         obd_off end;
957         int result;
958
959         if (lov_r0(lov)->lo_nr == 1)
960                 return cl_lock_ext_match(child, descr);
961
962         /*
963          * For a multi-stripes object:
964          * - make sure the descr only covers child's stripe, and
965          * - check if extent is matching.
966          */
967         start = cl_offset(&lov->lo_cl, descr->cld_start);
968         end   = cl_offset(&lov->lo_cl, descr->cld_end + 1) - 1;
969         result = end - start <= lsm->lsm_stripe_size &&
970                  stripe == lov_stripe_number(lsm, start) &&
971                  stripe == lov_stripe_number(lsm, end);
972         if (result) {
973                 struct cl_lock_descr *subd = &lov_env_info(env)->lti_ldescr;
974                 obd_off sub_start;
975                 obd_off sub_end;
976
977                 subd->cld_obj  = NULL;   /* don't need sub object at all */
978                 subd->cld_mode = descr->cld_mode;
979                 subd->cld_gid  = descr->cld_gid;
980                 result = lov_stripe_intersects(lsm, stripe, start, end,
981                                                &sub_start, &sub_end);
982                 LASSERT(result);
983                 subd->cld_start = cl_index(child->cld_obj, sub_start);
984                 subd->cld_end   = cl_index(child->cld_obj, sub_end);
985                 result = cl_lock_ext_match(child, subd);
986         }
987         return result;
988 }
989
990 /**
991  * An implementation of cl_lock_operations::clo_fits_into() method.
992  *
993  * Checks whether a lock (given by \a slice) is suitable for \a
994  * io. Multi-stripe locks can be used only for "quick" io, like truncate, or
995  * O_APPEND write.
996  *
997  * \see ccc_lock_fits_into().
998  */
999 static int lov_lock_fits_into(const struct lu_env *env,
1000                               const struct cl_lock_slice *slice,
1001                               const struct cl_lock_descr *need,
1002                               const struct cl_io *io)
1003 {
1004         struct lov_lock   *lov = cl2lov_lock(slice);
1005         struct lov_object *obj = cl2lov(slice->cls_obj);
1006         int result;
1007
1008         LASSERT(cl_object_same(need->cld_obj, slice->cls_obj));
1009         LASSERT(lov->lls_nr > 0);
1010
1011         ENTRY;
1012
1013         if (need->cld_mode == CLM_GROUP)
1014                 /*
1015                  * always allow to match group lock.
1016                  */
1017                 result = cl_lock_ext_match(&lov->lls_orig, need);
1018         else if (lov->lls_nr == 1) {
1019                 struct cl_lock_descr *got = &lov->lls_sub[0].sub_got;
1020                 result = lov_lock_stripe_is_matching(env,
1021                                                      cl2lov(slice->cls_obj),
1022                                                      lov->lls_sub[0].sub_stripe,
1023                                                      got, need);
1024         } else if (io->ci_type != CIT_SETATTR && io->ci_type != CIT_MISC &&
1025                    !cl_io_is_append(io) && need->cld_mode != CLM_PHANTOM)
1026                 /*
1027                  * Multi-stripe locks are only suitable for `quick' IO and for
1028                  * glimpse.
1029                  */
1030                 result = 0;
1031         else
1032                 /*
1033                  * Most general case: multi-stripe existing lock, and
1034                  * (potentially) multi-stripe @need lock. Check that @need is
1035                  * covered by @lov's sub-locks.
1036                  *
1037                  * For now, ignore lock expansions made by the server, and
1038                  * match against original lock extent.
1039                  */
1040                 result = cl_lock_ext_match(&lov->lls_orig, need);
1041         CDEBUG(D_DLMTRACE, DDESCR"/"DDESCR" %d %d/%d: %d\n",
1042                PDESCR(&lov->lls_orig), PDESCR(&lov->lls_sub[0].sub_got),
1043                lov->lls_sub[0].sub_stripe, lov->lls_nr, lov_r0(obj)->lo_nr,
1044                result);
1045         RETURN(result);
1046 }
1047
1048 void lov_lock_unlink(const struct lu_env *env,
1049                      struct lov_lock_link *link, struct lovsub_lock *sub)
1050 {
1051         struct lov_lock *lck    = link->lll_super;
1052         struct cl_lock  *parent = lck->lls_cl.cls_lock;
1053
1054         LASSERT(cl_lock_is_mutexed(parent));
1055         LASSERT(cl_lock_is_mutexed(sub->lss_cl.cls_lock));
1056         ENTRY;
1057
1058         cfs_list_del_init(&link->lll_list);
1059         LASSERT(lck->lls_sub[link->lll_idx].sub_lock == sub);
1060         /* yank this sub-lock from parent's array */
1061         lck->lls_sub[link->lll_idx].sub_lock = NULL;
1062         LASSERT(lck->lls_nr_filled > 0);
1063         lck->lls_nr_filled--;
1064         lu_ref_del(&parent->cll_reference, "lov-child", sub->lss_cl.cls_lock);
1065         cl_lock_put(env, parent);
1066         OBD_SLAB_FREE_PTR(link, lov_lock_link_kmem);
1067         EXIT;
1068 }
1069
1070 struct lov_lock_link *lov_lock_link_find(const struct lu_env *env,
1071                                          struct lov_lock *lck,
1072                                          struct lovsub_lock *sub)
1073 {
1074         struct lov_lock_link *scan;
1075
1076         LASSERT(cl_lock_is_mutexed(sub->lss_cl.cls_lock));
1077         ENTRY;
1078
1079         cfs_list_for_each_entry(scan, &sub->lss_parents, lll_list) {
1080                 if (scan->lll_super == lck)
1081                         RETURN(scan);
1082         }
1083         RETURN(NULL);
1084 }
1085
1086 /**
1087  * An implementation of cl_lock_operations::clo_delete() method. This is
1088  * invoked for "top-to-bottom" delete, when lock destruction starts from the
1089  * top-lock, e.g., as a result of inode destruction.
1090  *
1091  * Unlinks top-lock from all its sub-locks. Sub-locks are not deleted there:
1092  * this is done separately elsewhere:
1093  *
1094  *     - for inode destruction, lov_object_delete() calls cl_object_kill() for
1095  *       each sub-object, purging its locks;
1096  *
1097  *     - in other cases (e.g., a fatal error with a top-lock) sub-locks are
1098  *       left in the cache.
1099  */
1100 static void lov_lock_delete(const struct lu_env *env,
1101                             const struct cl_lock_slice *slice)
1102 {
1103         struct lov_lock        *lck     = cl2lov_lock(slice);
1104         struct cl_lock_closure *closure = lov_closure_get(env, slice->cls_lock);
1105         struct lov_lock_link   *link;
1106         int                     rc;
1107         int                     i;
1108
1109         LASSERT(slice->cls_lock->cll_state == CLS_FREEING);
1110         ENTRY;
1111
1112         for (i = 0; i < lck->lls_nr; ++i) {
1113                 struct lov_lock_sub *lls = &lck->lls_sub[i];
1114                 struct lovsub_lock  *lsl = lls->sub_lock;
1115
1116                 if (lsl == NULL) /* already removed */
1117                         continue;
1118
1119                 rc = lov_sublock_lock(env, lck, lls, closure, NULL);
1120                 if (rc == CLO_REPEAT) {
1121                         --i;
1122                         continue;
1123                 }
1124
1125                 LASSERT(rc == 0);
1126                 LASSERT(lsl->lss_cl.cls_lock->cll_state < CLS_FREEING);
1127
1128                 if (lls->sub_flags & LSF_HELD)
1129                         lov_sublock_release(env, lck, i, 1, 0);
1130
1131                 link = lov_lock_link_find(env, lck, lsl);
1132                 LASSERT(link != NULL);
1133                 lov_lock_unlink(env, link, lsl);
1134                 LASSERT(lck->lls_sub[i].sub_lock == NULL);
1135
1136                 lov_sublock_unlock(env, lsl, closure, NULL);
1137         }
1138
1139         cl_lock_closure_fini(closure);
1140         EXIT;
1141 }
1142
1143 static int lov_lock_print(const struct lu_env *env, void *cookie,
1144                           lu_printer_t p, const struct cl_lock_slice *slice)
1145 {
1146         struct lov_lock *lck = cl2lov_lock(slice);
1147         int              i;
1148
1149         (*p)(env, cookie, "%d\n", lck->lls_nr);
1150         for (i = 0; i < lck->lls_nr; ++i) {
1151                 struct lov_lock_sub *sub;
1152
1153                 sub = &lck->lls_sub[i];
1154                 (*p)(env, cookie, "    %d %x: ", i, sub->sub_flags);
1155                 if (sub->sub_lock != NULL)
1156                         cl_lock_print(env, cookie, p,
1157                                       sub->sub_lock->lss_cl.cls_lock);
1158                 else
1159                         (*p)(env, cookie, "---\n");
1160         }
1161         return 0;
1162 }
1163
1164 static const struct cl_lock_operations lov_lock_ops = {
1165         .clo_fini      = lov_lock_fini,
1166         .clo_enqueue   = lov_lock_enqueue,
1167         .clo_wait      = lov_lock_wait,
1168         .clo_use       = lov_lock_use,
1169         .clo_unuse     = lov_lock_unuse,
1170         .clo_cancel    = lov_lock_cancel,
1171         .clo_fits_into = lov_lock_fits_into,
1172         .clo_delete    = lov_lock_delete,
1173         .clo_print     = lov_lock_print
1174 };
1175
1176 int lov_lock_init_raid0(const struct lu_env *env, struct cl_object *obj,
1177                         struct cl_lock *lock, const struct cl_io *io)
1178 {
1179         struct lov_lock *lck;
1180         int result;
1181
1182         ENTRY;
1183         OBD_SLAB_ALLOC_PTR_GFP(lck, lov_lock_kmem, CFS_ALLOC_IO);
1184         if (lck != NULL) {
1185                 cl_lock_slice_add(lock, &lck->lls_cl, obj, &lov_lock_ops);
1186                 result = lov_lock_sub_init(env, lck, io);
1187         } else
1188                 result = -ENOMEM;
1189         RETURN(result);
1190 }
1191
1192 static struct cl_lock_closure *lov_closure_get(const struct lu_env *env,
1193                                                struct cl_lock *parent)
1194 {
1195         struct cl_lock_closure *closure;
1196
1197         closure = &lov_env_info(env)->lti_closure;
1198         LASSERT(cfs_list_empty(&closure->clc_list));
1199         cl_lock_closure_init(env, closure, parent, 1);
1200         return closure;
1201 }
1202
1203
1204 /** @} lov */