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 fp_unused1_sign:2, /* Fields available to use*/
219 fp_unused2_sign:2, /* Once used we must add */
220 fp_unused3_sign:2, /* a separate flag field */
221 fp_unused4_sign:2; /* at end of the struct. */
222 unsigned long long fp_size;
223 unsigned long long fp_size_units;
225 unsigned long long fp_zero_end:1,
227 fp_exclude_pattern:1,
235 fp_check_pool:1, /* LOV pool name */
236 fp_check_size:1, /* file size */
242 fp_get_lmv:1, /* get MDT list from LMV */
243 fp_raw:1, /* do not fill in defaults */
244 fp_check_stripe_size:1, /* LOV stripe size */
245 fp_exclude_stripe_size:1,
246 fp_check_stripe_count:1, /* LOV stripe count */
247 fp_exclude_stripe_count:1,
250 fp_get_default_lmv:1, /* Get default LMV */
254 fp_check_comp_count:1,
255 fp_exclude_comp_count:1,
256 fp_check_mirror_count:1,
257 fp_exclude_mirror_count:1,
258 fp_check_comp_flags:1,
259 fp_check_mirror_state:1,
260 fp_check_comp_start:1,
261 fp_exclude_comp_start:1,
263 fp_exclude_comp_end:1,
265 fp_exclude_comp_id:1,
266 fp_check_mirror_id:1,
267 fp_exclude_mirror_id:1,
268 fp_check_mirror_index:1,
269 fp_exclude_mirror_index:1,
270 fp_check_mdt_count:1,
271 fp_exclude_mdt_count:1,
272 fp_check_hash_type:1,
273 fp_exclude_hash_type:1,
274 fp_yaml:1, /* output layout in YAML */
278 fp_exclude_foreign:1,
279 fp_check_ext_size:1, /* extension size */
280 fp_exclude_ext_size:1,
283 fp_unused_bit2:1, /* All of these unused bit */
284 fp_unused_bit3:1, /* fields available to use.*/
285 fp_unused_bit4:1, /* Once all unused fields */
286 fp_unused_bit5:1, /* are used we need to add */
287 fp_unused_bit6:1, /* a separate flag field at*/
288 fp_unused_bit7:1; /* the end of the struct. */
290 enum llapi_layout_verbose fp_verbose;
293 /* regular expression */
296 struct obd_uuid *fp_obd_uuid;
298 int fp_num_alloc_obds;
302 struct obd_uuid *fp_mdt_uuid;
304 int fp_num_alloc_mdts;
307 int fp_file_mdt_index;
310 struct lov_user_mds_data *fp_lmd;
312 char fp_poolname[LOV_MAXPOOLNAME + 1];
314 __u32 fp_lmv_stripe_count;
315 struct lmv_user_md *fp_lmv_md;
317 unsigned long long fp_stripe_size;
318 unsigned long long fp_stripe_size_units;
319 unsigned long long fp_stripe_count;
323 __u32 fp_mirror_count;
325 __u32 fp_comp_neg_flags;
326 __u16 fp_mirror_state;
327 __u16 fp_mirror_neg_state;
330 __u16 fp_mirror_index;
331 unsigned long long fp_comp_start;
332 unsigned long long fp_comp_start_units;
333 unsigned long long fp_comp_end;
334 unsigned long long fp_comp_end_units;
335 unsigned long long fp_mdt_count;
337 unsigned long long fp_blocks;
338 unsigned long long fp_blocks_units;
340 unsigned long fp_got_uuids:1,
342 unsigned int fp_depth;
343 unsigned int fp_hash_type;
344 unsigned int fp_time_margin; /* time margin in seconds */
345 __u32 fp_foreign_type;
346 unsigned long long fp_ext_size;
347 unsigned long long fp_ext_size_units;
350 int llapi_ostlist(char *path, struct find_param *param);
351 int llapi_uuid_match(char *real_uuid, char *search_uuid);
352 int llapi_getstripe(char *path, struct find_param *param);
353 int llapi_find(char *path, struct find_param *param);
355 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
356 int llapi_dir_set_default_lmv(const char *name,
357 const struct llapi_stripe_param *param);
358 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
359 int stripe_count, int stripe_pattern,
360 const char *pool_name);
361 int llapi_dir_create(const char *name, mode_t mode,
362 const struct llapi_stripe_param *param);
363 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
364 __u32 flags, const char *value);
365 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
366 int stripe_count, int stripe_pattern,
367 const char *poolname);
368 int llapi_direntry_remove(char *dname);
370 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
371 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
372 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
373 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
374 int llapi_ping(char *obd_type, char *obd_name);
375 int llapi_target_check(int num_types, char **obd_types, char *dir);
376 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
377 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
378 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
379 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
380 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
381 int llapi_is_lustre_mnttype(const char *type);
382 int llapi_search_tgt(const char *fsname, const char *poolname,
383 const char *tgtname, bool is_mdt);
384 int llapi_search_mdt(const char *fsname, const char *poolname,
385 const char *mdtname);
386 int llapi_search_ost(const char *fsname, const char *poolname,
387 const char *ostname);
388 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
389 int llapi_parse_size(const char *optarg, unsigned long long *size,
390 unsigned long long *size_units, int bytes_spec);
391 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
393 int llapi_search_fsname(const char *pathname, char *fsname);
394 int llapi_getname(const char *path, char *buf, size_t size);
395 int llapi_search_fileset(const char *pathname, char *fileset);
397 int llapi_search_rootpath(char *pathname, const char *fsname);
398 int llapi_nodemap_exists(const char *name);
399 int llapi_migrate_mdt(char *path, struct find_param *param);
400 int llapi_mv(char *path, struct find_param *param);
404 #define HAVE_LLAPI_IS_LUSTRE_MNT
405 int llapi_is_lustre_mnt(struct mntent *mnt);
406 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
407 int llapi_target_iterate(int type_num, char **obd_type, void *args,
409 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
410 int llapi_cp(int argc, char *argv[]);
411 int llapi_ls(int argc, char *argv[]);
412 int llapi_fid2path(const char *device, const char *fidstr, char *path,
413 int pathlen, long long *recno, int *linkno);
414 int llapi_path2fid(const char *path, struct lu_fid *fid);
415 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
417 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
418 struct lov_user_md *lum, size_t lumsize);
419 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
420 struct lov_user_md *lum, size_t lumsize);
421 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
422 lstatx_t *statx, struct lov_user_md *lum,
424 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
425 struct lov_user_md *lum, size_t lumsize);
427 int llapi_fd2fid(int fd, struct lu_fid *fid);
428 /* get FID of parent dir + the related name of entry in this parent dir */
429 int llapi_path2parent(const char *path, unsigned int linkno,
430 struct lu_fid *parent_fid, char *name, size_t name_size);
431 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
432 char *name, size_t name_size);
433 int llapi_rmfid(const char *path, struct fid_array *fa);
434 int llapi_chomp_string(char *buf);
435 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
437 int llapi_get_version_string(char *version, unsigned int version_size);
438 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
439 int llapi_get_version(char *buffer, int buffer_size, char **version)
440 __attribute__((deprecated));
441 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
442 int llapi_file_flush(int fd);
443 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
444 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
445 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
446 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
448 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
450 int llapi_hsm_register_event_fifo(const char *path);
451 int llapi_hsm_unregister_event_fifo(const char *path);
452 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
453 const char *fmt, va_list args);
455 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
456 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
458 int llapi_create_volatile_param(const char *directory, int mdt_idx,
459 int open_flags, mode_t mode,
460 const struct llapi_stripe_param *stripe_param);
462 static inline int llapi_create_volatile(char *directory, int open_flags)
464 return llapi_create_volatile_idx(directory, -1, open_flags);
468 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
469 int gid, __u64 flags);
470 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
471 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
472 __u64 dv2, __u64 flags);
474 /* Changelog interface. priv is private state, managed internally by these
477 /* Records received are in extended format now, though most of them are still
478 * written in disk in changelog_rec format (to save space and time), it's
479 * converted to extended format in the lustre api to ease changelog analysis. */
480 #define HAVE_CHANGELOG_EXTEND_REC 1
482 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
483 const char *mdtname, long long startrec);
484 int llapi_changelog_fini(void **priv);
485 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
486 int llapi_changelog_in_buf(void *priv);
487 int llapi_changelog_free(struct changelog_rec **rech);
488 int llapi_changelog_get_fd(void *priv);
489 /* Allow records up to endrec to be destroyed; requires registered id. */
490 int llapi_changelog_clear(const char *mdtname, const char *idstr,
492 extern int llapi_changelog_set_xflags(void *priv,
493 enum changelog_send_extra_flag extra_flags);
495 /* HSM copytool interface.
496 * priv is private state, managed internally by these functions
498 struct hsm_copytool_private;
499 struct hsm_copyaction_private;
501 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
502 const char *mnt, int archive_count,
503 int *archives, int rfd_flags);
504 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
505 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
506 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
507 struct hsm_action_list **hal, int *msgsize);
508 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
509 const struct hsm_copytool_private *ct,
510 const struct hsm_action_item *hai,
511 int restore_mdt_index, int restore_open_flags,
513 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
514 const struct hsm_extent *he, int hp_flags, int errval);
515 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
516 const struct hsm_extent *he, __u64 total,
518 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
520 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
521 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
522 unsigned long long stripe_size, int stripe_offset,
523 int stripe_count, int stripe_pattern, char *pool_name,
524 struct lu_fid *newfid);
526 /* HSM user interface */
527 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
529 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
530 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
533 int llapi_json_init_list(struct llapi_json_item_list **item_list);
534 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
535 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
536 __u32 type, void *val);
537 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
540 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
541 int llapi_lease_release(int fd);
542 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
543 int llapi_lease_check(int fd);
544 int llapi_lease_get(int fd, int mode); /* obsoleted */
545 int llapi_lease_put(int fd); /* obsoleted */
548 int llapi_group_lock(int fd, int gid);
549 int llapi_group_unlock(int fd, int gid);
552 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
553 struct llapi_lu_ladvise *ladvise);
556 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
557 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
558 __u32 id, enum lu_pcc_type type);
559 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
560 __u32 id, enum lu_pcc_type type);
561 int llapi_pcc_detach_fd(int fd, __u32 option);
562 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
564 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
566 int llapi_pcc_detach_file(const char *path, __u32 option);
567 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
568 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
569 int llapi_pccdev_set(const char *mntpath, const char *cmd);
570 int llapi_pccdev_get(const char *mntpath);
573 /* llapi_layout user interface */
576 * An array element storing component info to be resynced during mirror
579 struct llapi_resync_comp {
582 uint32_t lrc_mirror_id;
583 uint32_t lrc_id; /* component id */
587 /** Opaque data type abstracting the layout of a Lustre file. */
590 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
591 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
592 size_t count, off_t pos);
593 uint32_t llapi_mirror_find(struct llapi_layout *layout,
594 uint64_t file_start, uint64_t file_end,
596 int llapi_mirror_find_stale(struct llapi_layout *layout,
597 struct llapi_resync_comp *comp, size_t comp_size,
598 __u16 *mirror_ids, int ids_nr);
599 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
600 struct llapi_resync_comp *comp_array,
601 int comp_size, uint64_t start, uint64_t end);
603 * Flags to control how layouts are retrieved.
606 /* Replace non-specified values with expected inherited values. */
607 #define LAYOUT_GET_EXPECTED 0x1
610 * Return a pointer to a newly-allocated opaque data structure containing
611 * the layout for the file at \a path. The pointer should be freed with
612 * llapi_layout_free() when it is no longer needed. Failure is indicated
613 * by a NULL return value and an appropriate error code stored in errno.
615 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
618 * Return a pointer to a newly-allocated opaque data type containing the
619 * layout for the file referenced by open file descriptor \a fd. The
620 * pointer should be freed with llapi_layout_free() when it is no longer
621 * needed. Failure is indicated by a NULL return value and an
622 * appropriate error code stored in errno.
624 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
627 * Return a pointer to a newly-allocated opaque data type containing the
628 * layout for the file associated with Lustre file identifier
629 * \a fid. The string \a path must name a path within the
630 * filesystem that contains the file being looked up, such as the
631 * filesystem root. The returned pointer should be freed with
632 * llapi_layout_free() when it is no longer needed. Failure is
633 * indicated with a NULL return value and an appropriate error code
636 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
637 const struct lu_fid *fid,
640 enum llapi_layout_xattr_flags {
641 LLAPI_LXF_CHECK = 0x0001,
642 LLAPI_LXF_COPY = 0x0002,
646 * Return a pointer to a newly-allocated opaque data type containing the
647 * layout for the file associated with extended attribute \a lov_xattr. The
648 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
649 * should be raw xattr without being swapped, since this function will swap it
650 * properly. Thus, \a lov_xattr will be modified during the process. If the
651 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
652 * the objects count in lum is consistent with the stripe count in lum. This
653 * check only apply to regular file, so \a LLAPI_LXF_CHECK flag should be
654 * cleared if the xattr belongs to a directory. If the \a LLAPI_LXF_COPY flag
655 * of \a flags is set, this function will use a temporary buffer for byte
656 * swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the byte
657 * swapping will be done to the \a lov_xattr buffer directly. The returned
658 * pointer should be freed with llapi_layout_free() when it is no longer
659 * needed. Failure is * indicated with a NULL return value and an appropriate
660 * error code stored in errno.
662 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
663 ssize_t lov_xattr_size,
667 * Allocate a new layout. Use this when creating a new file with
668 * llapi_layout_file_create().
670 struct llapi_layout *llapi_layout_alloc(void);
673 * Free memory allocated for \a layout.
675 void llapi_layout_free(struct llapi_layout *layout);
678 * llapi_layout_merge() - Merge a composite layout into another one.
679 * @dst_layout: Destination composite layout.
680 * @src_layout: Source composite layout.
682 * This function copies all of the components from @src_layout and
683 * appends them to @dst_layout.
685 * Return: 0 on success or -1 on failure.
687 int llapi_layout_merge(struct llapi_layout **dst_layout,
688 const struct llapi_layout *src_layout);
690 /** Not a valid stripe size, offset, or RAID pattern. */
691 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
694 * When specified or returned as the value for stripe count,
695 * stripe size, offset, or RAID pattern, the filesystem-wide
696 * default behavior will apply.
698 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
701 * When specified or returned as the value for stripe count, all
702 * available OSTs will be used.
704 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
707 * When specified as the value for layout pattern, file objects will be
708 * stored using RAID0. That is, data will be split evenly and without
709 * redundancy across all OSTs in the layout.
711 #define LLAPI_LAYOUT_RAID0 0ULL
712 #define LLAPI_LAYOUT_MDT 2ULL
713 #define LLAPI_LAYOUT_OVERSTRIPING 4ULL
716 * The layout includes a specific set of OSTs on which to allocate.
718 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
721 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
723 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
726 * Flags to modify how layouts are retrieved.
728 /******************** Stripe Count ********************/
731 * Store the stripe count of \a layout in \a count.
734 * \retval -1 Error with status code in errno.
736 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
740 * Set the stripe count of \a layout to \a count.
743 * \retval -1 Invalid argument, errno set to EINVAL.
745 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
747 /******************** Stripe Size ********************/
750 * Store the stripe size of \a layout in \a size.
753 * \retval -1 Invalid argument, errno set to EINVAL.
755 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
759 * Set the stripe size of \a layout to \a stripe_size.
762 * \retval -1 Invalid argument, errno set to EINVAL.
764 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
767 /******************** Extension Size ********************/
770 * Store the extension size of \a layout in \a size.
773 * \retval -1 Invalid argument, errno set to EINVAL.
775 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
779 * Set the extension size of \a layout to \a stripe_size.
782 * \retval -1 Invalid argument, errno set to EINVAL.
784 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
787 /******************** Stripe Pattern ********************/
790 * Store the stripe pattern of \a layout in \a pattern.
793 * \retval -1 Error with status code in errno.
795 int llapi_layout_pattern_get(const struct llapi_layout *layout,
799 * Set the stripe pattern of \a layout to \a pattern.
802 * \retval -1 Invalid argument, errno set to EINVAL.
804 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
806 /******************** OST Index ********************/
809 * Store the index of the OST where stripe number \a stripe_number is stored
812 * An error return value will result from a NULL layout, if \a
813 * stripe_number is out of range, or if \a layout was not initialized
814 * with llapi_layout_lookup_by{path,fd,fid}().
817 * \retval -1 Invalid argument, errno set to EINVAL.
819 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
820 uint64_t stripe_number, uint64_t *index);
823 * Set the OST index associated with stripe number \a stripe_number to
825 * NB: This is currently supported only for \a stripe_number = 0 and
826 * other usage will return ENOTSUPP in errno. A NULL \a layout or
827 * out-of-range \a stripe_number will return EINVAL in errno.
830 * \retval -1 Error with errno set to non-zero value.
832 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
835 /******************** Pool Name ********************/
838 * Store up to \a pool_name_len characters of the name of the pool of
839 * OSTs associated with \a layout into the buffer pointed to by
842 * The correct calling form is:
844 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
846 * A pool defines a set of OSTs from which file objects may be
847 * allocated for a file using \a layout.
849 * On success, the number of bytes stored is returned, excluding the
850 * terminating '\0' character (zero indicates that \a layout does not
851 * have an associated OST pool). On error, -1 is returned and errno is
852 * set appropriately. Possible sources of error include a NULL pointer
853 * argument or insufficient space in \a dest to store the pool name,
854 * in which cases errno will be set to EINVAL.
856 * \retval 0+ The number of bytes stored in \a dest.
857 * \retval -1 Invalid argument, errno set to EINVAL.
859 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
860 char *pool_name, size_t pool_name_len);
863 * Set the name of the pool of OSTs from which file objects will be
864 * allocated to \a pool_name.
866 * If the pool name uses "fsname.pool" notation to qualify the pool name
867 * with a filesystem name, the "fsname." portion will be silently
868 * discarded before storing the value. No validation that \a pool_name
869 * is an existing non-empty pool in filesystem \a fsname will be
870 * performed. Such validation can be performed by the application if
871 * desired using the llapi_search_ost() function. The maximum length of
872 * the stored value is defined by the constant LOV_MAXPOOLNAME.
875 * \retval -1 Invalid argument, errno set to EINVAL.
877 int llapi_layout_pool_name_set(struct llapi_layout *layout,
878 const char *pool_name);
880 /******************** File Creation ********************/
883 * Open an existing file at \a path, or create it with the specified
884 * \a layout and \a mode.
886 * One access mode and zero or more file creation flags and file status
887 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
888 * open file descriptor for the file. If \a layout is non-NULL and
889 * \a path is not on a Lustre filesystem this function will fail and set
892 * An already existing file may be opened with this function, but
893 * \a layout and \a mode will not be applied to it. Callers requiring a
894 * guarantee that the opened file is created with the specified
895 * \a layout and \a mode should use llapi_layout_file_create().
897 * A NULL \a layout may be specified, in which case the standard Lustre
898 * behavior for assigning layouts to newly-created files will apply.
900 * \retval 0+ An open file descriptor.
901 * \retval -1 Error with status code in errno.
903 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
904 const struct llapi_layout *layout);
907 * Create a new file at \a path with the specified \a layout and \a mode.
909 * One access mode and zero or more file creation flags and file status
910 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
911 * open file descriptor for the file. If \a layout is non-NULL and
912 * \a path is not on a Lustre filesystem this function will fail and set
917 * llapi_layout_file_create(path, open_flags, mode, layout)
919 * shall be equivalent to:
921 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
923 * It is an error if \a path specifies an existing file.
925 * A NULL \a layout may be specified, in which the standard Lustre
926 * behavior for assigning layouts to newly-created files will apply.
928 * \retval 0+ An open file descriptor.
929 * \retval -1 Error with status code in errno.
931 int llapi_layout_file_create(const char *path, int open_flags, int mode,
932 const struct llapi_layout *layout);
935 * Set flags to the header of component layout.
937 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
938 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
939 const char *llapi_layout_flags_string(uint32_t flags);
940 const __u16 llapi_layout_string_flags(char *string);
943 * llapi_layout_mirror_count_get() - Get mirror count from the header of
945 * @layout: Layout to get mirror count from.
946 * @count: Returned mirror count value.
948 * This function gets mirror count from the header of a layout.
950 * Return: 0 on success or -1 on failure.
952 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
956 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
957 * @layout: Layout to set mirror count in.
958 * @count: Mirror count value to be set.
960 * This function sets mirror count to the header of a layout.
962 * Return: 0 on success or -1 on failure.
964 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
968 * Fetch the start and end offset of the current layout component.
970 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
971 uint64_t *start, uint64_t *end);
973 * Set the extent of current layout component.
975 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
976 uint64_t start, uint64_t end);
978 /* PFL component flags table */
979 static const struct comp_flag_name {
980 enum lov_comp_md_entry_flags cfn_flag;
981 const char *cfn_name;
982 } comp_flags_table[] = {
983 { LCME_FL_INIT, "init" },
984 { LCME_FL_STALE, "stale" },
985 { LCME_FL_PREF_RW, "prefer" },
986 { LCME_FL_OFFLINE, "offline" },
987 { LCME_FL_NOSYNC, "nosync" },
988 { LCME_FL_EXTENSION, "extension" },
992 * Gets the attribute flags of the current component.
994 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
997 * Sets the specified flags of the current component leaving other flags as-is.
999 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1001 * Clears the flags specified in the flags leaving other flags as-is.
1003 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1005 * Fetches the file-unique component ID of the current layout component.
1007 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1009 * Fetches the mirror ID of the current layout component.
1011 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1013 * Adds one component to the existing composite or plain layout.
1015 int llapi_layout_comp_add(struct llapi_layout *layout);
1017 * Adds a first component of a mirror to the existing composite layout.
1019 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1021 * Deletes the current layout component from the composite layout.
1023 int llapi_layout_comp_del(struct llapi_layout *layout);
1025 enum llapi_layout_comp_use {
1026 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1027 LLAPI_LAYOUT_COMP_USE_LAST = 2,
1028 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1029 LLAPI_LAYOUT_COMP_USE_PREV = 4,
1033 * Set the currently active component to the specified component ID.
1035 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1037 * Select the currently active component at the specified position.
1039 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1041 * Add layout components to an existing file.
1043 int llapi_layout_file_comp_add(const char *path,
1044 const struct llapi_layout *layout);
1046 * Delete component(s) by the specified component id or flags.
1048 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1050 * Change flags or other parameters of the component(s) by component ID of an
1051 * existing file. The component to be modified is specified by the
1052 * comp->lcme_id value, which must be an unique component ID. The new
1053 * attributes are passed in by @comp and @valid is used to specify which
1054 * attributes in the component are going to be changed.
1056 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1059 * Check if the file layout is composite.
1061 bool llapi_layout_is_composite(struct llapi_layout *layout);
1064 LLAPI_LAYOUT_ITER_CONT = 0,
1065 LLAPI_LAYOUT_ITER_STOP = 1,
1069 * Iteration callback function.
1071 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
1072 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
1073 * \retval < 0 error code
1075 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1078 * Iterate all components in the corresponding layout
1080 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1081 llapi_layout_iter_cb cb, void *cbdata);
1084 * FLR: mirror operation APIs
1086 int llapi_mirror_set(int fd, unsigned int id);
1087 int llapi_mirror_clear(int fd);
1088 ssize_t llapi_mirror_read(int fd, unsigned int id,
1089 void *buf, size_t count, off_t pos);
1090 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1091 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1092 off_t pos, size_t count);
1094 int llapi_heat_get(int fd, struct lu_heat *heat);
1095 int llapi_heat_set(int fd, __u64 flags);
1096 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
1097 void llapi_layout_sanity_perror(int error);
1098 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1102 #if defined(__cplusplus)