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;
144 __u8 lsp_max_inherit;
145 __u8 lsp_max_inherit_rr;
149 #define lsp_tgts lsp_osts
151 __u32 llapi_pattern_to_lov(uint64_t pattern);
153 int llapi_file_open_param(const char *name, int flags, mode_t mode,
154 const struct llapi_stripe_param *param);
155 int llapi_file_is_encrypted(int fd);
156 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
157 __u32 flags, char *foreign_lov);
158 int llapi_file_create(const char *name, unsigned long long stripe_size,
159 int stripe_offset, int stripe_count, int stripe_pattern);
160 int llapi_file_open(const char *name, int flags, int mode,
161 unsigned long long stripe_size, int stripe_offset,
162 int stripe_count, int stripe_pattern);
163 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
164 int stripe_offset, int stripe_count,
165 int stripe_pattern, char *pool_name);
166 int llapi_file_open_pool(const char *name, int flags, int mode,
167 unsigned long long stripe_size, int stripe_offset,
168 int stripe_count, int stripe_pattern, char *pool_name);
169 int llapi_poollist(const char *name);
170 int llapi_get_poolbuf(const char *name, char **buf,
171 char ***poolist, int *poolcount);
172 int llapi_get_poollist(const char *name, char **poollist, int list_size,
173 char *buffer, int buffer_size);
174 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
175 char *buffer, int buffer_size);
176 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
177 int llapi_file_lookup(int dirfd, const char *name);
178 void llapi_set_command_name(const char *cmd);
179 void llapi_clear_command_name(void);
181 enum llapi_layout_verbose {
182 VERBOSE_STRIPE_COUNT = 0x1,
183 VERBOSE_STRIPE_SIZE = 0x2,
184 VERBOSE_STRIPE_OFFSET = 0x4,
186 VERBOSE_DETAIL = 0x10,
187 VERBOSE_OBJID = 0x20,
188 VERBOSE_GENERATION = 0x40,
189 VERBOSE_MDTINDEX = 0x80,
190 VERBOSE_PATTERN = 0x100,
191 VERBOSE_COMP_COUNT = 0x200,
192 VERBOSE_COMP_FLAGS = 0x400,
193 VERBOSE_COMP_START = 0x800,
194 VERBOSE_COMP_END = 0x1000,
195 VERBOSE_COMP_ID = 0x2000,
196 VERBOSE_DFID = 0x4000,
197 VERBOSE_HASH_TYPE = 0x8000,
198 VERBOSE_MIRROR_COUNT = 0x10000,
199 VERBOSE_MIRROR_ID = 0x20000,
200 VERBOSE_EXT_SIZE = 0x40000,
201 VERBOSE_INHERIT = 0x80000,
202 VERBOSE_INHERIT_RR = 0x100000,
203 VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
204 VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
205 VERBOSE_OBJID | VERBOSE_GENERATION |
206 VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
207 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
208 VERBOSE_COMP_START | VERBOSE_COMP_END |
209 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
210 VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE |
211 VERBOSE_INHERIT | VERBOSE_INHERIT_RR
213 /* Compatibility with original names */
214 #define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
215 #define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
216 #define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
217 #define VERBOSE_LAYOUT VERBOSE_PATTERN
220 NEWERXY_ATIME = 0, /* neweraY */
221 NEWERXY_MTIME = 1, /* newermY */
222 NEWERXY_CTIME = 2, /* newercY */
223 NEWERXY_BTIME = 3, /* newerbY | newerBY */
228 LFS_FIND_PERM_EXACT = -2,
229 LFS_FIND_PERM_ANY = -1,
230 LFS_FIND_PERM_OFF = 0,
231 LFS_FIND_PERM_ALL = 1,
235 unsigned int fp_max_depth;
237 mode_t fp_type; /* S_IFIFO,... */
244 /* {a,m,c,b}sign cannot be bitfields due to using pointers to
245 * access them during argument parsing. */
249 /* these need to be signed values */
251 fp_stripe_size_sign:2,
252 fp_stripe_count_sign:2,
253 fp_comp_start_sign:2,
255 fp_comp_count_sign:2,
256 fp_mirror_count_sign:2,
257 fp_mirror_index_sign:2,
263 fp_unused2_sign:2, /* Once used we must add */
264 fp_unused3_sign:2, /* a separate flag field */
265 fp_unused4_sign:2; /* at end of the struct. */
266 unsigned long long fp_size;
267 unsigned long long fp_size_units;
269 unsigned long long fp_zero_end:1,
271 fp_exclude_pattern:1,
279 fp_check_pool:1, /* LOV pool name */
280 fp_check_size:1, /* file size */
286 fp_get_lmv:1, /* get MDT list from LMV */
287 fp_raw:1, /* do not fill in defaults */
288 fp_check_stripe_size:1, /* LOV stripe size */
289 fp_exclude_stripe_size:1,
290 fp_check_stripe_count:1, /* LOV stripe count */
291 fp_exclude_stripe_count:1,
294 fp_get_default_lmv:1, /* Get default LMV */
298 fp_check_comp_count:1,
299 fp_exclude_comp_count:1,
300 fp_check_mirror_count:1,
301 fp_exclude_mirror_count:1,
302 fp_check_comp_flags:1,
303 fp_check_mirror_state:1,
304 fp_check_comp_start:1,
305 fp_exclude_comp_start:1,
307 fp_exclude_comp_end:1,
309 fp_exclude_comp_id:1,
310 fp_check_mirror_id:1,
311 fp_exclude_mirror_id:1,
312 fp_check_mirror_index:1,
313 fp_exclude_mirror_index:1,
314 fp_check_mdt_count:1,
315 fp_exclude_mdt_count:1,
316 fp_check_hash_flag:1,
317 fp_exclude_hash_type:1,
318 fp_yaml:1, /* output layout in YAML */
322 fp_exclude_foreign:1,
323 fp_check_ext_size:1, /* extension size */
324 fp_exclude_ext_size:1,
329 fp_unused_bit4:1, /* Once all unused fields */
330 fp_unused_bit5:1, /* are used we need to add */
331 fp_unused_bit6:1, /* a separate flag field at*/
332 fp_unused_bit7:1; /* the end of the struct. */
334 enum llapi_layout_verbose fp_verbose;
337 /* regular expression */
340 struct obd_uuid *fp_obd_uuid;
342 int fp_num_alloc_obds;
346 struct obd_uuid *fp_mdt_uuid;
348 int fp_num_alloc_mdts;
351 int fp_file_mdt_index;
354 struct lov_user_mds_data *fp_lmd;
356 char fp_poolname[LOV_MAXPOOLNAME + 1];
358 __u32 fp_lmv_stripe_count;
359 struct lmv_user_md *fp_lmv_md;
361 unsigned long long fp_stripe_size;
362 unsigned long long fp_stripe_size_units;
363 unsigned long long fp_stripe_count;
367 __u32 fp_mirror_count;
369 __u32 fp_comp_neg_flags;
370 __u16 fp_mirror_state;
371 __u16 fp_mirror_neg_state;
374 __u16 fp_mirror_index;
375 unsigned long long fp_comp_start;
376 unsigned long long fp_comp_start_units;
377 unsigned long long fp_comp_end;
378 unsigned long long fp_comp_end_units;
379 unsigned long long fp_mdt_count;
381 unsigned long long fp_blocks;
382 unsigned long long fp_blocks_units;
384 unsigned long fp_got_uuids:1,
386 unsigned int fp_depth;
387 unsigned int fp_hash_type;
388 unsigned int fp_time_margin; /* time margin in seconds */
389 __u32 fp_foreign_type;
390 unsigned long long fp_ext_size;
391 unsigned long long fp_ext_size_units;
394 * fp_newery[NEWERXY_MAX][0]: --newerXY reference
395 * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
397 time_t fp_newery[NEWERXY_MAX][2];
401 unsigned int fp_hash_inflags;
402 unsigned int fp_hash_exflags;
405 int llapi_ostlist(char *path, struct find_param *param);
406 int llapi_uuid_match(char *real_uuid, char *search_uuid);
407 int llapi_getstripe(char *path, struct find_param *param);
408 int llapi_find(char *path, struct find_param *param);
410 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
411 int llapi_dir_set_default_lmv(const char *name,
412 const struct llapi_stripe_param *param);
413 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
414 int stripe_count, int stripe_pattern,
415 const char *pool_name);
416 int llapi_dir_create(const char *name, mode_t mode,
417 const struct llapi_stripe_param *param);
418 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
419 __u32 flags, const char *value);
420 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
421 int stripe_count, int stripe_pattern,
422 const char *poolname);
423 int llapi_direntry_remove(char *dname);
424 int llapi_unlink_foreign(char *dname);
426 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
427 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
428 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
429 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
430 int llapi_ping(char *obd_type, char *obd_name);
431 int llapi_target_check(int num_types, char **obd_types, char *dir);
432 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
433 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
434 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
435 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
436 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
437 int llapi_is_lustre_mnttype(const char *type);
438 int llapi_search_tgt(const char *fsname, const char *poolname,
439 const char *tgtname, bool is_mdt);
440 int llapi_search_mdt(const char *fsname, const char *poolname,
441 const char *mdtname);
442 int llapi_search_ost(const char *fsname, const char *poolname,
443 const char *ostname);
444 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
445 int llapi_parse_size(const char *optarg, unsigned long long *size,
446 unsigned long long *size_units, int bytes_spec);
447 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
449 int llapi_search_fsname(const char *pathname, char *fsname);
450 int llapi_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
451 char *instance, size_t instance_len);
452 int llapi_get_instance(const char *path, char *instance, size_t instance_len);
453 int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
454 int llapi_getname(const char *path, char *name, size_t namelen);
455 int llapi_search_fileset(const char *pathname, char *fileset);
457 int llapi_search_rootpath(char *pathname, const char *fsname);
458 int llapi_nodemap_exists(const char *name);
459 int llapi_migrate_mdt(char *path, struct find_param *param);
460 int llapi_mv(char *path, struct find_param *param);
464 #define HAVE_LLAPI_IS_LUSTRE_MNT
465 int llapi_is_lustre_mnt(struct mntent *mnt);
466 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
467 int llapi_target_iterate(int type_num, char **obd_type, void *args,
469 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
470 int llapi_cp(int argc, char *argv[]);
471 int llapi_ls(int argc, char *argv[]);
472 int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
473 int llapi_fid2path_at(int mnt_fd, const struct lu_fid *fid, char *path,
474 int pathlen, long long *recno, int *linkno);
475 int llapi_fid2path(const char *device, const char *fidstr, char *path,
476 int pathlen, long long *recno, int *linkno);
477 int llapi_path2fid(const char *path, struct lu_fid *fid);
478 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
480 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
481 struct lov_user_md *lum, size_t lumsize);
482 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
483 struct lov_user_md *lum, size_t lumsize);
484 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
485 lstatx_t *statx, struct lov_user_md *lum,
487 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
488 struct lov_user_md *lum, size_t lumsize);
490 int llapi_fd2fid(int fd, struct lu_fid *fid);
491 /* get FID of parent dir + the related name of entry in this parent dir */
492 int llapi_path2parent(const char *path, unsigned int linkno,
493 struct lu_fid *parent_fid, char *name, size_t name_size);
494 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
495 char *name, size_t name_size);
496 int llapi_rmfid(const char *path, struct fid_array *fa);
497 int llapi_chomp_string(char *buf);
498 int llapi_open_by_fid(const char *dir, const struct lu_fid *fid,
500 int llapi_get_version_string(char *version, unsigned int version_size);
501 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
502 int llapi_get_version(char *buffer, int buffer_size, char **version)
503 __attribute__((deprecated));
504 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
505 int llapi_file_flush(int fd);
506 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
507 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
508 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
509 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
511 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
513 int llapi_hsm_register_event_fifo(const char *path);
514 int llapi_hsm_unregister_event_fifo(const char *path);
515 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
516 const char *fmt, va_list args);
518 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
519 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
521 int llapi_create_volatile_param(const char *directory, int mdt_idx,
522 int open_flags, mode_t mode,
523 const struct llapi_stripe_param *stripe_param);
525 static inline int llapi_create_volatile(char *directory, int open_flags)
527 return llapi_create_volatile_idx(directory, -1, open_flags);
531 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
532 int gid, __u64 flags);
533 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
534 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
535 __u64 dv2, __u64 flags);
537 /* Changelog interface. priv is private state, managed internally by these
540 /* Records received are in extended format now, though most of them are still
541 * written in disk in changelog_rec format (to save space and time), it's
542 * converted to extended format in the lustre api to ease changelog analysis. */
543 #define HAVE_CHANGELOG_EXTEND_REC 1
545 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
546 const char *mdtname, long long startrec);
547 int llapi_changelog_fini(void **priv);
548 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
549 int llapi_changelog_in_buf(void *priv);
550 int llapi_changelog_free(struct changelog_rec **rech);
551 int llapi_changelog_get_fd(void *priv);
552 /* Allow records up to endrec to be destroyed; requires registered id. */
553 int llapi_changelog_clear(const char *mdtname, const char *idstr,
555 extern int llapi_changelog_set_xflags(void *priv,
556 enum changelog_send_extra_flag extra_flags);
558 /* HSM copytool interface.
559 * priv is private state, managed internally by these functions
561 struct hsm_copytool_private;
562 struct hsm_copyaction_private;
564 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
565 const char *mnt, int archive_count,
566 int *archives, int rfd_flags);
567 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
568 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
569 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
570 struct hsm_action_list **hal, int *msgsize);
571 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
572 const struct hsm_copytool_private *ct,
573 const struct hsm_action_item *hai,
574 int restore_mdt_index, int restore_open_flags,
576 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
577 const struct hsm_extent *he, int hp_flags, int errval);
578 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
579 const struct hsm_extent *he, __u64 total,
581 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
583 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
584 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
585 unsigned long long stripe_size, int stripe_offset,
586 int stripe_count, int stripe_pattern, char *pool_name,
587 struct lu_fid *newfid);
589 /* HSM user interface */
590 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
592 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
593 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
596 enum llapi_json_types {
597 LLAPI_JSON_INTEGER = 1,
603 struct llapi_json_item {
612 struct llapi_json_item *lji_next;
615 struct llapi_json_item_list {
617 struct llapi_json_item *ljil_items;
620 int llapi_json_init_list(struct llapi_json_item_list **item_list);
621 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
622 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
623 __u32 type, void *val);
624 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
627 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
628 int llapi_lease_release(int fd);
629 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
630 int llapi_lease_check(int fd);
631 int llapi_lease_get(int fd, int mode); /* obsoleted */
632 int llapi_lease_put(int fd); /* obsoleted */
635 int llapi_group_lock(int fd, int gid);
636 int llapi_group_unlock(int fd, int gid);
637 int llapi_group_lock64(int fd, __u64 gid);
638 int llapi_group_unlock64(int fd, __u64 gid);
640 bool llapi_file_is_sparse(int fd);
641 off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
642 int llapi_hole_punch(int fd, off_t start, size_t length);
645 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
646 struct llapi_lu_ladvise *ladvise);
649 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
650 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
651 __u32 id, enum lu_pcc_type type);
652 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
653 __u32 id, enum lu_pcc_type type);
654 int llapi_pcc_detach_fd(int fd, __u32 option);
655 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
657 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
659 int llapi_pcc_detach_file(const char *path, __u32 option);
660 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
661 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
662 int llapi_pccdev_set(const char *mntpath, const char *cmd);
663 int llapi_pccdev_get(const char *mntpath);
666 /* llapi_layout user interface */
669 * An array element storing component info to be resynced during mirror
672 struct llapi_resync_comp {
675 uint32_t lrc_mirror_id;
676 uint32_t lrc_id; /* component id */
680 /** Opaque data type abstracting the layout of a Lustre file. */
683 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
684 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
685 size_t count, off_t pos);
686 uint32_t llapi_mirror_find(struct llapi_layout *layout,
687 uint64_t file_start, uint64_t file_end,
689 int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
690 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
691 struct llapi_layout *m_layout);
692 int llapi_mirror_find_stale(struct llapi_layout *layout,
693 struct llapi_resync_comp *comp, size_t comp_size,
694 __u16 *mirror_ids, int ids_nr);
695 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
696 struct llapi_resync_comp *comp_array,
697 int comp_size, uint64_t start, uint64_t end);
699 * Flags to control how layouts are retrieved.
702 enum llapi_layout_get_flags {
703 /** Replace non-specified values with expected inherited values. */
704 LLAPI_LAYOUT_GET_EXPECTED = 0x0001,
705 /** Use a temporary buffer to swab and return xattrs. */
706 LLAPI_LAYOUT_GET_COPY = 0x0002,
707 /** Verify xattr contains sane layout values. */
708 LLAPI_LAYOUT_GET_CHECK = 0x0004,
710 /* compatibility macros for old interfaces */
711 #define LAYOUT_GET_EXPECTED LLAPI_LAYOUT_GET_EXPECTED
712 #define LLAPI_LXF_COPY LLAPI_LAYOUT_GET_COPY
713 #define LLAPI_LXF_CHECK LLAPI_LAYOUT_GET_CHECK
716 * Return a pointer to a newly-allocated opaque data structure containing
717 * the layout for the file at \a path. The pointer should be freed with
718 * llapi_layout_free() when it is no longer needed. Failure is indicated
719 * by a NULL return value and an appropriate error code stored in errno.
721 struct llapi_layout *llapi_layout_get_by_path(const char *path,
722 enum llapi_layout_get_flags flags);
725 * Return a pointer to a newly-allocated opaque data type containing the
726 * layout for the file referenced by open file descriptor \a fd. The
727 * pointer should be freed with llapi_layout_free() when it is no longer
728 * needed. Failure is indicated by a NULL return value and an
729 * appropriate error code stored in errno.
731 struct llapi_layout *llapi_layout_get_by_fd(int fd,
732 enum llapi_layout_get_flags flags);
735 * Return a pointer to a newly-allocated opaque data type containing the
736 * layout for the file associated with Lustre file identifier
737 * \a fid. The string \a path must name a path within the
738 * filesystem that contains the file being looked up, such as the
739 * filesystem root. The returned pointer should be freed with
740 * llapi_layout_free() when it is no longer needed. Failure is
741 * indicated with a NULL return value and an appropriate error code
744 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
745 const struct lu_fid *fid,
746 enum llapi_layout_get_flags flags);
749 * Return a pointer to a newly-allocated opaque data type containing the
750 * layout for the file associated with extended attribute \a lov_xattr. The
751 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
752 * should be raw xattr without being swapped, since this function will swap it
753 * properly. Thus, \a lov_xattr will be modified during the process. If the
754 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
755 * the objects count in lum is consistent with the stripe count in lum. This
756 * check only apply to regular file, so \a LLAPI_LAYOUT_GET_CHECK flag should
757 * be cleared if the xattr belongs to a directory. If the flag \a
758 * LLAPI_LAYOUT_GET_COPY is set, this function will use a temporary buffer for
759 * byte swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the
760 * byte swapping will be done to the \a lov_xattr buffer directly. The returned
761 * pointer should be freed with llapi_layout_free() when it is no longer
762 * needed. Failure is * indicated with a NULL return value and an appropriate
763 * error code stored in errno.
765 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
766 ssize_t lov_xattr_size,
767 enum llapi_layout_get_flags flags);
770 * Allocate a new layout. Use this when creating a new file with
771 * llapi_layout_file_create().
773 struct llapi_layout *llapi_layout_alloc(void);
776 * Free memory allocated for \a layout.
778 void llapi_layout_free(struct llapi_layout *layout);
781 * llapi_layout_merge() - Merge a composite layout into another one.
782 * @dst_layout: Destination composite layout.
783 * @src_layout: Source composite layout.
785 * This function copies all of the components from @src_layout and
786 * appends them to @dst_layout.
788 * Return: 0 on success or -1 on failure.
790 int llapi_layout_merge(struct llapi_layout **dst_layout,
791 const struct llapi_layout *src_layout);
793 /** Not a valid stripe size, offset, or RAID pattern. */
794 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
797 * When specified or returned as the value for stripe count,
798 * stripe size, offset, or RAID pattern, the filesystem-wide
799 * default behavior will apply.
801 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
804 * When specified or returned as the value for stripe count, all
805 * available OSTs will be used.
807 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
810 * When specified as the value for layout pattern, file objects will be
811 * stored using RAID0. That is, data will be split evenly and without
812 * redundancy across all OSTs in the layout.
814 #define LLAPI_LAYOUT_RAID0 0ULL
815 #define LLAPI_LAYOUT_MDT 2ULL
816 #define LLAPI_LAYOUT_OVERSTRIPING 4ULL
819 * The layout includes a specific set of OSTs on which to allocate.
821 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
824 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
826 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
829 * Flags to modify how layouts are retrieved.
831 /******************** Stripe Count ********************/
834 * Store the stripe count of \a layout in \a count.
837 * \retval -1 Error with status code in errno.
839 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
843 * Set the stripe count of \a layout to \a count.
846 * \retval -1 Invalid argument, errno set to EINVAL.
848 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
851 * Check if the stripe count \a stripe_count \a is valid.
853 bool llapi_layout_stripe_count_is_valid(int64_t stripe_count);
854 /******************** Stripe Size ********************/
857 * Store the stripe size of \a layout in \a size.
860 * \retval -1 Invalid argument, errno set to EINVAL.
862 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
866 * Set the stripe size of \a layout to \a stripe_size.
869 * \retval -1 Invalid argument, errno set to EINVAL.
871 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
874 /******************** Extension Size ********************/
877 * Store the extension size of \a layout in \a size.
880 * \retval -1 Invalid argument, errno set to EINVAL.
882 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
886 * Set the extension size of \a layout to \a stripe_size.
889 * \retval -1 Invalid argument, errno set to EINVAL.
891 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
894 /******************** Stripe Pattern ********************/
897 * Store the stripe pattern of \a layout in \a pattern.
900 * \retval -1 Error with status code in errno.
902 int llapi_layout_pattern_get(const struct llapi_layout *layout,
906 * Set the stripe pattern of \a layout to \a pattern.
909 * \retval -1 Invalid argument, errno set to EINVAL.
911 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
913 /******************** OST Index ********************/
916 * Store the index of the OST where stripe number \a stripe_number is stored
919 * An error return value will result from a NULL layout, if \a
920 * stripe_number is out of range, or if \a layout was not initialized
921 * with llapi_layout_lookup_by{path,fd,fid}().
924 * \retval -1 Invalid argument, errno set to EINVAL.
926 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
927 uint64_t stripe_number, uint64_t *index);
930 * Set the OST index associated with stripe number \a stripe_number to
932 * NB: This is currently supported only for \a stripe_number = 0 and
933 * other usage will return ENOTSUPP in errno. A NULL \a layout or
934 * out-of-range \a stripe_number will return EINVAL in errno.
937 * \retval -1 Error with errno set to non-zero value.
939 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
942 /******************** Pool Name ********************/
945 * Store up to \a pool_name_len characters of the name of the pool of
946 * OSTs associated with \a layout into the buffer pointed to by
949 * The correct calling form is:
951 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
953 * A pool defines a set of OSTs from which file objects may be
954 * allocated for a file using \a layout.
956 * On success, the number of bytes stored is returned, excluding the
957 * terminating '\0' character (zero indicates that \a layout does not
958 * have an associated OST pool). On error, -1 is returned and errno is
959 * set appropriately. Possible sources of error include a NULL pointer
960 * argument or insufficient space in \a dest to store the pool name,
961 * in which cases errno will be set to EINVAL.
963 * \retval 0+ The number of bytes stored in \a dest.
964 * \retval -1 Invalid argument, errno set to EINVAL.
966 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
967 char *pool_name, size_t pool_name_len);
970 * Set the name of the pool of OSTs from which file objects will be
971 * allocated to \a pool_name.
973 * If the pool name uses "fsname.pool" notation to qualify the pool name
974 * with a filesystem name, the "fsname." portion will be silently
975 * discarded before storing the value. No validation that \a pool_name
976 * is an existing non-empty pool in filesystem \a fsname will be
977 * performed. Such validation can be performed by the application if
978 * desired using the llapi_search_ost() function. The maximum length of
979 * the stored value is defined by the constant LOV_MAXPOOLNAME.
982 * \retval -1 Invalid argument, errno set to EINVAL.
984 int llapi_layout_pool_name_set(struct llapi_layout *layout,
987 /******************** File Creation ********************/
990 * Open an existing file at \a path, or create it with the specified
991 * \a layout and \a mode.
993 * One access mode and zero or more file creation flags and file status
994 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
995 * open file descriptor for the file. If \a layout is non-NULL and
996 * \a path is not on a Lustre filesystem this function will fail and set
999 * An already existing file may be opened with this function, but
1000 * \a layout and \a mode will not be applied to it. Callers requiring a
1001 * guarantee that the opened file is created with the specified
1002 * \a layout and \a mode should use llapi_layout_file_create().
1004 * A NULL \a layout may be specified, in which case the standard Lustre
1005 * behavior for assigning layouts to newly-created files will apply.
1007 * \retval 0+ An open file descriptor.
1008 * \retval -1 Error with status code in errno.
1010 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
1011 const struct llapi_layout *layout);
1014 * Create a new file at \a path with the specified \a layout and \a mode.
1016 * One access mode and zero or more file creation flags and file status
1017 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
1018 * open file descriptor for the file. If \a layout is non-NULL and
1019 * \a path is not on a Lustre filesystem this function will fail and set
1024 * llapi_layout_file_create(path, open_flags, mode, layout)
1026 * shall be equivalent to:
1028 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
1030 * It is an error if \a path specifies an existing file.
1032 * A NULL \a layout may be specified, in which the standard Lustre
1033 * behavior for assigning layouts to newly-created files will apply.
1035 * \retval 0+ An open file descriptor.
1036 * \retval -1 Error with status code in errno.
1038 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1039 const struct llapi_layout *layout);
1042 * Set flags to the header of component layout.
1044 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
1045 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
1046 const char *llapi_layout_flags_string(uint32_t flags);
1047 __u16 llapi_layout_string_flags(char *string);
1050 * llapi_layout_mirror_count_get() - Get mirror count from the header of
1052 * @layout: Layout to get mirror count from.
1053 * @count: Returned mirror count value.
1055 * This function gets mirror count from the header of a layout.
1057 * Return: 0 on success or -1 on failure.
1059 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1063 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1064 * @layout: Layout to set mirror count in.
1065 * @count: Mirror count value to be set.
1067 * This function sets mirror count to the header of a layout.
1069 * Return: 0 on success or -1 on failure.
1071 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1075 * Fetch the start and end offset of the current layout component.
1077 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1078 uint64_t *start, uint64_t *end);
1080 * Set the extent of current layout component.
1082 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1083 uint64_t start, uint64_t end);
1085 /* PFL component flags table */
1086 static const struct comp_flag_name {
1087 enum lov_comp_md_entry_flags cfn_flag;
1088 const char *cfn_name;
1089 } comp_flags_table[] = {
1090 { LCME_FL_INIT, "init" },
1091 { LCME_FL_STALE, "stale" },
1092 { LCME_FL_PREF_RW, "prefer" },
1093 { LCME_FL_OFFLINE, "offline" },
1094 { LCME_FL_NOSYNC, "nosync" },
1095 { LCME_FL_EXTENSION, "extension" },
1099 * Gets the attribute flags of the current component.
1101 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1104 * Sets the specified flags of the current component leaving other flags as-is.
1106 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1108 * Clears the flags specified in the flags leaving other flags as-is.
1110 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1112 * Fetches the file-unique component ID of the current layout component.
1114 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1116 * Fetches the mirror ID of the current layout component.
1118 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1120 * Adds one component to the existing composite or plain layout.
1122 int llapi_layout_comp_add(struct llapi_layout *layout);
1124 * Adds a first component of a mirror to the existing composite layout.
1126 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1128 * Deletes the current layout component from the composite layout.
1130 int llapi_layout_comp_del(struct llapi_layout *layout);
1132 enum llapi_layout_comp_use {
1133 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1134 LLAPI_LAYOUT_COMP_USE_LAST = 2,
1135 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1136 LLAPI_LAYOUT_COMP_USE_PREV = 4,
1140 * Set the currently active component to the specified component ID.
1142 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1144 * Select the currently active component at the specified position.
1146 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1148 * Add layout components to an existing file.
1150 int llapi_layout_file_comp_add(const char *path,
1151 const struct llapi_layout *layout);
1153 * Delete component(s) by the specified component id or flags.
1155 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1157 * Change flags or other parameters of the component(s) by component ID of an
1158 * existing file. The component to be modified is specified by the
1159 * comp->lcme_id value, which must be an unique component ID. The new
1160 * attributes are passed in by @comp and @valid is used to specify which
1161 * attributes in the component are going to be changed.
1163 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1166 * Check if the file layout is composite.
1168 bool llapi_layout_is_composite(struct llapi_layout *layout);
1171 LLAPI_LAYOUT_ITER_CONT = 0,
1172 LLAPI_LAYOUT_ITER_STOP = 1,
1176 * Iteration callback function.
1178 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
1179 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
1180 * \retval < 0 error code
1182 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1185 * Iterate all components in the corresponding layout
1187 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1188 llapi_layout_iter_cb cb, void *cbdata);
1191 * FLR: mirror operation APIs
1193 int llapi_mirror_set(int fd, unsigned int id);
1194 int llapi_mirror_clear(int fd);
1195 ssize_t llapi_mirror_read(int fd, unsigned int id,
1196 void *buf, size_t count, off_t pos);
1197 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1198 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1199 off_t pos, size_t count);
1200 off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size);
1201 int llapi_mirror_punch(int fd, unsigned int id, off_t start, size_t length);
1203 int llapi_heat_get(int fd, struct lu_heat *heat);
1204 int llapi_heat_set(int fd, __u64 flags);
1206 int llapi_layout_sanity(struct llapi_layout *layout, const char *fname,
1207 bool incomplete, bool flr);
1208 void llapi_layout_sanity_perror(int error);
1209 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1211 int llapi_param_get_paths(const char *pattern, glob_t *paths);
1212 int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
1213 void llapi_param_paths_free(glob_t *paths);
1217 #if defined(__cplusplus)