4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
36 /** \defgroup llapi llapi
43 #include <linux/lustre/lustre_user.h>
45 #if defined(__cplusplus)
50 #define LL_MAXQUOTAS 3
54 #define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0])))
57 #define lustre_fid struct lu_fid
59 extern bool liblustreapi_initialized;
62 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
65 /* lustreapi message severity level */
66 enum llapi_message_level {
77 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
78 const char *fmt, va_list ap);
81 /* the bottom three bits reserved for llapi_message_level */
82 #define LLAPI_MSG_MASK 0x00000007
83 #define LLAPI_MSG_NO_ERRNO 0x00000010
85 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
87 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
91 if (level >= LLAPI_MSG_MAX)
97 void llapi_msg_set_level(int level);
98 int llapi_msg_get_level(void);
99 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
100 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
102 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
103 __attribute__((__format__(__printf__, 3, 4)));
104 #define llapi_err_noerrno(level, fmt, a...) \
105 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
106 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
107 __attribute__((__format__(__printf__, 2, 3)));
109 struct llapi_stripe_param {
110 unsigned long long lsp_stripe_size;
112 int lsp_stripe_offset;
113 int lsp_stripe_pattern;
114 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
115 int lsp_stripe_count;
116 bool lsp_is_specific;
120 int llapi_file_open_param(const char *name, int flags, mode_t mode,
121 const struct llapi_stripe_param *param);
122 int llapi_file_create(const char *name, unsigned long long stripe_size,
123 int stripe_offset, int stripe_count, int stripe_pattern);
124 int llapi_file_open(const char *name, int flags, int mode,
125 unsigned long long stripe_size, int stripe_offset,
126 int stripe_count, int stripe_pattern);
127 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
128 int stripe_offset, int stripe_count,
129 int stripe_pattern, char *pool_name);
130 int llapi_file_open_pool(const char *name, int flags, int mode,
131 unsigned long long stripe_size, int stripe_offset,
132 int stripe_count, int stripe_pattern, char *pool_name);
133 int llapi_poollist(const char *name);
134 int llapi_get_poollist(const char *name, char **poollist, int list_size,
135 char *buffer, int buffer_size);
136 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
137 char *buffer, int buffer_size);
138 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
139 int llapi_file_lookup(int dirfd, const char *name);
141 #define VERBOSE_COUNT 0x1
142 #define VERBOSE_SIZE 0x2
143 #define VERBOSE_OFFSET 0x4
144 #define VERBOSE_POOL 0x8
145 #define VERBOSE_DETAIL 0x10
146 #define VERBOSE_OBJID 0x20
147 #define VERBOSE_GENERATION 0x40
148 #define VERBOSE_MDTINDEX 0x80
149 #define VERBOSE_LAYOUT 0x100
150 #define VERBOSE_COMP_COUNT 0x200
151 #define VERBOSE_COMP_FLAGS 0x400
152 #define VERBOSE_COMP_START 0x800
153 #define VERBOSE_COMP_END 0x1000
154 #define VERBOSE_COMP_ID 0x2000
155 #define VERBOSE_DFID 0x4000
156 #define VERBOSE_HASH_TYPE 0x8000
157 #define VERBOSE_MIRROR_COUNT 0x10000
158 #define VERBOSE_DEFAULT (VERBOSE_COUNT | VERBOSE_SIZE | \
159 VERBOSE_OFFSET | VERBOSE_POOL | \
160 VERBOSE_OBJID | VERBOSE_GENERATION | \
161 VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
162 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
163 VERBOSE_COMP_START | VERBOSE_COMP_END | \
164 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT)
167 unsigned int fp_max_depth;
169 mode_t fp_type; /* S_IFIFO,... */
175 /* {a,m,c}sign cannot be bitfields due to using pointers to
176 * access them during argument parsing. */
180 /* these need to be signed values */
182 fp_stripe_size_sign:2,
183 fp_stripe_count_sign:2,
184 fp_comp_start_sign:2,
186 fp_comp_count_sign:2,
188 unsigned long long fp_size;
189 unsigned long long fp_size_units;
191 unsigned long long fp_zero_end:1,
193 fp_exclude_pattern:1,
201 fp_check_pool:1, /* LOV pool name */
202 fp_check_size:1, /* file size */
208 fp_get_lmv:1, /* get MDT list from LMV */
209 fp_raw:1, /* do not fill in defaults */
210 fp_check_stripe_size:1, /* LOV stripe size */
211 fp_exclude_stripe_size:1,
212 fp_check_stripe_count:1, /* LOV stripe count */
213 fp_exclude_stripe_count:1,
216 fp_get_default_lmv:1, /* Get default LMV */
220 fp_check_comp_count:1,
221 fp_exclude_comp_count:1,
222 fp_check_comp_flags:1,
223 fp_exclude_comp_flags:1,
224 fp_check_comp_start:1,
225 fp_exclude_comp_start:1,
227 fp_exclude_comp_end:1,
229 fp_exclude_comp_id:1,
230 fp_check_mdt_count:1,
231 fp_exclude_mdt_count:1,
232 fp_check_hash_type:1,
233 fp_exclude_hash_type:1,
234 fp_yaml:1; /* output layout in YAML */
239 /* regular expression */
242 struct obd_uuid *fp_obd_uuid;
244 int fp_num_alloc_obds;
248 struct obd_uuid *fp_mdt_uuid;
250 int fp_num_alloc_mdts;
253 int fp_file_mdt_index;
256 struct lov_user_mds_data *fp_lmd;
258 char fp_poolname[LOV_MAXPOOLNAME + 1];
260 __u32 fp_lmv_stripe_count;
261 struct lmv_user_md *fp_lmv_md;
263 unsigned long long fp_stripe_size;
264 unsigned long long fp_stripe_size_units;
265 unsigned long long fp_stripe_count;
271 unsigned long long fp_comp_start;
272 unsigned long long fp_comp_start_units;
273 unsigned long long fp_comp_end;
274 unsigned long long fp_comp_end_units;
275 unsigned long long fp_mdt_count;
278 /* In-process parameters. */
279 unsigned long fp_got_uuids:1,
281 unsigned int fp_depth;
282 unsigned int fp_hash_type;
285 int llapi_ostlist(char *path, struct find_param *param);
286 int llapi_uuid_match(char *real_uuid, char *search_uuid);
287 int llapi_getstripe(char *path, struct find_param *param);
288 int llapi_find(char *path, struct find_param *param);
290 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
291 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
292 int stripe_count, int stripe_pattern,
293 const char *pool_name);
294 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
295 int stripe_count, int stripe_pattern,
296 const char *poolname);
297 int llapi_direntry_remove(char *dname);
299 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
300 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
301 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
302 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
303 int llapi_ping(char *obd_type, char *obd_name);
304 int llapi_target_check(int num_types, char **obd_types, char *dir);
305 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
306 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
307 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
308 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
309 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
310 int llapi_is_lustre_mnttype(const char *type);
311 int llapi_search_ost(char *fsname, char *poolname, char *ostname);
312 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
313 int llapi_parse_size(const char *optarg, unsigned long long *size,
314 unsigned long long *size_units, int bytes_spec);
315 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
317 int llapi_search_fsname(const char *pathname, char *fsname);
318 int llapi_getname(const char *path, char *buf, size_t size);
319 int llapi_search_fileset(const char *pathname, char *fileset);
321 int llapi_search_rootpath(char *pathname, const char *fsname);
322 int llapi_nodemap_exists(const char *name);
323 int llapi_migrate_mdt(char *path, struct find_param *param);
324 int llapi_mv(char *path, struct find_param *param);
328 #define HAVE_LLAPI_IS_LUSTRE_MNT
329 int llapi_is_lustre_mnt(struct mntent *mnt);
330 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
331 int llapi_target_iterate(int type_num, char **obd_type, void *args,
333 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
334 int llapi_cp(int argc, char *argv[]);
335 int llapi_ls(int argc, char *argv[]);
336 int llapi_fid2path(const char *device, const char *fidstr, char *path,
337 int pathlen, long long *recno, int *linkno);
338 int llapi_path2fid(const char *path, struct lu_fid *fid);
339 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
341 int llapi_fd2fid(int fd, struct lu_fid *fid);
342 /* get FID of parent dir + the related name of entry in this parent dir */
343 int llapi_path2parent(const char *path, unsigned int linkno,
344 struct lu_fid *parent_fid, char *name, size_t name_size);
345 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
346 char *name, size_t name_size);
347 int llapi_chomp_string(char *buf);
348 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
350 int llapi_get_version_string(char *version, unsigned int version_size);
351 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
352 int llapi_get_version(char *buffer, int buffer_size, char **version)
353 __attribute__((deprecated));
354 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
355 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
356 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
357 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
358 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
360 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
362 int llapi_hsm_register_event_fifo(const char *path);
363 int llapi_hsm_unregister_event_fifo(const char *path);
364 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
365 const char *fmt, va_list args);
367 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
368 int llapi_create_volatile_idx(char *directory, int idx, int mode);
370 static inline int llapi_create_volatile(char *directory, int mode)
372 return llapi_create_volatile_idx(directory, -1, mode);
376 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
377 int gid, __u64 flags);
378 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
379 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
380 __u64 dv2, __u64 flags);
382 /* Changelog interface. priv is private state, managed internally by these
385 /* Records received are in extended format now, though most of them are still
386 * written in disk in changelog_rec format (to save space and time), it's
387 * converted to extended format in the lustre api to ease changelog analysis. */
388 #define HAVE_CHANGELOG_EXTEND_REC 1
390 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
391 const char *mdtname, long long startrec);
392 int llapi_changelog_fini(void **priv);
393 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
394 int llapi_changelog_free(struct changelog_rec **rech);
395 int llapi_changelog_get_fd(void *priv);
396 /* Allow records up to endrec to be destroyed; requires registered id. */
397 int llapi_changelog_clear(const char *mdtname, const char *idstr,
400 /* HSM copytool interface.
401 * priv is private state, managed internally by these functions
403 struct hsm_copytool_private;
404 struct hsm_copyaction_private;
406 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
407 const char *mnt, int archive_count,
408 int *archives, int rfd_flags);
409 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
410 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
411 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
412 struct hsm_action_list **hal, int *msgsize);
413 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
414 const struct hsm_copytool_private *ct,
415 const struct hsm_action_item *hai,
416 int restore_mdt_index, int restore_open_flags,
418 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
419 const struct hsm_extent *he, int hp_flags, int errval);
420 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
421 const struct hsm_extent *he, __u64 total,
423 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
425 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
426 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
427 unsigned long long stripe_size, int stripe_offset,
428 int stripe_count, int stripe_pattern, char *pool_name,
429 struct lu_fid *newfid);
431 /* HSM user interface */
432 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
434 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
435 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
438 int llapi_json_init_list(struct llapi_json_item_list **item_list);
439 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
440 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
441 __u32 type, void *val);
442 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
445 int llapi_lease_get(int fd, int mode);
446 int llapi_lease_check(int fd);
447 int llapi_lease_put(int fd);
448 extern int llapi_lease_get_ext(int fd, struct ll_ioc_lease *data);
451 int llapi_group_lock(int fd, int gid);
452 int llapi_group_unlock(int fd, int gid);
455 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
456 struct llapi_lu_ladvise *ladvise);
459 /* llapi_layout user interface */
461 static inline const char *lcm_flags_string(__u16 flags)
463 switch (flags & LCM_FL_FLR_MASK) {
468 case LCM_FL_WRITE_PENDING:
470 case LCM_FL_SYNC_PENDING:
478 * An array element storing component info to be resynced during mirror
481 struct llapi_resync_comp {
484 uint32_t lrc_mirror_id;
485 uint32_t lrc_id; /* component id */
489 /** Opaque data type abstracting the layout of a Lustre file. */
492 int llapi_mirror_find_stale(struct llapi_layout *layout,
493 struct llapi_resync_comp *comp, size_t comp_size,
494 __u16 *mirror_ids, int ids_nr);
495 ssize_t llapi_mirror_resync_one(int fd, struct llapi_layout *layout,
496 uint32_t dst, uint64_t start, uint64_t end);
498 * Flags to control how layouts are retrieved.
501 /* Replace non-specified values with expected inherited values. */
502 #define LAYOUT_GET_EXPECTED 0x1
505 * Return a pointer to a newly-allocated opaque data structure containing
506 * the layout for the file at \a path. The pointer should be freed with
507 * llapi_layout_free() when it is no longer needed. Failure is indicated
508 * by a NULL return value and an appropriate error code stored in errno.
510 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
513 * Return a pointer to a newly-allocated opaque data type containing the
514 * layout for the file referenced by open file descriptor \a fd. The
515 * pointer should be freed with llapi_layout_free() when it is no longer
516 * needed. Failure is indicated by a NULL return value and an
517 * appropriate error code stored in errno.
519 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
522 * Return a pointer to a newly-allocated opaque data type containing the
523 * layout for the file associated with Lustre file identifier string
524 * \a fidstr. The string \a path must name a path within the
525 * filesystem that contains the file being looked up, such as the
526 * filesystem root. The returned pointer should be freed with
527 * llapi_layout_free() when it is no longer needed. Failure is
528 * indicated with a NULL return value and an appropriate error code
531 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
532 const struct lu_fid *fid,
536 * Allocate a new layout. Use this when creating a new file with
537 * llapi_layout_file_create().
539 struct llapi_layout *llapi_layout_alloc(void);
542 * Free memory allocated for \a layout.
544 void llapi_layout_free(struct llapi_layout *layout);
547 * llapi_layout_merge() - Merge a composite layout into another one.
548 * @dst_layout: Destination composite layout.
549 * @src_layout: Source composite layout.
551 * This function copies all of the components from @src_layout and
552 * appends them to @dst_layout.
554 * Return: 0 on success or -1 on failure.
556 int llapi_layout_merge(struct llapi_layout **dst_layout,
557 const struct llapi_layout *src_layout);
559 /** Not a valid stripe size, offset, or RAID pattern. */
560 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
563 * When specified or returned as the value for stripe count,
564 * stripe size, offset, or RAID pattern, the filesystem-wide
565 * default behavior will apply.
567 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
570 * When specified or returned as the value for stripe count, all
571 * available OSTs will be used.
573 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
576 * When specified as the value for layout pattern, file objects will be
577 * stored using RAID0. That is, data will be split evenly and without
578 * redundancy across all OSTs in the layout.
580 #define LLAPI_LAYOUT_RAID0 0ULL
581 #define LLAPI_LAYOUT_MDT 2ULL
584 * The layout includes a specific set of OSTs on which to allocate.
586 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
589 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
591 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
594 * Flags to modify how layouts are retrieved.
596 /******************** Stripe Count ********************/
599 * Store the stripe count of \a layout in \a count.
602 * \retval -1 Error with status code in errno.
604 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
608 * Set the stripe count of \a layout to \a count.
611 * \retval -1 Invalid argument, errno set to EINVAL.
613 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
615 /******************** Stripe Size ********************/
618 * Store the stripe size of \a layout in \a size.
621 * \retval -1 Invalid argument, errno set to EINVAL.
623 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
627 * Set the stripe size of \a layout to \a stripe_size.
630 * \retval -1 Invalid argument, errno set to EINVAL.
632 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
634 /******************** Stripe Pattern ********************/
637 * Store the stripe pattern of \a layout in \a pattern.
640 * \retval -1 Error with status code in errno.
642 int llapi_layout_pattern_get(const struct llapi_layout *layout,
646 * Set the stripe pattern of \a layout to \a pattern.
649 * \retval -1 Invalid argument, errno set to EINVAL.
651 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
653 /******************** OST Index ********************/
656 * Store the index of the OST where stripe number \a stripe_number is stored
659 * An error return value will result from a NULL layout, if \a
660 * stripe_number is out of range, or if \a layout was not initialized
661 * with llapi_layout_lookup_by{path,fd,fid}().
664 * \retval -1 Invalid argument, errno set to EINVAL.
666 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
667 uint64_t stripe_number, uint64_t *index);
670 * Set the OST index associated with stripe number \a stripe_number to
672 * NB: This is currently supported only for \a stripe_number = 0 and
673 * other usage will return ENOTSUPP in errno. A NULL \a layout or
674 * out-of-range \a stripe_number will return EINVAL in errno.
677 * \retval -1 Error with errno set to non-zero value.
679 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
682 /******************** Pool Name ********************/
685 * Store up to \a pool_name_len characters of the name of the pool of
686 * OSTs associated with \a layout into the buffer pointed to by
689 * The correct calling form is:
691 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
693 * A pool defines a set of OSTs from which file objects may be
694 * allocated for a file using \a layout.
696 * On success, the number of bytes stored is returned, excluding the
697 * terminating '\0' character (zero indicates that \a layout does not
698 * have an associated OST pool). On error, -1 is returned and errno is
699 * set appropriately. Possible sources of error include a NULL pointer
700 * argument or insufficient space in \a dest to store the pool name,
701 * in which cases errno will be set to EINVAL.
703 * \retval 0+ The number of bytes stored in \a dest.
704 * \retval -1 Invalid argument, errno set to EINVAL.
706 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
707 char *pool_name, size_t pool_name_len);
710 * Set the name of the pool of OSTs from which file objects will be
711 * allocated to \a pool_name.
713 * If the pool name uses "fsname.pool" notation to qualify the pool name
714 * with a filesystem name, the "fsname." portion will be silently
715 * discarded before storing the value. No validation that \a pool_name
716 * is an existing non-empty pool in filesystem \a fsname will be
717 * performed. Such validation can be performed by the application if
718 * desired using the llapi_search_ost() function. The maximum length of
719 * the stored value is defined by the constant LOV_MAXPOOLNAME.
722 * \retval -1 Invalid argument, errno set to EINVAL.
724 int llapi_layout_pool_name_set(struct llapi_layout *layout,
725 const char *pool_name);
727 /******************** File Creation ********************/
730 * Open an existing file at \a path, or create it with the specified
731 * \a layout and \a mode.
733 * One access mode and zero or more file creation flags and file status
734 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
735 * open file descriptor for the file. If \a layout is non-NULL and
736 * \a path is not on a Lustre filesystem this function will fail and set
739 * An already existing file may be opened with this function, but
740 * \a layout and \a mode will not be applied to it. Callers requiring a
741 * guarantee that the opened file is created with the specified
742 * \a layout and \a mode should use llapi_layout_file_create().
744 * A NULL \a layout may be specified, in which case the standard Lustre
745 * behavior for assigning layouts to newly-created files will apply.
747 * \retval 0+ An open file descriptor.
748 * \retval -1 Error with status code in errno.
750 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
751 const struct llapi_layout *layout);
754 * Create a new file at \a path with the specified \a layout and \a mode.
756 * One access mode and zero or more file creation flags and file status
757 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
758 * open file descriptor for the file. If \a layout is non-NULL and
759 * \a path is not on a Lustre filesystem this function will fail and set
764 * llapi_layout_file_create(path, open_flags, mode, layout)
766 * shall be equivalent to:
768 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
770 * It is an error if \a path specifies an existing file.
772 * A NULL \a layout may be specified, in which the standard Lustre
773 * behavior for assigning layouts to newly-created files will apply.
775 * \retval 0+ An open file descriptor.
776 * \retval -1 Error with status code in errno.
778 int llapi_layout_file_create(const char *path, int open_flags, int mode,
779 const struct llapi_layout *layout);
782 * Set flags to the header of component layout.
784 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
785 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
788 * llapi_layout_mirror_count_get() - Get mirror count from the header of
790 * @layout: Layout to get mirror count from.
791 * @count: Returned mirror count value.
793 * This function gets mirror count from the header of a layout.
795 * Return: 0 on success or -1 on failure.
797 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
801 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
802 * @layout: Layout to set mirror count in.
803 * @count: Mirror count value to be set.
805 * This function sets mirror count to the header of a layout.
807 * Return: 0 on success or -1 on failure.
809 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
813 * Fetch the start and end offset of the current layout component.
815 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
816 uint64_t *start, uint64_t *end);
818 * Set the extent of current layout component.
820 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
821 uint64_t start, uint64_t end);
823 /* PFL component flags table */
824 static const struct comp_flag_name {
825 enum lov_comp_md_entry_flags cfn_flag;
826 const char *cfn_name;
827 } comp_flags_table[] = {
828 { LCME_FL_INIT, "init" },
829 { LCME_FL_PRIMARY, "primary" },
830 { LCME_FL_STALE, "stale" },
831 { LCME_FL_OFFLINE, "offline" },
832 { LCME_FL_PREFERRED, "preferred" }
836 * Gets the attribute flags of the current component.
838 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
841 * Sets the specified flags of the current component leaving other flags as-is.
843 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
845 * Clears the flags specified in the flags leaving other flags as-is.
847 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
849 * Fetches the file-unique component ID of the current layout component.
851 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
853 * Fetches the mirror ID of the current layout component.
855 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
857 * Adds one component to the existing composite or plain layout.
859 int llapi_layout_comp_add(struct llapi_layout *layout);
861 * Deletes the current layout component from the composite layout.
863 int llapi_layout_comp_del(struct llapi_layout *layout);
865 enum llapi_layout_comp_use {
866 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
867 LLAPI_LAYOUT_COMP_USE_LAST = 2,
868 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
869 LLAPI_LAYOUT_COMP_USE_PREV = 4,
873 * Set the currently active component to the specified component ID.
875 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
877 * Select the currently active component at the specified position.
879 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
881 * Add layout components to an existing file.
883 int llapi_layout_file_comp_add(const char *path,
884 const struct llapi_layout *layout);
886 * Delete component(s) by the specified component id or flags.
888 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
890 * Change flags or other parameters of the component(s) by component ID of an
891 * existing file. The component to be modified is specified by the
892 * comp->lcme_id value, which must be an unique component ID. The new
893 * attributes are passed in by @comp and @valid is used to specify which
894 * attributes in the component are going to be changed.
896 int llapi_layout_file_comp_set(const char *path,
897 const struct llapi_layout *comp,
900 * Check if the file layout is composite.
902 bool llapi_layout_is_composite(struct llapi_layout *layout);
905 * FLR: mirror operation APIs
907 int llapi_mirror_set(int fd, unsigned int id);
908 int llapi_mirror_clear(int fd);
909 ssize_t llapi_mirror_read(int fd, unsigned int id,
910 void *buf, size_t count, off_t pos);
911 ssize_t llapi_mirror_copy_many(int fd, unsigned int src,
912 unsigned int *dst, size_t count);
913 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
914 off_t pos, size_t count);
918 #if defined(__cplusplus)