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 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                                char *pool_name)
1530 {
1531         struct llapi_layout_comp *comp;
1532
1533         comp = __llapi_layout_cur_comp(layout);
1534         if (comp == NULL)
1535                 return -1;
1536
1537         if (!llapi_pool_name_is_valid(&pool_name, NULL)) {
1538                 errno = EINVAL;
1539                 return -1;
1540         }
1541
1542         strncpy(comp->llc_pool_name, pool_name, sizeof(comp->llc_pool_name));
1543         return 0;
1544 }
1545
1546 /**
1547  * Open and possibly create a file with a given \a layout.
1548  *
1549  * If \a layout is NULL this function acts as a simple wrapper for
1550  * open().  By convention, ENOTTY is returned in errno if \a path
1551  * refers to a non-Lustre file.
1552  *
1553  * \param[in] path              name of the file to open
1554  * \param[in] open_flags        open() flags
1555  * \param[in] mode              permissions to create file, filtered by umask
1556  * \param[in] layout            layout to create new file with
1557  *
1558  * \retval              non-negative file descriptor on successful open
1559  * \retval              -1 if an error occurred
1560  */
1561 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
1562                            const struct llapi_layout *layout)
1563 {
1564         int fd;
1565         int rc;
1566         int tmp;
1567         struct lov_user_md *lum;
1568         size_t lum_size;
1569
1570         if (path == NULL ||
1571             (layout != NULL && layout->llot_magic != LLAPI_LAYOUT_MAGIC)) {
1572                 errno = EINVAL;
1573                 return -1;
1574         }
1575
1576         if (layout) {
1577                 rc = llapi_layout_sanity((struct llapi_layout *)layout,
1578                                          path, false,
1579                                          !!(layout->llot_mirror_count > 1));
1580                 if (rc) {
1581                         llapi_layout_sanity_perror(rc);
1582                         return -1;
1583                 }
1584         }
1585
1586         /* Object creation must be postponed until after layout attributes
1587          * have been applied. */
1588         if (layout != NULL && (open_flags & O_CREAT))
1589                 open_flags |= O_LOV_DELAY_CREATE;
1590
1591         fd = open(path, open_flags, mode);
1592
1593         if (layout == NULL || fd < 0)
1594                 return fd;
1595
1596         lum = llapi_layout_to_lum(layout);
1597
1598         if (lum == NULL) {
1599                 tmp = errno;
1600                 close(fd);
1601                 errno = tmp;
1602                 return -1;
1603         }
1604
1605         if (lum->lmm_magic == LOV_USER_MAGIC_COMP_V1)
1606                 lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
1607         else if (lum->lmm_magic == LOV_USER_MAGIC_SPECIFIC)
1608                 lum_size = lov_user_md_size(lum->lmm_stripe_count,
1609                                             lum->lmm_magic);
1610         else
1611                 lum_size = lov_user_md_size(0, lum->lmm_magic);
1612
1613         rc = fsetxattr(fd, XATTR_LUSTRE_LOV, lum, lum_size, 0);
1614         if (rc < 0) {
1615                 tmp = errno;
1616                 close(fd);
1617                 errno = tmp;
1618                 fd = -1;
1619         }
1620
1621         free(lum);
1622         errno = errno == EOPNOTSUPP ? ENOTTY : errno;
1623
1624         return fd;
1625 }
1626
1627 /**
1628  * Create a file with a given \a layout.
1629  *
1630  * Force O_CREAT and O_EXCL flags on so caller is assured that file was
1631  * created with the given \a layout on successful function return.
1632  *
1633  * \param[in] path              name of the file to open
1634  * \param[in] open_flags        open() flags
1635  * \param[in] mode              permissions to create new file with
1636  * \param[in] layout            layout to create new file with
1637  *
1638  * \retval              non-negative file descriptor on successful open
1639  * \retval              -1 if an error occurred
1640  */
1641 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1642                              const struct llapi_layout *layout)
1643 {
1644         return llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode,
1645                                       layout);
1646 }
1647
1648 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags)
1649 {
1650         if (layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1651                 errno = EINVAL;
1652                 return -1;
1653         }
1654
1655         *flags = layout->llot_flags;
1656         return 0;
1657 }
1658
1659 /**
1660  * Set flags to the header of a component layout.
1661  */
1662 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags)
1663 {
1664         if (layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1665                 errno = EINVAL;
1666                 return -1;
1667         }
1668
1669         layout->llot_flags = flags;
1670         return 0;
1671 }
1672
1673 const char *llapi_layout_flags_string(uint32_t flags)
1674 {
1675         switch (flags & LCM_FL_FLR_MASK) {
1676         case LCM_FL_RDONLY:
1677                 return "ro";
1678         case LCM_FL_WRITE_PENDING:
1679                 return "wp";
1680         case LCM_FL_SYNC_PENDING:
1681                 return "sp";
1682         }
1683
1684         return "0";
1685 }
1686
1687 __u16 llapi_layout_string_flags(char *string)
1688 {
1689         if (strncmp(string, "ro", strlen(string)) == 0)
1690                 return LCM_FL_RDONLY;
1691         if (strncmp(string, "wp", strlen(string)) == 0)
1692                 return LCM_FL_WRITE_PENDING;
1693         if (strncmp(string, "sp", strlen(string)) == 0)
1694                 return LCM_FL_SYNC_PENDING;
1695
1696         return 0;
1697 }
1698
1699 /**
1700  * llapi_layout_mirror_count_is_valid() - Check the validity of mirror count.
1701  * @count: Mirror count value to be checked.
1702  *
1703  * This function checks the validity of mirror count.
1704  *
1705  * Return: true on success or false on failure.
1706  */
1707 static bool llapi_layout_mirror_count_is_valid(uint16_t count)
1708 {
1709         return count >= 0 && count <= LUSTRE_MIRROR_COUNT_MAX;
1710 }
1711
1712 /**
1713  * llapi_layout_mirror_count_get() - Get mirror count from the header of
1714  *                                   a layout.
1715  * @layout: Layout to get mirror count from.
1716  * @count:  Returned mirror count value.
1717  *
1718  * This function gets mirror count from the header of a layout.
1719  *
1720  * Return: 0 on success or -1 on failure.
1721  */
1722 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1723                                   uint16_t *count)
1724 {
1725         if (layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1726                 errno = EINVAL;
1727                 return -1;
1728         }
1729
1730         *count = layout->llot_mirror_count;
1731         return 0;
1732 }
1733
1734 /**
1735  * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1736  * @layout: Layout to set mirror count in.
1737  * @count:  Mirror count value to be set.
1738  *
1739  * This function sets mirror count to the header of a layout.
1740  *
1741  * Return: 0 on success or -1 on failure.
1742  */
1743 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1744                                   uint16_t count)
1745 {
1746         if (layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1747                 errno = EINVAL;
1748                 return -1;
1749         }
1750
1751         if (!llapi_layout_mirror_count_is_valid(count)) {
1752                 errno = EINVAL;
1753                 return -1;
1754         }
1755
1756         layout->llot_mirror_count = count;
1757         return 0;
1758 }
1759
1760 /**
1761  * Fetch the start and end offset of the current layout component.
1762  *
1763  * \param[in] layout    the layout component
1764  * \param[out] start    extent start, inclusive
1765  * \param[out] end      extent end, exclusive
1766  *
1767  * \retval      0 on success
1768  * \retval      <0 if error occurs
1769  */
1770 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1771                                  uint64_t *start, uint64_t *end)
1772 {
1773         struct llapi_layout_comp *comp;
1774
1775         comp = __llapi_layout_cur_comp(layout);
1776         if (comp == NULL)
1777                 return -1;
1778
1779         if (start == NULL || end == NULL) {
1780                 errno = EINVAL;
1781                 return -1;
1782         }
1783
1784         *start = comp->llc_extent.e_start;
1785         *end = comp->llc_extent.e_end;
1786
1787         return 0;
1788 }
1789
1790 /**
1791  * Set the layout extent of a layout.
1792  *
1793  * \param[in] layout    the layout to be set
1794  * \param[in] start     extent start, inclusive
1795  * \param[in] end       extent end, exclusive
1796  *
1797  * \retval      0 on success
1798  * \retval      <0 if error occurs
1799  */
1800 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1801                                  uint64_t start, uint64_t end)
1802 {
1803         struct llapi_layout_comp *comp;
1804
1805         comp = __llapi_layout_cur_comp(layout);
1806         if (comp == NULL)
1807                 return -1;
1808
1809         if (start > end) {
1810                 errno = EINVAL;
1811                 return -1;
1812         }
1813
1814         comp->llc_extent.e_start = start;
1815         comp->llc_extent.e_end = end;
1816         layout->llot_is_composite = true;
1817
1818         return 0;
1819 }
1820
1821 /**
1822  * Gets the attribute flags of the current component.
1823  *
1824  * \param[in] layout    the layout component
1825  * \param[out] flags    stored the returned component flags
1826  *
1827  * \retval      0 on success
1828  * \retval      <0 if error occurs
1829  */
1830 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1831                                 uint32_t *flags)
1832 {
1833         struct llapi_layout_comp *comp;
1834
1835         comp = __llapi_layout_cur_comp(layout);
1836         if (comp == NULL)
1837                 return -1;
1838
1839         if (flags == NULL) {
1840                 errno = EINVAL;
1841                 return -1;
1842         }
1843
1844         *flags = comp->llc_flags;
1845
1846         return 0;
1847 }
1848
1849 /**
1850  * Sets the specified flags of the current component leaving other flags as-is.
1851  *
1852  * \param[in] layout    the layout component
1853  * \param[in] flags     component flags to be set
1854  *
1855  * \retval      0 on success
1856  * \retval      <0 if error occurs
1857  */
1858 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags)
1859 {
1860         struct llapi_layout_comp *comp;
1861
1862         comp = __llapi_layout_cur_comp(layout);
1863         if (comp == NULL)
1864                 return -1;
1865
1866         comp->llc_flags |= flags;
1867
1868         return 0;
1869 }
1870
1871 /**
1872  * Clears the flags specified in the flags leaving other flags as-is.
1873  *
1874  * \param[in] layout    the layout component
1875  * \param[in] flags     component flags to be cleared
1876  *
1877  * \retval      0 on success
1878  * \retval      <0 if error occurs
1879  */
1880 int llapi_layout_comp_flags_clear(struct llapi_layout *layout,
1881                                   uint32_t flags)
1882 {
1883         struct llapi_layout_comp *comp;
1884
1885         comp = __llapi_layout_cur_comp(layout);
1886         if (comp == NULL)
1887                 return -1;
1888
1889         comp->llc_flags &= ~flags;
1890
1891         return 0;
1892 }
1893
1894 /**
1895  * Fetches the file-unique component ID of the current layout component.
1896  *
1897  * \param[in] layout    the layout component
1898  * \param[out] id       stored the returned component ID
1899  *
1900  * \retval      0 on success
1901  * \retval      <0 if error occurs
1902  */
1903 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id)
1904 {
1905         struct llapi_layout_comp *comp;
1906
1907         comp = __llapi_layout_cur_comp(layout);
1908         if (comp == NULL)
1909                 return -1;
1910
1911         if (id == NULL) {
1912                 errno = EINVAL;
1913                 return -1;
1914         }
1915         *id = comp->llc_id;
1916
1917         return 0;
1918 }
1919
1920 /**
1921  * Return the mirror id of the current layout component.
1922  *
1923  * \param[in] layout    the layout component
1924  * \param[out] id       stored the returned mirror ID
1925  *
1926  * \retval      0 on success
1927  * \retval      <0 if error occurs
1928  */
1929 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id)
1930 {
1931         struct llapi_layout_comp *comp;
1932
1933         comp = __llapi_layout_cur_comp(layout);
1934         if (comp == NULL)
1935                 return -1;
1936
1937         if (id == NULL) {
1938                 errno = EINVAL;
1939                 return -1;
1940         }
1941
1942         *id = mirror_id_of(comp->llc_id);
1943
1944         return 0;
1945 }
1946
1947 /**
1948  * Adds a component to \a layout, the new component will be added to
1949  * the tail of components list and it'll inherit attributes of existing
1950  * ones. The \a layout will change it's current component pointer to
1951  * the newly added component, and it'll be turned into a composite
1952  * layout if it was not before the adding.
1953  *
1954  * \param[in] layout    existing composite or plain layout
1955  *
1956  * \retval      0 on success
1957  * \retval      <0 if error occurs
1958  */
1959 int llapi_layout_comp_add(struct llapi_layout *layout)
1960 {
1961         struct llapi_layout_comp *last, *comp, *new;
1962         bool composite = layout->llot_is_composite;
1963
1964         comp = __llapi_layout_cur_comp(layout);
1965         if (comp == NULL)
1966                 return -1;
1967
1968         new = __llapi_comp_alloc(0);
1969         if (new == NULL)
1970                 return -1;
1971
1972         last = list_entry(layout->llot_comp_list.prev, typeof(*last),
1973                           llc_list);
1974
1975         list_add_tail(&new->llc_list, &layout->llot_comp_list);
1976
1977         /* We must mark the layout composite for the sanity check, but it may
1978          * not stay that way if the check fails */
1979         layout->llot_is_composite = true;
1980         layout->llot_cur_comp = new;
1981
1982         /* We need to set a temporary non-zero value for "end" when we call
1983          * comp_extent_set, so we use LUSTRE_EOF-1, which is > all allowed
1984          * for the end of the previous component.  (If we're adding this
1985          * component, the end of the previous component cannot be EOF.) */
1986         if (llapi_layout_comp_extent_set(layout, last->llc_extent.e_end,
1987                                         LUSTRE_EOF - 1)) {
1988                 llapi_layout_comp_del(layout);
1989                 layout->llot_is_composite = composite;
1990                 return -1;
1991         }
1992
1993         return 0;
1994 }
1995 /**
1996  * Adds a first component of a mirror to \a layout.
1997  * The \a layout will change it's current component pointer to
1998  * the newly added component, and it'll be turned into a composite
1999  * layout if it was not before the adding.
2000  *
2001  * \param[in] layout            existing composite or plain layout
2002  *
2003  * \retval      0 on success
2004  * \retval      <0 if error occurs
2005  */
2006 int llapi_layout_add_first_comp(struct llapi_layout *layout)
2007 {
2008         struct llapi_layout_comp *comp, *new;
2009
2010         comp = __llapi_layout_cur_comp(layout);
2011         if (comp == NULL)
2012                 return -1;
2013
2014         new = __llapi_comp_alloc(0);
2015         if (new == NULL)
2016                 return -1;
2017
2018         new->llc_extent.e_start = 0;
2019
2020         list_add_tail(&new->llc_list, &layout->llot_comp_list);
2021         layout->llot_cur_comp = new;
2022         layout->llot_is_composite = true;
2023
2024         return 0;
2025 }
2026
2027 /**
2028  * Deletes current component from the composite layout. The component
2029  * to be deleted must be the tail of components list, and it can't be
2030  * the only component in the layout.
2031  *
2032  * \param[in] layout    composite layout
2033  *
2034  * \retval      0 on success
2035  * \retval      <0 if error occurs
2036  */
2037 int llapi_layout_comp_del(struct llapi_layout *layout)
2038 {
2039         struct llapi_layout_comp *comp;
2040
2041         comp = __llapi_layout_cur_comp(layout);
2042         if (comp == NULL)
2043                 return -1;
2044
2045         if (!layout->llot_is_composite) {
2046                 errno = EINVAL;
2047                 return -1;
2048         }
2049
2050         /* It must be the tail of the list (for PFL, can be relaxed
2051          * once we get mirrored components) */
2052         if (comp->llc_list.next != &layout->llot_comp_list) {
2053                 errno = EINVAL;
2054                 return -1;
2055         }
2056         layout->llot_cur_comp =
2057                 list_entry(comp->llc_list.prev, typeof(*comp), llc_list);
2058         if (comp->llc_list.prev == &layout->llot_comp_list)
2059                 layout->llot_cur_comp = NULL;
2060
2061         list_del_init(&comp->llc_list);
2062         __llapi_comp_free(comp);
2063
2064         return 0;
2065 }
2066
2067 /**
2068  * Move the current component pointer to the component with
2069  * specified component ID.
2070  *
2071  * \param[in] layout    composite layout
2072  * \param[in] id        component ID
2073  *
2074  * \retval      =0 : moved successfully
2075  * \retval      <0 if error occurs
2076  */
2077 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t comp_id)
2078 {
2079         struct llapi_layout_comp *comp;
2080
2081         comp = __llapi_layout_cur_comp(layout);
2082         if (comp == NULL)
2083                 return -1; /* use previously set errno */
2084
2085         if (!layout->llot_is_composite) {
2086                 errno = EINVAL;
2087                 return -1;
2088         }
2089
2090         if (comp_id == LCME_ID_INVAL) {
2091                 errno = EINVAL;
2092                 return -1;
2093         }
2094
2095         list_for_each_entry(comp, &layout->llot_comp_list, llc_list) {
2096                 if (comp->llc_id == comp_id) {
2097                         layout->llot_cur_comp = comp;
2098                         return 0;
2099                 }
2100         }
2101         errno = ENOENT;
2102         return -1;
2103 }
2104
2105 /**
2106  * Move the current component pointer to a specified position.
2107  *
2108  * \param[in] layout    composite layout
2109  * \param[in] pos       the position to be moved, it can be:
2110  *                      LLAPI_LAYOUT_COMP_USE_FIRST: use first component
2111  *                      LLAPI_LAYOUT_COMP_USE_LAST: use last component
2112  *                      LLAPI_LAYOUT_COMP_USE_NEXT: use component after current
2113  *                      LLAPI_LAYOUT_COMP_USE_PREV: use component before current
2114  *
2115  * \retval      =0 : moved successfully
2116  * \retval      =1 : at last component with NEXT, at first component with PREV
2117  * \retval      <0 if error occurs
2118  */
2119 int llapi_layout_comp_use(struct llapi_layout *layout,
2120                           enum llapi_layout_comp_use pos)
2121 {
2122         struct llapi_layout_comp *comp, *head, *tail;
2123
2124         comp = __llapi_layout_cur_comp(layout);
2125         if (comp == NULL)
2126                 return -1;
2127
2128         if (!layout->llot_is_composite) {
2129                 if (pos == LLAPI_LAYOUT_COMP_USE_FIRST ||
2130                     pos == LLAPI_LAYOUT_COMP_USE_LAST)
2131                         return 0;
2132                 errno = ENOENT;
2133                 return 1;
2134         }
2135
2136         head = list_entry(layout->llot_comp_list.next, typeof(*head), llc_list);
2137         tail = list_entry(layout->llot_comp_list.prev, typeof(*tail), llc_list);
2138         switch (pos) {
2139         case LLAPI_LAYOUT_COMP_USE_FIRST:
2140                 layout->llot_cur_comp = head;
2141                 break;
2142         case LLAPI_LAYOUT_COMP_USE_NEXT:
2143                 if (comp == tail) {
2144                         errno = ENOENT;
2145                         return 1;
2146                 }
2147                 layout->llot_cur_comp = list_entry(comp->llc_list.next,
2148                                                    typeof(*comp), llc_list);
2149                 break;
2150         case LLAPI_LAYOUT_COMP_USE_LAST:
2151                 layout->llot_cur_comp = tail;
2152                 break;
2153         case LLAPI_LAYOUT_COMP_USE_PREV:
2154                 if (comp == head) {
2155                         errno = ENOENT;
2156                         return 1;
2157                 }
2158                 layout->llot_cur_comp = list_entry(comp->llc_list.prev,
2159                                                    typeof(*comp), llc_list);
2160                 break;
2161         default:
2162                 errno = EINVAL;
2163                 return -1;
2164         }
2165
2166         return 0;
2167 }
2168
2169 /**
2170  * Add layout component(s) to an existing file.
2171  *
2172  * \param[in] path      The path name of the file
2173  * \param[in] layout    The layout component(s) to be added
2174  */
2175 int llapi_layout_file_comp_add(const char *path,
2176                                const struct llapi_layout *layout)
2177 {
2178         int rc, fd = -1, lum_size, tmp_errno = 0;
2179         struct llapi_layout *existing_layout = NULL;
2180         struct lov_user_md *lum = NULL;
2181
2182         if (path == NULL || layout == NULL ||
2183             layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
2184                 errno = EINVAL;
2185                 return -1;
2186         }
2187
2188         fd = open(path, O_RDWR);
2189         if (fd < 0) {
2190                 tmp_errno = errno;
2191                 rc = -1;
2192                 goto out;
2193         }
2194
2195         existing_layout = llapi_layout_get_by_fd(fd, 0);
2196         if (existing_layout == NULL) {
2197                 tmp_errno = errno;
2198                 rc = -1;
2199                 goto out;
2200         }
2201
2202         rc = llapi_layout_merge(&existing_layout, layout);
2203         if (rc) {
2204                 tmp_errno = errno;
2205                 rc = -1;
2206                 goto out;
2207         }
2208
2209         rc = llapi_layout_sanity(existing_layout, path, false, false);
2210         if (rc) {
2211                 tmp_errno = errno;
2212                 llapi_layout_sanity_perror(rc);
2213                 rc = -1;
2214                 goto out;
2215         }
2216
2217         lum = llapi_layout_to_lum(layout);
2218         if (lum == NULL) {
2219                 tmp_errno = errno;
2220                 rc = -1;
2221                 goto out;
2222         }
2223
2224         if (lum->lmm_magic != LOV_USER_MAGIC_COMP_V1) {
2225                 tmp_errno = EINVAL;
2226                 rc = -1;
2227                 goto out;
2228         }
2229         lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
2230
2231         rc = fsetxattr(fd, XATTR_LUSTRE_LOV".add", lum, lum_size, 0);
2232         if (rc < 0) {
2233                 tmp_errno = errno;
2234                 rc = -1;
2235                 goto out;
2236         }
2237 out:
2238         if (fd >= 0)
2239                 close(fd);
2240         free(lum);
2241         llapi_layout_free(existing_layout);
2242         errno = tmp_errno;
2243         return rc;
2244 }
2245
2246 /**
2247  * Delete component(s) by the specified component id or component flags
2248  * from an existing file.
2249  *
2250  * \param[in] path      path name of the file
2251  * \param[in] id        unique component ID
2252  * \param[in] flags     flags: LCME_FL_* or;
2253  *                      negative flags: (LCME_FL_NEG|LCME_FL_*)
2254  */
2255 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags)
2256 {
2257         int rc = 0, fd = -1, lum_size, tmp_errno = 0;
2258         struct llapi_layout *layout;
2259         struct llapi_layout_comp *comp, *next;
2260         struct llapi_layout *existing_layout = NULL;
2261         struct lov_user_md *lum = NULL;
2262
2263         if (path == NULL || id > LCME_ID_MAX || (flags & ~LCME_KNOWN_FLAGS)) {
2264                 errno = EINVAL;
2265                 return -1;
2266         }
2267
2268         /* Can only specify ID or flags, not both, not none. */
2269         if ((id != LCME_ID_INVAL && flags != 0) ||
2270             (id == LCME_ID_INVAL && flags == 0)) {
2271                 errno = EINVAL;
2272                 return -1;
2273         }
2274
2275         layout = llapi_layout_alloc();
2276         if (layout == NULL)
2277                 return -1;
2278
2279         llapi_layout_comp_extent_set(layout, 0, LUSTRE_EOF);
2280         comp = __llapi_layout_cur_comp(layout);
2281         if (comp == NULL) {
2282                 tmp_errno = errno;
2283                 rc = -1;
2284                 goto out;
2285         }
2286
2287         comp->llc_id = id;
2288         comp->llc_flags = flags;
2289
2290         lum = llapi_layout_to_lum(layout);
2291         if (lum == NULL) {
2292                 tmp_errno = errno;
2293                 rc = -1;
2294                 goto out;
2295         }
2296         lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
2297
2298         fd = open(path, O_RDWR);
2299         if (fd < 0) {
2300                 tmp_errno = errno;
2301                 rc = -1;
2302                 goto out;
2303         }
2304
2305         existing_layout = llapi_layout_get_by_fd(fd, 0);
2306         if (existing_layout == NULL) {
2307                 tmp_errno = errno;
2308                 rc = -1;
2309                 goto out;
2310         }
2311
2312         comp = NULL;
2313         next = NULL;
2314         while (rc == 0 && existing_layout->llot_cur_comp != NULL) {
2315                 rc = llapi_layout_comp_use(existing_layout, comp ?
2316                                            LLAPI_LAYOUT_COMP_USE_PREV :
2317                                            LLAPI_LAYOUT_COMP_USE_LAST);
2318                 if (rc != 0)
2319                         break;
2320
2321                 next = comp;
2322                 comp = __llapi_layout_cur_comp(existing_layout);
2323                 if (comp == NULL) {
2324                         rc = -1;
2325                         break;
2326                 }
2327
2328                 if (id != LCME_ID_INVAL && id != comp->llc_id)
2329                         continue;
2330                 else if ((flags & LCME_FL_NEG) && (flags & comp->llc_flags))
2331                         continue;
2332                 else if (flags && !(flags & comp->llc_flags))
2333                         continue;
2334
2335                 rc = llapi_layout_comp_del(existing_layout);
2336                 /* the layout position is moved to previous one, adjust */
2337                 comp = next;
2338         }
2339         if (rc < 0) {
2340                 tmp_errno = errno;
2341                 goto out;
2342         }
2343
2344         rc = llapi_layout_sanity(existing_layout, path, false, false);
2345         if (rc) {
2346                 tmp_errno = errno;
2347                 llapi_layout_sanity_perror(rc);
2348                 rc = -1;
2349                 goto out;
2350         }
2351
2352         rc = fsetxattr(fd, XATTR_LUSTRE_LOV".del", lum, lum_size, 0);
2353         if (rc < 0) {
2354                 tmp_errno = errno;
2355                 rc = -1;
2356                 goto out;
2357         }
2358
2359 out:
2360         if (fd >= 0)
2361                 close(fd);
2362         free(lum);
2363         llapi_layout_free(layout);
2364         llapi_layout_free(existing_layout);
2365         errno = tmp_errno;
2366
2367         return rc;
2368 }
2369
2370 /* Internal utility function to apply flags for sanity checking */
2371 static void llapi_layout_comp_apply_flags(struct llapi_layout_comp *comp,
2372                                           uint32_t flags)
2373 {
2374         if (flags & LCME_FL_NEG)
2375                 comp->llc_flags &= ~flags;
2376         else
2377                 comp->llc_flags |= flags;
2378 }
2379
2380 struct llapi_layout_apply_flags_args {
2381         uint32_t *lfa_ids;
2382         uint32_t *lfa_flags;
2383         int lfa_count;
2384         int lfa_rc;
2385 };
2386
2387
2388 static int llapi_layout_apply_flags_cb(struct llapi_layout *layout,
2389                                        void *arg)
2390 {
2391         struct llapi_layout_apply_flags_args *args = arg;
2392         struct llapi_layout_comp *comp;
2393         int i = 0;
2394
2395         comp = __llapi_layout_cur_comp(layout);
2396         if (comp == NULL) {
2397                 args->lfa_rc = -1;
2398                 return LLAPI_LAYOUT_ITER_STOP;
2399         }
2400
2401         for (i = 0; i < args->lfa_count; i++) {
2402                 if (comp->llc_id == args->lfa_ids[i])
2403                         llapi_layout_comp_apply_flags(comp, args->lfa_flags[i]);
2404         }
2405
2406         return LLAPI_LAYOUT_ITER_CONT;
2407 }
2408
2409 /* Apply flags to the layout for sanity checking */
2410 static int llapi_layout_apply_flags(struct llapi_layout *layout, uint32_t *ids,
2411                                     uint32_t *flags, int count)
2412 {
2413         struct llapi_layout_apply_flags_args args;
2414         int rc = 0;
2415
2416         if (!ids || !flags || count == 0) {
2417                 errno = EINVAL;
2418                 return -1;
2419         }
2420
2421         args.lfa_ids = ids;
2422         args.lfa_flags = flags;
2423         args.lfa_count = count;
2424         args.lfa_rc = 0;
2425
2426         rc = llapi_layout_comp_iterate(layout,
2427                                        llapi_layout_apply_flags_cb,
2428                                        &args);
2429         if (errno == ENOENT)
2430                 errno = 0;
2431
2432         if (rc != LLAPI_LAYOUT_ITER_CONT)
2433                 rc = args.lfa_rc;
2434
2435         return rc;
2436 }
2437 /**
2438  * Change flags by component ID of components of an existing file.
2439  * The component to be modified is specified by the comp->lcme_id value,
2440  * which must be a unique component ID.
2441  *
2442  * \param[in] path      path name of the file
2443  * \param[in] ids       An array of component IDs
2444  * \param[in] flags     flags: LCME_FL_* or;
2445  *                      negative flags: (LCME_FL_NEG|LCME_FL_*)
2446  * \param[in] count     Number of elements in ids and flags array
2447  */
2448 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
2449                                size_t count)
2450 {
2451         int rc = -1, fd = -1, i, tmp_errno = 0;
2452         size_t lum_size;
2453         struct llapi_layout *existing_layout = NULL;
2454         struct llapi_layout *layout = NULL;
2455         struct llapi_layout_comp *comp;
2456         struct lov_user_md *lum = NULL;
2457
2458         if (path == NULL) {
2459                 errno = EINVAL;
2460                 return -1;
2461         }
2462
2463         if (!count)
2464                 return 0;
2465
2466         for (i = 0; i < count; i++) {
2467                 if (!ids[i] || !flags[i]) {
2468                         errno = EINVAL;
2469                         return -1;
2470                 }
2471
2472                 if (ids[i] > LCME_ID_MAX || (flags[i] & ~LCME_KNOWN_FLAGS)) {
2473                         errno = EINVAL;
2474                         return -1;
2475                 }
2476
2477                 /* do not allow to set or clear INIT flag */
2478                 if (flags[i] & LCME_FL_INIT) {
2479                         errno = EINVAL;
2480                         return -1;
2481                 }
2482         }
2483
2484         fd = open(path, O_RDWR);
2485         if (fd < 0) {
2486                 tmp_errno = errno;
2487                 rc = -1;
2488                 goto out;
2489         }
2490
2491         existing_layout = llapi_layout_get_by_fd(fd, 0);
2492         if (existing_layout == NULL) {
2493                 tmp_errno = errno;
2494                 rc = -1;
2495                 goto out;
2496         }
2497
2498         if (llapi_layout_apply_flags(existing_layout, ids, flags, count)) {
2499                 tmp_errno = errno;
2500                 rc = -1;
2501                 goto out;
2502         }
2503
2504         rc = llapi_layout_sanity(existing_layout, path, false, false);
2505         if (rc) {
2506                 tmp_errno = errno;
2507                 llapi_layout_sanity_perror(rc);
2508                 rc = -1;
2509                 goto out;
2510         }
2511
2512         layout = __llapi_layout_alloc();
2513         if (layout == NULL) {
2514                 tmp_errno = errno;
2515                 rc = -1;
2516                 goto out;
2517         }
2518
2519         layout->llot_is_composite = true;
2520         for (i = 0; i < count; i++) {
2521                 comp = __llapi_comp_alloc(0);
2522                 if (comp == NULL) {
2523                         tmp_errno = errno;
2524                         rc = -1;
2525                         goto out;
2526                 }
2527
2528                 comp->llc_id = ids[i];
2529                 comp->llc_flags = flags[i];
2530
2531                 list_add_tail(&comp->llc_list, &layout->llot_comp_list);
2532                 layout->llot_cur_comp = comp;
2533         }
2534
2535         lum = llapi_layout_to_lum(layout);
2536         if (lum == NULL) {
2537                 tmp_errno = errno;
2538                 rc = -1;
2539                 goto out;
2540         }
2541
2542         lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
2543
2544         /* flush cached pages from clients */
2545         rc = llapi_file_flush(fd);
2546         if (rc) {
2547                 tmp_errno = -rc;
2548                 rc = -1;
2549                 goto out;
2550         }
2551
2552         rc = fsetxattr(fd, XATTR_LUSTRE_LOV".set.flags", lum, lum_size, 0);
2553         if (rc < 0) {
2554                 tmp_errno = errno;
2555                 goto out;
2556         }
2557
2558         rc = 0;
2559
2560 out:
2561         if (fd >= 0)
2562                 close(fd);
2563
2564         free(lum);
2565         llapi_layout_free(existing_layout);
2566         llapi_layout_free(layout);
2567         errno = tmp_errno;
2568         return rc;
2569 }
2570
2571 /**
2572  * Check if the file layout is composite.
2573  *
2574  * \param[in] layout    the file layout to check
2575  *
2576  * \retval true         composite
2577  * \retval false        not composite
2578  */
2579 bool llapi_layout_is_composite(struct llapi_layout *layout)
2580 {
2581         return layout->llot_is_composite;
2582 }
2583
2584 /**
2585  * Iterate every components in the @layout and call callback function @cb.
2586  *
2587  * \param[in] layout    component layout list.
2588  * \param[in] cb        callback for each component
2589  * \param[in] cbdata    callback data
2590  *
2591  * \retval < 0                          error happens during the iteration
2592  * \retval LLAPI_LAYOUT_ITER_CONT       finished the iteration w/o error
2593  * \retval LLAPI_LAYOUT_ITER_STOP       got something, stop the iteration
2594  */
2595 int llapi_layout_comp_iterate(struct llapi_layout *layout,
2596                               llapi_layout_iter_cb cb, void *cbdata)
2597 {
2598         int rc;
2599
2600         rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_FIRST);
2601         if (rc < 0)
2602                 return rc;
2603
2604         /**
2605          * make sure on success llapi_layout_comp_use() API returns 0 with
2606          * USE_FIRST.
2607          */
2608         assert(rc == 0);
2609
2610         while (1) {
2611                 rc = cb(layout, cbdata);
2612                 if (rc != LLAPI_LAYOUT_ITER_CONT)
2613                         break;
2614
2615                 rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_NEXT);
2616                 if (rc < 0)
2617                         return rc;
2618                 else if (rc == 1)       /* reached the last comp */
2619                         return LLAPI_LAYOUT_ITER_CONT;
2620         }
2621
2622         return rc;
2623 }
2624
2625 /**
2626  * llapi_layout_merge() - Merge a composite layout into another one.
2627  * @dst_layout: Destination composite layout.
2628  * @src_layout: Source composite layout.
2629  *
2630  * This function copies all of the components from @src_layout and
2631  * appends them to @dst_layout.
2632  *
2633  * Return: 0 on success or -1 on failure.
2634  */
2635 int llapi_layout_merge(struct llapi_layout **dst_layout,
2636                        const struct llapi_layout *src_layout)
2637 {
2638         struct llapi_layout *new_layout = *dst_layout;
2639         struct llapi_layout_comp *new = NULL;
2640         struct llapi_layout_comp *comp = NULL;
2641         int i = 0;
2642
2643         if (src_layout == NULL ||
2644             list_empty((struct list_head *)&src_layout->llot_comp_list))
2645                 return 0;
2646
2647         if (new_layout == NULL) {
2648                 new_layout = __llapi_layout_alloc();
2649                 if (new_layout == NULL) {
2650                         errno = ENOMEM;
2651                         return -1;
2652                 }
2653         }
2654
2655         list_for_each_entry(comp, &src_layout->llot_comp_list, llc_list) {
2656                 new = __llapi_comp_alloc(0);
2657                 if (new == NULL) {
2658                         errno = ENOMEM;
2659                         goto error;
2660                 }
2661
2662                 new->llc_pattern = comp->llc_pattern;
2663                 new->llc_stripe_size = comp->llc_stripe_size;
2664                 new->llc_stripe_count = comp->llc_stripe_count;
2665                 new->llc_stripe_offset = comp->llc_stripe_offset;
2666
2667                 if (comp->llc_pool_name[0] != '\0')
2668                         strncpy(new->llc_pool_name, comp->llc_pool_name,
2669                                 sizeof(new->llc_pool_name));
2670
2671                 for (i = 0; i < comp->llc_objects_count; i++) {
2672                         if (__llapi_comp_objects_realloc(new,
2673                             stripe_number_roundup(i)) < 0) {
2674                                 errno = EINVAL;
2675                                 __llapi_comp_free(new);
2676                                 goto error;
2677                         }
2678                         new->llc_objects[i].l_ost_idx = \
2679                                 comp->llc_objects[i].l_ost_idx;
2680                 }
2681
2682                 new->llc_objects_count = comp->llc_objects_count;
2683                 new->llc_extent.e_start = comp->llc_extent.e_start;
2684                 new->llc_extent.e_end = comp->llc_extent.e_end;
2685                 new->llc_id = comp->llc_id;
2686                 new->llc_flags = comp->llc_flags;
2687
2688                 list_add_tail(&new->llc_list, &new_layout->llot_comp_list);
2689                 new_layout->llot_cur_comp = new;
2690         }
2691         new_layout->llot_is_composite = true;
2692
2693         *dst_layout = new_layout;
2694         return 0;
2695 error:
2696         llapi_layout_free(new_layout);
2697         return -1;
2698 }
2699
2700 /**
2701  * Get the last initialized component
2702  *
2703  * \param[in] layout    component layout list.
2704  *
2705  * \retval 0            found
2706  * \retval -EINVAL      not found
2707  * \retval -EISDIR      directory layout
2708  */
2709 int llapi_layout_get_last_init_comp(struct llapi_layout *layout)
2710 {
2711         struct llapi_layout_comp *comp = NULL, *head = NULL;
2712
2713         if (!layout->llot_is_composite)
2714                 return 0;
2715
2716         head = list_entry(layout->llot_comp_list.next, typeof(*comp), llc_list);
2717         if (head == NULL)
2718                 return -EINVAL;
2719         if (head->llc_id == 0 && !(head->llc_flags & LCME_FL_INIT))
2720                 /* a directory */
2721                 return -EISDIR;
2722
2723         /* traverse the components from the tail to find the last init one */
2724         comp = list_entry(layout->llot_comp_list.prev, typeof(*comp), llc_list);
2725         while (comp != head) {
2726                 if (comp->llc_flags & LCME_FL_INIT)
2727                         break;
2728                 comp = list_entry(comp->llc_list.prev, typeof(*comp), llc_list);
2729         }
2730
2731         layout->llot_cur_comp = comp;
2732
2733         return comp->llc_flags & LCME_FL_INIT ? 0 : -EINVAL;
2734 }
2735
2736 /**
2737  * Interit stripe info from the file's component to the mirror
2738  *
2739  * \param[in] layout    file component layout list.
2740  * \param[in] layout    mirro component layout list.
2741  *
2742  * \retval 0            on success
2743  * \retval -EINVAL      on error
2744  */
2745 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
2746                                 struct llapi_layout *m_layout)
2747 {
2748         struct llapi_layout_comp *m_comp = NULL;
2749         struct llapi_layout_comp *f_comp = NULL;
2750         int rc = 0;
2751
2752         f_comp = __llapi_layout_cur_comp(f_layout);
2753         if (f_comp == NULL)
2754                 return -EINVAL;
2755         m_comp = __llapi_layout_cur_comp(m_layout);
2756         if (m_comp == NULL)
2757                 return -EINVAL;
2758
2759         /* DoM component does not inherit stripe size */
2760         if (m_comp->llc_pattern != LLAPI_LAYOUT_MDT)
2761                 m_comp->llc_stripe_size = f_comp->llc_stripe_size;
2762         m_comp->llc_stripe_count = f_comp->llc_stripe_count;
2763
2764         return rc;
2765 }
2766
2767 /**
2768  * Find all stale components.
2769  *
2770  * \param[in] layout            component layout list.
2771  * \param[out] comp             array of stale component info.
2772  * \param[in] comp_size         array size of @comp.
2773  * \param[in] mirror_ids        array of mirror id that only components
2774  *                              belonging to these mirror will be collected.
2775  * \param[in] ids_nr            number of mirror ids array.
2776  *
2777  * \retval              number of component info collected on sucess or
2778  *                      an error code on failure.
2779  */
2780 int llapi_mirror_find_stale(struct llapi_layout *layout,
2781                 struct llapi_resync_comp *comp, size_t comp_size,
2782                 __u16 *mirror_ids, int ids_nr)
2783 {
2784         int idx = 0;
2785         int rc;
2786
2787         rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_FIRST);
2788         if (rc < 0)
2789                 goto error;
2790
2791         while (rc == 0) {
2792                 uint32_t id;
2793                 uint32_t mirror_id;
2794                 uint32_t flags;
2795                 uint64_t start, end;
2796
2797                 rc = llapi_layout_comp_flags_get(layout, &flags);
2798                 if (rc < 0)
2799                         goto error;
2800
2801                 if (!(flags & LCME_FL_STALE))
2802                         goto next;
2803
2804                 rc = llapi_layout_mirror_id_get(layout, &mirror_id);
2805                 if (rc < 0)
2806                         goto error;
2807
2808                 /* the caller only wants stale components from specific
2809                  * mirrors */
2810                 if (ids_nr > 0) {
2811                         int j;
2812
2813                         for (j = 0; j < ids_nr; j++) {
2814                                 if (mirror_ids[j] == mirror_id)
2815                                         break;
2816                         }
2817
2818                         /* not in the specified mirror */
2819                         if (j == ids_nr)
2820                                 goto next;
2821                 } else if (flags & LCME_FL_NOSYNC) {
2822                         /* if not specified mirrors, do not resync "nosync"
2823                          * mirrors */
2824                         goto next;
2825                 }
2826
2827                 rc = llapi_layout_comp_id_get(layout, &id);
2828                 if (rc < 0)
2829                         goto error;
2830
2831                 rc = llapi_layout_comp_extent_get(layout, &start, &end);
2832                 if (rc < 0)
2833                         goto error;
2834
2835                 /* pack this component into @comp array */
2836                 comp[idx].lrc_id = id;
2837                 comp[idx].lrc_mirror_id = mirror_id;
2838                 comp[idx].lrc_start = start;
2839                 comp[idx].lrc_end = end;
2840                 idx++;
2841
2842                 if (idx >= comp_size) {
2843                         rc = -EINVAL;
2844                         goto error;
2845                 }
2846
2847         next:
2848                 rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_NEXT);
2849                 if (rc < 0) {
2850                         rc = -EINVAL;
2851                         goto error;
2852                 }
2853         }
2854 error:
2855         return rc < 0 ? rc : idx;
2856 }
2857
2858 /* locate @layout to a valid component covering file [file_start, file_end) */
2859 uint32_t llapi_mirror_find(struct llapi_layout *layout,
2860                            uint64_t file_start, uint64_t file_end,
2861                            uint64_t *endp)
2862 {
2863         uint32_t mirror_id = 0;
2864         int rc;
2865
2866         rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_FIRST);
2867         if (rc < 0)
2868                 return rc;
2869
2870         *endp = 0;
2871         while (rc == 0) {
2872                 uint64_t start, end;
2873                 uint32_t flags, id, rid;
2874
2875                 rc = llapi_layout_comp_flags_get(layout, &flags);
2876                 if (rc < 0)
2877                         return rc;
2878
2879                 if (flags & LCME_FL_STALE)
2880                         goto next;
2881
2882                 rc = llapi_layout_mirror_id_get(layout, &rid);
2883                 if (rc < 0)
2884                         return rc;
2885
2886                 rc = llapi_layout_comp_id_get(layout, &id);
2887                 if (rc < 0)
2888                         return rc;
2889
2890                 rc = llapi_layout_comp_extent_get(layout, &start, &end);
2891                 if (rc < 0)
2892                         return rc;
2893
2894                 if (file_start >= start && file_start < end) {
2895                         if (!mirror_id)
2896                                 mirror_id = rid;
2897                         else if (mirror_id != rid || *endp != start)
2898                                 break;
2899
2900                         file_start = *endp = end;
2901                         if (end >= file_end)
2902                                 break;
2903                 }
2904
2905         next:
2906                 rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_NEXT);
2907                 if (rc < 0)
2908                         return rc;
2909         }
2910         if (!mirror_id)
2911                 return -ENOENT;
2912
2913         return mirror_id;
2914 }
2915
2916 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
2917                              struct llapi_resync_comp *comp_array,
2918                              int comp_size,  uint64_t start, uint64_t end)
2919 {
2920         size_t page_size = sysconf(_SC_PAGESIZE);
2921         const size_t buflen = 4 << 20; /* 4M */
2922         void *buf;
2923         uint64_t pos = start;
2924         uint64_t data_off = pos, data_end = pos;
2925         uint32_t src = 0;
2926         int i;
2927         int rc;
2928         int rc2 = 0;
2929
2930         rc = posix_memalign(&buf, page_size, buflen);
2931         if (rc)
2932                 return -rc;
2933
2934         while (pos < end) {
2935                 uint64_t mirror_end;
2936                 ssize_t bytes_read;
2937                 size_t to_read;
2938                 size_t to_write;
2939
2940                 if (pos >= data_end) {
2941                         off_t tmp_off;
2942                         size_t data_size;
2943
2944                         if (pos >= mirror_end || !src) {
2945                                 rc = llapi_mirror_find(layout, pos, end,
2946                                                         &mirror_end);
2947                                 if (rc < 0)
2948                                         return rc;
2949                                 src = rc;
2950                                 /* restrict mirror end by resync end */
2951                                 mirror_end = MIN(end, mirror_end);
2952                         }
2953
2954                         tmp_off = llapi_mirror_data_seek(fd, src, pos,
2955                                                          &data_size);
2956                         if (tmp_off < 0) {
2957                                 /* switch to full copy */
2958                                 to_read = mirror_end - pos;
2959                                 goto do_read;
2960                         }
2961                         data_off = tmp_off;
2962                         data_end = data_off + data_size;
2963
2964                         data_off = MIN(data_off, mirror_end);
2965                         data_end = MIN(data_end, mirror_end);
2966
2967                         /* align by page, if there is data block to copy */
2968                         if (data_size)
2969                                 data_off &= ~(page_size - 1);
2970                 }
2971
2972                 if (pos < data_off) {
2973                         for (i = 0; i < comp_size; i++) {
2974                                 uint64_t cur_pos;
2975                                 size_t to_punch;
2976                                 uint32_t mid = comp_array[i].lrc_mirror_id;
2977
2978                                 /* skip non-overlapped component */
2979                                 if (pos >= comp_array[i].lrc_end ||
2980                                     data_off <= comp_array[i].lrc_start)
2981                                         continue;
2982
2983                                 if (pos < comp_array[i].lrc_start)
2984                                         cur_pos = comp_array[i].lrc_start;
2985                                 else
2986                                         cur_pos = pos;
2987
2988                                 if (data_off > comp_array[i].lrc_end)
2989                                         to_punch = comp_array[i].lrc_end -
2990                                                    cur_pos;
2991                                 else
2992                                         to_punch = data_off - cur_pos;
2993
2994                                 if (comp_array[i].lrc_end == OBD_OBJECT_EOF) {
2995                                         /* the last component can be truncated
2996                                          * safely
2997                                          */
2998                                         rc = llapi_mirror_truncate(fd, mid,
2999                                                                    cur_pos);
3000                                         /* hole at the end of file, so just
3001                                          * truncate up to set size.
3002                                          */
3003                                         if (!rc && data_off == data_end)
3004                                                 rc = llapi_mirror_truncate(fd,
3005                                                                 mid, data_end);
3006                                 } else {
3007                                         rc = llapi_mirror_punch(fd,
3008                                                 comp_array[i].lrc_mirror_id,
3009                                                 cur_pos, to_punch);
3010                                 }
3011                                 /* if failed then read failed hole range */
3012                                 if (rc < 0) {
3013                                         rc = 0;
3014                                         pos = cur_pos;
3015                                         if (pos + to_punch == data_off)
3016                                                 to_read = data_end - pos;
3017                                         else
3018                                                 to_read = to_punch;
3019                                         goto do_read;
3020                                 }
3021                         }
3022                         pos = data_off;
3023                 }
3024                 if (pos == mirror_end)
3025                         continue;
3026                 to_read = data_end - pos;
3027 do_read:
3028                 if (!to_read)
3029                         break;
3030
3031                 assert(data_end <= mirror_end);
3032
3033                 to_read = MIN(buflen, to_read);
3034                 to_read = ((to_read - 1) | (page_size - 1)) + 1;
3035                 bytes_read = llapi_mirror_read(fd, src, buf, to_read, pos);
3036                 if (bytes_read == 0) {
3037                         /* end of file */
3038                         break;
3039                 }
3040                 if (bytes_read < 0) {
3041                         rc = bytes_read;
3042                         break;
3043                 }
3044
3045                 /* round up to page align to make direct IO happy. */
3046                 to_write = ((bytes_read - 1) | (page_size - 1)) + 1;
3047
3048                 for (i = 0; i < comp_size; i++) {
3049                         ssize_t written;
3050                         off_t pos2 = pos;
3051                         size_t to_write2 = to_write;
3052
3053                         /* skip non-overlapped component */
3054                         if (pos >= comp_array[i].lrc_end ||
3055                             pos + to_write <= comp_array[i].lrc_start)
3056                                 continue;
3057
3058                         if (pos < comp_array[i].lrc_start)
3059                                 pos2 = comp_array[i].lrc_start;
3060
3061                         to_write2 -= pos2 - pos;
3062
3063                         if ((pos + to_write) > comp_array[i].lrc_end)
3064                                 to_write2 -= pos + to_write -
3065                                              comp_array[i].lrc_end;
3066
3067                         written = llapi_mirror_write(fd,
3068                                         comp_array[i].lrc_mirror_id,
3069                                         buf + pos2 - pos,
3070                                         to_write2, pos2);
3071                         if (written < 0) {
3072                                 /**
3073                                  * this component is not written successfully,
3074                                  * mark it using its lrc_synced, it is supposed
3075                                  * to be false before getting here.
3076                                  *
3077                                  * And before this function returns, all
3078                                  * elements of comp_array will reverse their
3079                                  * lrc_synced flag to reflect their true
3080                                  * meanings.
3081                                  */
3082                                 comp_array[i].lrc_synced = true;
3083                                 llapi_error(LLAPI_MSG_ERROR, written,
3084                                             "component %u not synced",
3085                                             comp_array[i].lrc_id);
3086                                 if (rc2 == 0)
3087                                         rc2 = (int)written;
3088                                 continue;
3089                         }
3090                         assert(written == to_write2);
3091                 }
3092                 pos += bytes_read;
3093         }
3094
3095         free(buf);
3096
3097         if (rc < 0) {
3098                 /* fatal error happens */
3099                 for (i = 0; i < comp_size; i++)
3100                         comp_array[i].lrc_synced = false;
3101                 return rc;
3102         }
3103
3104         /**
3105          * no fatal error happens, each lrc_synced tells whether the component
3106          * has been resync successfully (note: we'd reverse the value to
3107          * reflect its true meaning.
3108          */
3109         for (i = 0; i < comp_size; i++) {
3110                 comp_array[i].lrc_synced = !comp_array[i].lrc_synced;
3111                 if (comp_array[i].lrc_synced && pos & (page_size - 1)) {
3112                         rc = llapi_mirror_truncate(fd,
3113                                         comp_array[i].lrc_mirror_id, pos);
3114                         if (rc < 0)
3115                                 comp_array[i].lrc_synced = false;
3116                 }
3117         }
3118
3119         /**
3120          * returns the first error code for partially successful resync if
3121          * possible.
3122          */
3123         return rc2;
3124 }
3125
3126 enum llapi_layout_comp_sanity_error {
3127         LSE_OK,
3128         LSE_INCOMPLETE_MIRROR,
3129         LSE_ADJACENT_EXTENSION,
3130         LSE_INIT_EXTENSION,
3131         LSE_FLAGS,
3132         LSE_DOM_EXTENSION,
3133         LSE_DOM_EXTENSION_FOLLOWING,
3134         LSE_DOM_FIRST,
3135         LSE_SET_COMP_START,
3136         LSE_NOT_ZERO_LENGTH_EXTENDABLE,
3137         LSE_END_NOT_GREATER,
3138         LSE_ZERO_LENGTH_NORMAL,
3139         LSE_NOT_ADJACENT_PREV,
3140         LSE_START_GT_END,
3141         LSE_ALIGN_END,
3142         LSE_ALIGN_EXT,
3143         LSE_UNKNOWN_OST,
3144         LSE_LAST,
3145 };
3146
3147 const char *const llapi_layout_strerror[] =
3148 {
3149         [LSE_OK] = "",
3150         [LSE_INCOMPLETE_MIRROR] =
3151                 "Incomplete mirror - must go to EOF",
3152         [LSE_ADJACENT_EXTENSION] =
3153                 "No adjacent extension space components",
3154         [LSE_INIT_EXTENSION] =
3155                 "Cannot apply extension flag to init components",
3156         [LSE_FLAGS] =
3157                 "Wrong flags",
3158         [LSE_DOM_EXTENSION] =
3159                 "DoM components can't be extension space",
3160         [LSE_DOM_EXTENSION_FOLLOWING] =
3161                 "DoM components cannot be followed by extension space",
3162         [LSE_DOM_FIRST] =
3163                 "DoM component should be the first one in a file/mirror",
3164         [LSE_SET_COMP_START] =
3165                 "Must set previous component extent before adding next",
3166         [LSE_NOT_ZERO_LENGTH_EXTENDABLE] =
3167                 "Extendable component must start out zero-length",
3168         [LSE_END_NOT_GREATER] =
3169                 "Component end is before end of previous component",
3170         [LSE_ZERO_LENGTH_NORMAL] =
3171                 "Zero length components must be followed by extension",
3172         [LSE_NOT_ADJACENT_PREV] =
3173                 "Components not adjacent (end != next->start",
3174         [LSE_START_GT_END] =
3175                 "Component start is > end",
3176         [LSE_ALIGN_END] =
3177                 "The component end must be aligned by the stripe size",
3178         [LSE_ALIGN_EXT] =
3179                 "The extension size must be aligned by the stripe size",
3180         [LSE_UNKNOWN_OST] =
3181                 "An unknown OST idx is specified",
3182 };
3183
3184 struct llapi_layout_sanity_args {
3185         char lsa_fsname[MAX_OBD_NAME + 1];
3186         bool lsa_incomplete;
3187         bool lsa_flr;
3188         bool lsa_ondisk;
3189         int lsa_rc;
3190 };
3191
3192 /* The component flags can be set by users at creation/modification time. */
3193 #define LCME_USER_COMP_FLAGS    (LCME_FL_PREF_RW | LCME_FL_NOSYNC | \
3194                                  LCME_FL_EXTENSION)
3195
3196 /**
3197  * When modified, adjust llapi_stripe_param_verify() if needed as well.
3198  */
3199 static int llapi_layout_sanity_cb(struct llapi_layout *layout,
3200                                   void *arg)
3201 {
3202         struct llapi_layout_comp *comp, *next, *prev;
3203         struct llapi_layout_sanity_args *args = arg;
3204         bool first_comp = false;
3205
3206         comp = __llapi_layout_cur_comp(layout);
3207         if (comp == NULL) {
3208                 args->lsa_rc = -1;
3209                 goto out_err;
3210         }
3211
3212         if (comp->llc_list.prev != &layout->llot_comp_list)
3213                 prev = list_entry(comp->llc_list.prev, typeof(*prev),
3214                                   llc_list);
3215         else
3216                 prev = NULL;
3217
3218         if (comp->llc_list.next != &layout->llot_comp_list)
3219                 next = list_entry(comp->llc_list.next, typeof(*next),
3220                                   llc_list);
3221         else
3222                 next = NULL;
3223
3224         /* Start of zero implies a new mirror */
3225         if (comp->llc_extent.e_start == 0) {
3226                 first_comp = true;
3227                 /* Most checks apply only within one mirror, this is an
3228                  * exception. */
3229                 if (prev && prev->llc_extent.e_end != LUSTRE_EOF) {
3230                         args->lsa_rc = LSE_INCOMPLETE_MIRROR;
3231                         goto out_err;
3232                 }
3233
3234                 prev = NULL;
3235         }
3236
3237         if (next && next->llc_extent.e_start == 0)
3238                 next = NULL;
3239
3240         /* Flag sanity checks */
3241         /* No adjacent extension components */
3242         if ((comp->llc_flags & LCME_FL_EXTENSION) && next &&
3243             (next->llc_flags & LCME_FL_EXTENSION)) {
3244                 args->lsa_rc = LSE_ADJACENT_EXTENSION;
3245                 goto out_err;
3246         }
3247
3248         /* Extension flag cannot be applied to init components and the first
3249          * component of each mirror is automatically init */
3250         if ((comp->llc_flags & LCME_FL_EXTENSION) &&
3251             (comp->llc_flags & LCME_FL_INIT || first_comp)) {
3252                 args->lsa_rc = LSE_INIT_EXTENSION;
3253                 goto out_err;
3254         }
3255
3256         if (comp->llc_ondisk) {
3257                 if (comp->llc_flags & LCME_FL_NEG)
3258                         args->lsa_rc = LSE_FLAGS;
3259         } else if (!args->lsa_incomplete) {
3260                 if (args->lsa_flr) {
3261                         if (comp->llc_flags & ~LCME_USER_COMP_FLAGS)
3262                                 args->lsa_rc = LSE_FLAGS;
3263                 } else {
3264                         if (comp->llc_flags &
3265                             ~(LCME_FL_EXTENSION | LCME_FL_PREF_RW))
3266                                 args->lsa_rc = LSE_FLAGS;
3267                 }
3268         }
3269         if (args->lsa_rc)
3270                 goto out_err;
3271
3272         /* DoM sanity checks */
3273         if (comp->llc_pattern == LLAPI_LAYOUT_MDT ||
3274             comp->llc_pattern == LOV_PATTERN_MDT) {
3275                 /* DoM components can't be extension components */
3276                 if (comp->llc_flags & LCME_FL_EXTENSION) {
3277                         args->lsa_rc = LSE_DOM_EXTENSION;
3278                         goto out_err;
3279                 }
3280                 /* DoM components cannot be followed by an extension comp */
3281                 if (next && (next->llc_flags & LCME_FL_EXTENSION)) {
3282                         args->lsa_rc = LSE_DOM_EXTENSION_FOLLOWING;
3283                         goto out_err;
3284                 }
3285
3286                 /* DoM should be the first component in a mirror */
3287                 if (!first_comp) {
3288                         args->lsa_rc = LSE_DOM_FIRST;
3289                         errno = EINVAL;
3290                         goto out_err;
3291                 }
3292         }
3293
3294         /* Extent sanity checks */
3295         /* Must set previous component extent before adding another */
3296         if (prev && prev->llc_extent.e_start == 0 &&
3297             prev->llc_extent.e_end == 0) {
3298                 args->lsa_rc = LSE_SET_COMP_START;
3299                 goto out_err;
3300         }
3301
3302         if (!args->lsa_incomplete) {
3303                 /* Components followed by extension space (extendable
3304                  * components) must be zero length before initialization.
3305                  * (Except for first comp, which will be initialized on
3306                  * creation). */
3307                 if (next && (next->llc_flags & LCME_FL_EXTENSION) &&
3308                     !first_comp && !(comp->llc_flags & LCME_FL_INIT) &&
3309                     comp->llc_extent.e_start != comp->llc_extent.e_end) {
3310                         args->lsa_rc = LSE_NOT_ZERO_LENGTH_EXTENDABLE;
3311                         goto out_err;
3312                 }
3313
3314                 /* End must come after end of previous comp */
3315                 if (prev && comp->llc_extent.e_end < prev->llc_extent.e_end) {
3316                         args->lsa_rc = LSE_END_NOT_GREATER;
3317                         goto out_err;
3318                 }
3319
3320                 /* Components not followed by ext space must have length > 0. */
3321                 if (comp->llc_extent.e_start == comp->llc_extent.e_end &&
3322                     (next == NULL || !(next->llc_flags & LCME_FL_EXTENSION))) {
3323                         args->lsa_rc = LSE_ZERO_LENGTH_NORMAL;
3324                         goto out_err;
3325                 }
3326
3327                 /* The component end must be aligned by the stripe size */
3328                 if ((comp->llc_flags & LCME_FL_EXTENSION) &&
3329                     (prev->llc_stripe_size != LLAPI_LAYOUT_DEFAULT)) {
3330                         if (comp->llc_extent.e_end != LUSTRE_EOF &&
3331                             comp->llc_extent.e_end % prev->llc_stripe_size) {
3332                                 args->lsa_rc = LSE_ALIGN_END;
3333                                 goto out_err;
3334                         }
3335                         if ((comp->llc_stripe_size * SEL_UNIT_SIZE) %
3336                             prev->llc_stripe_size) {
3337                                 args->lsa_rc = LSE_ALIGN_EXT;
3338                                 goto out_err;
3339                         }
3340                 } else if (!(comp->llc_flags & LCME_FL_EXTENSION) &&
3341                            (comp->llc_stripe_size != LLAPI_LAYOUT_DEFAULT)) {
3342                         if (comp->llc_extent.e_end != LUSTRE_EOF &&
3343                             comp->llc_extent.e_end !=
3344                             comp->llc_extent.e_start &&
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         if (args->lsa_fsname[0] != '\0') {
3366                 int i, rc = 0;
3367
3368                 if (comp->llc_pattern & LLAPI_LAYOUT_SPECIFIC) {
3369                         assert(comp->llc_stripe_count <=
3370                                comp->llc_objects_count);
3371
3372                         for (i = 0; i < comp->llc_stripe_count && rc == 0; i++){
3373                                 if (comp->llc_objects[i].l_ost_idx ==
3374                                     LLAPI_LAYOUT_IDX_MAX) {
3375                                         args->lsa_rc = -1;
3376                                         goto out_err;
3377                                 }
3378                                 rc = llapi_layout_search_ost(
3379                                         comp->llc_objects[i].l_ost_idx,
3380                                         comp->llc_pool_name, args->lsa_fsname);
3381                         }
3382                 } else if (comp->llc_stripe_offset != LLAPI_LAYOUT_DEFAULT) {
3383                         rc = llapi_layout_search_ost(
3384                                 comp->llc_stripe_offset,
3385                                 comp->llc_pool_name, args->lsa_fsname);
3386                 }
3387                 if (rc) {
3388                         args->lsa_rc = LSE_UNKNOWN_OST;
3389                         goto out_err;
3390                 }
3391         }
3392
3393         return LLAPI_LAYOUT_ITER_CONT;
3394
3395 out_err:
3396         errno = errno ? errno : EINVAL;
3397         return LLAPI_LAYOUT_ITER_STOP;
3398 }
3399
3400 /* Print explanation of layout error */
3401 void llapi_layout_sanity_perror(int error)
3402 {
3403         if (error >= LSE_LAST || error < 0) {
3404                 fprintf(stdout, "Invalid layout, unrecognized error: %d\n",
3405                         error);
3406         } else {
3407                 fprintf(stdout, "Invalid layout: %s\n",
3408                         llapi_layout_strerror[error]);
3409         }
3410 }
3411
3412 /* Walk a layout and enforce sanity checks that apply to > 1 component
3413  *
3414  * The core idea here is that of sanity checking individual tokens vs semantic
3415  * checking.
3416  * We cannot check everything at the individual component level ('token'),
3417  * instead we must check whether or not the full layout has a valid meaning.
3418  *
3419  * An example of a component level check is "is stripe size valid?".  That is
3420  * handled when setting stripe size.
3421  *
3422  * An example of a layout level check is "are the extents of these components
3423  * valid when adjacent to one another", or "can we set these flags on adjacent
3424  * components"?
3425  *
3426  * \param[in] layout            component layout list.
3427  * \param[in] fname             file the layout to be checked for
3428  * \param[in] incomplete        if layout is complete or not - some checks can
3429  *                              only be done on complete layouts.
3430  * \param[in] flr               set when this is called from FLR mirror create
3431  *
3432  * \retval                      0, success, positive: various errors, see
3433  *                              llapi_layout_sanity_perror, -1, failure
3434  */
3435 int llapi_layout_sanity(struct llapi_layout *layout,
3436                         const char *fname,
3437                         bool incomplete,
3438                         bool flr)
3439 {
3440         struct llapi_layout_sanity_args args = { { 0 } };
3441         struct llapi_layout_comp *curr;
3442         int rc = 0;
3443
3444         if (!layout)
3445                 return 0;
3446
3447         curr = layout->llot_cur_comp;
3448         if (!curr)
3449                 return 0;
3450
3451         /* Make sure we are on a Lustre file system */
3452         if (fname) {
3453                 rc = llapi_search_fsname(fname, args.lsa_fsname);
3454                 if (rc) {
3455                         llapi_error(LLAPI_MSG_ERROR, rc,
3456                                     "'%s' is not on a Lustre filesystem",
3457                                     fname);
3458                         return rc;
3459                 }
3460         }
3461
3462         /* Set up args */
3463         args.lsa_rc = 0;
3464         args.lsa_flr = flr;
3465         args.lsa_incomplete = incomplete;
3466
3467         /* When we modify an existing layout, this tells us if it's FLR */
3468         if (mirror_id_of(curr->llc_id) > 0)
3469                 args.lsa_flr = true;
3470
3471         errno = 0;
3472         rc = llapi_layout_comp_iterate(layout,
3473                                        llapi_layout_sanity_cb,
3474                                        &args);
3475         if (errno == ENOENT)
3476                 errno = 0;
3477
3478         if (rc != LLAPI_LAYOUT_ITER_CONT)
3479                 rc = args.lsa_rc;
3480
3481         layout->llot_cur_comp = curr;
3482
3483         return rc;
3484 }
3485
3486 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size)
3487 {
3488         uint64_t pattern, start;
3489         int rc;
3490
3491         if (!layout || !llapi_layout_is_composite(layout)) {
3492                 *size = 0;
3493                 return 0;
3494         }
3495
3496         rc = llapi_layout_comp_use(layout, LLAPI_LAYOUT_COMP_USE_FIRST);
3497         if (rc)
3498                 return -errno;
3499
3500         rc = llapi_layout_pattern_get(layout, &pattern);
3501         if (rc)
3502                 return -errno;
3503
3504         if (pattern != LOV_PATTERN_MDT && pattern != LLAPI_LAYOUT_MDT) {
3505                 *size = 0;
3506                 return 0;
3507         }
3508
3509         rc = llapi_layout_comp_extent_get(layout, &start, size);
3510         if (rc)
3511                 return -errno;
3512         if (start)
3513                 return -ERANGE;
3514         return 0;
3515 }
3516
3517 int lov_comp_md_size(struct lov_comp_md_v1 *lcm)
3518 {
3519         if (lcm->lcm_magic == LOV_MAGIC_V1 || lcm->lcm_magic == LOV_MAGIC_V3) {
3520                 struct lov_user_md *lum = (void *)lcm;
3521
3522                 return lov_user_md_size(lum->lmm_stripe_count, lum->lmm_magic);
3523         }
3524
3525         if (lcm->lcm_magic == LOV_MAGIC_FOREIGN) {
3526                 struct lov_foreign_md *lfm = (void *)lcm;
3527
3528                 return lfm->lfm_length;
3529         }
3530
3531         if (lcm->lcm_magic != LOV_MAGIC_COMP_V1)
3532                 return -EOPNOTSUPP;
3533
3534         return lcm->lcm_size;
3535 }
3536
3537 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
3538                           lstatx_t *statx, struct lov_user_md *lum,
3539                           size_t lumsize)
3540 {
3541         struct lov_user_mds_data *lmd;
3542         char buf[65536 + offsetof(typeof(*lmd), lmd_lmm)];
3543         int parent_fd = -1;
3544         int rc;
3545
3546         if (lum && lumsize < sizeof(*lum))
3547                 return -EINVAL;
3548
3549         /* If a file name is provided, it is relative to the parent directory */
3550         if (fname) {
3551                 parent_fd = dir_fd;
3552                 dir_fd = -1;
3553         }
3554
3555         lmd = (struct lov_user_mds_data *)buf;
3556         rc = get_lmd_info_fd(fname, parent_fd, dir_fd, buf, sizeof(buf),
3557                              GET_LMD_INFO);
3558         if (rc)
3559                 return rc;
3560
3561         if (valid)
3562                 *valid = lmd->lmd_flags;
3563
3564         if (statx)
3565                 memcpy(statx, &lmd->lmd_stx, sizeof(*statx));
3566
3567         if (lum) {
3568                 if (lmd->lmd_lmmsize > lumsize)
3569                         return -EOVERFLOW;
3570                 memcpy(lum, &lmd->lmd_lmm, lmd->lmd_lmmsize);
3571         }
3572
3573         return 0;
3574 }
3575
3576 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
3577                          struct lov_user_md *lum, size_t lumsize)
3578 {
3579         return llapi_get_lum_file_fd(dir_fd, NULL, valid, statx, lum, lumsize);
3580 }
3581
3582 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
3583                        struct lov_user_md *lum, size_t lumsize)
3584 {
3585         char parent[PATH_MAX];
3586         const char *fname;
3587         char *tmp;
3588         int offset;
3589         int dir_fd;
3590         int rc;
3591
3592         tmp = strrchr(path, '/');
3593         if (!tmp) {
3594                 strncpy(parent, ".", sizeof(parent) - 1);
3595                 offset = -1;
3596         } else {
3597                 strncpy(parent, path, tmp - path);
3598                 offset = tmp - path - 1;
3599                 parent[tmp - path] = 0;
3600         }
3601
3602         fname = path;
3603         if (offset >= 0)
3604                 fname += offset + 2;
3605
3606         dir_fd = open(parent, O_RDONLY);
3607         if (dir_fd < 0) {
3608                 rc = -errno;
3609                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot open '%s'", path);
3610                 return rc;
3611         }
3612
3613         rc = llapi_get_lum_file_fd(dir_fd, fname, valid, statx, lum, lumsize);
3614         close(dir_fd);
3615         return rc;
3616 }
3617
3618 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
3619                       struct lov_user_md *lum, size_t lumsize)
3620 {
3621         int dir_fd;
3622         int rc;
3623
3624         dir_fd = open(path, O_RDONLY);
3625         if (dir_fd < 0) {
3626                 rc = -errno;
3627                 llapi_error(LLAPI_MSG_ERROR, rc, "cannot open '%s'", path);
3628                 return rc;
3629         }
3630
3631         rc = llapi_get_lum_dir_fd(dir_fd, valid, statx, lum, lumsize);
3632         close(dir_fd);
3633         return rc;
3634 }