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
46 #include <sys/types.h>
47 #include <linux/lustre/lustre_user.h>
49 #if defined(__cplusplus)
54 #define LL_MAXQUOTAS 3
58 #define ARRAY_SIZE(a) ((sizeof(a)) / (sizeof((a)[0])))
61 #define lustre_fid struct lu_fid
63 /* Currently external applications can access this but in the
64 * future this will no longer be exposed for the user. Instead
65 * if you want to know if the library is initialized just call
66 * llapi_liblustreapi_initialized() which is now available. */
67 extern bool liblustreapi_initialized;
69 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
72 /* lustreapi message severity level */
73 enum llapi_message_level {
84 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
85 const char *fmt, va_list ap);
87 static inline bool llapi_liblustreapi_initialized(void)
89 return liblustreapi_initialized;
92 /* the bottom three bits reserved for llapi_message_level */
93 #define LLAPI_MSG_MASK 0x00000007
94 #define LLAPI_MSG_NO_ERRNO 0x00000010
96 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
98 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
102 if (level >= LLAPI_MSG_MAX)
105 return levels[level];
108 void llapi_msg_set_level(int level);
109 int llapi_msg_get_level(void);
110 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
111 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
113 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
114 __attribute__((__format__(__printf__, 3, 4)));
115 #define llapi_err_noerrno(level, fmt, a...) \
116 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
117 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
118 __attribute__((__format__(__printf__, 2, 3)));
120 struct llapi_stripe_param {
121 unsigned long long lsp_stripe_size;
123 int lsp_stripe_offset;
124 int lsp_stripe_pattern;
125 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
126 int lsp_stripe_count;
127 bool lsp_is_specific;
131 #define lsp_tgts lsp_osts
133 __u32 llapi_pattern_to_lov(uint64_t pattern);
135 int llapi_file_open_param(const char *name, int flags, mode_t mode,
136 const struct llapi_stripe_param *param);
137 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
138 __u32 flags, char *foreign_lov);
139 int llapi_file_create(const char *name, unsigned long long stripe_size,
140 int stripe_offset, int stripe_count, int stripe_pattern);
141 int llapi_file_open(const char *name, int flags, int mode,
142 unsigned long long stripe_size, int stripe_offset,
143 int stripe_count, int stripe_pattern);
144 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
145 int stripe_offset, int stripe_count,
146 int stripe_pattern, char *pool_name);
147 int llapi_file_open_pool(const char *name, int flags, int mode,
148 unsigned long long stripe_size, int stripe_offset,
149 int stripe_count, int stripe_pattern, char *pool_name);
150 int llapi_poollist(const char *name);
151 int llapi_get_poollist(const char *name, char **poollist, int list_size,
152 char *buffer, int buffer_size);
153 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
154 char *buffer, int buffer_size);
155 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
156 int llapi_file_lookup(int dirfd, const char *name);
157 void llapi_set_command_name(const char *cmd);
158 void llapi_clear_command_name(void);
160 enum llapi_layout_verbose {
161 VERBOSE_STRIPE_COUNT = 0x1,
162 VERBOSE_STRIPE_SIZE = 0x2,
163 VERBOSE_STRIPE_OFFSET = 0x4,
165 VERBOSE_DETAIL = 0x10,
166 VERBOSE_OBJID = 0x20,
167 VERBOSE_GENERATION = 0x40,
168 VERBOSE_MDTINDEX = 0x80,
169 VERBOSE_PATTERN = 0x100,
170 VERBOSE_COMP_COUNT = 0x200,
171 VERBOSE_COMP_FLAGS = 0x400,
172 VERBOSE_COMP_START = 0x800,
173 VERBOSE_COMP_END = 0x1000,
174 VERBOSE_COMP_ID = 0x2000,
175 VERBOSE_DFID = 0x4000,
176 VERBOSE_HASH_TYPE = 0x8000,
177 VERBOSE_MIRROR_COUNT = 0x10000,
178 VERBOSE_MIRROR_ID = 0x20000,
179 VERBOSE_EXT_SIZE = 0x40000,
180 VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
181 VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
182 VERBOSE_OBJID | VERBOSE_GENERATION |
183 VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
184 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
185 VERBOSE_COMP_START | VERBOSE_COMP_END |
186 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
187 VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE
189 /* Compatibility with original names */
190 #define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
191 #define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
192 #define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
193 #define VERBOSE_LAYOUT VERBOSE_PATTERN
196 NEWERXY_ATIME = 0, /* neweraY */
197 NEWERXY_MTIME = 1, /* newermY */
198 NEWERXY_CTIME = 2, /* newercY */
199 NEWERXY_BTIME = 3, /* newerbY | newerBY */
204 unsigned int fp_max_depth;
206 mode_t fp_type; /* S_IFIFO,... */
212 /* {a,m,c,b}sign cannot be bitfields due to using pointers to
213 * access them during argument parsing. */
217 /* these need to be signed values */
219 fp_stripe_size_sign:2,
220 fp_stripe_count_sign:2,
221 fp_comp_start_sign:2,
223 fp_comp_count_sign:2,
224 fp_mirror_count_sign:2,
225 fp_mirror_index_sign:2,
230 fp_unused1_sign:2, /* Fields available to use*/
231 fp_unused2_sign:2, /* Once used we must add */
232 fp_unused3_sign:2, /* a separate flag field */
233 fp_unused4_sign:2; /* at end of the struct. */
234 unsigned long long fp_size;
235 unsigned long long fp_size_units;
237 unsigned long long fp_zero_end:1,
239 fp_exclude_pattern:1,
247 fp_check_pool:1, /* LOV pool name */
248 fp_check_size:1, /* file size */
254 fp_get_lmv:1, /* get MDT list from LMV */
255 fp_raw:1, /* do not fill in defaults */
256 fp_check_stripe_size:1, /* LOV stripe size */
257 fp_exclude_stripe_size:1,
258 fp_check_stripe_count:1, /* LOV stripe count */
259 fp_exclude_stripe_count:1,
262 fp_get_default_lmv:1, /* Get default LMV */
266 fp_check_comp_count:1,
267 fp_exclude_comp_count:1,
268 fp_check_mirror_count:1,
269 fp_exclude_mirror_count:1,
270 fp_check_comp_flags:1,
271 fp_check_mirror_state:1,
272 fp_check_comp_start:1,
273 fp_exclude_comp_start:1,
275 fp_exclude_comp_end:1,
277 fp_exclude_comp_id:1,
278 fp_check_mirror_id:1,
279 fp_exclude_mirror_id:1,
280 fp_check_mirror_index:1,
281 fp_exclude_mirror_index:1,
282 fp_check_mdt_count:1,
283 fp_exclude_mdt_count:1,
284 fp_check_hash_type:1,
285 fp_exclude_hash_type:1,
286 fp_yaml:1, /* output layout in YAML */
290 fp_exclude_foreign:1,
291 fp_check_ext_size:1, /* extension size */
292 fp_exclude_ext_size:1,
296 fp_unused_bit3:1, /* All of these unused bit */
297 fp_unused_bit4:1, /* fields available to use.*/
298 fp_unused_bit5:1, /* Once all unused fields */
299 fp_unused_bit6:1, /* are used we need to add */
300 fp_unused_bit7:1; /* a separate flag field at*/
301 /* the end of the struct. */
303 enum llapi_layout_verbose fp_verbose;
306 /* regular expression */
309 struct obd_uuid *fp_obd_uuid;
311 int fp_num_alloc_obds;
315 struct obd_uuid *fp_mdt_uuid;
317 int fp_num_alloc_mdts;
320 int fp_file_mdt_index;
323 struct lov_user_mds_data *fp_lmd;
325 char fp_poolname[LOV_MAXPOOLNAME + 1];
327 __u32 fp_lmv_stripe_count;
328 struct lmv_user_md *fp_lmv_md;
330 unsigned long long fp_stripe_size;
331 unsigned long long fp_stripe_size_units;
332 unsigned long long fp_stripe_count;
336 __u32 fp_mirror_count;
338 __u32 fp_comp_neg_flags;
339 __u16 fp_mirror_state;
340 __u16 fp_mirror_neg_state;
343 __u16 fp_mirror_index;
344 unsigned long long fp_comp_start;
345 unsigned long long fp_comp_start_units;
346 unsigned long long fp_comp_end;
347 unsigned long long fp_comp_end_units;
348 unsigned long long fp_mdt_count;
350 unsigned long long fp_blocks;
351 unsigned long long fp_blocks_units;
353 unsigned long fp_got_uuids:1,
355 unsigned int fp_depth;
356 unsigned int fp_hash_type;
357 unsigned int fp_time_margin; /* time margin in seconds */
358 __u32 fp_foreign_type;
359 unsigned long long fp_ext_size;
360 unsigned long long fp_ext_size_units;
363 * fp_newery[NEWERXY_MAX][0]: --newerXY reference
364 * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
366 time_t fp_newery[NEWERXY_MAX][2];
372 int llapi_ostlist(char *path, struct find_param *param);
373 int llapi_uuid_match(char *real_uuid, char *search_uuid);
374 int llapi_getstripe(char *path, struct find_param *param);
375 int llapi_find(char *path, struct find_param *param);
377 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
378 int llapi_dir_set_default_lmv(const char *name,
379 const struct llapi_stripe_param *param);
380 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
381 int stripe_count, int stripe_pattern,
382 const char *pool_name);
383 int llapi_dir_create(const char *name, mode_t mode,
384 const struct llapi_stripe_param *param);
385 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
386 __u32 flags, const char *value);
387 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
388 int stripe_count, int stripe_pattern,
389 const char *poolname);
390 int llapi_direntry_remove(char *dname);
392 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
393 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
394 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
395 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
396 int llapi_ping(char *obd_type, char *obd_name);
397 int llapi_target_check(int num_types, char **obd_types, char *dir);
398 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
399 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
400 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
401 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
402 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
403 int llapi_is_lustre_mnttype(const char *type);
404 int llapi_search_tgt(const char *fsname, const char *poolname,
405 const char *tgtname, bool is_mdt);
406 int llapi_search_mdt(const char *fsname, const char *poolname,
407 const char *mdtname);
408 int llapi_search_ost(const char *fsname, const char *poolname,
409 const char *ostname);
410 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
411 int llapi_parse_size(const char *optarg, unsigned long long *size,
412 unsigned long long *size_units, int bytes_spec);
413 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
415 int llapi_search_fsname(const char *pathname, char *fsname);
416 int llapi_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
417 char *instance, size_t instance_len);
418 int llapi_get_instance(const char *path, char *instance, size_t instance_len);
419 int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
420 int llapi_getname(const char *path, char *name, size_t namelen);
421 int llapi_search_fileset(const char *pathname, char *fileset);
423 int llapi_search_rootpath(char *pathname, const char *fsname);
424 int llapi_nodemap_exists(const char *name);
425 int llapi_migrate_mdt(char *path, struct find_param *param);
426 int llapi_mv(char *path, struct find_param *param);
430 #define HAVE_LLAPI_IS_LUSTRE_MNT
431 int llapi_is_lustre_mnt(struct mntent *mnt);
432 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
433 int llapi_target_iterate(int type_num, char **obd_type, void *args,
435 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
436 int llapi_cp(int argc, char *argv[]);
437 int llapi_ls(int argc, char *argv[]);
438 int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
439 int llapi_fid2path(const char *device, const char *fidstr, char *path,
440 int pathlen, long long *recno, int *linkno);
441 int llapi_path2fid(const char *path, struct lu_fid *fid);
442 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
444 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
445 struct lov_user_md *lum, size_t lumsize);
446 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
447 struct lov_user_md *lum, size_t lumsize);
448 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
449 lstatx_t *statx, struct lov_user_md *lum,
451 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
452 struct lov_user_md *lum, size_t lumsize);
454 int llapi_fd2fid(int fd, struct lu_fid *fid);
455 /* get FID of parent dir + the related name of entry in this parent dir */
456 int llapi_path2parent(const char *path, unsigned int linkno,
457 struct lu_fid *parent_fid, char *name, size_t name_size);
458 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
459 char *name, size_t name_size);
460 int llapi_rmfid(const char *path, struct fid_array *fa);
461 int llapi_chomp_string(char *buf);
462 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
464 int llapi_get_version_string(char *version, unsigned int version_size);
465 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
466 int llapi_get_version(char *buffer, int buffer_size, char **version)
467 __attribute__((deprecated));
468 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
469 int llapi_file_flush(int fd);
470 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
471 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
472 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
473 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
475 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
477 int llapi_hsm_register_event_fifo(const char *path);
478 int llapi_hsm_unregister_event_fifo(const char *path);
479 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
480 const char *fmt, va_list args);
482 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
483 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
485 int llapi_create_volatile_param(const char *directory, int mdt_idx,
486 int open_flags, mode_t mode,
487 const struct llapi_stripe_param *stripe_param);
489 static inline int llapi_create_volatile(char *directory, int open_flags)
491 return llapi_create_volatile_idx(directory, -1, open_flags);
495 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
496 int gid, __u64 flags);
497 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
498 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
499 __u64 dv2, __u64 flags);
501 /* Changelog interface. priv is private state, managed internally by these
504 /* Records received are in extended format now, though most of them are still
505 * written in disk in changelog_rec format (to save space and time), it's
506 * converted to extended format in the lustre api to ease changelog analysis. */
507 #define HAVE_CHANGELOG_EXTEND_REC 1
509 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
510 const char *mdtname, long long startrec);
511 int llapi_changelog_fini(void **priv);
512 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
513 int llapi_changelog_in_buf(void *priv);
514 int llapi_changelog_free(struct changelog_rec **rech);
515 int llapi_changelog_get_fd(void *priv);
516 /* Allow records up to endrec to be destroyed; requires registered id. */
517 int llapi_changelog_clear(const char *mdtname, const char *idstr,
519 extern int llapi_changelog_set_xflags(void *priv,
520 enum changelog_send_extra_flag extra_flags);
522 /* HSM copytool interface.
523 * priv is private state, managed internally by these functions
525 struct hsm_copytool_private;
526 struct hsm_copyaction_private;
528 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
529 const char *mnt, int archive_count,
530 int *archives, int rfd_flags);
531 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
532 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
533 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
534 struct hsm_action_list **hal, int *msgsize);
535 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
536 const struct hsm_copytool_private *ct,
537 const struct hsm_action_item *hai,
538 int restore_mdt_index, int restore_open_flags,
540 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
541 const struct hsm_extent *he, int hp_flags, int errval);
542 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
543 const struct hsm_extent *he, __u64 total,
545 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
547 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
548 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
549 unsigned long long stripe_size, int stripe_offset,
550 int stripe_count, int stripe_pattern, char *pool_name,
551 struct lu_fid *newfid);
553 /* HSM user interface */
554 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
556 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
557 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
560 int llapi_json_init_list(struct llapi_json_item_list **item_list);
561 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
562 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
563 __u32 type, void *val);
564 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
567 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
568 int llapi_lease_release(int fd);
569 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
570 int llapi_lease_check(int fd);
571 int llapi_lease_get(int fd, int mode); /* obsoleted */
572 int llapi_lease_put(int fd); /* obsoleted */
575 int llapi_group_lock(int fd, int gid);
576 int llapi_group_unlock(int fd, int gid);
579 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
580 struct llapi_lu_ladvise *ladvise);
583 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
584 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
585 __u32 id, enum lu_pcc_type type);
586 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
587 __u32 id, enum lu_pcc_type type);
588 int llapi_pcc_detach_fd(int fd, __u32 option);
589 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
591 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
593 int llapi_pcc_detach_file(const char *path, __u32 option);
594 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
595 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
596 int llapi_pccdev_set(const char *mntpath, const char *cmd);
597 int llapi_pccdev_get(const char *mntpath);
600 /* llapi_layout user interface */
603 * An array element storing component info to be resynced during mirror
606 struct llapi_resync_comp {
609 uint32_t lrc_mirror_id;
610 uint32_t lrc_id; /* component id */
614 /** Opaque data type abstracting the layout of a Lustre file. */
617 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
618 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
619 size_t count, off_t pos);
620 uint32_t llapi_mirror_find(struct llapi_layout *layout,
621 uint64_t file_start, uint64_t file_end,
623 int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
624 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
625 struct llapi_layout *m_layout);
626 int llapi_mirror_find_stale(struct llapi_layout *layout,
627 struct llapi_resync_comp *comp, size_t comp_size,
628 __u16 *mirror_ids, int ids_nr);
629 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
630 struct llapi_resync_comp *comp_array,
631 int comp_size, uint64_t start, uint64_t end);
633 * Flags to control how layouts are retrieved.
636 /* Replace non-specified values with expected inherited values. */
637 #define LAYOUT_GET_EXPECTED 0x1
640 * Return a pointer to a newly-allocated opaque data structure containing
641 * the layout for the file at \a path. The pointer should be freed with
642 * llapi_layout_free() when it is no longer needed. Failure is indicated
643 * by a NULL return value and an appropriate error code stored in errno.
645 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
648 * Return a pointer to a newly-allocated opaque data type containing the
649 * layout for the file referenced by open file descriptor \a fd. The
650 * pointer should be freed with llapi_layout_free() when it is no longer
651 * needed. Failure is indicated by a NULL return value and an
652 * appropriate error code stored in errno.
654 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
657 * Return a pointer to a newly-allocated opaque data type containing the
658 * layout for the file associated with Lustre file identifier
659 * \a fid. The string \a path must name a path within the
660 * filesystem that contains the file being looked up, such as the
661 * filesystem root. The returned pointer should be freed with
662 * llapi_layout_free() when it is no longer needed. Failure is
663 * indicated with a NULL return value and an appropriate error code
666 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
667 const struct lu_fid *fid,
670 enum llapi_layout_xattr_flags {
671 LLAPI_LXF_CHECK = 0x0001,
672 LLAPI_LXF_COPY = 0x0002,
676 * Return a pointer to a newly-allocated opaque data type containing the
677 * layout for the file associated with extended attribute \a lov_xattr. The
678 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
679 * should be raw xattr without being swapped, since this function will swap it
680 * properly. Thus, \a lov_xattr will be modified during the process. If the
681 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
682 * the objects count in lum is consistent with the stripe count in lum. This
683 * check only apply to regular file, so \a LLAPI_LXF_CHECK flag should be
684 * cleared if the xattr belongs to a directory. If the \a LLAPI_LXF_COPY flag
685 * of \a flags is set, this function will use a temporary buffer for byte
686 * swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the byte
687 * swapping will be done to the \a lov_xattr buffer directly. The returned
688 * pointer should be freed with llapi_layout_free() when it is no longer
689 * needed. Failure is * indicated with a NULL return value and an appropriate
690 * error code stored in errno.
692 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
693 ssize_t lov_xattr_size,
697 * Allocate a new layout. Use this when creating a new file with
698 * llapi_layout_file_create().
700 struct llapi_layout *llapi_layout_alloc(void);
703 * Free memory allocated for \a layout.
705 void llapi_layout_free(struct llapi_layout *layout);
708 * llapi_layout_merge() - Merge a composite layout into another one.
709 * @dst_layout: Destination composite layout.
710 * @src_layout: Source composite layout.
712 * This function copies all of the components from @src_layout and
713 * appends them to @dst_layout.
715 * Return: 0 on success or -1 on failure.
717 int llapi_layout_merge(struct llapi_layout **dst_layout,
718 const struct llapi_layout *src_layout);
720 /** Not a valid stripe size, offset, or RAID pattern. */
721 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
724 * When specified or returned as the value for stripe count,
725 * stripe size, offset, or RAID pattern, the filesystem-wide
726 * default behavior will apply.
728 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
731 * When specified or returned as the value for stripe count, all
732 * available OSTs will be used.
734 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
737 * When specified as the value for layout pattern, file objects will be
738 * stored using RAID0. That is, data will be split evenly and without
739 * redundancy across all OSTs in the layout.
741 #define LLAPI_LAYOUT_RAID0 0ULL
742 #define LLAPI_LAYOUT_MDT 2ULL
743 #define LLAPI_LAYOUT_OVERSTRIPING 4ULL
746 * The layout includes a specific set of OSTs on which to allocate.
748 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
751 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
753 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
756 * Flags to modify how layouts are retrieved.
758 /******************** Stripe Count ********************/
761 * Store the stripe count of \a layout in \a count.
764 * \retval -1 Error with status code in errno.
766 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
770 * Set the stripe count of \a layout to \a count.
773 * \retval -1 Invalid argument, errno set to EINVAL.
775 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
777 /******************** Stripe Size ********************/
780 * Store the stripe size of \a layout in \a size.
783 * \retval -1 Invalid argument, errno set to EINVAL.
785 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
789 * Set the stripe size of \a layout to \a stripe_size.
792 * \retval -1 Invalid argument, errno set to EINVAL.
794 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
797 /******************** Extension Size ********************/
800 * Store the extension size of \a layout in \a size.
803 * \retval -1 Invalid argument, errno set to EINVAL.
805 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
809 * Set the extension size of \a layout to \a stripe_size.
812 * \retval -1 Invalid argument, errno set to EINVAL.
814 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
817 /******************** Stripe Pattern ********************/
820 * Store the stripe pattern of \a layout in \a pattern.
823 * \retval -1 Error with status code in errno.
825 int llapi_layout_pattern_get(const struct llapi_layout *layout,
829 * Set the stripe pattern of \a layout to \a pattern.
832 * \retval -1 Invalid argument, errno set to EINVAL.
834 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
836 /******************** OST Index ********************/
839 * Store the index of the OST where stripe number \a stripe_number is stored
842 * An error return value will result from a NULL layout, if \a
843 * stripe_number is out of range, or if \a layout was not initialized
844 * with llapi_layout_lookup_by{path,fd,fid}().
847 * \retval -1 Invalid argument, errno set to EINVAL.
849 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
850 uint64_t stripe_number, uint64_t *index);
853 * Set the OST index associated with stripe number \a stripe_number to
855 * NB: This is currently supported only for \a stripe_number = 0 and
856 * other usage will return ENOTSUPP in errno. A NULL \a layout or
857 * out-of-range \a stripe_number will return EINVAL in errno.
860 * \retval -1 Error with errno set to non-zero value.
862 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
865 /******************** Pool Name ********************/
868 * Store up to \a pool_name_len characters of the name of the pool of
869 * OSTs associated with \a layout into the buffer pointed to by
872 * The correct calling form is:
874 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
876 * A pool defines a set of OSTs from which file objects may be
877 * allocated for a file using \a layout.
879 * On success, the number of bytes stored is returned, excluding the
880 * terminating '\0' character (zero indicates that \a layout does not
881 * have an associated OST pool). On error, -1 is returned and errno is
882 * set appropriately. Possible sources of error include a NULL pointer
883 * argument or insufficient space in \a dest to store the pool name,
884 * in which cases errno will be set to EINVAL.
886 * \retval 0+ The number of bytes stored in \a dest.
887 * \retval -1 Invalid argument, errno set to EINVAL.
889 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
890 char *pool_name, size_t pool_name_len);
893 * Set the name of the pool of OSTs from which file objects will be
894 * allocated to \a pool_name.
896 * If the pool name uses "fsname.pool" notation to qualify the pool name
897 * with a filesystem name, the "fsname." portion will be silently
898 * discarded before storing the value. No validation that \a pool_name
899 * is an existing non-empty pool in filesystem \a fsname will be
900 * performed. Such validation can be performed by the application if
901 * desired using the llapi_search_ost() function. The maximum length of
902 * the stored value is defined by the constant LOV_MAXPOOLNAME.
905 * \retval -1 Invalid argument, errno set to EINVAL.
907 int llapi_layout_pool_name_set(struct llapi_layout *layout,
908 const char *pool_name);
910 /******************** File Creation ********************/
913 * Open an existing file at \a path, or create it with the specified
914 * \a layout and \a mode.
916 * One access mode and zero or more file creation flags and file status
917 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
918 * open file descriptor for the file. If \a layout is non-NULL and
919 * \a path is not on a Lustre filesystem this function will fail and set
922 * An already existing file may be opened with this function, but
923 * \a layout and \a mode will not be applied to it. Callers requiring a
924 * guarantee that the opened file is created with the specified
925 * \a layout and \a mode should use llapi_layout_file_create().
927 * A NULL \a layout may be specified, in which case the standard Lustre
928 * behavior for assigning layouts to newly-created files will apply.
930 * \retval 0+ An open file descriptor.
931 * \retval -1 Error with status code in errno.
933 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
934 const struct llapi_layout *layout);
937 * Create a new file at \a path with the specified \a layout and \a mode.
939 * One access mode and zero or more file creation flags and file status
940 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
941 * open file descriptor for the file. If \a layout is non-NULL and
942 * \a path is not on a Lustre filesystem this function will fail and set
947 * llapi_layout_file_create(path, open_flags, mode, layout)
949 * shall be equivalent to:
951 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
953 * It is an error if \a path specifies an existing file.
955 * A NULL \a layout may be specified, in which the standard Lustre
956 * behavior for assigning layouts to newly-created files will apply.
958 * \retval 0+ An open file descriptor.
959 * \retval -1 Error with status code in errno.
961 int llapi_layout_file_create(const char *path, int open_flags, int mode,
962 const struct llapi_layout *layout);
965 * Set flags to the header of component layout.
967 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
968 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
969 const char *llapi_layout_flags_string(uint32_t flags);
970 const __u16 llapi_layout_string_flags(char *string);
973 * llapi_layout_mirror_count_get() - Get mirror count from the header of
975 * @layout: Layout to get mirror count from.
976 * @count: Returned mirror count value.
978 * This function gets mirror count from the header of a layout.
980 * Return: 0 on success or -1 on failure.
982 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
986 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
987 * @layout: Layout to set mirror count in.
988 * @count: Mirror count value to be set.
990 * This function sets mirror count to the header of a layout.
992 * Return: 0 on success or -1 on failure.
994 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
998 * Fetch the start and end offset of the current layout component.
1000 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1001 uint64_t *start, uint64_t *end);
1003 * Set the extent of current layout component.
1005 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1006 uint64_t start, uint64_t end);
1008 /* PFL component flags table */
1009 static const struct comp_flag_name {
1010 enum lov_comp_md_entry_flags cfn_flag;
1011 const char *cfn_name;
1012 } comp_flags_table[] = {
1013 { LCME_FL_INIT, "init" },
1014 { LCME_FL_STALE, "stale" },
1015 { LCME_FL_PREF_RW, "prefer" },
1016 { LCME_FL_OFFLINE, "offline" },
1017 { LCME_FL_NOSYNC, "nosync" },
1018 { LCME_FL_EXTENSION, "extension" },
1022 * Gets the attribute flags of the current component.
1024 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1027 * Sets the specified flags of the current component leaving other flags as-is.
1029 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1031 * Clears the flags specified in the flags leaving other flags as-is.
1033 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1035 * Fetches the file-unique component ID of the current layout component.
1037 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1039 * Fetches the mirror ID of the current layout component.
1041 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1043 * Adds one component to the existing composite or plain layout.
1045 int llapi_layout_comp_add(struct llapi_layout *layout);
1047 * Adds a first component of a mirror to the existing composite layout.
1049 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1051 * Deletes the current layout component from the composite layout.
1053 int llapi_layout_comp_del(struct llapi_layout *layout);
1055 enum llapi_layout_comp_use {
1056 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1057 LLAPI_LAYOUT_COMP_USE_LAST = 2,
1058 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1059 LLAPI_LAYOUT_COMP_USE_PREV = 4,
1063 * Set the currently active component to the specified component ID.
1065 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1067 * Select the currently active component at the specified position.
1069 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1071 * Add layout components to an existing file.
1073 int llapi_layout_file_comp_add(const char *path,
1074 const struct llapi_layout *layout);
1076 * Delete component(s) by the specified component id or flags.
1078 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1080 * Change flags or other parameters of the component(s) by component ID of an
1081 * existing file. The component to be modified is specified by the
1082 * comp->lcme_id value, which must be an unique component ID. The new
1083 * attributes are passed in by @comp and @valid is used to specify which
1084 * attributes in the component are going to be changed.
1086 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1089 * Check if the file layout is composite.
1091 bool llapi_layout_is_composite(struct llapi_layout *layout);
1094 LLAPI_LAYOUT_ITER_CONT = 0,
1095 LLAPI_LAYOUT_ITER_STOP = 1,
1099 * Iteration callback function.
1101 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
1102 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
1103 * \retval < 0 error code
1105 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1108 * Iterate all components in the corresponding layout
1110 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1111 llapi_layout_iter_cb cb, void *cbdata);
1114 * FLR: mirror operation APIs
1116 int llapi_mirror_set(int fd, unsigned int id);
1117 int llapi_mirror_clear(int fd);
1118 ssize_t llapi_mirror_read(int fd, unsigned int id,
1119 void *buf, size_t count, off_t pos);
1120 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1121 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1122 off_t pos, size_t count);
1124 int llapi_heat_get(int fd, struct lu_heat *heat);
1125 int llapi_heat_set(int fd, __u64 flags);
1126 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
1127 void llapi_layout_sanity_perror(int error);
1128 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1130 int llapi_param_get_paths(const char *pattern, glob_t *paths);
1131 int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
1132 void llapi_param_paths_free(glob_t *paths);
1136 #if defined(__cplusplus)