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
65 # if defined(__GNUC__) && __GNUC__ >= 7
66 # define fallthrough __attribute__((fallthrough)) /* fallthrough */
68 # define fallthrough do {} while (0) /* fallthrough */
72 typedef struct statx lstatx_t;
74 #define lustre_fid struct lu_fid
77 * BUILD_BUG_ON() is Compile-time check which verifies correctness at
78 * compile-time rather than runtime. If "cond" is true, (1 - 2*!!(cond))
79 * will be a negative value, which will cause the compiler to complain.
83 #define BUILD_BUG_ON(cond) ((void)sizeof(char[1 - 2*!!(cond)]))
86 /* Currently external applications can access this but in the
87 * future this will no longer be exposed for the user. Instead
88 * if you want to know if the library is initialized just call
89 * llapi_liblustreapi_initialized() which is now available. */
90 extern bool liblustreapi_initialized;
92 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
95 /* lustreapi message severity level */
96 enum llapi_message_level {
101 LLAPI_MSG_NORMAL = 4,
107 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
108 const char *fmt, va_list ap);
110 static inline bool llapi_liblustreapi_initialized(void)
112 return liblustreapi_initialized;
115 /* the bottom three bits reserved for llapi_message_level */
116 #define LLAPI_MSG_MASK 0x00000007
117 #define LLAPI_MSG_NO_ERRNO 0x00000010
119 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
121 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
125 if (level >= LLAPI_MSG_MAX)
128 return levels[level];
131 void llapi_msg_set_level(int level);
132 int llapi_msg_get_level(void);
133 llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
134 llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
136 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
137 __attribute__((__format__(__printf__, 3, 4)));
138 #define llapi_err_noerrno(level, fmt, a...) \
139 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
140 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
141 __attribute__((__format__(__printf__, 2, 3)));
143 struct llapi_stripe_param {
144 unsigned long long lsp_stripe_size;
146 int lsp_stripe_offset;
147 int lsp_stripe_pattern;
148 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
149 int lsp_stripe_count;
150 bool lsp_is_specific;
152 __u8 lsp_max_inherit;
153 __u8 lsp_max_inherit_rr;
157 #define lsp_tgts lsp_osts
160 LLAPI_MIGRATION_NONBLOCK = 0x0001,
161 LLAPI_MIGRATION_MIRROR = 0x0002,
162 LLAPI_MIGRATION_NONDIRECT = 0x0004,
163 LLAPI_MIGRATION_VERBOSE = 0x0008,
166 __u32 llapi_pattern_to_lov(uint64_t pattern);
168 int llapi_file_open_param(const char *name, int flags, mode_t mode,
169 const struct llapi_stripe_param *param);
170 int llapi_file_is_encrypted(int fd);
171 int llapi_file_create_foreign(const char *name, mode_t mode, __u32 type,
172 __u32 flags, char *foreign_lov);
173 int llapi_file_create(const char *name, unsigned long long stripe_size,
174 int stripe_offset, int stripe_count, int stripe_pattern);
175 int llapi_file_open(const char *name, int flags, int mode,
176 unsigned long long stripe_size, int stripe_offset,
177 int stripe_count, int stripe_pattern);
178 int llapi_file_create_pool(const char *name, unsigned long long stripe_size,
179 int stripe_offset, int stripe_count,
180 int stripe_pattern, char *pool_name);
181 int llapi_file_open_pool(const char *name, int flags, int mode,
182 unsigned long long stripe_size, int stripe_offset,
183 int stripe_count, int stripe_pattern, char *pool_name);
184 int llapi_poollist(const char *name);
185 int llapi_get_poolbuf(const char *name, char **buf,
186 char ***poolist, int *poolcount);
187 int llapi_get_poollist(const char *name, char **poollist, int list_size,
188 char *buffer, int buffer_size);
189 int llapi_get_poolmembers(const char *poolname, char **members, int list_size,
190 char *buffer, int buffer_size);
191 int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
192 int llapi_file_lookup(int dirfd, const char *name);
193 void llapi_set_command_name(const char *cmd);
194 void llapi_clear_command_name(void);
196 enum llapi_layout_verbose {
197 VERBOSE_STRIPE_COUNT = 0x1,
198 VERBOSE_STRIPE_SIZE = 0x2,
199 VERBOSE_STRIPE_OFFSET = 0x4,
201 VERBOSE_DETAIL = 0x10,
202 VERBOSE_OBJID = 0x20,
203 VERBOSE_GENERATION = 0x40,
204 VERBOSE_MDTINDEX = 0x80,
205 VERBOSE_PATTERN = 0x100,
206 VERBOSE_COMP_COUNT = 0x200,
207 VERBOSE_COMP_FLAGS = 0x400,
208 VERBOSE_COMP_START = 0x800,
209 VERBOSE_COMP_END = 0x1000,
210 VERBOSE_COMP_ID = 0x2000,
211 VERBOSE_DFID = 0x4000,
212 VERBOSE_HASH_TYPE = 0x8000,
213 VERBOSE_MIRROR_COUNT = 0x10000,
214 VERBOSE_MIRROR_ID = 0x20000,
215 VERBOSE_EXT_SIZE = 0x40000,
216 VERBOSE_INHERIT = 0x80000,
217 VERBOSE_INHERIT_RR = 0x100000,
218 VERBOSE_DEFAULT = VERBOSE_STRIPE_COUNT | VERBOSE_STRIPE_SIZE |
219 VERBOSE_STRIPE_OFFSET | VERBOSE_POOL |
220 VERBOSE_OBJID | VERBOSE_GENERATION |
221 VERBOSE_PATTERN | VERBOSE_HASH_TYPE |
222 VERBOSE_COMP_COUNT | VERBOSE_COMP_FLAGS |
223 VERBOSE_COMP_START | VERBOSE_COMP_END |
224 VERBOSE_COMP_ID | VERBOSE_MIRROR_COUNT |
225 VERBOSE_MIRROR_ID | VERBOSE_EXT_SIZE |
226 VERBOSE_INHERIT | VERBOSE_INHERIT_RR
228 /* Compatibility with original names */
229 #define VERBOSE_SIZE VERBOSE_STRIPE_SIZE
230 #define VERBOSE_COUNT VERBOSE_STRIPE_COUNT
231 #define VERBOSE_OFFSET VERBOSE_STRIPE_OFFSET
232 #define VERBOSE_LAYOUT VERBOSE_PATTERN
235 NEWERXY_ATIME = 0, /* neweraY */
236 NEWERXY_MTIME = 1, /* newermY */
237 NEWERXY_CTIME = 2, /* newercY */
238 NEWERXY_BTIME = 3, /* newerbY | newerBY */
243 LFS_FIND_PERM_EXACT = -2,
244 LFS_FIND_PERM_ANY = -1,
245 LFS_FIND_PERM_OFF = 0,
246 LFS_FIND_PERM_ALL = 1,
250 unsigned int fp_max_depth;
252 mode_t fp_type; /* S_IFIFO,... */
259 /* {a,m,c,b}sign cannot be bitfields due to using pointers to
260 * access them during argument parsing. */
264 /* these need to be signed values */
266 fp_stripe_size_sign:2,
267 fp_stripe_count_sign:2,
268 fp_comp_start_sign:2,
270 fp_comp_count_sign:2,
271 fp_mirror_count_sign:2,
272 fp_mirror_index_sign:2,
278 fp_unused2_sign:2, /* Once used we must add */
279 fp_unused3_sign:2, /* a separate flag field */
280 fp_unused4_sign:2; /* at end of the struct. */
281 unsigned long long fp_size;
282 unsigned long long fp_size_units;
284 unsigned long long fp_zero_end:1,
286 fp_exclude_pattern:1,
294 fp_check_pool:1, /* LOV pool name */
295 fp_check_size:1, /* file size */
301 fp_get_lmv:1, /* get MDT list from LMV */
302 fp_raw:1, /* do not fill in defaults */
303 fp_check_stripe_size:1, /* LOV stripe size */
304 fp_exclude_stripe_size:1,
305 fp_check_stripe_count:1, /* LOV stripe count */
306 fp_exclude_stripe_count:1,
309 fp_get_default_lmv:1, /* Get default LMV */
313 fp_check_comp_count:1,
314 fp_exclude_comp_count:1,
315 fp_check_mirror_count:1,
316 fp_exclude_mirror_count:1,
317 fp_check_comp_flags:1,
318 fp_check_mirror_state:1,
319 fp_check_comp_start:1,
320 fp_exclude_comp_start:1,
322 fp_exclude_comp_end:1,
324 fp_exclude_comp_id:1,
325 fp_check_mirror_id:1,
326 fp_exclude_mirror_id:1,
327 fp_check_mirror_index:1,
328 fp_exclude_mirror_index:1,
329 fp_check_mdt_count:1,
330 fp_exclude_mdt_count:1,
331 fp_check_hash_flag:1,
332 fp_exclude_hash_type:1,
333 fp_yaml:1, /* output layout in YAML */
337 fp_exclude_foreign:1,
338 fp_check_ext_size:1, /* extension size */
339 fp_exclude_ext_size:1,
344 fp_stop_on_error:1, /* stop iteration on error */
345 fp_unused_bit5:1, /* are used we need to add */
346 fp_unused_bit6:1, /* a separate flag field at*/
347 fp_unused_bit7:1; /* the end of the struct. */
349 enum llapi_layout_verbose fp_verbose;
352 /* regular expression */
355 struct obd_uuid *fp_obd_uuid;
357 int fp_num_alloc_obds;
361 struct obd_uuid *fp_mdt_uuid;
363 int fp_num_alloc_mdts;
366 int fp_file_mdt_index;
369 struct lov_user_mds_data *fp_lmd;
371 char fp_poolname[LOV_MAXPOOLNAME + 1];
373 __u32 fp_lmv_stripe_count;
374 struct lmv_user_md *fp_lmv_md;
376 unsigned long long fp_stripe_size;
377 unsigned long long fp_stripe_size_units;
378 unsigned long long fp_stripe_count;
382 __u32 fp_mirror_count;
384 __u32 fp_comp_neg_flags;
385 __u16 fp_mirror_state;
386 __u16 fp_mirror_neg_state;
389 __u16 fp_mirror_index;
390 unsigned long long fp_comp_start;
391 unsigned long long fp_comp_start_units;
392 unsigned long long fp_comp_end;
393 unsigned long long fp_comp_end_units;
394 unsigned long long fp_mdt_count;
395 unsigned int fp_projid;
396 unsigned long long fp_blocks;
397 unsigned long long fp_blocks_units;
399 unsigned long fp_got_uuids:1,
403 unsigned int fp_depth;
404 unsigned int fp_hash_type;
405 unsigned int fp_time_margin; /* time margin in seconds */
406 __u32 fp_foreign_type;
407 unsigned long long fp_ext_size;
408 unsigned long long fp_ext_size_units;
411 * fp_newery[NEWERXY_MAX][0]: --newerXY reference
412 * fp_newery[NEWERXY_MAX][1]: ! -- newerXY reference
414 time_t fp_newery[NEWERXY_MAX][2];
418 unsigned int fp_hash_inflags;
419 unsigned int fp_hash_exflags;
420 /* Print all information (lfs find only) */
421 char *fp_format_printf_str;
424 int llapi_ostlist(char *path, struct find_param *param);
425 int llapi_uuid_match(char *real_uuid, char *search_uuid);
426 int llapi_getstripe(char *path, struct find_param *param);
427 int llapi_find(char *path, struct find_param *param);
429 int llapi_file_fget_mdtidx(int fd, int *mdtidx);
430 int llapi_dir_set_default_lmv(const char *name,
431 const struct llapi_stripe_param *param);
432 int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
433 int stripe_count, int stripe_pattern,
434 const char *pool_name);
435 int llapi_dir_create(const char *name, mode_t mode,
436 const struct llapi_stripe_param *param);
437 int llapi_dir_create_foreign(const char *name, mode_t mode, __u32 type,
438 __u32 flags, const char *value);
439 int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
440 int stripe_count, int stripe_pattern,
441 const char *poolname);
442 int llapi_direntry_remove(char *dname);
443 int llapi_unlink_foreign(char *dname);
445 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
446 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
447 int llapi_obd_statfs(char *path, __u32 type, __u32 index,
448 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
449 int llapi_ping(char *obd_type, char *obd_name);
450 int llapi_target_check(int num_types, char **obd_types, char *dir);
451 int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
452 int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
453 int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
454 int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
455 int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
456 int llapi_is_lustre_mnttype(const char *type);
457 int llapi_search_tgt(const char *fsname, const char *poolname,
458 const char *tgtname, bool is_mdt);
459 int llapi_search_mdt(const char *fsname, const char *poolname,
460 const char *mdtname);
461 int llapi_search_ost(const char *fsname, const char *poolname,
462 const char *ostname);
463 int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
464 int llapi_parse_size(const char *optarg, unsigned long long *size,
465 unsigned long long *size_units, int bytes_spec);
466 int llapi_search_mounts(const char *pathname, int index, char *mntdir,
468 int llapi_search_fsname(const char *pathname, char *fsname);
469 int llapi_get_fsname_instance(const char *path, char *fsname, size_t fsname_len,
470 char *instance, size_t instance_len);
471 int llapi_get_instance(const char *path, char *instance, size_t instance_len);
472 int llapi_get_fsname(const char *path, char *fsname, size_t fsname_len);
473 int llapi_getname(const char *path, char *name, size_t namelen);
474 int llapi_search_fileset(const char *pathname, char *fileset);
476 int llapi_search_rootpath(char *pathname, const char *fsname);
477 int llapi_search_rootpath_by_dev(char *pathname, dev_t dev);
478 int llapi_nodemap_exists(const char *name);
479 int llapi_migrate_mdt(char *path, struct find_param *param);
480 int llapi_mv(char *path, struct find_param *param);
484 #define HAVE_LLAPI_IS_LUSTRE_MNT
485 int llapi_is_lustre_mnt(struct mntent *mnt);
486 int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
487 int llapi_target_iterate(int type_num, char **obd_type, void *args,
489 int llapi_get_connect_flags(const char *mnt, __u64 *flags);
490 int llapi_cp(int argc, char *argv[]);
491 int llapi_ls(int argc, char *argv[]);
492 int llapi_fid_parse(const char *fidstr, struct lu_fid *fid, char **endptr);
493 int llapi_fid2path_at(int mnt_fd, const struct lu_fid *fid, char *path,
494 int pathlen, long long *recno, int *linkno);
495 int llapi_fid2path(const char *device, const char *fidstr, char *path,
496 int pathlen, long long *recno, int *linkno);
497 int llapi_path2fid(const char *path, struct lu_fid *fid);
498 unsigned long llapi_fid_hash(const struct lu_fid *f, unsigned int shift);
499 int llapi_get_mdt_index_by_fid(int fd, const struct lu_fid *fid,
501 int llapi_get_lum_file(const char *path, __u64 *valid, lstatx_t *statx,
502 struct lov_user_md *lum, size_t lumsize);
503 int llapi_get_lum_dir(const char *path, __u64 *valid, lstatx_t *statx,
504 struct lov_user_md *lum, size_t lumsize);
505 int llapi_get_lum_file_fd(int dir_fd, const char *fname, __u64 *valid,
506 lstatx_t *statx, struct lov_user_md *lum,
508 int llapi_get_lum_dir_fd(int dir_fd, __u64 *valid, lstatx_t *statx,
509 struct lov_user_md *lum, size_t lumsize);
511 int llapi_fd2fid(int fd, struct lu_fid *fid);
512 /* get FID of parent dir + the related name of entry in this parent dir */
513 int llapi_path2parent(const char *path, unsigned int linkno,
514 struct lu_fid *parent_fid, char *name, size_t name_size);
515 int llapi_fd2parent(int fd, unsigned int linkno, struct lu_fid *parent_fid,
516 char *name, size_t name_size);
517 int llapi_rmfid(const char *path, struct fid_array *fa);
518 int llapi_rmfid_at(int fd, struct fid_array *fa);
519 int llapi_root_path_open(char *device, int *outfd);
520 int llapi_chomp_string(char *buf);
524 int llapi_handle_to_fid(struct file_handle **handle, const struct lu_fid *fid);
525 int llapi_open_by_fid_at(int lustre_fd, const struct lu_fid *fid,
527 int llapi_open_by_fid(const char *lustre_dir, const struct lu_fid *fid,
529 int llapi_get_version_string(char *version, unsigned int version_size);
530 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
531 int llapi_get_version(char *buffer, int buffer_size, char **version)
532 __attribute__((deprecated));
533 int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
534 int llapi_file_flush(int fd);
535 extern int llapi_get_ost_layout_version(int fd, __u32 *layout_version);
536 int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
537 int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
538 int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
540 int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
542 int llapi_hsm_register_event_fifo(const char *path);
543 int llapi_hsm_unregister_event_fifo(const char *path);
544 void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
545 const char *fmt, va_list args);
547 int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
548 int llapi_create_volatile_idx(const char *directory, int mdt_idx,
550 int llapi_create_volatile_param(const char *directory, int mdt_idx,
551 int open_flags, mode_t mode,
552 const struct llapi_stripe_param *stripe_param);
554 static inline int llapi_create_volatile(char *directory, int open_flags)
556 return llapi_create_volatile_idx(directory, -1, open_flags);
560 int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
561 int gid, __u64 flags);
562 int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2, __u64 flags);
563 int llapi_swap_layouts(const char *path1, const char *path2, __u64 dv1,
564 __u64 dv2, __u64 flags);
566 /* Changelog interface. priv is private state, managed internally by these
569 /* Records received are in extended format now, though most of them are still
570 * written in disk in changelog_rec format (to save space and time), it's
571 * converted to extended format in the lustre api to ease changelog analysis.
573 #define HAVE_CHANGELOG_EXTEND_REC 1
575 int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
576 const char *mdtname, long long startrec);
577 int llapi_changelog_fini(void **priv);
578 int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
579 int llapi_changelog_in_buf(void *priv);
580 int llapi_changelog_free(struct changelog_rec **rech);
581 int llapi_changelog_get_fd(void *priv);
582 /* Allow records up to endrec to be destroyed; requires registered id. */
583 int llapi_changelog_clear(const char *mdtname, const char *idstr,
585 extern int llapi_changelog_set_xflags(void *priv,
586 enum changelog_send_extra_flag extra_flags);
588 /* HSM copytool interface.
589 * priv is private state, managed internally by these functions
591 struct hsm_copytool_private;
592 struct hsm_copyaction_private;
594 int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
595 const char *mnt, int archive_count,
596 int *archives, int rfd_flags);
597 int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
598 int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
599 int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
600 struct hsm_action_list **hal, int *msgsize);
601 int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
602 const struct hsm_copytool_private *ct,
603 const struct hsm_action_item *hai,
604 int restore_mdt_index, int restore_open_flags,
606 int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
607 const struct hsm_extent *he, int hp_flags, int errval);
608 int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
609 const struct hsm_extent *he, __u64 total,
611 int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
613 int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
614 int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
615 unsigned long long stripe_size, int stripe_offset,
616 int stripe_count, int stripe_pattern, char *pool_name,
617 struct lu_fid *newfid);
619 /* HSM user interface */
620 struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
622 int llapi_hsm_request(const char *path, const struct hsm_user_request *request);
623 int llapi_hsm_current_action(const char *path, struct hsm_current_action *hca);
626 enum llapi_json_types {
627 LLAPI_JSON_INTEGER = 1,
633 struct llapi_json_item {
642 struct llapi_json_item *lji_next;
645 struct llapi_json_item_list {
647 struct llapi_json_item *ljil_items;
650 int llapi_json_init_list(struct llapi_json_item_list **item_list);
651 int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
652 int llapi_json_add_item(struct llapi_json_item_list **item_list, char *key,
653 __u32 type, void *val);
654 int llapi_json_write_list(struct llapi_json_item_list **item_list, FILE *fp);
657 int llapi_lease_acquire(int fd, enum ll_lease_mode mode);
658 int llapi_lease_release(int fd);
659 int llapi_lease_set(int fd, const struct ll_ioc_lease *data);
660 int llapi_lease_check(int fd);
661 int llapi_lease_get(int fd, int mode); /* obsoleted */
662 int llapi_lease_put(int fd); /* obsoleted */
665 int llapi_group_lock(int fd, int gid);
666 int llapi_group_unlock(int fd, int gid);
667 int llapi_group_lock64(int fd, __u64 gid);
668 int llapi_group_unlock64(int fd, __u64 gid);
670 bool llapi_file_is_sparse(int fd);
671 off_t llapi_data_seek(int src_fd, off_t offset, size_t *length);
672 int llapi_hole_punch(int fd, off_t start, size_t length);
675 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
676 struct llapi_lu_ladvise *ladvise);
679 int llapi_pcc_attach(const char *path, __u32 id, enum lu_pcc_type type);
680 int llapi_pcc_attach_fid(const char *mntpath, const struct lu_fid *fid,
681 __u32 id, enum lu_pcc_type type);
682 int llapi_pcc_attach_fid_str(const char *mntpath, const char *fidstr,
683 __u32 id, enum lu_pcc_type type);
684 int llapi_pcc_detach_fd(int fd, __u32 option);
685 int llapi_pcc_detach_fid(const char *mntpath, const struct lu_fid *fid,
687 int llapi_pcc_detach_fid_str(const char *mntpath, const char *fidstr,
689 int llapi_pcc_detach_file(const char *path, __u32 option);
690 int llapi_pcc_state_get_fd(int fd, struct lu_pcc_state *state);
691 int llapi_pcc_state_get(const char *path, struct lu_pcc_state *state);
692 int llapi_pccdev_set(const char *mntpath, const char *cmd);
693 int llapi_pccdev_get(const char *mntpath);
696 /* llapi_layout user interface */
699 * An array element storing component info to be resynced during mirror
702 struct llapi_resync_comp {
705 uint32_t lrc_mirror_id;
706 uint32_t lrc_id; /* component id */
710 /** Opaque data type abstracting the layout of a Lustre file. */
713 int llapi_mirror_truncate(int fd, unsigned int id, off_t length);
714 ssize_t llapi_mirror_write(int fd, unsigned int id, const void *buf,
715 size_t count, off_t pos);
716 int llapi_mirror_find(struct llapi_layout *layout, uint64_t file_start,
717 uint64_t file_end, uint64_t *endp);
718 int llapi_layout_get_last_init_comp(struct llapi_layout *layout);
719 int llapi_layout_mirror_inherit(struct llapi_layout *f_layout,
720 struct llapi_layout *m_layout);
721 int llapi_mirror_find_stale(struct llapi_layout *layout,
722 struct llapi_resync_comp *comp, size_t comp_size,
723 __u16 *mirror_ids, int ids_nr);
724 int llapi_mirror_resync_many(int fd, struct llapi_layout *layout,
725 struct llapi_resync_comp *comp_array,
726 int comp_size, uint64_t start, uint64_t end);
728 * Flags to control how layouts are retrieved.
731 enum llapi_layout_get_flags {
732 /** Replace non-specified values with expected inherited values. */
733 LLAPI_LAYOUT_GET_EXPECTED = 0x0001,
734 /** Use a temporary buffer to swab and return xattrs. */
735 LLAPI_LAYOUT_GET_COPY = 0x0002,
736 /** Verify xattr contains sane layout values. */
737 LLAPI_LAYOUT_GET_CHECK = 0x0004,
739 /* compatibility macros for old interfaces */
740 #define LAYOUT_GET_EXPECTED LLAPI_LAYOUT_GET_EXPECTED
741 #define LLAPI_LXF_COPY LLAPI_LAYOUT_GET_COPY
742 #define LLAPI_LXF_CHECK LLAPI_LAYOUT_GET_CHECK
745 * Return a pointer to a newly-allocated opaque data structure containing
746 * the layout for the file at \a path. The pointer should be freed with
747 * llapi_layout_free() when it is no longer needed. Failure is indicated
748 * by a NULL return value and an appropriate error code stored in errno.
750 struct llapi_layout *llapi_layout_get_by_path(const char *path,
751 enum llapi_layout_get_flags flags);
754 * Return a pointer to a newly-allocated opaque data type containing the
755 * layout for the file referenced by open file descriptor \a fd. The
756 * pointer should be freed with llapi_layout_free() when it is no longer
757 * needed. Failure is indicated by a NULL return value and an
758 * appropriate error code stored in errno.
760 struct llapi_layout *llapi_layout_get_by_fd(int fd,
761 enum llapi_layout_get_flags flags);
764 * Return a pointer to a newly-allocated opaque data type containing the
765 * layout for the file associated with Lustre file identifier
766 * \a fid. The string \a path must name a path within the
767 * filesystem that contains the file being looked up, such as the
768 * filesystem root. The returned pointer should be freed with
769 * llapi_layout_free() when it is no longer needed. Failure is
770 * indicated with a NULL return value and an appropriate error code
773 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
774 const struct lu_fid *fid,
775 enum llapi_layout_get_flags flags);
778 * Return a pointer to a newly-allocated opaque data type containing the
779 * layout for the file associated with extended attribute \a lov_xattr. The
780 * length of the extended attribute is \a lov_xattr_size. The \a lov_xattr
781 * should be raw xattr without being swapped, since this function will swap it
782 * properly. Thus, \a lov_xattr will be modified during the process. If the
783 * \a LLAPI_LXF_CHECK flag of \a flags is set, this function will check whether
784 * the objects count in lum is consistent with the stripe count in lum. This
785 * check only apply to regular file, so \a LLAPI_LAYOUT_GET_CHECK flag should
786 * be cleared if the xattr belongs to a directory. If the flag \a
787 * LLAPI_LAYOUT_GET_COPY is set, this function will use a temporary buffer for
788 * byte swapping when necessary, leaving \a lov_xattr untouched. Otherwise, the
789 * byte swapping will be done to the \a lov_xattr buffer directly. The returned
790 * pointer should be freed with llapi_layout_free() when it is no longer
791 * needed. Failure is * indicated with a NULL return value and an appropriate
792 * error code stored in errno.
794 struct llapi_layout *llapi_layout_get_by_xattr(void *lov_xattr,
795 ssize_t lov_xattr_size,
796 enum llapi_layout_get_flags flags);
799 * Allocate a new layout. Use this when creating a new file with
800 * llapi_layout_file_create().
802 struct llapi_layout *llapi_layout_alloc(void);
805 * Free memory allocated for \a layout.
807 void llapi_layout_free(struct llapi_layout *layout);
810 * llapi_layout_merge() - Merge a composite layout into another one.
811 * @dst_layout: Destination composite layout.
812 * @src_layout: Source composite layout.
814 * This function copies all of the components from @src_layout and
815 * appends them to @dst_layout.
817 * Return: 0 on success or -1 on failure.
819 int llapi_layout_merge(struct llapi_layout **dst_layout,
820 const struct llapi_layout *src_layout);
822 /** Not a valid stripe size, offset, or RAID pattern. */
823 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
826 * When specified or returned as the value for stripe count,
827 * stripe size, offset, or RAID pattern, the filesystem-wide
828 * default behavior will apply.
830 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
833 * When specified or returned as the value for stripe count, all
834 * available OSTs will be used.
836 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
839 * When specified as the value for layout pattern, file objects will be
840 * stored using RAID0. That is, data will be split evenly and without
841 * redundancy across all OSTs in the layout.
843 #define LLAPI_LAYOUT_RAID0 0ULL
844 #define LLAPI_LAYOUT_MDT 2ULL
845 #define LLAPI_LAYOUT_OVERSTRIPING 4ULL
846 #define LLAPI_LAYOUT_FOREIGN 8ULL
849 * The layout includes a specific set of OSTs on which to allocate.
851 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
854 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
856 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
859 * Flags to modify how layouts are retrieved.
861 /******************** Stripe Count ********************/
864 * Store the stripe count of \a layout in \a count.
867 * \retval -1 Error with status code in errno.
869 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
873 * Set the stripe count of \a layout to \a count.
876 * \retval -1 Invalid argument, errno set to EINVAL.
878 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
881 * Check if the stripe count \a stripe_count \a is valid.
883 bool llapi_layout_stripe_count_is_valid(int64_t stripe_count);
884 /******************** Stripe Size ********************/
887 * Store the stripe size of \a layout in \a size.
890 * \retval -1 Invalid argument, errno set to EINVAL.
892 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
896 * Set the stripe size of \a layout to \a stripe_size.
899 * \retval -1 Invalid argument, errno set to EINVAL.
901 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
904 /******************** Extension Size ********************/
907 * Store the extension size of \a layout in \a size.
910 * \retval -1 Invalid argument, errno set to EINVAL.
912 int llapi_layout_extension_size_get(const struct llapi_layout *layout,
916 * Set the extension size of \a layout to \a stripe_size.
919 * \retval -1 Invalid argument, errno set to EINVAL.
921 int llapi_layout_extension_size_set(struct llapi_layout *layout, uint64_t size);
924 /******************** Stripe Pattern ********************/
927 * Store the stripe pattern of \a layout in \a pattern.
930 * \retval -1 Error with status code in errno.
932 int llapi_layout_pattern_get(const struct llapi_layout *layout,
936 * Set the stripe pattern of \a layout to \a pattern.
939 * \retval -1 Invalid argument, errno set to EINVAL.
941 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
943 /******************** OST Index ********************/
946 * Store the index of the OST where stripe number \a stripe_number is stored
949 * An error return value will result from a NULL layout, if \a
950 * stripe_number is out of range, or if \a layout was not initialized
951 * with llapi_layout_lookup_by{path,fd,fid}().
954 * \retval -1 Invalid argument, errno set to EINVAL.
956 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
957 uint64_t stripe_number, uint64_t *index);
960 * Set the OST index associated with stripe number \a stripe_number to
962 * NB: This is currently supported only for \a stripe_number = 0 and
963 * other usage will return ENOTSUPP in errno. A NULL \a layout or
964 * out-of-range \a stripe_number will return EINVAL in errno.
967 * \retval -1 Error with errno set to non-zero value.
969 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
972 /******************** Pool Name ********************/
975 * Store up to \a pool_name_len characters of the name of the pool of
976 * OSTs associated with \a layout into the buffer pointed to by
979 * The correct calling form is:
981 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
983 * A pool defines a set of OSTs from which file objects may be
984 * allocated for a file using \a layout.
986 * On success, the number of bytes stored is returned, excluding the
987 * terminating '\0' character (zero indicates that \a layout does not
988 * have an associated OST pool). On error, -1 is returned and errno is
989 * set appropriately. Possible sources of error include a NULL pointer
990 * argument or insufficient space in \a dest to store the pool name,
991 * in which cases errno will be set to EINVAL.
993 * \retval 0+ The number of bytes stored in \a dest.
994 * \retval -1 Invalid argument, errno set to EINVAL.
996 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
997 char *pool_name, size_t pool_name_len);
1000 * Set the name of the pool of OSTs from which file objects will be
1001 * allocated to \a pool_name.
1003 * If the pool name uses "fsname.pool" notation to qualify the pool name
1004 * with a filesystem name, the "fsname." portion will be silently
1005 * discarded before storing the value. No validation that \a pool_name
1006 * is an existing non-empty pool in filesystem \a fsname will be
1007 * performed. Such validation can be performed by the application if
1008 * desired using the llapi_search_ost() function. The maximum length of
1009 * the stored value is defined by the constant LOV_MAXPOOLNAME.
1011 * \retval 0 Success.
1012 * \retval -1 Invalid argument, errno set to EINVAL.
1014 int llapi_layout_pool_name_set(struct llapi_layout *layout,
1015 const char *pool_name);
1017 /******************** File Creation ********************/
1020 * Open an existing file at \a path, or create it with the specified
1021 * \a layout and \a mode.
1023 * One access mode and zero or more file creation flags and file status
1024 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
1025 * open file descriptor for the file. If \a layout is non-NULL and
1026 * \a path is not on a Lustre filesystem this function will fail and set
1029 * An already existing file may be opened with this function, but
1030 * \a layout and \a mode will not be applied to it. Callers requiring a
1031 * guarantee that the opened file is created with the specified
1032 * \a layout and \a mode should use llapi_layout_file_create().
1034 * A NULL \a layout may be specified, in which case the standard Lustre
1035 * behavior for assigning layouts to newly-created files will apply.
1037 * \retval 0+ An open file descriptor.
1038 * \retval -1 Error with status code in errno.
1040 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
1041 const struct llapi_layout *layout);
1044 * Create a new file at \a path with the specified \a layout and \a mode.
1046 * One access mode and zero or more file creation flags and file status
1047 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
1048 * open file descriptor for the file. If \a layout is non-NULL and
1049 * \a path is not on a Lustre filesystem this function will fail and set
1054 * llapi_layout_file_create(path, open_flags, mode, layout)
1056 * shall be equivalent to:
1058 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
1060 * It is an error if \a path specifies an existing file.
1062 * A NULL \a layout may be specified, in which the standard Lustre
1063 * behavior for assigning layouts to newly-created files will apply.
1065 * \retval 0+ An open file descriptor.
1066 * \retval -1 Error with status code in errno.
1068 int llapi_layout_file_create(const char *path, int open_flags, int mode,
1069 const struct llapi_layout *layout);
1072 * Set flags to the header of component layout.
1074 int llapi_layout_flags_set(struct llapi_layout *layout, uint32_t flags);
1075 int llapi_layout_flags_get(struct llapi_layout *layout, uint32_t *flags);
1076 const char *llapi_layout_flags_string(uint32_t flags);
1077 __u16 llapi_layout_string_flags(char *string);
1080 * llapi_layout_mirror_count_get() - Get mirror count from the header of
1082 * @layout: Layout to get mirror count from.
1083 * @count: Returned mirror count value.
1085 * This function gets mirror count from the header of a layout.
1087 * Return: 0 on success or -1 on failure.
1089 int llapi_layout_mirror_count_get(struct llapi_layout *layout,
1093 * llapi_layout_mirror_count_set() - Set mirror count to the header of a layout.
1094 * @layout: Layout to set mirror count in.
1095 * @count: Mirror count value to be set.
1097 * This function sets mirror count to the header of a layout.
1099 * Return: 0 on success or -1 on failure.
1101 int llapi_layout_mirror_count_set(struct llapi_layout *layout,
1105 * Fetch the start and end offset of the current layout component.
1107 int llapi_layout_comp_extent_get(const struct llapi_layout *layout,
1108 uint64_t *start, uint64_t *end);
1110 * Set the extent of current layout component.
1112 int llapi_layout_comp_extent_set(struct llapi_layout *layout,
1113 uint64_t start, uint64_t end);
1115 /* PFL component flags table */
1116 static const struct comp_flag_name {
1117 enum lov_comp_md_entry_flags cfn_flag;
1118 const char *cfn_name;
1119 } comp_flags_table[] = {
1120 { LCME_FL_INIT, "init" },
1121 { LCME_FL_STALE, "stale" },
1122 { LCME_FL_PREF_RW, "prefer" },
1123 { LCME_FL_OFFLINE, "offline" },
1124 { LCME_FL_NOSYNC, "nosync" },
1125 { LCME_FL_EXTENSION, "extension" },
1126 { LCME_FL_PARITY, "parity" },
1129 /* HSM component flags table */
1130 static const struct hsm_flag_name {
1131 enum hsm_states hfn_flag;
1132 const char *hfn_name;
1133 } hsm_flags_table[] = {
1134 { HS_NONE, "none" },
1135 { HS_EXISTS, "exists" },
1136 { HS_DIRTY, "dirty" },
1137 { HS_RELEASED, "released" },
1138 { HS_ARCHIVED, "archived" },
1139 { HS_NORELEASE, "norelease" },
1140 { HS_NOARCHIVE, "noarchive" },
1141 { HS_LOST, "lost" },
1142 { HS_PCCRW, "pccrw" },
1143 { HS_PCCRO, "pccro" },
1147 * Gets the attribute flags of the current component.
1149 int llapi_layout_comp_flags_get(const struct llapi_layout *layout,
1152 * Sets the specified flags of the current component leaving other flags as-is.
1154 int llapi_layout_comp_flags_set(struct llapi_layout *layout, uint32_t flags);
1156 * Clears the flags specified in the flags leaving other flags as-is.
1158 int llapi_layout_comp_flags_clear(struct llapi_layout *layout, uint32_t flags);
1160 * Fetches the file-unique component ID of the current layout component.
1162 int llapi_layout_comp_id_get(const struct llapi_layout *layout, uint32_t *id);
1164 * Fetches the mirror ID of the current layout component.
1166 int llapi_layout_mirror_id_get(const struct llapi_layout *layout, uint32_t *id);
1168 * Adds one component to the existing composite or plain layout.
1170 int llapi_layout_comp_add(struct llapi_layout *layout);
1172 * Adds a first component of a mirror to the existing composite layout.
1174 int llapi_layout_add_first_comp(struct llapi_layout *layout);
1176 * Deletes the current layout component from the composite layout.
1178 int llapi_layout_comp_del(struct llapi_layout *layout);
1180 enum llapi_layout_comp_use {
1181 LLAPI_LAYOUT_COMP_USE_FIRST = 1,
1182 LLAPI_LAYOUT_COMP_USE_LAST = 2,
1183 LLAPI_LAYOUT_COMP_USE_NEXT = 3,
1184 LLAPI_LAYOUT_COMP_USE_PREV = 4,
1188 * Set the currently active component to the specified component ID.
1190 int llapi_layout_comp_use_id(struct llapi_layout *layout, uint32_t id);
1192 * Select the currently active component at the specified position.
1194 int llapi_layout_comp_use(struct llapi_layout *layout, uint32_t pos);
1196 * Add layout components to an existing file.
1198 int llapi_layout_file_comp_add(const char *path,
1199 const struct llapi_layout *layout);
1201 * Delete component(s) by the specified component id or flags.
1203 int llapi_layout_file_comp_del(const char *path, uint32_t id, uint32_t flags);
1205 * Change flags or other parameters of the component(s) by component ID of an
1206 * existing file. The component to be modified is specified by the
1207 * comp->lcme_id value, which must be an unique component ID. The new
1208 * attributes are passed in by @comp and @valid is used to specify which
1209 * attributes in the component are going to be changed.
1211 int llapi_layout_file_comp_set(const char *path, uint32_t *ids, uint32_t *flags,
1214 * Check if the file layout is composite.
1216 bool llapi_layout_is_composite(struct llapi_layout *layout);
1219 LLAPI_LAYOUT_ITER_CONT = 0,
1220 LLAPI_LAYOUT_ITER_STOP = 1,
1224 * Iteration callback function.
1226 * \retval LLAPI_LAYOUT_ITER_CONT Iteration proceeds
1227 * \retval LLAPI_LAYOUT_ITER_STOP Stop iteration
1228 * \retval < 0 error code
1230 typedef int (*llapi_layout_iter_cb)(struct llapi_layout *layout, void *cbdata);
1233 * Iterate all components in the corresponding layout
1235 int llapi_layout_comp_iterate(struct llapi_layout *layout,
1236 llapi_layout_iter_cb cb, void *cbdata);
1239 * FLR: mirror operation APIs
1241 int llapi_mirror_set(int fd, unsigned int id);
1242 int llapi_mirror_clear(int fd);
1243 ssize_t llapi_mirror_read(int fd, unsigned int id,
1244 void *buf, size_t count, off_t pos);
1245 ssize_t llapi_mirror_copy_many(int fd, __u16 src, __u16 *dst, size_t count);
1246 int llapi_mirror_copy(int fd, unsigned int src, unsigned int dst,
1247 off_t pos, size_t count);
1248 off_t llapi_mirror_data_seek(int fd, unsigned int id, off_t pos, size_t *size);
1249 int llapi_mirror_punch(int fd, unsigned int id, off_t start, size_t length);
1251 int llapi_heat_get(int fd, struct lu_heat *heat);
1252 int llapi_heat_set(int fd, __u64 flags);
1254 int llapi_layout_sanity(struct llapi_layout *layout, bool incomplete, bool flr);
1255 void llapi_layout_sanity_perror(int error);
1256 int llapi_layout_dom_size(struct llapi_layout *layout, uint64_t *size);
1258 int llapi_param_get_paths(const char *pattern, glob_t *paths);
1259 int llapi_param_get_value(const char *path, char **buf, size_t *buflen);
1260 void llapi_param_paths_free(glob_t *paths);
1264 #if defined(__cplusplus)