4 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License version 2 for more details (a copy is included
14 * in the LICENSE file that accompanied this code).
16 * You should have received a copy of the GNU General Public License
17 * version 2 along with this program; If not, see
18 * http://www.gnu.org/licenses/gpl-2.0.html
23 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
24 * Use is subject to license terms.
26 * Copyright (c) 2011, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
36 /** \defgroup llapi llapi
43 #include <lustre/lustre_user.h>
46 #define LL_MAXQUOTAS 2
49 extern bool liblustreapi_initialized;
52 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
55 /* lustreapi message severity level */
56 enum llapi_message_level {
67 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
68 const char *fmt, va_list ap);
71 /* the bottom three bits reserved for llapi_message_level */
72 #define LLAPI_MSG_MASK 0x00000007
73 #define LLAPI_MSG_NO_ERRNO 0x00000010
75 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
77 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
81 if (level >= LLAPI_MSG_MAX)
86 extern void llapi_msg_set_level(int level);
87 int llapi_msg_get_level(void);
88 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
89 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
91 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
92 __attribute__((__format__(__printf__, 3, 4)));
93 #define llapi_err_noerrno(level, fmt, a...) \
94 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
95 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
96 __attribute__((__format__(__printf__, 2, 3)));
98 struct llapi_stripe_param {
99 unsigned long long lsp_stripe_size;
101 int lsp_stripe_offset;
102 int lsp_stripe_pattern;
103 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
104 int lsp_stripe_count;
105 bool lsp_is_specific;
109 extern int llapi_file_open_param(const char *name, int flags, mode_t mode,
110 const struct llapi_stripe_param *param);
111 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
112 int stripe_offset, int stripe_count,
114 extern int llapi_file_open(const char *name, int flags, int mode,
115 unsigned long long stripe_size, int stripe_offset,
116 int stripe_count, int stripe_pattern);
117 extern int llapi_file_create_pool(const char *name,
118 unsigned long long stripe_size,
119 int stripe_offset, int stripe_count,
120 int stripe_pattern, char *pool_name);
121 extern int llapi_file_open_pool(const char *name, int flags, int mode,
122 unsigned long long stripe_size,
123 int stripe_offset, int stripe_count,
124 int stripe_pattern, char *pool_name);
125 extern int llapi_poollist(const char *name);
126 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
127 char *buffer, int buffer_size);
128 extern int llapi_get_poolmembers(const char *poolname, char **members,
129 int list_size, char *buffer, int buffer_size);
130 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
131 #define HAVE_LLAPI_FILE_LOOKUP
132 extern int llapi_file_lookup(int dirfd, const char *name);
134 #define VERBOSE_COUNT 0x1
135 #define VERBOSE_SIZE 0x2
136 #define VERBOSE_OFFSET 0x4
137 #define VERBOSE_POOL 0x8
138 #define VERBOSE_DETAIL 0x10
139 #define VERBOSE_OBJID 0x20
140 #define VERBOSE_GENERATION 0x40
141 #define VERBOSE_MDTINDEX 0x80
142 #define VERBOSE_LAYOUT 0x100
143 #define VERBOSE_COMP_COUNT 0x200
144 #define VERBOSE_COMP_FLAGS 0x400
145 #define VERBOSE_COMP_START 0x800
146 #define VERBOSE_COMP_END 0x1000
147 #define VERBOSE_COMP_ID 0x2000
148 #define VERBOSE_DFID 0x4000
149 #define VERBOSE_HASH_TYPE 0x8000
150 #define VERBOSE_DEFAULT (VERBOSE_COUNT | VERBOSE_SIZE | \
151 VERBOSE_OFFSET | VERBOSE_POOL | \
152 VERBOSE_OBJID | VERBOSE_GENERATION | \
153 VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
154 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
155 VERBOSE_COMP_START | VERBOSE_COMP_END | \
159 unsigned int fp_max_depth;
161 mode_t fp_type; /* S_IFIFO,... */
167 /* {a,m,c}sign cannot be bitfields due to using pointers to
168 * access them during argument parsing. */
172 /* these need to be signed values */
174 fp_stripe_size_sign:2,
175 fp_stripe_count_sign:2,
176 fp_comp_start_sign:2,
178 fp_comp_count_sign:2;
179 unsigned long long fp_size;
180 unsigned long long fp_size_units;
182 unsigned long long fp_zero_end:1,
184 fp_exclude_pattern:1,
192 fp_check_pool:1, /* LOV pool name */
193 fp_check_size:1, /* file size */
199 fp_get_lmv:1, /* get MDT list from LMV */
200 fp_raw:1, /* do not fill in defaults */
201 fp_check_stripe_size:1, /* LOV stripe size */
202 fp_exclude_stripe_size:1,
203 fp_check_stripe_count:1, /* LOV stripe count */
204 fp_exclude_stripe_count:1,
207 fp_get_default_lmv:1, /* Get default LMV */
209 fp_check_comp_count:1,
210 fp_exclude_comp_count:1,
211 fp_check_comp_flags:1,
212 fp_exclude_comp_flags:1,
213 fp_check_comp_start:1,
214 fp_exclude_comp_start:1,
216 fp_exclude_comp_end:1,
218 fp_exclude_comp_id:1;
223 /* regular expression */
226 struct obd_uuid *fp_obd_uuid;
228 int fp_num_alloc_obds;
232 struct obd_uuid *fp_mdt_uuid;
234 int fp_num_alloc_mdts;
237 int fp_file_mdt_index;
240 struct lov_user_mds_data *fp_lmd;
242 char fp_poolname[LOV_MAXPOOLNAME + 1];
244 __u32 fp_lmv_stripe_count;
245 struct lmv_user_md *fp_lmv_md;
247 unsigned long long fp_stripe_size;
248 unsigned long long fp_stripe_size_units;
249 unsigned long long fp_stripe_count;
255 unsigned long long fp_comp_start;
256 unsigned long long fp_comp_start_units;
257 unsigned long long fp_comp_end;
258 unsigned long long fp_comp_end_units;
260 /* In-process parameters. */
261 unsigned long fp_got_uuids:1,
263 unsigned int fp_depth;
266 extern int llapi_ostlist(char *path, struct find_param *param);
267 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
268 extern int llapi_getstripe(char *path, struct find_param *param);
269 extern int llapi_find(char *path, struct find_param *param);
271 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
272 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
273 int stripe_count, int stripe_pattern,
274 const char *pool_name);
275 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
276 int stripe_count, int stripe_pattern,
277 const char *poolname);
278 int llapi_direntry_remove(char *dname);
280 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
281 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
282 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
283 struct obd_statfs *stat_buf,
284 struct obd_uuid *uuid_buf);
285 extern int llapi_ping(char *obd_type, char *obd_name);
286 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
287 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
288 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
289 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
290 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
291 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
292 extern int llapi_is_lustre_mnttype(const char *type);
293 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
294 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
295 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
296 unsigned long long *size_units, int bytes_spec);
297 extern int llapi_search_mounts(const char *pathname, int index,
298 char *mntdir, char *fsname);
299 extern int llapi_search_fsname(const char *pathname, char *fsname);
300 extern int llapi_getname(const char *path, char *buf, size_t size);
301 extern int llapi_search_fileset(const char *pathname, char *fileset);
303 extern int llapi_search_rootpath(char *pathname, const char *fsname);
304 extern int llapi_nodemap_exists(const char *name);
305 extern int llapi_migrate_mdt(char *path, struct find_param *param);
306 extern int llapi_mv(char *path, struct find_param *param);
309 #define HAVE_LLAPI_IS_LUSTRE_MNT
310 extern int llapi_is_lustre_mnt(struct mntent *mnt);
311 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
312 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
314 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
315 extern int llapi_cp(int argc, char *argv[]);
316 extern int llapi_ls(int argc, char *argv[]);
317 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
318 int pathlen, long long *recno, int *linkno);
319 extern int llapi_path2fid(const char *path, lustre_fid *fid);
320 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
322 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
323 /* get FID of parent dir + the related name of entry in this parent dir */
324 extern int llapi_path2parent(const char *path, unsigned int linkno,
325 lustre_fid *parent_fid, char *name,
327 extern int llapi_fd2parent(int fd, unsigned int linkno,
328 lustre_fid *parent_fid, char *name,
330 extern int llapi_chomp_string(char *buf);
331 extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid,
334 extern int llapi_get_version_string(char *version, unsigned int version_size);
335 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
336 extern int llapi_get_version(char *buffer, int buffer_size, char **version)
337 __attribute__((deprecated));
338 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
339 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
340 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
341 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
343 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
345 extern int llapi_hsm_register_event_fifo(const char *path);
346 extern int llapi_hsm_unregister_event_fifo(const char *path);
347 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
348 const char *fmt, va_list args);
350 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
351 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
352 static inline int llapi_create_volatile(char *directory, int mode)
354 return llapi_create_volatile_idx(directory, -1, mode);
358 extern int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
359 int gid, __u64 flags);
360 extern int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2,
362 extern int llapi_swap_layouts(const char *path1, const char *path2,
363 __u64 dv1, __u64 dv2, __u64 flags);
365 /* Changelog interface. priv is private state, managed internally by these
368 /* Records received are in extended format now, though most of them are still
369 * written in disk in changelog_rec format (to save space and time), it's
370 * converted to extended format in the lustre api to ease changelog analysis. */
371 #define HAVE_CHANGELOG_EXTEND_REC 1
373 extern int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
374 const char *mdtname, long long startrec);
375 extern int llapi_changelog_fini(void **priv);
376 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
377 extern int llapi_changelog_free(struct changelog_rec **rech);
378 extern int llapi_changelog_get_fd(void *priv);
379 /* Allow records up to endrec to be destroyed; requires registered id. */
380 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
383 /* HSM copytool interface.
384 * priv is private state, managed internally by these functions
386 struct hsm_copytool_private;
387 struct hsm_copyaction_private;
389 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
390 const char *mnt, int archive_count,
391 int *archives, int rfd_flags);
392 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
393 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
394 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
395 struct hsm_action_list **hal, int *msgsize);
396 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
397 const struct hsm_copytool_private *ct,
398 const struct hsm_action_item *hai,
399 int restore_mdt_index, int restore_open_flags,
401 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
402 const struct hsm_extent *he,
403 int hp_flags, int errval);
404 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
405 const struct hsm_extent *he, __u64 total,
407 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
409 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
410 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
411 unsigned long long stripe_size, int stripe_offset,
412 int stripe_count, int stripe_pattern,
413 char *pool_name, lustre_fid *newfid);
415 /* HSM user interface */
416 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
418 extern int llapi_hsm_request(const char *path,
419 const struct hsm_user_request *request);
420 extern int llapi_hsm_current_action(const char *path,
421 struct hsm_current_action *hca);
424 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
425 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
426 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
427 char *key, __u32 type, void *val);
428 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
432 extern int llapi_lease_get(int fd, int mode);
433 extern int llapi_lease_check(int fd);
434 extern int llapi_lease_put(int fd);
437 int llapi_group_lock(int fd, int gid);
438 int llapi_group_unlock(int fd, int gid);
441 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
442 struct llapi_lu_ladvise *ladvise);
445 /* llapi_layout user interface */
447 /** Opaque data type abstracting the layout of a Lustre file. */
451 * Flags to control how layouts are retrieved.
454 /* Replace non-specified values with expected inherited values. */
455 #define LAYOUT_GET_EXPECTED 0x1
458 * Return a pointer to a newly-allocated opaque data structure containing
459 * the layout for the file at \a path. The pointer should be freed with
460 * llapi_layout_free() when it is no longer needed. Failure is indicated
461 * by a NULL return value and an appropriate error code stored in errno.
463 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
466 * Return a pointer to a newly-allocated opaque data type containing the
467 * layout for the file referenced by open file descriptor \a fd. The
468 * pointer should be freed with llapi_layout_free() when it is no longer
469 * needed. Failure is indicated by a NULL return value and an
470 * appropriate error code stored in errno.
472 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
475 * Return a pointer to a newly-allocated opaque data type containing the
476 * layout for the file associated with Lustre file identifier string
477 * \a fidstr. The string \a path must name a path within the
478 * filesystem that contains the file being looked up, such as the
479 * filesystem root. The returned pointer should be freed with
480 * llapi_layout_free() when it is no longer needed. Failure is
481 * indicated with a NULL return value and an appropriate error code
484 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
485 const lustre_fid *fid,
489 * Allocate a new layout. Use this when creating a new file with
490 * llapi_layout_file_create().
492 struct llapi_layout *llapi_layout_alloc(void);
495 * Free memory allocated for \a layout.
497 void llapi_layout_free(struct llapi_layout *layout);
499 /** Not a valid stripe size, offset, or RAID pattern. */
500 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
503 * When specified or returned as the value for stripe count,
504 * stripe size, offset, or RAID pattern, the filesystem-wide
505 * default behavior will apply.
507 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
510 * When specified or returned as the value for stripe count, all
511 * available OSTs will be used.
513 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
516 * When specified as the value for layout pattern, file objects will be
517 * stored using RAID0. That is, data will be split evenly and without
518 * redundancy across all OSTs in the layout.
520 #define LLAPI_LAYOUT_RAID0 0
523 * The layout includes a specific set of OSTs on which to allocate.
525 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
528 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
530 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
533 * Flags to modify how layouts are retrieved.
535 /******************** Stripe Count ********************/
538 * Store the stripe count of \a layout in \a count.
541 * \retval -1 Error with status code in errno.
543 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
547 * Set the stripe count of \a layout to \a count.
550 * \retval -1 Invalid argument, errno set to EINVAL.
552 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
554 /******************** Stripe Size ********************/
557 * Store the stripe size of \a layout in \a size.
560 * \retval -1 Invalid argument, errno set to EINVAL.
562 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
566 * Set the stripe size of \a layout to \a stripe_size.
569 * \retval -1 Invalid argument, errno set to EINVAL.
571 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
573 /******************** Stripe Pattern ********************/
576 * Store the stripe pattern of \a layout in \a pattern.
579 * \retval -1 Error with status code in errno.
581 int llapi_layout_pattern_get(const struct llapi_layout *layout,
585 * Set the stripe pattern of \a layout to \a pattern.
588 * \retval -1 Invalid argument, errno set to EINVAL.
590 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
592 /******************** OST Index ********************/
595 * Store the index of the OST where stripe number \a stripe_number is stored
598 * An error return value will result from a NULL layout, if \a
599 * stripe_number is out of range, or if \a layout was not initialized
600 * with llapi_layout_lookup_by{path,fd,fid}().
603 * \retval -1 Invalid argument, errno set to EINVAL.
605 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
606 uint64_t stripe_number, uint64_t *index);
609 * Set the OST index associated with stripe number \a stripe_number to
611 * NB: This is currently supported only for \a stripe_number = 0 and
612 * other usage will return ENOTSUPP in errno. A NULL \a layout or
613 * out-of-range \a stripe_number will return EINVAL in errno.
616 * \retval -1 Error with errno set to non-zero value.
618 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
621 /******************** Pool Name ********************/
624 * Store up to \a pool_name_len characters of the name of the pool of
625 * OSTs associated with \a layout into the buffer pointed to by
628 * The correct calling form is:
630 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
632 * A pool defines a set of OSTs from which file objects may be
633 * allocated for a file using \a layout.
635 * On success, the number of bytes stored is returned, excluding the
636 * terminating '\0' character (zero indicates that \a layout does not
637 * have an associated OST pool). On error, -1 is returned and errno is
638 * set appropriately. Possible sources of error include a NULL pointer
639 * argument or insufficient space in \a dest to store the pool name,
640 * in which cases errno will be set to EINVAL.
642 * \retval 0+ The number of bytes stored in \a dest.
643 * \retval -1 Invalid argument, errno set to EINVAL.
645 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
646 char *pool_name, size_t pool_name_len);
649 * Set the name of the pool of OSTs from which file objects will be
650 * allocated to \a pool_name.
652 * If the pool name uses "fsname.pool" notation to qualify the pool name
653 * with a filesystem name, the "fsname." portion will be silently
654 * discarded before storing the value. No validation that \a pool_name
655 * is an existing non-empty pool in filesystem \a fsname will be
656 * performed. Such validation can be performed by the application if
657 * desired using the llapi_search_ost() function. The maximum length of
658 * the stored value is defined by the constant LOV_MAXPOOLNAME.
661 * \retval -1 Invalid argument, errno set to EINVAL.
663 int llapi_layout_pool_name_set(struct llapi_layout *layout,
664 const char *pool_name);
666 /******************** File Creation ********************/
669 * Open an existing file at \a path, or create it with the specified
670 * \a layout and \a mode.
672 * One access mode and zero or more file creation flags and file status
673 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
674 * open file descriptor for the file. If \a layout is non-NULL and
675 * \a path is not on a Lustre filesystem this function will fail and set
678 * An already existing file may be opened with this function, but
679 * \a layout and \a mode will not be applied to it. Callers requiring a
680 * guarantee that the opened file is created with the specified
681 * \a layout and \a mode should use llapi_layout_file_create().
683 * A NULL \a layout may be specified, in which case the standard Lustre
684 * behavior for assigning layouts to newly-created files will apply.
686 * \retval 0+ An open file descriptor.
687 * \retval -1 Error with status code in errno.
689 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
690 const struct llapi_layout *layout);
693 * Create a new file at \a path with the specified \a layout and \a mode.
695 * One access mode and zero or more file creation flags and file status
696 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
697 * open file descriptor for the file. If \a layout is non-NULL and
698 * \a path is not on a Lustre filesystem this function will fail and set
703 * llapi_layout_file_create(path, open_flags, mode, layout)
705 * shall be equivalent to:
707 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
709 * It is an error if \a path specifies an existing file.
711 * A NULL \a layout may be specified, in which the standard Lustre
712 * behavior for assigning layouts to newly-created files will apply.
714 * \retval 0+ An open file descriptor.
715 * \retval -1 Error with status code in errno.
717 int llapi_layout_file_create(const char *path, int open_flags, int mode,
718 const struct llapi_layout *layout);
721 * Fetch the start and end offset of the current layout component.
723 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
724 uint64_t *start, uint64_t *end);
726 * Set the extent of current layout component.
728 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
729 uint64_t start, uint64_t end);
731 * Gets the attribute flags of the current component.
733 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
736 * Sets the specified flags of the current component leaving other flags as-is.
738 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
740 * Clears the flags specified in the flags leaving other flags as-is.
742 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
744 * Fetches the file-unique component ID of the current layout component.
746 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
748 * Adds one component to the existing composite or plain layout.
750 int llapi_layout_comp_add(struct llapi_layout *layout);
752 * Deletes the current layout component from the composite layout.
754 int llapi_layout_comp_del(struct llapi_layout *layout);
757 LLAPI_LAYOUT_COMP_POS_NEXT = 0,
758 LLAPI_LAYOUT_COMP_POS_FIRST = 1,
759 LLAPI_LAYOUT_COMP_POS_LAST = 2
763 * Move the current component pointer by specified component ID.
765 int llapi_layout_comp_move_at(struct llapi_layout *layout, uint32_t id);
767 * Move the current component pointer to a specified position.
769 int llapi_layout_comp_move(struct llapi_layout *layout, uint32_t pos);
771 * Add layout components to an existing file.
773 int llapi_layout_file_comp_add(const char *path,
774 const struct llapi_layout *layout);
776 * Delete component(s) by the specified component id (accepting lcme_id
777 * wildcards also) from an existing file.
779 int llapi_layout_file_comp_del(const char *path, uint32_t id);
781 * Change flags or other parameters of the component(s) by component ID of an
782 * existing file. The component to be modified is specified by the
783 * comp->lcme_id value, which must be an unique component ID. The new
784 * attributes are passed in by @comp and @valid is used to specify which
785 * attributes in the component are going to be changed.
787 int llapi_layout_file_comp_set(const char *path,
788 const struct llapi_layout *comp,