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 3
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 extern int llapi_file_lookup(int dirfd, const char *name);
133 #define VERBOSE_COUNT 0x1
134 #define VERBOSE_SIZE 0x2
135 #define VERBOSE_OFFSET 0x4
136 #define VERBOSE_POOL 0x8
137 #define VERBOSE_DETAIL 0x10
138 #define VERBOSE_OBJID 0x20
139 #define VERBOSE_GENERATION 0x40
140 #define VERBOSE_MDTINDEX 0x80
141 #define VERBOSE_LAYOUT 0x100
142 #define VERBOSE_COMP_COUNT 0x200
143 #define VERBOSE_COMP_FLAGS 0x400
144 #define VERBOSE_COMP_START 0x800
145 #define VERBOSE_COMP_END 0x1000
146 #define VERBOSE_COMP_ID 0x2000
147 #define VERBOSE_DFID 0x4000
148 #define VERBOSE_HASH_TYPE 0x8000
149 #define VERBOSE_DEFAULT (VERBOSE_COUNT | VERBOSE_SIZE | \
150 VERBOSE_OFFSET | VERBOSE_POOL | \
151 VERBOSE_OBJID | VERBOSE_GENERATION | \
152 VERBOSE_LAYOUT | VERBOSE_HASH_TYPE | \
153 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS | \
154 VERBOSE_COMP_START | VERBOSE_COMP_END | \
158 unsigned int fp_max_depth;
160 mode_t fp_type; /* S_IFIFO,... */
166 /* {a,m,c}sign cannot be bitfields due to using pointers to
167 * access them during argument parsing. */
171 /* these need to be signed values */
173 fp_stripe_size_sign:2,
174 fp_stripe_count_sign:2,
175 fp_comp_start_sign:2,
177 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 */
211 fp_check_comp_count:1,
212 fp_exclude_comp_count:1,
213 fp_check_comp_flags:1,
214 fp_exclude_comp_flags:1,
215 fp_check_comp_start:1,
216 fp_exclude_comp_start:1,
218 fp_exclude_comp_end:1,
220 fp_exclude_comp_id:1,
221 fp_check_mdt_count:1,
222 fp_exclude_mdt_count:1,
223 fp_check_hash_type:1,
224 fp_exclude_hash_type:1;
229 /* regular expression */
232 struct obd_uuid *fp_obd_uuid;
234 int fp_num_alloc_obds;
238 struct obd_uuid *fp_mdt_uuid;
240 int fp_num_alloc_mdts;
243 int fp_file_mdt_index;
246 struct lov_user_mds_data *fp_lmd;
248 char fp_poolname[LOV_MAXPOOLNAME + 1];
250 __u32 fp_lmv_stripe_count;
251 struct lmv_user_md *fp_lmv_md;
253 unsigned long long fp_stripe_size;
254 unsigned long long fp_stripe_size_units;
255 unsigned long long fp_stripe_count;
261 unsigned long long fp_comp_start;
262 unsigned long long fp_comp_start_units;
263 unsigned long long fp_comp_end;
264 unsigned long long fp_comp_end_units;
265 unsigned long long fp_mdt_count;
268 /* In-process parameters. */
269 unsigned long fp_got_uuids:1,
271 unsigned int fp_depth;
272 unsigned int fp_hash_type;
275 extern int llapi_ostlist(char *path, struct find_param *param);
276 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
277 extern int llapi_getstripe(char *path, struct find_param *param);
278 extern int llapi_find(char *path, struct find_param *param);
280 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
281 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
282 int stripe_count, int stripe_pattern,
283 const char *pool_name);
284 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
285 int stripe_count, int stripe_pattern,
286 const char *poolname);
287 int llapi_direntry_remove(char *dname);
289 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
290 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
291 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
292 struct obd_statfs *stat_buf,
293 struct obd_uuid *uuid_buf);
294 extern int llapi_ping(char *obd_type, char *obd_name);
295 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
296 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
297 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
298 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
299 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
300 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
301 extern int llapi_is_lustre_mnttype(const char *type);
302 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
303 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
304 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
305 unsigned long long *size_units, int bytes_spec);
306 extern int llapi_search_mounts(const char *pathname, int index,
307 char *mntdir, char *fsname);
308 extern int llapi_search_fsname(const char *pathname, char *fsname);
309 extern int llapi_getname(const char *path, char *buf, size_t size);
310 extern int llapi_search_fileset(const char *pathname, char *fileset);
312 extern int llapi_search_rootpath(char *pathname, const char *fsname);
313 extern int llapi_nodemap_exists(const char *name);
314 extern int llapi_migrate_mdt(char *path, struct find_param *param);
315 extern int llapi_mv(char *path, struct find_param *param);
318 #define HAVE_LLAPI_IS_LUSTRE_MNT
319 extern int llapi_is_lustre_mnt(struct mntent *mnt);
320 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
321 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
323 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
324 extern int llapi_cp(int argc, char *argv[]);
325 extern int llapi_ls(int argc, char *argv[]);
326 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
327 int pathlen, long long *recno, int *linkno);
328 extern int llapi_path2fid(const char *path, lustre_fid *fid);
329 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
331 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
332 /* get FID of parent dir + the related name of entry in this parent dir */
333 extern int llapi_path2parent(const char *path, unsigned int linkno,
334 lustre_fid *parent_fid, char *name,
336 extern int llapi_fd2parent(int fd, unsigned int linkno,
337 lustre_fid *parent_fid, char *name,
339 extern int llapi_chomp_string(char *buf);
340 extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid,
343 extern int llapi_get_version_string(char *version, unsigned int version_size);
344 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
345 extern int llapi_get_version(char *buffer, int buffer_size, char **version)
346 __attribute__((deprecated));
347 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
348 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
349 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
350 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
352 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
354 extern int llapi_hsm_register_event_fifo(const char *path);
355 extern int llapi_hsm_unregister_event_fifo(const char *path);
356 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
357 const char *fmt, va_list args);
359 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
360 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
361 static inline int llapi_create_volatile(char *directory, int mode)
363 return llapi_create_volatile_idx(directory, -1, mode);
367 extern int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
368 int gid, __u64 flags);
369 extern int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2,
371 extern int llapi_swap_layouts(const char *path1, const char *path2,
372 __u64 dv1, __u64 dv2, __u64 flags);
374 /* Changelog interface. priv is private state, managed internally by these
377 /* Records received are in extended format now, though most of them are still
378 * written in disk in changelog_rec format (to save space and time), it's
379 * converted to extended format in the lustre api to ease changelog analysis. */
380 #define HAVE_CHANGELOG_EXTEND_REC 1
382 extern int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
383 const char *mdtname, long long startrec);
384 extern int llapi_changelog_fini(void **priv);
385 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
386 extern int llapi_changelog_free(struct changelog_rec **rech);
387 extern int llapi_changelog_get_fd(void *priv);
388 /* Allow records up to endrec to be destroyed; requires registered id. */
389 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
392 /* HSM copytool interface.
393 * priv is private state, managed internally by these functions
395 struct hsm_copytool_private;
396 struct hsm_copyaction_private;
398 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
399 const char *mnt, int archive_count,
400 int *archives, int rfd_flags);
401 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
402 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
403 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
404 struct hsm_action_list **hal, int *msgsize);
405 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
406 const struct hsm_copytool_private *ct,
407 const struct hsm_action_item *hai,
408 int restore_mdt_index, int restore_open_flags,
410 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
411 const struct hsm_extent *he,
412 int hp_flags, int errval);
413 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
414 const struct hsm_extent *he, __u64 total,
416 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
418 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
419 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
420 unsigned long long stripe_size, int stripe_offset,
421 int stripe_count, int stripe_pattern,
422 char *pool_name, lustre_fid *newfid);
424 /* HSM user interface */
425 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
427 extern int llapi_hsm_request(const char *path,
428 const struct hsm_user_request *request);
429 extern int llapi_hsm_current_action(const char *path,
430 struct hsm_current_action *hca);
433 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
434 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
435 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
436 char *key, __u32 type, void *val);
437 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
441 extern int llapi_lease_get(int fd, int mode);
442 extern int llapi_lease_check(int fd);
443 extern int llapi_lease_put(int fd);
446 int llapi_group_lock(int fd, int gid);
447 int llapi_group_unlock(int fd, int gid);
450 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
451 struct llapi_lu_ladvise *ladvise);
454 /* llapi_layout user interface */
456 /** Opaque data type abstracting the layout of a Lustre file. */
460 * Flags to control how layouts are retrieved.
463 /* Replace non-specified values with expected inherited values. */
464 #define LAYOUT_GET_EXPECTED 0x1
467 * Return a pointer to a newly-allocated opaque data structure containing
468 * the layout for the file at \a path. The pointer should be freed with
469 * llapi_layout_free() when it is no longer needed. Failure is indicated
470 * by a NULL return value and an appropriate error code stored in errno.
472 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
475 * Return a pointer to a newly-allocated opaque data type containing the
476 * layout for the file referenced by open file descriptor \a fd. The
477 * pointer should be freed with llapi_layout_free() when it is no longer
478 * needed. Failure is indicated by a NULL return value and an
479 * appropriate error code stored in errno.
481 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
484 * Return a pointer to a newly-allocated opaque data type containing the
485 * layout for the file associated with Lustre file identifier string
486 * \a fidstr. The string \a path must name a path within the
487 * filesystem that contains the file being looked up, such as the
488 * filesystem root. The returned pointer should be freed with
489 * llapi_layout_free() when it is no longer needed. Failure is
490 * indicated with a NULL return value and an appropriate error code
493 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
494 const lustre_fid *fid,
498 * Allocate a new layout. Use this when creating a new file with
499 * llapi_layout_file_create().
501 struct llapi_layout *llapi_layout_alloc(void);
504 * Free memory allocated for \a layout.
506 void llapi_layout_free(struct llapi_layout *layout);
508 /** Not a valid stripe size, offset, or RAID pattern. */
509 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
512 * When specified or returned as the value for stripe count,
513 * stripe size, offset, or RAID pattern, the filesystem-wide
514 * default behavior will apply.
516 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
519 * When specified or returned as the value for stripe count, all
520 * available OSTs will be used.
522 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
525 * When specified as the value for layout pattern, file objects will be
526 * stored using RAID0. That is, data will be split evenly and without
527 * redundancy across all OSTs in the layout.
529 #define LLAPI_LAYOUT_RAID0 0
532 * The layout includes a specific set of OSTs on which to allocate.
534 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
537 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
539 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
542 * Flags to modify how layouts are retrieved.
544 /******************** Stripe Count ********************/
547 * Store the stripe count of \a layout in \a count.
550 * \retval -1 Error with status code in errno.
552 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
556 * Set the stripe count of \a layout to \a count.
559 * \retval -1 Invalid argument, errno set to EINVAL.
561 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
563 /******************** Stripe Size ********************/
566 * Store the stripe size of \a layout in \a size.
569 * \retval -1 Invalid argument, errno set to EINVAL.
571 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
575 * Set the stripe size of \a layout to \a stripe_size.
578 * \retval -1 Invalid argument, errno set to EINVAL.
580 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
582 /******************** Stripe Pattern ********************/
585 * Store the stripe pattern of \a layout in \a pattern.
588 * \retval -1 Error with status code in errno.
590 int llapi_layout_pattern_get(const struct llapi_layout *layout,
594 * Set the stripe pattern of \a layout to \a pattern.
597 * \retval -1 Invalid argument, errno set to EINVAL.
599 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
601 /******************** OST Index ********************/
604 * Store the index of the OST where stripe number \a stripe_number is stored
607 * An error return value will result from a NULL layout, if \a
608 * stripe_number is out of range, or if \a layout was not initialized
609 * with llapi_layout_lookup_by{path,fd,fid}().
612 * \retval -1 Invalid argument, errno set to EINVAL.
614 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
615 uint64_t stripe_number, uint64_t *index);
618 * Set the OST index associated with stripe number \a stripe_number to
620 * NB: This is currently supported only for \a stripe_number = 0 and
621 * other usage will return ENOTSUPP in errno. A NULL \a layout or
622 * out-of-range \a stripe_number will return EINVAL in errno.
625 * \retval -1 Error with errno set to non-zero value.
627 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
630 /******************** Pool Name ********************/
633 * Store up to \a pool_name_len characters of the name of the pool of
634 * OSTs associated with \a layout into the buffer pointed to by
637 * The correct calling form is:
639 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
641 * A pool defines a set of OSTs from which file objects may be
642 * allocated for a file using \a layout.
644 * On success, the number of bytes stored is returned, excluding the
645 * terminating '\0' character (zero indicates that \a layout does not
646 * have an associated OST pool). On error, -1 is returned and errno is
647 * set appropriately. Possible sources of error include a NULL pointer
648 * argument or insufficient space in \a dest to store the pool name,
649 * in which cases errno will be set to EINVAL.
651 * \retval 0+ The number of bytes stored in \a dest.
652 * \retval -1 Invalid argument, errno set to EINVAL.
654 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
655 char *pool_name, size_t pool_name_len);
658 * Set the name of the pool of OSTs from which file objects will be
659 * allocated to \a pool_name.
661 * If the pool name uses "fsname.pool" notation to qualify the pool name
662 * with a filesystem name, the "fsname." portion will be silently
663 * discarded before storing the value. No validation that \a pool_name
664 * is an existing non-empty pool in filesystem \a fsname will be
665 * performed. Such validation can be performed by the application if
666 * desired using the llapi_search_ost() function. The maximum length of
667 * the stored value is defined by the constant LOV_MAXPOOLNAME.
670 * \retval -1 Invalid argument, errno set to EINVAL.
672 int llapi_layout_pool_name_set(struct llapi_layout *layout,
673 const char *pool_name);
675 /******************** File Creation ********************/
678 * Open an existing file at \a path, or create it with the specified
679 * \a layout and \a mode.
681 * One access mode and zero or more file creation flags and file status
682 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
683 * open file descriptor for the file. If \a layout is non-NULL and
684 * \a path is not on a Lustre filesystem this function will fail and set
687 * An already existing file may be opened with this function, but
688 * \a layout and \a mode will not be applied to it. Callers requiring a
689 * guarantee that the opened file is created with the specified
690 * \a layout and \a mode should use llapi_layout_file_create().
692 * A NULL \a layout may be specified, in which case the standard Lustre
693 * behavior for assigning layouts to newly-created files will apply.
695 * \retval 0+ An open file descriptor.
696 * \retval -1 Error with status code in errno.
698 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
699 const struct llapi_layout *layout);
702 * Create a new file at \a path with the specified \a layout and \a mode.
704 * One access mode and zero or more file creation flags and file status
705 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
706 * open file descriptor for the file. If \a layout is non-NULL and
707 * \a path is not on a Lustre filesystem this function will fail and set
712 * llapi_layout_file_create(path, open_flags, mode, layout)
714 * shall be equivalent to:
716 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
718 * It is an error if \a path specifies an existing file.
720 * A NULL \a layout may be specified, in which the standard Lustre
721 * behavior for assigning layouts to newly-created files will apply.
723 * \retval 0+ An open file descriptor.
724 * \retval -1 Error with status code in errno.
726 int llapi_layout_file_create(const char *path, int open_flags, int mode,
727 const struct llapi_layout *layout);
730 * Fetch the start and end offset of the current layout component.
732 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
733 uint64_t *start, uint64_t *end);
735 * Set the extent of current layout component.
737 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
738 uint64_t start, uint64_t end);
740 * Gets the attribute flags of the current component.
742 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
745 * Sets the specified flags of the current component leaving other flags as-is.
747 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
749 * Clears the flags specified in the flags leaving other flags as-is.
751 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
753 * Fetches the file-unique component ID of the current layout component.
755 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
757 * Adds one component to the existing composite or plain layout.
759 int llapi_layout_comp_add(struct llapi_layout *layout);
761 * Deletes the current layout component from the composite layout.
763 int llapi_layout_comp_del(struct llapi_layout *layout);
765 enum llapi_layout_comp_use {
766 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
767 LLAPI_LAYOUT_COMP_USE_LAST = 2,
768 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
772 * Set the currently active component to the specified component ID.
774 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
776 * Select the currently active component at the specified position.
778 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
780 * Add layout components to an existing file.
782 int llapi_layout_file_comp_add(const char *path,
783 const struct llapi_layout *layout);
785 * Delete component(s) by the specified component id (accepting lcme_id
786 * wildcards also) from an existing file.
788 int llapi_layout_file_comp_del(const char *path, uint32_t id);
790 * Change flags or other parameters of the component(s) by component ID of an
791 * existing file. The component to be modified is specified by the
792 * comp->lcme_id value, which must be an unique component ID. The new
793 * attributes are passed in by @comp and @valid is used to specify which
794 * attributes in the component are going to be changed.
796 int llapi_layout_file_comp_set(const char *path,
797 const struct llapi_layout *comp,