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 __u32 llapi_pattern_to_lov(uint64_t pattern);
131 int llapi_file_open_param(const char *name, int flags, mode_t mode,
132 const struct llapi_stripe_param *param);
133 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
134 __u32 flags, char *foreign_lov);
135 int llapi_file_create(const char *name, unsigned long long stripe_size,
136 int stripe_offset, int stripe_count, int stripe_pattern);
137 int llapi_file_open(const char *name, int flags, int mode,
138 unsigned long long stripe_size, int stripe_offset,
139 int stripe_count, int stripe_pattern);
140 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
141 int stripe_offset, int stripe_count,
142 int stripe_pattern, char *pool_name);
143 int llapi_file_open_pool(const char *name, int flags, int mode,
144 unsigned long long stripe_size, int stripe_offset,
145 int stripe_count, int stripe_pattern, char *pool_name);
146 int llapi_poollist(const char *name);
147 int llapi_get_poollist(const char *name, char **poollist, int list_size,
148 char *buffer, int buffer_size);
149 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
150 char *buffer, int buffer_size);
151 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
152 int llapi_file_lookup(int dirfd, const char *name);
153 void llapi_set_command_name(const char *cmd);
154 void llapi_clear_command_name(void);
156 enum llapi_layout_verbose {
157 VERBOSE_STRIPE_COUNT = 0x1,
158 VERBOSE_STRIPE_SIZE = 0x2,
159 VERBOSE_STRIPE_OFFSET = 0x4,
161 VERBOSE_DETAIL = 0x10,
162 VERBOSE_OBJID = 0x20,
163 VERBOSE_GENERATION = 0x40,
164 VERBOSE_MDTINDEX = 0x80,
165 VERBOSE_PATTERN = 0x100,
166 VERBOSE_COMP_COUNT = 0x200,
167 VERBOSE_COMP_FLAGS = 0x400,
168 VERBOSE_COMP_START = 0x800,
169 VERBOSE_COMP_END = 0x1000,
170 VERBOSE_COMP_ID = 0x2000,
171 VERBOSE_DFID = 0x4000,
172 VERBOSE_HASH_TYPE = 0x8000,
173 VERBOSE_MIRROR_COUNT = 0x10000,
174 VERBOSE_MIRROR_ID = 0x20000,
175 VERBOSE_EXT_SIZE = 0x40000,
176 VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
177 VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
178 VERBOSE_OBJID | VERBOSE_GENERATION |
179 VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
180 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
181 VERBOSE_COMP_START | VERBOSE_COMP_END |
182 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
183 VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE
185 /* Compatibility with original names */
186 #define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
187 #define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
188 #define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
189 #define VERBOSE_LAYOUT VERBOSE_PATTERN
192 unsigned int fp_max_depth;
194 mode_t fp_type; /* S_IFIFO,... */
200 /* {a,m,c}sign cannot be bitfields due to using pointers to
201 * access them during argument parsing. */
205 /* these need to be signed values */
207 fp_stripe_size_sign:2,
208 fp_stripe_count_sign:2,
209 fp_comp_start_sign:2,
211 fp_comp_count_sign:2,
212 fp_mirror_count_sign:2,
213 fp_mirror_index_sign:2,
218 unsigned long long fp_size;
219 unsigned long long fp_size_units;
221 unsigned long long fp_zero_end:1,
223 fp_exclude_pattern:1,
231 fp_check_pool:1, /* LOV pool name */
232 fp_check_size:1, /* file size */
238 fp_get_lmv:1, /* get MDT list from LMV */
239 fp_raw:1, /* do not fill in defaults */
240 fp_check_stripe_size:1, /* LOV stripe size */
241 fp_exclude_stripe_size:1,
242 fp_check_stripe_count:1, /* LOV stripe count */
243 fp_exclude_stripe_count:1,
246 fp_get_default_lmv:1, /* Get default LMV */
250 fp_check_comp_count:1,
251 fp_exclude_comp_count:1,
252 fp_check_mirror_count:1,
253 fp_exclude_mirror_count:1,
254 fp_check_comp_flags:1,
255 fp_check_mirror_state:1,
256 fp_check_comp_start:1,
257 fp_exclude_comp_start:1,
259 fp_exclude_comp_end:1,
261 fp_exclude_comp_id:1,
262 fp_check_mirror_id:1,
263 fp_exclude_mirror_id:1,
264 fp_check_mirror_index:1,
265 fp_exclude_mirror_index:1,
266 fp_check_mdt_count:1,
267 fp_exclude_mdt_count:1,
268 fp_check_hash_type:1,
269 fp_exclude_hash_type:1,
270 fp_yaml:1, /* output layout in YAML */
274 fp_exclude_foreign:1,
275 fp_check_ext_size:1, /* extension size */
276 fp_exclude_ext_size:1;
278 enum llapi_layout_verbose fp_verbose;
281 /* regular expression */
284 struct obd_uuid *fp_obd_uuid;
286 int fp_num_alloc_obds;
290 struct obd_uuid *fp_mdt_uuid;
292 int fp_num_alloc_mdts;
295 int fp_file_mdt_index;
298 struct lov_user_mds_data *fp_lmd;
300 char fp_poolname[LOV_MAXPOOLNAME + 1];
302 __u32 fp_lmv_stripe_count;
303 struct lmv_user_md *fp_lmv_md;
305 unsigned long long fp_stripe_size;
306 unsigned long long fp_stripe_size_units;
307 unsigned long long fp_stripe_count;
311 __u32 fp_mirror_count;
313 __u32 fp_comp_neg_flags;
314 __u16 fp_mirror_state;
315 __u16 fp_mirror_neg_state;
318 __u16 fp_mirror_index;
319 unsigned long long fp_comp_start;
320 unsigned long long fp_comp_start_units;
321 unsigned long long fp_comp_end;
322 unsigned long long fp_comp_end_units;
323 unsigned long long fp_mdt_count;
325 unsigned long long fp_blocks;
326 unsigned long long fp_blocks_units;
327 unsigned long long fp_ext_size;
328 unsigned long long fp_ext_size_units;
330 /* In-process parameters. */
331 unsigned long fp_got_uuids:1,
333 unsigned int fp_depth;
334 unsigned int fp_hash_type;
335 unsigned int fp_time_margin; /* time margin in seconds */
336 __u32 fp_foreign_type;
339 int llapi_ostlist(char *path, struct find_param *param);
340 int llapi_uuid_match(char *real_uuid, char *search_uuid);
341 int llapi_getstripe(char *path, struct find_param *param);
342 int llapi_find(char *path, struct find_param *param);
344 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
345 int llapi_dir_set_default_lmv(const char *name,
346 const struct llapi_stripe_param *param);
347 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
348 int stripe_count, int stripe_pattern,
349 const char *pool_name);
350 int llapi_dir_create(const char *name, mode_t mode,
351 const struct llapi_stripe_param *param);
352 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
353 __u32 flags, const char *value);
354 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
355 int stripe_count, int stripe_pattern,
356 const char *poolname);
357 int llapi_direntry_remove(char *dname);
359 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
360 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
361 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
362 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
363 int llapi_ping(char *obd_type, char *obd_name);
364 int llapi_target_check(int num_types, char **obd_types, char *dir);
365 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
366 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
367 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
368 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
369 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
370 int llapi_is_lustre_mnttype(const char *type);
371 int llapi_search_tgt(const char *fsname, const char *poolname,
372 const char *tgtname, bool is_mdt);
373 int llapi_search_mdt(const char *fsname, const char *poolname,
374 const char *mdtname);
375 int llapi_search_ost(const char *fsname, const char *poolname,
376 const char *ostname);
377 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
378 int llapi_parse_size(const char *optarg, unsigned long long *size,
379 unsigned long long *size_units, int bytes_spec);
380 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
382 int llapi_search_fsname(const char *pathname, char *fsname);
383 int llapi_getname(const char *path, char *buf, size_t size);
384 int llapi_search_fileset(const char *pathname, char *fileset);
386 int llapi_search_rootpath(char *pathname, const char *fsname);
387 int llapi_nodemap_exists(const char *name);
388 int llapi_migrate_mdt(char *path, struct find_param *param);
389 int llapi_mv(char *path, struct find_param *param);
393 #define HAVE_LLAPI_IS_LUSTRE_MNT
394 int llapi_is_lustre_mnt(struct mntent *mnt);
395 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
396 int llapi_target_iterate(int type_num, char **obd_type, void *args,
398 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
399 int llapi_cp(int argc, char *argv[]);
400 int llapi_ls(int argc, char *argv[]);
401 int llapi_fid2path(const char *device, const char *fidstr, char *path,
402 int pathlen, long long *recno, int *linkno);
403 int llapi_path2fid(const char *path, struct lu_fid *fid);
404 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
406 int llapi_fd2fid(int fd, struct lu_fid *fid);
407 /* get FID of parent dir + the related name of entry in this parent dir */
408 int llapi_path2parent(const char *path, unsigned int linkno,
409 struct lu_fid *parent_fid, char *name, size_t name_size);
410 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
411 char *name, size_t name_size);
412 int llapi_rmfid(const char *path, struct fid_array *fa);
413 int llapi_chomp_string(char *buf);
414 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
416 int llapi_get_version_string(char *version, unsigned int version_size);
417 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
418 int llapi_get_version(char *buffer, int buffer_size, char **version)
419 __attribute__((deprecated));
420 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
421 int llapi_file_flush(int fd);
422 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
423 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
424 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
425 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
427 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
429 int llapi_hsm_register_event_fifo(const char *path);
430 int llapi_hsm_unregister_event_fifo(const char *path);
431 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
432 const char *fmt, va_list args);
434 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
435 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
437 int llapi_create_volatile_param(const char *directory, int mdt_idx,
438 int open_flags, mode_t mode,
439 const struct llapi_stripe_param *stripe_param);
441 static inline int llapi_create_volatile(char *directory, int open_flags)
443 return llapi_create_volatile_idx(directory, -1, open_flags);
447 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
448 int gid, __u64 flags);
449 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
450 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
451 __u64 dv2, __u64 flags);
453 /* Changelog interface. priv is private state, managed internally by these
456 /* Records received are in extended format now, though most of them are still
457 * written in disk in changelog_rec format (to save space and time), it's
458 * converted to extended format in the lustre api to ease changelog analysis. */
459 #define HAVE_CHANGELOG_EXTEND_REC 1
461 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
462 const char *mdtname, long long startrec);
463 int llapi_changelog_fini(void **priv);
464 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
465 int llapi_changelog_in_buf(void *priv);
466 int llapi_changelog_free(struct changelog_rec **rech);
467 int llapi_changelog_get_fd(void *priv);
468 /* Allow records up to endrec to be destroyed; requires registered id. */
469 int llapi_changelog_clear(const char *mdtname, const char *idstr,
471 extern int llapi_changelog_set_xflags(void *priv,
472 enum changelog_send_extra_flag extra_flags);
474 /* HSM copytool interface.
475 * priv is private state, managed internally by these functions
477 struct hsm_copytool_private;
478 struct hsm_copyaction_private;
480 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
481 const char *mnt, int archive_count,
482 int *archives, int rfd_flags);
483 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
484 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
485 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
486 struct hsm_action_list **hal, int *msgsize);
487 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
488 const struct hsm_copytool_private *ct,
489 const struct hsm_action_item *hai,
490 int restore_mdt_index, int restore_open_flags,
492 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
493 const struct hsm_extent *he, int hp_flags, int errval);
494 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
495 const struct hsm_extent *he, __u64 total,
497 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
499 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
500 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
501 unsigned long long stripe_size, int stripe_offset,
502 int stripe_count, int stripe_pattern, char *pool_name,
503 struct lu_fid *newfid);
505 /* HSM user interface */
506 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
508 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
509 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
512 int llapi_json_init_list(struct llapi_json_item_list **item_list);
513 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
514 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
515 __u32 type, void *val);
516 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
519 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
520 int llapi_lease_release(int fd);
521 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
522 int llapi_lease_check(int fd);
523 int llapi_lease_get(int fd, int mode); /* obsoleted */
524 int llapi_lease_put(int fd); /* obsoleted */
527 int llapi_group_lock(int fd, int gid);
528 int llapi_group_unlock(int fd, int gid);
531 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
532 struct llapi_lu_ladvise *ladvise);
535 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
536 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
537 __u32 id, enum lu_pcc_type type);
538 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
539 __u32 id, enum lu_pcc_type type);
540 int llapi_pcc_detach_fd(int fd, __u32 option);
541 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
543 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
545 int llapi_pcc_detach_file(const char *path, __u32 option);
546 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
547 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
548 int llapi_pccdev_set(const char *mntpath, const char *cmd);
549 int llapi_pccdev_get(const char *mntpath);
552 /* llapi_layout user interface */
555 * An array element storing component info to be resynced during mirror
558 struct llapi_resync_comp {
561 uint32_t lrc_mirror_id;
562 uint32_t lrc_id; /* component id */
566 /** Opaque data type abstracting the layout of a Lustre file. */
569 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
570 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
571 size_t count, off_t pos);
572 uint32_t llapi_mirror_find(struct llapi_layout *layout,
573 uint64_t file_start, uint64_t file_end,
575 int llapi_mirror_find_stale(struct llapi_layout *layout,
576 struct llapi_resync_comp *comp, size_t comp_size,
577 __u16 *mirror_ids, int ids_nr);
578 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
579 struct llapi_resync_comp *comp_array,
580 int comp_size, uint64_t start, uint64_t end);
582 * Flags to control how layouts are retrieved.
585 /* Replace non-specified values with expected inherited values. */
586 #define LAYOUT_GET_EXPECTED 0x1
589 * Return a pointer to a newly-allocated opaque data structure containing
590 * the layout for the file at \a path. The pointer should be freed with
591 * llapi_layout_free() when it is no longer needed. Failure is indicated
592 * by a NULL return value and an appropriate error code stored in errno.
594 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
597 * Return a pointer to a newly-allocated opaque data type containing the
598 * layout for the file referenced by open file descriptor \a fd. The
599 * pointer should be freed with llapi_layout_free() when it is no longer
600 * needed. Failure is indicated by a NULL return value and an
601 * appropriate error code stored in errno.
603 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
606 * Return a pointer to a newly-allocated opaque data type containing the
607 * layout for the file associated with Lustre file identifier
608 * \a fid. The string \a path must name a path within the
609 * filesystem that contains the file being looked up, such as the
610 * filesystem root. The returned pointer should be freed with
611 * llapi_layout_free() when it is no longer needed. Failure is
612 * indicated with a NULL return value and an appropriate error code
615 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
616 const struct lu_fid *fid,
619 enum llapi_layout_xattr_flags {
620 LLAPI_LXF_CHECK = 0x0001,
621 LLAPI_LXF_COPY = 0x0002,
625 * Return a pointer to a newly-allocated opaque data type containing the
626 * layout for the file associated with extended attribute \a lov_xattr. The
627 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
628 * should be raw xattr without being swapped, since this function will swap it
629 * properly. Thus, \a lov_xattr will be modified during the process. If the
630 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
631 * the objects count in lum is consistent with the stripe count in lum. This
632 * check only apply to regular file, so \a LLAPI_LXF_CHECK flag should be
633 * cleared if the xattr belongs to a directory. If the \a LLAPI_LXF_COPY flag
634 * of \a flags is set, this function will use a temporary buffer for byte
635 * swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the byte
636 * swapping will be done to the \a lov_xattr buffer directly. The returned
637 * pointer should be freed with llapi_layout_free() when it is no longer
638 * needed. Failure is * indicated with a NULL return value and an appropriate
639 * error code stored in errno.
641 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
642 ssize_t lov_xattr_size,
646 * Allocate a new layout. Use this when creating a new file with
647 * llapi_layout_file_create().
649 struct llapi_layout *llapi_layout_alloc(void);
652 * Free memory allocated for \a layout.
654 void llapi_layout_free(struct llapi_layout *layout);
657 * llapi_layout_merge() - Merge a composite layout into another one.
658 * @dst_layout: Destination composite layout.
659 * @src_layout: Source composite layout.
661 * This function copies all of the components from @src_layout and
662 * appends them to @dst_layout.
664 * Return: 0 on success or -1 on failure.
666 int llapi_layout_merge(struct llapi_layout **dst_layout,
667 const struct llapi_layout *src_layout);
669 /** Not a valid stripe size, offset, or RAID pattern. */
670 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
673 * When specified or returned as the value for stripe count,
674 * stripe size, offset, or RAID pattern, the filesystem-wide
675 * default behavior will apply.
677 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
680 * When specified or returned as the value for stripe count, all
681 * available OSTs will be used.
683 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
686 * When specified as the value for layout pattern, file objects will be
687 * stored using RAID0. That is, data will be split evenly and without
688 * redundancy across all OSTs in the layout.
690 #define LLAPI_LAYOUT_RAID0 0ULL
691 #define LLAPI_LAYOUT_MDT 2ULL
692 #define LLAPI_LAYOUT_OVERSTRIPING 4ULL
695 * The layout includes a specific set of OSTs on which to allocate.
697 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
700 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
702 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
705 * Flags to modify how layouts are retrieved.
707 /******************** Stripe Count ********************/
710 * Store the stripe count of \a layout in \a count.
713 * \retval -1 Error with status code in errno.
715 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
719 * Set the stripe count of \a layout to \a count.
722 * \retval -1 Invalid argument, errno set to EINVAL.
724 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
726 /******************** Stripe Size ********************/
729 * Store the stripe size of \a layout in \a size.
732 * \retval -1 Invalid argument, errno set to EINVAL.
734 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
738 * Set the stripe size of \a layout to \a stripe_size.
741 * \retval -1 Invalid argument, errno set to EINVAL.
743 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
746 /******************** Extension Size ********************/
749 * Store the extension size of \a layout in \a size.
752 * \retval -1 Invalid argument, errno set to EINVAL.
754 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
758 * Set the extension size of \a layout to \a stripe_size.
761 * \retval -1 Invalid argument, errno set to EINVAL.
763 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
766 /******************** Stripe Pattern ********************/
769 * Store the stripe pattern of \a layout in \a pattern.
772 * \retval -1 Error with status code in errno.
774 int llapi_layout_pattern_get(const struct llapi_layout *layout,
778 * Set the stripe pattern of \a layout to \a pattern.
781 * \retval -1 Invalid argument, errno set to EINVAL.
783 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
785 /******************** OST Index ********************/
788 * Store the index of the OST where stripe number \a stripe_number is stored
791 * An error return value will result from a NULL layout, if \a
792 * stripe_number is out of range, or if \a layout was not initialized
793 * with llapi_layout_lookup_by{path,fd,fid}().
796 * \retval -1 Invalid argument, errno set to EINVAL.
798 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
799 uint64_t stripe_number, uint64_t *index);
802 * Set the OST index associated with stripe number \a stripe_number to
804 * NB: This is currently supported only for \a stripe_number = 0 and
805 * other usage will return ENOTSUPP in errno. A NULL \a layout or
806 * out-of-range \a stripe_number will return EINVAL in errno.
809 * \retval -1 Error with errno set to non-zero value.
811 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
814 /******************** Pool Name ********************/
817 * Store up to \a pool_name_len characters of the name of the pool of
818 * OSTs associated with \a layout into the buffer pointed to by
821 * The correct calling form is:
823 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
825 * A pool defines a set of OSTs from which file objects may be
826 * allocated for a file using \a layout.
828 * On success, the number of bytes stored is returned, excluding the
829 * terminating '\0' character (zero indicates that \a layout does not
830 * have an associated OST pool). On error, -1 is returned and errno is
831 * set appropriately. Possible sources of error include a NULL pointer
832 * argument or insufficient space in \a dest to store the pool name,
833 * in which cases errno will be set to EINVAL.
835 * \retval 0+ The number of bytes stored in \a dest.
836 * \retval -1 Invalid argument, errno set to EINVAL.
838 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
839 char *pool_name, size_t pool_name_len);
842 * Set the name of the pool of OSTs from which file objects will be
843 * allocated to \a pool_name.
845 * If the pool name uses "fsname.pool" notation to qualify the pool name
846 * with a filesystem name, the "fsname." portion will be silently
847 * discarded before storing the value. No validation that \a pool_name
848 * is an existing non-empty pool in filesystem \a fsname will be
849 * performed. Such validation can be performed by the application if
850 * desired using the llapi_search_ost() function. The maximum length of
851 * the stored value is defined by the constant LOV_MAXPOOLNAME.
854 * \retval -1 Invalid argument, errno set to EINVAL.
856 int llapi_layout_pool_name_set(struct llapi_layout *layout,
857 const char *pool_name);
859 /******************** File Creation ********************/
862 * Open an existing file at \a path, or create it with the specified
863 * \a layout and \a mode.
865 * One access mode and zero or more file creation flags and file status
866 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
867 * open file descriptor for the file. If \a layout is non-NULL and
868 * \a path is not on a Lustre filesystem this function will fail and set
871 * An already existing file may be opened with this function, but
872 * \a layout and \a mode will not be applied to it. Callers requiring a
873 * guarantee that the opened file is created with the specified
874 * \a layout and \a mode should use llapi_layout_file_create().
876 * A NULL \a layout may be specified, in which case the standard Lustre
877 * behavior for assigning layouts to newly-created files will apply.
879 * \retval 0+ An open file descriptor.
880 * \retval -1 Error with status code in errno.
882 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
883 const struct llapi_layout *layout);
886 * Create a new file at \a path with the specified \a layout and \a mode.
888 * One access mode and zero or more file creation flags and file status
889 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
890 * open file descriptor for the file. If \a layout is non-NULL and
891 * \a path is not on a Lustre filesystem this function will fail and set
896 * llapi_layout_file_create(path, open_flags, mode, layout)
898 * shall be equivalent to:
900 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
902 * It is an error if \a path specifies an existing file.
904 * A NULL \a layout may be specified, in which the standard Lustre
905 * behavior for assigning layouts to newly-created files will apply.
907 * \retval 0+ An open file descriptor.
908 * \retval -1 Error with status code in errno.
910 int llapi_layout_file_create(const char *path, int open_flags, int mode,
911 const struct llapi_layout *layout);
914 * Set flags to the header of component layout.
916 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
917 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
918 const char *llapi_layout_flags_string(uint32_t flags);
919 const __u16 llapi_layout_string_flags(char *string);
922 * llapi_layout_mirror_count_get() - Get mirror count from the header of
924 * @layout: Layout to get mirror count from.
925 * @count: Returned mirror count value.
927 * This function gets mirror count from the header of a layout.
929 * Return: 0 on success or -1 on failure.
931 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
935 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
936 * @layout: Layout to set mirror count in.
937 * @count: Mirror count value to be set.
939 * This function sets mirror count to the header of a layout.
941 * Return: 0 on success or -1 on failure.
943 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
947 * Fetch the start and end offset of the current layout component.
949 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
950 uint64_t *start, uint64_t *end);
952 * Set the extent of current layout component.
954 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
955 uint64_t start, uint64_t end);
957 /* PFL component flags table */
958 static const struct comp_flag_name {
959 enum lov_comp_md_entry_flags cfn_flag;
960 const char *cfn_name;
961 } comp_flags_table[] = {
962 { LCME_FL_INIT, "init" },
963 { LCME_FL_STALE, "stale" },
964 { LCME_FL_PREF_RW, "prefer" },
965 { LCME_FL_OFFLINE, "offline" },
966 { LCME_FL_NOSYNC, "nosync" },
967 { LCME_FL_EXTENSION, "extension" },
971 * Gets the attribute flags of the current component.
973 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
976 * Sets the specified flags of the current component leaving other flags as-is.
978 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
980 * Clears the flags specified in the flags leaving other flags as-is.
982 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
984 * Fetches the file-unique component ID of the current layout component.
986 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
988 * Fetches the mirror ID of the current layout component.
990 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
992 * Adds one component to the existing composite or plain layout.
994 int llapi_layout_comp_add(struct llapi_layout *layout);
996 * Adds a first component of a mirror to the existing composite layout.
998 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1000 * Deletes the current layout component from the composite layout.
1002 int llapi_layout_comp_del(struct llapi_layout *layout);
1004 enum llapi_layout_comp_use {
1005 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1006 LLAPI_LAYOUT_COMP_USE_LAST = 2,
1007 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1008 LLAPI_LAYOUT_COMP_USE_PREV = 4,
1012 * Set the currently active component to the specified component ID.
1014 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1016 * Select the currently active component at the specified position.
1018 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1020 * Add layout components to an existing file.
1022 int llapi_layout_file_comp_add(const char *path,
1023 const struct llapi_layout *layout);
1025 * Delete component(s) by the specified component id or flags.
1027 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1029 * Change flags or other parameters of the component(s) by component ID of an
1030 * existing file. The component to be modified is specified by the
1031 * comp->lcme_id value, which must be an unique component ID. The new
1032 * attributes are passed in by @comp and @valid is used to specify which
1033 * attributes in the component are going to be changed.
1035 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1038 * Check if the file layout is composite.
1040 bool llapi_layout_is_composite(struct llapi_layout *layout);
1043 LLAPI_LAYOUT_ITER_CONT = 0,
1044 LLAPI_LAYOUT_ITER_STOP = 1,
1048 * Iteration callback function.
1050 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
1051 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
1052 * \retval < 0 error code
1054 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1057 * Iterate all components in the corresponding layout
1059 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1060 llapi_layout_iter_cb cb, void *cbdata);
1063 * FLR: mirror operation APIs
1065 int llapi_mirror_set(int fd, unsigned int id);
1066 int llapi_mirror_clear(int fd);
1067 ssize_t llapi_mirror_read(int fd, unsigned int id,
1068 void *buf, size_t count, off_t pos);
1069 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1070 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1071 off_t pos, size_t count);
1073 int llapi_heat_get(int fd, struct lu_heat *heat);
1074 int llapi_heat_set(int fd, __u64 flags);
1075 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
1076 void llapi_layout_sanity_perror(int error);
1077 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1081 #if defined(__cplusplus)