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/
35 /** \defgroup llapi llapi
45 #include <sys/types.h>
46 #include <linux/lustre/lustre_user.h>
48 #if defined(__cplusplus)
53 #define LL_MAXQUOTAS 3
57 #define SEL_UNIT_SIZE 1024llu
60 #ifndef LOV_PATTERN_DEFAULT
61 #define LOV_PATTERN_DEFAULT 0xffffffff
64 typedef struct statx lstatx_t;
66 #define lustre_fid struct lu_fid
68 /* Currently external applications can access this but in the
69 * future this will no longer be exposed for the user. Instead
70 * if you want to know if the library is initialized just call
71 * llapi_liblustreapi_initialized() which is now available. */
72 extern bool liblustreapi_initialized;
74 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
77 /* lustreapi message severity level */
78 enum llapi_message_level {
89 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
90 const char *fmt, va_list ap);
92 static inline bool llapi_liblustreapi_initialized(void)
94 return liblustreapi_initialized;
97 /* the bottom three bits reserved for llapi_message_level */
98 #define LLAPI_MSG_MASK 0x00000007
99 #define LLAPI_MSG_NO_ERRNO 0x00000010
101 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
103 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
107 if (level >= LLAPI_MSG_MAX)
110 return levels[level];
113 void llapi_msg_set_level(int level);
114 int llapi_msg_get_level(void);
115 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
116 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
118 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
119 __attribute__((__format__(__printf__, 3, 4)));
120 #define llapi_err_noerrno(level, fmt, a...) \
121 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
122 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
123 __attribute__((__format__(__printf__, 2, 3)));
125 struct llapi_stripe_param {
126 unsigned long long lsp_stripe_size;
128 int lsp_stripe_offset;
129 int lsp_stripe_pattern;
130 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
131 int lsp_stripe_count;
132 bool lsp_is_specific;
137 #define lsp_tgts lsp_osts
139 __u32 llapi_pattern_to_lov(uint64_t pattern);
141 int llapi_file_open_param(const char *name, int flags, mode_t mode,
142 const struct llapi_stripe_param *param);
143 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
144 __u32 flags, char *foreign_lov);
145 int llapi_file_create(const char *name, unsigned long long stripe_size,
146 int stripe_offset, int stripe_count, int stripe_pattern);
147 int llapi_file_open(const char *name, int flags, int mode,
148 unsigned long long stripe_size, int stripe_offset,
149 int stripe_count, int stripe_pattern);
150 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
151 int stripe_offset, int stripe_count,
152 int stripe_pattern, char *pool_name);
153 int llapi_file_open_pool(const char *name, int flags, int mode,
154 unsigned long long stripe_size, int stripe_offset,
155 int stripe_count, int stripe_pattern, char *pool_name);
156 int llapi_poollist(const char *name);
157 int llapi_get_poollist(const char *name, char **poollist, int list_size,
158 char *buffer, int buffer_size);
159 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
160 char *buffer, int buffer_size);
161 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
162 int llapi_file_lookup(int dirfd, const char *name);
163 void llapi_set_command_name(const char *cmd);
164 void llapi_clear_command_name(void);
166 enum llapi_layout_verbose {
167 VERBOSE_STRIPE_COUNT = 0x1,
168 VERBOSE_STRIPE_SIZE = 0x2,
169 VERBOSE_STRIPE_OFFSET = 0x4,
171 VERBOSE_DETAIL = 0x10,
172 VERBOSE_OBJID = 0x20,
173 VERBOSE_GENERATION = 0x40,
174 VERBOSE_MDTINDEX = 0x80,
175 VERBOSE_PATTERN = 0x100,
176 VERBOSE_COMP_COUNT = 0x200,
177 VERBOSE_COMP_FLAGS = 0x400,
178 VERBOSE_COMP_START = 0x800,
179 VERBOSE_COMP_END = 0x1000,
180 VERBOSE_COMP_ID = 0x2000,
181 VERBOSE_DFID = 0x4000,
182 VERBOSE_HASH_TYPE = 0x8000,
183 VERBOSE_MIRROR_COUNT = 0x10000,
184 VERBOSE_MIRROR_ID = 0x20000,
185 VERBOSE_EXT_SIZE = 0x40000,
186 VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
187 VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
188 VERBOSE_OBJID | VERBOSE_GENERATION |
189 VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
190 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
191 VERBOSE_COMP_START | VERBOSE_COMP_END |
192 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
193 VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE
195 /* Compatibility with original names */
196 #define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
197 #define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
198 #define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
199 #define VERBOSE_LAYOUT VERBOSE_PATTERN
202 NEWERXY_ATIME = 0, /* neweraY */
203 NEWERXY_MTIME = 1, /* newermY */
204 NEWERXY_CTIME = 2, /* newercY */
205 NEWERXY_BTIME = 3, /* newerbY | newerBY */
210 unsigned int fp_max_depth;
212 mode_t fp_type; /* S_IFIFO,... */
218 /* {a,m,c,b}sign cannot be bitfields due to using pointers to
219 * access them during argument parsing. */
223 /* these need to be signed values */
225 fp_stripe_size_sign:2,
226 fp_stripe_count_sign:2,
227 fp_comp_start_sign:2,
229 fp_comp_count_sign:2,
230 fp_mirror_count_sign:2,
231 fp_mirror_index_sign:2,
236 fp_unused1_sign:2, /* Fields available to use*/
237 fp_unused2_sign:2, /* Once used we must add */
238 fp_unused3_sign:2, /* a separate flag field */
239 fp_unused4_sign:2; /* at end of the struct. */
240 unsigned long long fp_size;
241 unsigned long long fp_size_units;
243 unsigned long long fp_zero_end:1,
245 fp_exclude_pattern:1,
253 fp_check_pool:1, /* LOV pool name */
254 fp_check_size:1, /* file size */
260 fp_get_lmv:1, /* get MDT list from LMV */
261 fp_raw:1, /* do not fill in defaults */
262 fp_check_stripe_size:1, /* LOV stripe size */
263 fp_exclude_stripe_size:1,
264 fp_check_stripe_count:1, /* LOV stripe count */
265 fp_exclude_stripe_count:1,
268 fp_get_default_lmv:1, /* Get default LMV */
272 fp_check_comp_count:1,
273 fp_exclude_comp_count:1,
274 fp_check_mirror_count:1,
275 fp_exclude_mirror_count:1,
276 fp_check_comp_flags:1,
277 fp_check_mirror_state:1,
278 fp_check_comp_start:1,
279 fp_exclude_comp_start:1,
281 fp_exclude_comp_end:1,
283 fp_exclude_comp_id:1,
284 fp_check_mirror_id:1,
285 fp_exclude_mirror_id:1,
286 fp_check_mirror_index:1,
287 fp_exclude_mirror_index:1,
288 fp_check_mdt_count:1,
289 fp_exclude_mdt_count:1,
290 fp_check_hash_flag:1,
291 fp_exclude_hash_type:1,
292 fp_yaml:1, /* output layout in YAML */
296 fp_exclude_foreign:1,
297 fp_check_ext_size:1, /* extension size */
298 fp_exclude_ext_size:1,
302 fp_unused_bit3:1, /* All of these unused bit */
303 fp_unused_bit4:1, /* fields available to use.*/
304 fp_unused_bit5:1, /* Once all unused fields */
305 fp_unused_bit6:1, /* are used we need to add */
306 fp_unused_bit7:1; /* a separate flag field at*/
307 /* the end of the struct. */
309 enum llapi_layout_verbose fp_verbose;
312 /* regular expression */
315 struct obd_uuid *fp_obd_uuid;
317 int fp_num_alloc_obds;
321 struct obd_uuid *fp_mdt_uuid;
323 int fp_num_alloc_mdts;
326 int fp_file_mdt_index;
329 struct lov_user_mds_data *fp_lmd;
331 char fp_poolname[LOV_MAXPOOLNAME + 1];
333 __u32 fp_lmv_stripe_count;
334 struct lmv_user_md *fp_lmv_md;
336 unsigned long long fp_stripe_size;
337 unsigned long long fp_stripe_size_units;
338 unsigned long long fp_stripe_count;
342 __u32 fp_mirror_count;
344 __u32 fp_comp_neg_flags;
345 __u16 fp_mirror_state;
346 __u16 fp_mirror_neg_state;
349 __u16 fp_mirror_index;
350 unsigned long long fp_comp_start;
351 unsigned long long fp_comp_start_units;
352 unsigned long long fp_comp_end;
353 unsigned long long fp_comp_end_units;
354 unsigned long long fp_mdt_count;
356 unsigned long long fp_blocks;
357 unsigned long long fp_blocks_units;
359 unsigned long fp_got_uuids:1,
361 unsigned int fp_depth;
362 unsigned int fp_hash_type;
363 unsigned int fp_time_margin; /* time margin in seconds */
364 __u32 fp_foreign_type;
365 unsigned long long fp_ext_size;
366 unsigned long long fp_ext_size_units;
369 * fp_newery[NEWERXY_MAX][0]: --newerXY reference
370 * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
372 time_t fp_newery[NEWERXY_MAX][2];
376 unsigned int fp_hash_inflags;
377 unsigned int fp_hash_exflags;
380 int llapi_ostlist(char *path, struct find_param *param);
381 int llapi_uuid_match(char *real_uuid, char *search_uuid);
382 int llapi_getstripe(char *path, struct find_param *param);
383 int llapi_find(char *path, struct find_param *param);
385 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
386 int llapi_dir_set_default_lmv(const char *name,
387 const struct llapi_stripe_param *param);
388 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
389 int stripe_count, int stripe_pattern,
390 const char *pool_name);
391 int llapi_dir_create(const char *name, mode_t mode,
392 const struct llapi_stripe_param *param);
393 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
394 __u32 flags, const char *value);
395 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
396 int stripe_count, int stripe_pattern,
397 const char *poolname);
398 int llapi_direntry_remove(char *dname);
399 int llapi_unlink_foreign(char *dname);
401 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
402 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
403 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
404 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
405 int llapi_ping(char *obd_type, char *obd_name);
406 int llapi_target_check(int num_types, char **obd_types, char *dir);
407 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
408 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
409 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
410 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
411 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
412 int llapi_is_lustre_mnttype(const char *type);
413 int llapi_search_tgt(const char *fsname, const char *poolname,
414 const char *tgtname, bool is_mdt);
415 int llapi_search_mdt(const char *fsname, const char *poolname,
416 const char *mdtname);
417 int llapi_search_ost(const char *fsname, const char *poolname,
418 const char *ostname);
419 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
420 int llapi_parse_size(const char *optarg, unsigned long long *size,
421 unsigned long long *size_units, int bytes_spec);
422 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
424 int llapi_search_fsname(const char *pathname, char *fsname);
425 int llapi_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
426 char *instance, size_t instance_len);
427 int llapi_get_instance(const char *path, char *instance, size_t instance_len);
428 int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
429 int llapi_getname(const char *path, char *name, size_t namelen);
430 int llapi_search_fileset(const char *pathname, char *fileset);
432 int llapi_search_rootpath(char *pathname, const char *fsname);
433 int llapi_nodemap_exists(const char *name);
434 int llapi_migrate_mdt(char *path, struct find_param *param);
435 int llapi_mv(char *path, struct find_param *param);
439 #define HAVE_LLAPI_IS_LUSTRE_MNT
440 int llapi_is_lustre_mnt(struct mntent *mnt);
441 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
442 int llapi_target_iterate(int type_num, char **obd_type, void *args,
444 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
445 int llapi_cp(int argc, char *argv[]);
446 int llapi_ls(int argc, char *argv[]);
447 int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
448 int llapi_fid2path_at(int mnt_fd, const struct lu_fid *fid, char *path,
449 int pathlen, long long *recno, int *linkno);
450 int llapi_fid2path(const char *device, const char *fidstr, char *path,
451 int pathlen, long long *recno, int *linkno);
452 int llapi_path2fid(const char *path, struct lu_fid *fid);
453 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
455 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
456 struct lov_user_md *lum, size_t lumsize);
457 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
458 struct lov_user_md *lum, size_t lumsize);
459 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
460 lstatx_t *statx, struct lov_user_md *lum,
462 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
463 struct lov_user_md *lum, size_t lumsize);
465 int llapi_fd2fid(int fd, struct lu_fid *fid);
466 /* get FID of parent dir + the related name of entry in this parent dir */
467 int llapi_path2parent(const char *path, unsigned int linkno,
468 struct lu_fid *parent_fid, char *name, size_t name_size);
469 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
470 char *name, size_t name_size);
471 int llapi_rmfid(const char *path, struct fid_array *fa);
472 int llapi_chomp_string(char *buf);
473 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
475 int llapi_get_version_string(char *version, unsigned int version_size);
476 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
477 int llapi_get_version(char *buffer, int buffer_size, char **version)
478 __attribute__((deprecated));
479 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
480 int llapi_file_flush(int fd);
481 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
482 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
483 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
484 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
486 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
488 int llapi_hsm_register_event_fifo(const char *path);
489 int llapi_hsm_unregister_event_fifo(const char *path);
490 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
491 const char *fmt, va_list args);
493 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
494 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
496 int llapi_create_volatile_param(const char *directory, int mdt_idx,
497 int open_flags, mode_t mode,
498 const struct llapi_stripe_param *stripe_param);
500 static inline int llapi_create_volatile(char *directory, int open_flags)
502 return llapi_create_volatile_idx(directory, -1, open_flags);
506 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
507 int gid, __u64 flags);
508 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
509 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
510 __u64 dv2, __u64 flags);
512 /* Changelog interface. priv is private state, managed internally by these
515 /* Records received are in extended format now, though most of them are still
516 * written in disk in changelog_rec format (to save space and time), it's
517 * converted to extended format in the lustre api to ease changelog analysis. */
518 #define HAVE_CHANGELOG_EXTEND_REC 1
520 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
521 const char *mdtname, long long startrec);
522 int llapi_changelog_fini(void **priv);
523 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
524 int llapi_changelog_in_buf(void *priv);
525 int llapi_changelog_free(struct changelog_rec **rech);
526 int llapi_changelog_get_fd(void *priv);
527 /* Allow records up to endrec to be destroyed; requires registered id. */
528 int llapi_changelog_clear(const char *mdtname, const char *idstr,
530 extern int llapi_changelog_set_xflags(void *priv,
531 enum changelog_send_extra_flag extra_flags);
533 /* HSM copytool interface.
534 * priv is private state, managed internally by these functions
536 struct hsm_copytool_private;
537 struct hsm_copyaction_private;
539 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
540 const char *mnt, int archive_count,
541 int *archives, int rfd_flags);
542 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
543 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
544 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
545 struct hsm_action_list **hal, int *msgsize);
546 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
547 const struct hsm_copytool_private *ct,
548 const struct hsm_action_item *hai,
549 int restore_mdt_index, int restore_open_flags,
551 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
552 const struct hsm_extent *he, int hp_flags, int errval);
553 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
554 const struct hsm_extent *he, __u64 total,
556 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
558 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
559 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
560 unsigned long long stripe_size, int stripe_offset,
561 int stripe_count, int stripe_pattern, char *pool_name,
562 struct lu_fid *newfid);
564 /* HSM user interface */
565 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
567 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
568 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
571 enum llapi_json_types {
572 LLAPI_JSON_INTEGER = 1,
578 struct llapi_json_item {
587 struct llapi_json_item *lji_next;
590 struct llapi_json_item_list {
592 struct llapi_json_item *ljil_items;
595 int llapi_json_init_list(struct llapi_json_item_list **item_list);
596 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
597 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
598 __u32 type, void *val);
599 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
602 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
603 int llapi_lease_release(int fd);
604 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
605 int llapi_lease_check(int fd);
606 int llapi_lease_get(int fd, int mode); /* obsoleted */
607 int llapi_lease_put(int fd); /* obsoleted */
610 int llapi_group_lock(int fd, int gid);
611 int llapi_group_unlock(int fd, int gid);
613 bool llapi_file_is_sparse(int fd);
614 off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
615 int llapi_hole_punch(int fd, off_t start, size_t length);
618 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
619 struct llapi_lu_ladvise *ladvise);
622 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
623 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
624 __u32 id, enum lu_pcc_type type);
625 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
626 __u32 id, enum lu_pcc_type type);
627 int llapi_pcc_detach_fd(int fd, __u32 option);
628 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
630 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
632 int llapi_pcc_detach_file(const char *path, __u32 option);
633 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
634 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
635 int llapi_pccdev_set(const char *mntpath, const char *cmd);
636 int llapi_pccdev_get(const char *mntpath);
639 /* llapi_layout user interface */
642 * An array element storing component info to be resynced during mirror
645 struct llapi_resync_comp {
648 uint32_t lrc_mirror_id;
649 uint32_t lrc_id; /* component id */
653 /** Opaque data type abstracting the layout of a Lustre file. */
656 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
657 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
658 size_t count, off_t pos);
659 uint32_t llapi_mirror_find(struct llapi_layout *layout,
660 uint64_t file_start, uint64_t file_end,
662 int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
663 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
664 struct llapi_layout *m_layout);
665 int llapi_mirror_find_stale(struct llapi_layout *layout,
666 struct llapi_resync_comp *comp, size_t comp_size,
667 __u16 *mirror_ids, int ids_nr);
668 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
669 struct llapi_resync_comp *comp_array,
670 int comp_size, uint64_t start, uint64_t end);
672 * Flags to control how layouts are retrieved.
675 /* Replace non-specified values with expected inherited values. */
676 #define LAYOUT_GET_EXPECTED 0x1
679 * Return a pointer to a newly-allocated opaque data structure containing
680 * the layout for the file at \a path. The pointer should be freed with
681 * llapi_layout_free() when it is no longer needed. Failure is indicated
682 * by a NULL return value and an appropriate error code stored in errno.
684 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
687 * Return a pointer to a newly-allocated opaque data type containing the
688 * layout for the file referenced by open file descriptor \a fd. The
689 * pointer should be freed with llapi_layout_free() when it is no longer
690 * needed. Failure is indicated by a NULL return value and an
691 * appropriate error code stored in errno.
693 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
696 * Return a pointer to a newly-allocated opaque data type containing the
697 * layout for the file associated with Lustre file identifier
698 * \a fid. The string \a path must name a path within the
699 * filesystem that contains the file being looked up, such as the
700 * filesystem root. The returned pointer should be freed with
701 * llapi_layout_free() when it is no longer needed. Failure is
702 * indicated with a NULL return value and an appropriate error code
705 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
706 const struct lu_fid *fid,
709 enum llapi_layout_xattr_flags {
710 LLAPI_LXF_CHECK = 0x0001,
711 LLAPI_LXF_COPY = 0x0002,
715 * Return a pointer to a newly-allocated opaque data type containing the
716 * layout for the file associated with extended attribute \a lov_xattr. The
717 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
718 * should be raw xattr without being swapped, since this function will swap it
719 * properly. Thus, \a lov_xattr will be modified during the process. If the
720 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
721 * the objects count in lum is consistent with the stripe count in lum. This
722 * check only apply to regular file, so \a LLAPI_LXF_CHECK flag should be
723 * cleared if the xattr belongs to a directory. If the \a LLAPI_LXF_COPY flag
724 * of \a flags is set, this function will use a temporary buffer for byte
725 * swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the byte
726 * swapping will be done to the \a lov_xattr buffer directly. The returned
727 * pointer should be freed with llapi_layout_free() when it is no longer
728 * needed. Failure is * indicated with a NULL return value and an appropriate
729 * error code stored in errno.
731 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
732 ssize_t lov_xattr_size,
736 * Allocate a new layout. Use this when creating a new file with
737 * llapi_layout_file_create().
739 struct llapi_layout *llapi_layout_alloc(void);
742 * Free memory allocated for \a layout.
744 void llapi_layout_free(struct llapi_layout *layout);
747 * llapi_layout_merge() - Merge a composite layout into another one.
748 * @dst_layout: Destination composite layout.
749 * @src_layout: Source composite layout.
751 * This function copies all of the components from @src_layout and
752 * appends them to @dst_layout.
754 * Return: 0 on success or -1 on failure.
756 int llapi_layout_merge(struct llapi_layout **dst_layout,
757 const struct llapi_layout *src_layout);
759 /** Not a valid stripe size, offset, or RAID pattern. */
760 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
763 * When specified or returned as the value for stripe count,
764 * stripe size, offset, or RAID pattern, the filesystem-wide
765 * default behavior will apply.
767 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
770 * When specified or returned as the value for stripe count, all
771 * available OSTs will be used.
773 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
776 * When specified as the value for layout pattern, file objects will be
777 * stored using RAID0. That is, data will be split evenly and without
778 * redundancy across all OSTs in the layout.
780 #define LLAPI_LAYOUT_RAID0 0ULL
781 #define LLAPI_LAYOUT_MDT 2ULL
782 #define LLAPI_LAYOUT_OVERSTRIPING 4ULL
785 * The layout includes a specific set of OSTs on which to allocate.
787 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
790 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
792 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
795 * Flags to modify how layouts are retrieved.
797 /******************** Stripe Count ********************/
800 * Store the stripe count of \a layout in \a count.
803 * \retval -1 Error with status code in errno.
805 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
809 * Set the stripe count of \a layout to \a count.
812 * \retval -1 Invalid argument, errno set to EINVAL.
814 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
816 /******************** Stripe Size ********************/
819 * Store the stripe size of \a layout in \a size.
822 * \retval -1 Invalid argument, errno set to EINVAL.
824 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
828 * Set the stripe size of \a layout to \a stripe_size.
831 * \retval -1 Invalid argument, errno set to EINVAL.
833 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
836 /******************** Extension Size ********************/
839 * Store the extension size of \a layout in \a size.
842 * \retval -1 Invalid argument, errno set to EINVAL.
844 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
848 * Set the extension size of \a layout to \a stripe_size.
851 * \retval -1 Invalid argument, errno set to EINVAL.
853 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
856 /******************** Stripe Pattern ********************/
859 * Store the stripe pattern of \a layout in \a pattern.
862 * \retval -1 Error with status code in errno.
864 int llapi_layout_pattern_get(const struct llapi_layout *layout,
868 * Set the stripe pattern of \a layout to \a pattern.
871 * \retval -1 Invalid argument, errno set to EINVAL.
873 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
875 /******************** OST Index ********************/
878 * Store the index of the OST where stripe number \a stripe_number is stored
881 * An error return value will result from a NULL layout, if \a
882 * stripe_number is out of range, or if \a layout was not initialized
883 * with llapi_layout_lookup_by{path,fd,fid}().
886 * \retval -1 Invalid argument, errno set to EINVAL.
888 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
889 uint64_t stripe_number, uint64_t *index);
892 * Set the OST index associated with stripe number \a stripe_number to
894 * NB: This is currently supported only for \a stripe_number = 0 and
895 * other usage will return ENOTSUPP in errno. A NULL \a layout or
896 * out-of-range \a stripe_number will return EINVAL in errno.
899 * \retval -1 Error with errno set to non-zero value.
901 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
904 /******************** Pool Name ********************/
907 * Store up to \a pool_name_len characters of the name of the pool of
908 * OSTs associated with \a layout into the buffer pointed to by
911 * The correct calling form is:
913 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
915 * A pool defines a set of OSTs from which file objects may be
916 * allocated for a file using \a layout.
918 * On success, the number of bytes stored is returned, excluding the
919 * terminating '\0' character (zero indicates that \a layout does not
920 * have an associated OST pool). On error, -1 is returned and errno is
921 * set appropriately. Possible sources of error include a NULL pointer
922 * argument or insufficient space in \a dest to store the pool name,
923 * in which cases errno will be set to EINVAL.
925 * \retval 0+ The number of bytes stored in \a dest.
926 * \retval -1 Invalid argument, errno set to EINVAL.
928 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
929 char *pool_name, size_t pool_name_len);
932 * Set the name of the pool of OSTs from which file objects will be
933 * allocated to \a pool_name.
935 * If the pool name uses "fsname.pool" notation to qualify the pool name
936 * with a filesystem name, the "fsname." portion will be silently
937 * discarded before storing the value. No validation that \a pool_name
938 * is an existing non-empty pool in filesystem \a fsname will be
939 * performed. Such validation can be performed by the application if
940 * desired using the llapi_search_ost() function. The maximum length of
941 * the stored value is defined by the constant LOV_MAXPOOLNAME.
944 * \retval -1 Invalid argument, errno set to EINVAL.
946 int llapi_layout_pool_name_set(struct llapi_layout *layout,
947 const char *pool_name);
949 /******************** File Creation ********************/
952 * Open an existing file at \a path, or create it with the specified
953 * \a layout and \a mode.
955 * One access mode and zero or more file creation flags and file status
956 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
957 * open file descriptor for the file. If \a layout is non-NULL and
958 * \a path is not on a Lustre filesystem this function will fail and set
961 * An already existing file may be opened with this function, but
962 * \a layout and \a mode will not be applied to it. Callers requiring a
963 * guarantee that the opened file is created with the specified
964 * \a layout and \a mode should use llapi_layout_file_create().
966 * A NULL \a layout may be specified, in which case the standard Lustre
967 * behavior for assigning layouts to newly-created files will apply.
969 * \retval 0+ An open file descriptor.
970 * \retval -1 Error with status code in errno.
972 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
973 const struct llapi_layout *layout);
976 * Create a new file at \a path with the specified \a layout and \a mode.
978 * One access mode and zero or more file creation flags and file status
979 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
980 * open file descriptor for the file. If \a layout is non-NULL and
981 * \a path is not on a Lustre filesystem this function will fail and set
986 * llapi_layout_file_create(path, open_flags, mode, layout)
988 * shall be equivalent to:
990 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
992 * It is an error if \a path specifies an existing file.
994 * A NULL \a layout may be specified, in which the standard Lustre
995 * behavior for assigning layouts to newly-created files will apply.
997 * \retval 0+ An open file descriptor.
998 * \retval -1 Error with status code in errno.
1000 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1001 const struct llapi_layout *layout);
1004 * Set flags to the header of component layout.
1006 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
1007 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
1008 const char *llapi_layout_flags_string(uint32_t flags);
1009 const __u16 llapi_layout_string_flags(char *string);
1012 * llapi_layout_mirror_count_get() - Get mirror count from the header of
1014 * @layout: Layout to get mirror count from.
1015 * @count: Returned mirror count value.
1017 * This function gets mirror count from the header of a layout.
1019 * Return: 0 on success or -1 on failure.
1021 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1025 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1026 * @layout: Layout to set mirror count in.
1027 * @count: Mirror count value to be set.
1029 * This function sets mirror count to the header of a layout.
1031 * Return: 0 on success or -1 on failure.
1033 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1037 * Fetch the start and end offset of the current layout component.
1039 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1040 uint64_t *start, uint64_t *end);
1042 * Set the extent of current layout component.
1044 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1045 uint64_t start, uint64_t end);
1047 /* PFL component flags table */
1048 static const struct comp_flag_name {
1049 enum lov_comp_md_entry_flags cfn_flag;
1050 const char *cfn_name;
1051 } comp_flags_table[] = {
1052 { LCME_FL_INIT, "init" },
1053 { LCME_FL_STALE, "stale" },
1054 { LCME_FL_PREF_RW, "prefer" },
1055 { LCME_FL_OFFLINE, "offline" },
1056 { LCME_FL_NOSYNC, "nosync" },
1057 { LCME_FL_EXTENSION, "extension" },
1061 * Gets the attribute flags of the current component.
1063 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1066 * Sets the specified flags of the current component leaving other flags as-is.
1068 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1070 * Clears the flags specified in the flags leaving other flags as-is.
1072 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1074 * Fetches the file-unique component ID of the current layout component.
1076 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1078 * Fetches the mirror ID of the current layout component.
1080 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1082 * Adds one component to the existing composite or plain layout.
1084 int llapi_layout_comp_add(struct llapi_layout *layout);
1086 * Adds a first component of a mirror to the existing composite layout.
1088 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1090 * Deletes the current layout component from the composite layout.
1092 int llapi_layout_comp_del(struct llapi_layout *layout);
1094 enum llapi_layout_comp_use {
1095 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1096 LLAPI_LAYOUT_COMP_USE_LAST = 2,
1097 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1098 LLAPI_LAYOUT_COMP_USE_PREV = 4,
1102 * Set the currently active component to the specified component ID.
1104 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1106 * Select the currently active component at the specified position.
1108 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1110 * Add layout components to an existing file.
1112 int llapi_layout_file_comp_add(const char *path,
1113 const struct llapi_layout *layout);
1115 * Delete component(s) by the specified component id or flags.
1117 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1119 * Change flags or other parameters of the component(s) by component ID of an
1120 * existing file. The component to be modified is specified by the
1121 * comp->lcme_id value, which must be an unique component ID. The new
1122 * attributes are passed in by @comp and @valid is used to specify which
1123 * attributes in the component are going to be changed.
1125 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1128 * Check if the file layout is composite.
1130 bool llapi_layout_is_composite(struct llapi_layout *layout);
1133 LLAPI_LAYOUT_ITER_CONT = 0,
1134 LLAPI_LAYOUT_ITER_STOP = 1,
1138 * Iteration callback function.
1140 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
1141 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
1142 * \retval < 0 error code
1144 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1147 * Iterate all components in the corresponding layout
1149 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1150 llapi_layout_iter_cb cb, void *cbdata);
1153 * FLR: mirror operation APIs
1155 int llapi_mirror_set(int fd, unsigned int id);
1156 int llapi_mirror_clear(int fd);
1157 ssize_t llapi_mirror_read(int fd, unsigned int id,
1158 void *buf, size_t count, off_t pos);
1159 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1160 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1161 off_t pos, size_t count);
1162 off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size);
1163 int llapi_mirror_punch(int fd, unsigned int id, off_t start, size_t length);
1165 int llapi_heat_get(int fd, struct lu_heat *heat);
1166 int llapi_heat_set(int fd, __u64 flags);
1168 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
1169 void llapi_layout_sanity_perror(int error);
1170 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1172 int llapi_param_get_paths(const char *pattern, glob_t *paths);
1173 int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
1174 void llapi_param_paths_free(glob_t *paths);
1178 #if defined(__cplusplus)