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
46 #include <sys/types.h>
47 #include <linux/lustre/lustre_user.h>
50 #if defined(__cplusplus)
55 #define LL_MAXQUOTAS 3
59 #define SEL_UNIT_SIZE 1024llu
62 #ifndef LOV_PATTERN_DEFAULT
63 #define LOV_PATTERN_DEFAULT 0xffffffff
67 # if defined(__GNUC__) && __GNUC__ >= 7
68 # define fallthrough __attribute__((fallthrough)) /* fallthrough */
70 # define fallthrough do {} while (0) /* fallthrough */
74 typedef struct statx lstatx_t;
76 #define lustre_fid struct lu_fid
79 * BUILD_BUG_ON() is Compile-time check which verifies correctness at
80 * compile-time rather than runtime. If "cond" is true, (1 - 2*!!(cond))
81 * will be a negative value, which will cause the compiler to complain.
84 #define BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2*!!(cond)]))
87 /* Currently external applications can access this but in the
88 * future this will no longer be exposed for the user. Instead
89 * if you want to know if the library is initialized just call
90 * llapi_liblustreapi_initialized() which is now available.
92 extern bool liblustreapi_initialized;
94 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
97 /* lustreapi message severity level */
98 enum llapi_message_level {
103 LLAPI_MSG_NORMAL = 4,
109 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
110 const char *fmt, va_list ap);
112 static inline bool llapi_liblustreapi_initialized(void)
114 return liblustreapi_initialized;
117 /* the bottom three bits reserved for llapi_message_level */
118 #define LLAPI_MSG_MASK 0x00000007
119 #define LLAPI_MSG_NO_ERRNO 0x00000010
121 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
123 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
127 if (level >= LLAPI_MSG_MAX)
130 return levels[level];
133 void llapi_msg_set_level(int level);
134 int llapi_msg_get_level(void);
135 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
136 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
138 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
139 __attribute__((__format__(__printf__, 3, 4)));
140 #define llapi_err_noerrno(level, fmt, a...) \
141 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
142 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
143 __attribute__((__format__(__printf__, 2, 3)));
145 struct llapi_stripe_param {
146 unsigned long long lsp_stripe_size;
148 int lsp_stripe_offset;
149 int lsp_stripe_pattern;
150 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
151 int lsp_stripe_count;
152 bool lsp_is_specific;
154 __u8 lsp_max_inherit;
155 __u8 lsp_max_inherit_rr;
159 #define lsp_tgts lsp_osts
162 LLAPI_MIGRATION_NONBLOCK = 0x0001,
163 LLAPI_MIGRATION_MIRROR = 0x0002,
164 LLAPI_MIGRATION_NONDIRECT = 0x0004,
165 LLAPI_MIGRATION_VERBOSE = 0x0008,
168 __u32 llapi_pattern_to_lov(uint64_t pattern);
170 int llapi_file_open_param(const char *name, int flags, mode_t mode,
171 const struct llapi_stripe_param *param);
172 int llapi_file_is_encrypted(int fd);
173 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
174 __u32 flags, char *foreign_lov);
175 int llapi_file_create(const char *name, unsigned long long stripe_size,
176 int stripe_offset, int stripe_count, int stripe_pattern);
177 int llapi_file_open(const char *name, int flags, int mode,
178 unsigned long long stripe_size, int stripe_offset,
179 int stripe_count, int stripe_pattern);
180 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
181 int stripe_offset, int stripe_count,
182 int stripe_pattern, char *pool_name);
183 int llapi_file_open_pool(const char *name, int flags, int mode,
184 unsigned long long stripe_size, int stripe_offset,
185 int stripe_count, int stripe_pattern, char *pool_name);
186 int llapi_poollist(const char *name);
187 int llapi_get_poolbuf(const char *name, char **buf,
188 char ***poolist, int *poolcount);
189 int llapi_get_poollist(const char *name, char **poollist, int list_size,
190 char *buffer, int buffer_size);
191 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
192 char *buffer, int buffer_size);
193 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
194 int llapi_file_lookup(int dirfd, const char *name);
195 void llapi_set_command_name(const char *cmd);
196 void llapi_clear_command_name(void);
198 enum llapi_layout_verbose {
199 VERBOSE_STRIPE_COUNT = 0x1,
200 VERBOSE_STRIPE_SIZE = 0x2,
201 VERBOSE_STRIPE_OFFSET = 0x4,
203 VERBOSE_DETAIL = 0x10,
204 VERBOSE_OBJID = 0x20,
205 VERBOSE_GENERATION = 0x40,
206 VERBOSE_MDTINDEX = 0x80,
207 VERBOSE_PATTERN = 0x100,
208 VERBOSE_COMP_COUNT = 0x200,
209 VERBOSE_COMP_FLAGS = 0x400,
210 VERBOSE_COMP_START = 0x800,
211 VERBOSE_COMP_END = 0x1000,
212 VERBOSE_COMP_ID = 0x2000,
213 VERBOSE_DFID = 0x4000,
214 VERBOSE_HASH_TYPE = 0x8000,
215 VERBOSE_MIRROR_COUNT = 0x10000,
216 VERBOSE_MIRROR_ID = 0x20000,
217 VERBOSE_EXT_SIZE = 0x40000,
218 VERBOSE_INHERIT = 0x80000,
219 VERBOSE_INHERIT_RR = 0x100000,
220 VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
221 VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
222 VERBOSE_OBJID | VERBOSE_GENERATION |
223 VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
224 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
225 VERBOSE_COMP_START | VERBOSE_COMP_END |
226 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
227 VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE |
228 VERBOSE_INHERIT | VERBOSE_INHERIT_RR
230 /* Compatibility with original names */
231 #define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
232 #define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
233 #define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
234 #define VERBOSE_LAYOUT VERBOSE_PATTERN
237 NEWERXY_ATIME = 0, /* neweraY */
238 NEWERXY_MTIME = 1, /* newermY */
239 NEWERXY_CTIME = 2, /* newercY */
240 NEWERXY_BTIME = 3, /* newerbY | newerBY */
245 LFS_FIND_PERM_EXACT = -2,
246 LFS_FIND_PERM_ANY = -1,
247 LFS_FIND_PERM_OFF = 0,
248 LFS_FIND_PERM_ALL = 1,
251 /* struct for buffers and matching info for -xattr arguments to lfs find */
252 struct xattr_match_info {
253 /* number of -xattr args specified (and size of xattr_regex_ arrays) */
254 int xattr_regex_count;
255 /* negation (!) can be specified separately for each -xattr arg */
256 bool *xattr_regex_exclude;
257 /* which regexes have already matched, when multiple specified */
258 bool *xattr_regex_matched;
259 regex_t **xattr_regex_name;
260 regex_t **xattr_regex_value;
261 char *xattr_name_buf; /* [XATTR_LIST_MAX] */
262 char *xattr_value_buf; /* [XATTR_SIZE_MAX] */
266 * new fields should be added to the end of this struct (unless filling a hole
267 * such as in a bitfield), to preserve the ABI
270 unsigned int fp_max_depth;
272 mode_t fp_type; /* S_IFIFO,... */
279 /* {a,m,c,b}sign cannot be bitfields due to using pointers to
280 * access them during argument parsing.
285 /* these need to be signed values */
287 fp_stripe_size_sign:2,
288 fp_stripe_count_sign:2,
289 fp_comp_start_sign:2,
291 fp_comp_count_sign:2,
292 fp_mirror_count_sign:2,
293 fp_mirror_index_sign:2,
299 fp_nlink_sign:2, /* Once used we must add */
300 fp_unused3_sign:2, /* a separate flag field */
301 fp_unused4_sign:2; /* at end of the struct. */
302 unsigned long long fp_size;
303 unsigned long long fp_size_units;
305 unsigned long long fp_zero_end:1,
307 fp_exclude_pattern:1,
315 fp_check_pool:1, /* LOV pool name */
316 fp_check_size:1, /* file size */
322 fp_get_lmv:1, /* get MDT list from LMV */
323 fp_raw:1, /* do not fill in defaults */
324 fp_check_stripe_size:1, /* LOV stripe size */
325 fp_exclude_stripe_size:1,
326 fp_check_stripe_count:1, /* LOV stripe count */
327 fp_exclude_stripe_count:1,
330 fp_get_default_lmv:1, /* Get default LMV */
334 fp_check_comp_count:1,
335 fp_exclude_comp_count:1,
336 fp_check_mirror_count:1,
337 fp_exclude_mirror_count:1,
338 fp_check_comp_flags:1,
339 fp_check_mirror_state:1,
340 fp_check_comp_start:1,
341 fp_exclude_comp_start:1,
343 fp_exclude_comp_end:1,
345 fp_exclude_comp_id:1,
346 fp_check_mirror_id:1,
347 fp_exclude_mirror_id:1,
348 fp_check_mirror_index:1,
349 fp_exclude_mirror_index:1,
350 fp_check_mdt_count:1,
351 fp_exclude_mdt_count:1,
352 fp_check_hash_flag:1,
353 fp_exclude_hash_type:1,
354 fp_yaml:1, /* output layout in YAML */
358 fp_exclude_foreign:1,
359 fp_check_ext_size:1, /* extension size */
360 fp_exclude_ext_size:1,
365 fp_stop_on_error:1, /* stop iteration on err */
366 fp_exclude_nlink:1, /* Once used, we must add*/
367 fp_exclude_attrs:1, /* a separate flag field */
368 fp_unused_bit7:1; /* at end of struct. */
370 enum llapi_layout_verbose fp_verbose;
373 /* regular expression */
376 struct obd_uuid *fp_obd_uuid;
378 int fp_num_alloc_obds;
382 struct obd_uuid *fp_mdt_uuid;
384 int fp_num_alloc_mdts;
387 int fp_file_mdt_index;
390 struct lov_user_mds_data *fp_lmd;
392 char fp_poolname[LOV_MAXPOOLNAME + 1];
394 __u32 fp_lmv_stripe_count;
395 struct lmv_user_md *fp_lmv_md;
397 unsigned long long fp_stripe_size;
398 unsigned long long fp_stripe_size_units;
399 unsigned long long fp_stripe_count;
403 __u32 fp_mirror_count;
405 __u32 fp_comp_neg_flags;
406 __u16 fp_mirror_state;
407 __u16 fp_mirror_neg_state;
410 __u16 fp_mirror_index;
411 unsigned long long fp_comp_start;
412 unsigned long long fp_comp_start_units;
413 unsigned long long fp_comp_end;
414 unsigned long long fp_comp_end_units;
415 unsigned long long fp_mdt_count;
416 unsigned int fp_projid;
417 unsigned long long fp_blocks;
418 unsigned long long fp_blocks_units;
420 unsigned long fp_got_uuids:1,
424 unsigned int fp_depth;
425 unsigned int fp_hash_type;
426 unsigned int fp_time_margin; /* time margin in seconds */
427 __u32 fp_foreign_type;
428 unsigned long long fp_ext_size;
429 unsigned long long fp_ext_size_units;
432 * fp_newery[NEWERXY_MAX][0]: --newerXY reference
433 * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
435 time_t fp_newery[NEWERXY_MAX][2];
439 unsigned int fp_hash_inflags;
440 unsigned int fp_hash_exflags;
441 /* Print all information (lfs find only) */
442 char *fp_format_printf_str;
446 struct xattr_match_info *fp_xattr_match_info;
449 int llapi_ostlist(char *path, struct find_param *param);
450 int llapi_uuid_match(char *real_uuid, char *search_uuid);
451 int llapi_getstripe(char *path, struct find_param *param);
452 int llapi_find(char *path, struct find_param *param);
454 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
455 int llapi_dir_set_default_lmv(const char *name,
456 const struct llapi_stripe_param *param);
457 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
458 int stripe_count, int stripe_pattern,
459 const char *pool_name);
460 int llapi_dir_create(const char *name, mode_t mode,
461 const struct llapi_stripe_param *param);
462 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
463 __u32 flags, const char *value);
464 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
465 int stripe_count, int stripe_pattern,
466 const char *poolname);
467 int llapi_direntry_remove(char *dname);
468 int llapi_unlink_foreign(char *dname);
470 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
471 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
472 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
473 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
474 int llapi_ping(char *obd_type, char *obd_name);
475 int llapi_target_check(int num_types, char **obd_types, char *dir);
476 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
477 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
478 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
479 int llapi_file_fget_lmv_uuid(int fd, struct obd_uuid *lov_uuid);
480 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
481 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
482 int llapi_is_lustre_mnttype(const char *type);
483 int llapi_search_tgt(const char *fsname, const char *poolname,
484 const char *tgtname, bool is_mdt);
485 int llapi_search_mdt(const char *fsname, const char *poolname,
486 const char *mdtname);
487 int llapi_search_ost(const char *fsname, const char *poolname,
488 const char *ostname);
489 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
490 int llapi_parse_size(const char *optarg, unsigned long long *size,
491 unsigned long long *size_units, int bytes_spec);
492 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
494 int llapi_search_fsname(const char *pathname, char *fsname);
495 int llapi_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
496 char *instance, size_t instance_len);
497 int llapi_get_instance(const char *path, char *instance, size_t instance_len);
498 int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
499 int llapi_getname(const char *path, char *name, size_t namelen);
500 int llapi_search_fileset(const char *pathname, char *fileset);
502 int llapi_search_rootpath(char *pathname, const char *fsname);
503 int llapi_search_rootpath_by_dev(char *pathname, dev_t dev);
504 int llapi_nodemap_exists(const char *name);
505 int llapi_migrate_mdt(char *path, struct find_param *param);
506 int llapi_mv(char *path, struct find_param *param);
510 #define HAVE_LLAPI_IS_LUSTRE_MNT
511 int llapi_is_lustre_mnt(struct mntent *mnt);
512 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
513 int llapi_target_iterate(int type_num, char **obd_type, void *args,
515 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
516 int llapi_cp(int argc, char *argv[]);
517 int llapi_ls(int argc, char *argv[]);
518 int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
519 int llapi_fid2path_at(int mnt_fd, const struct lu_fid *fid, char *path,
520 int pathlen, long long *recno, int *linkno);
521 int llapi_fid2path(const char *device, const char *fidstr, char *path,
522 int pathlen, long long *recno, int *linkno);
523 int llapi_path2fid(const char *path, struct lu_fid *fid);
524 unsigned long llapi_fid_hash(const struct lu_fid *f, unsigned int shift);
525 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
527 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
528 struct lov_user_md *lum, size_t lumsize);
529 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
530 struct lov_user_md *lum, size_t lumsize);
531 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
532 lstatx_t *statx, struct lov_user_md *lum,
534 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
535 struct lov_user_md *lum, size_t lumsize);
537 int llapi_fd2fid(int fd, struct lu_fid *fid);
539 /* get FID of parent dir + the related name of entry in this parent dir */
540 int llapi_path2parent(const char *path, unsigned int linkno,
541 struct lu_fid *parent_fid, char *name, size_t name_size);
542 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
543 char *name, size_t name_size);
544 int llapi_rmfid(const char *path, struct fid_array *fa);
545 int llapi_rmfid_at(int fd, struct fid_array *fa);
546 int llapi_root_path_open(const char *device, int *outfd);
547 int llapi_chomp_string(char *buf);
550 int llapi_handle_to_fid(struct file_handle **handle, const struct lu_fid *fid);
551 int llapi_fid_to_handle(struct file_handle **handle, const struct lu_fid *fid);
552 int llapi_open_by_fid_at(int lustre_fd, const struct lu_fid *fid,
554 int llapi_open_by_fid(const char *lustre_dir, const struct lu_fid *fid,
556 int llapi_get_version_string(char *version, unsigned int version_size);
557 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
558 int llapi_get_version(char *buffer, int buffer_size, char **version)
559 __attribute__((deprecated));
560 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
561 int llapi_file_flush(int fd);
562 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
563 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
564 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
565 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
567 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
569 int llapi_hsm_register_event_fifo(const char *path);
570 int llapi_hsm_unregister_event_fifo(const char *path);
571 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
572 const char *fmt, va_list args);
574 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
575 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
577 int llapi_create_volatile_param(const char *directory, int mdt_idx,
578 int open_flags, mode_t mode,
579 const struct llapi_stripe_param *stripe_param);
581 static inline int llapi_create_volatile(char *directory, int open_flags)
583 return llapi_create_volatile_idx(directory, -1, open_flags);
587 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
588 int gid, __u64 flags);
589 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
590 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
591 __u64 dv2, __u64 flags);
593 /* Changelog interface. priv is private connection state, managed internally */
595 /* Records received are in extended format now, though most of them are still
596 * written in disk in changelog_rec format (to save space and time), it's
597 * converted to extended format in the lustre api to ease changelog analysis.
599 #define HAVE_CHANGELOG_EXTEND_REC 1
601 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
602 const char *mdtname, long long startrec);
603 int llapi_changelog_fini(void **priv);
604 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
605 int llapi_changelog_in_buf(void *priv);
606 int llapi_changelog_free(struct changelog_rec **rech);
607 int llapi_changelog_get_fd(void *priv);
608 /* Allow records up to endrec to be destroyed; requires registered id. */
609 int llapi_changelog_clear(const char *mdtname, const char *idstr,
611 extern int llapi_changelog_set_xflags(void *priv,
612 enum changelog_send_extra_flag extra_flags);
614 /* HSM copytool interface.
615 * priv is private state, managed internally by these functions
617 struct hsm_copytool_private;
618 struct hsm_copyaction_private;
620 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
621 const char *mnt, int archive_count,
622 int *archives, int rfd_flags);
623 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
624 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
625 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
626 struct hsm_action_list **hal, int *msgsize);
627 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
628 const struct hsm_copytool_private *ct,
629 const struct hsm_action_item *hai,
630 int restore_mdt_index, int restore_open_flags,
632 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
633 const struct hsm_extent *he, int hp_flags, int errval);
634 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
635 const struct hsm_extent *he, __u64 total,
637 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
639 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
640 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
641 unsigned long long stripe_size, int stripe_offset,
642 int stripe_count, int stripe_pattern, char *pool_name,
643 struct lu_fid *newfid);
645 /* HSM user interface */
646 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
648 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
649 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
652 enum llapi_json_types {
653 LLAPI_JSON_INTEGER = 1,
659 struct llapi_json_item {
668 struct llapi_json_item *lji_next;
671 struct llapi_json_item_list {
673 struct llapi_json_item *ljil_items;
676 int llapi_json_init_list(struct llapi_json_item_list **item_list);
677 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
678 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
679 __u32 type, void *val);
680 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
683 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
684 int llapi_lease_release_intent(int fd, struct ll_ioc_lease *data);
685 int llapi_lease_release(int fd);
686 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
687 int llapi_lease_check(int fd);
688 int llapi_lease_get(int fd, int mode); /* obsoleted */
689 int llapi_lease_put(int fd); /* obsoleted */
692 int llapi_group_lock(int fd, int gid);
693 int llapi_group_unlock(int fd, int gid);
694 int llapi_group_lock64(int fd, __u64 gid);
695 int llapi_group_unlock64(int fd, __u64 gid);
697 bool llapi_file_is_sparse(int fd);
698 off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
699 int llapi_hole_punch(int fd, off_t start, size_t length);
702 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
703 struct llapi_lu_ladvise *ladvise);
706 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
707 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
708 __u32 id, enum lu_pcc_type type);
709 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
710 __u32 id, enum lu_pcc_type type);
711 int llapi_pcc_detach_fd(int fd, __u32 option);
712 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
714 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
716 int llapi_pcc_detach_file(const char *path, __u32 option);
717 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
718 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
719 int llapi_pccdev_set(const char *mntpath, const char *cmd);
720 int llapi_pccdev_get(const char *mntpath);
723 /* llapi_layout user interface */
726 * An array element storing component info to be resynced during mirror
729 struct llapi_resync_comp {
732 uint32_t lrc_mirror_id;
733 uint32_t lrc_id; /* component id */
737 /** Opaque data type abstracting the layout of a Lustre file. */
740 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
741 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
742 size_t count, off_t pos);
743 int llapi_mirror_find(struct llapi_layout *layout, uint64_t file_start,
744 uint64_t file_end, uint64_t *endp);
745 int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
746 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
747 struct llapi_layout *m_layout);
748 int llapi_mirror_find_stale(struct llapi_layout *layout,
749 struct llapi_resync_comp *comp, size_t comp_size,
750 __u16 *mirror_ids, int ids_nr);
751 int llapi_mirror_resync_many_params(int fd, struct llapi_layout *layout,
752 struct llapi_resync_comp *comp_array,
753 int comp_size, uint64_t start,
755 unsigned long stats_interval_sec,
756 unsigned long bandwidth_bytes_sec);
757 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
758 struct llapi_resync_comp *comp_array,
759 int comp_size, uint64_t start, uint64_t end);
761 * Flags to control how layouts are retrieved.
764 enum llapi_layout_get_flags {
765 /** Replace non-specified values with expected inherited values. */
766 LLAPI_LAYOUT_GET_EXPECTED = 0x0001,
767 /** Use a temporary buffer to swab and return xattrs. */
768 LLAPI_LAYOUT_GET_COPY = 0x0002,
769 /** Verify xattr contains sane layout values. */
770 LLAPI_LAYOUT_GET_CHECK = 0x0004,
772 /* compatibility macros for old interfaces */
773 #define LAYOUT_GET_EXPECTED LLAPI_LAYOUT_GET_EXPECTED
774 #define LLAPI_LXF_COPY LLAPI_LAYOUT_GET_COPY
775 #define LLAPI_LXF_CHECK LLAPI_LAYOUT_GET_CHECK
778 * Return a pointer to a newly-allocated opaque data structure containing
779 * the layout for the file at \a path. The pointer should be freed with
780 * llapi_layout_free() when it is no longer needed. Failure is indicated
781 * by a NULL return value and an appropriate error code stored in errno.
783 struct llapi_layout *llapi_layout_get_by_path(const char *path,
784 enum llapi_layout_get_flags flags);
787 * Return a pointer to a newly-allocated opaque data type containing the
788 * layout for the file referenced by open file descriptor \a fd. The
789 * pointer should be freed with llapi_layout_free() when it is no longer
790 * needed. Failure is indicated by a NULL return value and an
791 * appropriate error code stored in errno.
793 struct llapi_layout *llapi_layout_get_by_fd(int fd,
794 enum llapi_layout_get_flags flags);
797 * Return a pointer to a newly-allocated opaque data type containing the
798 * layout for the file associated with Lustre file identifier
799 * \a fid. The string \a path must name a path within the
800 * filesystem that contains the file being looked up, such as the
801 * filesystem root. The returned pointer should be freed with
802 * llapi_layout_free() when it is no longer needed. Failure is
803 * indicated with a NULL return value and an appropriate error code
806 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
807 const struct lu_fid *fid,
808 enum llapi_layout_get_flags flags);
811 * Return a pointer to a newly-allocated opaque data type containing the
812 * layout for the file associated with extended attribute \a lov_xattr. The
813 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
814 * should be raw xattr without being swapped, since this function will swap it
815 * properly. Thus, \a lov_xattr will be modified during the process. If the
816 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
817 * the objects count in lum is consistent with the stripe count in lum. This
818 * check only apply to regular file, so \a LLAPI_LAYOUT_GET_CHECK flag should
819 * be cleared if the xattr belongs to a directory. If the flag \a
820 * LLAPI_LAYOUT_GET_COPY is set, this function will use a temporary buffer for
821 * byte swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the
822 * byte swapping will be done to the \a lov_xattr buffer directly. The returned
823 * pointer should be freed with llapi_layout_free() when it is no longer
824 * needed. Failure is * indicated with a NULL return value and an appropriate
825 * error code stored in errno.
827 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
828 ssize_t lov_xattr_size,
829 enum llapi_layout_get_flags flags);
832 * Allocate a new layout. Use this when creating a new file with
833 * llapi_layout_file_create().
835 struct llapi_layout *llapi_layout_alloc(void);
838 * Free memory allocated for \a layout.
840 void llapi_layout_free(struct llapi_layout *layout);
843 * llapi_layout_merge() - Merge a composite layout into another one.
844 * @dst_layout: Destination composite layout.
845 * @src_layout: Source composite layout.
847 * This function copies all of the components from @src_layout and
848 * appends them to @dst_layout.
850 * Return: 0 on success or -1 on failure.
852 int llapi_layout_merge(struct llapi_layout **dst_layout,
853 const struct llapi_layout *src_layout);
855 /** Not a valid stripe size, offset, or RAID pattern. */
856 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
859 * When specified or returned as the value for stripe count,
860 * stripe size, offset, or RAID pattern, the filesystem-wide
861 * default behavior will apply.
863 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
866 * When specified or returned as the value for stripe count, all
867 * available OSTs will be used.
869 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
872 * When specified as the value for layout pattern, file objects will be
873 * stored using RAID0. That is, data will be split evenly and without
874 * redundancy across all OSTs in the layout.
876 #define LLAPI_LAYOUT_RAID0 0ULL
877 #define LLAPI_LAYOUT_MDT 2ULL
878 #define LLAPI_LAYOUT_OVERSTRIPING 4ULL
879 #define LLAPI_LAYOUT_FOREIGN 8ULL
882 * The layout includes a specific set of OSTs on which to allocate.
884 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
887 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
889 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
892 * Flags to modify how layouts are retrieved.
894 /******************** Stripe Count ********************/
897 * Store the stripe count of \a layout in \a count.
900 * \retval -1 Error with status code in errno.
902 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
906 * Set the stripe count of \a layout to \a count.
909 * \retval -1 Invalid argument, errno set to EINVAL.
911 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
914 * Check if the stripe count \a stripe_count \a is valid.
916 bool llapi_layout_stripe_count_is_valid(int64_t stripe_count);
917 /******************** Stripe Size ********************/
920 * Store the stripe size of \a layout in \a size.
923 * \retval -1 Invalid argument, errno set to EINVAL.
925 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
929 * Set the stripe size of \a layout to \a stripe_size.
932 * \retval -1 Invalid argument, errno set to EINVAL.
934 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
937 /******************** Extension Size ********************/
940 * Store the extension size of \a layout in \a size.
943 * \retval -1 Invalid argument, errno set to EINVAL.
945 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
949 * Set the extension size of \a layout to \a stripe_size.
952 * \retval -1 Invalid argument, errno set to EINVAL.
954 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
957 /******************** Stripe Pattern ********************/
960 * Store the stripe pattern of \a layout in \a pattern.
963 * \retval -1 Error with status code in errno.
965 int llapi_layout_pattern_get(const struct llapi_layout *layout,
969 * Set the stripe pattern of \a layout to \a pattern.
972 * \retval -1 Invalid argument, errno set to EINVAL.
974 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
976 /******************** OST Index ********************/
979 * Store the index of the OST where stripe number \a stripe_number is stored
982 * An error return value will result from a NULL layout, if \a
983 * stripe_number is out of range, or if \a layout was not initialized
984 * with llapi_layout_lookup_by{path,fd,fid}().
987 * \retval -1 Invalid argument, errno set to EINVAL.
989 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
990 uint64_t stripe_number, uint64_t *index);
993 * Set the OST index associated with stripe number \a stripe_number to
995 * NB: This is currently supported only for \a stripe_number = 0 and
996 * other usage will return ENOTSUPP in errno. A NULL \a layout or
997 * out-of-range \a stripe_number will return EINVAL in errno.
1000 * \retval -1 Error with errno set to non-zero value.
1002 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
1005 /******************** Pool Name ********************/
1008 * Store up to \a pool_name_len characters of the name of the pool of
1009 * OSTs associated with \a layout into the buffer pointed to by
1012 * The correct calling form is:
1014 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
1016 * A pool defines a set of OSTs from which file objects may be
1017 * allocated for a file using \a layout.
1019 * On success, the number of bytes stored is returned, excluding the
1020 * terminating '\0' character (zero indicates that \a layout does not
1021 * have an associated OST pool). On error, -1 is returned and errno is
1022 * set appropriately. Possible sources of error include a NULL pointer
1023 * argument or insufficient space in \a dest to store the pool name,
1024 * in which cases errno will be set to EINVAL.
1026 * \retval 0+ The number of bytes stored in \a dest.
1027 * \retval -1 Invalid argument, errno set to EINVAL.
1029 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
1030 char *pool_name, size_t pool_name_len);
1033 * Set the name of the pool of OSTs from which file objects will be
1034 * allocated to \a pool_name.
1036 * If the pool name uses "fsname.pool" notation to qualify the pool name
1037 * with a filesystem name, the "fsname." portion will be silently
1038 * discarded before storing the value. No validation that \a pool_name
1039 * is an existing non-empty pool in filesystem \a fsname will be
1040 * performed. Such validation can be performed by the application if
1041 * desired using the llapi_search_ost() function. The maximum length of
1042 * the stored value is defined by the constant LOV_MAXPOOLNAME.
1044 * \retval 0 Success.
1045 * \retval -1 Invalid argument, errno set to EINVAL.
1047 int llapi_layout_pool_name_set(struct llapi_layout *layout,
1048 const char *pool_name);
1050 /******************** File Creation ********************/
1053 * Open an existing file at \a path, or create it with the specified
1054 * \a layout and \a mode.
1056 * One access mode and zero or more file creation flags and file status
1057 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
1058 * open file descriptor for the file. If \a layout is non-NULL and
1059 * \a path is not on a Lustre filesystem this function will fail and set
1062 * An already existing file may be opened with this function, but
1063 * \a layout and \a mode will not be applied to it. Callers requiring a
1064 * guarantee that the opened file is created with the specified
1065 * \a layout and \a mode should use llapi_layout_file_create().
1067 * A NULL \a layout may be specified, in which case the standard Lustre
1068 * behavior for assigning layouts to newly-created files will apply.
1070 * \retval 0+ An open file descriptor.
1071 * \retval -1 Error with status code in errno.
1073 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
1074 const struct llapi_layout *layout);
1077 * Create a new file at \a path with the specified \a layout and \a mode.
1079 * One access mode and zero or more file creation flags and file status
1080 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
1081 * open file descriptor for the file. If \a layout is non-NULL and
1082 * \a path is not on a Lustre filesystem this function will fail and set
1087 * llapi_layout_file_create(path, open_flags, mode, layout)
1089 * shall be equivalent to:
1091 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
1093 * It is an error if \a path specifies an existing file.
1095 * A NULL \a layout may be specified, in which the standard Lustre
1096 * behavior for assigning layouts to newly-created files will apply.
1098 * \retval 0+ An open file descriptor.
1099 * \retval -1 Error with status code in errno.
1101 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1102 const struct llapi_layout *layout);
1105 * Set flags to the header of component layout.
1107 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
1108 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
1109 const char *llapi_layout_flags_string(uint32_t flags);
1110 __u16 llapi_layout_string_flags(char *string);
1113 * llapi_layout_mirror_count_get() - Get mirror count from the header of
1115 * @layout: Layout to get mirror count from.
1116 * @count: Returned mirror count value.
1118 * This function gets mirror count from the header of a layout.
1120 * Return: 0 on success or -1 on failure.
1122 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1126 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1127 * @layout: Layout to set mirror count in.
1128 * @count: Mirror count value to be set.
1130 * This function sets mirror count to the header of a layout.
1132 * Return: 0 on success or -1 on failure.
1134 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1138 * Fetch the start and end offset of the current layout component.
1140 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1141 uint64_t *start, uint64_t *end);
1143 * Set the extent of current layout component.
1145 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1146 uint64_t start, uint64_t end);
1148 /* PFL component flags table */
1149 static const struct comp_flag_name {
1150 enum lov_comp_md_entry_flags cfn_flag;
1151 const char *cfn_name;
1152 } comp_flags_table[] = {
1153 { LCME_FL_INIT, "init" },
1154 { LCME_FL_STALE, "stale" },
1155 { LCME_FL_PREF_RW, "prefer" },
1156 { LCME_FL_PREF_RD, "prefrd" },
1157 { LCME_FL_PREF_WR, "prefwr" },
1158 { LCME_FL_OFFLINE, "offline" },
1159 { LCME_FL_NOSYNC, "nosync" },
1160 { LCME_FL_EXTENSION, "extension" },
1161 { LCME_FL_PARITY, "parity" },
1162 { LCME_FL_COMPRESS, "compress" },
1163 { LCME_FL_PARTIAL, "partial" },
1164 { LCME_FL_NOCOMPR, "nocompr" },
1167 /* HSM component flags table */
1168 static const struct hsm_flag_name {
1169 enum hsm_states hfn_flag;
1170 const char *hfn_name;
1171 } hsm_flags_table[] = {
1172 { HS_NONE, "none" },
1173 { HS_EXISTS, "exists" },
1174 { HS_DIRTY, "dirty" },
1175 { HS_RELEASED, "released" },
1176 { HS_ARCHIVED, "archived" },
1177 { HS_NORELEASE, "norelease" },
1178 { HS_NOARCHIVE, "noarchive" },
1179 { HS_LOST, "lost" },
1180 { HS_PCCRW, "pccrw" },
1181 { HS_PCCRO, "pccro" },
1184 /* Currently known file attributes.
1185 * Update if more attributes are added in lustre_user.h.
1187 static const struct attrs_name {
1189 const char *an_name;
1190 const char an_shortname;
1192 { STATX_ATTR_COMPRESSED, "Compressed", 'c' },
1193 { STATX_ATTR_IMMUTABLE, "Immutable", 'i' },
1194 { STATX_ATTR_APPEND, "Append_Only", 'a' },
1195 { STATX_ATTR_NODUMP, "No_Dump", 'd' },
1196 { STATX_ATTR_ENCRYPTED, "Encrypted", 'E' },
1197 { STATX_ATTR_AUTOMOUNT, "Automount", 'M' },
1202 * Gets the attribute flags of the current component.
1204 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1207 * Sets the specified flags of the current component leaving other flags as-is.
1209 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1211 * Clears the flags specified in the flags leaving other flags as-is.
1213 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1215 * Fetches the file-unique component ID of the current layout component.
1217 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1219 * Fetches the mirror ID of the current layout component.
1221 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1223 * Adds one component to the existing composite or plain layout.
1225 int llapi_layout_comp_add(struct llapi_layout *layout);
1227 * Adds a first component of a mirror to the existing composite layout.
1229 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1231 * Deletes the current layout component from the composite layout.
1233 int llapi_layout_comp_del(struct llapi_layout *layout);
1235 enum llapi_layout_comp_use {
1236 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1237 LLAPI_LAYOUT_COMP_USE_LAST = 2,
1238 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1239 LLAPI_LAYOUT_COMP_USE_PREV = 4,
1243 * Set the currently active component to the specified component ID.
1245 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1247 * Select the currently active component at the specified position.
1249 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1251 * Add layout components to an existing file.
1253 int llapi_layout_file_comp_add(const char *path,
1254 const struct llapi_layout *layout);
1256 * Delete component(s) by the specified component id or flags.
1258 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1260 * Change flags or other parameters of the component(s) by component ID of an
1261 * existing file. The component to be modified is specified by the
1262 * comp->lcme_id value, which must be an unique component ID. The new
1263 * attributes are passed in by @comp and @valid is used to specify which
1264 * attributes in the component are going to be changed.
1266 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1269 * Check if the file layout is composite.
1271 bool llapi_layout_is_composite(struct llapi_layout *layout);
1274 LLAPI_LAYOUT_ITER_CONT = 0,
1275 LLAPI_LAYOUT_ITER_STOP = 1,
1279 * Iteration callback function.
1281 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
1282 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
1283 * \retval < 0 error code
1285 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1288 * Iterate all components in the corresponding layout
1290 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1291 llapi_layout_iter_cb cb, void *cbdata);
1293 int llapi_verify_pool_name(struct llapi_layout *layout, void *arg);
1296 * FLR: mirror operation APIs
1298 int llapi_mirror_set(int fd, unsigned int id);
1299 int llapi_mirror_clear(int fd);
1300 ssize_t llapi_mirror_read(int fd, unsigned int id,
1301 void *buf, size_t count, off_t pos);
1302 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1303 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1304 off_t pos, size_t count);
1305 off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size);
1306 int llapi_mirror_punch(int fd, unsigned int id, off_t start, size_t length);
1307 bool llapi_mirror_is_sparse(int fd, unsigned int id);
1309 int llapi_heat_get(int fd, struct lu_heat *heat);
1310 int llapi_heat_set(int fd, __u64 flags);
1312 int llapi_ioctl(int fd, unsigned int cmd, void *buf);
1314 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
1315 int llapi_layout_v2_sanity(struct llapi_layout *layout, bool incomplete,
1316 bool flr, char *fsname);
1317 void llapi_layout_sanity_perror(int error);
1318 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1320 int llapi_param_get_paths(const char *pattern, glob_t *paths);
1321 int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
1322 void llapi_param_paths_free(glob_t *paths);
1326 #if defined(__cplusplus)