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
69 * BUILD_BUG_ON() is Compile-time check which verifies correctness at
70 * compile-time rather than runtime. If "cond" is true, (1 - 2*!!(cond))
71 * will be a negative value, which will cause the compiler to complain.
75 #define BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2*!!(cond)]))
78 /* Currently external applications can access this but in the
79 * future this will no longer be exposed for the user. Instead
80 * if you want to know if the library is initialized just call
81 * llapi_liblustreapi_initialized() which is now available. */
82 extern bool liblustreapi_initialized;
84 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
87 /* lustreapi message severity level */
88 enum llapi_message_level {
99 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
100 const char *fmt, va_list ap);
102 static inline bool llapi_liblustreapi_initialized(void)
104 return liblustreapi_initialized;
107 /* the bottom three bits reserved for llapi_message_level */
108 #define LLAPI_MSG_MASK 0x00000007
109 #define LLAPI_MSG_NO_ERRNO 0x00000010
111 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
113 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
117 if (level >= LLAPI_MSG_MAX)
120 return levels[level];
123 void llapi_msg_set_level(int level);
124 int llapi_msg_get_level(void);
125 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
126 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
128 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
129 __attribute__((__format__(__printf__, 3, 4)));
130 #define llapi_err_noerrno(level, fmt, a...) \
131 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
132 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
133 __attribute__((__format__(__printf__, 2, 3)));
135 struct llapi_stripe_param {
136 unsigned long long lsp_stripe_size;
138 int lsp_stripe_offset;
139 int lsp_stripe_pattern;
140 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
141 int lsp_stripe_count;
142 bool lsp_is_specific;
147 #define lsp_tgts lsp_osts
149 __u32 llapi_pattern_to_lov(uint64_t pattern);
151 int llapi_file_open_param(const char *name, int flags, mode_t mode,
152 const struct llapi_stripe_param *param);
153 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
154 __u32 flags, char *foreign_lov);
155 int llapi_file_create(const char *name, unsigned long long stripe_size,
156 int stripe_offset, int stripe_count, int stripe_pattern);
157 int llapi_file_open(const char *name, int flags, int mode,
158 unsigned long long stripe_size, int stripe_offset,
159 int stripe_count, int stripe_pattern);
160 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
161 int stripe_offset, int stripe_count,
162 int stripe_pattern, char *pool_name);
163 int llapi_file_open_pool(const char *name, int flags, int mode,
164 unsigned long long stripe_size, int stripe_offset,
165 int stripe_count, int stripe_pattern, char *pool_name);
166 int llapi_poollist(const char *name);
167 int llapi_get_poollist(const char *name, char **poollist, int list_size,
168 char *buffer, int buffer_size);
169 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
170 char *buffer, int buffer_size);
171 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
172 int llapi_file_lookup(int dirfd, const char *name);
173 void llapi_set_command_name(const char *cmd);
174 void llapi_clear_command_name(void);
176 enum llapi_layout_verbose {
177 VERBOSE_STRIPE_COUNT = 0x1,
178 VERBOSE_STRIPE_SIZE = 0x2,
179 VERBOSE_STRIPE_OFFSET = 0x4,
181 VERBOSE_DETAIL = 0x10,
182 VERBOSE_OBJID = 0x20,
183 VERBOSE_GENERATION = 0x40,
184 VERBOSE_MDTINDEX = 0x80,
185 VERBOSE_PATTERN = 0x100,
186 VERBOSE_COMP_COUNT = 0x200,
187 VERBOSE_COMP_FLAGS = 0x400,
188 VERBOSE_COMP_START = 0x800,
189 VERBOSE_COMP_END = 0x1000,
190 VERBOSE_COMP_ID = 0x2000,
191 VERBOSE_DFID = 0x4000,
192 VERBOSE_HASH_TYPE = 0x8000,
193 VERBOSE_MIRROR_COUNT = 0x10000,
194 VERBOSE_MIRROR_ID = 0x20000,
195 VERBOSE_EXT_SIZE = 0x40000,
196 VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
197 VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
198 VERBOSE_OBJID | VERBOSE_GENERATION |
199 VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
200 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
201 VERBOSE_COMP_START | VERBOSE_COMP_END |
202 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
203 VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE
205 /* Compatibility with original names */
206 #define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
207 #define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
208 #define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
209 #define VERBOSE_LAYOUT VERBOSE_PATTERN
212 NEWERXY_ATIME = 0, /* neweraY */
213 NEWERXY_MTIME = 1, /* newermY */
214 NEWERXY_CTIME = 2, /* newercY */
215 NEWERXY_BTIME = 3, /* newerbY | newerBY */
220 unsigned int fp_max_depth;
222 mode_t fp_type; /* S_IFIFO,... */
228 /* {a,m,c,b}sign cannot be bitfields due to using pointers to
229 * access them during argument parsing. */
233 /* these need to be signed values */
235 fp_stripe_size_sign:2,
236 fp_stripe_count_sign:2,
237 fp_comp_start_sign:2,
239 fp_comp_count_sign:2,
240 fp_mirror_count_sign:2,
241 fp_mirror_index_sign:2,
246 fp_unused1_sign:2, /* Fields available to use*/
247 fp_unused2_sign:2, /* Once used we must add */
248 fp_unused3_sign:2, /* a separate flag field */
249 fp_unused4_sign:2; /* at end of the struct. */
250 unsigned long long fp_size;
251 unsigned long long fp_size_units;
253 unsigned long long fp_zero_end:1,
255 fp_exclude_pattern:1,
263 fp_check_pool:1, /* LOV pool name */
264 fp_check_size:1, /* file size */
270 fp_get_lmv:1, /* get MDT list from LMV */
271 fp_raw:1, /* do not fill in defaults */
272 fp_check_stripe_size:1, /* LOV stripe size */
273 fp_exclude_stripe_size:1,
274 fp_check_stripe_count:1, /* LOV stripe count */
275 fp_exclude_stripe_count:1,
278 fp_get_default_lmv:1, /* Get default LMV */
282 fp_check_comp_count:1,
283 fp_exclude_comp_count:1,
284 fp_check_mirror_count:1,
285 fp_exclude_mirror_count:1,
286 fp_check_comp_flags:1,
287 fp_check_mirror_state:1,
288 fp_check_comp_start:1,
289 fp_exclude_comp_start:1,
291 fp_exclude_comp_end:1,
293 fp_exclude_comp_id:1,
294 fp_check_mirror_id:1,
295 fp_exclude_mirror_id:1,
296 fp_check_mirror_index:1,
297 fp_exclude_mirror_index:1,
298 fp_check_mdt_count:1,
299 fp_exclude_mdt_count:1,
300 fp_check_hash_flag:1,
301 fp_exclude_hash_type:1,
302 fp_yaml:1, /* output layout in YAML */
306 fp_exclude_foreign:1,
307 fp_check_ext_size:1, /* extension size */
308 fp_exclude_ext_size:1,
312 fp_unused_bit3:1, /* All of these unused bit */
313 fp_unused_bit4:1, /* fields available to use.*/
314 fp_unused_bit5:1, /* Once all unused fields */
315 fp_unused_bit6:1, /* are used we need to add */
316 fp_unused_bit7:1; /* a separate flag field at*/
317 /* the end of the struct. */
319 enum llapi_layout_verbose fp_verbose;
322 /* regular expression */
325 struct obd_uuid *fp_obd_uuid;
327 int fp_num_alloc_obds;
331 struct obd_uuid *fp_mdt_uuid;
333 int fp_num_alloc_mdts;
336 int fp_file_mdt_index;
339 struct lov_user_mds_data *fp_lmd;
341 char fp_poolname[LOV_MAXPOOLNAME + 1];
343 __u32 fp_lmv_stripe_count;
344 struct lmv_user_md *fp_lmv_md;
346 unsigned long long fp_stripe_size;
347 unsigned long long fp_stripe_size_units;
348 unsigned long long fp_stripe_count;
352 __u32 fp_mirror_count;
354 __u32 fp_comp_neg_flags;
355 __u16 fp_mirror_state;
356 __u16 fp_mirror_neg_state;
359 __u16 fp_mirror_index;
360 unsigned long long fp_comp_start;
361 unsigned long long fp_comp_start_units;
362 unsigned long long fp_comp_end;
363 unsigned long long fp_comp_end_units;
364 unsigned long long fp_mdt_count;
366 unsigned long long fp_blocks;
367 unsigned long long fp_blocks_units;
369 unsigned long fp_got_uuids:1,
371 unsigned int fp_depth;
372 unsigned int fp_hash_type;
373 unsigned int fp_time_margin; /* time margin in seconds */
374 __u32 fp_foreign_type;
375 unsigned long long fp_ext_size;
376 unsigned long long fp_ext_size_units;
379 * fp_newery[NEWERXY_MAX][0]: --newerXY reference
380 * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
382 time_t fp_newery[NEWERXY_MAX][2];
386 unsigned int fp_hash_inflags;
387 unsigned int fp_hash_exflags;
390 int llapi_ostlist(char *path, struct find_param *param);
391 int llapi_uuid_match(char *real_uuid, char *search_uuid);
392 int llapi_getstripe(char *path, struct find_param *param);
393 int llapi_find(char *path, struct find_param *param);
395 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
396 int llapi_dir_set_default_lmv(const char *name,
397 const struct llapi_stripe_param *param);
398 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
399 int stripe_count, int stripe_pattern,
400 const char *pool_name);
401 int llapi_dir_create(const char *name, mode_t mode,
402 const struct llapi_stripe_param *param);
403 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
404 __u32 flags, const char *value);
405 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
406 int stripe_count, int stripe_pattern,
407 const char *poolname);
408 int llapi_direntry_remove(char *dname);
409 int llapi_unlink_foreign(char *dname);
411 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
412 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
413 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
414 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
415 int llapi_ping(char *obd_type, char *obd_name);
416 int llapi_target_check(int num_types, char **obd_types, char *dir);
417 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
418 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
419 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
420 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
421 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
422 int llapi_is_lustre_mnttype(const char *type);
423 int llapi_search_tgt(const char *fsname, const char *poolname,
424 const char *tgtname, bool is_mdt);
425 int llapi_search_mdt(const char *fsname, const char *poolname,
426 const char *mdtname);
427 int llapi_search_ost(const char *fsname, const char *poolname,
428 const char *ostname);
429 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
430 int llapi_parse_size(const char *optarg, unsigned long long *size,
431 unsigned long long *size_units, int bytes_spec);
432 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
434 int llapi_search_fsname(const char *pathname, char *fsname);
435 int llapi_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
436 char *instance, size_t instance_len);
437 int llapi_get_instance(const char *path, char *instance, size_t instance_len);
438 int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
439 int llapi_getname(const char *path, char *name, size_t namelen);
440 int llapi_search_fileset(const char *pathname, char *fileset);
442 int llapi_search_rootpath(char *pathname, const char *fsname);
443 int llapi_nodemap_exists(const char *name);
444 int llapi_migrate_mdt(char *path, struct find_param *param);
445 int llapi_mv(char *path, struct find_param *param);
449 #define HAVE_LLAPI_IS_LUSTRE_MNT
450 int llapi_is_lustre_mnt(struct mntent *mnt);
451 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
452 int llapi_target_iterate(int type_num, char **obd_type, void *args,
454 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
455 int llapi_cp(int argc, char *argv[]);
456 int llapi_ls(int argc, char *argv[]);
457 int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
458 int llapi_fid2path_at(int mnt_fd, const struct lu_fid *fid, char *path,
459 int pathlen, long long *recno, int *linkno);
460 int llapi_fid2path(const char *device, const char *fidstr, char *path,
461 int pathlen, long long *recno, int *linkno);
462 int llapi_path2fid(const char *path, struct lu_fid *fid);
463 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
465 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
466 struct lov_user_md *lum, size_t lumsize);
467 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
468 struct lov_user_md *lum, size_t lumsize);
469 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
470 lstatx_t *statx, struct lov_user_md *lum,
472 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
473 struct lov_user_md *lum, size_t lumsize);
475 int llapi_fd2fid(int fd, struct lu_fid *fid);
476 /* get FID of parent dir + the related name of entry in this parent dir */
477 int llapi_path2parent(const char *path, unsigned int linkno,
478 struct lu_fid *parent_fid, char *name, size_t name_size);
479 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
480 char *name, size_t name_size);
481 int llapi_rmfid(const char *path, struct fid_array *fa);
482 int llapi_chomp_string(char *buf);
483 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
485 int llapi_get_version_string(char *version, unsigned int version_size);
486 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
487 int llapi_get_version(char *buffer, int buffer_size, char **version)
488 __attribute__((deprecated));
489 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
490 int llapi_file_flush(int fd);
491 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
492 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
493 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
494 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
496 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
498 int llapi_hsm_register_event_fifo(const char *path);
499 int llapi_hsm_unregister_event_fifo(const char *path);
500 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
501 const char *fmt, va_list args);
503 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
504 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
506 int llapi_create_volatile_param(const char *directory, int mdt_idx,
507 int open_flags, mode_t mode,
508 const struct llapi_stripe_param *stripe_param);
510 static inline int llapi_create_volatile(char *directory, int open_flags)
512 return llapi_create_volatile_idx(directory, -1, open_flags);
516 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
517 int gid, __u64 flags);
518 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
519 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
520 __u64 dv2, __u64 flags);
522 /* Changelog interface. priv is private state, managed internally by these
525 /* Records received are in extended format now, though most of them are still
526 * written in disk in changelog_rec format (to save space and time), it's
527 * converted to extended format in the lustre api to ease changelog analysis. */
528 #define HAVE_CHANGELOG_EXTEND_REC 1
530 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
531 const char *mdtname, long long startrec);
532 int llapi_changelog_fini(void **priv);
533 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
534 int llapi_changelog_in_buf(void *priv);
535 int llapi_changelog_free(struct changelog_rec **rech);
536 int llapi_changelog_get_fd(void *priv);
537 /* Allow records up to endrec to be destroyed; requires registered id. */
538 int llapi_changelog_clear(const char *mdtname, const char *idstr,
540 extern int llapi_changelog_set_xflags(void *priv,
541 enum changelog_send_extra_flag extra_flags);
543 /* HSM copytool interface.
544 * priv is private state, managed internally by these functions
546 struct hsm_copytool_private;
547 struct hsm_copyaction_private;
549 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
550 const char *mnt, int archive_count,
551 int *archives, int rfd_flags);
552 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
553 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
554 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
555 struct hsm_action_list **hal, int *msgsize);
556 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
557 const struct hsm_copytool_private *ct,
558 const struct hsm_action_item *hai,
559 int restore_mdt_index, int restore_open_flags,
561 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
562 const struct hsm_extent *he, int hp_flags, int errval);
563 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
564 const struct hsm_extent *he, __u64 total,
566 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
568 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
569 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
570 unsigned long long stripe_size, int stripe_offset,
571 int stripe_count, int stripe_pattern, char *pool_name,
572 struct lu_fid *newfid);
574 /* HSM user interface */
575 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
577 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
578 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
581 enum llapi_json_types {
582 LLAPI_JSON_INTEGER = 1,
588 struct llapi_json_item {
597 struct llapi_json_item *lji_next;
600 struct llapi_json_item_list {
602 struct llapi_json_item *ljil_items;
605 int llapi_json_init_list(struct llapi_json_item_list **item_list);
606 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
607 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
608 __u32 type, void *val);
609 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
612 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
613 int llapi_lease_release(int fd);
614 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
615 int llapi_lease_check(int fd);
616 int llapi_lease_get(int fd, int mode); /* obsoleted */
617 int llapi_lease_put(int fd); /* obsoleted */
620 int llapi_group_lock(int fd, int gid);
621 int llapi_group_unlock(int fd, int gid);
622 int llapi_group_lock64(int fd, __u64 gid);
623 int llapi_group_unlock64(int fd, __u64 gid);
625 bool llapi_file_is_sparse(int fd);
626 off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
627 int llapi_hole_punch(int fd, off_t start, size_t length);
630 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
631 struct llapi_lu_ladvise *ladvise);
634 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
635 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
636 __u32 id, enum lu_pcc_type type);
637 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
638 __u32 id, enum lu_pcc_type type);
639 int llapi_pcc_detach_fd(int fd, __u32 option);
640 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
642 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
644 int llapi_pcc_detach_file(const char *path, __u32 option);
645 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
646 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
647 int llapi_pccdev_set(const char *mntpath, const char *cmd);
648 int llapi_pccdev_get(const char *mntpath);
651 /* llapi_layout user interface */
654 * An array element storing component info to be resynced during mirror
657 struct llapi_resync_comp {
660 uint32_t lrc_mirror_id;
661 uint32_t lrc_id; /* component id */
665 /** Opaque data type abstracting the layout of a Lustre file. */
668 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
669 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
670 size_t count, off_t pos);
671 uint32_t llapi_mirror_find(struct llapi_layout *layout,
672 uint64_t file_start, uint64_t file_end,
674 int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
675 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
676 struct llapi_layout *m_layout);
677 int llapi_mirror_find_stale(struct llapi_layout *layout,
678 struct llapi_resync_comp *comp, size_t comp_size,
679 __u16 *mirror_ids, int ids_nr);
680 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
681 struct llapi_resync_comp *comp_array,
682 int comp_size, uint64_t start, uint64_t end);
684 * Flags to control how layouts are retrieved.
687 enum llapi_layout_get_flags {
688 /** Replace non-specified values with expected inherited values. */
689 LLAPI_LAYOUT_GET_EXPECTED = 0x0001,
690 /** Use a temporary buffer to swab and return xattrs. */
691 LLAPI_LAYOUT_GET_COPY = 0x0002,
692 /** Verify xattr contains sane layout values. */
693 LLAPI_LAYOUT_GET_CHECK = 0x0004,
695 /* compatibility macros for old interfaces */
696 #define LAYOUT_GET_EXPECTED LLAPI_LAYOUT_GET_EXPECTED
697 #define LLAPI_LXF_COPY LLAPI_LAYOUT_GET_COPY
698 #define LLAPI_LXF_CHECK LLAPI_LAYOUT_GET_CHECK
701 * Return a pointer to a newly-allocated opaque data structure containing
702 * the layout for the file at \a path. The pointer should be freed with
703 * llapi_layout_free() when it is no longer needed. Failure is indicated
704 * by a NULL return value and an appropriate error code stored in errno.
706 struct llapi_layout *llapi_layout_get_by_path(const char *path,
707 enum llapi_layout_get_flags flags);
710 * Return a pointer to a newly-allocated opaque data type containing the
711 * layout for the file referenced by open file descriptor \a fd. The
712 * pointer should be freed with llapi_layout_free() when it is no longer
713 * needed. Failure is indicated by a NULL return value and an
714 * appropriate error code stored in errno.
716 struct llapi_layout *llapi_layout_get_by_fd(int fd,
717 enum llapi_layout_get_flags flags);
720 * Return a pointer to a newly-allocated opaque data type containing the
721 * layout for the file associated with Lustre file identifier
722 * \a fid. The string \a path must name a path within the
723 * filesystem that contains the file being looked up, such as the
724 * filesystem root. The returned pointer should be freed with
725 * llapi_layout_free() when it is no longer needed. Failure is
726 * indicated with a NULL return value and an appropriate error code
729 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
730 const struct lu_fid *fid,
731 enum llapi_layout_get_flags flags);
734 * Return a pointer to a newly-allocated opaque data type containing the
735 * layout for the file associated with extended attribute \a lov_xattr. The
736 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
737 * should be raw xattr without being swapped, since this function will swap it
738 * properly. Thus, \a lov_xattr will be modified during the process. If the
739 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
740 * the objects count in lum is consistent with the stripe count in lum. This
741 * check only apply to regular file, so \a LLAPI_LAYOUT_GET_CHECK flag should
742 * be cleared if the xattr belongs to a directory. If the flag \a
743 * LLAPI_LAYOUT_GET_COPY is set, this function will use a temporary buffer for
744 * byte swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the
745 * byte swapping will be done to the \a lov_xattr buffer directly. The returned
746 * pointer should be freed with llapi_layout_free() when it is no longer
747 * needed. Failure is * indicated with a NULL return value and an appropriate
748 * error code stored in errno.
750 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
751 ssize_t lov_xattr_size,
752 enum llapi_layout_get_flags flags);
755 * Allocate a new layout. Use this when creating a new file with
756 * llapi_layout_file_create().
758 struct llapi_layout *llapi_layout_alloc(void);
761 * Free memory allocated for \a layout.
763 void llapi_layout_free(struct llapi_layout *layout);
766 * llapi_layout_merge() - Merge a composite layout into another one.
767 * @dst_layout: Destination composite layout.
768 * @src_layout: Source composite layout.
770 * This function copies all of the components from @src_layout and
771 * appends them to @dst_layout.
773 * Return: 0 on success or -1 on failure.
775 int llapi_layout_merge(struct llapi_layout **dst_layout,
776 const struct llapi_layout *src_layout);
778 /** Not a valid stripe size, offset, or RAID pattern. */
779 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
782 * When specified or returned as the value for stripe count,
783 * stripe size, offset, or RAID pattern, the filesystem-wide
784 * default behavior will apply.
786 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
789 * When specified or returned as the value for stripe count, all
790 * available OSTs will be used.
792 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
795 * When specified as the value for layout pattern, file objects will be
796 * stored using RAID0. That is, data will be split evenly and without
797 * redundancy across all OSTs in the layout.
799 #define LLAPI_LAYOUT_RAID0 0ULL
800 #define LLAPI_LAYOUT_MDT 2ULL
801 #define LLAPI_LAYOUT_OVERSTRIPING 4ULL
804 * The layout includes a specific set of OSTs on which to allocate.
806 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
809 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
811 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
814 * Flags to modify how layouts are retrieved.
816 /******************** Stripe Count ********************/
819 * Store the stripe count of \a layout in \a count.
822 * \retval -1 Error with status code in errno.
824 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
828 * Set the stripe count of \a layout to \a count.
831 * \retval -1 Invalid argument, errno set to EINVAL.
833 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
835 /******************** Stripe Size ********************/
838 * Store the stripe size of \a layout in \a size.
841 * \retval -1 Invalid argument, errno set to EINVAL.
843 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
847 * Set the stripe size of \a layout to \a stripe_size.
850 * \retval -1 Invalid argument, errno set to EINVAL.
852 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
855 /******************** Extension Size ********************/
858 * Store the extension size of \a layout in \a size.
861 * \retval -1 Invalid argument, errno set to EINVAL.
863 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
867 * Set the extension size of \a layout to \a stripe_size.
870 * \retval -1 Invalid argument, errno set to EINVAL.
872 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
875 /******************** Stripe Pattern ********************/
878 * Store the stripe pattern of \a layout in \a pattern.
881 * \retval -1 Error with status code in errno.
883 int llapi_layout_pattern_get(const struct llapi_layout *layout,
887 * Set the stripe pattern of \a layout to \a pattern.
890 * \retval -1 Invalid argument, errno set to EINVAL.
892 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
894 /******************** OST Index ********************/
897 * Store the index of the OST where stripe number \a stripe_number is stored
900 * An error return value will result from a NULL layout, if \a
901 * stripe_number is out of range, or if \a layout was not initialized
902 * with llapi_layout_lookup_by{path,fd,fid}().
905 * \retval -1 Invalid argument, errno set to EINVAL.
907 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
908 uint64_t stripe_number, uint64_t *index);
911 * Set the OST index associated with stripe number \a stripe_number to
913 * NB: This is currently supported only for \a stripe_number = 0 and
914 * other usage will return ENOTSUPP in errno. A NULL \a layout or
915 * out-of-range \a stripe_number will return EINVAL in errno.
918 * \retval -1 Error with errno set to non-zero value.
920 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
923 /******************** Pool Name ********************/
926 * Store up to \a pool_name_len characters of the name of the pool of
927 * OSTs associated with \a layout into the buffer pointed to by
930 * The correct calling form is:
932 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
934 * A pool defines a set of OSTs from which file objects may be
935 * allocated for a file using \a layout.
937 * On success, the number of bytes stored is returned, excluding the
938 * terminating '\0' character (zero indicates that \a layout does not
939 * have an associated OST pool). On error, -1 is returned and errno is
940 * set appropriately. Possible sources of error include a NULL pointer
941 * argument or insufficient space in \a dest to store the pool name,
942 * in which cases errno will be set to EINVAL.
944 * \retval 0+ The number of bytes stored in \a dest.
945 * \retval -1 Invalid argument, errno set to EINVAL.
947 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
948 char *pool_name, size_t pool_name_len);
951 * Set the name of the pool of OSTs from which file objects will be
952 * allocated to \a pool_name.
954 * If the pool name uses "fsname.pool" notation to qualify the pool name
955 * with a filesystem name, the "fsname." portion will be silently
956 * discarded before storing the value. No validation that \a pool_name
957 * is an existing non-empty pool in filesystem \a fsname will be
958 * performed. Such validation can be performed by the application if
959 * desired using the llapi_search_ost() function. The maximum length of
960 * the stored value is defined by the constant LOV_MAXPOOLNAME.
963 * \retval -1 Invalid argument, errno set to EINVAL.
965 int llapi_layout_pool_name_set(struct llapi_layout *layout,
966 const char *pool_name);
968 /******************** File Creation ********************/
971 * Open an existing file at \a path, or create it with the specified
972 * \a layout and \a mode.
974 * One access mode and zero or more file creation flags and file status
975 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
976 * open file descriptor for the file. If \a layout is non-NULL and
977 * \a path is not on a Lustre filesystem this function will fail and set
980 * An already existing file may be opened with this function, but
981 * \a layout and \a mode will not be applied to it. Callers requiring a
982 * guarantee that the opened file is created with the specified
983 * \a layout and \a mode should use llapi_layout_file_create().
985 * A NULL \a layout may be specified, in which case the standard Lustre
986 * behavior for assigning layouts to newly-created files will apply.
988 * \retval 0+ An open file descriptor.
989 * \retval -1 Error with status code in errno.
991 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
992 const struct llapi_layout *layout);
995 * Create a new file at \a path with the specified \a layout and \a mode.
997 * One access mode and zero or more file creation flags and file status
998 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
999 * open file descriptor for the file. If \a layout is non-NULL and
1000 * \a path is not on a Lustre filesystem this function will fail and set
1005 * llapi_layout_file_create(path, open_flags, mode, layout)
1007 * shall be equivalent to:
1009 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
1011 * It is an error if \a path specifies an existing file.
1013 * A NULL \a layout may be specified, in which the standard Lustre
1014 * behavior for assigning layouts to newly-created files will apply.
1016 * \retval 0+ An open file descriptor.
1017 * \retval -1 Error with status code in errno.
1019 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1020 const struct llapi_layout *layout);
1023 * Set flags to the header of component layout.
1025 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
1026 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
1027 const char *llapi_layout_flags_string(uint32_t flags);
1028 const __u16 llapi_layout_string_flags(char *string);
1031 * llapi_layout_mirror_count_get() - Get mirror count from the header of
1033 * @layout: Layout to get mirror count from.
1034 * @count: Returned mirror count value.
1036 * This function gets mirror count from the header of a layout.
1038 * Return: 0 on success or -1 on failure.
1040 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1044 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1045 * @layout: Layout to set mirror count in.
1046 * @count: Mirror count value to be set.
1048 * This function sets mirror count to the header of a layout.
1050 * Return: 0 on success or -1 on failure.
1052 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1056 * Fetch the start and end offset of the current layout component.
1058 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1059 uint64_t *start, uint64_t *end);
1061 * Set the extent of current layout component.
1063 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1064 uint64_t start, uint64_t end);
1066 /* PFL component flags table */
1067 static const struct comp_flag_name {
1068 enum lov_comp_md_entry_flags cfn_flag;
1069 const char *cfn_name;
1070 } comp_flags_table[] = {
1071 { LCME_FL_INIT, "init" },
1072 { LCME_FL_STALE, "stale" },
1073 { LCME_FL_PREF_RW, "prefer" },
1074 { LCME_FL_OFFLINE, "offline" },
1075 { LCME_FL_NOSYNC, "nosync" },
1076 { LCME_FL_EXTENSION, "extension" },
1080 * Gets the attribute flags of the current component.
1082 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1085 * Sets the specified flags of the current component leaving other flags as-is.
1087 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1089 * Clears the flags specified in the flags leaving other flags as-is.
1091 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1093 * Fetches the file-unique component ID of the current layout component.
1095 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1097 * Fetches the mirror ID of the current layout component.
1099 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1101 * Adds one component to the existing composite or plain layout.
1103 int llapi_layout_comp_add(struct llapi_layout *layout);
1105 * Adds a first component of a mirror to the existing composite layout.
1107 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1109 * Deletes the current layout component from the composite layout.
1111 int llapi_layout_comp_del(struct llapi_layout *layout);
1113 enum llapi_layout_comp_use {
1114 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1115 LLAPI_LAYOUT_COMP_USE_LAST = 2,
1116 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1117 LLAPI_LAYOUT_COMP_USE_PREV = 4,
1121 * Set the currently active component to the specified component ID.
1123 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1125 * Select the currently active component at the specified position.
1127 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1129 * Add layout components to an existing file.
1131 int llapi_layout_file_comp_add(const char *path,
1132 const struct llapi_layout *layout);
1134 * Delete component(s) by the specified component id or flags.
1136 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1138 * Change flags or other parameters of the component(s) by component ID of an
1139 * existing file. The component to be modified is specified by the
1140 * comp->lcme_id value, which must be an unique component ID. The new
1141 * attributes are passed in by @comp and @valid is used to specify which
1142 * attributes in the component are going to be changed.
1144 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1147 * Check if the file layout is composite.
1149 bool llapi_layout_is_composite(struct llapi_layout *layout);
1152 LLAPI_LAYOUT_ITER_CONT = 0,
1153 LLAPI_LAYOUT_ITER_STOP = 1,
1157 * Iteration callback function.
1159 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
1160 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
1161 * \retval < 0 error code
1163 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1166 * Iterate all components in the corresponding layout
1168 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1169 llapi_layout_iter_cb cb, void *cbdata);
1172 * FLR: mirror operation APIs
1174 int llapi_mirror_set(int fd, unsigned int id);
1175 int llapi_mirror_clear(int fd);
1176 ssize_t llapi_mirror_read(int fd, unsigned int id,
1177 void *buf, size_t count, off_t pos);
1178 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1179 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1180 off_t pos, size_t count);
1181 off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size);
1182 int llapi_mirror_punch(int fd, unsigned int id, off_t start, size_t length);
1184 int llapi_heat_get(int fd, struct lu_heat *heat);
1185 int llapi_heat_set(int fd, __u64 flags);
1187 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
1188 void llapi_layout_sanity_perror(int error);
1189 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1191 int llapi_param_get_paths(const char *pattern, glob_t *paths);
1192 int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
1193 void llapi_param_paths_free(glob_t *paths);
1197 #if defined(__cplusplus)