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 #define lsp_tgts lsp_osts
122 int llapi_file_open_param(const char *name, int flags, mode_t mode,
123 const struct llapi_stripe_param *param);
124 int llapi_file_create(const char *name, unsigned long long stripe_size,
125 int stripe_offset, int stripe_count, int stripe_pattern);
126 int llapi_file_open(const char *name, int flags, int mode,
127 unsigned long long stripe_size, int stripe_offset,
128 int stripe_count, int stripe_pattern);
129 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
130 int stripe_offset, int stripe_count,
131 int stripe_pattern, char *pool_name);
132 int llapi_file_open_pool(const char *name, int flags, int mode,
133 unsigned long long stripe_size, int stripe_offset,
134 int stripe_count, int stripe_pattern, char *pool_name);
135 int llapi_poollist(const char *name);
136 int llapi_get_poollist(const char *name, char **poollist, int list_size,
137 char *buffer, int buffer_size);
138 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
139 char *buffer, int buffer_size);
140 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
141 int llapi_file_lookup(int dirfd, const char *name);
142 void llapi_set_command_name(const char *cmd);
143 void llapi_clear_command_name(void);
145 #define VERBOSE_COUNT 0x1
146 #define VERBOSE_SIZE 0x2
147 #define VERBOSE_OFFSET 0x4
148 #define VERBOSE_POOL 0x8
149 #define VERBOSE_DETAIL 0x10
150 #define VERBOSE_OBJID 0x20
151 #define VERBOSE_GENERATION 0x40
152 #define VERBOSE_MDTINDEX 0x80
153 #define VERBOSE_LAYOUT 0x100
154 #define VERBOSE_COMP_COUNT 0x200
155 #define VERBOSE_COMP_FLAGS 0x400
156 #define VERBOSE_COMP_START 0x800
157 #define VERBOSE_COMP_END 0x1000
158 #define VERBOSE_COMP_ID 0x2000
159 #define VERBOSE_DFID 0x4000
160 #define VERBOSE_HASH_TYPE 0x8000
161 #define VERBOSE_MIRROR_COUNT 0x10000
162 #define VERBOSE_DEFAULT (VERBOSE_COUNT | VERBOSE_SIZE | \
163 VERBOSE_OFFSET | VERBOSE_POOL | \
164 VERBOSE_OBJID | VERBOSE_GENERATION | \
165 VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
166 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
167 VERBOSE_COMP_START | VERBOSE_COMP_END | \
168 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT)
171 unsigned int fp_max_depth;
173 mode_t fp_type; /* S_IFIFO,... */
179 /* {a,m,c}sign cannot be bitfields due to using pointers to
180 * access them during argument parsing. */
184 /* these need to be signed values */
186 fp_stripe_size_sign:2,
187 fp_stripe_count_sign:2,
188 fp_comp_start_sign:2,
190 fp_comp_count_sign:2,
192 unsigned long long fp_size;
193 unsigned long long fp_size_units;
195 unsigned long long fp_zero_end:1,
197 fp_exclude_pattern:1,
205 fp_check_pool:1, /* LOV pool name */
206 fp_check_size:1, /* file size */
212 fp_get_lmv:1, /* get MDT list from LMV */
213 fp_raw:1, /* do not fill in defaults */
214 fp_check_stripe_size:1, /* LOV stripe size */
215 fp_exclude_stripe_size:1,
216 fp_check_stripe_count:1, /* LOV stripe count */
217 fp_exclude_stripe_count:1,
220 fp_get_default_lmv:1, /* Get default LMV */
224 fp_check_comp_count:1,
225 fp_exclude_comp_count:1,
226 fp_check_comp_flags:1,
227 fp_exclude_comp_flags:1,
228 fp_check_comp_start:1,
229 fp_exclude_comp_start:1,
231 fp_exclude_comp_end:1,
233 fp_exclude_comp_id:1,
234 fp_check_mdt_count:1,
235 fp_exclude_mdt_count:1,
236 fp_check_hash_type:1,
237 fp_exclude_hash_type:1,
238 fp_yaml:1; /* output layout in YAML */
243 /* regular expression */
246 struct obd_uuid *fp_obd_uuid;
248 int fp_num_alloc_obds;
252 struct obd_uuid *fp_mdt_uuid;
254 int fp_num_alloc_mdts;
257 int fp_file_mdt_index;
260 struct lov_user_mds_data *fp_lmd;
262 char fp_poolname[LOV_MAXPOOLNAME + 1];
264 __u32 fp_lmv_stripe_count;
265 struct lmv_user_md *fp_lmv_md;
267 unsigned long long fp_stripe_size;
268 unsigned long long fp_stripe_size_units;
269 unsigned long long fp_stripe_count;
275 unsigned long long fp_comp_start;
276 unsigned long long fp_comp_start_units;
277 unsigned long long fp_comp_end;
278 unsigned long long fp_comp_end_units;
279 unsigned long long fp_mdt_count;
282 /* In-process parameters. */
283 unsigned long fp_got_uuids:1,
285 unsigned int fp_depth;
286 unsigned int fp_hash_type;
289 int llapi_ostlist(char *path, struct find_param *param);
290 int llapi_uuid_match(char *real_uuid, char *search_uuid);
291 int llapi_getstripe(char *path, struct find_param *param);
292 int llapi_find(char *path, struct find_param *param);
294 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
295 int llapi_dir_set_default_lmv(const char *name,
296 const struct llapi_stripe_param *param);
297 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
298 int stripe_count, int stripe_pattern,
299 const char *pool_name);
300 int llapi_dir_create_param(const char *name, mode_t mode,
301 const struct llapi_stripe_param *param);
302 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
303 int stripe_count, int stripe_pattern,
304 const char *poolname);
305 int llapi_direntry_remove(char *dname);
307 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
308 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
309 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
310 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
311 int llapi_ping(char *obd_type, char *obd_name);
312 int llapi_target_check(int num_types, char **obd_types, char *dir);
313 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
314 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
315 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
316 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
317 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
318 int llapi_is_lustre_mnttype(const char *type);
319 int llapi_search_tgt(char *fsname, char *poolname, char *tgtname, bool is_mdt);
320 int llapi_search_ost(char *fsname, char *poolname, char *ostname);
321 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
322 int llapi_parse_size(const char *optarg, unsigned long long *size,
323 unsigned long long *size_units, int bytes_spec);
324 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
326 int llapi_search_fsname(const char *pathname, char *fsname);
327 int llapi_getname(const char *path, char *buf, size_t size);
328 int llapi_search_fileset(const char *pathname, char *fileset);
330 int llapi_search_rootpath(char *pathname, const char *fsname);
331 int llapi_nodemap_exists(const char *name);
332 int llapi_migrate_mdt(char *path, struct find_param *param);
333 int llapi_mv(char *path, struct find_param *param);
337 #define HAVE_LLAPI_IS_LUSTRE_MNT
338 int llapi_is_lustre_mnt(struct mntent *mnt);
339 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
340 int llapi_target_iterate(int type_num, char **obd_type, void *args,
342 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
343 int llapi_cp(int argc, char *argv[]);
344 int llapi_ls(int argc, char *argv[]);
345 int llapi_fid2path(const char *device, const char *fidstr, char *path,
346 int pathlen, long long *recno, int *linkno);
347 int llapi_path2fid(const char *path, struct lu_fid *fid);
348 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
350 int llapi_fd2fid(int fd, struct lu_fid *fid);
351 /* get FID of parent dir + the related name of entry in this parent dir */
352 int llapi_path2parent(const char *path, unsigned int linkno,
353 struct lu_fid *parent_fid, char *name, size_t name_size);
354 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
355 char *name, size_t name_size);
356 int llapi_chomp_string(char *buf);
357 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
359 int llapi_get_version_string(char *version, unsigned int version_size);
360 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
361 int llapi_get_version(char *buffer, int buffer_size, char **version)
362 __attribute__((deprecated));
363 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
364 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
365 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
366 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
367 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
369 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
371 int llapi_hsm_register_event_fifo(const char *path);
372 int llapi_hsm_unregister_event_fifo(const char *path);
373 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
374 const char *fmt, va_list args);
376 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
377 int llapi_create_volatile_idx(char *directory, int idx, int mode);
379 static inline int llapi_create_volatile(char *directory, int mode)
381 return llapi_create_volatile_idx(directory, -1, mode);
385 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
386 int gid, __u64 flags);
387 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
388 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
389 __u64 dv2, __u64 flags);
391 /* Changelog interface. priv is private state, managed internally by these
394 /* Records received are in extended format now, though most of them are still
395 * written in disk in changelog_rec format (to save space and time), it's
396 * converted to extended format in the lustre api to ease changelog analysis. */
397 #define HAVE_CHANGELOG_EXTEND_REC 1
399 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
400 const char *mdtname, long long startrec);
401 int llapi_changelog_fini(void **priv);
402 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
403 int llapi_changelog_free(struct changelog_rec **rech);
404 int llapi_changelog_get_fd(void *priv);
405 /* Allow records up to endrec to be destroyed; requires registered id. */
406 int llapi_changelog_clear(const char *mdtname, const char *idstr,
408 extern int llapi_changelog_set_xflags(void *priv,
409 enum changelog_send_extra_flag extra_flags);
411 /* HSM copytool interface.
412 * priv is private state, managed internally by these functions
414 struct hsm_copytool_private;
415 struct hsm_copyaction_private;
417 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
418 const char *mnt, int archive_count,
419 int *archives, int rfd_flags);
420 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
421 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
422 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
423 struct hsm_action_list **hal, int *msgsize);
424 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
425 const struct hsm_copytool_private *ct,
426 const struct hsm_action_item *hai,
427 int restore_mdt_index, int restore_open_flags,
429 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
430 const struct hsm_extent *he, int hp_flags, int errval);
431 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
432 const struct hsm_extent *he, __u64 total,
434 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
436 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
437 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
438 unsigned long long stripe_size, int stripe_offset,
439 int stripe_count, int stripe_pattern, char *pool_name,
440 struct lu_fid *newfid);
442 /* HSM user interface */
443 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
445 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
446 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
449 int llapi_json_init_list(struct llapi_json_item_list **item_list);
450 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
451 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
452 __u32 type, void *val);
453 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
456 int llapi_lease_get(int fd, int mode);
457 int llapi_lease_check(int fd);
458 int llapi_lease_put(int fd);
459 extern int llapi_lease_get_ext(int fd, struct ll_ioc_lease *data);
462 int llapi_group_lock(int fd, int gid);
463 int llapi_group_unlock(int fd, int gid);
466 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
467 struct llapi_lu_ladvise *ladvise);
470 /* llapi_layout user interface */
472 static inline const char *lcm_flags_string(__u16 flags)
474 switch (flags & LCM_FL_FLR_MASK) {
479 case LCM_FL_WRITE_PENDING:
481 case LCM_FL_SYNC_PENDING:
489 * An array element storing component info to be resynced during mirror
492 struct llapi_resync_comp {
495 uint32_t lrc_mirror_id;
496 uint32_t lrc_id; /* component id */
500 /** Opaque data type abstracting the layout of a Lustre file. */
503 int llapi_mirror_find_stale(struct llapi_layout *layout,
504 struct llapi_resync_comp *comp, size_t comp_size,
505 __u16 *mirror_ids, int ids_nr);
506 ssize_t llapi_mirror_resync_one(int fd, struct llapi_layout *layout,
507 uint32_t dst, uint64_t start, uint64_t end);
509 * Flags to control how layouts are retrieved.
512 /* Replace non-specified values with expected inherited values. */
513 #define LAYOUT_GET_EXPECTED 0x1
516 * Return a pointer to a newly-allocated opaque data structure containing
517 * the layout for the file at \a path. The pointer should be freed with
518 * llapi_layout_free() when it is no longer needed. Failure is indicated
519 * by a NULL return value and an appropriate error code stored in errno.
521 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
524 * Return a pointer to a newly-allocated opaque data type containing the
525 * layout for the file referenced by open file descriptor \a fd. The
526 * pointer should be freed with llapi_layout_free() when it is no longer
527 * needed. Failure is indicated by a NULL return value and an
528 * appropriate error code stored in errno.
530 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
533 * Return a pointer to a newly-allocated opaque data type containing the
534 * layout for the file associated with Lustre file identifier string
535 * \a fidstr. The string \a path must name a path within the
536 * filesystem that contains the file being looked up, such as the
537 * filesystem root. The returned pointer should be freed with
538 * llapi_layout_free() when it is no longer needed. Failure is
539 * indicated with a NULL return value and an appropriate error code
542 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
543 const struct lu_fid *fid,
547 * Allocate a new layout. Use this when creating a new file with
548 * llapi_layout_file_create().
550 struct llapi_layout *llapi_layout_alloc(void);
553 * Free memory allocated for \a layout.
555 void llapi_layout_free(struct llapi_layout *layout);
558 * llapi_layout_merge() - Merge a composite layout into another one.
559 * @dst_layout: Destination composite layout.
560 * @src_layout: Source composite layout.
562 * This function copies all of the components from @src_layout and
563 * appends them to @dst_layout.
565 * Return: 0 on success or -1 on failure.
567 int llapi_layout_merge(struct llapi_layout **dst_layout,
568 const struct llapi_layout *src_layout);
570 /** Not a valid stripe size, offset, or RAID pattern. */
571 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
574 * When specified or returned as the value for stripe count,
575 * stripe size, offset, or RAID pattern, the filesystem-wide
576 * default behavior will apply.
578 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
581 * When specified or returned as the value for stripe count, all
582 * available OSTs will be used.
584 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
587 * When specified as the value for layout pattern, file objects will be
588 * stored using RAID0. That is, data will be split evenly and without
589 * redundancy across all OSTs in the layout.
591 #define LLAPI_LAYOUT_RAID0 0ULL
592 #define LLAPI_LAYOUT_MDT 2ULL
595 * The layout includes a specific set of OSTs on which to allocate.
597 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
600 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
602 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
605 * Flags to modify how layouts are retrieved.
607 /******************** Stripe Count ********************/
610 * Store the stripe count of \a layout in \a count.
613 * \retval -1 Error with status code in errno.
615 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
619 * Set the stripe count of \a layout to \a count.
622 * \retval -1 Invalid argument, errno set to EINVAL.
624 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
626 /******************** Stripe Size ********************/
629 * Store the stripe size of \a layout in \a size.
632 * \retval -1 Invalid argument, errno set to EINVAL.
634 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
638 * Set the stripe size of \a layout to \a stripe_size.
641 * \retval -1 Invalid argument, errno set to EINVAL.
643 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
645 /******************** Stripe Pattern ********************/
648 * Store the stripe pattern of \a layout in \a pattern.
651 * \retval -1 Error with status code in errno.
653 int llapi_layout_pattern_get(const struct llapi_layout *layout,
657 * Set the stripe pattern of \a layout to \a pattern.
660 * \retval -1 Invalid argument, errno set to EINVAL.
662 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
664 /******************** OST Index ********************/
667 * Store the index of the OST where stripe number \a stripe_number is stored
670 * An error return value will result from a NULL layout, if \a
671 * stripe_number is out of range, or if \a layout was not initialized
672 * with llapi_layout_lookup_by{path,fd,fid}().
675 * \retval -1 Invalid argument, errno set to EINVAL.
677 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
678 uint64_t stripe_number, uint64_t *index);
681 * Set the OST index associated with stripe number \a stripe_number to
683 * NB: This is currently supported only for \a stripe_number = 0 and
684 * other usage will return ENOTSUPP in errno. A NULL \a layout or
685 * out-of-range \a stripe_number will return EINVAL in errno.
688 * \retval -1 Error with errno set to non-zero value.
690 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
693 /******************** Pool Name ********************/
696 * Store up to \a pool_name_len characters of the name of the pool of
697 * OSTs associated with \a layout into the buffer pointed to by
700 * The correct calling form is:
702 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
704 * A pool defines a set of OSTs from which file objects may be
705 * allocated for a file using \a layout.
707 * On success, the number of bytes stored is returned, excluding the
708 * terminating '\0' character (zero indicates that \a layout does not
709 * have an associated OST pool). On error, -1 is returned and errno is
710 * set appropriately. Possible sources of error include a NULL pointer
711 * argument or insufficient space in \a dest to store the pool name,
712 * in which cases errno will be set to EINVAL.
714 * \retval 0+ The number of bytes stored in \a dest.
715 * \retval -1 Invalid argument, errno set to EINVAL.
717 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
718 char *pool_name, size_t pool_name_len);
721 * Set the name of the pool of OSTs from which file objects will be
722 * allocated to \a pool_name.
724 * If the pool name uses "fsname.pool" notation to qualify the pool name
725 * with a filesystem name, the "fsname." portion will be silently
726 * discarded before storing the value. No validation that \a pool_name
727 * is an existing non-empty pool in filesystem \a fsname will be
728 * performed. Such validation can be performed by the application if
729 * desired using the llapi_search_ost() function. The maximum length of
730 * the stored value is defined by the constant LOV_MAXPOOLNAME.
733 * \retval -1 Invalid argument, errno set to EINVAL.
735 int llapi_layout_pool_name_set(struct llapi_layout *layout,
736 const char *pool_name);
738 /******************** File Creation ********************/
741 * Open an existing file at \a path, or create it with the specified
742 * \a layout and \a mode.
744 * One access mode and zero or more file creation flags and file status
745 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
746 * open file descriptor for the file. If \a layout is non-NULL and
747 * \a path is not on a Lustre filesystem this function will fail and set
750 * An already existing file may be opened with this function, but
751 * \a layout and \a mode will not be applied to it. Callers requiring a
752 * guarantee that the opened file is created with the specified
753 * \a layout and \a mode should use llapi_layout_file_create().
755 * A NULL \a layout may be specified, in which case the standard Lustre
756 * behavior for assigning layouts to newly-created files will apply.
758 * \retval 0+ An open file descriptor.
759 * \retval -1 Error with status code in errno.
761 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
762 const struct llapi_layout *layout);
765 * Create a new file at \a path with the specified \a layout and \a mode.
767 * One access mode and zero or more file creation flags and file status
768 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
769 * open file descriptor for the file. If \a layout is non-NULL and
770 * \a path is not on a Lustre filesystem this function will fail and set
775 * llapi_layout_file_create(path, open_flags, mode, layout)
777 * shall be equivalent to:
779 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
781 * It is an error if \a path specifies an existing file.
783 * A NULL \a layout may be specified, in which the standard Lustre
784 * behavior for assigning layouts to newly-created files will apply.
786 * \retval 0+ An open file descriptor.
787 * \retval -1 Error with status code in errno.
789 int llapi_layout_file_create(const char *path, int open_flags, int mode,
790 const struct llapi_layout *layout);
793 * Set flags to the header of component layout.
795 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
796 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
799 * llapi_layout_mirror_count_get() - Get mirror count from the header of
801 * @layout: Layout to get mirror count from.
802 * @count: Returned mirror count value.
804 * This function gets mirror count from the header of a layout.
806 * Return: 0 on success or -1 on failure.
808 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
812 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
813 * @layout: Layout to set mirror count in.
814 * @count: Mirror count value to be set.
816 * This function sets mirror count to the header of a layout.
818 * Return: 0 on success or -1 on failure.
820 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
824 * Fetch the start and end offset of the current layout component.
826 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
827 uint64_t *start, uint64_t *end);
829 * Set the extent of current layout component.
831 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
832 uint64_t start, uint64_t end);
834 /* PFL component flags table */
835 static const struct comp_flag_name {
836 enum lov_comp_md_entry_flags cfn_flag;
837 const char *cfn_name;
838 } comp_flags_table[] = {
839 { LCME_FL_INIT, "init" },
840 { LCME_FL_PRIMARY, "primary" },
841 { LCME_FL_STALE, "stale" },
842 { LCME_FL_OFFLINE, "offline" },
843 { LCME_FL_PREFERRED, "preferred" }
847 * Gets the attribute flags of the current component.
849 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
852 * Sets the specified flags of the current component leaving other flags as-is.
854 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
856 * Clears the flags specified in the flags leaving other flags as-is.
858 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
860 * Fetches the file-unique component ID of the current layout component.
862 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
864 * Fetches the mirror ID of the current layout component.
866 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
868 * Adds one component to the existing composite or plain layout.
870 int llapi_layout_comp_add(struct llapi_layout *layout);
872 * Deletes the current layout component from the composite layout.
874 int llapi_layout_comp_del(struct llapi_layout *layout);
876 enum llapi_layout_comp_use {
877 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
878 LLAPI_LAYOUT_COMP_USE_LAST = 2,
879 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
880 LLAPI_LAYOUT_COMP_USE_PREV = 4,
884 * Set the currently active component to the specified component ID.
886 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
888 * Select the currently active component at the specified position.
890 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
892 * Add layout components to an existing file.
894 int llapi_layout_file_comp_add(const char *path,
895 const struct llapi_layout *layout);
897 * Delete component(s) by the specified component id or flags.
899 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
901 * Change flags or other parameters of the component(s) by component ID of an
902 * existing file. The component to be modified is specified by the
903 * comp->lcme_id value, which must be an unique component ID. The new
904 * attributes are passed in by @comp and @valid is used to specify which
905 * attributes in the component are going to be changed.
907 int llapi_layout_file_comp_set(const char *path,
908 const struct llapi_layout *comp,
911 * Check if the file layout is composite.
913 bool llapi_layout_is_composite(struct llapi_layout *layout);
916 * FLR: mirror operation APIs
918 int llapi_mirror_set(int fd, unsigned int id);
919 int llapi_mirror_clear(int fd);
920 ssize_t llapi_mirror_read(int fd, unsigned int id,
921 void *buf, size_t count, off_t pos);
922 ssize_t llapi_mirror_copy_many(int fd, unsigned int src,
923 unsigned int *dst, size_t count);
924 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
925 off_t pos, size_t count);
929 #if defined(__cplusplus)