Linux-libre 3.14.42-gnu
[librecmc/linux-libre.git] / drivers / staging / lustre / lustre / lov / lov_object.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, Intel Corporation.
31  */
32 /*
33  * This file is part of Lustre, http://www.lustre.org/
34  * Lustre is a trademark of Sun Microsystems, Inc.
35  *
36  * Implementation of cl_object for LOV layer.
37  *
38  *   Author: Nikita Danilov <nikita.danilov@sun.com>
39  *   Author: Jinshan Xiong <jinshan.xiong@whamcloud.com>
40  */
41
42 #define DEBUG_SUBSYSTEM S_LOV
43
44 #include "lov_cl_internal.h"
45 #include <lustre_debug.h>
46
47 /** \addtogroup lov
48  *  @{
49  */
50
51 /*****************************************************************************
52  *
53  * Layout operations.
54  *
55  */
56
57 struct lov_layout_operations {
58         int (*llo_init)(const struct lu_env *env, struct lov_device *dev,
59                         struct lov_object *lov,
60                         const struct cl_object_conf *conf,
61                         union lov_layout_state *state);
62         int (*llo_delete)(const struct lu_env *env, struct lov_object *lov,
63                            union lov_layout_state *state);
64         void (*llo_fini)(const struct lu_env *env, struct lov_object *lov,
65                          union lov_layout_state *state);
66         void (*llo_install)(const struct lu_env *env, struct lov_object *lov,
67                             union lov_layout_state *state);
68         int  (*llo_print)(const struct lu_env *env, void *cookie,
69                           lu_printer_t p, const struct lu_object *o);
70         int  (*llo_page_init)(const struct lu_env *env, struct cl_object *obj,
71                                 struct cl_page *page, struct page *vmpage);
72         int  (*llo_lock_init)(const struct lu_env *env,
73                               struct cl_object *obj, struct cl_lock *lock,
74                               const struct cl_io *io);
75         int  (*llo_io_init)(const struct lu_env *env,
76                             struct cl_object *obj, struct cl_io *io);
77         int  (*llo_getattr)(const struct lu_env *env, struct cl_object *obj,
78                             struct cl_attr *attr);
79 };
80
81 static int lov_layout_wait(const struct lu_env *env, struct lov_object *lov);
82
83 /*****************************************************************************
84  *
85  * Lov object layout operations.
86  *
87  */
88
89 static void lov_install_empty(const struct lu_env *env,
90                               struct lov_object *lov,
91                               union  lov_layout_state *state)
92 {
93         /*
94          * File without objects.
95          */
96 }
97
98 static int lov_init_empty(const struct lu_env *env,
99                           struct lov_device *dev, struct lov_object *lov,
100                           const struct cl_object_conf *conf,
101                           union  lov_layout_state *state)
102 {
103         return 0;
104 }
105
106 static void lov_install_raid0(const struct lu_env *env,
107                               struct lov_object *lov,
108                               union  lov_layout_state *state)
109 {
110 }
111
112 static struct cl_object *lov_sub_find(const struct lu_env *env,
113                                       struct cl_device *dev,
114                                       const struct lu_fid *fid,
115                                       const struct cl_object_conf *conf)
116 {
117         struct lu_object *o;
118
119         o = lu_object_find_at(env, cl2lu_dev(dev), fid, &conf->coc_lu);
120         LASSERT(ergo(!IS_ERR(o), o->lo_dev->ld_type == &lovsub_device_type));
121         return lu2cl(o);
122 }
123
124 static int lov_init_sub(const struct lu_env *env, struct lov_object *lov,
125                         struct cl_object *stripe,
126                         struct lov_layout_raid0 *r0, int idx)
127 {
128         struct cl_object_header *hdr;
129         struct cl_object_header *subhdr;
130         struct cl_object_header *parent;
131         struct lov_oinfo        *oinfo;
132         int result;
133
134         if (OBD_FAIL_CHECK(OBD_FAIL_LOV_INIT)) {
135                 /* For sanity:test_206.
136                  * Do not leave the object in cache to avoid accessing
137                  * freed memory. This is because osc_object is referring to
138                  * lov_oinfo of lsm_stripe_data which will be freed due to
139                  * this failure. */
140                 cl_object_kill(env, stripe);
141                 cl_object_put(env, stripe);
142                 return -EIO;
143         }
144
145         hdr    = cl_object_header(lov2cl(lov));
146         subhdr = cl_object_header(stripe);
147         parent = subhdr->coh_parent;
148
149         oinfo = lov->lo_lsm->lsm_oinfo[idx];
150         CDEBUG(D_INODE, DFID"@%p[%d] -> "DFID"@%p: ostid: "DOSTID
151                " idx: %d gen: %d\n",
152                PFID(&subhdr->coh_lu.loh_fid), subhdr, idx,
153                PFID(&hdr->coh_lu.loh_fid), hdr, POSTID(&oinfo->loi_oi),
154                oinfo->loi_ost_idx, oinfo->loi_ost_gen);
155
156         if (parent == NULL) {
157                 subhdr->coh_parent = hdr;
158                 subhdr->coh_nesting = hdr->coh_nesting + 1;
159                 lu_object_ref_add(&stripe->co_lu, "lov-parent", lov);
160                 r0->lo_sub[idx] = cl2lovsub(stripe);
161                 r0->lo_sub[idx]->lso_super = lov;
162                 r0->lo_sub[idx]->lso_index = idx;
163                 result = 0;
164         } else {
165                 struct lu_object  *old_obj;
166                 struct lov_object *old_lov;
167                 unsigned int mask = D_INODE;
168
169                 old_obj = lu_object_locate(&parent->coh_lu, &lov_device_type);
170                 LASSERT(old_obj != NULL);
171                 old_lov = cl2lov(lu2cl(old_obj));
172                 if (old_lov->lo_layout_invalid) {
173                         /* the object's layout has already changed but isn't
174                          * refreshed */
175                         lu_object_unhash(env, &stripe->co_lu);
176                         result = -EAGAIN;
177                 } else {
178                         mask = D_ERROR;
179                         result = -EIO;
180                 }
181
182                 LU_OBJECT_DEBUG(mask, env, &stripe->co_lu,
183                                 "stripe %d is already owned.\n", idx);
184                 LU_OBJECT_DEBUG(mask, env, old_obj, "owned.\n");
185                 LU_OBJECT_HEADER(mask, env, lov2lu(lov), "try to own.\n");
186                 cl_object_put(env, stripe);
187         }
188         return result;
189 }
190
191 static int lov_init_raid0(const struct lu_env *env,
192                           struct lov_device *dev, struct lov_object *lov,
193                           const struct cl_object_conf *conf,
194                           union  lov_layout_state *state)
195 {
196         int result;
197         int i;
198
199         struct cl_object        *stripe;
200         struct lov_thread_info  *lti     = lov_env_info(env);
201         struct cl_object_conf   *subconf = &lti->lti_stripe_conf;
202         struct lov_stripe_md    *lsm     = conf->u.coc_md->lsm;
203         struct lu_fid      *ofid    = &lti->lti_fid;
204         struct lov_layout_raid0 *r0      = &state->raid0;
205
206         if (lsm->lsm_magic != LOV_MAGIC_V1 && lsm->lsm_magic != LOV_MAGIC_V3) {
207                 dump_lsm(D_ERROR, lsm);
208                 LASSERTF(0, "magic mismatch, expected %d/%d, actual %d.\n",
209                          LOV_MAGIC_V1, LOV_MAGIC_V3, lsm->lsm_magic);
210         }
211
212         LASSERT(lov->lo_lsm == NULL);
213         lov->lo_lsm = lsm_addref(lsm);
214         r0->lo_nr  = lsm->lsm_stripe_count;
215         LASSERT(r0->lo_nr <= lov_targets_nr(dev));
216
217         OBD_ALLOC_LARGE(r0->lo_sub, r0->lo_nr * sizeof(r0->lo_sub[0]));
218         if (r0->lo_sub != NULL) {
219                 result = 0;
220                 subconf->coc_inode = conf->coc_inode;
221                 spin_lock_init(&r0->lo_sub_lock);
222                 /*
223                  * Create stripe cl_objects.
224                  */
225                 for (i = 0; i < r0->lo_nr && result == 0; ++i) {
226                         struct cl_device *subdev;
227                         struct lov_oinfo *oinfo = lsm->lsm_oinfo[i];
228                         int ost_idx = oinfo->loi_ost_idx;
229
230                         result = ostid_to_fid(ofid, &oinfo->loi_oi,
231                                               oinfo->loi_ost_idx);
232                         if (result != 0)
233                                 GOTO(out, result);
234
235                         subdev = lovsub2cl_dev(dev->ld_target[ost_idx]);
236                         subconf->u.coc_oinfo = oinfo;
237                         LASSERTF(subdev != NULL, "not init ost %d\n", ost_idx);
238                         /* In the function below, .hs_keycmp resolves to
239                          * lu_obj_hop_keycmp() */
240                         /* coverity[overrun-buffer-val] */
241                         stripe = lov_sub_find(env, subdev, ofid, subconf);
242                         if (!IS_ERR(stripe)) {
243                                 result = lov_init_sub(env, lov, stripe, r0, i);
244                                 if (result == -EAGAIN) { /* try again */
245                                         --i;
246                                         result = 0;
247                                 }
248                         } else {
249                                 result = PTR_ERR(stripe);
250                         }
251                 }
252         } else
253                 result = -ENOMEM;
254 out:
255         return result;
256 }
257
258 static int lov_init_released(const struct lu_env *env,
259                         struct lov_device *dev, struct lov_object *lov,
260                         const struct cl_object_conf *conf,
261                         union  lov_layout_state *state)
262 {
263         struct lov_stripe_md *lsm = conf->u.coc_md->lsm;
264
265         LASSERT(lsm != NULL);
266         LASSERT(lsm_is_released(lsm));
267         LASSERT(lov->lo_lsm == NULL);
268
269         lov->lo_lsm = lsm_addref(lsm);
270         return 0;
271 }
272
273 static int lov_delete_empty(const struct lu_env *env, struct lov_object *lov,
274                             union lov_layout_state *state)
275 {
276         LASSERT(lov->lo_type == LLT_EMPTY || lov->lo_type == LLT_RELEASED);
277
278         lov_layout_wait(env, lov);
279
280         cl_object_prune(env, &lov->lo_cl);
281         return 0;
282 }
283
284 static void lov_subobject_kill(const struct lu_env *env, struct lov_object *lov,
285                                struct lovsub_object *los, int idx)
286 {
287         struct cl_object        *sub;
288         struct lov_layout_raid0 *r0;
289         struct lu_site    *site;
290         struct lu_site_bkt_data *bkt;
291         wait_queue_t      *waiter;
292
293         r0  = &lov->u.raid0;
294         LASSERT(r0->lo_sub[idx] == los);
295
296         sub  = lovsub2cl(los);
297         site = sub->co_lu.lo_dev->ld_site;
298         bkt  = lu_site_bkt_from_fid(site, &sub->co_lu.lo_header->loh_fid);
299
300         cl_object_kill(env, sub);
301         /* release a reference to the sub-object and ... */
302         lu_object_ref_del(&sub->co_lu, "lov-parent", lov);
303         cl_object_put(env, sub);
304
305         /* ... wait until it is actually destroyed---sub-object clears its
306          * ->lo_sub[] slot in lovsub_object_fini() */
307         if (r0->lo_sub[idx] == los) {
308                 waiter = &lov_env_info(env)->lti_waiter;
309                 init_waitqueue_entry_current(waiter);
310                 add_wait_queue(&bkt->lsb_marche_funebre, waiter);
311                 set_current_state(TASK_UNINTERRUPTIBLE);
312                 while (1) {
313                         /* this wait-queue is signaled at the end of
314                          * lu_object_free(). */
315                         set_current_state(TASK_UNINTERRUPTIBLE);
316                         spin_lock(&r0->lo_sub_lock);
317                         if (r0->lo_sub[idx] == los) {
318                                 spin_unlock(&r0->lo_sub_lock);
319                                 waitq_wait(waiter, TASK_UNINTERRUPTIBLE);
320                         } else {
321                                 spin_unlock(&r0->lo_sub_lock);
322                                 set_current_state(TASK_RUNNING);
323                                 break;
324                         }
325                 }
326                 remove_wait_queue(&bkt->lsb_marche_funebre, waiter);
327         }
328         LASSERT(r0->lo_sub[idx] == NULL);
329 }
330
331 static int lov_delete_raid0(const struct lu_env *env, struct lov_object *lov,
332                             union lov_layout_state *state)
333 {
334         struct lov_layout_raid0 *r0 = &state->raid0;
335         struct lov_stripe_md    *lsm = lov->lo_lsm;
336         int i;
337
338         dump_lsm(D_INODE, lsm);
339
340         lov_layout_wait(env, lov);
341         if (r0->lo_sub != NULL) {
342                 for (i = 0; i < r0->lo_nr; ++i) {
343                         struct lovsub_object *los = r0->lo_sub[i];
344
345                         if (los != NULL) {
346                                 cl_locks_prune(env, &los->lso_cl, 1);
347                                 /*
348                                  * If top-level object is to be evicted from
349                                  * the cache, so are its sub-objects.
350                                  */
351                                 lov_subobject_kill(env, lov, los, i);
352                         }
353                 }
354         }
355         cl_object_prune(env, &lov->lo_cl);
356         return 0;
357 }
358
359 static void lov_fini_empty(const struct lu_env *env, struct lov_object *lov,
360                            union lov_layout_state *state)
361 {
362         LASSERT(lov->lo_type == LLT_EMPTY || lov->lo_type == LLT_RELEASED);
363 }
364
365 static void lov_fini_raid0(const struct lu_env *env, struct lov_object *lov,
366                            union lov_layout_state *state)
367 {
368         struct lov_layout_raid0 *r0 = &state->raid0;
369
370         if (r0->lo_sub != NULL) {
371                 OBD_FREE_LARGE(r0->lo_sub, r0->lo_nr * sizeof(r0->lo_sub[0]));
372                 r0->lo_sub = NULL;
373         }
374
375         dump_lsm(D_INODE, lov->lo_lsm);
376         lov_free_memmd(&lov->lo_lsm);
377 }
378
379 static void lov_fini_released(const struct lu_env *env, struct lov_object *lov,
380                                 union lov_layout_state *state)
381 {
382         dump_lsm(D_INODE, lov->lo_lsm);
383         lov_free_memmd(&lov->lo_lsm);
384 }
385
386 static int lov_print_empty(const struct lu_env *env, void *cookie,
387                            lu_printer_t p, const struct lu_object *o)
388 {
389         (*p)(env, cookie, "empty %d\n", lu2lov(o)->lo_layout_invalid);
390         return 0;
391 }
392
393 static int lov_print_raid0(const struct lu_env *env, void *cookie,
394                            lu_printer_t p, const struct lu_object *o)
395 {
396         struct lov_object       *lov = lu2lov(o);
397         struct lov_layout_raid0 *r0  = lov_r0(lov);
398         struct lov_stripe_md    *lsm = lov->lo_lsm;
399         int                      i;
400
401         (*p)(env, cookie, "stripes: %d, %s, lsm{%p 0x%08X %d %u %u}:\n",
402                 r0->lo_nr, lov->lo_layout_invalid ? "invalid" : "valid", lsm,
403                 lsm->lsm_magic, atomic_read(&lsm->lsm_refc),
404                 lsm->lsm_stripe_count, lsm->lsm_layout_gen);
405         for (i = 0; i < r0->lo_nr; ++i) {
406                 struct lu_object *sub;
407
408                 if (r0->lo_sub[i] != NULL) {
409                         sub = lovsub2lu(r0->lo_sub[i]);
410                         lu_object_print(env, cookie, p, sub);
411                 } else {
412                         (*p)(env, cookie, "sub %d absent\n", i);
413                 }
414         }
415         return 0;
416 }
417
418 static int lov_print_released(const struct lu_env *env, void *cookie,
419                                 lu_printer_t p, const struct lu_object *o)
420 {
421         struct lov_object       *lov = lu2lov(o);
422         struct lov_stripe_md    *lsm = lov->lo_lsm;
423
424         (*p)(env, cookie,
425                 "released: %s, lsm{%p 0x%08X %d %u %u}:\n",
426                 lov->lo_layout_invalid ? "invalid" : "valid", lsm,
427                 lsm->lsm_magic, atomic_read(&lsm->lsm_refc),
428                 lsm->lsm_stripe_count, lsm->lsm_layout_gen);
429         return 0;
430 }
431
432 /**
433  * Implements cl_object_operations::coo_attr_get() method for an object
434  * without stripes (LLT_EMPTY layout type).
435  *
436  * The only attributes this layer is authoritative in this case is
437  * cl_attr::cat_blocks---it's 0.
438  */
439 static int lov_attr_get_empty(const struct lu_env *env, struct cl_object *obj,
440                               struct cl_attr *attr)
441 {
442         attr->cat_blocks = 0;
443         return 0;
444 }
445
446 static int lov_attr_get_raid0(const struct lu_env *env, struct cl_object *obj,
447                               struct cl_attr *attr)
448 {
449         struct lov_object       *lov = cl2lov(obj);
450         struct lov_layout_raid0 *r0 = lov_r0(lov);
451         struct cl_attr          *lov_attr = &r0->lo_attr;
452         int                      result = 0;
453
454         /* this is called w/o holding type guard mutex, so it must be inside
455          * an on going IO otherwise lsm may be replaced.
456          * LU-2117: it turns out there exists one exception. For mmaped files,
457          * the lock of those files may be requested in the other file's IO
458          * context, and this function is called in ccc_lock_state(), it will
459          * hit this assertion.
460          * Anyway, it's still okay to call attr_get w/o type guard as layout
461          * can't go if locks exist. */
462         /* LASSERT(atomic_read(&lsm->lsm_refc) > 1); */
463
464         if (!r0->lo_attr_valid) {
465                 struct lov_stripe_md    *lsm = lov->lo_lsm;
466                 struct ost_lvb    *lvb = &lov_env_info(env)->lti_lvb;
467                 __u64               kms = 0;
468
469                 memset(lvb, 0, sizeof(*lvb));
470                 /* XXX: timestamps can be negative by sanity:test_39m,
471                  * how can it be? */
472                 lvb->lvb_atime = LLONG_MIN;
473                 lvb->lvb_ctime = LLONG_MIN;
474                 lvb->lvb_mtime = LLONG_MIN;
475
476                 /*
477                  * XXX that should be replaced with a loop over sub-objects,
478                  * doing cl_object_attr_get() on them. But for now, let's
479                  * reuse old lov code.
480                  */
481
482                 /*
483                  * XXX take lsm spin-lock to keep lov_merge_lvb_kms()
484                  * happy. It's not needed, because new code uses
485                  * ->coh_attr_guard spin-lock to protect consistency of
486                  * sub-object attributes.
487                  */
488                 lov_stripe_lock(lsm);
489                 result = lov_merge_lvb_kms(lsm, lvb, &kms);
490                 lov_stripe_unlock(lsm);
491                 if (result == 0) {
492                         cl_lvb2attr(lov_attr, lvb);
493                         lov_attr->cat_kms = kms;
494                         r0->lo_attr_valid = 1;
495                 }
496         }
497         if (result == 0) { /* merge results */
498                 attr->cat_blocks = lov_attr->cat_blocks;
499                 attr->cat_size = lov_attr->cat_size;
500                 attr->cat_kms = lov_attr->cat_kms;
501                 if (attr->cat_atime < lov_attr->cat_atime)
502                         attr->cat_atime = lov_attr->cat_atime;
503                 if (attr->cat_ctime < lov_attr->cat_ctime)
504                         attr->cat_ctime = lov_attr->cat_ctime;
505                 if (attr->cat_mtime < lov_attr->cat_mtime)
506                         attr->cat_mtime = lov_attr->cat_mtime;
507         }
508         return result;
509 }
510
511 const static struct lov_layout_operations lov_dispatch[] = {
512         [LLT_EMPTY] = {
513                 .llo_init      = lov_init_empty,
514                 .llo_delete    = lov_delete_empty,
515                 .llo_fini      = lov_fini_empty,
516                 .llo_install   = lov_install_empty,
517                 .llo_print     = lov_print_empty,
518                 .llo_page_init = lov_page_init_empty,
519                 .llo_lock_init = lov_lock_init_empty,
520                 .llo_io_init   = lov_io_init_empty,
521                 .llo_getattr   = lov_attr_get_empty
522         },
523         [LLT_RAID0] = {
524                 .llo_init      = lov_init_raid0,
525                 .llo_delete    = lov_delete_raid0,
526                 .llo_fini      = lov_fini_raid0,
527                 .llo_install   = lov_install_raid0,
528                 .llo_print     = lov_print_raid0,
529                 .llo_page_init = lov_page_init_raid0,
530                 .llo_lock_init = lov_lock_init_raid0,
531                 .llo_io_init   = lov_io_init_raid0,
532                 .llo_getattr   = lov_attr_get_raid0
533         },
534         [LLT_RELEASED] = {
535                 .llo_init      = lov_init_released,
536                 .llo_delete    = lov_delete_empty,
537                 .llo_fini      = lov_fini_released,
538                 .llo_install   = lov_install_empty,
539                 .llo_print     = lov_print_released,
540                 .llo_page_init = lov_page_init_empty,
541                 .llo_lock_init = lov_lock_init_empty,
542                 .llo_io_init   = lov_io_init_released,
543                 .llo_getattr   = lov_attr_get_empty
544         }
545 };
546
547 /**
548  * Performs a double-dispatch based on the layout type of an object.
549  */
550 #define LOV_2DISPATCH_NOLOCK(obj, op, ...)                            \
551 ({                                                                    \
552         struct lov_object                     *__obj = (obj);     \
553         enum lov_layout_type                __llt;                \
554                                                                         \
555         __llt = __obj->lo_type;                                  \
556         LASSERT(0 <= __llt && __llt < ARRAY_SIZE(lov_dispatch));        \
557         lov_dispatch[__llt].op(__VA_ARGS__);                        \
558 })
559
560 /**
561  * Return lov_layout_type associated with a given lsm
562  */
563 enum lov_layout_type lov_type(struct lov_stripe_md *lsm)
564 {
565         if (lsm == NULL)
566                 return LLT_EMPTY;
567         if (lsm_is_released(lsm))
568                 return LLT_RELEASED;
569         return LLT_RAID0;
570 }
571
572 static inline void lov_conf_freeze(struct lov_object *lov)
573 {
574         if (lov->lo_owner != current)
575                 down_read(&lov->lo_type_guard);
576 }
577
578 static inline void lov_conf_thaw(struct lov_object *lov)
579 {
580         if (lov->lo_owner != current)
581                 up_read(&lov->lo_type_guard);
582 }
583
584 #define LOV_2DISPATCH_MAYLOCK(obj, op, lock, ...)                      \
585 ({                                                                    \
586         struct lov_object                     *__obj = (obj);     \
587         int                                  __lock = !!(lock);      \
588         typeof(lov_dispatch[0].op(__VA_ARGS__)) __result;              \
589                                                                         \
590         if (__lock)                                                  \
591                 lov_conf_freeze(__obj);                                 \
592         __result = LOV_2DISPATCH_NOLOCK(obj, op, __VA_ARGS__);    \
593         if (__lock)                                                  \
594                 lov_conf_thaw(__obj);                                   \
595         __result;                                                      \
596 })
597
598 /**
599  * Performs a locked double-dispatch based on the layout type of an object.
600  */
601 #define LOV_2DISPATCH(obj, op, ...)                  \
602         LOV_2DISPATCH_MAYLOCK(obj, op, 1, __VA_ARGS__)
603
604 #define LOV_2DISPATCH_VOID(obj, op, ...)                                \
605 do {                                                                \
606         struct lov_object                     *__obj = (obj);     \
607         enum lov_layout_type                __llt;                \
608                                                                         \
609         lov_conf_freeze(__obj);                                         \
610         __llt = __obj->lo_type;                                  \
611         LASSERT(0 <= __llt && __llt < ARRAY_SIZE(lov_dispatch));        \
612         lov_dispatch[__llt].op(__VA_ARGS__);                        \
613         lov_conf_thaw(__obj);                                           \
614 } while (0)
615
616 static void lov_conf_lock(struct lov_object *lov)
617 {
618         LASSERT(lov->lo_owner != current);
619         down_write(&lov->lo_type_guard);
620         LASSERT(lov->lo_owner == NULL);
621         lov->lo_owner = current;
622 }
623
624 static void lov_conf_unlock(struct lov_object *lov)
625 {
626         lov->lo_owner = NULL;
627         up_write(&lov->lo_type_guard);
628 }
629
630 static int lov_layout_wait(const struct lu_env *env, struct lov_object *lov)
631 {
632         struct l_wait_info lwi = { 0 };
633
634         while (atomic_read(&lov->lo_active_ios) > 0) {
635                 CDEBUG(D_INODE, "file:"DFID" wait for active IO, now: %d.\n",
636                         PFID(lu_object_fid(lov2lu(lov))),
637                         atomic_read(&lov->lo_active_ios));
638
639                 l_wait_event(lov->lo_waitq,
640                              atomic_read(&lov->lo_active_ios) == 0, &lwi);
641         }
642         return 0;
643 }
644
645 static int lov_layout_change(const struct lu_env *unused,
646                              struct lov_object *lov,
647                              const struct cl_object_conf *conf)
648 {
649         int result;
650         enum lov_layout_type llt = LLT_EMPTY;
651         union lov_layout_state *state = &lov->u;
652         const struct lov_layout_operations *old_ops;
653         const struct lov_layout_operations *new_ops;
654
655         struct cl_object_header *hdr = cl_object_header(&lov->lo_cl);
656         void *cookie;
657         struct lu_env *env;
658         int refcheck;
659
660         LASSERT(0 <= lov->lo_type && lov->lo_type < ARRAY_SIZE(lov_dispatch));
661
662         if (conf->u.coc_md != NULL)
663                 llt = lov_type(conf->u.coc_md->lsm);
664         LASSERT(0 <= llt && llt < ARRAY_SIZE(lov_dispatch));
665
666         cookie = cl_env_reenter();
667         env = cl_env_get(&refcheck);
668         if (IS_ERR(env)) {
669                 cl_env_reexit(cookie);
670                 return PTR_ERR(env);
671         }
672
673         CDEBUG(D_INODE, DFID" from %s to %s\n",
674                PFID(lu_object_fid(lov2lu(lov))),
675                llt2str(lov->lo_type), llt2str(llt));
676
677         old_ops = &lov_dispatch[lov->lo_type];
678         new_ops = &lov_dispatch[llt];
679
680         result = old_ops->llo_delete(env, lov, &lov->u);
681         if (result == 0) {
682                 old_ops->llo_fini(env, lov, &lov->u);
683
684                 LASSERT(atomic_read(&lov->lo_active_ios) == 0);
685                 LASSERT(hdr->coh_tree.rnode == NULL);
686                 LASSERT(hdr->coh_pages == 0);
687
688                 lov->lo_type = LLT_EMPTY;
689                 result = new_ops->llo_init(env,
690                                         lu2lov_dev(lov->lo_cl.co_lu.lo_dev),
691                                         lov, conf, state);
692                 if (result == 0) {
693                         new_ops->llo_install(env, lov, state);
694                         lov->lo_type = llt;
695                 } else {
696                         new_ops->llo_delete(env, lov, state);
697                         new_ops->llo_fini(env, lov, state);
698                         /* this file becomes an EMPTY file. */
699                 }
700         }
701
702         cl_env_put(env, &refcheck);
703         cl_env_reexit(cookie);
704         return result;
705 }
706
707 /*****************************************************************************
708  *
709  * Lov object operations.
710  *
711  */
712 int lov_object_init(const struct lu_env *env, struct lu_object *obj,
713                     const struct lu_object_conf *conf)
714 {
715         struct lov_device           *dev   = lu2lov_dev(obj->lo_dev);
716         struct lov_object           *lov   = lu2lov(obj);
717         const struct cl_object_conf  *cconf = lu2cl_conf(conf);
718         union  lov_layout_state      *set   = &lov->u;
719         const struct lov_layout_operations *ops;
720         int result;
721
722         init_rwsem(&lov->lo_type_guard);
723         atomic_set(&lov->lo_active_ios, 0);
724         init_waitqueue_head(&lov->lo_waitq);
725
726         cl_object_page_init(lu2cl(obj), sizeof(struct lov_page));
727
728         /* no locking is necessary, as object is being created */
729         lov->lo_type = lov_type(cconf->u.coc_md->lsm);
730         ops = &lov_dispatch[lov->lo_type];
731         result = ops->llo_init(env, dev, lov, cconf, set);
732         if (result == 0)
733                 ops->llo_install(env, lov, set);
734         return result;
735 }
736
737 static int lov_conf_set(const struct lu_env *env, struct cl_object *obj,
738                         const struct cl_object_conf *conf)
739 {
740         struct lov_stripe_md    *lsm = NULL;
741         struct lov_object       *lov = cl2lov(obj);
742         int                      result = 0;
743
744         lov_conf_lock(lov);
745         if (conf->coc_opc == OBJECT_CONF_INVALIDATE) {
746                 lov->lo_layout_invalid = true;
747                 GOTO(out, result = 0);
748         }
749
750         if (conf->coc_opc == OBJECT_CONF_WAIT) {
751                 if (lov->lo_layout_invalid &&
752                     atomic_read(&lov->lo_active_ios) > 0) {
753                         lov_conf_unlock(lov);
754                         result = lov_layout_wait(env, lov);
755                         lov_conf_lock(lov);
756                 }
757                 GOTO(out, result);
758         }
759
760         LASSERT(conf->coc_opc == OBJECT_CONF_SET);
761
762         if (conf->u.coc_md != NULL)
763                 lsm = conf->u.coc_md->lsm;
764         if ((lsm == NULL && lov->lo_lsm == NULL) ||
765             ((lsm != NULL && lov->lo_lsm != NULL) &&
766              (lov->lo_lsm->lsm_layout_gen == lsm->lsm_layout_gen) &&
767              (lov->lo_lsm->lsm_pattern == lsm->lsm_pattern))) {
768                 /* same version of layout */
769                 lov->lo_layout_invalid = false;
770                 GOTO(out, result = 0);
771         }
772
773         /* will change layout - check if there still exists active IO. */
774         if (atomic_read(&lov->lo_active_ios) > 0) {
775                 lov->lo_layout_invalid = true;
776                 GOTO(out, result = -EBUSY);
777         }
778
779         lov->lo_layout_invalid = lov_layout_change(env, lov, conf);
780
781 out:
782         lov_conf_unlock(lov);
783         CDEBUG(D_INODE, DFID" lo_layout_invalid=%d\n",
784                PFID(lu_object_fid(lov2lu(lov))), lov->lo_layout_invalid);
785         return result;
786 }
787
788 static void lov_object_delete(const struct lu_env *env, struct lu_object *obj)
789 {
790         struct lov_object *lov = lu2lov(obj);
791
792         LOV_2DISPATCH_VOID(lov, llo_delete, env, lov, &lov->u);
793 }
794
795 static void lov_object_free(const struct lu_env *env, struct lu_object *obj)
796 {
797         struct lov_object *lov = lu2lov(obj);
798
799         LOV_2DISPATCH_VOID(lov, llo_fini, env, lov, &lov->u);
800         lu_object_fini(obj);
801         OBD_SLAB_FREE_PTR(lov, lov_object_kmem);
802 }
803
804 static int lov_object_print(const struct lu_env *env, void *cookie,
805                             lu_printer_t p, const struct lu_object *o)
806 {
807         return LOV_2DISPATCH_NOLOCK(lu2lov(o), llo_print, env, cookie, p, o);
808 }
809
810 int lov_page_init(const struct lu_env *env, struct cl_object *obj,
811                 struct cl_page *page, struct page *vmpage)
812 {
813         return LOV_2DISPATCH_NOLOCK(cl2lov(obj),
814                                     llo_page_init, env, obj, page, vmpage);
815 }
816
817 /**
818  * Implements cl_object_operations::clo_io_init() method for lov
819  * layer. Dispatches to the appropriate layout io initialization method.
820  */
821 int lov_io_init(const struct lu_env *env, struct cl_object *obj,
822                 struct cl_io *io)
823 {
824         CL_IO_SLICE_CLEAN(lov_env_io(env), lis_cl);
825         return LOV_2DISPATCH_MAYLOCK(cl2lov(obj), llo_io_init,
826                                      !io->ci_ignore_layout, env, obj, io);
827 }
828
829 /**
830  * An implementation of cl_object_operations::clo_attr_get() method for lov
831  * layer. For raid0 layout this collects and merges attributes of all
832  * sub-objects.
833  */
834 static int lov_attr_get(const struct lu_env *env, struct cl_object *obj,
835                         struct cl_attr *attr)
836 {
837         /* do not take lock, as this function is called under a
838          * spin-lock. Layout is protected from changing by ongoing IO. */
839         return LOV_2DISPATCH_NOLOCK(cl2lov(obj), llo_getattr, env, obj, attr);
840 }
841
842 static int lov_attr_set(const struct lu_env *env, struct cl_object *obj,
843                         const struct cl_attr *attr, unsigned valid)
844 {
845         /*
846          * No dispatch is required here, as no layout implements this.
847          */
848         return 0;
849 }
850
851 int lov_lock_init(const struct lu_env *env, struct cl_object *obj,
852                   struct cl_lock *lock, const struct cl_io *io)
853 {
854         /* No need to lock because we've taken one refcount of layout.  */
855         return LOV_2DISPATCH_NOLOCK(cl2lov(obj), llo_lock_init, env, obj, lock,
856                                     io);
857 }
858
859 static const struct cl_object_operations lov_ops = {
860         .coo_page_init = lov_page_init,
861         .coo_lock_init = lov_lock_init,
862         .coo_io_init   = lov_io_init,
863         .coo_attr_get  = lov_attr_get,
864         .coo_attr_set  = lov_attr_set,
865         .coo_conf_set  = lov_conf_set
866 };
867
868 static const struct lu_object_operations lov_lu_obj_ops = {
869         .loo_object_init      = lov_object_init,
870         .loo_object_delete    = lov_object_delete,
871         .loo_object_release   = NULL,
872         .loo_object_free      = lov_object_free,
873         .loo_object_print     = lov_object_print,
874         .loo_object_invariant = NULL
875 };
876
877 struct lu_object *lov_object_alloc(const struct lu_env *env,
878                                    const struct lu_object_header *unused,
879                                    struct lu_device *dev)
880 {
881         struct lov_object *lov;
882         struct lu_object  *obj;
883
884         OBD_SLAB_ALLOC_PTR_GFP(lov, lov_object_kmem, __GFP_IO);
885         if (lov != NULL) {
886                 obj = lov2lu(lov);
887                 lu_object_init(obj, NULL, dev);
888                 lov->lo_cl.co_ops = &lov_ops;
889                 lov->lo_type = -1; /* invalid, to catch uninitialized type */
890                 /*
891                  * object io operation vector (cl_object::co_iop) is installed
892                  * later in lov_object_init(), as different vectors are used
893                  * for object with different layouts.
894                  */
895                 obj->lo_ops = &lov_lu_obj_ops;
896         } else
897                 obj = NULL;
898         return obj;
899 }
900
901 struct lov_stripe_md *lov_lsm_addref(struct lov_object *lov)
902 {
903         struct lov_stripe_md *lsm = NULL;
904
905         lov_conf_freeze(lov);
906         if (lov->lo_lsm != NULL) {
907                 lsm = lsm_addref(lov->lo_lsm);
908                 CDEBUG(D_INODE, "lsm %p addref %d/%d by %p.\n",
909                         lsm, atomic_read(&lsm->lsm_refc),
910                         lov->lo_layout_invalid, current);
911         }
912         lov_conf_thaw(lov);
913         return lsm;
914 }
915
916 void lov_lsm_decref(struct lov_object *lov, struct lov_stripe_md *lsm)
917 {
918         if (lsm == NULL)
919                 return;
920
921         CDEBUG(D_INODE, "lsm %p decref %d by %p.\n",
922                 lsm, atomic_read(&lsm->lsm_refc), current);
923
924         lov_free_memmd(&lsm);
925 }
926
927 struct lov_stripe_md *lov_lsm_get(struct cl_object *clobj)
928 {
929         struct lu_object *luobj;
930         struct lov_stripe_md *lsm = NULL;
931
932         if (clobj == NULL)
933                 return NULL;
934
935         luobj = lu_object_locate(&cl_object_header(clobj)->coh_lu,
936                                  &lov_device_type);
937         if (luobj != NULL)
938                 lsm = lov_lsm_addref(lu2lov(luobj));
939         return lsm;
940 }
941 EXPORT_SYMBOL(lov_lsm_get);
942
943 void lov_lsm_put(struct cl_object *unused, struct lov_stripe_md *lsm)
944 {
945         if (lsm != NULL)
946                 lov_free_memmd(&lsm);
947 }
948 EXPORT_SYMBOL(lov_lsm_put);
949
950 int lov_read_and_clear_async_rc(struct cl_object *clob)
951 {
952         struct lu_object *luobj;
953         int rc = 0;
954
955         luobj = lu_object_locate(&cl_object_header(clob)->coh_lu,
956                                  &lov_device_type);
957         if (luobj != NULL) {
958                 struct lov_object *lov = lu2lov(luobj);
959
960                 lov_conf_freeze(lov);
961                 switch (lov->lo_type) {
962                 case LLT_RAID0: {
963                         struct lov_stripe_md *lsm;
964                         int i;
965
966                         lsm = lov->lo_lsm;
967                         LASSERT(lsm != NULL);
968                         for (i = 0; i < lsm->lsm_stripe_count; i++) {
969                                 struct lov_oinfo *loi = lsm->lsm_oinfo[i];
970                                 if (loi->loi_ar.ar_rc && !rc)
971                                         rc = loi->loi_ar.ar_rc;
972                                 loi->loi_ar.ar_rc = 0;
973                         }
974                 }
975                 case LLT_RELEASED:
976                 case LLT_EMPTY:
977                         break;
978                 default:
979                         LBUG();
980                 }
981                 lov_conf_thaw(lov);
982         }
983         return rc;
984 }
985 EXPORT_SYMBOL(lov_read_and_clear_async_rc);
986
987 /** @} lov */