4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2008, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2017, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
31 * Implementation of cl_lock for LOV layer.
33 * Author: Nikita Danilov <nikita.danilov@sun.com>
36 #define DEBUG_SUBSYSTEM S_LOV
38 #include "lov_cl_internal.h"
44 /*****************************************************************************
46 * Lov lock operations.
50 static struct lov_sublock_env *lov_sublock_env_get(const struct lu_env *env,
51 const struct cl_lock *parent,
52 struct lov_lock_sub *lls)
54 struct lov_sublock_env *subenv;
55 struct lov_io *lio = lov_env_io(env);
56 struct cl_io *io = lio->lis_cl.cis_io;
57 struct lov_io_sub *sub;
59 subenv = &lov_env_session(env)->ls_subenv;
62 * FIXME: We tend to use the subio's env & io to call the sublock
63 * lock operations because osc lock sometimes stores some control
64 * variables in thread's IO infomation(Now only lockless information).
65 * However, if the lock's host(object) is different from the object
66 * for current IO, we have no way to get the subenv and subio because
67 * they are not initialized at all. As a temp fix, in this case,
68 * we still borrow the parent's env to call sublock operations.
70 if (!io || !cl_object_same(io->ci_obj, parent->cll_descr.cld_obj)) {
71 subenv->lse_env = env;
74 sub = lov_sub_get(env, lio, lls->sub_index);
76 subenv->lse_env = sub->sub_env;
77 subenv->lse_io = &sub->sub_io;
85 static int lov_sublock_init(const struct lu_env *env,
86 const struct cl_lock *parent,
87 struct lov_lock_sub *lls)
89 struct lov_sublock_env *subenv;
94 subenv = lov_sublock_env_get(env, parent, lls);
95 if (!IS_ERR(subenv)) {
96 result = cl_lock_init(subenv->lse_env, &lls->sub_lock,
100 result = PTR_ERR(subenv);
106 * Creates sub-locks for a given lov_lock for the first time.
108 * Goes through all sub-objects of top-object, and creates sub-locks on every
109 * sub-object intersecting with top-lock extent. This is complicated by the
110 * fact that top-lock (that is being created) can be accessed concurrently
111 * through already created sub-locks (possibly shared with other top-locks).
113 static struct lov_lock *lov_lock_sub_init(const struct lu_env *env,
114 const struct cl_io *io,
115 const struct cl_object *obj,
116 struct cl_lock *lock)
118 struct lov_object *lov = cl2lov(obj);
119 struct lov_io *lio = lov_env_io(env);
120 bool is_trunc = cl_io_is_trunc(io);
121 struct lov_lock *lovlck;
122 struct lu_extent ext;
132 LASSERT(ergo(is_trunc, lio->lis_trunc_stripe_index != NULL));
134 ext.e_start = lock->cll_descr.cld_start << PAGE_SHIFT;
135 if (lock->cll_descr.cld_end == CL_PAGE_EOF)
136 ext.e_end = OBD_OBJECT_EOF;
138 ext.e_end = (lock->cll_descr.cld_end + 1) << PAGE_SHIFT;
141 lov_foreach_io_layout(index, lio, &ext) {
142 struct lov_layout_raid0 *r0 = lov_r0(lov, index);
144 for (i = 0; i < r0->lo_nr; i++) {
145 if (likely(r0->lo_sub[i])) {/* spare layout */
146 if (lov_stripe_intersects(lov->lo_lsm, index, i, &ext, &start, &end) ||
147 (is_trunc && i == lio->lis_trunc_stripe_index[index]))
153 * Aggressive lock request (from cl_setattr_ost) which asks for
154 * [eof, -1) lock, could come across uninstantiated layout extent,
155 * hence a 0 nr is possible.
158 OBD_ALLOC_LARGE(lovlck, offsetof(struct lov_lock, lls_sub[nr]));
160 RETURN(ERR_PTR(-ENOMEM));
164 lov_foreach_io_layout(index, lov_env_io(env), &ext) {
165 struct lov_layout_raid0 *r0 = lov_r0(lov, index);
167 for (i = 0; i < r0->lo_nr; ++i) {
168 struct lov_lock_sub *lls;
169 struct cl_lock_descr *descr;
171 if (unlikely(!r0->lo_sub[i]))
174 if (lov_stripe_intersects(lov->lo_lsm, index, i, &ext, &start, &end) ||
175 (is_trunc && i == lio->lis_trunc_stripe_index[index]))
180 LASSERT(nr < lovlck->lls_nr);
181 lls = &lovlck->lls_sub[nr];
182 descr = &lls->sub_lock.cll_descr;
183 LASSERT(descr->cld_obj == NULL);
184 descr->cld_obj = lovsub2cl(r0->lo_sub[i]);
185 descr->cld_start = start >> PAGE_SHIFT;
186 descr->cld_end = end >> PAGE_SHIFT;
187 descr->cld_mode = lock->cll_descr.cld_mode;
188 descr->cld_gid = lock->cll_descr.cld_gid;
189 descr->cld_enq_flags = lock->cll_descr.cld_enq_flags;
191 lls->sub_index = lov_comp_index(index, i);
193 /* initialize sub lock */
194 result = lov_sublock_init(env, lock, lls);
198 lls->sub_initialized = 1;
204 LASSERT(ergo(result == 0, nr == lovlck->lls_nr));
207 for (i = 0; i < nr; ++i) {
208 if (!lovlck->lls_sub[i].sub_initialized)
211 cl_lock_fini(env, &lovlck->lls_sub[i].sub_lock);
214 OBD_FREE_LARGE(lovlck,
215 offsetof(struct lov_lock, lls_sub[nr]));
216 lovlck = ERR_PTR(result);
222 static void lov_lock_fini(const struct lu_env *env,
223 struct cl_lock_slice *slice)
225 struct lov_lock *lovlck;
229 lovlck = cl2lov_lock(slice);
230 for (i = 0; i < lovlck->lls_nr; ++i) {
231 LASSERT(!lovlck->lls_sub[i].sub_is_enqueued);
232 if (lovlck->lls_sub[i].sub_initialized)
233 cl_lock_fini(env, &lovlck->lls_sub[i].sub_lock);
235 OBD_FREE_LARGE(lovlck,
236 offsetof(struct lov_lock, lls_sub[lovlck->lls_nr]));
241 * Implementation of cl_lock_operations::clo_enqueue() for lov layer. This
242 * function is rather subtle, as it enqueues top-lock (i.e., advances top-lock
243 * state machine from CLS_QUEUING to CLS_ENQUEUED states) by juggling sub-lock
244 * state machines in the face of sub-locks sharing (by multiple top-locks),
245 * and concurrent sub-lock cancellations.
247 static int lov_lock_enqueue(const struct lu_env *env,
248 const struct cl_lock_slice *slice,
249 struct cl_io *io, struct cl_sync_io *anchor)
251 struct cl_lock *lock = slice->cls_lock;
252 struct lov_lock *lovlck = cl2lov_lock(slice);
258 for (i = 0; i < lovlck->lls_nr; ++i) {
259 struct lov_lock_sub *lls = &lovlck->lls_sub[i];
260 struct lov_sublock_env *subenv;
262 subenv = lov_sublock_env_get(env, lock, lls);
263 if (IS_ERR(subenv)) {
264 rc = PTR_ERR(subenv);
268 rc = cl_lock_enqueue(subenv->lse_env, subenv->lse_io,
269 &lls->sub_lock, anchor);
273 lls->sub_is_enqueued = 1;
278 static void lov_lock_cancel(const struct lu_env *env,
279 const struct cl_lock_slice *slice)
281 struct cl_lock *lock = slice->cls_lock;
282 struct lov_lock *lovlck = cl2lov_lock(slice);
287 for (i = 0; i < lovlck->lls_nr; ++i) {
288 struct lov_lock_sub *lls = &lovlck->lls_sub[i];
289 struct cl_lock *sublock = &lls->sub_lock;
290 struct lov_sublock_env *subenv;
292 if (!lls->sub_is_enqueued)
295 lls->sub_is_enqueued = 0;
296 subenv = lov_sublock_env_get(env, lock, lls);
297 if (!IS_ERR(subenv)) {
298 cl_lock_cancel(subenv->lse_env, sublock);
300 CL_LOCK_DEBUG(D_ERROR, env, slice->cls_lock,
301 "lov_lock_cancel fails with %ld.\n",
307 static int lov_lock_print(const struct lu_env *env, void *cookie,
308 lu_printer_t p, const struct cl_lock_slice *slice)
310 struct lov_lock *lck = cl2lov_lock(slice);
313 (*p)(env, cookie, "%d\n", lck->lls_nr);
314 for (i = 0; i < lck->lls_nr; ++i) {
315 struct lov_lock_sub *sub;
317 sub = &lck->lls_sub[i];
318 (*p)(env, cookie, " %d %x: ", i, sub->sub_is_enqueued);
319 cl_lock_print(env, cookie, p, &sub->sub_lock);
324 static const struct cl_lock_operations lov_lock_ops = {
325 .clo_fini = lov_lock_fini,
326 .clo_enqueue = lov_lock_enqueue,
327 .clo_cancel = lov_lock_cancel,
328 .clo_print = lov_lock_print
331 int lov_lock_init_composite(const struct lu_env *env, struct cl_object *obj,
332 struct cl_lock *lock, const struct cl_io *io)
334 struct lov_lock *lck;
338 lck = lov_lock_sub_init(env, io, obj, lock);
340 cl_lock_slice_add(lock, &lck->lls_cl, obj, &lov_lock_ops);
342 result = PTR_ERR(lck);
346 static void lov_empty_lock_fini(const struct lu_env *env,
347 struct cl_lock_slice *slice)
349 struct lov_lock *lck = cl2lov_lock(slice);
351 OBD_SLAB_FREE_PTR(lck, lov_lock_kmem);
354 static int lov_empty_lock_print(const struct lu_env *env, void *cookie,
355 lu_printer_t p, const struct cl_lock_slice *slice)
357 (*p)(env, cookie, "empty\n");
361 /* XXX: more methods will be added later. */
362 static const struct cl_lock_operations lov_empty_lock_ops = {
363 .clo_fini = lov_empty_lock_fini,
364 .clo_print = lov_empty_lock_print
367 int lov_lock_init_empty(const struct lu_env *env, struct cl_object *obj,
368 struct cl_lock *lock, const struct cl_io *io)
370 struct lov_lock *lck;
371 int result = -ENOMEM;
374 OBD_SLAB_ALLOC_PTR_GFP(lck, lov_lock_kmem, GFP_NOFS);
376 cl_lock_slice_add(lock, &lck->lls_cl, obj, &lov_empty_lock_ops);