lustre/utils/liblustreapi_layout.c

   1 /*
   2  * LGPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * All rights reserved. This program and the accompanying materials
   7  * are made available under the terms of the GNU Lesser General Public License
   8  * (LGPL) version 2.1 or (at your discretion) any later version.
   9  * (LGPL) version 2.1 accompanies this distribution, and is available at
  10  * http://www.gnu.org/licenses/lgpl-2.1.html
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * LGPL HEADER END
  18  */
  19 /*
  20  * lustre/utils/liblustreapi_layout.c
  21  *
  22  * lustreapi library for layout calls for interacting with the layout of
  23  * Lustre files while hiding details of the internal data structures
  24  * from the user.
  25  *
  26  * Copyright (c) 2016, 2017, Intel Corporation.
  27  *
  28  * Author: Ned Bass <bass6@llnl.gov>
  29  */
  30
  31 #include <stdio.h>
  32 #include <fcntl.h>
  33 #include <stdlib.h>
  34 #include <unistd.h>
  35 #include <errno.h>
  36 #include <limits.h>
  37 #include <assert.h>
  38 #include <sys/xattr.h>
  39 #include <sys/param.h>
  40
  41 #include <libcfs/util/list.h>
  42 #include <lustre/lustreapi.h>
  43 #include "lustreapi_internal.h"
  44
  45 /**
  46  * Layout component, which contains all attributes of a plain
  47  * V1/V3 layout.
  48  */
  49 struct llapi_layout_comp {
  50         uint64_t        llc_pattern;
  51         uint64_t        llc_stripe_size;
  52         uint64_t        llc_stripe_count;
  53         uint64_t        llc_stripe_offset;
  54         /* Add 1 so user always gets back a null terminated string. */
  55         char            llc_pool_name[LOV_MAXPOOLNAME + 1];
  56         /** Number of objects in llc_objects array if was initialized. */
  57         uint32_t        llc_objects_count;
  58         struct          lov_user_ost_data_v1 *llc_objects;
  59         /* fields used only for composite layouts */
  60         struct lu_extent        llc_extent;     /* [start, end) of component */
  61         uint32_t                llc_id;         /* unique ID of component */
  62         uint32_t                llc_flags;      /* LCME_FL_* flags */
  63         uint64_t                llc_timestamp;  /* snapshot timestamp */
  64         struct list_head        llc_list;       /* linked to the llapi_layout
  65                                                    components list */
  66         bool            llc_ondisk;
  67 };
  68
  69 /**
  70  * An Opaque data type abstracting the layout of a Lustre file.
  71  */
  72 struct llapi_layout {
  73         uint32_t        llot_magic; /* LLAPI_LAYOUT_MAGIC */
  74         uint32_t        llot_gen;
  75         uint32_t        llot_flags;
  76         bool            llot_is_composite;
  77         uint16_t        llot_mirror_count;
  78         /* Cursor pointing to one of the components in llot_comp_list */
  79         struct llapi_layout_comp *llot_cur_comp;
  80         struct list_head          llot_comp_list;
  81 };
  82
  83 /**
  84  * Compute the number of elements in the lmm_objects array of \a lum
  85  * with size \a lum_size.
  86  *
  87  * \param[in] lum       the struct lov_user_md to check
  88  * \param[in] lum_size  the number of bytes in \a lum
  89  *
  90  * \retval              number of elements in array lum->lmm_objects
  91  */
  92 static int llapi_layout_objects_in_lum(struct lov_user_md *lum, size_t lum_size)
  93 {
  94         uint32_t magic;
  95         size_t base_size;
  96
  97         if (lum_size < lov_user_md_size(0, LOV_MAGIC_V1))
  98                 return 0;
  99
 100         if (lum->lmm_magic == __swab32(LOV_MAGIC_V1) ||
 101             lum->lmm_magic == __swab32(LOV_MAGIC_V3))
 102                 magic = __swab32(lum->lmm_magic);
 103         else
 104                 magic = lum->lmm_magic;
 105
 106         base_size = lov_user_md_size(0, magic);
 107
 108         if (lum_size <= base_size)
 109                 return 0;
 110         else
 111                 return (lum_size - base_size) / sizeof(lum->lmm_objects[0]);
 112 }
 113
 114 /**
 115  * Byte-swap the fields of struct lov_user_md.
 116  *
 117  * XXX Rather than duplicating swabbing code here, we should eventually
 118  * refactor the needed functions in lustre/ptlrpc/pack_generic.c
 119  * into a library that can be shared between kernel and user code.
 120  */
 121 static void
 122 llapi_layout_swab_lov_user_md(struct lov_user_md *lum, int lum_size)
 123 {
 124         int i, j, ent_count, obj_count;
 125         struct lov_comp_md_v1 *comp_v1 = NULL;
 126         struct lov_comp_md_entry_v1 *ent;
 127         struct lov_user_ost_data *lod;
 128
 129         if (lum->lmm_magic != __swab32(LOV_MAGIC_V1) &&
 130             lum->lmm_magic != __swab32(LOV_MAGIC_V3) &&
 131             lum->lmm_magic != __swab32(LOV_MAGIC_COMP_V1))
 132                 return;
 133
 134         if (lum->lmm_magic == __swab32(LOV_MAGIC_COMP_V1))
 135                 comp_v1 = (struct lov_comp_md_v1 *)lum;
 136
 137         if (comp_v1 != NULL) {
 138                 comp_v1->lcm_magic = __swab32(comp_v1->lcm_magic);
 139                 comp_v1->lcm_size = __swab32(comp_v1->lcm_size);
 140                 comp_v1->lcm_layout_gen = __swab32(comp_v1->lcm_layout_gen);
 141                 comp_v1->lcm_flags = __swab16(comp_v1->lcm_flags);
 142                 comp_v1->lcm_entry_count = __swab16(comp_v1->lcm_entry_count);
 143                 ent_count = comp_v1->lcm_entry_count;
 144         } else {
 145                 ent_count = 1;
 146         }
 147
 148         for (i = 0; i < ent_count; i++) {
 149                 if (comp_v1 != NULL) {
 150                         ent = &comp_v1->lcm_entries[i];
 151                         ent->lcme_id = __swab32(ent->lcme_id);
 152                         ent->lcme_flags = __swab32(ent->lcme_flags);
 153                         ent->lcme_timestamp = __swab64(ent->lcme_timestamp);
 154                         ent->lcme_extent.e_start = __swab64(ent->lcme_extent.e_start);
 155                         ent->lcme_extent.e_end = __swab64(ent->lcme_extent.e_end);
 156                         ent->lcme_offset = __swab32(ent->lcme_offset);
 157                         ent->lcme_size = __swab32(ent->lcme_size);
 158
 159                         lum = (struct lov_user_md *)((char *)comp_v1 +
 160                                         ent->lcme_offset);
 161                         lum_size = ent->lcme_size;
 162                 }
 163                 obj_count = llapi_layout_objects_in_lum(lum, lum_size);
 164
 165                 lum->lmm_magic = __swab32(lum->lmm_magic);
 166                 lum->lmm_pattern = __swab32(lum->lmm_pattern);
 167                 lum->lmm_stripe_size = __swab32(lum->lmm_stripe_size);
 168                 lum->lmm_stripe_count = __swab16(lum->lmm_stripe_count);
 169                 lum->lmm_stripe_offset = __swab16(lum->lmm_stripe_offset);
 170
 171                 if (lum->lmm_magic != LOV_MAGIC_V1) {
 172                         struct lov_user_md_v3 *v3;
 173                         v3 = (struct lov_user_md_v3 *)lum;
 174                         lod = v3->lmm_objects;
 175                 } else {
 176                         lod = lum->lmm_objects;
 177                 }
 178
 179                 for (j = 0; j < obj_count; j++)
 180                         lod[j].l_ost_idx = __swab32(lod[j].l_ost_idx);
 181         }
 182 }
 183
 184 /**
 185  * (Re-)allocate llc_objects[] to \a num_stripes stripes.
 186  *
 187  * Copy over existing llc_objects[], if any, to the new llc_objects[].
 188  *
 189  * \param[in] layout            existing layout to be modified
 190  * \param[in] num_stripes       number of stripes in new layout
 191  *
 192  * \retval      0 if the objects are re-allocated successfully
 193  * \retval      -1 on error with errno set
 194  */
 195 static int __llapi_comp_objects_realloc(struct llapi_layout_comp *comp,
 196                                         unsigned int new_stripes)
 197 {
 198         struct lov_user_ost_data_v1 *new_objects;
 199         unsigned int i;
 200
 201         if (new_stripes > LOV_MAX_STRIPE_COUNT) {
 202                 errno = EINVAL;
 203                 return -1;
 204         }
 205
 206         if (new_stripes == comp->llc_objects_count)
 207                 return 0;
 208
 209         if (new_stripes != 0 && new_stripes <= comp->llc_objects_count)
 210                 return 0;
 211
 212         new_objects = realloc(comp->llc_objects,
 213                               sizeof(*new_objects) * new_stripes);
 214         if (new_objects == NULL && new_stripes != 0) {
 215                 errno = ENOMEM;
 216                 return -1;
 217         }
 218
 219         for (i = comp->llc_objects_count; i < new_stripes; i++)
 220                 new_objects[i].l_ost_idx = LLAPI_LAYOUT_IDX_MAX;
 221
 222         comp->llc_objects = new_objects;
 223         comp->llc_objects_count = new_stripes;
 224
 225         return 0;
 226 }
 227
 228 /**
 229  * Allocate storage for a llapi_layout_comp with \a num_stripes stripes.
 230  *
 231  * \param[in] num_stripes       number of stripes in new layout
 232  *
 233  * \retval      valid pointer if allocation succeeds
 234  * \retval      NULL if allocation fails
 235  */
 236 static struct llapi_layout_comp *__llapi_comp_alloc(unsigned int num_stripes)
 237 {
 238         struct llapi_layout_comp *comp;
 239
 240         if (num_stripes > LOV_MAX_STRIPE_COUNT) {
 241                 errno = EINVAL;
 242                 return NULL;
 243         }
 244
 245         comp = calloc(1, sizeof(*comp));
 246         if (comp == NULL) {
 247                 errno = ENOMEM;
 248                 return NULL;
 249         }
 250
 251         comp->llc_objects = NULL;
 252         comp->llc_objects_count = 0;
 253
 254         if (__llapi_comp_objects_realloc(comp, num_stripes) < 0) {
 255                 free(comp);
 256                 return NULL;
 257         }
 258
 259         /* Set defaults. */
 260         comp->llc_pattern = LLAPI_LAYOUT_DEFAULT;
 261         comp->llc_stripe_size = LLAPI_LAYOUT_DEFAULT;
 262         comp->llc_stripe_count = LLAPI_LAYOUT_DEFAULT;
 263         comp->llc_stripe_offset = LLAPI_LAYOUT_DEFAULT;
 264         comp->llc_pool_name[0] = '\0';
 265         comp->llc_extent.e_start = 0;
 266         comp->llc_extent.e_end = LUSTRE_EOF;
 267         comp->llc_flags = 0;
 268         comp->llc_id = 0;
 269         INIT_LIST_HEAD(&comp->llc_list);
 270
 271         return comp;
 272 }
 273
 274 /**
 275  * Free memory allocated for \a comp
 276  *
 277  * \param[in] comp      previously allocated by __llapi_comp_alloc()
 278  */
 279 static void __llapi_comp_free(struct llapi_layout_comp *comp)
 280 {
 281         if (comp->llc_objects != NULL)
 282                 free(comp->llc_objects);
 283         free(comp);
 284 }
 285
 286 /**
 287  * Free memory allocated for \a layout.
 288  *
 289  * \param[in] layout    previously allocated by llapi_layout_alloc()
 290  */
 291 void llapi_layout_free(struct llapi_layout *layout)
 292 {
 293         struct llapi_layout_comp *comp, *n;
 294
 295         if (layout == NULL)
 296                 return;
 297
 298         list_for_each_entry_safe(comp, n, &layout->llot_comp_list, llc_list) {
 299                 list_del_init(&comp->llc_list);
 300                 __llapi_comp_free(comp);
 301         }
 302         free(layout);
 303 }
 304
 305 /**
 306  * Allocate and initialize a llapi_layout structure.
 307  *
 308  * \retval      valid llapi_layout pointer on success
 309  * \retval      NULL if memory allocation fails
 310  */
 311 static struct llapi_layout *__llapi_layout_alloc(void)
 312 {
 313         struct llapi_layout *layout;
 314
 315         layout = calloc(1, sizeof(*layout));
 316         if (layout == NULL) {
 317                 errno = ENOMEM;
 318                 return NULL;
 319         }
 320
 321         /* Set defaults. */
 322         layout->llot_magic = LLAPI_LAYOUT_MAGIC;
 323         layout->llot_gen = 0;
 324         layout->llot_flags = 0;
 325         layout->llot_is_composite = false;
 326         layout->llot_mirror_count = 1;
 327         layout->llot_cur_comp = NULL;
 328         INIT_LIST_HEAD(&layout->llot_comp_list);
 329
 330         return layout;
 331 }
 332
 333 /**
 334  * Allocate and initialize a new plain layout.
 335  *
 336  * \retval      valid llapi_layout pointer on success
 337  * \retval      NULL if memory allocation fails
 338  */
 339 struct llapi_layout *llapi_layout_alloc(void)
 340 {
 341         struct llapi_layout_comp *comp;
 342         struct llapi_layout *layout;
 343
 344         layout = __llapi_layout_alloc();
 345         if (layout == NULL)
 346                 return NULL;
 347
 348         comp = __llapi_comp_alloc(0);
 349         if (comp == NULL) {
 350                 free(layout);
 351                 return NULL;
 352         }
 353
 354         list_add_tail(&comp->llc_list, &layout->llot_comp_list);
 355         layout->llot_cur_comp = comp;
 356
 357         return layout;
 358 }
 359
 360 /**
 361  * Check if the given \a lum_size is large enough to hold the required
 362  * fields in \a lum.
 363  *
 364  * \param[in] lum       the struct lov_user_md to check
 365  * \param[in] lum_size  the number of bytes in \a lum
 366  *
 367  * \retval true         the \a lum_size is too small
 368  * \retval false        the \a lum_size is large enough
 369  */
 370 static bool llapi_layout_lum_truncated(struct lov_user_md *lum, size_t lum_size)
 371 {
 372         uint32_t magic;
 373
 374         if (lum_size < sizeof(lum->lmm_magic))
 375                 return true;
 376
 377         if (lum->lmm_magic == LOV_MAGIC_V1 ||
 378             lum->lmm_magic == __swab32(LOV_MAGIC_V1))
 379                 magic = LOV_MAGIC_V1;
 380         else if (lum->lmm_magic == LOV_MAGIC_V3 ||
 381                  lum->lmm_magic == __swab32(LOV_MAGIC_V3))
 382                 magic = LOV_MAGIC_V3;
 383         else if (lum->lmm_magic == LOV_MAGIC_COMP_V1 ||
 384                  lum->lmm_magic == __swab32(LOV_MAGIC_COMP_V1))
 385                 magic = LOV_MAGIC_COMP_V1;
 386         else
 387                 return true;
 388
 389         if (magic == LOV_MAGIC_V1 || magic == LOV_MAGIC_V3)
 390                 return lum_size < lov_user_md_size(0, magic);
 391         else
 392                 return lum_size < sizeof(struct lov_comp_md_v1);
 393 }
 394
 395 /* Verify if the objects count in lum is consistent with the
 396  * stripe count in lum. It applies to regular file only. */
 397 static bool llapi_layout_lum_valid(struct lov_user_md *lum, int lum_size)
 398 {
 399         struct lov_comp_md_v1 *comp_v1 = NULL;
 400         int i, ent_count, obj_count;
 401
 402         if (lum->lmm_magic == LOV_MAGIC_COMP_V1) {
 403                 comp_v1 = (struct lov_comp_md_v1 *)lum;
 404                 ent_count = comp_v1->lcm_entry_count;
 405         } else if (lum->lmm_magic == LOV_MAGIC_V1 ||
 406                    lum->lmm_magic == LOV_MAGIC_V3) {
 407                 ent_count = 1;
 408         } else {
 409                 return false;
 410         }
 411
 412         for (i = 0; i < ent_count; i++) {
 413                 if (comp_v1) {
 414                         lum = (struct lov_user_md *)((char *)comp_v1 +
 415                                 comp_v1->lcm_entries[i].lcme_offset);
 416                         lum_size = comp_v1->lcm_entries[i].lcme_size;
 417                 }
 418                 obj_count = llapi_layout_objects_in_lum(lum, lum_size);
 419
 420                 if (comp_v1) {
 421                         if (!(comp_v1->lcm_entries[i].lcme_flags &
 422                                  LCME_FL_INIT) && obj_count != 0)
 423                                 return false;
 424                 } else if (obj_count != lum->lmm_stripe_count) {
 425                         return false;
 426                 }
 427         }
 428         return true;
 429 }
 430
 431 /**
 432  * Convert the data from a lov_user_md to a newly allocated llapi_layout.
 433  * The caller is responsible for freeing the returned pointer.
 434  *
 435  * \param[in] lov_xattr         LOV user metadata xattr to copy data from
 436  * \param[in] lov_xattr_size    size the lov_xattr_size passed in
 437  * \param[in] flags             flags to control how layout is retrieved
 438  *
 439  * \retval              valid llapi_layout pointer on success
 440  * \retval              NULL if memory allocation fails
 441  */
 442 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
 443                                               ssize_t lov_xattr_size,
 444                                               enum llapi_layout_get_flags flags)
 445 {
 446         struct lov_user_md *lum = lov_xattr;
 447         struct lov_comp_md_v1 *comp_v1 = NULL;
 448         struct lov_comp_md_entry_v1 *ent;
 449         struct lov_user_md *v1;
 450         struct llapi_layout *layout = NULL;
 451         struct llapi_layout_comp *comp;
 452         int i, ent_count = 0, obj_count;
 453
 454         if (lov_xattr == NULL || lov_xattr_size <= 0) {
 455                 errno = EINVAL;
 456                 return NULL;
 457         }
 458
 459         /* Return an error if we got back a partial layout. */
 460         if (llapi_layout_lum_truncated(lov_xattr, lov_xattr_size)) {
 461                 errno = ERANGE;
 462                 return NULL;
 463         }
 464
 465 #if __BYTE_ORDER == __BIG_ENDIAN
 466         if (flags & LLAPI_LAYOUT_GET_COPY) {
 467                 lum = malloc(lov_xattr_size);
 468                 if (lum == NULL) {
 469                         errno = ENOMEM;
 470                         return NULL;
 471                 }
 472                 memcpy(lum, lov_xattr, lov_xattr_size);
 473         }
 474 #endif
 475
 476         llapi_layout_swab_lov_user_md(lum, lov_xattr_size);
 477
 478 #if LUSTRE_VERSION_CODE > OBD_OCD_VERSION(2, 16, 53, 0)
 479 #define LLAPI_LXF_CHECK_OLD 0x0001
 480         if (flags & LLAPI_LXF_CHECK_OLD)
 481                 flags = (flags & ~LLAPI_LXF_CHECK_OLD) | LLAPI_LAYOUT_GET_CHECK;
 482 #endif
 483         if ((flags & LLAPI_LAYOUT_GET_CHECK) &&
 484             !llapi_layout_lum_valid(lum, lov_xattr_size)) {
 485                 errno = EBADSLT;
 486                 goto out;
 487         }
 488
 489         layout = __llapi_layout_alloc();
 490         if (layout == NULL) {
 491                 errno = ENOMEM;
 492                 goto out;
 493         }
 494
 495         if (lum->lmm_magic == LOV_MAGIC_COMP_V1) {
 496                 comp_v1 = (struct lov_comp_md_v1 *)lum;
 497                 ent_count = comp_v1->lcm_entry_count;
 498                 layout->llot_gen = comp_v1->lcm_layout_gen;
 499                 layout->llot_is_composite = true;
 500                 layout->llot_mirror_count = comp_v1->lcm_mirror_count + 1;
 501                 layout->llot_gen = comp_v1->lcm_layout_gen;
 502                 layout->llot_flags = comp_v1->lcm_flags;
 503         } else if (lum->lmm_magic == LOV_MAGIC_V1 ||
 504                    lum->lmm_magic == LOV_MAGIC_V3) {
 505                 ent_count = 1;
 506                 layout->llot_is_composite = false;
 507
 508                 if (lov_xattr_size <= 0) {
 509                         errno = EINVAL;
 510                         goto out_layout;
 511                 }
 512         } else {
 513                 errno = EOPNOTSUPP;
 514                 goto out_layout;
 515         }
 516
 517         if (ent_count == 0) {
 518                 errno = EINVAL;
 519                 goto out_layout;
 520         }
 521
 522         v1 = (struct lov_user_md *)lum;
 523         for (i = 0; i < ent_count; i++) {
 524                 if (comp_v1 != NULL) {
 525                         ent = &comp_v1->lcm_entries[i];
 526                         v1 = (struct lov_user_md *)((char *)comp_v1 +
 527                                 ent->lcme_offset);
 528                         lov_xattr_size = ent->lcme_size;
 529                 } else {
 530                         ent = NULL;
 531                 }
 532
 533                 obj_count = llapi_layout_objects_in_lum(v1, lov_xattr_size);
 534                 comp = __llapi_comp_alloc(obj_count);
 535                 if (comp == NULL)
 536                         goto out_layout;
 537
 538                 if (ent != NULL) {
 539                         comp->llc_extent.e_start = ent->lcme_extent.e_start;
 540                         comp->llc_extent.e_end = ent->lcme_extent.e_end;
 541                         comp->llc_id = ent->lcme_id;
 542                         comp->llc_flags = ent->lcme_flags;
 543                         if (comp->llc_flags & LCME_FL_NOSYNC)
 544                                 comp->llc_timestamp = ent->lcme_timestamp;
 545                 } else {
 546                         comp->llc_extent.e_start = 0;
 547                         comp->llc_extent.e_end = LUSTRE_EOF;
 548                         comp->llc_id = 0;
 549                         comp->llc_flags = 0;
 550                 }
 551
 552                 if (v1->lmm_pattern == LOV_PATTERN_RAID0)
 553                         comp->llc_pattern = LLAPI_LAYOUT_RAID0;
 554                 else if (v1->lmm_pattern == (LOV_PATTERN_RAID0 |
 555                                          LOV_PATTERN_OVERSTRIPING))
 556                         comp->llc_pattern = LLAPI_LAYOUT_OVERSTRIPING;
 557                 else if (v1->lmm_pattern == LOV_PATTERN_MDT)
 558                         comp->llc_pattern = LLAPI_LAYOUT_MDT;
 559                 else
 560                         /* Lustre only supports RAID0, overstripping
 561                          * and DoM for now.
 562                          */
 563                         comp->llc_pattern = v1->lmm_pattern;
 564
 565                 if (v1->lmm_stripe_size == 0)
 566                         comp->llc_stripe_size = LLAPI_LAYOUT_DEFAULT;
 567                 else
 568                         comp->llc_stripe_size = v1->lmm_stripe_size;
 569
 570                 if (v1->lmm_stripe_count == (typeof(v1->lmm_stripe_count))-1)
 571                         comp->llc_stripe_count = LLAPI_LAYOUT_WIDE;
 572                 else if (v1->lmm_stripe_count == 0)
 573                         comp->llc_stripe_count = LLAPI_LAYOUT_DEFAULT;
 574                 else
 575                         comp->llc_stripe_count = v1->lmm_stripe_count;
 576
 577                 if (v1->lmm_stripe_offset ==
 578                     (typeof(v1->lmm_stripe_offset))-1)
 579                         comp->llc_stripe_offset = LLAPI_LAYOUT_DEFAULT;
 580                 else
 581                         comp->llc_stripe_offset = v1->lmm_stripe_offset;
 582
 583                 if (v1->lmm_magic != LOV_USER_MAGIC_V1) {
 584                         const struct lov_user_md_v3 *lumv3;
 585                         lumv3 = (struct lov_user_md_v3 *)v1;
 586                         snprintf(comp->llc_pool_name,
 587                                  sizeof(comp->llc_pool_name),
 588                                  "%s", lumv3->lmm_pool_name);
 589                         memcpy(comp->llc_objects, lumv3->lmm_objects,
 590                                obj_count * sizeof(lumv3->lmm_objects[0]));
 591                 } else {
 592                         const struct lov_user_md_v1 *lumv1;
 593                         lumv1 = (struct lov_user_md_v1 *)v1;
 594                         memcpy(comp->llc_objects, lumv1->lmm_objects,
 595                                obj_count * sizeof(lumv1->lmm_objects[0]));
 596                 }
 597
 598                 if (obj_count != 0)
 599                         comp->llc_stripe_offset =
 600                                 comp->llc_objects[0].l_ost_idx;
 601
 602                 comp->llc_ondisk = true;
 603                 list_add_tail(&comp->llc_list, &layout->llot_comp_list);
 604                 layout->llot_cur_comp = comp;
 605         }
 606
 607 out:
 608         if (lum != lov_xattr)
 609                 free(lum);
 610         return layout;
 611 out_layout:
 612         llapi_layout_free(layout);
 613         layout = NULL;
 614         goto out;
 615 }
 616
 617 __u32 llapi_pattern_to_lov(uint64_t pattern)
 618 {
 619         __u32 lov_pattern;
 620
 621         switch (pattern) {
 622         case LLAPI_LAYOUT_DEFAULT:
 623                 lov_pattern = LOV_PATTERN_RAID0;
 624                 break;
 625         case LLAPI_LAYOUT_RAID0:
 626                 lov_pattern = LOV_PATTERN_RAID0;
 627                 break;
 628         case LLAPI_LAYOUT_MDT:
 629                 lov_pattern = LOV_PATTERN_MDT;
 630                 break;
 631         case LLAPI_LAYOUT_OVERSTRIPING:
 632                 lov_pattern = LOV_PATTERN_OVERSTRIPING | LOV_PATTERN_RAID0;
 633                 break;
 634         default:
 635                 lov_pattern = EINVAL;
 636         }
 637
 638         return lov_pattern;
 639 }
 640
 641 /**
 642  * Convert the data from a llapi_layout to a newly allocated lov_user_md.
 643  * The caller is responsible for freeing the returned pointer.
 644  *
 645  * \param[in] layout    the layout to copy from
 646  *
 647  * \retval      valid lov_user_md pointer on success
 648  * \retval      NULL if memory allocation fails or the layout is invalid
 649  */
 650 static struct lov_user_md *
 651 llapi_layout_to_lum(const struct llapi_layout *layout)
 652 {
 653         struct llapi_layout_comp *comp;
 654         struct lov_comp_md_v1 *comp_v1 = NULL;
 655         struct lov_comp_md_entry_v1 *ent;
 656         struct lov_user_md *lum = NULL;
 657         size_t lum_size = 0;
 658         int ent_idx = 0;
 659         uint32_t offset = 0;
 660
 661         if (layout == NULL ||
 662             list_empty((struct list_head *)&layout->llot_comp_list)) {
 663                 errno = EINVAL;
 664                 return NULL;
 665         }
 666
 667         /* Allocate header of lov_comp_md_v1 if necessary */
 668         if (layout->llot_is_composite) {
 669                 int comp_cnt = 0;
 670
 671                 list_for_each_entry(comp, &layout->llot_comp_list, llc_list)
 672                         comp_cnt++;
 673
 674                 lum_size = sizeof(*comp_v1) + comp_cnt * sizeof(*ent);
 675                 lum = calloc(lum_size, 1);
 676                 if (lum == NULL) {
 677                         errno = ENOMEM;
 678                         return NULL;
 679                 }
 680                 comp_v1 = (struct lov_comp_md_v1 *)lum;
 681                 comp_v1->lcm_magic = LOV_USER_MAGIC_COMP_V1;
 682                 comp_v1->lcm_size = lum_size;
 683                 comp_v1->lcm_layout_gen = 0;
 684                 comp_v1->lcm_flags = layout->llot_flags;
 685                 comp_v1->lcm_entry_count = comp_cnt;
 686                 comp_v1->lcm_mirror_count = layout->llot_mirror_count - 1;
 687                 offset += lum_size;
 688         }
 689
 690         list_for_each_entry(comp, &layout->llot_comp_list, llc_list) {
 691                 struct lov_user_md *blob;
 692                 size_t blob_size;
 693                 uint32_t magic;
 694                 int i, obj_count = 0;
 695                 struct lov_user_ost_data *lmm_objects;
 696                 uint64_t pattern = comp->llc_pattern;
 697
 698                 if ((pattern & LLAPI_LAYOUT_SPECIFIC) != 0) {
 699                         if (comp->llc_objects_count <
 700                             comp->llc_stripe_count) {
 701                                 errno = EINVAL;
 702                                 goto error;
 703                         }
 704                         magic = LOV_USER_MAGIC_SPECIFIC;
 705                         obj_count = comp->llc_stripe_count;
 706                         pattern &= ~LLAPI_LAYOUT_SPECIFIC;
 707                 } else if (strlen(comp->llc_pool_name) != 0) {
 708                         magic = LOV_USER_MAGIC_V3;
 709                 } else {
 710                         magic = LOV_USER_MAGIC_V1;
 711                 }
 712                 /* All stripes must be specified when the pattern contains
 713                  * LLAPI_LAYOUT_SPECIFIC */
 714                 for (i = 0; i < obj_count; i++) {
 715                         if (comp->llc_objects[i].l_ost_idx ==
 716                             LLAPI_LAYOUT_IDX_MAX) {
 717                                 errno = EINVAL;
 718                                 goto error;
 719                         }
 720                 }
 721
 722                 blob_size = lov_user_md_size(obj_count, magic);
 723                 blob = realloc(lum, lum_size + blob_size);
 724                 if (blob == NULL) {
 725                         errno = ENOMEM;
 726                         goto error;
 727                 } else {
 728                         lum = blob;
 729                         comp_v1 = (struct lov_comp_md_v1 *)lum;
 730                         blob = (struct lov_user_md *)((char *)lum + lum_size);
 731                         lum_size += blob_size;
 732                 }
 733
 734                 blob->lmm_magic = magic;
 735                 blob->lmm_pattern = llapi_pattern_to_lov(pattern);
 736                 if (blob->lmm_pattern == EINVAL) {
 737                         errno = EINVAL;
 738                         goto error;
 739                 }
 740
 741                 if (comp->llc_stripe_size == LLAPI_LAYOUT_DEFAULT)
 742                         blob->lmm_stripe_size = 0;
 743                 else
 744                         blob->lmm_stripe_size = comp->llc_stripe_size;
 745
 746                 if (comp->llc_stripe_count == LLAPI_LAYOUT_DEFAULT)
 747                         blob->lmm_stripe_count = 0;
 748                 else if (comp->llc_stripe_count == LLAPI_LAYOUT_WIDE)
 749                         blob->lmm_stripe_count = LOV_ALL_STRIPES;
 750                 else
 751                         blob->lmm_stripe_count = comp->llc_stripe_count;
 752
 753                 if (comp->llc_stripe_offset == LLAPI_LAYOUT_DEFAULT)
 754                         blob->lmm_stripe_offset = -1;
 755                 else
 756                         blob->lmm_stripe_offset = comp->llc_stripe_offset;
 757
 758                 if (magic == LOV_USER_MAGIC_V3 ||
 759                     magic == LOV_USER_MAGIC_SPECIFIC) {
 760                         struct lov_user_md_v3 *lumv3 =
 761                                 (struct lov_user_md_v3 *)blob;
 762
 763                         if (comp->llc_pool_name[0] != '\0') {
 764                                 strncpy(lumv3->lmm_pool_name,
 765                                         comp->llc_pool_name,
 766                                         sizeof(lumv3->lmm_pool_name));
 767                         } else {
 768                                 memset(lumv3->lmm_pool_name, 0,
 769                                        sizeof(lumv3->lmm_pool_name));
 770                         }
 771                         lmm_objects = lumv3->lmm_objects;
 772                 } else {
 773                         lmm_objects = blob->lmm_objects;
 774                 }
 775
 776                 for (i = 0; i < obj_count; i++)
 777                         lmm_objects[i].l_ost_idx =
 778                                 comp->llc_objects[i].l_ost_idx;
 779
 780                 if (layout->llot_is_composite) {
 781                         ent = &comp_v1->lcm_entries[ent_idx];
 782                         ent->lcme_id = comp->llc_id;
 783                         ent->lcme_flags = comp->llc_flags;
 784                         if (ent->lcme_flags & LCME_FL_NOSYNC)
 785                                 ent->lcme_timestamp = comp->llc_timestamp;
 786                         ent->lcme_extent.e_start = comp->llc_extent.e_start;
 787                         ent->lcme_extent.e_end = comp->llc_extent.e_end;
 788                         ent->lcme_size = blob_size;
 789                         ent->lcme_offset = offset;
 790                         offset += blob_size;
 791                         comp_v1->lcm_size += blob_size;
 792                         ent_idx++;
 793                 } else {
 794                         break;
 795                 }
 796         }
 797
 798         return lum;
 799 error:
 800         free(lum);
 801         return NULL;
 802 }
 803
 804 /**
 805  * Get the parent directory of a path.
 806  *
 807  * \param[in] path      path to get parent of
 808  * \param[out] buf      buffer in which to store parent path
 809  * \param[in] size      size in bytes of buffer \a buf
 810  */
 811 static void get_parent_dir(const char *path, char *buf, size_t size)
 812 {
 813         char *p;
 814
 815         strncpy(buf, path, size - 1);
 816         p = strrchr(buf, '/');
 817
 818         if (p != NULL) {
 819                 *p = '\0';
 820         } else if (size >= 2) {
 821                 strncpy(buf, ".", 2);
 822                 buf[size - 1] = '\0';
 823         }
 824 }
 825
 826 /**
 827  * Substitute unspecified attribute values in \a layout with values
 828  * from fs global settings. (lov.stripesize, lov.stripecount,
 829  * lov.stripeoffset)
 830  *
 831  * \param[in] layout    layout to inherit values from
 832  * \param[in] path      file path of the filesystem
 833  */
 834 static void inherit_sys_attributes(struct llapi_layout *layout,
 835                                    const char *path)
 836 {
 837         struct llapi_layout_comp *comp;
 838         unsigned int ssize, scount, soffset;
 839         int rc;
 840
 841         rc = sattr_cache_get_defaults(NULL, path, &scount, &ssize, &soffset);
 842         if (rc)
 843                 return;
 844
 845         list_for_each_entry(comp, &layout->llot_comp_list, llc_list) {
 846                 if (comp->llc_pattern == LLAPI_LAYOUT_DEFAULT)
 847                         comp->llc_pattern = LLAPI_LAYOUT_RAID0;
 848                 if (comp->llc_stripe_size == LLAPI_LAYOUT_DEFAULT)
 849                         comp->llc_stripe_size = ssize;
 850                 if (comp->llc_stripe_count == LLAPI_LAYOUT_DEFAULT)
 851                         comp->llc_stripe_count = scount;
 852                 if (comp->llc_stripe_offset == LLAPI_LAYOUT_DEFAULT)
 853                         comp->llc_stripe_offset = soffset;
 854         }
 855 }
 856
 857 /**
 858  * Get the current component of \a layout.
 859  *
 860  * \param[in] layout    layout to get current component
 861  *
 862  * \retval      valid llapi_layout_comp pointer on success
 863  * \retval      NULL on error
 864  */
 865 static struct llapi_layout_comp *
 866 __llapi_layout_cur_comp(const struct llapi_layout *layout)
 867 {
 868         struct llapi_layout_comp *comp;
 869
 870         if (layout == NULL || layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
 871                 errno = EINVAL;
 872                 return NULL;
 873         }
 874         if (layout->llot_cur_comp == NULL) {
 875                 errno = EINVAL;
 876                 return NULL;
 877         }
 878         /* Verify data consistency */
 879         list_for_each_entry(comp, &layout->llot_comp_list, llc_list)
 880                 if (comp == layout->llot_cur_comp)
 881                         return comp;
 882         errno = EFAULT;
 883         return NULL;
 884 }
 885
 886 /**
 887  * Test if any attributes of \a layout are specified.
 888  *
 889  * \param[in] layout    the layout to check
 890  *
 891  * \retval true         any attributes are specified
 892  * \retval false        all attributes are unspecified
 893  */
 894 static bool is_any_specified(const struct llapi_layout *layout)
 895 {
 896         struct llapi_layout_comp *comp;
 897
 898         comp = __llapi_layout_cur_comp(layout);
 899         if (comp == NULL)
 900                 return false;
 901
 902         if (layout->llot_is_composite || layout->llot_mirror_count != 1)
 903                 return true;
 904
 905         return comp->llc_pattern != LLAPI_LAYOUT_DEFAULT ||
 906                comp->llc_stripe_size != LLAPI_LAYOUT_DEFAULT ||
 907                comp->llc_stripe_count != LLAPI_LAYOUT_DEFAULT ||
 908                comp->llc_stripe_offset != LLAPI_LAYOUT_DEFAULT ||
 909                strlen(comp->llc_pool_name);
 910 }
 911
 912 /**
 913  * Get the striping layout for the file referenced by file descriptor \a fd.
 914  *
 915  * If the filesystem does not support the "lustre." xattr namespace, the
 916  * file must be on a non-Lustre filesystem, so set errno to ENOTTY per
 917  * convention.  If the file has no "lustre.lov" data, the file will
 918  * inherit default values, so return a default layout.
 919  *
 920  * If the kernel gives us back less than the expected amount of data,
 921  * we fail with errno set to EINTR.
 922  *
 923  * \param[in] fd        open file descriptor
 924  * \param[in] flags     open file descriptor
 925  *
 926  * \retval      valid llapi_layout pointer on success
 927  * \retval      NULL if an error occurs
 928  */
 929 struct llapi_layout *llapi_layout_get_by_fd(int fd,
 930                                             enum llapi_layout_get_flags flags)
 931 {
 932         size_t lum_len;
 933         struct lov_user_md *lum;
 934         struct llapi_layout *layout = NULL;
 935         ssize_t bytes_read;
 936         struct stat st;
 937
 938         lum_len = XATTR_SIZE_MAX;
 939         lum = malloc(lum_len);
 940         if (lum == NULL)
 941                 return NULL;
 942
 943         bytes_read = fgetxattr(fd, XATTR_LUSTRE_LOV, lum, lum_len);
 944         if (bytes_read < 0) {
 945                 if (errno == EOPNOTSUPP)
 946                         errno = ENOTTY;
 947                 else if (errno == ENODATA)
 948                         layout = llapi_layout_alloc();
 949                 goto out;
 950         }
 951
 952         /* Directories may have a positive non-zero lum->lmm_stripe_count
 953          * yet have an empty lum->lmm_objects array. For non-directories the
 954          * amount of data returned from the kernel must be consistent
 955          * with the stripe count. */
 956         if (fstat(fd, &st) < 0)
 957                 goto out;
 958
 959         layout = llapi_layout_get_by_xattr(lum, bytes_read,
 960                         S_ISDIR(st.st_mode) ? 0 : LLAPI_LAYOUT_GET_CHECK);
 961 out:
 962         free(lum);
 963         return layout;
 964 }
 965
 966 /**
 967  * Get the expected striping layout for a file at \a path.
 968  *
 969  * Substitute expected inherited attribute values for unspecified
 970  * attributes.  Unspecified attributes may belong to directories and
 971  * never-written-to files, and indicate that default values will be
 972  * assigned when files are created or first written to.  A default value
 973  * is inherited from the parent directory if the attribute is specified
 974  * there, otherwise it is inherited from the filesystem root.
 975  * Unspecified attributes normally have the value LLAPI_LAYOUT_DEFAULT.
 976  *
 977  * The complete \a path need not refer to an existing file or directory,
 978  * but some leading portion of it must reside within a lustre filesystem.
 979  * A use case for this interface would be to obtain the literal striping
 980  * values that would be assigned to a new file in a given directory.
 981  *
 982  * \param[in] path      path for which to get the expected layout
 983  *
 984  * \retval      valid llapi_layout pointer on success
 985  * \retval      NULL if an error occurs
 986  */
 987 static struct llapi_layout *llapi_layout_expected(const char *path)
 988 {
 989         struct llapi_layout     *path_layout = NULL;
 990         char                    donor_path[PATH_MAX];
 991         struct stat st;
 992         int fd;
 993         int rc;
 994
 995         fd = open(path, O_RDONLY);
 996         if (fd < 0 && errno != ENOENT)
 997                 return NULL;
 998
 999         if (fd >= 0) {
1000                 int tmp;
1001
1002                 path_layout = llapi_layout_get_by_fd(fd, 0);
1003                 tmp = errno;
1004                 close(fd);
1005                 errno = tmp;
1006         }
1007
1008         if (path_layout == NULL) {
1009                 if (errno != ENODATA && errno != ENOENT)
1010                         return NULL;
1011
1012                 path_layout = llapi_layout_alloc();
1013                 if (path_layout == NULL)
1014                         return NULL;
1015         }
1016
1017         if (is_any_specified(path_layout)) {
1018                 inherit_sys_attributes(path_layout, path);
1019                 return path_layout;
1020         }
1021
1022         llapi_layout_free(path_layout);
1023
1024         rc = stat(path, &st);
1025         if (rc < 0 && errno != ENOENT)
1026                 return NULL;
1027
1028         /* If path is a not a directory or doesn't exist, inherit layout
1029          * from parent directory. */
1030         if ((rc == 0 && !S_ISDIR(st.st_mode)) ||
1031             (rc < 0 && errno == ENOENT)) {
1032                 get_parent_dir(path, donor_path, sizeof(donor_path));
1033                 path_layout = llapi_layout_get_by_path(donor_path, 0);
1034                 if (path_layout != NULL) {
1035                         if (is_any_specified(path_layout)) {
1036                                 inherit_sys_attributes(path_layout, donor_path);
1037                                 return path_layout;
1038                         }
1039                         llapi_layout_free(path_layout);
1040                 }
1041         }
1042
1043         /* Inherit layout from the filesystem root. */
1044         rc = llapi_search_mounts(path, 0, donor_path, NULL);
1045         if (rc < 0)
1046                 return NULL;
1047         path_layout = llapi_layout_get_by_path(donor_path, 0);
1048         if (path_layout == NULL)
1049                 return NULL;
1050
1051         inherit_sys_attributes(path_layout, donor_path);
1052         return path_layout;
1053 }
1054
1055 /**
1056  * Get the striping layout for the file at \a path.
1057  *
1058  * If \a flags contains LLAPI_LAYOUT_GET_EXPECTED, substitute
1059  * expected inherited attribute values for unspecified attributes. See
1060  * llapi_layout_expected().
1061  *
1062  * \param[in] path      path for which to get the layout
1063  * \param[in] flags     flags to control how layout is retrieved
1064  *
1065  * \retval      valid llapi_layout pointer on success
1066  * \retval      NULL if an error occurs
1067  */
1068 struct llapi_layout *llapi_layout_get_by_path(const char *path,
1069                                               enum llapi_layout_get_flags flags)
1070 {
1071         struct llapi_layout *layout = NULL;
1072         int fd;
1073         int tmp;
1074
1075         if (flags & LLAPI_LAYOUT_GET_EXPECTED)
1076                 return llapi_layout_expected(path);
1077
1078         fd = open(path, O_RDONLY);
1079         if (fd < 0)
1080                 return layout;
1081
1082         layout = llapi_layout_get_by_fd(fd, flags);
1083         tmp = errno;
1084         close(fd);
1085         errno = tmp;
1086
1087         return layout;
1088 }
1089
1090 /**
1091  * Get the layout for the file with FID \a fidstr in filesystem \a lustre_dir.
1092  *
1093  * \param[in] lustre_dir        path within Lustre filesystem containing \a fid
1094  * \param[in] fid               Lustre identifier of file to get layout for
1095  *
1096  * \retval      valid llapi_layout pointer on success
1097  * \retval      NULL if an error occurs
1098  */
1099 struct llapi_layout *llapi_layout_get_by_fid(const char *lustre_dir,
1100                                              const struct lu_fid *fid,
1101                                              enum llapi_layout_get_flags flags)
1102 {
1103         int fd;
1104         int tmp;
1105         int saved_msg_level = llapi_msg_get_level();
1106         struct llapi_layout *layout = NULL;
1107
1108         /* Prevent llapi internal routines from writing to console
1109          * while executing this function, then restore previous message
1110          * level. */
1111         llapi_msg_set_level(LLAPI_MSG_OFF);
1112         fd = llapi_open_by_fid(lustre_dir, fid, O_RDONLY);
1113         llapi_msg_set_level(saved_msg_level);
1114
1115         if (fd < 0)
1116                 return NULL;
1117
1118         layout = llapi_layout_get_by_fd(fd, flags);
1119         tmp = errno;
1120         close(fd);
1121         errno = tmp;
1122
1123         return layout;
1124 }
1125
1126 /**
1127  * Get the stripe count of \a layout.
1128  *
1129  * \param[in] layout    layout to get stripe count from
1130  * \param[out] count    integer to store stripe count in
1131  *
1132  * \retval      0 on success
1133  * \retval      -1 if arguments are invalid
1134  */
1135 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
1136                                   uint64_t *count)
1137 {
1138         struct llapi_layout_comp *comp;
1139
1140         comp = __llapi_layout_cur_comp(layout);
1141         if (comp == NULL)
1142                 return -1;
1143
1144         if (count == NULL) {
1145                 errno = EINVAL;
1146                 return -1;
1147         }
1148
1149         *count = comp->llc_stripe_count;
1150
1151         return 0;
1152 }
1153
1154 /*
1155  * The llapi_layout API functions have these extra validity checks since
1156  * they use intuitively named macros to denote special behavior, whereas
1157  * the old API uses 0 and -1.
1158  */
1159
1160 static bool llapi_layout_stripe_count_is_valid(int64_t stripe_count)
1161 {
1162         return stripe_count == LLAPI_LAYOUT_DEFAULT ||
1163                 stripe_count == LLAPI_LAYOUT_WIDE ||
1164                 (stripe_count != 0 && stripe_count != -1 &&
1165                  llapi_stripe_count_is_valid(stripe_count));
1166 }
1167
1168 static bool llapi_layout_extension_size_is_valid(uint64_t ext_size)
1169 {
1170         return (ext_size != 0 &&
1171                 llapi_stripe_size_is_aligned(ext_size) &&
1172                 !llapi_stripe_size_is_too_big(ext_size));
1173 }
1174
1175 static bool llapi_layout_stripe_size_is_valid(uint64_t stripe_size)
1176 {
1177         return stripe_size == LLAPI_LAYOUT_DEFAULT ||
1178                 (stripe_size != 0 &&
1179                  llapi_stripe_size_is_aligned(stripe_size) &&
1180                  !llapi_stripe_size_is_too_big(stripe_size));
1181 }
1182
1183 static bool llapi_layout_stripe_index_is_valid(int64_t stripe_index)
1184 {
1185         return stripe_index == LLAPI_LAYOUT_DEFAULT ||
1186                 (stripe_index >= 0 &&
1187                 llapi_stripe_index_is_valid(stripe_index));
1188 }
1189
1190 /**
1191  * Set the stripe count of \a layout.
1192  *
1193  * \param[in] layout    layout to set stripe count in
1194  * \param[in] count     value to be set
1195  *
1196  * \retval      0 on success
1197  * \retval      -1 if arguments are invalid
1198  */
1199 int llapi_layout_stripe_count_set(struct llapi_layout *layout,
1200                                   uint64_t count)
1201 {
1202         struct llapi_layout_comp *comp;
1203
1204         comp = __llapi_layout_cur_comp(layout);
1205         if (comp == NULL)
1206                 return -1;
1207
1208         if (!llapi_layout_stripe_count_is_valid(count)) {
1209                 errno = EINVAL;
1210                 return -1;
1211         }
1212
1213         comp->llc_stripe_count = count;
1214
1215         return 0;
1216 }
1217
1218 /**
1219  * Get the stripe/extension size of \a layout.
1220  *
1221  * \param[in] layout    layout to get stripe size from
1222  * \param[out] size     integer to store stripe size in
1223  * \param[in] extension flag if extenion size is requested
1224  *
1225  * \retval      0 on success
1226  * \retval      -1 if arguments are invalid
1227  */
1228 static int layout_stripe_size_get(const struct llapi_layout *layout,
1229                                   uint64_t *size, bool extension)
1230 {
1231         struct llapi_layout_comp *comp;
1232         int comp_ext;
1233
1234         comp = __llapi_layout_cur_comp(layout);
1235         if (comp == NULL)
1236                 return -1;
1237
1238         if (size == NULL) {
1239                 errno = EINVAL;
1240                 return -1;
1241         }
1242
1243         comp_ext = comp->llc_flags & LCME_FL_EXTENSION;
1244         if ((comp_ext && !extension) || (!comp_ext && extension)) {
1245                 errno = EINVAL;
1246                 return -1;
1247         }
1248
1249         *size = comp->llc_stripe_size;
1250         if (comp->llc_flags & LCME_FL_EXTENSION)
1251                 *size *= SEL_UNIT_SIZE;
1252
1253         return 0;
1254 }
1255
1256 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
1257                                  uint64_t *size)
1258 {
1259         return layout_stripe_size_get(layout, size, false);
1260 }
1261
1262 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
1263                                     uint64_t *size)
1264 {
1265         return layout_stripe_size_get(layout, size, true);
1266 }
1267
1268 /**
1269  * Set the stripe/extension size of \a layout.
1270  *
1271  * \param[in] layout    layout to set stripe size in
1272  * \param[in] size      value to be set
1273  * \param[in] extension flag if extenion size is passed
1274  *
1275  * \retval      0 on success
1276  * \retval      -1 if arguments are invalid
1277  */
1278 static int layout_stripe_size_set(struct llapi_layout *layout,
1279                                   uint64_t size, bool extension)
1280 {
1281         struct llapi_layout_comp *comp;
1282         int comp_ext;
1283
1284         comp = __llapi_layout_cur_comp(layout);
1285         if (comp == NULL)
1286                 return -1;
1287
1288         comp_ext = comp->llc_flags & LCME_FL_EXTENSION;
1289         if ((comp_ext && !extension) || (!comp_ext && extension)) {
1290                 errno = EINVAL;
1291                 return -1;
1292         }
1293
1294         if (comp_ext)
1295                 size /= SEL_UNIT_SIZE;
1296
1297         if ((comp_ext && !llapi_layout_extension_size_is_valid(size)) ||
1298             (!comp_ext && !llapi_layout_stripe_size_is_valid(size))) {
1299                 errno = EINVAL;
1300                 return -1;
1301         }
1302
1303         comp->llc_stripe_size = size;
1304         return 0;
1305 }
1306
1307 int llapi_layout_stripe_size_set(struct llapi_layout *layout,
1308                                  uint64_t size)
1309 {
1310         return layout_stripe_size_set(layout, size, false);
1311 }
1312
1313 int llapi_layout_extension_size_set(struct llapi_layout *layout,
1314                                     uint64_t size)
1315 {
1316         return layout_stripe_size_set(layout, size, true);
1317 }
1318
1319 /**
1320  * Get the RAID pattern of \a layout.
1321  *
1322  * \param[in] layout    layout to get pattern from
1323  * \param[out] pattern  integer to store pattern in
1324  *
1325  * \retval      0 on success
1326  * \retval      -1 if arguments are invalid
1327  */
1328 int llapi_layout_pattern_get(const struct llapi_layout *layout,
1329                              uint64_t *pattern)
1330 {
1331         struct llapi_layout_comp *comp;
1332
1333         comp = __llapi_layout_cur_comp(layout);
1334         if (comp == NULL)
1335                 return -1;
1336
1337         if (pattern == NULL) {
1338                 errno = EINVAL;
1339                 return -1;
1340         }
1341
1342         *pattern = comp->llc_pattern;
1343
1344         return 0;
1345 }
1346
1347 /**
1348  * Set the pattern of \a layout.
1349  *
1350  * \param[in] layout    layout to set pattern in
1351  * \param[in] pattern   value to be set
1352  *
1353  * \retval      0 on success
1354  * \retval      -1 if arguments are invalid or RAID pattern
1355  *              is unsupported
1356  */
1357 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern)
1358 {
1359         struct llapi_layout_comp *comp;
1360
1361         comp = __llapi_layout_cur_comp(layout);
1362         if (comp == NULL)
1363                 return -1;
1364
1365         if (pattern != LLAPI_LAYOUT_DEFAULT &&
1366             pattern != LLAPI_LAYOUT_RAID0 && pattern != LLAPI_LAYOUT_MDT
1367             && pattern != LLAPI_LAYOUT_OVERSTRIPING) {
1368                 errno = EOPNOTSUPP;
1369                 return -1;
1370         }
1371
1372         comp->llc_pattern = pattern |
1373                             (comp->llc_pattern & LLAPI_LAYOUT_SPECIFIC);
1374
1375         return 0;
1376 }
1377
1378 static inline int stripe_number_roundup(int stripe_number)
1379 {
1380         unsigned int round_up = (stripe_number + 8) & ~7;
1381         return round_up > LOV_MAX_STRIPE_COUNT ?
1382                 LOV_MAX_STRIPE_COUNT : round_up;
1383 }
1384
1385 /**
1386  * Set the OST index of stripe number \a stripe_number to \a ost_index.
1387  *
1388  * If only the starting stripe's OST index is specified, then this can use
1389  * the normal LOV_MAGIC_{V1,V3} layout type.  If multiple OST indices are
1390  * given, then allocate an array to hold the list of indices and ensure that
1391  * the LOV_USER_MAGIC_SPECIFIC layout is used when creating the file.
1392  *
1393  * \param[in] layout            layout to set OST index in
1394  * \param[in] stripe_number     stripe number to set index for
1395  * \param[in] ost_index         the index to set
1396  *
1397  * \retval      0 on success
1398  * \retval      -1 if arguments are invalid or an unsupported stripe number
1399  *              was specified, error returned in errno
1400  */
1401 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
1402                                uint64_t ost_index)
1403 {
1404         struct llapi_layout_comp *comp;
1405
1406         comp = __llapi_layout_cur_comp(layout);
1407         if (comp == NULL)
1408                 return -1;
1409
1410         if (!llapi_layout_stripe_index_is_valid(ost_index)) {
1411                 errno = EINVAL;
1412                 return -1;
1413         }
1414
1415         if (stripe_number == 0 && ost_index == LLAPI_LAYOUT_DEFAULT) {
1416                 comp->llc_stripe_offset = ost_index;
1417                 comp->llc_pattern &= ~LLAPI_LAYOUT_SPECIFIC;
1418                 __llapi_comp_objects_realloc(comp, 0);
1419         } else if (stripe_number >= 0 &&
1420                    stripe_number < LOV_MAX_STRIPE_COUNT) {
1421                 if (ost_index >= LLAPI_LAYOUT_IDX_MAX) {
1422                         errno = EINVAL;
1423                         return -1;
1424                 }
1425
1426                 /* Preallocate a few more stripes to avoid realloc() overhead.*/
1427                 if (__llapi_comp_objects_realloc(comp,
1428                                 stripe_number_roundup(stripe_number)) < 0)
1429                         return -1;
1430
1431                 comp->llc_objects[stripe_number].l_ost_idx = ost_index;
1432
1433                 if (stripe_number == 0)
1434                         comp->llc_stripe_offset = ost_index;
1435                 else
1436                         comp->llc_pattern |= LLAPI_LAYOUT_SPECIFIC;
1437
1438                 if (comp->llc_stripe_count == LLAPI_LAYOUT_DEFAULT ||
1439                     comp->llc_stripe_count <= stripe_number)
1440                         comp->llc_stripe_count = stripe_number + 1;
1441         } else {
1442                 errno = EINVAL;
1443                 return -1;
1444         }
1445
1446         return 0;
1447 }
1448
1449 /**
1450  * Get the OST index associated with stripe \a stripe_number.
1451  *
1452  * Stripes are indexed starting from zero.
1453  *
1454  * \param[in] layout            layout to get index from
1455  * \param[in] stripe_number     stripe number to get index for
1456  * \param[out] index            integer to store index in
1457  *
1458  * \retval      0 on success
1459  * \retval      -1 if arguments are invalid
1460  */
1461 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
1462                                uint64_t stripe_number, uint64_t *index)
1463 {
1464         struct llapi_layout_comp *comp;
1465
1466         comp = __llapi_layout_cur_comp(layout);
1467         if (comp == NULL)
1468                 return -1;
1469
1470         if (index == NULL) {
1471                 errno = EINVAL;
1472                 return -1;
1473         }
1474
1475         if (stripe_number >= comp->llc_stripe_count ||
1476             stripe_number >= comp->llc_objects_count) {
1477                 errno = EINVAL;
1478                 return -1;
1479         }
1480
1481         if (comp->llc_stripe_offset == LLAPI_LAYOUT_DEFAULT)
1482                 *index = LLAPI_LAYOUT_DEFAULT;
1483         else
1484                 *index = comp->llc_objects[stripe_number].l_ost_idx;
1485
1486         return 0;
1487 }
1488
1489 /**
1490  *
1491  * Get the pool name of layout \a layout.
1492  *
1493  * \param[in] layout    layout to get pool name from
1494  * \param[out] dest     buffer to store pool name in
1495  * \param[in] n         size in bytes of buffer \a dest
1496  *
1497  * \retval      0 on success
1498  * \retval      -1 if arguments are invalid
1499  */
1500 int llapi_layout_pool_name_get(const struct llapi_layout *layout, char *dest,
1501                                size_t n)
1502 {
1503         struct llapi_layout_comp *comp;
1504
1505         comp = __llapi_layout_cur_comp(layout);
1506         if (comp == NULL)
1507                 return -1;
1508
1509         if (dest == NULL) {
1510                 errno = EINVAL;
1511                 return -1;
1512         }
1513
1514         strncpy(dest, comp->llc_pool_name, n);
1515
1516         return 0;
1517 }
1518
1519 /**
1520  * Set the name of the pool of layout \a layout.
1521  *
1522  * \param[in] layout    layout to set pool name in
1523  * \param[in] pool_name pool name to set
1524  *
1525  * \retval      0 on success
1526  * \retval      -1 if arguments are invalid or pool name is too long
1527  */
1528 int llapi_layout_pool_name_set(struct llapi_layout *layout,
1529                                const char *pool_name)
1530 {
1531         struct llapi_layout_comp *comp;
1532         char *ptr;
1533
1534         comp = __llapi_layout_cur_comp(layout);
1535         if (comp == NULL)
1536                 return -1;
1537
1538         if (pool_name == NULL) {
1539                 errno = EINVAL;
1540                 return -1;
1541         }
1542
1543         /* Strip off any 'fsname.' portion. */
1544         ptr = strchr(pool_name, '.');
1545         if (ptr != NULL)
1546                 pool_name = ptr + 1;
1547
1548         if (strlen(pool_name) > LOV_MAXPOOLNAME) {
1549                 errno = EINVAL;
1550                 return -1;
1551         }
1552
1553         strncpy(comp->llc_pool_name, pool_name, sizeof(comp->llc_pool_name));
1554
1555         return 0;
1556 }
1557
1558 /**
1559  * Open and possibly create a file with a given \a layout.
1560  *
1561  * If \a layout is NULL this function acts as a simple wrapper for
1562  * open().  By convention, ENOTTY is returned in errno if \a path
1563  * refers to a non-Lustre file.
1564  *
1565  * \param[in] path              name of the file to open
1566  * \param[in] open_flags        open() flags
1567  * \param[in] mode              permissions to create file, filtered by umask
1568  * \param[in] layout            layout to create new file with
1569  *
1570  * \retval              non-negative file descriptor on successful open
1571  * \retval              -1 if an error occurred
1572  */
1573 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
1574                            const struct llapi_layout *layout)
1575 {
1576         int fd;
1577         int rc;
1578         int tmp;
1579         struct lov_user_md *lum;
1580         size_t lum_size;
1581
1582         if (path == NULL ||
1583             (layout != NULL && layout->llot_magic != LLAPI_LAYOUT_MAGIC)) {
1584                 errno = EINVAL;
1585                 return -1;
1586         }
1587
1588         if (layout) {
1589                 rc = llapi_layout_sanity((struct llapi_layout *)layout, false,
1590                                          !!(layout->llot_mirror_count > 1));
1591                 if (rc) {
1592                         llapi_layout_sanity_perror(rc);
1593                         return -1;
1594                 }
1595         }
1596
1597         /* Object creation must be postponed until after layout attributes
1598          * have been applied. */
1599         if (layout != NULL && (open_flags & O_CREAT))
1600                 open_flags |= O_LOV_DELAY_CREATE;
1601
1602         fd = open(path, open_flags, mode);
1603
1604         if (layout == NULL || fd < 0)
1605                 return fd;
1606
1607         lum = llapi_layout_to_lum(layout);
1608
1609         if (lum == NULL) {
1610                 tmp = errno;
1611                 close(fd);
1612                 errno = tmp;
1613                 return -1;
1614         }
1615
1616         if (lum->lmm_magic == LOV_USER_MAGIC_COMP_V1)
1617                 lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
1618         else if (lum->lmm_magic == LOV_USER_MAGIC_SPECIFIC)
1619                 lum_size = lov_user_md_size(lum->lmm_stripe_count,
1620                                             lum->lmm_magic);
1621         else
1622                 lum_size = lov_user_md_size(0, lum->lmm_magic);
1623
1624         rc = fsetxattr(fd, XATTR_LUSTRE_LOV, lum, lum_size, 0);
1625         if (rc < 0) {
1626                 tmp = errno;
1627                 close(fd);
1628                 errno = tmp;
1629                 fd = -1;
1630         }
1631
1632         free(lum);
1633         errno = errno == EOPNOTSUPP ? ENOTTY : errno;
1634
1635         return fd;
1636 }
1637
1638 /**
1639  * Create a file with a given \a layout.
1640  *
1641  * Force O_CREAT and O_EXCL flags on so caller is assured that file was
1642  * created with the given \a layout on successful function return.
1643  *
1644  * \param[in] path              name of the file to open
1645  * \param[in] open_flags        open() flags
1646  * \param[in] mode              permissions to create new file with
1647  * \param[in] layout            layout to create new file with
1648  *
1649  * \retval              non-negative file descriptor on successful open
1650  * \retval              -1 if an error occurred
1651  */
1652 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1653                              const struct llapi_layout *layout)
1654 {
1655         return llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode,
1656                                       layout);
1657 }
1658
1659 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags)
1660 {
1661         if (layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1662                 errno = EINVAL;
1663                 return -1;
1664         }
1665
1666         *flags = layout->llot_flags;
1667         return 0;
1668 }
1669
1670 /**
1671  * Set flags to the header of a component layout.
1672  */
1673 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags)
1674 {
1675         if (layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1676                 errno = EINVAL;
1677                 return -1;
1678         }
1679
1680         layout->llot_flags = flags;
1681         return 0;
1682 }
1683
1684 const char *llapi_layout_flags_string(uint32_t flags)
1685 {
1686         switch (flags & LCM_FL_FLR_MASK) {
1687         case LCM_FL_RDONLY:
1688                 return "ro";
1689         case LCM_FL_WRITE_PENDING:
1690                 return "wp";
1691         case LCM_FL_SYNC_PENDING:
1692                 return "sp";
1693         }
1694
1695         return "0";
1696 }
1697
1698 const __u16 llapi_layout_string_flags(char *string)
1699 {
1700         if (strncmp(string, "ro", strlen(string)) == 0)
1701                 return LCM_FL_RDONLY;
1702         if (strncmp(string, "wp", strlen(string)) == 0)
1703                 return LCM_FL_WRITE_PENDING;
1704         if (strncmp(string, "sp", strlen(string)) == 0)
1705                 return LCM_FL_SYNC_PENDING;
1706
1707         return 0;
1708 }
1709
1710 /**
1711  * llapi_layout_mirror_count_is_valid() - Check the validity of mirror count.
1712  * @count: Mirror count value to be checked.
1713  *
1714  * This function checks the validity of mirror count.
1715  *
1716  * Return: true on success or false on failure.
1717  */
1718 static bool llapi_layout_mirror_count_is_valid(uint16_t count)
1719 {
1720         return count >= 0 && count <= LUSTRE_MIRROR_COUNT_MAX;
1721 }
1722
1723 /**
1724  * llapi_layout_mirror_count_get() - Get mirror count from the header of
1725  *                                   a layout.
1726  * @layout: Layout to get mirror count from.
1727  * @count:  Returned mirror count value.
1728  *
1729  * This function gets mirror count from the header of a layout.
1730  *
1731  * Return: 0 on success or -1 on failure.
1732  */
1733 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1734                                   uint16_t *count)
1735 {
1736         if (layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1737                 errno = EINVAL;
1738                 return -1;
1739         }
1740
1741         *count = layout->llot_mirror_count;
1742         return 0;
1743 }
1744
1745 /**
1746  * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1747  * @layout: Layout to set mirror count in.
1748  * @count:  Mirror count value to be set.
1749  *
1750  * This function sets mirror count to the header of a layout.
1751  *
1752  * Return: 0 on success or -1 on failure.
1753  */
1754 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1755                                   uint16_t count)
1756 {
1757         if (layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1758                 errno = EINVAL;
1759                 return -1;
1760         }
1761
1762         if (!llapi_layout_mirror_count_is_valid(count)) {
1763                 errno = EINVAL;
1764                 return -1;
1765         }
1766
1767         layout->llot_mirror_count = count;
1768         return 0;
1769 }
1770
1771 /**
1772  * Fetch the start and end offset of the current layout component.
1773  *
1774  * \param[in] layout    the layout component
1775  * \param[out] start    extent start, inclusive
1776  * \param[out] end      extent end, exclusive
1777  *
1778  * \retval      0 on success
1779  * \retval      <0 if error occurs
1780  */
1781 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1782                                  uint64_t *start, uint64_t *end)
1783 {
1784         struct llapi_layout_comp *comp;
1785
1786         comp = __llapi_layout_cur_comp(layout);
1787         if (comp == NULL)
1788                 return -1;
1789
1790         if (start == NULL || end == NULL) {
1791                 errno = EINVAL;
1792                 return -1;
1793         }
1794
1795         *start = comp->llc_extent.e_start;
1796         *end = comp->llc_extent.e_end;
1797
1798         return 0;
1799 }
1800
1801 /**
1802  * Set the layout extent of a layout.
1803  *
1804  * \param[in] layout    the layout to be set
1805  * \param[in] start     extent start, inclusive
1806  * \param[in] end       extent end, exclusive
1807  *
1808  * \retval      0 on success
1809  * \retval      <0 if error occurs
1810  */
1811 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1812                                  uint64_t start, uint64_t end)
1813 {
1814         struct llapi_layout_comp *comp;
1815
1816         comp = __llapi_layout_cur_comp(layout);
1817         if (comp == NULL)
1818                 return -1;
1819
1820         if (start > end) {
1821                 errno = EINVAL;
1822                 return -1;
1823         }
1824
1825         comp->llc_extent.e_start = start;
1826         comp->llc_extent.e_end = end;
1827         layout->llot_is_composite = true;
1828
1829         return 0;
1830 }
1831
1832 /**
1833  * Gets the attribute flags of the current component.
1834  *
1835  * \param[in] layout    the layout component
1836  * \param[out] flags    stored the returned component flags
1837  *
1838  * \retval      0 on success
1839  * \retval      <0 if error occurs
1840  */
1841 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1842                                 uint32_t *flags)
1843 {
1844         struct llapi_layout_comp *comp;
1845
1846         comp = __llapi_layout_cur_comp(layout);
1847         if (comp == NULL)
1848                 return -1;
1849
1850         if (flags == NULL) {
1851                 errno = EINVAL;
1852                 return -1;
1853         }
1854
1855         *flags = comp->llc_flags;
1856
1857         return 0;
1858 }
1859
1860 /**
1861  * Sets the specified flags of the current component leaving other flags as-is.
1862  *
1863  * \param[in] layout    the layout component
1864  * \param[in] flags     component flags to be set
1865  *
1866  * \retval      0 on success
1867  * \retval      <0 if error occurs
1868  */
1869 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags)
1870 {
1871         struct llapi_layout_comp *comp;
1872
1873         comp = __llapi_layout_cur_comp(layout);
1874         if (comp == NULL)
1875                 return -1;
1876
1877         comp->llc_flags |= flags;
1878
1879         return 0;
1880 }
1881
1882 /**
1883  * Clears the flags specified in the flags leaving other flags as-is.
1884  *
1885  * \param[in] layout    the layout component
1886  * \param[in] flags     component flags to be cleared
1887  *
1888  * \retval      0 on success
1889  * \retval      <0 if error occurs
1890  */
1891 int llapi_layout_comp_flags_clear(struct llapi_layout *layout,
1892                                   uint32_t flags)
1893 {
1894         struct llapi_layout_comp *comp;
1895
1896         comp = __llapi_layout_cur_comp(layout);
1897         if (comp == NULL)
1898                 return -1;
1899
1900         comp->llc_flags &= ~flags;
1901
1902         return 0;
1903 }
1904
1905 /**
1906  * Fetches the file-unique component ID of the current layout component.
1907  *
1908  * \param[in] layout    the layout component
1909  * \param[out] id       stored the returned component ID
1910  *
1911  * \retval      0 on success
1912  * \retval      <0 if error occurs
1913  */
1914 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id)
1915 {
1916         struct llapi_layout_comp *comp;
1917
1918         comp = __llapi_layout_cur_comp(layout);
1919         if (comp == NULL)
1920                 return -1;
1921
1922         if (id == NULL) {
1923                 errno = EINVAL;
1924                 return -1;
1925         }
1926         *id = comp->llc_id;
1927
1928         return 0;
1929 }
1930
1931 /**
1932  * Return the mirror id of the current layout component.
1933  *
1934  * \param[in] layout    the layout component
1935  * \param[out] id       stored the returned mirror ID
1936  *
1937  * \retval      0 on success
1938  * \retval      <0 if error occurs
1939  */
1940 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id)
1941 {
1942         struct llapi_layout_comp *comp;
1943
1944         comp = __llapi_layout_cur_comp(layout);
1945         if (comp == NULL)
1946                 return -1;
1947
1948         if (id == NULL) {
1949                 errno = EINVAL;
1950                 return -1;
1951         }
1952
1953         *id = mirror_id_of(comp->llc_id);
1954
1955         return 0;
1956 }
1957
1958 /**
1959  * Adds a component to \a layout, the new component will be added to
1960  * the tail of components list and it'll inherit attributes of existing
1961  * ones. The \a layout will change it's current component pointer to
1962  * the newly added component, and it'll be turned into a composite
1963  * layout if it was not before the adding.
1964  *
1965  * \param[in] layout    existing composite or plain layout
1966  *
1967  * \retval      0 on success
1968  * \retval      <0 if error occurs
1969  */
1970 int llapi_layout_comp_add(struct llapi_layout *layout)
1971 {
1972         struct llapi_layout_comp *last, *comp, *new;
1973         bool composite = layout->llot_is_composite;
1974
1975         comp = __llapi_layout_cur_comp(layout);
1976         if (comp == NULL)
1977                 return -1;
1978
1979         new = __llapi_comp_alloc(0);
1980         if (new == NULL)
1981                 return -1;
1982
1983         last = list_entry(layout->llot_comp_list.prev, typeof(*last),
1984                           llc_list);
1985
1986         list_add_tail(&new->llc_list, &layout->llot_comp_list);
1987
1988         /* We must mark the layout composite for the sanity check, but it may
1989          * not stay that way if the check fails */
1990         layout->llot_is_composite = true;
1991         layout->llot_cur_comp = new;
1992
1993         /* We need to set a temporary non-zero value for "end" when we call
1994          * comp_extent_set, so we use LUSTRE_EOF-1, which is > all allowed
1995          * for the end of the previous component.  (If we're adding this
1996          * component, the end of the previous component cannot be EOF.) */
1997         if (llapi_layout_comp_extent_set(layout, last->llc_extent.e_end,
1998                                         LUSTRE_EOF - 1)) {
1999                 llapi_layout_comp_del(layout);
2000                 layout->llot_is_composite = composite;
2001                 return -1;
2002         }
2003
2004         return 0;
2005 }
2006 /**
2007  * Adds a first component of a mirror to \a layout.
2008  * The \a layout will change it's current component pointer to
2009  * the newly added component, and it'll be turned into a composite
2010  * layout if it was not before the adding.
2011  *
2012  * \param[in] layout            existing composite or plain layout
2013  *
2014  * \retval      0 on success
2015  * \retval      <0 if error occurs
2016  */
2017 int llapi_layout_add_first_comp(struct llapi_layout *layout)
2018 {
2019         struct llapi_layout_comp *comp, *new;
2020
2021         comp = __llapi_layout_cur_comp(layout);
2022         if (comp == NULL)
2023                 return -1;
2024
2025         new = __llapi_comp_alloc(0);
2026         if (new == NULL)
2027                 return -1;
2028
2029         new->llc_extent.e_start = 0;
2030
2031         list_add_tail(&new->llc_list, &layout->llot_comp_list);
2032         layout->llot_cur_comp = new;
2033         layout->llot_is_composite = true;
2034
2035         return 0;
2036 }
2037
2038 /**
2039  * Deletes current component from the composite layout. The component
2040  * to be deleted must be the tail of components list, and it can't be
2041  * the only component in the layout.
2042  *
2043  * \param[in] layout    composite layout
2044  *
2045  * \retval      0 on success
2046  * \retval      <0 if error occurs
2047  */
2048 int llapi_layout_comp_del(struct llapi_layout *layout)
2049 {
2050         struct llapi_layout_comp *comp;
2051
2052         comp = __llapi_layout_cur_comp(layout);
2053         if (comp == NULL)
2054                 return -1;
2055
2056         if (!layout->llot_is_composite) {
2057                 errno = EINVAL;
2058                 return -1;
2059         }
2060
2061         /* It must be the tail of the list (for PFL, can be relaxed
2062          * once we get mirrored components) */
2063         if (comp->llc_list.next != &layout->llot_comp_list) {
2064                 errno = EINVAL;
2065                 return -1;
2066         }
2067         layout->llot_cur_comp =
2068                 list_entry(comp->llc_list.prev, typeof(*comp), llc_list);
2069         if (comp->llc_list.prev == &layout->llot_comp_list)
2070                 layout->llot_cur_comp = NULL;
2071
2072         list_del_init(&comp->llc_list);
2073         __llapi_comp_free(comp);
2074
2075         return 0;
2076 }
2077
2078 /**
2079  * Move the current component pointer to the component with
2080  * specified component ID.
2081  *
2082  * \param[in] layout    composite layout
2083  * \param[in] id        component ID
2084  *
2085  * \retval      =0 : moved successfully
2086  * \retval      <0 if error occurs
2087  */
2088 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t comp_id)
2089 {
2090         struct llapi_layout_comp *comp;
2091
2092         comp = __llapi_layout_cur_comp(layout);
2093         if (comp == NULL)
2094                 return -1; /* use previously set errno */
2095
2096         if (!layout->llot_is_composite) {
2097                 errno = EINVAL;
2098                 return -1;
2099         }
2100
2101         if (comp_id == LCME_ID_INVAL) {
2102                 errno = EINVAL;
2103                 return -1;
2104         }
2105
2106         list_for_each_entry(comp, &layout->llot_comp_list, llc_list) {
2107                 if (comp->llc_id == comp_id) {
2108                         layout->llot_cur_comp = comp;
2109                         return 0;
2110                 }
2111         }
2112         errno = ENOENT;
2113         return -1;
2114 }
2115
2116 /**
2117  * Move the current component pointer to a specified position.
2118  *
2119  * \param[in] layout    composite layout
2120  * \param[in] pos       the position to be moved, it can be:
2121  *                      LLAPI_LAYOUT_COMP_USE_FIRST: use first component
2122  *                      LLAPI_LAYOUT_COMP_USE_LAST: use last component
2123  *                      LLAPI_LAYOUT_COMP_USE_NEXT: use component after current
2124  *                      LLAPI_LAYOUT_COMP_USE_PREV: use component before current
2125  *
2126  * \retval      =0 : moved successfully
2127  * \retval      =1 : at last component with NEXT, at first component with PREV
2128  * \retval      <0 if error occurs
2129  */
2130 int llapi_layout_comp_use(struct llapi_layout *layout,
2131                           enum llapi_layout_comp_use pos)
2132 {
2133         struct llapi_layout_comp *comp, *head, *tail;
2134
2135         comp = __llapi_layout_cur_comp(layout);
2136         if (comp == NULL)
2137                 return -1;
2138
2139         if (!layout->llot_is_composite) {
2140                 if (pos == LLAPI_LAYOUT_COMP_USE_FIRST ||
2141                     pos == LLAPI_LAYOUT_COMP_USE_LAST)
2142                         return 0;
2143                 errno = ENOENT;
2144                 return 1;
2145         }
2146
2147         head = list_entry(layout->llot_comp_list.next, typeof(*head), llc_list);
2148         tail = list_entry(layout->llot_comp_list.prev, typeof(*tail), llc_list);
2149         switch (pos) {
2150         case LLAPI_LAYOUT_COMP_USE_FIRST:
2151                 layout->llot_cur_comp = head;
2152                 break;
2153         case LLAPI_LAYOUT_COMP_USE_NEXT:
2154                 if (comp == tail) {
2155                         errno = ENOENT;
2156                         return 1;
2157                 }
2158                 layout->llot_cur_comp = list_entry(comp->llc_list.next,
2159                                                    typeof(*comp), llc_list);
2160                 break;
2161         case LLAPI_LAYOUT_COMP_USE_LAST:
2162                 layout->llot_cur_comp = tail;
2163                 break;
2164         case LLAPI_LAYOUT_COMP_USE_PREV:
2165                 if (comp == head) {
2166                         errno = ENOENT;
2167                         return 1;
2168                 }
2169                 layout->llot_cur_comp = list_entry(comp->llc_list.prev,
2170                                                    typeof(*comp), llc_list);
2171                 break;
2172         default:
2173                 errno = EINVAL;
2174                 return -1;
2175         }
2176
2177         return 0;
2178 }
2179
2180 /**
2181  * Add layout component(s) to an existing file.
2182  *
2183  * \param[in] path      The path name of the file
2184  * \param[in] layout    The layout component(s) to be added
2185  */
2186 int llapi_layout_file_comp_add(const char *path,
2187                                const struct llapi_layout *layout)
2188 {
2189         int rc, fd = -1, lum_size, tmp_errno = 0;
2190         struct llapi_layout *existing_layout = NULL;
2191         struct lov_user_md *lum = NULL;
2192
2193         if (path == NULL || layout == NULL ||
2194             layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
2195                 errno = EINVAL;
2196                 return -1;
2197         }
2198
2199         fd = open(path, O_RDWR);
2200         if (fd < 0) {
2201                 tmp_errno = errno;
2202                 rc = -1;
2203                 goto out;
2204         }
2205
2206         existing_layout = llapi_layout_get_by_fd(fd, 0);
2207         if (existing_layout == NULL) {
2208                 tmp_errno = errno;
2209                 rc = -1;
2210                 goto out;
2211         }
2212
2213         rc = llapi_layout_merge(&existing_layout, layout);
2214         if (rc) {
2215                 tmp_errno = errno;
2216                 rc = -1;
2217                 goto out;
2218         }
2219
2220         rc = llapi_layout_sanity(existing_layout, false, false);
2221         if (rc) {
2222                 tmp_errno = errno;
2223                 llapi_layout_sanity_perror(rc);
2224                 rc = -1;
2225                 goto out;
2226         }
2227
2228         lum = llapi_layout_to_lum(layout);
2229         if (lum == NULL) {
2230                 tmp_errno = errno;
2231                 rc = -1;
2232                 goto out;
2233         }
2234
2235         if (lum->lmm_magic != LOV_USER_MAGIC_COMP_V1) {
2236                 tmp_errno = EINVAL;
2237                 rc = -1;
2238                 goto out;
2239         }
2240         lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
2241
2242         rc = fsetxattr(fd, XATTR_LUSTRE_LOV".add", lum, lum_size, 0);
2243         if (rc < 0) {
2244                 tmp_errno = errno;
2245                 rc = -1;
2246                 goto out;
2247         }
2248 out:
2249         if (fd >= 0)
2250                 close(fd);
2251         free(lum);
2252         llapi_layout_free(existing_layout);
2253         errno = tmp_errno;
2254         return rc;
2255 }
2256
2257 /**
2258  * Delete component(s) by the specified component id or component flags
2259  * from an existing file.
2260  *
2261  * \param[in] path      path name of the file
2262  * \param[in] id        unique component ID
2263  * \param[in] flags     flags: LCME_FL_* or;
2264  *                      negative flags: (LCME_FL_NEG|LCME_FL_*)
2265  */
2266 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags)
2267 {
2268         int rc = 0, fd = -1, lum_size, tmp_errno = 0;
2269         struct llapi_layout *layout;
2270         struct llapi_layout_comp *comp, *next;
2271         struct llapi_layout *existing_layout = NULL;
2272         struct lov_user_md *lum = NULL;
2273
2274         if (path == NULL || id > LCME_ID_MAX || (flags & ~LCME_KNOWN_FLAGS)) {
2275                 errno = EINVAL;
2276                 return -1;
2277         }
2278
2279         /* Can only specify ID or flags, not both, not none. */
2280         if ((id != LCME_ID_INVAL && flags != 0) ||
2281             (id == LCME_ID_INVAL && flags == 0)) {
2282                 errno = EINVAL;
2283                 return -1;
2284         }
2285
2286         layout = llapi_layout_alloc();
2287         if (layout == NULL)
2288                 return -1;
2289
2290         llapi_layout_comp_extent_set(layout, 0, LUSTRE_EOF);
2291         comp = __llapi_layout_cur_comp(layout);
2292         if (comp == NULL) {
2293                 tmp_errno = errno;
2294                 rc = -1;
2295                 goto out;
2296         }
2297
2298         comp->llc_id = id;
2299         comp->llc_flags = flags;
2300
2301         lum = llapi_layout_to_lum(layout);
2302         if (lum == NULL) {
2303                 tmp_errno = errno;
2304                 rc = -1;
2305                 goto out;
2306         }
2307         lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
2308
2309         fd = open(path, O_RDWR);
2310         if (fd < 0) {
2311                 tmp_errno = errno;
2312                 rc = -1;
2313                 goto out;
2314         }
2315
2316         existing_layout = llapi_layout_get_by_fd(fd, 0);
2317         if (existing_layout == NULL) {
2318                 tmp_errno = errno;
2319                 rc = -1;
2320                 goto out;
2321         }
2322
2323         comp = NULL;
2324         next = NULL;
2325         while (rc == 0 && existing_layout->llot_cur_comp != NULL) {
2326                 rc = llapi_layout_comp_use(existing_layout, comp ?
2327                                            LLAPI_LAYOUT_COMP_USE_PREV :
2328                                            LLAPI_LAYOUT_COMP_USE_LAST);
2329                 if (rc != 0)
2330                         break;
2331
2332                 next = comp;
2333                 comp = __llapi_layout_cur_comp(existing_layout);
2334                 if (comp == NULL) {
2335                         rc = -1;
2336                         break;
2337                 }
2338
2339                 if (id != LCME_ID_INVAL && id != comp->llc_id)
2340                         continue;
2341                 else if ((flags & LCME_FL_NEG) && (flags & comp->llc_flags))
2342                         continue;
2343                 else if (flags && !(flags & comp->llc_flags))
2344                         continue;
2345
2346                 rc = llapi_layout_comp_del(existing_layout);
2347                 /* the layout position is moved to previous one, adjust */
2348                 comp = next;
2349         }
2350         if (rc < 0) {
2351                 tmp_errno = errno;
2352                 goto out;
2353         }
2354
2355         rc = llapi_layout_sanity(existing_layout, false, false);
2356         if (rc) {
2357                 tmp_errno = errno;
2358                 llapi_layout_sanity_perror(rc);
2359                 rc = -1;
2360                 goto out;
2361         }
2362
2363         rc = fsetxattr(fd, XATTR_LUSTRE_LOV".del", lum, lum_size, 0);
2364         if (rc < 0) {
2365                 tmp_errno = errno;
2366                 rc = -1;
2367                 goto out;
2368         }
2369
2370 out:
2371         if (fd >= 0)
2372                 close(fd);
2373         free(lum);
2374         llapi_layout_free(layout);
2375         llapi_layout_free(existing_layout);
2376         errno = tmp_errno;
2377
2378         return rc;
2379 }
2380
2381 /* Internal utility function to apply flags for sanity checking */
2382 static void llapi_layout_comp_apply_flags(struct llapi_layout_comp *comp,
2383                                           uint32_t flags)
2384 {
2385         if (flags & LCME_FL_NEG)
2386                 comp->llc_flags &= ~flags;
2387         else
2388                 comp->llc_flags |= flags;
2389 }
2390
2391 struct llapi_layout_apply_flags_args {
2392         uint32_t *lfa_ids;
2393         uint32_t *lfa_flags;
2394         int lfa_count;
2395         int lfa_rc;
2396 };
2397
2398
2399 static int llapi_layout_apply_flags_cb(struct llapi_layout *layout,
2400                                        void *arg)
2401 {
2402         struct llapi_layout_apply_flags_args *args = arg;
2403         struct llapi_layout_comp *comp;
2404         int i = 0;
2405
2406         comp = __llapi_layout_cur_comp(layout);
2407         if (comp == NULL) {
2408                 args->lfa_rc = -1;
2409                 return LLAPI_LAYOUT_ITER_STOP;
2410         }
2411
2412         for (i = 0; i < args->lfa_count; i++) {
2413                 if (comp->llc_id == args->lfa_ids[i])
2414                         llapi_layout_comp_apply_flags(comp, args->lfa_flags[i]);
2415         }
2416
2417         return LLAPI_LAYOUT_ITER_CONT;
2418 }
2419
2420 /* Apply flags to the layout for sanity checking */
2421 static int llapi_layout_apply_flags(struct llapi_layout *layout, uint32_t *ids,
2422                                     uint32_t *flags, int count)
2423 {
2424         struct llapi_layout_apply_flags_args args;
2425         int rc = 0;
2426
2427         if (!ids || !flags || count == 0) {
2428                 errno = EINVAL;
2429                 return -1;
2430         }
2431
2432         args.lfa_ids = ids;
2433         args.lfa_flags = flags;
2434         args.lfa_count = count;
2435         args.lfa_rc = 0;
2436
2437         rc = llapi_layout_comp_iterate(layout,
2438                                        llapi_layout_apply_flags_cb,
2439                                        &args);
2440         if (errno == ENOENT)
2441                 errno = 0;
2442
2443         if (rc != LLAPI_LAYOUT_ITER_CONT)
2444                 rc = args.lfa_rc;
2445
2446         return rc;
2447 }
2448 /**
2449  * Change flags by component ID of components of an existing file.
2450  * The component to be modified is specified by the comp->lcme_id value,
2451  * which must be a unique component ID.
2452  *
2453  * \param[in] path      path name of the file
2454  * \param[in] ids       An array of component IDs
2455  * \param[in] flags     flags: LCME_FL_* or;
2456  *                      negative flags: (LCME_FL_NEG|LCME_FL_*)
2457  * \param[in] count     Number of elements in ids and flags array
2458  */
2459 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
2460                                size_t count)
2461 {
2462         int rc = -1, fd = -1, i, tmp_errno = 0;
2463         size_t lum_size;
2464         struct llapi_layout *existing_layout = NULL;
2465         struct llapi_layout *layout = NULL;
2466         struct llapi_layout_comp *comp;
2467         struct lov_user_md *lum = NULL;
2468
2469         if (path == NULL) {
2470                 errno = EINVAL;
2471                 return -1;
2472         }
2473
2474         if (!count)
2475                 return 0;
2476
2477         for (i = 0; i < count; i++) {
2478                 if (!ids[i] || !flags[i]) {
2479                         errno = EINVAL;
2480                         return -1;
2481                 }
2482
2483                 if (ids[i] > LCME_ID_MAX || (flags[i] & ~LCME_KNOWN_FLAGS)) {
2484                         errno = EINVAL;
2485                         return -1;
2486                 }
2487
2488                 /* do not allow to set or clear INIT flag */
2489                 if (flags[i] & LCME_FL_INIT) {
2490                         errno = EINVAL;
2491                         return -1;
2492                 }
2493         }
2494
2495         fd = open(path, O_RDWR);
2496         if (fd < 0) {
2497                 tmp_errno = errno;
2498                 rc = -1;
2499                 goto out;
2500         }
2501
2502         existing_layout = llapi_layout_get_by_fd(fd, 0);
2503         if (existing_layout == NULL) {
2504                 tmp_errno = errno;
2505                 rc = -1;
2506                 goto out;
2507         }
2508
2509         if (llapi_layout_apply_flags(existing_layout, ids, flags, count)) {
2510                 tmp_errno = errno;
2511                 rc = -1;
2512                 goto out;
2513         }
2514
2515         rc = llapi_layout_sanity(existing_layout, false, false);
2516         if (rc) {
2517                 tmp_errno = errno;
2518                 llapi_layout_sanity_perror(rc);
2519                 rc = -1;
2520                 goto out;
2521         }
2522
2523         layout = __llapi_layout_alloc();
2524         if (layout == NULL) {
2525                 tmp_errno = errno;
2526                 rc = -1;
2527                 goto out;
2528         }
2529
2530         layout->llot_is_composite = true;
2531         for (i = 0; i < count; i++) {
2532                 comp = __llapi_comp_alloc(0);
2533                 if (comp == NULL) {
2534                         tmp_errno = errno;
2535                         rc = -1;
2536                         goto out;
2537                 }
2538
2539                 comp->llc_id = ids[i];
2540                 comp->llc_flags = flags[i];
2541
2542                 list_add_tail(&comp->llc_list, &layout->llot_comp_list);
2543                 layout->llot_cur_comp = comp;
2544         }
2545
2546         lum = llapi_layout_to_lum(layout);
2547         if (lum == NULL) {
2548                 tmp_errno = errno;
2549                 rc = -1;
2550                 goto out;
2551         }
2552
2553         lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
2554
2555         /* flush cached pages from clients */
2556         rc = llapi_file_flush(fd);
2557         if (rc) {
2558                 tmp_errno = -rc;
2559                 rc = -1;
2560                 goto out;
2561         }
2562
2563         rc = fsetxattr(fd, XATTR_LUSTRE_LOV".set.flags", lum, lum_size, 0);
2564         if (rc < 0) {
2565                 tmp_errno = errno;
2566                 goto out;
2567         }
2568
2569         rc = 0;
2570
2571 out:
2572         if (fd >= 0)
2573                 close(fd);
2574
2575         free(lum);
2576         llapi_layout_free(existing_layout);
2577         llapi_layout_free(layout);
2578         errno = tmp_errno;
2579         return rc;
2580 }
2581
2582 /**
2583  * Check if the file layout is composite.
2584  *
2585  * \param[in] layout    the file layout to check
2586  *
2587  * \retval true         composite
2588  * \retval false        not composite
2589  */
2590 bool llapi_layout_is_composite(struct llapi_layout *layout)
2591 {
2592         return layout->llot_is_composite;
2593 }
2594
2595 /**
2596  * Iterate every components in the @layout and call callback function @cb.
2597  *
2598  * \param[in] layout    component layout list.
2599  * \param[in] cb        callback for each component
2600  * \param[in] cbdata    callback data
2601  *
2602  * \retval < 0                          error happens during the iteration
2603  * \retval LLAPI_LAYOUT_ITER_CONT       finished the iteration w/o error
2604  * \retval LLAPI_LAYOUT_ITER_STOP       got something, stop the iteration
2605  */
2606 int llapi_layout_comp_iterate(struct llapi_layout *layout,
2607                               llapi_layout_iter_cb cb, void *cbdata)
2608 {
2609         int rc;
2610
2611         rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_FIRST);
2612         if (rc < 0)
2613                 return rc;
2614
2615         /**
2616          * make sure on success llapi_layout_comp_use() API returns 0 with
2617          * USE_FIRST.
2618          */
2619         assert(rc == 0);
2620
2621         while (1) {
2622                 rc = cb(layout, cbdata);
2623                 if (rc != LLAPI_LAYOUT_ITER_CONT)
2624                         break;
2625
2626                 rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_NEXT);
2627                 if (rc < 0)
2628                         return rc;
2629                 else if (rc == 1)       /* reached the last comp */
2630                         return LLAPI_LAYOUT_ITER_CONT;
2631         }
2632
2633         return rc;
2634 }
2635
2636 /**
2637  * llapi_layout_merge() - Merge a composite layout into another one.
2638  * @dst_layout: Destination composite layout.
2639  * @src_layout: Source composite layout.
2640  *
2641  * This function copies all of the components from @src_layout and
2642  * appends them to @dst_layout.
2643  *
2644  * Return: 0 on success or -1 on failure.
2645  */
2646 int llapi_layout_merge(struct llapi_layout **dst_layout,
2647                        const struct llapi_layout *src_layout)
2648 {
2649         struct llapi_layout *new_layout = *dst_layout;
2650         struct llapi_layout_comp *new = NULL;
2651         struct llapi_layout_comp *comp = NULL;
2652         int i = 0;
2653
2654         if (src_layout == NULL ||
2655             list_empty((struct list_head *)&src_layout->llot_comp_list))
2656                 return 0;
2657
2658         if (new_layout == NULL) {
2659                 new_layout = __llapi_layout_alloc();
2660                 if (new_layout == NULL) {
2661                         errno = ENOMEM;
2662                         return -1;
2663                 }
2664         }
2665
2666         list_for_each_entry(comp, &src_layout->llot_comp_list, llc_list) {
2667                 new = __llapi_comp_alloc(0);
2668                 if (new == NULL) {
2669                         errno = ENOMEM;
2670                         goto error;
2671                 }
2672
2673                 new->llc_pattern = comp->llc_pattern;
2674                 new->llc_stripe_size = comp->llc_stripe_size;
2675                 new->llc_stripe_count = comp->llc_stripe_count;
2676                 new->llc_stripe_offset = comp->llc_stripe_offset;
2677
2678                 if (comp->llc_pool_name[0] != '\0')
2679                         strncpy(new->llc_pool_name, comp->llc_pool_name,
2680                                 sizeof(new->llc_pool_name));
2681
2682                 for (i = 0; i < comp->llc_objects_count; i++) {
2683                         if (__llapi_comp_objects_realloc(new,
2684                             stripe_number_roundup(i)) < 0) {
2685                                 errno = EINVAL;
2686                                 __llapi_comp_free(new);
2687                                 goto error;
2688                         }
2689                         new->llc_objects[i].l_ost_idx = \
2690                                 comp->llc_objects[i].l_ost_idx;
2691                 }
2692
2693                 new->llc_objects_count = comp->llc_objects_count;
2694                 new->llc_extent.e_start = comp->llc_extent.e_start;
2695                 new->llc_extent.e_end = comp->llc_extent.e_end;
2696                 new->llc_id = comp->llc_id;
2697                 new->llc_flags = comp->llc_flags;
2698
2699                 list_add_tail(&new->llc_list, &new_layout->llot_comp_list);
2700                 new_layout->llot_cur_comp = new;
2701         }
2702         new_layout->llot_is_composite = true;
2703
2704         *dst_layout = new_layout;
2705         return 0;
2706 error:
2707         llapi_layout_free(new_layout);
2708         return -1;
2709 }
2710
2711 /**
2712  * Get the last initialized component
2713  *
2714  * \param[in] layout    component layout list.
2715  *
2716  * \retval 0            found
2717  * \retval -EINVAL      not found
2718  * \retval -EISDIR      directory layout
2719  */
2720 int llapi_layout_get_last_init_comp(struct llapi_layout *layout)
2721 {
2722         struct llapi_layout_comp *comp = NULL, *head = NULL;
2723
2724         if (!layout->llot_is_composite)
2725                 return 0;
2726
2727         head = list_entry(layout->llot_comp_list.next, typeof(*comp), llc_list);
2728         if (head == NULL)
2729                 return -EINVAL;
2730         if (head->llc_id == 0 && !(head->llc_flags & LCME_FL_INIT))
2731                 /* a directory */
2732                 return -EISDIR;
2733
2734         /* traverse the components from the tail to find the last init one */
2735         comp = list_entry(layout->llot_comp_list.prev, typeof(*comp), llc_list);
2736         while (comp != head) {
2737                 if (comp->llc_flags & LCME_FL_INIT)
2738                         break;
2739                 comp = list_entry(comp->llc_list.prev, typeof(*comp), llc_list);
2740         }
2741
2742         layout->llot_cur_comp = comp;
2743
2744         return comp->llc_flags & LCME_FL_INIT ? 0 : -EINVAL;
2745 }
2746
2747 /**
2748  * Interit stripe info from the file's component to the mirror
2749  *
2750  * \param[in] layout    file component layout list.
2751  * \param[in] layout    mirro component layout list.
2752  *
2753  * \retval 0            on success
2754  * \retval -EINVAL      on error
2755  */
2756 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
2757                                 struct llapi_layout *m_layout)
2758 {
2759         struct llapi_layout_comp *m_comp = NULL;
2760         struct llapi_layout_comp *f_comp = NULL;
2761         int rc = 0;
2762
2763         f_comp = __llapi_layout_cur_comp(f_layout);
2764         if (f_comp == NULL)
2765                 return -EINVAL;
2766         m_comp = __llapi_layout_cur_comp(m_layout);
2767         if (m_comp == NULL)
2768                 return -EINVAL;
2769
2770         m_comp->llc_stripe_size = f_comp->llc_stripe_size;
2771         m_comp->llc_stripe_count = f_comp->llc_stripe_count;
2772
2773         return rc;
2774 }
2775
2776 /**
2777  * Find all stale components.
2778  *
2779  * \param[in] layout            component layout list.
2780  * \param[out] comp             array of stale component info.
2781  * \param[in] comp_size         array size of @comp.
2782  * \param[in] mirror_ids        array of mirror id that only components
2783  *                              belonging to these mirror will be collected.
2784  * \param[in] ids_nr            number of mirror ids array.
2785  *
2786  * \retval              number of component info collected on sucess or
2787  *                      an error code on failure.
2788  */
2789 int llapi_mirror_find_stale(struct llapi_layout *layout,
2790                 struct llapi_resync_comp *comp, size_t comp_size,
2791                 __u16 *mirror_ids, int ids_nr)
2792 {
2793         int idx = 0;
2794         int rc;
2795
2796         rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_FIRST);
2797         if (rc < 0)
2798                 goto error;
2799
2800         while (rc == 0) {
2801                 uint32_t id;
2802                 uint32_t mirror_id;
2803                 uint32_t flags;
2804                 uint64_t start, end;
2805
2806                 rc = llapi_layout_comp_flags_get(layout, &flags);
2807                 if (rc < 0)
2808                         goto error;
2809
2810                 if (!(flags & LCME_FL_STALE))
2811                         goto next;
2812
2813                 rc = llapi_layout_mirror_id_get(layout, &mirror_id);
2814                 if (rc < 0)
2815                         goto error;
2816
2817                 /* the caller only wants stale components from specific
2818                  * mirrors */
2819                 if (ids_nr > 0) {
2820                         int j;
2821
2822                         for (j = 0; j < ids_nr; j++) {
2823                                 if (mirror_ids[j] == mirror_id)
2824                                         break;
2825                         }
2826
2827                         /* not in the specified mirror */
2828                         if (j == ids_nr)
2829                                 goto next;
2830                 } else if (flags & LCME_FL_NOSYNC) {
2831                         /* if not specified mirrors, do not resync "nosync"
2832                          * mirrors */
2833                         goto next;
2834                 }
2835
2836                 rc = llapi_layout_comp_id_get(layout, &id);
2837                 if (rc < 0)
2838                         goto error;
2839
2840                 rc = llapi_layout_comp_extent_get(layout, &start, &end);
2841                 if (rc < 0)
2842                         goto error;
2843
2844                 /* pack this component into @comp array */
2845                 comp[idx].lrc_id = id;
2846                 comp[idx].lrc_mirror_id = mirror_id;
2847                 comp[idx].lrc_start = start;
2848                 comp[idx].lrc_end = end;
2849                 idx++;
2850
2851                 if (idx >= comp_size) {
2852                         rc = -EINVAL;
2853                         goto error;
2854                 }
2855
2856         next:
2857                 rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_NEXT);
2858                 if (rc < 0) {
2859                         rc = -EINVAL;
2860                         goto error;
2861                 }
2862         }
2863 error:
2864         return rc < 0 ? rc : idx;
2865 }
2866
2867 /* locate @layout to a valid component covering file [file_start, file_end) */
2868 uint32_t llapi_mirror_find(struct llapi_layout *layout,
2869                            uint64_t file_start, uint64_t file_end,
2870                            uint64_t *endp)
2871 {
2872         uint32_t mirror_id = 0;
2873         int rc;
2874
2875         rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_FIRST);
2876         if (rc < 0)
2877                 return rc;
2878
2879         *endp = 0;
2880         while (rc == 0) {
2881                 uint64_t start, end;
2882                 uint32_t flags, id, rid;
2883
2884                 rc = llapi_layout_comp_flags_get(layout, &flags);
2885                 if (rc < 0)
2886                         return rc;
2887
2888                 if (flags & LCME_FL_STALE)
2889                         goto next;
2890
2891                 rc = llapi_layout_mirror_id_get(layout, &rid);
2892                 if (rc < 0)
2893                         return rc;
2894
2895                 rc = llapi_layout_comp_id_get(layout, &id);
2896                 if (rc < 0)
2897                         return rc;
2898
2899                 rc = llapi_layout_comp_extent_get(layout, &start, &end);
2900                 if (rc < 0)
2901                         return rc;
2902
2903                 if (file_start >= start && file_start < end) {
2904                         if (!mirror_id)
2905                                 mirror_id = rid;
2906                         else if (mirror_id != rid || *endp != start)
2907                                 break;
2908
2909                         file_start = *endp = end;
2910                         if (end >= file_end)
2911                                 break;
2912                 }
2913
2914         next:
2915                 rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_NEXT);
2916                 if (rc < 0)
2917                         return rc;
2918         }
2919         if (!mirror_id)
2920                 return -ENOENT;
2921
2922         return mirror_id;
2923 }
2924
2925 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
2926                              struct llapi_resync_comp *comp_array,
2927                              int comp_size,  uint64_t start, uint64_t end)
2928 {
2929         size_t page_size = sysconf(_SC_PAGESIZE);
2930         const size_t buflen = 4 << 20; /* 4M */
2931         void *buf;
2932         uint64_t pos = start;
2933         uint64_t data_off = pos, data_end = pos;
2934         uint32_t src = 0;
2935         int i;
2936         int rc;
2937         int rc2 = 0;
2938
2939         rc = posix_memalign(&buf, page_size, buflen);
2940         if (rc)
2941                 return -rc;
2942
2943         while (pos < end) {
2944                 uint64_t mirror_end;
2945                 ssize_t bytes_read;
2946                 size_t to_read;
2947                 size_t to_write;
2948
2949                 if (pos >= data_end) {
2950                         off_t tmp_off;
2951                         size_t data_size;
2952
2953                         if (pos >= mirror_end || !src) {
2954                                 rc = llapi_mirror_find(layout, pos, end,
2955                                                         &mirror_end);
2956                                 if (rc < 0)
2957                                         return rc;
2958                                 src = rc;
2959                                 /* restrict mirror end by resync end */
2960                                 mirror_end = MIN(end, mirror_end);
2961                         }
2962
2963                         tmp_off = llapi_mirror_data_seek(fd, src, pos,
2964                                                          &data_size);
2965                         if (tmp_off < 0) {
2966                                 /* switch to full copy */
2967                                 to_read = mirror_end - pos;
2968                                 goto do_read;
2969                         }
2970                         data_off = tmp_off;
2971                         data_end = data_off + data_size;
2972
2973                         data_off = MIN(data_off, mirror_end);
2974                         data_end = MIN(data_end, mirror_end);
2975
2976                         /* align by page, if there is data block to copy */
2977                         if (data_size)
2978                                 data_off &= ~(page_size - 1);
2979                 }
2980
2981                 if (pos < data_off) {
2982                         for (i = 0; i < comp_size; i++) {
2983                                 uint64_t cur_pos;
2984                                 size_t to_punch;
2985                                 uint32_t mid = comp_array[i].lrc_mirror_id;
2986
2987                                 /* skip non-overlapped component */
2988                                 if (pos >= comp_array[i].lrc_end ||
2989                                     data_off <= comp_array[i].lrc_start)
2990                                         continue;
2991
2992                                 if (pos < comp_array[i].lrc_start)
2993                                         cur_pos = comp_array[i].lrc_start;
2994                                 else
2995                                         cur_pos = pos;
2996
2997                                 if (data_off > comp_array[i].lrc_end)
2998                                         to_punch = comp_array[i].lrc_end -
2999                                                    cur_pos;
3000                                 else
3001                                         to_punch = data_off - cur_pos;
3002
3003                                 if (comp_array[i].lrc_end == OBD_OBJECT_EOF) {
3004                                         /* the last component can be truncated
3005                                          * safely
3006                                          */
3007                                         rc = llapi_mirror_truncate(fd, mid,
3008                                                                    cur_pos);
3009                                         /* hole at the end of file, so just
3010                                          * truncate up to set size.
3011                                          */
3012                                         if (!rc && data_off == data_end)
3013                                                 rc = llapi_mirror_truncate(fd,
3014                                                                 mid, data_end);
3015                                 } else {
3016                                         rc = llapi_mirror_punch(fd,
3017                                                 comp_array[i].lrc_mirror_id,
3018                                                 cur_pos, to_punch);
3019                                 }
3020                                 /* if failed then read failed hole range */
3021                                 if (rc < 0) {
3022                                         rc = 0;
3023                                         pos = cur_pos;
3024                                         if (pos + to_punch == data_off)
3025                                                 to_read = data_end - pos;
3026                                         else
3027                                                 to_read = to_punch;
3028                                         goto do_read;
3029                                 }
3030                         }
3031                         pos = data_off;
3032                 }
3033                 if (pos == mirror_end)
3034                         continue;
3035                 to_read = data_end - pos;
3036 do_read:
3037                 if (!to_read)
3038                         break;
3039
3040                 assert(data_end <= mirror_end);
3041
3042                 to_read = MIN(buflen, to_read);
3043                 to_read = ((to_read - 1) | (page_size - 1)) + 1;
3044                 bytes_read = llapi_mirror_read(fd, src, buf, to_read, pos);
3045                 if (bytes_read == 0) {
3046                         /* end of file */
3047                         break;
3048                 }
3049                 if (bytes_read < 0) {
3050                         rc = bytes_read;
3051                         break;
3052                 }
3053
3054                 /* round up to page align to make direct IO happy. */
3055                 to_write = ((bytes_read - 1) | (page_size - 1)) + 1;
3056
3057                 for (i = 0; i < comp_size; i++) {
3058                         ssize_t written;
3059                         off_t pos2 = pos;
3060                         size_t to_write2 = to_write;
3061
3062                         /* skip non-overlapped component */
3063                         if (pos >= comp_array[i].lrc_end ||
3064                             pos + to_write <= comp_array[i].lrc_start)
3065                                 continue;
3066
3067                         if (pos < comp_array[i].lrc_start)
3068                                 pos2 = comp_array[i].lrc_start;
3069
3070                         to_write2 -= pos2 - pos;
3071
3072                         if ((pos + to_write) > comp_array[i].lrc_end)
3073                                 to_write2 -= pos + to_write -
3074                                              comp_array[i].lrc_end;
3075
3076                         written = llapi_mirror_write(fd,
3077                                         comp_array[i].lrc_mirror_id,
3078                                         buf + pos2 - pos,
3079                                         to_write2, pos2);
3080                         if (written < 0) {
3081                                 /**
3082                                  * this component is not written successfully,
3083                                  * mark it using its lrc_synced, it is supposed
3084                                  * to be false before getting here.
3085                                  *
3086                                  * And before this function returns, all
3087                                  * elements of comp_array will reverse their
3088                                  * lrc_synced flag to reflect their true
3089                                  * meanings.
3090                                  */
3091                                 comp_array[i].lrc_synced = true;
3092                                 llapi_error(LLAPI_MSG_ERROR, written,
3093                                             "component %u not synced",
3094                                             comp_array[i].lrc_id);
3095                                 if (rc2 == 0)
3096                                         rc2 = (int)written;
3097                                 continue;
3098                         }
3099                         assert(written == to_write2);
3100                 }
3101                 pos += bytes_read;
3102         }
3103
3104         free(buf);
3105
3106         if (rc < 0) {
3107                 /* fatal error happens */
3108                 for (i = 0; i < comp_size; i++)
3109                         comp_array[i].lrc_synced = false;
3110                 return rc;
3111         }
3112
3113         /**
3114          * no fatal error happens, each lrc_synced tells whether the component
3115          * has been resync successfully (note: we'd reverse the value to
3116          * reflect its true meaning.
3117          */
3118         for (i = 0; i < comp_size; i++) {
3119                 comp_array[i].lrc_synced = !comp_array[i].lrc_synced;
3120                 if (comp_array[i].lrc_synced && pos & (page_size - 1)) {
3121                         rc = llapi_mirror_truncate(fd,
3122                                         comp_array[i].lrc_mirror_id, pos);
3123                         if (rc < 0)
3124                                 comp_array[i].lrc_synced = false;
3125                 }
3126         }
3127
3128         /**
3129          * returns the first error code for partially successful resync if
3130          * possible.
3131          */
3132         return rc2;
3133 }
3134
3135 enum llapi_layout_comp_sanity_error {
3136         LSE_OK,
3137         LSE_INCOMPLETE_MIRROR,
3138         LSE_ADJACENT_EXTENSION,
3139         LSE_INIT_EXTENSION,
3140         LSE_FLAGS,
3141         LSE_DOM_EXTENSION,
3142         LSE_DOM_EXTENSION_FOLLOWING,
3143         LSE_DOM_FIRST,
3144         LSE_SET_COMP_START,
3145         LSE_NOT_ZERO_LENGTH_EXTENDABLE,
3146         LSE_END_NOT_GREATER,
3147         LSE_ZERO_LENGTH_NORMAL,
3148         LSE_NOT_ADJACENT_PREV,
3149         LSE_START_GT_END,
3150         LSE_ALIGN_END,
3151         LSE_ALIGN_EXT,
3152         LSE_LAST,
3153 };
3154
3155 const char *const llapi_layout_strerror[] =
3156 {
3157         [LSE_OK] = "",
3158         [LSE_INCOMPLETE_MIRROR] =
3159                 "Incomplete mirror - must go to EOF",
3160         [LSE_ADJACENT_EXTENSION] =
3161                 "No adjacent extension space components",
3162         [LSE_INIT_EXTENSION] =
3163                 "Cannot apply extension flag to init components",
3164         [LSE_FLAGS] =
3165                 "Wrong flags",
3166         [LSE_DOM_EXTENSION] =
3167                 "DoM components can't be extension space",
3168         [LSE_DOM_EXTENSION_FOLLOWING] =
3169                 "DoM components cannot be followed by extension space",
3170         [LSE_DOM_FIRST] =
3171                 "DoM component should be the first one in a file/mirror",
3172         [LSE_SET_COMP_START] =
3173                 "Must set previous component extent before adding next",
3174         [LSE_NOT_ZERO_LENGTH_EXTENDABLE] =
3175                 "Extendable component must start out zero-length",
3176         [LSE_END_NOT_GREATER] =
3177                 "Component end is before end of previous component",
3178         [LSE_ZERO_LENGTH_NORMAL] =
3179                 "Zero length components must be followed by extension",
3180         [LSE_NOT_ADJACENT_PREV] =
3181                 "Components not adjacent (end != next->start",
3182         [LSE_START_GT_END] =
3183                 "Component start is > end",
3184         [LSE_ALIGN_END] =
3185                 "The component end must be aligned by the stripe size",
3186         [LSE_ALIGN_EXT] =
3187                 "The extension size must be aligned by the stripe size",
3188 };
3189
3190 struct llapi_layout_sanity_args {
3191         bool lsa_incomplete;
3192         bool lsa_flr;
3193         bool lsa_ondisk;
3194         int lsa_rc;
3195 };
3196
3197 /* The component flags can be set by users at creation/modification time. */
3198 #define LCME_USER_COMP_FLAGS    (LCME_FL_PREF_RW | LCME_FL_NOSYNC | \
3199                                  LCME_FL_EXTENSION)
3200
3201 static int llapi_layout_sanity_cb(struct llapi_layout *layout,
3202                                   void *arg)
3203 {
3204         struct llapi_layout_comp *comp, *next, *prev;
3205         struct llapi_layout_sanity_args *args = arg;
3206         bool first_comp = false;
3207
3208         comp = __llapi_layout_cur_comp(layout);
3209         if (comp == NULL) {
3210                 args->lsa_rc = -1;
3211                 goto out_err;
3212         }
3213
3214         if (comp->llc_list.prev != &layout->llot_comp_list)
3215                 prev = list_entry(comp->llc_list.prev, typeof(*prev),
3216                                   llc_list);
3217         else
3218                 prev = NULL;
3219
3220         if (comp->llc_list.next != &layout->llot_comp_list)
3221                 next = list_entry(comp->llc_list.next, typeof(*next),
3222                                   llc_list);
3223         else
3224                 next = NULL;
3225
3226         /* Start of zero implies a new mirror */
3227         if (comp->llc_extent.e_start == 0) {
3228                 first_comp = true;
3229                 /* Most checks apply only within one mirror, this is an
3230                  * exception. */
3231                 if (prev && prev->llc_extent.e_end != LUSTRE_EOF) {
3232                         args->lsa_rc = LSE_INCOMPLETE_MIRROR;
3233                         goto out_err;
3234                 }
3235
3236                 prev = NULL;
3237         }
3238
3239         if (next && next->llc_extent.e_start == 0)
3240                 next = NULL;
3241
3242         /* Flag sanity checks */
3243         /* No adjacent extension components */
3244         if ((comp->llc_flags & LCME_FL_EXTENSION) && next &&
3245             (next->llc_flags & LCME_FL_EXTENSION)) {
3246                 args->lsa_rc = LSE_ADJACENT_EXTENSION;
3247                 goto out_err;
3248         }
3249
3250         /* Extension flag cannot be applied to init components and the first
3251          * component of each mirror is automatically init */
3252         if ((comp->llc_flags & LCME_FL_EXTENSION) &&
3253             (comp->llc_flags & LCME_FL_INIT || first_comp)) {
3254                 args->lsa_rc = LSE_INIT_EXTENSION;
3255                 goto out_err;
3256         }
3257
3258         if (comp->llc_ondisk) {
3259                 if (comp->llc_flags & LCME_FL_NEG)
3260                         args->lsa_rc = LSE_FLAGS;
3261         } else if (!args->lsa_incomplete) {
3262                 if (args->lsa_flr) {
3263                         if (comp->llc_flags & ~LCME_USER_COMP_FLAGS)
3264                                 args->lsa_rc = LSE_FLAGS;
3265                 } else {
3266                         if (comp->llc_flags &
3267                             ~(LCME_FL_EXTENSION | LCME_FL_PREF_RW))
3268                                 args->lsa_rc = LSE_FLAGS;
3269                 }
3270         }
3271         if (args->lsa_rc)
3272                 goto out_err;
3273
3274         /* DoM sanity checks */
3275         if (comp->llc_pattern == LLAPI_LAYOUT_MDT ||
3276             comp->llc_pattern == LOV_PATTERN_MDT) {
3277                 /* DoM components can't be extension components */
3278                 if (comp->llc_flags & LCME_FL_EXTENSION) {
3279                         args->lsa_rc = LSE_DOM_EXTENSION;
3280                         goto out_err;
3281                 }
3282                 /* DoM components cannot be followed by an extension comp */
3283                 if (next && (next->llc_flags & LCME_FL_EXTENSION)) {
3284                         args->lsa_rc = LSE_DOM_EXTENSION_FOLLOWING;
3285                         goto out_err;
3286                 }
3287
3288                 /* DoM should be the first component in a mirror */
3289                 if (!first_comp) {
3290                         args->lsa_rc = LSE_DOM_FIRST;
3291                         errno = EINVAL;
3292                         goto out_err;
3293                 }
3294         }
3295
3296         /* Extent sanity checks */
3297         /* Must set previous component extent before adding another */
3298         if (prev && prev->llc_extent.e_start == 0 &&
3299             prev->llc_extent.e_end == 0) {
3300                 args->lsa_rc = LSE_SET_COMP_START;
3301                 goto out_err;
3302         }
3303
3304         if (!args->lsa_incomplete) {
3305                 /* Components followed by extension space (extendable
3306                  * components) must be zero length before initialization.
3307                  * (Except for first comp, which will be initialized on
3308                  * creation). */
3309                 if (next && (next->llc_flags & LCME_FL_EXTENSION) &&
3310                     !first_comp && !(comp->llc_flags & LCME_FL_INIT) &&
3311                     comp->llc_extent.e_start != comp->llc_extent.e_end) {
3312                         args->lsa_rc = LSE_NOT_ZERO_LENGTH_EXTENDABLE;
3313                         goto out_err;
3314                 }
3315
3316                 /* End must come after end of previous comp */
3317                 if (prev && comp->llc_extent.e_end < prev->llc_extent.e_end) {
3318                         args->lsa_rc = LSE_END_NOT_GREATER;
3319                         goto out_err;
3320                 }
3321
3322                 /* Components not followed by ext space must have length > 0. */
3323                 if (comp->llc_extent.e_start == comp->llc_extent.e_end &&
3324                     (next == NULL || !(next->llc_flags & LCME_FL_EXTENSION))) {
3325                         args->lsa_rc = LSE_ZERO_LENGTH_NORMAL;
3326                         goto out_err;
3327                 }
3328
3329                 /* The component end must be aligned by the stripe size */
3330                 if ((comp->llc_flags & LCME_FL_EXTENSION) &&
3331                     (prev->llc_stripe_size != LLAPI_LAYOUT_DEFAULT)) {
3332                         if (comp->llc_extent.e_end != LUSTRE_EOF &&
3333                             comp->llc_extent.e_end % prev->llc_stripe_size) {
3334                                 args->lsa_rc = LSE_ALIGN_END;
3335                                 goto out_err;
3336                         }
3337                         if ((comp->llc_stripe_size * SEL_UNIT_SIZE) %
3338                             prev->llc_stripe_size) {
3339                                 args->lsa_rc = LSE_ALIGN_EXT;
3340                                 goto out_err;
3341                         }
3342                 } else if (!(comp->llc_flags & LCME_FL_EXTENSION) &&
3343                            (comp->llc_stripe_size != LLAPI_LAYOUT_DEFAULT)) {
3344                         if (comp->llc_extent.e_end != LUSTRE_EOF &&
3345                             comp->llc_extent.e_end % comp->llc_stripe_size) {
3346                                 args->lsa_rc = LSE_ALIGN_END;
3347                                 goto out_err;
3348                         }
3349                 }
3350         }
3351
3352         /* Components must have start == prev->end */
3353         if (prev && comp->llc_extent.e_start != 0 &&
3354             comp->llc_extent.e_start != prev->llc_extent.e_end) {
3355                 args->lsa_rc = LSE_NOT_ADJACENT_PREV;
3356                 goto out_err;
3357         }
3358
3359         /* Components must have start <= end */
3360         if (comp->llc_extent.e_start > comp->llc_extent.e_end) {
3361                 args->lsa_rc = LSE_START_GT_END;
3362                 goto out_err;
3363         }
3364
3365         return LLAPI_LAYOUT_ITER_CONT;
3366
3367 out_err:
3368         errno = errno ? errno : EINVAL;
3369         return LLAPI_LAYOUT_ITER_STOP;
3370 }
3371
3372 /* Print explanation of layout error */
3373 void llapi_layout_sanity_perror(int error)
3374 {
3375         if (error >= LSE_LAST || error < 0) {
3376                 fprintf(stdout, "Invalid layout, unrecognized error: %d\n",
3377                         error);
3378         } else {
3379                 fprintf(stdout, "Invalid layout: %s\n",
3380                         llapi_layout_strerror[error]);
3381         }
3382 }
3383
3384 /* Walk a layout and enforce sanity checks that apply to > 1 component
3385  *
3386  * The core idea here is that of sanity checking individual tokens vs semantic
3387  * checking.
3388  * We cannot check everything at the individual component level ('token'),
3389  * instead we must check whether or not the full layout has a valid meaning.
3390  *
3391  * An example of a component level check is "is stripe size valid?".  That is
3392  * handled when setting stripe size.
3393  *
3394  * An example of a layout level check is "are the extents of these components
3395  * valid when adjacent to one another", or "can we set these flags on adjacent
3396  * components"?
3397  *
3398  * \param[in] layout            component layout list.
3399  * \param[in] incomplete        if layout is complete or not - some checks can
3400  *                              only be done on complete layouts.
3401  * \param[in] flr               set when this is called from FLR mirror create
3402  *
3403  * \retval                      0, success, positive: various errors, see
3404  *                              llapi_layout_sanity_perror, -1, failure
3405  */
3406 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr)
3407 {
3408         struct llapi_layout_sanity_args args;
3409         struct llapi_layout_comp *curr;
3410         int rc = 0;
3411
3412         if (!layout)
3413                 return 0;
3414
3415         curr = layout->llot_cur_comp;
3416         if (!curr)
3417                 return 0;
3418
3419         /* Set up args */
3420         args.lsa_rc = 0;
3421         args.lsa_flr = flr;
3422         args.lsa_incomplete = incomplete;
3423
3424         /* When we modify an existing layout, this tells us if it's FLR */
3425         if (mirror_id_of(curr->llc_id) > 0)
3426                 args.lsa_flr = true;
3427
3428         errno = 0;
3429         rc = llapi_layout_comp_iterate(layout,
3430                                        llapi_layout_sanity_cb,
3431                                        &args);
3432         if (errno == ENOENT)
3433                 errno = 0;
3434
3435         if (rc != LLAPI_LAYOUT_ITER_CONT)
3436                 rc = args.lsa_rc;
3437
3438         layout->llot_cur_comp = curr;
3439
3440         return rc;
3441 }
3442
3443 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size)
3444 {
3445         uint64_t pattern, start;
3446         int rc;
3447
3448         if (!layout || !llapi_layout_is_composite(layout)) {
3449                 *size = 0;
3450                 return 0;
3451         }
3452
3453         rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_FIRST);
3454         if (rc)
3455                 return -errno;
3456
3457         rc = llapi_layout_pattern_get(layout, &pattern);
3458         if (rc)
3459                 return -errno;
3460
3461         if (pattern != LOV_PATTERN_MDT && pattern != LLAPI_LAYOUT_MDT) {
3462                 *size = 0;
3463                 return 0;
3464         }
3465
3466         rc = llapi_layout_comp_extent_get(layout, &start, size);
3467         if (rc)
3468                 return -errno;
3469         if (start)
3470                 return -ERANGE;
3471         return 0;
3472 }
3473
3474 int lov_comp_md_size(struct lov_comp_md_v1 *lcm)
3475 {
3476         if (lcm->lcm_magic == LOV_MAGIC_V1 || lcm->lcm_magic == LOV_MAGIC_V3) {
3477                 struct lov_user_md *lum = (void *)lcm;
3478
3479                 return lov_user_md_size(lum->lmm_stripe_count, lum->lmm_magic);
3480         }
3481
3482         if (lcm->lcm_magic == LOV_MAGIC_FOREIGN) {
3483                 struct lov_foreign_md *lfm = (void *)lcm;
3484
3485                 return lfm->lfm_length;
3486         }
3487
3488         if (lcm->lcm_magic != LOV_MAGIC_COMP_V1)
3489                 return -EOPNOTSUPP;
3490
3491         return lcm->lcm_size;
3492 }
3493
3494 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
3495                           lstatx_t *statx, struct lov_user_md *lum,
3496                           size_t lumsize)
3497 {
3498         struct lov_user_mds_data *lmd;
3499         char buf[65536 + offsetof(typeof(*lmd), lmd_lmm)];
3500         int parent_fd = -1;
3501         int rc;
3502
3503         if (lum && lumsize < sizeof(*lum))
3504                 return -EINVAL;
3505
3506         /* If a file name is provided, it is relative to the parent directory */
3507         if (fname) {
3508                 parent_fd = dir_fd;
3509                 dir_fd = -1;
3510         }
3511
3512         lmd = (struct lov_user_mds_data *)buf;
3513         rc = get_lmd_info_fd(fname, parent_fd, dir_fd, buf, sizeof(buf),
3514                              GET_LMD_INFO);
3515         if (rc)
3516                 return rc;
3517
3518         if (valid)
3519                 *valid = lmd->lmd_flags;
3520
3521         if (statx)
3522                 memcpy(statx, &lmd->lmd_stx, sizeof(*statx));
3523
3524         if (lum) {
3525                 if (lmd->lmd_lmmsize > lumsize)
3526                         return -EOVERFLOW;
3527                 memcpy(lum, &lmd->lmd_lmm, lmd->lmd_lmmsize);
3528         }
3529
3530         return 0;
3531 }
3532
3533 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
3534                          struct lov_user_md *lum, size_t lumsize)
3535 {
3536         return llapi_get_lum_file_fd(dir_fd, NULL, valid, statx, lum, lumsize);
3537 }
3538
3539 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
3540                        struct lov_user_md *lum, size_t lumsize)
3541 {
3542         char parent[PATH_MAX];
3543         const char *fname;
3544         char *tmp;
3545         int offset;
3546         int dir_fd;
3547         int rc;
3548
3549         tmp = strrchr(path, '/');
3550         if (!tmp) {
3551                 strncpy(parent, ".", sizeof(parent) - 1);
3552                 offset = -1;
3553         } else {
3554                 strncpy(parent, path, tmp - path);
3555                 offset = tmp - path - 1;
3556                 parent[tmp - path] = 0;
3557         }
3558
3559         fname = path;
3560         if (offset >= 0)
3561                 fname += offset + 2;
3562
3563         dir_fd = open(parent, O_RDONLY);
3564         if (dir_fd < 0) {
3565                 rc = -errno;
3566                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot open '%s'", path);
3567                 return rc;
3568         }
3569
3570         rc = llapi_get_lum_file_fd(dir_fd, fname, valid, statx, lum, lumsize);
3571         close(dir_fd);
3572         return rc;
3573 }
3574
3575 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
3576                       struct lov_user_md *lum, size_t lumsize)
3577 {
3578         int dir_fd;
3579         int rc;
3580
3581         dir_fd = open(path, O_RDONLY);
3582         if (dir_fd < 0) {
3583                 rc = -errno;
3584                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot open '%s'", path);
3585                 return rc;
3586         }
3587
3588         rc = llapi_get_lum_dir_fd(dir_fd, valid, statx, lum, lumsize);
3589         close(dir_fd);
3590         return rc;
3591 }