4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
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
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.
20 * lustre/utils/liblustreapi_layout.c
22 * lustreapi library for layout calls for interacting with the layout of
23 * Lustre files while hiding details of the internal data structures
26 * Copyright (c) 2016, Intel Corporation.
28 * Author: Ned Bass <bass6@llnl.gov>
37 #include <sys/xattr.h>
39 #include <libcfs/util/list.h>
40 #include <lustre/lustreapi.h>
41 #include <lustre/lustre_idl.h>
42 #include "lustreapi_internal.h"
45 * Layout component, which contains all attributes of a plain
48 struct llapi_layout_comp {
50 uint64_t llc_stripe_size;
51 uint64_t llc_stripe_count;
52 uint64_t llc_stripe_offset;
53 /* Add 1 so user always gets back a null terminated string. */
54 char llc_pool_name[LOV_MAXPOOLNAME + 1];
55 /** Number of objects in llc_objects array if was initialized. */
56 uint32_t llc_objects_count;
57 struct lov_user_ost_data_v1 *llc_objects;
58 /* fields used only for composite layouts */
59 struct lu_extent llc_extent; /* [start, end) of component */
60 uint32_t llc_id; /* unique ID of component */
61 uint32_t llc_flags; /* LCME_FL_* flags */
62 struct list_head llc_list; /* linked to the llapi_layout
67 * An Opaque data type abstracting the layout of a Lustre file.
70 uint32_t llot_magic; /* LLAPI_LAYOUT_MAGIC */
73 bool llot_is_composite;
74 /* Cursor pointing to one of the components in llot_comp_list */
75 struct llapi_layout_comp *llot_cur_comp;
76 struct list_head llot_comp_list;
80 * Compute the number of elements in the lmm_objects array of \a lum
81 * with size \a lum_size.
83 * \param[in] lum the struct lov_user_md to check
84 * \param[in] lum_size the number of bytes in \a lum
86 * \retval number of elements in array lum->lmm_objects
88 static int llapi_layout_objects_in_lum(struct lov_user_md *lum, size_t lum_size)
93 if (lum_size < lov_user_md_size(0, LOV_MAGIC_V1))
96 if (lum->lmm_magic == __swab32(LOV_MAGIC_V1) ||
97 lum->lmm_magic == __swab32(LOV_MAGIC_V3))
98 magic = __swab32(lum->lmm_magic);
100 magic = lum->lmm_magic;
102 base_size = lov_user_md_size(0, magic);
104 if (lum_size <= base_size)
107 return (lum_size - base_size) / sizeof(lum->lmm_objects[0]);
111 * Byte-swap the fields of struct lov_user_md.
113 * XXX Rather than duplicating swabbing code here, we should eventually
114 * refactor the needed functions in lustre/ptlrpc/pack_generic.c
115 * into a library that can be shared between kernel and user code.
118 llapi_layout_swab_lov_user_md(struct lov_user_md *lum, int lum_size)
120 int i, j, ent_count, obj_count;
121 struct lov_comp_md_v1 *comp_v1 = NULL;
122 struct lov_comp_md_entry_v1 *ent;
123 struct lov_user_ost_data *lod;
125 if (lum->lmm_magic != __swab32(LOV_MAGIC_V1) &&
126 lum->lmm_magic != __swab32(LOV_MAGIC_V3) &&
127 lum->lmm_magic != __swab32(LOV_MAGIC_COMP_V1))
130 if (lum->lmm_magic == __swab32(LOV_MAGIC_COMP_V1))
131 comp_v1 = (struct lov_comp_md_v1 *)lum;
133 if (comp_v1 != NULL) {
134 __swab32s(&comp_v1->lcm_magic);
135 __swab32s(&comp_v1->lcm_size);
136 __swab32s(&comp_v1->lcm_layout_gen);
137 __swab16s(&comp_v1->lcm_flags);
138 __swab16s(&comp_v1->lcm_entry_count);
139 ent_count = comp_v1->lcm_entry_count;
144 for (i = 0; i < ent_count; i++) {
145 if (comp_v1 != NULL) {
146 ent = &comp_v1->lcm_entries[i];
147 __swab32s(&ent->lcme_id);
148 __swab32s(&ent->lcme_flags);
149 __swab64s(&ent->lcme_extent.e_start);
150 __swab64s(&ent->lcme_extent.e_end);
151 __swab32s(&ent->lcme_offset);
152 __swab32s(&ent->lcme_size);
154 lum = (struct lov_user_md *)((char *)comp_v1 +
156 lum_size = ent->lcme_size;
158 obj_count = llapi_layout_objects_in_lum(lum, lum_size);
160 __swab32s(&lum->lmm_magic);
161 __swab32s(&lum->lmm_pattern);
162 __swab32s(&lum->lmm_stripe_size);
163 __swab16s(&lum->lmm_stripe_count);
164 __swab16s(&lum->lmm_stripe_offset);
166 if (lum->lmm_magic != LOV_MAGIC_V1) {
167 struct lov_user_md_v3 *v3;
168 v3 = (struct lov_user_md_v3 *)lum;
169 lod = v3->lmm_objects;
171 lod = lum->lmm_objects;
174 for (j = 0; j < obj_count; j++)
175 __swab32s(&lod[j].l_ost_idx);
180 * (Re-)allocate llc_objects[] to \a num_stripes stripes.
182 * Copy over existing llc_objects[], if any, to the new llc_objects[].
184 * \param[in] layout existing layout to be modified
185 * \param[in] num_stripes number of stripes in new layout
187 * \retval 0 if the objects are re-allocated successfully
188 * \retval -1 on error with errno set
190 static int __llapi_comp_objects_realloc(struct llapi_layout_comp *comp,
191 unsigned int new_stripes)
193 struct lov_user_ost_data_v1 *new_objects;
196 if (new_stripes > LOV_MAX_STRIPE_COUNT) {
201 if (new_stripes == comp->llc_objects_count)
204 if (new_stripes != 0 && new_stripes <= comp->llc_objects_count)
207 new_objects = realloc(comp->llc_objects,
208 sizeof(*new_objects) * new_stripes);
209 if (new_objects == NULL && new_stripes != 0) {
214 for (i = comp->llc_objects_count; i < new_stripes; i++)
215 new_objects[i].l_ost_idx = LLAPI_LAYOUT_IDX_MAX;
217 comp->llc_objects = new_objects;
218 comp->llc_objects_count = new_stripes;
224 * Allocate storage for a llapi_layout_comp with \a num_stripes stripes.
226 * \param[in] num_stripes number of stripes in new layout
228 * \retval valid pointer if allocation succeeds
229 * \retval NULL if allocation fails
231 static struct llapi_layout_comp *__llapi_comp_alloc(unsigned int num_stripes)
233 struct llapi_layout_comp *comp;
235 if (num_stripes > LOV_MAX_STRIPE_COUNT) {
240 comp = calloc(1, sizeof(*comp));
246 comp->llc_objects = NULL;
247 comp->llc_objects_count = 0;
249 if (__llapi_comp_objects_realloc(comp, num_stripes) < 0) {
255 comp->llc_pattern = LLAPI_LAYOUT_DEFAULT;
256 comp->llc_stripe_size = LLAPI_LAYOUT_DEFAULT;
257 comp->llc_stripe_count = LLAPI_LAYOUT_DEFAULT;
258 comp->llc_stripe_offset = LLAPI_LAYOUT_DEFAULT;
259 comp->llc_pool_name[0] = '\0';
260 comp->llc_extent.e_start = 0;
261 comp->llc_extent.e_end = LUSTRE_EOF;
264 INIT_LIST_HEAD(&comp->llc_list);
270 * Free memory allocated for \a comp
272 * \param[in] comp previously allocated by __llapi_comp_alloc()
274 static void __llapi_comp_free(struct llapi_layout_comp *comp)
276 if (comp->llc_objects != NULL)
277 free(comp->llc_objects);
282 * Free memory allocated for \a layout.
284 * \param[in] layout previously allocated by llapi_layout_alloc()
286 void llapi_layout_free(struct llapi_layout *layout)
288 struct llapi_layout_comp *comp, *n;
293 list_for_each_entry_safe(comp, n, &layout->llot_comp_list, llc_list) {
294 list_del_init(&comp->llc_list);
295 __llapi_comp_free(comp);
301 * Allocate and initialize a llapi_layout structure.
303 * \retval valid llapi_layout pointer on success
304 * \retval NULL if memory allocation fails
306 static struct llapi_layout *__llapi_layout_alloc(void)
308 struct llapi_layout *layout;
310 layout = calloc(1, sizeof(*layout));
311 if (layout == NULL) {
317 layout->llot_magic = LLAPI_LAYOUT_MAGIC;
318 layout->llot_gen = 0;
319 layout->llot_flags = 0;
320 layout->llot_is_composite = false;
321 layout->llot_cur_comp = NULL;
322 INIT_LIST_HEAD(&layout->llot_comp_list);
328 * Allocate and initialize a new plain layout.
330 * \retval valid llapi_layout pointer on success
331 * \retval NULL if memory allocation fails
333 struct llapi_layout *llapi_layout_alloc(void)
335 struct llapi_layout_comp *comp;
336 struct llapi_layout *layout;
338 layout = __llapi_layout_alloc();
342 comp = __llapi_comp_alloc(0);
348 list_add_tail(&comp->llc_list, &layout->llot_comp_list);
349 layout->llot_cur_comp = comp;
355 * Convert the data from a lov_user_md to a newly allocated llapi_layout.
356 * The caller is responsible for freeing the returned pointer.
358 * \param[in] lum LOV user metadata structure to copy data from
359 * \param[in] lum_size size the the lum passed in
361 * \retval valid llapi_layout pointer on success
362 * \retval NULL if memory allocation fails
364 static struct llapi_layout *
365 llapi_layout_from_lum(const struct lov_user_md *lum, int lum_size)
367 struct lov_comp_md_v1 *comp_v1 = NULL;
368 struct lov_comp_md_entry_v1 *ent;
369 struct lov_user_md *v1;
370 struct llapi_layout *layout;
371 struct llapi_layout_comp *comp;
372 int i, ent_count = 0, obj_count;
374 layout = __llapi_layout_alloc();
378 if (lum->lmm_magic == LOV_MAGIC_COMP_V1) {
379 comp_v1 = (struct lov_comp_md_v1 *)lum;
380 ent_count = comp_v1->lcm_entry_count;
381 layout->llot_is_composite = true;
382 layout->llot_gen = comp_v1->lcm_layout_gen;
383 layout->llot_flags = comp_v1->lcm_flags;
384 } else if (lum->lmm_magic == LOV_MAGIC_V1 ||
385 lum->lmm_magic == LOV_MAGIC_V3) {
387 layout->llot_is_composite = false;
390 if (ent_count == 0) {
395 v1 = (struct lov_user_md *)lum;
396 for (i = 0; i < ent_count; i++) {
397 if (comp_v1 != NULL) {
398 ent = &comp_v1->lcm_entries[i];
399 v1 = (struct lov_user_md *)((char *)comp_v1 +
401 lum_size = ent->lcme_size;
406 obj_count = llapi_layout_objects_in_lum(v1, lum_size);
407 comp = __llapi_comp_alloc(obj_count);
412 comp->llc_extent.e_start = ent->lcme_extent.e_start;
413 comp->llc_extent.e_end = ent->lcme_extent.e_end;
414 comp->llc_id = ent->lcme_id;
415 comp->llc_flags = ent->lcme_flags;
417 comp->llc_extent.e_start = 0;
418 comp->llc_extent.e_end = LUSTRE_EOF;
423 if (v1->lmm_pattern == LOV_PATTERN_RAID0)
424 comp->llc_pattern = LLAPI_LAYOUT_RAID0;
426 /* Lustre only supports RAID0 for now. */
427 comp->llc_pattern = v1->lmm_pattern;
429 if (v1->lmm_stripe_size == 0)
430 comp->llc_stripe_size = LLAPI_LAYOUT_DEFAULT;
432 comp->llc_stripe_size = v1->lmm_stripe_size;
434 if (v1->lmm_stripe_count == (typeof(v1->lmm_stripe_count))-1)
435 comp->llc_stripe_count = LLAPI_LAYOUT_WIDE;
436 else if (v1->lmm_stripe_count == 0)
437 comp->llc_stripe_count = LLAPI_LAYOUT_DEFAULT;
439 comp->llc_stripe_count = v1->lmm_stripe_count;
441 if (v1->lmm_stripe_offset ==
442 (typeof(v1->lmm_stripe_offset))-1)
443 comp->llc_stripe_offset = LLAPI_LAYOUT_DEFAULT;
445 comp->llc_stripe_offset = v1->lmm_stripe_offset;
447 if (v1->lmm_magic != LOV_USER_MAGIC_V1) {
448 const struct lov_user_md_v3 *lumv3;
449 lumv3 = (struct lov_user_md_v3 *)v1;
450 snprintf(comp->llc_pool_name,
451 sizeof(comp->llc_pool_name),
452 "%s", lumv3->lmm_pool_name);
453 memcpy(comp->llc_objects, lumv3->lmm_objects,
454 obj_count * sizeof(lumv3->lmm_objects[0]));
456 const struct lov_user_md_v1 *lumv1;
457 lumv1 = (struct lov_user_md_v1 *)v1;
458 memcpy(comp->llc_objects, lumv1->lmm_objects,
459 obj_count * sizeof(lumv1->lmm_objects[0]));
463 comp->llc_stripe_offset =
464 comp->llc_objects[0].l_ost_idx;
466 list_add_tail(&comp->llc_list, &layout->llot_comp_list);
467 layout->llot_cur_comp = comp;
472 llapi_layout_free(layout);
477 * Convert the data from a llapi_layout to a newly allocated lov_user_md.
478 * The caller is responsible for freeing the returned pointer.
480 * \param[in] layout the layout to copy from
482 * \retval valid lov_user_md pointer on success
483 * \retval NULL if memory allocation fails or the layout is invalid
485 static struct lov_user_md *
486 llapi_layout_to_lum(const struct llapi_layout *layout)
488 struct llapi_layout_comp *comp;
489 struct lov_comp_md_v1 *comp_v1 = NULL;
490 struct lov_comp_md_entry_v1 *ent;
491 struct lov_user_md *lum = NULL;
496 if (layout == NULL ||
497 list_empty((struct list_head *)&layout->llot_comp_list)) {
502 /* Allocate header of lov_comp_md_v1 if necessary */
503 if (layout->llot_is_composite) {
506 list_for_each_entry(comp, &layout->llot_comp_list, llc_list)
509 lum_size = sizeof(*comp_v1) + comp_cnt * sizeof(*ent);
510 lum = malloc(lum_size);
515 comp_v1 = (struct lov_comp_md_v1 *)lum;
516 comp_v1->lcm_magic = LOV_USER_MAGIC_COMP_V1;
517 comp_v1->lcm_size = lum_size;
518 comp_v1->lcm_layout_gen = 0;
519 comp_v1->lcm_flags = 0;
520 comp_v1->lcm_entry_count = comp_cnt;
524 list_for_each_entry(comp, &layout->llot_comp_list, llc_list) {
525 struct lov_user_md *blob;
528 int i, obj_count = 0;
529 struct lov_user_ost_data *lmm_objects;
530 uint64_t pattern = comp->llc_pattern;
532 if ((pattern & LLAPI_LAYOUT_SPECIFIC) != 0) {
533 if (comp->llc_objects_count <
534 comp->llc_stripe_count) {
538 magic = LOV_USER_MAGIC_SPECIFIC;
539 obj_count = comp->llc_stripe_count;
540 pattern &= ~LLAPI_LAYOUT_SPECIFIC;
541 } else if (strlen(comp->llc_pool_name) != 0) {
542 magic = LOV_USER_MAGIC_V3;
544 magic = LOV_USER_MAGIC_V1;
546 /* All stripes must be specified when the pattern contains
547 * LLAPI_LAYOUT_SPECIFIC */
548 for (i = 0; i < obj_count; i++) {
549 if (comp->llc_objects[i].l_ost_idx ==
550 LLAPI_LAYOUT_IDX_MAX) {
556 blob_size = lov_user_md_size(obj_count, magic);
557 blob = realloc(lum, lum_size + blob_size);
563 comp_v1 = (struct lov_comp_md_v1 *)lum;
564 blob = (struct lov_user_md *)((char *)lum + lum_size);
565 lum_size += blob_size;
568 blob->lmm_magic = magic;
569 if (pattern == LLAPI_LAYOUT_DEFAULT)
570 blob->lmm_pattern = 0;
571 else if (pattern == LLAPI_LAYOUT_RAID0)
572 blob->lmm_pattern = LOV_PATTERN_RAID0;
574 blob->lmm_pattern = pattern;
576 if (comp->llc_stripe_size == LLAPI_LAYOUT_DEFAULT)
577 blob->lmm_stripe_size = 0;
579 blob->lmm_stripe_size = comp->llc_stripe_size;
581 if (comp->llc_stripe_count == LLAPI_LAYOUT_DEFAULT)
582 blob->lmm_stripe_count = 0;
583 else if (comp->llc_stripe_count == LLAPI_LAYOUT_WIDE)
584 blob->lmm_stripe_count = LOV_ALL_STRIPES;
586 blob->lmm_stripe_count = comp->llc_stripe_count;
588 if (comp->llc_stripe_offset == LLAPI_LAYOUT_DEFAULT)
589 blob->lmm_stripe_offset = -1;
591 blob->lmm_stripe_offset = comp->llc_stripe_offset;
593 if (magic == LOV_USER_MAGIC_V3 ||
594 magic == LOV_USER_MAGIC_SPECIFIC) {
595 struct lov_user_md_v3 *lumv3 =
596 (struct lov_user_md_v3 *)blob;
598 if (comp->llc_pool_name[0] != '\0') {
599 strncpy(lumv3->lmm_pool_name,
601 sizeof(lumv3->lmm_pool_name));
603 memset(lumv3->lmm_pool_name, 0,
604 sizeof(lumv3->lmm_pool_name));
606 lmm_objects = lumv3->lmm_objects;
608 lmm_objects = blob->lmm_objects;
611 for (i = 0; i < obj_count; i++)
612 lmm_objects[i].l_ost_idx =
613 comp->llc_objects[i].l_ost_idx;
615 if (layout->llot_is_composite) {
616 ent = &comp_v1->lcm_entries[ent_idx];
617 ent->lcme_id = comp->llc_id;
618 ent->lcme_flags = comp->llc_flags;
619 ent->lcme_extent.e_start = comp->llc_extent.e_start;
620 ent->lcme_extent.e_end = comp->llc_extent.e_end;
621 ent->lcme_size = blob_size;
622 ent->lcme_offset = offset;
624 comp_v1->lcm_size += blob_size;
638 * Get the parent directory of a path.
640 * \param[in] path path to get parent of
641 * \param[out] buf buffer in which to store parent path
642 * \param[in] size size in bytes of buffer \a buf
644 static void get_parent_dir(const char *path, char *buf, size_t size)
648 strncpy(buf, path, size);
649 p = strrchr(buf, '/');
653 } else if (size >= 2) {
654 strncpy(buf, ".", 2);
655 buf[size - 1] = '\0';
660 * Substitute unspecified attribute values in \a layout with values
661 * from fs global settings. (lov.stripesize, lov.stripecount,
664 * \param[in] layout layout to inherit values from
665 * \param[in] path file path of the filesystem
667 static void inherit_sys_attributes(struct llapi_layout *layout,
670 struct llapi_layout_comp *comp;
671 unsigned int ssize, scount, soffset;
674 rc = sattr_cache_get_defaults(NULL, path, &scount, &ssize, &soffset);
678 list_for_each_entry(comp, &layout->llot_comp_list, llc_list) {
679 if (comp->llc_pattern == LLAPI_LAYOUT_DEFAULT)
680 comp->llc_pattern = LLAPI_LAYOUT_RAID0;
681 if (comp->llc_stripe_size == LLAPI_LAYOUT_DEFAULT)
682 comp->llc_stripe_size = ssize;
683 if (comp->llc_stripe_count == LLAPI_LAYOUT_DEFAULT)
684 comp->llc_stripe_count = scount;
685 if (comp->llc_stripe_offset == LLAPI_LAYOUT_DEFAULT)
686 comp->llc_stripe_offset = soffset;
691 * Get the current component of \a layout.
693 * \param[in] layout layout to get current component
695 * \retval valid llapi_layout_comp pointer on success
696 * \retval NULL on error
698 static struct llapi_layout_comp *
699 __llapi_layout_cur_comp(const struct llapi_layout *layout)
701 struct llapi_layout_comp *comp;
703 if (layout == NULL || layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
707 if (layout->llot_cur_comp == NULL) {
711 /* Verify data consistency */
712 list_for_each_entry(comp, &layout->llot_comp_list, llc_list)
713 if (comp == layout->llot_cur_comp)
720 * Test if any attributes of \a layout are specified.
722 * \param[in] layout the layout to check
724 * \retval true any attributes are specified
725 * \retval false all attributes are unspecified
727 static bool is_any_specified(const struct llapi_layout *layout)
729 struct llapi_layout_comp *comp;
731 comp = __llapi_layout_cur_comp(layout);
735 if (layout->llot_is_composite)
738 return comp->llc_pattern != LLAPI_LAYOUT_DEFAULT ||
739 comp->llc_stripe_size != LLAPI_LAYOUT_DEFAULT ||
740 comp->llc_stripe_count != LLAPI_LAYOUT_DEFAULT ||
741 comp->llc_stripe_offset != LLAPI_LAYOUT_DEFAULT ||
742 strlen(comp->llc_pool_name);
746 * Check if the given \a lum_size is large enough to hold the required
749 * \param[in] lum the struct lov_user_md to check
750 * \param[in] lum_size the number of bytes in \a lum
752 * \retval true the \a lum_size is too small
753 * \retval false the \a lum_size is large enough
755 static bool llapi_layout_lum_truncated(struct lov_user_md *lum, size_t lum_size)
759 if (lum_size < sizeof(lum->lmm_magic))
762 if (lum->lmm_magic == LOV_MAGIC_V1 ||
763 lum->lmm_magic == __swab32(LOV_MAGIC_V1))
764 magic = LOV_MAGIC_V1;
765 else if (lum->lmm_magic == LOV_MAGIC_V3 ||
766 lum->lmm_magic == __swab32(LOV_MAGIC_V3))
767 magic = LOV_MAGIC_V3;
768 else if (lum->lmm_magic == LOV_MAGIC_COMP_V1 ||
769 lum->lmm_magic == __swab32(LOV_MAGIC_COMP_V1))
770 magic = LOV_MAGIC_COMP_V1;
774 if (magic == LOV_MAGIC_V1 || magic == LOV_MAGIC_V3)
775 return lum_size < lov_user_md_size(0, magic);
777 return lum_size < sizeof(struct lov_comp_md_v1);
780 /* Verify if the objects count in lum is consistent with the
781 * stripe count in lum. It applies to regular file only. */
782 static bool llapi_layout_lum_valid(struct lov_user_md *lum, int lum_size)
784 struct lov_comp_md_v1 *comp_v1 = NULL;
785 int i, ent_count, obj_count;
787 if (lum->lmm_magic == LOV_MAGIC_COMP_V1) {
788 comp_v1 = (struct lov_comp_md_v1 *)lum;
789 ent_count = comp_v1->lcm_entry_count;
790 } else if (lum->lmm_magic == LOV_MAGIC_V1 ||
791 lum->lmm_magic == LOV_MAGIC_V3) {
797 for (i = 0; i < ent_count; i++) {
799 lum = (struct lov_user_md *)((char *)comp_v1 +
800 comp_v1->lcm_entries[i].lcme_offset);
801 lum_size = comp_v1->lcm_entries[i].lcme_size;
803 obj_count = llapi_layout_objects_in_lum(lum, lum_size);
806 if (!(comp_v1->lcm_entries[i].lcme_flags &
807 LCME_FL_INIT) && obj_count != 0)
809 } else if (obj_count != lum->lmm_stripe_count) {
817 * Get the striping layout for the file referenced by file descriptor \a fd.
819 * If the filesystem does not support the "lustre." xattr namespace, the
820 * file must be on a non-Lustre filesystem, so set errno to ENOTTY per
821 * convention. If the file has no "lustre.lov" data, the file will
822 * inherit default values, so return a default layout.
824 * If the kernel gives us back less than the expected amount of data,
825 * we fail with errno set to EINTR.
827 * \param[in] fd open file descriptor
828 * \param[in] flags open file descriptor
830 * \retval valid llapi_layout pointer on success
831 * \retval NULL if an error occurs
833 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags)
836 struct lov_user_md *lum;
837 struct llapi_layout *layout = NULL;
841 lum_len = XATTR_SIZE_MAX;
842 lum = malloc(lum_len);
846 bytes_read = fgetxattr(fd, XATTR_LUSTRE_LOV, lum, lum_len);
847 if (bytes_read < 0) {
848 if (errno == EOPNOTSUPP)
850 else if (errno == ENODATA)
851 layout = llapi_layout_alloc();
855 /* Return an error if we got back a partial layout. */
856 if (llapi_layout_lum_truncated(lum, bytes_read)) {
861 llapi_layout_swab_lov_user_md(lum, bytes_read);
863 /* Directories may have a positive non-zero lum->lmm_stripe_count
864 * yet have an empty lum->lmm_objects array. For non-directories the
865 * amount of data returned from the kernel must be consistent
866 * with the stripe count. */
867 if (fstat(fd, &st) < 0)
870 if (!S_ISDIR(st.st_mode) && !llapi_layout_lum_valid(lum, bytes_read)) {
875 layout = llapi_layout_from_lum(lum, bytes_read);
882 * Get the expected striping layout for a file at \a path.
884 * Substitute expected inherited attribute values for unspecified
885 * attributes. Unspecified attributes may belong to directories and
886 * never-written-to files, and indicate that default values will be
887 * assigned when files are created or first written to. A default value
888 * is inherited from the parent directory if the attribute is specified
889 * there, otherwise it is inherited from the filesystem root.
890 * Unspecified attributes normally have the value LLAPI_LAYOUT_DEFAULT.
892 * The complete \a path need not refer to an existing file or directory,
893 * but some leading portion of it must reside within a lustre filesystem.
894 * A use case for this interface would be to obtain the literal striping
895 * values that would be assigned to a new file in a given directory.
897 * \param[in] path path for which to get the expected layout
899 * \retval valid llapi_layout pointer on success
900 * \retval NULL if an error occurs
902 static struct llapi_layout *llapi_layout_expected(const char *path)
904 struct llapi_layout *path_layout = NULL;
905 char donor_path[PATH_MAX];
910 fd = open(path, O_RDONLY);
911 if (fd < 0 && errno != ENOENT)
917 path_layout = llapi_layout_get_by_fd(fd, 0);
923 if (path_layout == NULL) {
924 if (errno != ENODATA && errno != ENOENT)
927 path_layout = llapi_layout_alloc();
928 if (path_layout == NULL)
932 if (is_any_specified(path_layout)) {
933 inherit_sys_attributes(path_layout, path);
937 llapi_layout_free(path_layout);
939 rc = stat(path, &st);
940 if (rc < 0 && errno != ENOENT)
943 /* If path is a not a directory or doesn't exist, inherit layout
944 * from parent directory. */
945 if ((rc == 0 && !S_ISDIR(st.st_mode)) ||
946 (rc < 0 && errno == ENOENT)) {
947 get_parent_dir(path, donor_path, sizeof(donor_path));
948 path_layout = llapi_layout_get_by_path(donor_path, 0);
949 if (path_layout != NULL) {
950 if (is_any_specified(path_layout)) {
951 inherit_sys_attributes(path_layout, donor_path);
954 llapi_layout_free(path_layout);
958 /* Inherit layout from the filesystem root. */
959 rc = llapi_search_mounts(path, 0, donor_path, NULL);
962 path_layout = llapi_layout_get_by_path(donor_path, 0);
963 if (path_layout == NULL)
966 inherit_sys_attributes(path_layout, donor_path);
971 * Get the striping layout for the file at \a path.
973 * If \a flags contains LAYOUT_GET_EXPECTED, substitute
974 * expected inherited attribute values for unspecified attributes. See
975 * llapi_layout_expected().
977 * \param[in] path path for which to get the layout
978 * \param[in] flags flags to control how layout is retrieved
980 * \retval valid llapi_layout pointer on success
981 * \retval NULL if an error occurs
983 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags)
985 struct llapi_layout *layout = NULL;
989 if (flags & LAYOUT_GET_EXPECTED)
990 return llapi_layout_expected(path);
992 fd = open(path, O_RDONLY);
996 layout = llapi_layout_get_by_fd(fd, flags);
1005 * Get the layout for the file with FID \a fidstr in filesystem \a lustre_dir.
1007 * \param[in] lustre_dir path within Lustre filesystem containing \a fid
1008 * \param[in] fid Lustre identifier of file to get layout for
1010 * \retval valid llapi_layout pointer on success
1011 * \retval NULL if an error occurs
1013 struct llapi_layout *llapi_layout_get_by_fid(const char *lustre_dir,
1014 const lustre_fid *fid,
1019 int saved_msg_level = llapi_msg_get_level();
1020 struct llapi_layout *layout = NULL;
1022 /* Prevent llapi internal routines from writing to console
1023 * while executing this function, then restore previous message
1025 llapi_msg_set_level(LLAPI_MSG_OFF);
1026 fd = llapi_open_by_fid(lustre_dir, fid, O_RDONLY);
1027 llapi_msg_set_level(saved_msg_level);
1032 layout = llapi_layout_get_by_fd(fd, flags);
1041 * Get the stripe count of \a layout.
1043 * \param[in] layout layout to get stripe count from
1044 * \param[out] count integer to store stripe count in
1046 * \retval 0 on success
1047 * \retval -1 if arguments are invalid
1049 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
1052 struct llapi_layout_comp *comp;
1054 comp = __llapi_layout_cur_comp(layout);
1058 if (count == NULL) {
1063 *count = comp->llc_stripe_count;
1069 * The llapi_layout API functions have these extra validity checks since
1070 * they use intuitively named macros to denote special behavior, whereas
1071 * the old API uses 0 and -1.
1074 static bool llapi_layout_stripe_count_is_valid(int64_t stripe_count)
1076 return stripe_count == LLAPI_LAYOUT_DEFAULT ||
1077 stripe_count == LLAPI_LAYOUT_WIDE ||
1078 (stripe_count != 0 && stripe_count != -1 &&
1079 llapi_stripe_count_is_valid(stripe_count));
1082 static bool llapi_layout_stripe_size_is_valid(uint64_t stripe_size)
1084 return stripe_size == LLAPI_LAYOUT_DEFAULT ||
1085 (stripe_size != 0 &&
1086 llapi_stripe_size_is_aligned(stripe_size) &&
1087 !llapi_stripe_size_is_too_big(stripe_size));
1090 static bool llapi_layout_stripe_index_is_valid(int64_t stripe_index)
1092 return stripe_index == LLAPI_LAYOUT_DEFAULT ||
1093 (stripe_index >= 0 &&
1094 llapi_stripe_index_is_valid(stripe_index));
1098 * Set the stripe count of \a layout.
1100 * \param[in] layout layout to set stripe count in
1101 * \param[in] count value to be set
1103 * \retval 0 on success
1104 * \retval -1 if arguments are invalid
1106 int llapi_layout_stripe_count_set(struct llapi_layout *layout,
1109 struct llapi_layout_comp *comp;
1111 comp = __llapi_layout_cur_comp(layout);
1115 if (!llapi_layout_stripe_count_is_valid(count)) {
1120 comp->llc_stripe_count = count;
1126 * Get the stripe size of \a layout.
1128 * \param[in] layout layout to get stripe size from
1129 * \param[out] size integer to store stripe size in
1131 * \retval 0 on success
1132 * \retval -1 if arguments are invalid
1134 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
1137 struct llapi_layout_comp *comp;
1139 comp = __llapi_layout_cur_comp(layout);
1148 *size = comp->llc_stripe_size;
1154 * Set the stripe size of \a layout.
1156 * \param[in] layout layout to set stripe size in
1157 * \param[in] size value to be set
1159 * \retval 0 on success
1160 * \retval -1 if arguments are invalid
1162 int llapi_layout_stripe_size_set(struct llapi_layout *layout,
1165 struct llapi_layout_comp *comp;
1167 comp = __llapi_layout_cur_comp(layout);
1171 if (!llapi_layout_stripe_size_is_valid(size)) {
1176 comp->llc_stripe_size = size;
1182 * Get the RAID pattern of \a layout.
1184 * \param[in] layout layout to get pattern from
1185 * \param[out] pattern integer to store pattern in
1187 * \retval 0 on success
1188 * \retval -1 if arguments are invalid
1190 int llapi_layout_pattern_get(const struct llapi_layout *layout,
1193 struct llapi_layout_comp *comp;
1195 comp = __llapi_layout_cur_comp(layout);
1199 if (pattern == NULL) {
1204 *pattern = comp->llc_pattern;
1210 * Set the RAID pattern of \a layout.
1212 * \param[in] layout layout to set pattern in
1213 * \param[in] pattern value to be set
1215 * \retval 0 on success
1216 * \retval -1 if arguments are invalid or RAID pattern
1219 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern)
1221 struct llapi_layout_comp *comp;
1223 comp = __llapi_layout_cur_comp(layout);
1227 if (pattern != LLAPI_LAYOUT_DEFAULT &&
1228 pattern != LLAPI_LAYOUT_RAID0) {
1233 comp->llc_pattern = pattern |
1234 (comp->llc_pattern & LLAPI_LAYOUT_SPECIFIC);
1239 static inline int stripe_number_roundup(int stripe_number)
1241 unsigned int round_up = (stripe_number + 8) & ~7;
1242 return round_up > LOV_MAX_STRIPE_COUNT ?
1243 LOV_MAX_STRIPE_COUNT : round_up;
1247 * Set the OST index of stripe number \a stripe_number to \a ost_index.
1249 * If only the starting stripe's OST index is specified, then this can use
1250 * the normal LOV_MAGIC_{V1,V3} layout type. If multiple OST indices are
1251 * given, then allocate an array to hold the list of indices and ensure that
1252 * the LOV_USER_MAGIC_SPECIFIC layout is used when creating the file.
1254 * \param[in] layout layout to set OST index in
1255 * \param[in] stripe_number stripe number to set index for
1256 * \param[in] ost_index the index to set
1258 * \retval 0 on success
1259 * \retval -1 if arguments are invalid or an unsupported stripe number
1260 * was specified, error returned in errno
1262 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
1265 struct llapi_layout_comp *comp;
1267 comp = __llapi_layout_cur_comp(layout);
1271 if (!llapi_layout_stripe_index_is_valid(ost_index)) {
1276 if (stripe_number == 0 && ost_index == LLAPI_LAYOUT_DEFAULT) {
1277 comp->llc_stripe_offset = ost_index;
1278 comp->llc_pattern &= ~LLAPI_LAYOUT_SPECIFIC;
1279 __llapi_comp_objects_realloc(comp, 0);
1280 } else if (stripe_number >= 0 &&
1281 stripe_number < LOV_MAX_STRIPE_COUNT) {
1282 if (ost_index >= LLAPI_LAYOUT_IDX_MAX) {
1287 /* Preallocate a few more stripes to avoid realloc() overhead.*/
1288 if (__llapi_comp_objects_realloc(comp,
1289 stripe_number_roundup(stripe_number)) < 0)
1292 comp->llc_objects[stripe_number].l_ost_idx = ost_index;
1294 if (stripe_number == 0)
1295 comp->llc_stripe_offset = ost_index;
1297 comp->llc_pattern |= LLAPI_LAYOUT_SPECIFIC;
1299 if (comp->llc_stripe_count == LLAPI_LAYOUT_DEFAULT ||
1300 comp->llc_stripe_count <= stripe_number)
1301 comp->llc_stripe_count = stripe_number + 1;
1311 * Get the OST index associated with stripe \a stripe_number.
1313 * Stripes are indexed starting from zero.
1315 * \param[in] layout layout to get index from
1316 * \param[in] stripe_number stripe number to get index for
1317 * \param[out] index integer to store index in
1319 * \retval 0 on success
1320 * \retval -1 if arguments are invalid
1322 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
1323 uint64_t stripe_number, uint64_t *index)
1325 struct llapi_layout_comp *comp;
1327 comp = __llapi_layout_cur_comp(layout);
1331 if (index == NULL) {
1336 if (stripe_number >= comp->llc_stripe_count ||
1337 stripe_number >= comp->llc_objects_count) {
1342 if (comp->llc_stripe_offset == LLAPI_LAYOUT_DEFAULT)
1343 *index = LLAPI_LAYOUT_DEFAULT;
1345 *index = comp->llc_objects[stripe_number].l_ost_idx;
1352 * Get the pool name of layout \a layout.
1354 * \param[in] layout layout to get pool name from
1355 * \param[out] dest buffer to store pool name in
1356 * \param[in] n size in bytes of buffer \a dest
1358 * \retval 0 on success
1359 * \retval -1 if arguments are invalid
1361 int llapi_layout_pool_name_get(const struct llapi_layout *layout, char *dest,
1364 struct llapi_layout_comp *comp;
1366 comp = __llapi_layout_cur_comp(layout);
1375 strncpy(dest, comp->llc_pool_name, n);
1381 * Set the name of the pool of layout \a layout.
1383 * \param[in] layout layout to set pool name in
1384 * \param[in] pool_name pool name to set
1386 * \retval 0 on success
1387 * \retval -1 if arguments are invalid or pool name is too long
1389 int llapi_layout_pool_name_set(struct llapi_layout *layout,
1390 const char *pool_name)
1392 struct llapi_layout_comp *comp;
1395 comp = __llapi_layout_cur_comp(layout);
1399 if (pool_name == NULL) {
1404 /* Strip off any 'fsname.' portion. */
1405 ptr = strchr(pool_name, '.');
1407 pool_name = ptr + 1;
1409 if (strlen(pool_name) > LOV_MAXPOOLNAME) {
1414 strncpy(comp->llc_pool_name, pool_name, sizeof(comp->llc_pool_name));
1420 * Open and possibly create a file with a given \a layout.
1422 * If \a layout is NULL this function acts as a simple wrapper for
1423 * open(). By convention, ENOTTY is returned in errno if \a path
1424 * refers to a non-Lustre file.
1426 * \param[in] path name of the file to open
1427 * \param[in] open_flags open() flags
1428 * \param[in] mode permissions to create new file with
1429 * \param[in] layout layout to create new file with
1431 * \retval non-negative file descriptor on successful open
1432 * \retval -1 if an error occurred
1434 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
1435 const struct llapi_layout *layout)
1440 struct lov_user_md *lum;
1444 (layout != NULL && layout->llot_magic != LLAPI_LAYOUT_MAGIC)) {
1449 /* Object creation must be postponed until after layout attributes
1450 * have been applied. */
1451 if (layout != NULL && (open_flags & O_CREAT))
1452 open_flags |= O_LOV_DELAY_CREATE;
1454 fd = open(path, open_flags, mode);
1456 if (layout == NULL || fd < 0)
1459 lum = llapi_layout_to_lum(layout);
1468 if (lum->lmm_magic == LOV_USER_MAGIC_COMP_V1)
1469 lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
1470 else if (lum->lmm_magic == LOV_USER_MAGIC_SPECIFIC)
1471 lum_size = lov_user_md_size(lum->lmm_stripe_count,
1474 lum_size = lov_user_md_size(0, lum->lmm_magic);
1476 rc = fsetxattr(fd, XATTR_LUSTRE_LOV, lum, lum_size, 0);
1485 errno = errno == EOPNOTSUPP ? ENOTTY : errno;
1491 * Create a file with a given \a layout.
1493 * Force O_CREAT and O_EXCL flags on so caller is assured that file was
1494 * created with the given \a layout on successful function return.
1496 * \param[in] path name of the file to open
1497 * \param[in] open_flags open() flags
1498 * \param[in] mode permissions to create new file with
1499 * \param[in] layout layout to create new file with
1501 * \retval non-negative file descriptor on successful open
1502 * \retval -1 if an error occurred
1504 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1505 const struct llapi_layout *layout)
1507 return llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode,
1512 * Fetch the start and end offset of the current layout component.
1514 * \param[in] layout the layout component
1515 * \param[out] start extent start, inclusive
1516 * \param[out] end extent end, exclusive
1518 * \retval 0 on success
1519 * \retval <0 if error occurs
1521 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1522 uint64_t *start, uint64_t *end)
1524 struct llapi_layout_comp *comp;
1526 comp = __llapi_layout_cur_comp(layout);
1530 if (start == NULL || end == NULL) {
1535 *start = comp->llc_extent.e_start;
1536 *end = comp->llc_extent.e_end;
1542 * Set the layout extent of a layout.
1544 * \param[in] layout the layout to be set
1545 * \param[in] start extent start, inclusive
1546 * \param[in] end extent end, exclusive
1548 * \retval 0 on success
1549 * \retval <0 if error occurs
1551 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1552 uint64_t start, uint64_t end)
1554 struct llapi_layout_comp *prev, *next, *comp;
1556 comp = __llapi_layout_cur_comp(layout);
1566 * We need to make sure the extent to be set is valid: the new
1567 * extent must be adjacent with the prev & next component.
1569 if (comp->llc_list.prev != &layout->llot_comp_list) {
1570 prev = list_entry(comp->llc_list.prev, typeof(*prev),
1572 if (start != prev->llc_extent.e_end) {
1578 if (comp->llc_list.next != &layout->llot_comp_list) {
1579 next = list_entry(comp->llc_list.next, typeof(*next),
1581 if (end != next->llc_extent.e_start) {
1587 comp->llc_extent.e_start = start;
1588 comp->llc_extent.e_end = end;
1589 layout->llot_is_composite = true;
1595 * Gets the attribute flags of the current component.
1597 * \param[in] layout the layout component
1598 * \param[out] flags stored the returned component flags
1600 * \retval 0 on success
1601 * \retval <0 if error occurs
1603 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1606 struct llapi_layout_comp *comp;
1608 comp = __llapi_layout_cur_comp(layout);
1612 if (flags == NULL) {
1617 *flags = comp->llc_flags;
1623 * Sets the specified flags of the current component leaving other flags as-is.
1625 * \param[in] layout the layout component
1626 * \param[in] flags component flags to be set
1628 * \retval 0 on success
1629 * \retval <0 if error occurs
1631 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags)
1633 struct llapi_layout_comp *comp;
1635 comp = __llapi_layout_cur_comp(layout);
1639 comp->llc_flags |= flags;
1645 * Clears the flags specified in the flags leaving other flags as-is.
1647 * \param[in] layout the layout component
1648 * \param[in] flags component flags to be cleared
1650 * \retval 0 on success
1651 * \retval <0 if error occurs
1653 int llapi_layout_comp_flags_clear(struct llapi_layout *layout,
1656 struct llapi_layout_comp *comp;
1658 comp = __llapi_layout_cur_comp(layout);
1662 comp->llc_flags &= ~flags;
1668 * Fetches the file-unique component ID of the current layout component.
1670 * \param[in] layout the layout component
1671 * \param[out] id stored the returned component ID
1673 * \retval 0 on success
1674 * \retval <0 if error occurs
1676 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id)
1678 struct llapi_layout_comp *comp;
1680 comp = __llapi_layout_cur_comp(layout);
1694 * Adds a component to \a layout, the new component will be added to
1695 * the tail of components list and it'll inherit attributes of existing
1696 * ones. The \a layout will change it's current component pointer to
1697 * the newly added component, and it'll be turned into a composite
1698 * layout if it was not before the adding.
1700 * \param[in] layout existing composite or plain layout
1702 * \retval 0 on success
1703 * \retval <0 if error occurs
1705 int llapi_layout_comp_add(struct llapi_layout *layout)
1707 struct llapi_layout_comp *last, *comp, *new;
1709 comp = __llapi_layout_cur_comp(layout);
1713 new = __llapi_comp_alloc(0);
1717 last = list_entry(layout->llot_comp_list.prev, typeof(*last),
1720 /* Inherit some attributes from existing component */
1721 new->llc_stripe_size = comp->llc_stripe_size;
1722 new->llc_stripe_count = comp->llc_stripe_count;
1723 if (comp->llc_pool_name[0] != '\0')
1724 strncpy(new->llc_pool_name, comp->llc_pool_name,
1725 sizeof(comp->llc_pool_name));
1726 if (new->llc_extent.e_end <= last->llc_extent.e_end) {
1727 __llapi_comp_free(new);
1731 new->llc_extent.e_start = last->llc_extent.e_end;
1733 list_add_tail(&new->llc_list, &layout->llot_comp_list);
1734 layout->llot_cur_comp = new;
1735 layout->llot_is_composite = true;
1741 * Deletes current component from the composite layout. The component
1742 * to be deleted must be the tail of components list, and it can't be
1743 * the only component in the layout.
1745 * \param[in] layout composite layout
1747 * \retval 0 on success
1748 * \retval <0 if error occurs
1750 int llapi_layout_comp_del(struct llapi_layout *layout)
1752 struct llapi_layout_comp *comp;
1754 comp = __llapi_layout_cur_comp(layout);
1758 if (!layout->llot_is_composite) {
1763 /* It must be the tail of the list (for PFL, can be relaxed
1764 * once we get mirrored components) */
1765 if (comp->llc_list.next != &layout->llot_comp_list) {
1769 /* It can't be the only one on the list */
1770 if (comp->llc_list.prev == &layout->llot_comp_list) {
1775 layout->llot_cur_comp =
1776 list_entry(comp->llc_list.prev, typeof(*comp), llc_list);
1777 list_del_init(&comp->llc_list);
1778 __llapi_comp_free(comp);
1784 * Move the current component pointer to the component with
1785 * specified component ID.
1787 * \param[in] layout composite layout
1788 * \param[in] id component ID
1790 * \retval =0 : moved successfully
1791 * \retval <0 if error occurs
1793 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t comp_id)
1795 struct llapi_layout_comp *comp;
1797 comp = __llapi_layout_cur_comp(layout);
1799 return -1; /* use previously set errno */
1801 if (!layout->llot_is_composite) {
1806 if (comp_id == LCME_ID_INVAL) {
1811 list_for_each_entry(comp, &layout->llot_comp_list, llc_list) {
1812 if (comp->llc_id == comp_id) {
1813 layout->llot_cur_comp = comp;
1822 * Move the current component pointer to a specified position.
1824 * \param[in] layout composite layout
1825 * \param[in] pos the position to be moved, it can be:
1826 * LLAPI_LAYOUT_COMP_USE_FIRST: use first component
1827 * LLAPI_LAYOUT_COMP_USE_LAST: use last component
1828 * LLAPI_LAYOUT_COMP_USE_NEXT: use component after current
1829 * LLAPI_LAYOUT_COMP_USE_PREV: use component before current
1831 * \retval =0 : moved successfully
1832 * \retval =1 : at last component with NEXT, at first component with PREV
1833 * \retval <0 if error occurs
1835 int llapi_layout_comp_use(struct llapi_layout *layout,
1836 enum llapi_layout_comp_use pos)
1838 struct llapi_layout_comp *comp, *head, *tail;
1840 comp = __llapi_layout_cur_comp(layout);
1844 if (!layout->llot_is_composite) {
1849 head = list_entry(layout->llot_comp_list.next, typeof(*head), llc_list);
1850 tail = list_entry(layout->llot_comp_list.prev, typeof(*tail), llc_list);
1852 case LLAPI_LAYOUT_COMP_USE_FIRST:
1853 layout->llot_cur_comp = head;
1855 case LLAPI_LAYOUT_COMP_USE_NEXT:
1860 layout->llot_cur_comp = list_entry(comp->llc_list.next,
1861 typeof(*comp), llc_list);
1863 case LLAPI_LAYOUT_COMP_USE_LAST:
1864 layout->llot_cur_comp = tail;
1866 case LLAPI_LAYOUT_COMP_USE_PREV:
1871 layout->llot_cur_comp = list_entry(comp->llc_list.prev,
1872 typeof(*comp), llc_list);
1883 * Add layout component(s) to an existing file.
1885 * \param[in] path The path name of the file
1886 * \param[in] layout The layout component(s) to be added
1888 int llapi_layout_file_comp_add(const char *path,
1889 const struct llapi_layout *layout)
1891 int rc, fd, lum_size, tmp_errno = 0;
1892 struct lov_user_md *lum;
1894 if (path == NULL || layout == NULL ||
1895 layout->llot_magic != LLAPI_LAYOUT_MAGIC) {
1900 lum = llapi_layout_to_lum(layout);
1904 if (lum->lmm_magic != LOV_USER_MAGIC_COMP_V1) {
1909 lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
1911 fd = open(path, O_RDWR);
1918 rc = fsetxattr(fd, XATTR_LUSTRE_LOV".add", lum, lum_size, 0);
1933 * Delete component(s) by the specified component id or component flags
1934 * from an existing file.
1936 * \param[in] path path name of the file
1937 * \param[in] id unique component ID
1938 * \param[in] flags flags: LCME_FL_* or;
1939 * negative flags: (LCME_FL_NEG|LCME_FL_*)
1941 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags)
1943 int rc, fd, lum_size;
1944 struct llapi_layout *layout;
1945 struct llapi_layout_comp *comp;
1946 struct lov_user_md *lum;
1948 if (path == NULL || id > LCME_ID_MAX || (flags & ~LCME_KNOWN_FLAGS)) {
1953 /* Can only specify ID or flags, not both. */
1954 if (id != 0 && flags != 0) {
1959 layout = llapi_layout_alloc();
1963 llapi_layout_comp_extent_set(layout, 0, LUSTRE_EOF);
1964 comp = __llapi_layout_cur_comp(layout);
1966 llapi_layout_free(layout);
1971 comp->llc_flags = flags;
1973 lum = llapi_layout_to_lum(layout);
1975 llapi_layout_free(layout);
1978 lum_size = ((struct lov_comp_md_v1 *)lum)->lcm_size;
1980 fd = open(path, O_RDWR);
1986 rc = fsetxattr(fd, XATTR_LUSTRE_LOV".del", lum, lum_size, 0);
1988 int tmp_errno = errno;
1997 llapi_layout_free(layout);
2002 * Change flags or other parameters of the component(s) by component ID of an
2003 * existing file. The component to be modified is specified by the
2004 * comp->lcme_id value, which must be an unique component ID. The new
2005 * attributes are passed in by @comp and @valid is used to specify which
2006 * attributes in the component are going to be changed.
2008 int llapi_layout_file_comp_set(const char *path,
2009 const struct llapi_layout *comp,
2017 * Check if the file layout is composite.
2019 * \param[in] layout the file layout to check
2021 * \retval true composite
2022 * \retval false not composite
2024 bool llapi_layout_is_composite(struct llapi_layout *layout)
2026 return layout->llot_is_composite;