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_MIRROR_ID 0x20000
170 #define VERBOSE_DEFAULT (VERBOSE_COUNT | VERBOSE_SIZE | \
171 VERBOSE_OFFSET | VERBOSE_POOL | \
172 VERBOSE_OBJID | VERBOSE_GENERATION | \
173 VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
174 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
175 VERBOSE_COMP_START | VERBOSE_COMP_END | \
176 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT| \
180 unsigned int fp_max_depth;
182 mode_t fp_type; /* S_IFIFO,... */
188 /* {a,m,c}sign cannot be bitfields due to using pointers to
189 * access them during argument parsing. */
193 /* these need to be signed values */
195 fp_stripe_size_sign:2,
196 fp_stripe_count_sign:2,
197 fp_comp_start_sign:2,
199 fp_comp_count_sign:2,
200 fp_mirror_count_sign:2,
201 fp_mirror_index_sign:2,
205 unsigned long long fp_size;
206 unsigned long long fp_size_units;
208 unsigned long long fp_zero_end:1,
210 fp_exclude_pattern:1,
218 fp_check_pool:1, /* LOV pool name */
219 fp_check_size:1, /* file size */
225 fp_get_lmv:1, /* get MDT list from LMV */
226 fp_raw:1, /* do not fill in defaults */
227 fp_check_stripe_size:1, /* LOV stripe size */
228 fp_exclude_stripe_size:1,
229 fp_check_stripe_count:1, /* LOV stripe count */
230 fp_exclude_stripe_count:1,
233 fp_get_default_lmv:1, /* Get default LMV */
237 fp_check_comp_count:1,
238 fp_exclude_comp_count:1,
239 fp_check_mirror_count:1,
240 fp_exclude_mirror_count:1,
241 fp_check_comp_flags:1,
242 fp_check_mirror_state:1,
243 fp_check_comp_start:1,
244 fp_exclude_comp_start:1,
246 fp_exclude_comp_end:1,
248 fp_exclude_comp_id:1,
249 fp_check_mirror_id:1,
250 fp_exclude_mirror_id:1,
251 fp_check_mirror_index:1,
252 fp_exclude_mirror_index:1,
253 fp_check_mdt_count:1,
254 fp_exclude_mdt_count:1,
255 fp_check_hash_type:1,
256 fp_exclude_hash_type:1,
257 fp_yaml:1, /* output layout in YAML */
264 /* regular expression */
267 struct obd_uuid *fp_obd_uuid;
269 int fp_num_alloc_obds;
273 struct obd_uuid *fp_mdt_uuid;
275 int fp_num_alloc_mdts;
278 int fp_file_mdt_index;
281 struct lov_user_mds_data *fp_lmd;
283 char fp_poolname[LOV_MAXPOOLNAME + 1];
285 __u32 fp_lmv_stripe_count;
286 struct lmv_user_md *fp_lmv_md;
288 unsigned long long fp_stripe_size;
289 unsigned long long fp_stripe_size_units;
290 unsigned long long fp_stripe_count;
294 __u32 fp_mirror_count;
296 __u32 fp_comp_neg_flags;
297 __u16 fp_mirror_state;
298 __u16 fp_mirror_neg_state;
301 __u16 fp_mirror_index;
302 unsigned long long fp_comp_start;
303 unsigned long long fp_comp_start_units;
304 unsigned long long fp_comp_end;
305 unsigned long long fp_comp_end_units;
306 unsigned long long fp_mdt_count;
308 unsigned long long fp_blocks;
309 unsigned long long fp_blocks_units;
311 /* In-process parameters. */
312 unsigned long fp_got_uuids:1,
314 unsigned int fp_depth;
315 unsigned int fp_hash_type;
318 int llapi_ostlist(char *path, struct find_param *param);
319 int llapi_uuid_match(char *real_uuid, char *search_uuid);
320 int llapi_getstripe(char *path, struct find_param *param);
321 int llapi_find(char *path, struct find_param *param);
323 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
324 int llapi_dir_set_default_lmv(const char *name,
325 const struct llapi_stripe_param *param);
326 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
327 int stripe_count, int stripe_pattern,
328 const char *pool_name);
329 int llapi_dir_create(const char *name, mode_t mode,
330 const struct llapi_stripe_param *param);
331 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
332 int stripe_count, int stripe_pattern,
333 const char *poolname);
334 int llapi_direntry_remove(char *dname);
336 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
337 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
338 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
339 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
340 int llapi_ping(char *obd_type, char *obd_name);
341 int llapi_target_check(int num_types, char **obd_types, char *dir);
342 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
343 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
344 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
345 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
346 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
347 int llapi_is_lustre_mnttype(const char *type);
348 int llapi_search_tgt(char *fsname, char *poolname, char *tgtname, bool is_mdt);
349 int llapi_search_ost(char *fsname, char *poolname, char *ostname);
350 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
351 int llapi_parse_size(const char *optarg, unsigned long long *size,
352 unsigned long long *size_units, int bytes_spec);
353 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
355 int llapi_search_fsname(const char *pathname, char *fsname);
356 int llapi_getname(const char *path, char *buf, size_t size);
357 int llapi_search_fileset(const char *pathname, char *fileset);
359 int llapi_search_rootpath(char *pathname, const char *fsname);
360 int llapi_nodemap_exists(const char *name);
361 int llapi_migrate_mdt(char *path, struct find_param *param);
362 int llapi_mv(char *path, struct find_param *param);
366 #define HAVE_LLAPI_IS_LUSTRE_MNT
367 int llapi_is_lustre_mnt(struct mntent *mnt);
368 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
369 int llapi_target_iterate(int type_num, char **obd_type, void *args,
371 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
372 int llapi_cp(int argc, char *argv[]);
373 int llapi_ls(int argc, char *argv[]);
374 int llapi_fid2path(const char *device, const char *fidstr, char *path,
375 int pathlen, long long *recno, int *linkno);
376 int llapi_path2fid(const char *path, struct lu_fid *fid);
377 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
379 int llapi_fd2fid(int fd, struct lu_fid *fid);
380 /* get FID of parent dir + the related name of entry in this parent dir */
381 int llapi_path2parent(const char *path, unsigned int linkno,
382 struct lu_fid *parent_fid, char *name, size_t name_size);
383 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
384 char *name, size_t name_size);
385 int llapi_chomp_string(char *buf);
386 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
388 int llapi_get_version_string(char *version, unsigned int version_size);
389 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
390 int llapi_get_version(char *buffer, int buffer_size, char **version)
391 __attribute__((deprecated));
392 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
393 int llapi_file_flush(int fd);
394 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
395 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
396 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
397 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
399 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
401 int llapi_hsm_register_event_fifo(const char *path);
402 int llapi_hsm_unregister_event_fifo(const char *path);
403 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
404 const char *fmt, va_list args);
406 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
407 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
409 int llapi_create_volatile_param(const char *directory, int mdt_idx,
410 int open_flags, mode_t mode,
411 const struct llapi_stripe_param *stripe_param);
413 static inline int llapi_create_volatile(char *directory, int open_flags)
415 return llapi_create_volatile_idx(directory, -1, open_flags);
419 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
420 int gid, __u64 flags);
421 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
422 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
423 __u64 dv2, __u64 flags);
425 /* Changelog interface. priv is private state, managed internally by these
428 /* Records received are in extended format now, though most of them are still
429 * written in disk in changelog_rec format (to save space and time), it's
430 * converted to extended format in the lustre api to ease changelog analysis. */
431 #define HAVE_CHANGELOG_EXTEND_REC 1
433 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
434 const char *mdtname, long long startrec);
435 int llapi_changelog_fini(void **priv);
436 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
437 int llapi_changelog_free(struct changelog_rec **rech);
438 int llapi_changelog_get_fd(void *priv);
439 /* Allow records up to endrec to be destroyed; requires registered id. */
440 int llapi_changelog_clear(const char *mdtname, const char *idstr,
442 extern int llapi_changelog_set_xflags(void *priv,
443 enum changelog_send_extra_flag extra_flags);
445 /* HSM copytool interface.
446 * priv is private state, managed internally by these functions
448 struct hsm_copytool_private;
449 struct hsm_copyaction_private;
451 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
452 const char *mnt, int archive_count,
453 int *archives, int rfd_flags);
454 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
455 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
456 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
457 struct hsm_action_list **hal, int *msgsize);
458 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
459 const struct hsm_copytool_private *ct,
460 const struct hsm_action_item *hai,
461 int restore_mdt_index, int restore_open_flags,
463 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
464 const struct hsm_extent *he, int hp_flags, int errval);
465 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
466 const struct hsm_extent *he, __u64 total,
468 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
470 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
471 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
472 unsigned long long stripe_size, int stripe_offset,
473 int stripe_count, int stripe_pattern, char *pool_name,
474 struct lu_fid *newfid);
476 /* HSM user interface */
477 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
479 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
480 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
483 int llapi_json_init_list(struct llapi_json_item_list **item_list);
484 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
485 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
486 __u32 type, void *val);
487 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
490 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
491 int llapi_lease_release(int fd);
492 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
493 int llapi_lease_check(int fd);
494 int llapi_lease_get(int fd, int mode); /* obsoleted */
495 int llapi_lease_put(int fd); /* obsoleted */
498 int llapi_group_lock(int fd, int gid);
499 int llapi_group_unlock(int fd, int gid);
502 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
503 struct llapi_lu_ladvise *ladvise);
506 /* llapi_layout user interface */
509 * An array element storing component info to be resynced during mirror
512 struct llapi_resync_comp {
515 uint32_t lrc_mirror_id;
516 uint32_t lrc_id; /* component id */
520 /** Opaque data type abstracting the layout of a Lustre file. */
523 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
524 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
525 size_t count, off_t pos);
526 uint32_t llapi_mirror_find(struct llapi_layout *layout,
527 uint64_t file_start, uint64_t file_end,
529 int llapi_mirror_find_stale(struct llapi_layout *layout,
530 struct llapi_resync_comp *comp, size_t comp_size,
531 __u16 *mirror_ids, int ids_nr);
532 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
533 struct llapi_resync_comp *comp_array,
534 int comp_size, uint64_t start, uint64_t end);
536 * Flags to control how layouts are retrieved.
539 /* Replace non-specified values with expected inherited values. */
540 #define LAYOUT_GET_EXPECTED 0x1
543 * Return a pointer to a newly-allocated opaque data structure containing
544 * the layout for the file at \a path. The pointer should be freed with
545 * llapi_layout_free() when it is no longer needed. Failure is indicated
546 * by a NULL return value and an appropriate error code stored in errno.
548 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
551 * Return a pointer to a newly-allocated opaque data type containing the
552 * layout for the file referenced by open file descriptor \a fd. The
553 * pointer should be freed with llapi_layout_free() when it is no longer
554 * needed. Failure is indicated by a NULL return value and an
555 * appropriate error code stored in errno.
557 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
560 * Return a pointer to a newly-allocated opaque data type containing the
561 * layout for the file associated with Lustre file identifier string
562 * \a fidstr. The string \a path must name a path within the
563 * filesystem that contains the file being looked up, such as the
564 * filesystem root. The returned pointer should be freed with
565 * llapi_layout_free() when it is no longer needed. Failure is
566 * indicated with a NULL return value and an appropriate error code
569 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
570 const struct lu_fid *fid,
574 * Allocate a new layout. Use this when creating a new file with
575 * llapi_layout_file_create().
577 struct llapi_layout *llapi_layout_alloc(void);
580 * Free memory allocated for \a layout.
582 void llapi_layout_free(struct llapi_layout *layout);
585 * llapi_layout_merge() - Merge a composite layout into another one.
586 * @dst_layout: Destination composite layout.
587 * @src_layout: Source composite layout.
589 * This function copies all of the components from @src_layout and
590 * appends them to @dst_layout.
592 * Return: 0 on success or -1 on failure.
594 int llapi_layout_merge(struct llapi_layout **dst_layout,
595 const struct llapi_layout *src_layout);
597 /** Not a valid stripe size, offset, or RAID pattern. */
598 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
601 * When specified or returned as the value for stripe count,
602 * stripe size, offset, or RAID pattern, the filesystem-wide
603 * default behavior will apply.
605 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
608 * When specified or returned as the value for stripe count, all
609 * available OSTs will be used.
611 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
614 * When specified as the value for layout pattern, file objects will be
615 * stored using RAID0. That is, data will be split evenly and without
616 * redundancy across all OSTs in the layout.
618 #define LLAPI_LAYOUT_RAID0 0ULL
619 #define LLAPI_LAYOUT_MDT 2ULL
622 * The layout includes a specific set of OSTs on which to allocate.
624 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
627 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
629 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
632 * Flags to modify how layouts are retrieved.
634 /******************** Stripe Count ********************/
637 * Store the stripe count of \a layout in \a count.
640 * \retval -1 Error with status code in errno.
642 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
646 * Set the stripe count of \a layout to \a count.
649 * \retval -1 Invalid argument, errno set to EINVAL.
651 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
653 /******************** Stripe Size ********************/
656 * Store the stripe size of \a layout in \a size.
659 * \retval -1 Invalid argument, errno set to EINVAL.
661 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
665 * Set the stripe size of \a layout to \a stripe_size.
668 * \retval -1 Invalid argument, errno set to EINVAL.
670 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
672 /******************** Stripe Pattern ********************/
675 * Store the stripe pattern of \a layout in \a pattern.
678 * \retval -1 Error with status code in errno.
680 int llapi_layout_pattern_get(const struct llapi_layout *layout,
684 * Set the stripe pattern of \a layout to \a pattern.
687 * \retval -1 Invalid argument, errno set to EINVAL.
689 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
691 /******************** OST Index ********************/
694 * Store the index of the OST where stripe number \a stripe_number is stored
697 * An error return value will result from a NULL layout, if \a
698 * stripe_number is out of range, or if \a layout was not initialized
699 * with llapi_layout_lookup_by{path,fd,fid}().
702 * \retval -1 Invalid argument, errno set to EINVAL.
704 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
705 uint64_t stripe_number, uint64_t *index);
708 * Set the OST index associated with stripe number \a stripe_number to
710 * NB: This is currently supported only for \a stripe_number = 0 and
711 * other usage will return ENOTSUPP in errno. A NULL \a layout or
712 * out-of-range \a stripe_number will return EINVAL in errno.
715 * \retval -1 Error with errno set to non-zero value.
717 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
720 /******************** Pool Name ********************/
723 * Store up to \a pool_name_len characters of the name of the pool of
724 * OSTs associated with \a layout into the buffer pointed to by
727 * The correct calling form is:
729 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
731 * A pool defines a set of OSTs from which file objects may be
732 * allocated for a file using \a layout.
734 * On success, the number of bytes stored is returned, excluding the
735 * terminating '\0' character (zero indicates that \a layout does not
736 * have an associated OST pool). On error, -1 is returned and errno is
737 * set appropriately. Possible sources of error include a NULL pointer
738 * argument or insufficient space in \a dest to store the pool name,
739 * in which cases errno will be set to EINVAL.
741 * \retval 0+ The number of bytes stored in \a dest.
742 * \retval -1 Invalid argument, errno set to EINVAL.
744 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
745 char *pool_name, size_t pool_name_len);
748 * Set the name of the pool of OSTs from which file objects will be
749 * allocated to \a pool_name.
751 * If the pool name uses "fsname.pool" notation to qualify the pool name
752 * with a filesystem name, the "fsname." portion will be silently
753 * discarded before storing the value. No validation that \a pool_name
754 * is an existing non-empty pool in filesystem \a fsname will be
755 * performed. Such validation can be performed by the application if
756 * desired using the llapi_search_ost() function. The maximum length of
757 * the stored value is defined by the constant LOV_MAXPOOLNAME.
760 * \retval -1 Invalid argument, errno set to EINVAL.
762 int llapi_layout_pool_name_set(struct llapi_layout *layout,
763 const char *pool_name);
765 /******************** File Creation ********************/
768 * Open an existing file at \a path, or create it with the specified
769 * \a layout and \a mode.
771 * One access mode and zero or more file creation flags and file status
772 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
773 * open file descriptor for the file. If \a layout is non-NULL and
774 * \a path is not on a Lustre filesystem this function will fail and set
777 * An already existing file may be opened with this function, but
778 * \a layout and \a mode will not be applied to it. Callers requiring a
779 * guarantee that the opened file is created with the specified
780 * \a layout and \a mode should use llapi_layout_file_create().
782 * A NULL \a layout may be specified, in which case the standard Lustre
783 * behavior for assigning layouts to newly-created files will apply.
785 * \retval 0+ An open file descriptor.
786 * \retval -1 Error with status code in errno.
788 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
789 const struct llapi_layout *layout);
792 * Create a new file at \a path with the specified \a layout and \a mode.
794 * One access mode and zero or more file creation flags and file status
795 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
796 * open file descriptor for the file. If \a layout is non-NULL and
797 * \a path is not on a Lustre filesystem this function will fail and set
802 * llapi_layout_file_create(path, open_flags, mode, layout)
804 * shall be equivalent to:
806 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
808 * It is an error if \a path specifies an existing file.
810 * A NULL \a layout may be specified, in which the standard Lustre
811 * behavior for assigning layouts to newly-created files will apply.
813 * \retval 0+ An open file descriptor.
814 * \retval -1 Error with status code in errno.
816 int llapi_layout_file_create(const char *path, int open_flags, int mode,
817 const struct llapi_layout *layout);
820 * Set flags to the header of component layout.
822 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
823 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
824 const char *llapi_layout_flags_string(uint32_t flags);
825 const __u16 llapi_layout_string_flags(char *string);
828 * llapi_layout_mirror_count_get() - Get mirror count from the header of
830 * @layout: Layout to get mirror count from.
831 * @count: Returned mirror count value.
833 * This function gets mirror count from the header of a layout.
835 * Return: 0 on success or -1 on failure.
837 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
841 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
842 * @layout: Layout to set mirror count in.
843 * @count: Mirror count value to be set.
845 * This function sets mirror count to the header of a layout.
847 * Return: 0 on success or -1 on failure.
849 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
853 * Fetch the start and end offset of the current layout component.
855 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
856 uint64_t *start, uint64_t *end);
858 * Set the extent of current layout component.
860 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
861 uint64_t start, uint64_t end);
863 /* PFL component flags table */
864 static const struct comp_flag_name {
865 enum lov_comp_md_entry_flags cfn_flag;
866 const char *cfn_name;
867 } comp_flags_table[] = {
868 { LCME_FL_INIT, "init" },
869 { LCME_FL_STALE, "stale" },
870 { LCME_FL_PREF_RW, "prefer" },
871 { LCME_FL_OFFLINE, "offline" },
875 * Gets the attribute flags of the current component.
877 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
880 * Sets the specified flags of the current component leaving other flags as-is.
882 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
884 * Clears the flags specified in the flags leaving other flags as-is.
886 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
888 * Fetches the file-unique component ID of the current layout component.
890 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
892 * Fetches the mirror ID of the current layout component.
894 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
896 * Adds one component to the existing composite or plain layout.
898 int llapi_layout_comp_add(struct llapi_layout *layout);
900 * Adds a first component of a mirror to the existing composite layout.
902 int llapi_layout_add_first_comp(struct llapi_layout *layout);
904 * Deletes the current layout component from the composite layout.
906 int llapi_layout_comp_del(struct llapi_layout *layout);
908 enum llapi_layout_comp_use {
909 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
910 LLAPI_LAYOUT_COMP_USE_LAST = 2,
911 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
912 LLAPI_LAYOUT_COMP_USE_PREV = 4,
916 * Set the currently active component to the specified component ID.
918 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
920 * Select the currently active component at the specified position.
922 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
924 * Add layout components to an existing file.
926 int llapi_layout_file_comp_add(const char *path,
927 const struct llapi_layout *layout);
929 * Delete component(s) by the specified component id or flags.
931 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
933 * Change flags or other parameters of the component(s) by component ID of an
934 * existing file. The component to be modified is specified by the
935 * comp->lcme_id value, which must be an unique component ID. The new
936 * attributes are passed in by @comp and @valid is used to specify which
937 * attributes in the component are going to be changed.
939 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
942 * Check if the file layout is composite.
944 bool llapi_layout_is_composite(struct llapi_layout *layout);
947 LLAPI_LAYOUT_ITER_CONT = 0,
948 LLAPI_LAYOUT_ITER_STOP = 1,
952 * Iteration callback function.
954 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
955 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
956 * \retval < 0 error code
958 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
961 * Iterate all components in the corresponding layout
963 int llapi_layout_comp_iterate(struct llapi_layout *layout,
964 llapi_layout_iter_cb cb, void *cbdata);
967 * FLR: mirror operation APIs
969 int llapi_mirror_set(int fd, unsigned int id);
970 int llapi_mirror_clear(int fd);
971 ssize_t llapi_mirror_read(int fd, unsigned int id,
972 void *buf, size_t count, off_t pos);
973 ssize_t llapi_mirror_copy_many(int fd, unsigned int src,
974 unsigned int *dst, size_t count);
975 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
976 off_t pos, size_t count);
980 #if defined(__cplusplus)