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, 2017, 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 /* Currently external applications can access this but in the
60 * future this will no longer be exposed for the user. Instead
61 * if you want to know if the library is initialized just call
62 * llapi_liblustreapi_initialized() which is now available. */
63 extern bool liblustreapi_initialized;
65 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
68 /* lustreapi message severity level */
69 enum llapi_message_level {
80 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
81 const char *fmt, va_list ap);
83 static inline bool llapi_liblustreapi_initialized(void)
85 return liblustreapi_initialized;
88 /* the bottom three bits reserved for llapi_message_level */
89 #define LLAPI_MSG_MASK 0x00000007
90 #define LLAPI_MSG_NO_ERRNO 0x00000010
92 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
94 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
98 if (level >= LLAPI_MSG_MAX)
101 return levels[level];
104 void llapi_msg_set_level(int level);
105 int llapi_msg_get_level(void);
106 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
107 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
109 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
110 __attribute__((__format__(__printf__, 3, 4)));
111 #define llapi_err_noerrno(level, fmt, a...) \
112 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
113 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
114 __attribute__((__format__(__printf__, 2, 3)));
116 struct llapi_stripe_param {
117 unsigned long long lsp_stripe_size;
119 int lsp_stripe_offset;
120 int lsp_stripe_pattern;
121 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
122 int lsp_stripe_count;
123 bool lsp_is_specific;
127 #define lsp_tgts lsp_osts
129 int llapi_file_open_param(const char *name, int flags, mode_t mode,
130 const struct llapi_stripe_param *param);
131 int llapi_file_create(const char *name, unsigned long long stripe_size,
132 int stripe_offset, int stripe_count, int stripe_pattern);
133 int llapi_file_open(const char *name, int flags, int mode,
134 unsigned long long stripe_size, int stripe_offset,
135 int stripe_count, int stripe_pattern);
136 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
137 int stripe_offset, int stripe_count,
138 int stripe_pattern, char *pool_name);
139 int llapi_file_open_pool(const char *name, int flags, int mode,
140 unsigned long long stripe_size, int stripe_offset,
141 int stripe_count, int stripe_pattern, char *pool_name);
142 int llapi_poollist(const char *name);
143 int llapi_get_poollist(const char *name, char **poollist, int list_size,
144 char *buffer, int buffer_size);
145 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
146 char *buffer, int buffer_size);
147 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
148 int llapi_file_lookup(int dirfd, const char *name);
149 void llapi_set_command_name(const char *cmd);
150 void llapi_clear_command_name(void);
152 #define VERBOSE_COUNT 0x1
153 #define VERBOSE_SIZE 0x2
154 #define VERBOSE_OFFSET 0x4
155 #define VERBOSE_POOL 0x8
156 #define VERBOSE_DETAIL 0x10
157 #define VERBOSE_OBJID 0x20
158 #define VERBOSE_GENERATION 0x40
159 #define VERBOSE_MDTINDEX 0x80
160 #define VERBOSE_LAYOUT 0x100
161 #define VERBOSE_COMP_COUNT 0x200
162 #define VERBOSE_COMP_FLAGS 0x400
163 #define VERBOSE_COMP_START 0x800
164 #define VERBOSE_COMP_END 0x1000
165 #define VERBOSE_COMP_ID 0x2000
166 #define VERBOSE_DFID 0x4000
167 #define VERBOSE_HASH_TYPE 0x8000
168 #define VERBOSE_MIRROR_COUNT 0x10000
169 #define VERBOSE_DEFAULT (VERBOSE_COUNT | VERBOSE_SIZE | \
170 VERBOSE_OFFSET | VERBOSE_POOL | \
171 VERBOSE_OBJID | VERBOSE_GENERATION | \
172 VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
173 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
174 VERBOSE_COMP_START | VERBOSE_COMP_END | \
175 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT)
178 unsigned int fp_max_depth;
180 mode_t fp_type; /* S_IFIFO,... */
186 /* {a,m,c}sign cannot be bitfields due to using pointers to
187 * access them during argument parsing. */
191 /* these need to be signed values */
193 fp_stripe_size_sign:2,
194 fp_stripe_count_sign:2,
195 fp_comp_start_sign:2,
197 fp_comp_count_sign:2,
199 unsigned long long fp_size;
200 unsigned long long fp_size_units;
202 unsigned long long fp_zero_end:1,
204 fp_exclude_pattern:1,
212 fp_check_pool:1, /* LOV pool name */
213 fp_check_size:1, /* file size */
219 fp_get_lmv:1, /* get MDT list from LMV */
220 fp_raw:1, /* do not fill in defaults */
221 fp_check_stripe_size:1, /* LOV stripe size */
222 fp_exclude_stripe_size:1,
223 fp_check_stripe_count:1, /* LOV stripe count */
224 fp_exclude_stripe_count:1,
227 fp_get_default_lmv:1, /* Get default LMV */
231 fp_check_comp_count:1,
232 fp_exclude_comp_count:1,
233 fp_check_comp_flags:1,
234 fp_check_comp_start:1,
235 fp_exclude_comp_start:1,
237 fp_exclude_comp_end:1,
239 fp_exclude_comp_id:1,
240 fp_check_mdt_count:1,
241 fp_exclude_mdt_count:1,
242 fp_check_hash_type:1,
243 fp_exclude_hash_type:1,
244 fp_yaml:1; /* output layout in YAML */
249 /* regular expression */
252 struct obd_uuid *fp_obd_uuid;
254 int fp_num_alloc_obds;
258 struct obd_uuid *fp_mdt_uuid;
260 int fp_num_alloc_mdts;
263 int fp_file_mdt_index;
266 struct lov_user_mds_data *fp_lmd;
268 char fp_poolname[LOV_MAXPOOLNAME + 1];
270 __u32 fp_lmv_stripe_count;
271 struct lmv_user_md *fp_lmv_md;
273 unsigned long long fp_stripe_size;
274 unsigned long long fp_stripe_size_units;
275 unsigned long long fp_stripe_count;
280 __u32 fp_comp_neg_flags;
282 unsigned long long fp_comp_start;
283 unsigned long long fp_comp_start_units;
284 unsigned long long fp_comp_end;
285 unsigned long long fp_comp_end_units;
286 unsigned long long fp_mdt_count;
289 /* In-process parameters. */
290 unsigned long fp_got_uuids:1,
292 unsigned int fp_depth;
293 unsigned int fp_hash_type;
296 int llapi_ostlist(char *path, struct find_param *param);
297 int llapi_uuid_match(char *real_uuid, char *search_uuid);
298 int llapi_getstripe(char *path, struct find_param *param);
299 int llapi_find(char *path, struct find_param *param);
301 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
302 int llapi_dir_set_default_lmv(const char *name,
303 const struct llapi_stripe_param *param);
304 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
305 int stripe_count, int stripe_pattern,
306 const char *pool_name);
307 int llapi_dir_create_param(const char *name, mode_t mode,
308 const struct llapi_stripe_param *param);
309 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
310 int stripe_count, int stripe_pattern,
311 const char *poolname);
312 int llapi_direntry_remove(char *dname);
314 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
315 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
316 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
317 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
318 int llapi_ping(char *obd_type, char *obd_name);
319 int llapi_target_check(int num_types, char **obd_types, char *dir);
320 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
321 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
322 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
323 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
324 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
325 int llapi_is_lustre_mnttype(const char *type);
326 int llapi_search_tgt(char *fsname, char *poolname, char *tgtname, bool is_mdt);
327 int llapi_search_ost(char *fsname, char *poolname, char *ostname);
328 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
329 int llapi_parse_size(const char *optarg, unsigned long long *size,
330 unsigned long long *size_units, int bytes_spec);
331 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
333 int llapi_search_fsname(const char *pathname, char *fsname);
334 int llapi_getname(const char *path, char *buf, size_t size);
335 int llapi_search_fileset(const char *pathname, char *fileset);
337 int llapi_search_rootpath(char *pathname, const char *fsname);
338 int llapi_nodemap_exists(const char *name);
339 int llapi_migrate_mdt(char *path, struct find_param *param);
340 int llapi_mv(char *path, struct find_param *param);
344 #define HAVE_LLAPI_IS_LUSTRE_MNT
345 int llapi_is_lustre_mnt(struct mntent *mnt);
346 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
347 int llapi_target_iterate(int type_num, char **obd_type, void *args,
349 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
350 int llapi_cp(int argc, char *argv[]);
351 int llapi_ls(int argc, char *argv[]);
352 int llapi_fid2path(const char *device, const char *fidstr, char *path,
353 int pathlen, long long *recno, int *linkno);
354 int llapi_path2fid(const char *path, struct lu_fid *fid);
355 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
357 int llapi_fd2fid(int fd, struct lu_fid *fid);
358 /* get FID of parent dir + the related name of entry in this parent dir */
359 int llapi_path2parent(const char *path, unsigned int linkno,
360 struct lu_fid *parent_fid, char *name, size_t name_size);
361 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
362 char *name, size_t name_size);
363 int llapi_chomp_string(char *buf);
364 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
366 int llapi_get_version_string(char *version, unsigned int version_size);
367 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
368 int llapi_get_version(char *buffer, int buffer_size, char **version)
369 __attribute__((deprecated));
370 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
371 int llapi_file_flush(int fd);
372 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
373 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
374 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
375 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
377 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
379 int llapi_hsm_register_event_fifo(const char *path);
380 int llapi_hsm_unregister_event_fifo(const char *path);
381 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
382 const char *fmt, va_list args);
384 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
385 int llapi_create_volatile_idx(char *directory, int idx, int mode);
387 static inline int llapi_create_volatile(char *directory, int mode)
389 return llapi_create_volatile_idx(directory, -1, mode);
393 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
394 int gid, __u64 flags);
395 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
396 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
397 __u64 dv2, __u64 flags);
399 /* Changelog interface. priv is private state, managed internally by these
402 /* Records received are in extended format now, though most of them are still
403 * written in disk in changelog_rec format (to save space and time), it's
404 * converted to extended format in the lustre api to ease changelog analysis. */
405 #define HAVE_CHANGELOG_EXTEND_REC 1
407 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
408 const char *mdtname, long long startrec);
409 int llapi_changelog_fini(void **priv);
410 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
411 int llapi_changelog_free(struct changelog_rec **rech);
412 int llapi_changelog_get_fd(void *priv);
413 /* Allow records up to endrec to be destroyed; requires registered id. */
414 int llapi_changelog_clear(const char *mdtname, const char *idstr,
416 extern int llapi_changelog_set_xflags(void *priv,
417 enum changelog_send_extra_flag extra_flags);
419 /* HSM copytool interface.
420 * priv is private state, managed internally by these functions
422 struct hsm_copytool_private;
423 struct hsm_copyaction_private;
425 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
426 const char *mnt, int archive_count,
427 int *archives, int rfd_flags);
428 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
429 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
430 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
431 struct hsm_action_list **hal, int *msgsize);
432 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
433 const struct hsm_copytool_private *ct,
434 const struct hsm_action_item *hai,
435 int restore_mdt_index, int restore_open_flags,
437 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
438 const struct hsm_extent *he, int hp_flags, int errval);
439 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
440 const struct hsm_extent *he, __u64 total,
442 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
444 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
445 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
446 unsigned long long stripe_size, int stripe_offset,
447 int stripe_count, int stripe_pattern, char *pool_name,
448 struct lu_fid *newfid);
450 /* HSM user interface */
451 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
453 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
454 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
457 int llapi_json_init_list(struct llapi_json_item_list **item_list);
458 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
459 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
460 __u32 type, void *val);
461 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
464 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
465 int llapi_lease_release(int fd);
466 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
467 int llapi_lease_check(int fd);
468 int llapi_lease_get(int fd, int mode); /* obsoleted */
469 int llapi_lease_put(int fd); /* obsoleted */
472 int llapi_group_lock(int fd, int gid);
473 int llapi_group_unlock(int fd, int gid);
476 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
477 struct llapi_lu_ladvise *ladvise);
480 /* llapi_layout user interface */
482 static inline const char *lcm_flags_string(__u16 flags)
484 switch (flags & LCM_FL_FLR_MASK) {
489 case LCM_FL_WRITE_PENDING:
491 case LCM_FL_SYNC_PENDING:
499 * An array element storing component info to be resynced during mirror
502 struct llapi_resync_comp {
505 uint32_t lrc_mirror_id;
506 uint32_t lrc_id; /* component id */
510 /** Opaque data type abstracting the layout of a Lustre file. */
513 int llapi_mirror_find_stale(struct llapi_layout *layout,
514 struct llapi_resync_comp *comp, size_t comp_size,
515 __u16 *mirror_ids, int ids_nr);
516 ssize_t llapi_mirror_resync_one(int fd, struct llapi_layout *layout,
517 uint32_t dst, uint64_t start, uint64_t end);
519 * Flags to control how layouts are retrieved.
522 /* Replace non-specified values with expected inherited values. */
523 #define LAYOUT_GET_EXPECTED 0x1
526 * Return a pointer to a newly-allocated opaque data structure containing
527 * the layout for the file at \a path. The pointer should be freed with
528 * llapi_layout_free() when it is no longer needed. Failure is indicated
529 * by a NULL return value and an appropriate error code stored in errno.
531 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
534 * Return a pointer to a newly-allocated opaque data type containing the
535 * layout for the file referenced by open file descriptor \a fd. The
536 * pointer should be freed with llapi_layout_free() when it is no longer
537 * needed. Failure is indicated by a NULL return value and an
538 * appropriate error code stored in errno.
540 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
543 * Return a pointer to a newly-allocated opaque data type containing the
544 * layout for the file associated with Lustre file identifier string
545 * \a fidstr. The string \a path must name a path within the
546 * filesystem that contains the file being looked up, such as the
547 * filesystem root. The returned pointer should be freed with
548 * llapi_layout_free() when it is no longer needed. Failure is
549 * indicated with a NULL return value and an appropriate error code
552 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
553 const struct lu_fid *fid,
557 * Allocate a new layout. Use this when creating a new file with
558 * llapi_layout_file_create().
560 struct llapi_layout *llapi_layout_alloc(void);
563 * Free memory allocated for \a layout.
565 void llapi_layout_free(struct llapi_layout *layout);
568 * llapi_layout_merge() - Merge a composite layout into another one.
569 * @dst_layout: Destination composite layout.
570 * @src_layout: Source composite layout.
572 * This function copies all of the components from @src_layout and
573 * appends them to @dst_layout.
575 * Return: 0 on success or -1 on failure.
577 int llapi_layout_merge(struct llapi_layout **dst_layout,
578 const struct llapi_layout *src_layout);
580 /** Not a valid stripe size, offset, or RAID pattern. */
581 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
584 * When specified or returned as the value for stripe count,
585 * stripe size, offset, or RAID pattern, the filesystem-wide
586 * default behavior will apply.
588 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
591 * When specified or returned as the value for stripe count, all
592 * available OSTs will be used.
594 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
597 * When specified as the value for layout pattern, file objects will be
598 * stored using RAID0. That is, data will be split evenly and without
599 * redundancy across all OSTs in the layout.
601 #define LLAPI_LAYOUT_RAID0 0ULL
602 #define LLAPI_LAYOUT_MDT 2ULL
605 * The layout includes a specific set of OSTs on which to allocate.
607 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
610 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
612 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
615 * Flags to modify how layouts are retrieved.
617 /******************** Stripe Count ********************/
620 * Store the stripe count of \a layout in \a count.
623 * \retval -1 Error with status code in errno.
625 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
629 * Set the stripe count of \a layout to \a count.
632 * \retval -1 Invalid argument, errno set to EINVAL.
634 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
636 /******************** Stripe Size ********************/
639 * Store the stripe size of \a layout in \a size.
642 * \retval -1 Invalid argument, errno set to EINVAL.
644 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
648 * Set the stripe size of \a layout to \a stripe_size.
651 * \retval -1 Invalid argument, errno set to EINVAL.
653 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
655 /******************** Stripe Pattern ********************/
658 * Store the stripe pattern of \a layout in \a pattern.
661 * \retval -1 Error with status code in errno.
663 int llapi_layout_pattern_get(const struct llapi_layout *layout,
667 * Set the stripe pattern of \a layout to \a pattern.
670 * \retval -1 Invalid argument, errno set to EINVAL.
672 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
674 /******************** OST Index ********************/
677 * Store the index of the OST where stripe number \a stripe_number is stored
680 * An error return value will result from a NULL layout, if \a
681 * stripe_number is out of range, or if \a layout was not initialized
682 * with llapi_layout_lookup_by{path,fd,fid}().
685 * \retval -1 Invalid argument, errno set to EINVAL.
687 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
688 uint64_t stripe_number, uint64_t *index);
691 * Set the OST index associated with stripe number \a stripe_number to
693 * NB: This is currently supported only for \a stripe_number = 0 and
694 * other usage will return ENOTSUPP in errno. A NULL \a layout or
695 * out-of-range \a stripe_number will return EINVAL in errno.
698 * \retval -1 Error with errno set to non-zero value.
700 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
703 /******************** Pool Name ********************/
706 * Store up to \a pool_name_len characters of the name of the pool of
707 * OSTs associated with \a layout into the buffer pointed to by
710 * The correct calling form is:
712 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
714 * A pool defines a set of OSTs from which file objects may be
715 * allocated for a file using \a layout.
717 * On success, the number of bytes stored is returned, excluding the
718 * terminating '\0' character (zero indicates that \a layout does not
719 * have an associated OST pool). On error, -1 is returned and errno is
720 * set appropriately. Possible sources of error include a NULL pointer
721 * argument or insufficient space in \a dest to store the pool name,
722 * in which cases errno will be set to EINVAL.
724 * \retval 0+ The number of bytes stored in \a dest.
725 * \retval -1 Invalid argument, errno set to EINVAL.
727 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
728 char *pool_name, size_t pool_name_len);
731 * Set the name of the pool of OSTs from which file objects will be
732 * allocated to \a pool_name.
734 * If the pool name uses "fsname.pool" notation to qualify the pool name
735 * with a filesystem name, the "fsname." portion will be silently
736 * discarded before storing the value. No validation that \a pool_name
737 * is an existing non-empty pool in filesystem \a fsname will be
738 * performed. Such validation can be performed by the application if
739 * desired using the llapi_search_ost() function. The maximum length of
740 * the stored value is defined by the constant LOV_MAXPOOLNAME.
743 * \retval -1 Invalid argument, errno set to EINVAL.
745 int llapi_layout_pool_name_set(struct llapi_layout *layout,
746 const char *pool_name);
748 /******************** File Creation ********************/
751 * Open an existing file at \a path, or create it with the specified
752 * \a layout and \a mode.
754 * One access mode and zero or more file creation flags and file status
755 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
756 * open file descriptor for the file. If \a layout is non-NULL and
757 * \a path is not on a Lustre filesystem this function will fail and set
760 * An already existing file may be opened with this function, but
761 * \a layout and \a mode will not be applied to it. Callers requiring a
762 * guarantee that the opened file is created with the specified
763 * \a layout and \a mode should use llapi_layout_file_create().
765 * A NULL \a layout may be specified, in which case the standard Lustre
766 * behavior for assigning layouts to newly-created files will apply.
768 * \retval 0+ An open file descriptor.
769 * \retval -1 Error with status code in errno.
771 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
772 const struct llapi_layout *layout);
775 * Create a new file at \a path with the specified \a layout and \a mode.
777 * One access mode and zero or more file creation flags and file status
778 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
779 * open file descriptor for the file. If \a layout is non-NULL and
780 * \a path is not on a Lustre filesystem this function will fail and set
785 * llapi_layout_file_create(path, open_flags, mode, layout)
787 * shall be equivalent to:
789 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
791 * It is an error if \a path specifies an existing file.
793 * A NULL \a layout may be specified, in which the standard Lustre
794 * behavior for assigning layouts to newly-created files will apply.
796 * \retval 0+ An open file descriptor.
797 * \retval -1 Error with status code in errno.
799 int llapi_layout_file_create(const char *path, int open_flags, int mode,
800 const struct llapi_layout *layout);
803 * Set flags to the header of component layout.
805 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
806 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
809 * llapi_layout_mirror_count_get() - Get mirror count from the header of
811 * @layout: Layout to get mirror count from.
812 * @count: Returned mirror count value.
814 * This function gets mirror count from the header of a layout.
816 * Return: 0 on success or -1 on failure.
818 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
822 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
823 * @layout: Layout to set mirror count in.
824 * @count: Mirror count value to be set.
826 * This function sets mirror count to the header of a layout.
828 * Return: 0 on success or -1 on failure.
830 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
834 * Fetch the start and end offset of the current layout component.
836 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
837 uint64_t *start, uint64_t *end);
839 * Set the extent of current layout component.
841 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
842 uint64_t start, uint64_t end);
844 /* PFL component flags table */
845 static const struct comp_flag_name {
846 enum lov_comp_md_entry_flags cfn_flag;
847 const char *cfn_name;
848 } comp_flags_table[] = {
849 { LCME_FL_INIT, "init" },
850 { LCME_FL_STALE, "stale" },
851 { LCME_FL_PREF_RW, "prefer" },
852 { LCME_FL_OFFLINE, "offline" },
856 * Gets the attribute flags of the current component.
858 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
861 * Sets the specified flags of the current component leaving other flags as-is.
863 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
865 * Clears the flags specified in the flags leaving other flags as-is.
867 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
869 * Fetches the file-unique component ID of the current layout component.
871 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
873 * Fetches the mirror ID of the current layout component.
875 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
877 * Adds one component to the existing composite or plain layout.
879 int llapi_layout_comp_add(struct llapi_layout *layout);
881 * Deletes the current layout component from the composite layout.
883 int llapi_layout_comp_del(struct llapi_layout *layout);
885 enum llapi_layout_comp_use {
886 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
887 LLAPI_LAYOUT_COMP_USE_LAST = 2,
888 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
889 LLAPI_LAYOUT_COMP_USE_PREV = 4,
893 * Set the currently active component to the specified component ID.
895 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
897 * Select the currently active component at the specified position.
899 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
901 * Add layout components to an existing file.
903 int llapi_layout_file_comp_add(const char *path,
904 const struct llapi_layout *layout);
906 * Delete component(s) by the specified component id or flags.
908 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
910 * Change flags or other parameters of the component(s) by component ID of an
911 * existing file. The component to be modified is specified by the
912 * comp->lcme_id value, which must be an unique component ID. The new
913 * attributes are passed in by @comp and @valid is used to specify which
914 * attributes in the component are going to be changed.
916 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
919 * Check if the file layout is composite.
921 bool llapi_layout_is_composite(struct llapi_layout *layout);
924 LLAPI_LAYOUT_ITER_CONT = 0,
925 LLAPI_LAYOUT_ITER_STOP = 1,
929 * Iteration callback function.
931 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
932 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
933 * \retval < 0 error code
935 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
938 * Iterate all components in the corresponding layout
940 int llapi_layout_comp_iterate(struct llapi_layout *layout,
941 llapi_layout_iter_cb cb, void *cbdata);
944 * FLR: mirror operation APIs
946 int llapi_mirror_set(int fd, unsigned int id);
947 int llapi_mirror_clear(int fd);
948 ssize_t llapi_mirror_read(int fd, unsigned int id,
949 void *buf, size_t count, off_t pos);
950 ssize_t llapi_mirror_copy_many(int fd, unsigned int src,
951 unsigned int *dst, size_t count);
952 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
953 off_t pos, size_t count);
957 #if defined(__cplusplus)