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_foreign(const char *name, mode_t mode, __u32 type,
132 __u32 flags, char *foreign_lov);
133 int llapi_file_create(const char *name, unsigned long long stripe_size,
134 int stripe_offset, int stripe_count, int stripe_pattern);
135 int llapi_file_open(const char *name, int flags, int mode,
136 unsigned long long stripe_size, int stripe_offset,
137 int stripe_count, int stripe_pattern);
138 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
139 int stripe_offset, int stripe_count,
140 int stripe_pattern, char *pool_name);
141 int llapi_file_open_pool(const char *name, int flags, int mode,
142 unsigned long long stripe_size, int stripe_offset,
143 int stripe_count, int stripe_pattern, char *pool_name);
144 int llapi_poollist(const char *name);
145 int llapi_get_poollist(const char *name, char **poollist, int list_size,
146 char *buffer, int buffer_size);
147 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
148 char *buffer, int buffer_size);
149 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
150 int llapi_file_lookup(int dirfd, const char *name);
151 void llapi_set_command_name(const char *cmd);
152 void llapi_clear_command_name(void);
154 enum llapi_layout_verbose {
155 VERBOSE_STRIPE_COUNT = 0x1,
156 VERBOSE_STRIPE_SIZE = 0x2,
157 VERBOSE_STRIPE_OFFSET = 0x4,
159 VERBOSE_DETAIL = 0x10,
160 VERBOSE_OBJID = 0x20,
161 VERBOSE_GENERATION = 0x40,
162 VERBOSE_MDTINDEX = 0x80,
163 VERBOSE_PATTERN = 0x100,
164 VERBOSE_COMP_COUNT = 0x200,
165 VERBOSE_COMP_FLAGS = 0x400,
166 VERBOSE_COMP_START = 0x800,
167 VERBOSE_COMP_END = 0x1000,
168 VERBOSE_COMP_ID = 0x2000,
169 VERBOSE_DFID = 0x4000,
170 VERBOSE_HASH_TYPE = 0x8000,
171 VERBOSE_MIRROR_COUNT = 0x10000,
172 VERBOSE_MIRROR_ID = 0x20000,
173 VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
174 VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
175 VERBOSE_OBJID | VERBOSE_GENERATION |
176 VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
177 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
178 VERBOSE_COMP_START | VERBOSE_COMP_END |
179 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
182 /* Compatibility with original names */
183 #define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
184 #define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
185 #define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
186 #define VERBOSE_LAYOUT VERBOSE_PATTERN
189 unsigned int fp_max_depth;
191 mode_t fp_type; /* S_IFIFO,... */
197 /* {a,m,c}sign cannot be bitfields due to using pointers to
198 * access them during argument parsing. */
202 /* these need to be signed values */
204 fp_stripe_size_sign:2,
205 fp_stripe_count_sign:2,
206 fp_comp_start_sign:2,
208 fp_comp_count_sign:2,
209 fp_mirror_count_sign:2,
210 fp_mirror_index_sign:2,
214 unsigned long long fp_size;
215 unsigned long long fp_size_units;
217 unsigned long long fp_zero_end:1,
219 fp_exclude_pattern:1,
227 fp_check_pool:1, /* LOV pool name */
228 fp_check_size:1, /* file size */
234 fp_get_lmv:1, /* get MDT list from LMV */
235 fp_raw:1, /* do not fill in defaults */
236 fp_check_stripe_size:1, /* LOV stripe size */
237 fp_exclude_stripe_size:1,
238 fp_check_stripe_count:1, /* LOV stripe count */
239 fp_exclude_stripe_count:1,
242 fp_get_default_lmv:1, /* Get default LMV */
246 fp_check_comp_count:1,
247 fp_exclude_comp_count:1,
248 fp_check_mirror_count:1,
249 fp_exclude_mirror_count:1,
250 fp_check_comp_flags:1,
251 fp_check_mirror_state:1,
252 fp_check_comp_start:1,
253 fp_exclude_comp_start:1,
255 fp_exclude_comp_end:1,
257 fp_exclude_comp_id:1,
258 fp_check_mirror_id:1,
259 fp_exclude_mirror_id:1,
260 fp_check_mirror_index:1,
261 fp_exclude_mirror_index:1,
262 fp_check_mdt_count:1,
263 fp_exclude_mdt_count:1,
264 fp_check_hash_type:1,
265 fp_exclude_hash_type:1,
266 fp_yaml:1, /* output layout in YAML */
270 fp_exclude_foreign:1;
272 enum llapi_layout_verbose fp_verbose;
275 /* regular expression */
278 struct obd_uuid *fp_obd_uuid;
280 int fp_num_alloc_obds;
284 struct obd_uuid *fp_mdt_uuid;
286 int fp_num_alloc_mdts;
289 int fp_file_mdt_index;
292 struct lov_user_mds_data *fp_lmd;
294 char fp_poolname[LOV_MAXPOOLNAME + 1];
296 __u32 fp_lmv_stripe_count;
297 struct lmv_user_md *fp_lmv_md;
299 unsigned long long fp_stripe_size;
300 unsigned long long fp_stripe_size_units;
301 unsigned long long fp_stripe_count;
305 __u32 fp_mirror_count;
307 __u32 fp_comp_neg_flags;
308 __u16 fp_mirror_state;
309 __u16 fp_mirror_neg_state;
312 __u16 fp_mirror_index;
313 unsigned long long fp_comp_start;
314 unsigned long long fp_comp_start_units;
315 unsigned long long fp_comp_end;
316 unsigned long long fp_comp_end_units;
317 unsigned long long fp_mdt_count;
319 unsigned long long fp_blocks;
320 unsigned long long fp_blocks_units;
322 /* In-process parameters. */
323 unsigned long fp_got_uuids:1,
325 unsigned int fp_depth;
326 unsigned int fp_hash_type;
327 unsigned int fp_time_margin; /* time margin in seconds */
328 __u32 fp_foreign_type;
331 int llapi_ostlist(char *path, struct find_param *param);
332 int llapi_uuid_match(char *real_uuid, char *search_uuid);
333 int llapi_getstripe(char *path, struct find_param *param);
334 int llapi_find(char *path, struct find_param *param);
336 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
337 int llapi_dir_set_default_lmv(const char *name,
338 const struct llapi_stripe_param *param);
339 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
340 int stripe_count, int stripe_pattern,
341 const char *pool_name);
342 int llapi_dir_create(const char *name, mode_t mode,
343 const struct llapi_stripe_param *param);
344 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
345 int stripe_count, int stripe_pattern,
346 const char *poolname);
347 int llapi_direntry_remove(char *dname);
349 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
350 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
351 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
352 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
353 int llapi_ping(char *obd_type, char *obd_name);
354 int llapi_target_check(int num_types, char **obd_types, char *dir);
355 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
356 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
357 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
358 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
359 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
360 int llapi_is_lustre_mnttype(const char *type);
361 int llapi_search_tgt(char *fsname, char *poolname, char *tgtname, bool is_mdt);
362 int llapi_search_ost(char *fsname, char *poolname, char *ostname);
363 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
364 int llapi_parse_size(const char *optarg, unsigned long long *size,
365 unsigned long long *size_units, int bytes_spec);
366 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
368 int llapi_search_fsname(const char *pathname, char *fsname);
369 int llapi_getname(const char *path, char *buf, size_t size);
370 int llapi_search_fileset(const char *pathname, char *fileset);
372 int llapi_search_rootpath(char *pathname, const char *fsname);
373 int llapi_nodemap_exists(const char *name);
374 int llapi_migrate_mdt(char *path, struct find_param *param);
375 int llapi_mv(char *path, struct find_param *param);
379 #define HAVE_LLAPI_IS_LUSTRE_MNT
380 int llapi_is_lustre_mnt(struct mntent *mnt);
381 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
382 int llapi_target_iterate(int type_num, char **obd_type, void *args,
384 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
385 int llapi_cp(int argc, char *argv[]);
386 int llapi_ls(int argc, char *argv[]);
387 int llapi_fid2path(const char *device, const char *fidstr, char *path,
388 int pathlen, long long *recno, int *linkno);
389 int llapi_path2fid(const char *path, struct lu_fid *fid);
390 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
392 int llapi_fd2fid(int fd, struct lu_fid *fid);
393 /* get FID of parent dir + the related name of entry in this parent dir */
394 int llapi_path2parent(const char *path, unsigned int linkno,
395 struct lu_fid *parent_fid, char *name, size_t name_size);
396 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
397 char *name, size_t name_size);
398 int llapi_chomp_string(char *buf);
399 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
401 int llapi_get_version_string(char *version, unsigned int version_size);
402 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
403 int llapi_get_version(char *buffer, int buffer_size, char **version)
404 __attribute__((deprecated));
405 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
406 int llapi_file_flush(int fd);
407 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
408 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
409 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
410 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
412 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
414 int llapi_hsm_register_event_fifo(const char *path);
415 int llapi_hsm_unregister_event_fifo(const char *path);
416 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
417 const char *fmt, va_list args);
419 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
420 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
422 int llapi_create_volatile_param(const char *directory, int mdt_idx,
423 int open_flags, mode_t mode,
424 const struct llapi_stripe_param *stripe_param);
426 static inline int llapi_create_volatile(char *directory, int open_flags)
428 return llapi_create_volatile_idx(directory, -1, open_flags);
432 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
433 int gid, __u64 flags);
434 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
435 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
436 __u64 dv2, __u64 flags);
438 /* Changelog interface. priv is private state, managed internally by these
441 /* Records received are in extended format now, though most of them are still
442 * written in disk in changelog_rec format (to save space and time), it's
443 * converted to extended format in the lustre api to ease changelog analysis. */
444 #define HAVE_CHANGELOG_EXTEND_REC 1
446 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
447 const char *mdtname, long long startrec);
448 int llapi_changelog_fini(void **priv);
449 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
450 int llapi_changelog_free(struct changelog_rec **rech);
451 int llapi_changelog_get_fd(void *priv);
452 /* Allow records up to endrec to be destroyed; requires registered id. */
453 int llapi_changelog_clear(const char *mdtname, const char *idstr,
455 extern int llapi_changelog_set_xflags(void *priv,
456 enum changelog_send_extra_flag extra_flags);
458 /* HSM copytool interface.
459 * priv is private state, managed internally by these functions
461 struct hsm_copytool_private;
462 struct hsm_copyaction_private;
464 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
465 const char *mnt, int archive_count,
466 int *archives, int rfd_flags);
467 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
468 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
469 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
470 struct hsm_action_list **hal, int *msgsize);
471 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
472 const struct hsm_copytool_private *ct,
473 const struct hsm_action_item *hai,
474 int restore_mdt_index, int restore_open_flags,
476 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
477 const struct hsm_extent *he, int hp_flags, int errval);
478 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
479 const struct hsm_extent *he, __u64 total,
481 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
483 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
484 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
485 unsigned long long stripe_size, int stripe_offset,
486 int stripe_count, int stripe_pattern, char *pool_name,
487 struct lu_fid *newfid);
489 /* HSM user interface */
490 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
492 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
493 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
496 int llapi_json_init_list(struct llapi_json_item_list **item_list);
497 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
498 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
499 __u32 type, void *val);
500 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
503 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
504 int llapi_lease_release(int fd);
505 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
506 int llapi_lease_check(int fd);
507 int llapi_lease_get(int fd, int mode); /* obsoleted */
508 int llapi_lease_put(int fd); /* obsoleted */
511 int llapi_group_lock(int fd, int gid);
512 int llapi_group_unlock(int fd, int gid);
515 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
516 struct llapi_lu_ladvise *ladvise);
519 /* llapi_layout user interface */
522 * An array element storing component info to be resynced during mirror
525 struct llapi_resync_comp {
528 uint32_t lrc_mirror_id;
529 uint32_t lrc_id; /* component id */
533 /** Opaque data type abstracting the layout of a Lustre file. */
536 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
537 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
538 size_t count, off_t pos);
539 uint32_t llapi_mirror_find(struct llapi_layout *layout,
540 uint64_t file_start, uint64_t file_end,
542 int llapi_mirror_find_stale(struct llapi_layout *layout,
543 struct llapi_resync_comp *comp, size_t comp_size,
544 __u16 *mirror_ids, int ids_nr);
545 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
546 struct llapi_resync_comp *comp_array,
547 int comp_size, uint64_t start, uint64_t end);
549 * Flags to control how layouts are retrieved.
552 /* Replace non-specified values with expected inherited values. */
553 #define LAYOUT_GET_EXPECTED 0x1
556 * Return a pointer to a newly-allocated opaque data structure containing
557 * the layout for the file at \a path. The pointer should be freed with
558 * llapi_layout_free() when it is no longer needed. Failure is indicated
559 * by a NULL return value and an appropriate error code stored in errno.
561 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
564 * Return a pointer to a newly-allocated opaque data type containing the
565 * layout for the file referenced by open file descriptor \a fd. The
566 * pointer should be freed with llapi_layout_free() when it is no longer
567 * needed. Failure is indicated by a NULL return value and an
568 * appropriate error code stored in errno.
570 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
573 * Return a pointer to a newly-allocated opaque data type containing the
574 * layout for the file associated with Lustre file identifier
575 * \a fid. The string \a path must name a path within the
576 * filesystem that contains the file being looked up, such as the
577 * filesystem root. The returned pointer should be freed with
578 * llapi_layout_free() when it is no longer needed. Failure is
579 * indicated with a NULL return value and an appropriate error code
582 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
583 const struct lu_fid *fid,
586 enum llapi_layout_xattr_flags {
587 LLAPI_LXF_CHECK = 0x0001,
588 LLAPI_LXF_COPY = 0x0002,
592 * Return a pointer to a newly-allocated opaque data type containing the
593 * layout for the file associated with extended attribute \a lov_xattr. The
594 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
595 * should be raw xattr without being swapped, since this function will swap it
596 * properly. Thus, \a lov_xattr will be modified during the process. If the
597 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
598 * the objects count in lum is consistent with the stripe count in lum. This
599 * check only apply to regular file, so \a LLAPI_LXF_CHECK flag should be
600 * cleared if the xattr belongs to a directory. If the \a LLAPI_LXF_COPY flag
601 * of \a flags is set, this function will use a temporary buffer for byte
602 * swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the byte
603 * swapping will be done to the \a lov_xattr buffer directly. The returned
604 * pointer should be freed with llapi_layout_free() when it is no longer
605 * needed. Failure is * indicated with a NULL return value and an appropriate
606 * error code stored in errno.
608 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
609 ssize_t lov_xattr_size,
613 * Allocate a new layout. Use this when creating a new file with
614 * llapi_layout_file_create().
616 struct llapi_layout *llapi_layout_alloc(void);
619 * Free memory allocated for \a layout.
621 void llapi_layout_free(struct llapi_layout *layout);
624 * llapi_layout_merge() - Merge a composite layout into another one.
625 * @dst_layout: Destination composite layout.
626 * @src_layout: Source composite layout.
628 * This function copies all of the components from @src_layout and
629 * appends them to @dst_layout.
631 * Return: 0 on success or -1 on failure.
633 int llapi_layout_merge(struct llapi_layout **dst_layout,
634 const struct llapi_layout *src_layout);
636 /** Not a valid stripe size, offset, or RAID pattern. */
637 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
640 * When specified or returned as the value for stripe count,
641 * stripe size, offset, or RAID pattern, the filesystem-wide
642 * default behavior will apply.
644 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
647 * When specified or returned as the value for stripe count, all
648 * available OSTs will be used.
650 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
653 * When specified as the value for layout pattern, file objects will be
654 * stored using RAID0. That is, data will be split evenly and without
655 * redundancy across all OSTs in the layout.
657 #define LLAPI_LAYOUT_RAID0 0ULL
658 #define LLAPI_LAYOUT_MDT 2ULL
661 * The layout includes a specific set of OSTs on which to allocate.
663 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
666 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
668 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
671 * Flags to modify how layouts are retrieved.
673 /******************** Stripe Count ********************/
676 * Store the stripe count of \a layout in \a count.
679 * \retval -1 Error with status code in errno.
681 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
685 * Set the stripe count of \a layout to \a count.
688 * \retval -1 Invalid argument, errno set to EINVAL.
690 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
692 /******************** Stripe Size ********************/
695 * Store the stripe size of \a layout in \a size.
698 * \retval -1 Invalid argument, errno set to EINVAL.
700 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
704 * Set the stripe size of \a layout to \a stripe_size.
707 * \retval -1 Invalid argument, errno set to EINVAL.
709 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
711 /******************** Stripe Pattern ********************/
714 * Store the stripe pattern of \a layout in \a pattern.
717 * \retval -1 Error with status code in errno.
719 int llapi_layout_pattern_get(const struct llapi_layout *layout,
723 * Set the stripe pattern of \a layout to \a pattern.
726 * \retval -1 Invalid argument, errno set to EINVAL.
728 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
730 /******************** OST Index ********************/
733 * Store the index of the OST where stripe number \a stripe_number is stored
736 * An error return value will result from a NULL layout, if \a
737 * stripe_number is out of range, or if \a layout was not initialized
738 * with llapi_layout_lookup_by{path,fd,fid}().
741 * \retval -1 Invalid argument, errno set to EINVAL.
743 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
744 uint64_t stripe_number, uint64_t *index);
747 * Set the OST index associated with stripe number \a stripe_number to
749 * NB: This is currently supported only for \a stripe_number = 0 and
750 * other usage will return ENOTSUPP in errno. A NULL \a layout or
751 * out-of-range \a stripe_number will return EINVAL in errno.
754 * \retval -1 Error with errno set to non-zero value.
756 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
759 /******************** Pool Name ********************/
762 * Store up to \a pool_name_len characters of the name of the pool of
763 * OSTs associated with \a layout into the buffer pointed to by
766 * The correct calling form is:
768 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
770 * A pool defines a set of OSTs from which file objects may be
771 * allocated for a file using \a layout.
773 * On success, the number of bytes stored is returned, excluding the
774 * terminating '\0' character (zero indicates that \a layout does not
775 * have an associated OST pool). On error, -1 is returned and errno is
776 * set appropriately. Possible sources of error include a NULL pointer
777 * argument or insufficient space in \a dest to store the pool name,
778 * in which cases errno will be set to EINVAL.
780 * \retval 0+ The number of bytes stored in \a dest.
781 * \retval -1 Invalid argument, errno set to EINVAL.
783 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
784 char *pool_name, size_t pool_name_len);
787 * Set the name of the pool of OSTs from which file objects will be
788 * allocated to \a pool_name.
790 * If the pool name uses "fsname.pool" notation to qualify the pool name
791 * with a filesystem name, the "fsname." portion will be silently
792 * discarded before storing the value. No validation that \a pool_name
793 * is an existing non-empty pool in filesystem \a fsname will be
794 * performed. Such validation can be performed by the application if
795 * desired using the llapi_search_ost() function. The maximum length of
796 * the stored value is defined by the constant LOV_MAXPOOLNAME.
799 * \retval -1 Invalid argument, errno set to EINVAL.
801 int llapi_layout_pool_name_set(struct llapi_layout *layout,
802 const char *pool_name);
804 /******************** File Creation ********************/
807 * Open an existing file at \a path, or create it with the specified
808 * \a layout and \a mode.
810 * One access mode and zero or more file creation flags and file status
811 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
812 * open file descriptor for the file. If \a layout is non-NULL and
813 * \a path is not on a Lustre filesystem this function will fail and set
816 * An already existing file may be opened with this function, but
817 * \a layout and \a mode will not be applied to it. Callers requiring a
818 * guarantee that the opened file is created with the specified
819 * \a layout and \a mode should use llapi_layout_file_create().
821 * A NULL \a layout may be specified, in which case the standard Lustre
822 * behavior for assigning layouts to newly-created files will apply.
824 * \retval 0+ An open file descriptor.
825 * \retval -1 Error with status code in errno.
827 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
828 const struct llapi_layout *layout);
831 * Create a new file at \a path with the specified \a layout and \a mode.
833 * One access mode and zero or more file creation flags and file status
834 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
835 * open file descriptor for the file. If \a layout is non-NULL and
836 * \a path is not on a Lustre filesystem this function will fail and set
841 * llapi_layout_file_create(path, open_flags, mode, layout)
843 * shall be equivalent to:
845 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
847 * It is an error if \a path specifies an existing file.
849 * A NULL \a layout may be specified, in which the standard Lustre
850 * behavior for assigning layouts to newly-created files will apply.
852 * \retval 0+ An open file descriptor.
853 * \retval -1 Error with status code in errno.
855 int llapi_layout_file_create(const char *path, int open_flags, int mode,
856 const struct llapi_layout *layout);
859 * Set flags to the header of component layout.
861 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
862 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
863 const char *llapi_layout_flags_string(uint32_t flags);
864 const __u16 llapi_layout_string_flags(char *string);
867 * llapi_layout_mirror_count_get() - Get mirror count from the header of
869 * @layout: Layout to get mirror count from.
870 * @count: Returned mirror count value.
872 * This function gets mirror count from the header of a layout.
874 * Return: 0 on success or -1 on failure.
876 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
880 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
881 * @layout: Layout to set mirror count in.
882 * @count: Mirror count value to be set.
884 * This function sets mirror count to the header of a layout.
886 * Return: 0 on success or -1 on failure.
888 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
892 * Fetch the start and end offset of the current layout component.
894 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
895 uint64_t *start, uint64_t *end);
897 * Set the extent of current layout component.
899 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
900 uint64_t start, uint64_t end);
902 /* PFL component flags table */
903 static const struct comp_flag_name {
904 enum lov_comp_md_entry_flags cfn_flag;
905 const char *cfn_name;
906 } comp_flags_table[] = {
907 { LCME_FL_INIT, "init" },
908 { LCME_FL_STALE, "stale" },
909 { LCME_FL_PREF_RW, "prefer" },
910 { LCME_FL_OFFLINE, "offline" },
911 { LCME_FL_NOSYNC, "nosync" },
915 * Gets the attribute flags of the current component.
917 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
920 * Sets the specified flags of the current component leaving other flags as-is.
922 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
924 * Clears the flags specified in the flags leaving other flags as-is.
926 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
928 * Fetches the file-unique component ID of the current layout component.
930 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
932 * Fetches the mirror ID of the current layout component.
934 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
936 * Adds one component to the existing composite or plain layout.
938 int llapi_layout_comp_add(struct llapi_layout *layout);
940 * Adds a first component of a mirror to the existing composite layout.
942 int llapi_layout_add_first_comp(struct llapi_layout *layout);
944 * Deletes the current layout component from the composite layout.
946 int llapi_layout_comp_del(struct llapi_layout *layout);
948 enum llapi_layout_comp_use {
949 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
950 LLAPI_LAYOUT_COMP_USE_LAST = 2,
951 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
952 LLAPI_LAYOUT_COMP_USE_PREV = 4,
956 * Set the currently active component to the specified component ID.
958 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
960 * Select the currently active component at the specified position.
962 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
964 * Add layout components to an existing file.
966 int llapi_layout_file_comp_add(const char *path,
967 const struct llapi_layout *layout);
969 * Delete component(s) by the specified component id or flags.
971 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
973 * Change flags or other parameters of the component(s) by component ID of an
974 * existing file. The component to be modified is specified by the
975 * comp->lcme_id value, which must be an unique component ID. The new
976 * attributes are passed in by @comp and @valid is used to specify which
977 * attributes in the component are going to be changed.
979 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
982 * Check if the file layout is composite.
984 bool llapi_layout_is_composite(struct llapi_layout *layout);
987 LLAPI_LAYOUT_ITER_CONT = 0,
988 LLAPI_LAYOUT_ITER_STOP = 1,
992 * Iteration callback function.
994 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
995 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
996 * \retval < 0 error code
998 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1001 * Iterate all components in the corresponding layout
1003 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1004 llapi_layout_iter_cb cb, void *cbdata);
1007 * FLR: mirror operation APIs
1009 int llapi_mirror_set(int fd, unsigned int id);
1010 int llapi_mirror_clear(int fd);
1011 ssize_t llapi_mirror_read(int fd, unsigned int id,
1012 void *buf, size_t count, off_t pos);
1013 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1014 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1015 off_t pos, size_t count);
1017 int llapi_heat_get(int fd, struct lu_heat *heat);
1018 int llapi_heat_set(int fd, __u64 flags);
1022 #if defined(__cplusplus)