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, 2016, Intel Corporation.
29 * This file is part of Lustre, http://www.lustre.org/
30 * Lustre is a trademark of Sun Microsystems, Inc.
36 /** \defgroup llapi llapi
43 #include <lustre/lustre_user.h>
45 extern bool liblustreapi_initialized;
48 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
51 /* lustreapi message severity level */
52 enum llapi_message_level {
63 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
64 const char *fmt, va_list ap);
67 /* the bottom three bits reserved for llapi_message_level */
68 #define LLAPI_MSG_MASK 0x00000007
69 #define LLAPI_MSG_NO_ERRNO 0x00000010
71 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
73 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
77 if (level >= LLAPI_MSG_MAX)
82 extern void llapi_msg_set_level(int level);
83 int llapi_msg_get_level(void);
84 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
85 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
87 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
88 __attribute__((__format__(__printf__, 3, 4)));
89 #define llapi_err_noerrno(level, fmt, a...) \
90 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
91 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
92 __attribute__((__format__(__printf__, 2, 3)));
94 struct llapi_stripe_param {
95 unsigned long long lsp_stripe_size;
97 int lsp_stripe_offset;
98 int lsp_stripe_pattern;
99 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
100 int lsp_stripe_count;
101 bool lsp_is_specific;
105 extern int llapi_file_open_param(const char *name, int flags, mode_t mode,
106 const struct llapi_stripe_param *param);
107 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
108 int stripe_offset, int stripe_count,
110 extern int llapi_file_open(const char *name, int flags, int mode,
111 unsigned long long stripe_size, int stripe_offset,
112 int stripe_count, int stripe_pattern);
113 extern int llapi_file_create_pool(const char *name,
114 unsigned long long stripe_size,
115 int stripe_offset, int stripe_count,
116 int stripe_pattern, char *pool_name);
117 extern int llapi_file_open_pool(const char *name, int flags, int mode,
118 unsigned long long stripe_size,
119 int stripe_offset, int stripe_count,
120 int stripe_pattern, char *pool_name);
121 extern int llapi_poollist(const char *name);
122 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
123 char *buffer, int buffer_size);
124 extern int llapi_get_poolmembers(const char *poolname, char **members,
125 int list_size, char *buffer, int buffer_size);
126 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
127 #define HAVE_LLAPI_FILE_LOOKUP
128 extern int llapi_file_lookup(int dirfd, const char *name);
130 #define VERBOSE_COUNT 0x1
131 #define VERBOSE_SIZE 0x2
132 #define VERBOSE_OFFSET 0x4
133 #define VERBOSE_POOL 0x8
134 #define VERBOSE_DETAIL 0x10
135 #define VERBOSE_OBJID 0x20
136 #define VERBOSE_GENERATION 0x40
137 #define VERBOSE_MDTINDEX 0x80
138 #define VERBOSE_LAYOUT 0x100
139 #define VERBOSE_COMP_COUNT 0x200
140 #define VERBOSE_COMP_FLAGS 0x400
141 #define VERBOSE_COMP_START 0x800
142 #define VERBOSE_COMP_END 0x1000
143 #define VERBOSE_COMP_ID 0x2000
144 #define VERBOSE_DFID 0x4000
145 #define VERBOSE_HASH_TYPE 0x8000
146 #define VERBOSE_DEFAULT (VERBOSE_COUNT | VERBOSE_SIZE | \
147 VERBOSE_OFFSET | VERBOSE_POOL | \
148 VERBOSE_OBJID | VERBOSE_GENERATION | \
149 VERBOSE_LAYOUT | VERBOSE_HASH_TYPE)
152 unsigned int fp_max_depth;
154 mode_t fp_type; /* S_IFIFO,... */
160 /* {a,m,c}sign cannot be bitfields due to using pointers to
161 * access them during argument parsing. */
165 /* these need to be signed values */
167 fp_stripe_size_sign:2,
168 fp_stripe_count_sign:2;
169 unsigned long long fp_size;
170 unsigned long long fp_size_units;
172 unsigned long fp_zero_end:1,
174 fp_exclude_pattern:1,
182 fp_check_pool:1, /* LOV pool name */
183 fp_check_size:1, /* file size */
189 fp_get_lmv:1, /* get MDT list from LMV */
190 fp_raw:1, /* do not fill in defaults */
191 fp_check_stripe_size:1, /* LOV stripe size */
192 fp_exclude_stripe_size:1,
193 fp_check_stripe_count:1, /* LOV stripe count */
194 fp_exclude_stripe_count:1,
197 fp_get_default_lmv:1, /* Get default LMV */
203 /* regular expression */
206 struct obd_uuid *fp_obd_uuid;
208 int fp_num_alloc_obds;
212 struct obd_uuid *fp_mdt_uuid;
214 int fp_num_alloc_mdts;
217 int fp_file_mdt_index;
220 struct lov_user_mds_data *fp_lmd;
222 char fp_poolname[LOV_MAXPOOLNAME + 1];
224 __u32 fp_lmv_stripe_count;
225 struct lmv_user_md *fp_lmv_md;
227 unsigned long long fp_stripe_size;
228 unsigned long long fp_stripe_size_units;
229 unsigned long long fp_stripe_count;
232 /* In-process parameters. */
233 unsigned long fp_got_uuids:1,
235 unsigned int fp_depth;
238 extern int llapi_ostlist(char *path, struct find_param *param);
239 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
240 extern int llapi_getstripe(char *path, struct find_param *param);
241 extern int llapi_find(char *path, struct find_param *param);
243 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
244 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
245 int stripe_count, int stripe_pattern,
246 const char *pool_name);
247 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
248 int stripe_count, int stripe_pattern,
249 const char *poolname);
250 int llapi_direntry_remove(char *dname);
252 int llapi_obd_fstatfs(int fd, __u32 type, __u32 index,
253 struct obd_statfs *stat_buf, struct obd_uuid *uuid_buf);
254 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
255 struct obd_statfs *stat_buf,
256 struct obd_uuid *uuid_buf);
257 extern int llapi_ping(char *obd_type, char *obd_name);
258 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
259 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
260 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
261 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
262 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
263 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
264 extern int llapi_is_lustre_mnttype(const char *type);
265 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
266 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
267 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
268 unsigned long long *size_units, int bytes_spec);
269 extern int llapi_search_mounts(const char *pathname, int index,
270 char *mntdir, char *fsname);
271 extern int llapi_search_fsname(const char *pathname, char *fsname);
272 extern int llapi_getname(const char *path, char *buf, size_t size);
273 extern int llapi_search_fileset(const char *pathname, char *fileset);
275 extern int llapi_search_rootpath(char *pathname, const char *fsname);
276 extern int llapi_nodemap_exists(const char *name);
277 extern int llapi_migrate_mdt(char *path, struct find_param *param);
278 extern int llapi_mv(char *path, struct find_param *param);
281 #define HAVE_LLAPI_IS_LUSTRE_MNT
282 extern int llapi_is_lustre_mnt(struct mntent *mnt);
283 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
284 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
286 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
287 extern int llapi_cp(int argc, char *argv[]);
288 extern int llapi_ls(int argc, char *argv[]);
289 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
290 int pathlen, long long *recno, int *linkno);
291 extern int llapi_path2fid(const char *path, lustre_fid *fid);
292 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
294 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
295 /* get FID of parent dir + the related name of entry in this parent dir */
296 extern int llapi_path2parent(const char *path, unsigned int linkno,
297 lustre_fid *parent_fid, char *name,
299 extern int llapi_fd2parent(int fd, unsigned int linkno,
300 lustre_fid *parent_fid, char *name,
302 extern int llapi_chomp_string(char *buf);
303 extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid,
306 extern int llapi_get_version_string(char *version, unsigned int version_size);
307 /* llapi_get_version() is deprecated, use llapi_get_version_string() instead */
308 extern int llapi_get_version(char *buffer, int buffer_size, char **version)
309 __attribute__((deprecated));
310 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
311 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
312 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
313 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
315 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
317 extern int llapi_hsm_register_event_fifo(const char *path);
318 extern int llapi_hsm_unregister_event_fifo(const char *path);
319 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
320 const char *fmt, va_list args);
322 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
323 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
324 static inline int llapi_create_volatile(char *directory, int mode)
326 return llapi_create_volatile_idx(directory, -1, mode);
330 extern int llapi_fswap_layouts_grouplock(int fd1, int fd2, __u64 dv1, __u64 dv2,
331 int gid, __u64 flags);
332 extern int llapi_fswap_layouts(int fd1, int fd2, __u64 dv1, __u64 dv2,
334 extern int llapi_swap_layouts(const char *path1, const char *path2,
335 __u64 dv1, __u64 dv2, __u64 flags);
337 /* Changelog interface. priv is private state, managed internally by these
340 /* Records received are in extended format now, though most of them are still
341 * written in disk in changelog_rec format (to save space and time), it's
342 * converted to extended format in the lustre api to ease changelog analysis. */
343 #define HAVE_CHANGELOG_EXTEND_REC 1
345 extern int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
346 const char *mdtname, long long startrec);
347 extern int llapi_changelog_fini(void **priv);
348 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
349 extern int llapi_changelog_free(struct changelog_rec **rech);
350 extern int llapi_changelog_get_fd(void *priv);
351 /* Allow records up to endrec to be destroyed; requires registered id. */
352 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
355 /* HSM copytool interface.
356 * priv is private state, managed internally by these functions
358 struct hsm_copytool_private;
359 struct hsm_copyaction_private;
361 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
362 const char *mnt, int archive_count,
363 int *archives, int rfd_flags);
364 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
365 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
366 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
367 struct hsm_action_list **hal, int *msgsize);
368 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
369 const struct hsm_copytool_private *ct,
370 const struct hsm_action_item *hai,
371 int restore_mdt_index, int restore_open_flags,
373 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
374 const struct hsm_extent *he,
375 int hp_flags, int errval);
376 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
377 const struct hsm_extent *he, __u64 total,
379 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
381 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
382 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
383 unsigned long long stripe_size, int stripe_offset,
384 int stripe_count, int stripe_pattern,
385 char *pool_name, lustre_fid *newfid);
387 /* HSM user interface */
388 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
390 extern int llapi_hsm_request(const char *path,
391 const struct hsm_user_request *request);
392 extern int llapi_hsm_current_action(const char *path,
393 struct hsm_current_action *hca);
396 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
397 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
398 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
399 char *key, __u32 type, void *val);
400 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
404 extern int llapi_lease_get(int fd, int mode);
405 extern int llapi_lease_check(int fd);
406 extern int llapi_lease_put(int fd);
409 int llapi_group_lock(int fd, int gid);
410 int llapi_group_unlock(int fd, int gid);
413 int llapi_ladvise(int fd, unsigned long long flags, int num_advise,
414 struct llapi_lu_ladvise *ladvise);
417 /* llapi_layout user interface */
419 /** Opaque data type abstracting the layout of a Lustre file. */
423 * Flags to control how layouts are retrieved.
426 /* Replace non-specified values with expected inherited values. */
427 #define LAYOUT_GET_EXPECTED 0x1
430 * Return a pointer to a newly-allocated opaque data structure containing
431 * the layout for the file at \a path. The pointer should be freed with
432 * llapi_layout_free() when it is no longer needed. Failure is indicated
433 * by a NULL return value and an appropriate error code stored in errno.
435 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
438 * Return a pointer to a newly-allocated opaque data type containing the
439 * layout for the file referenced by open file descriptor \a fd. The
440 * pointer should be freed with llapi_layout_free() when it is no longer
441 * needed. Failure is indicated by a NULL return value and an
442 * appropriate error code stored in errno.
444 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
447 * Return a pointer to a newly-allocated opaque data type containing the
448 * layout for the file associated with Lustre file identifier string
449 * \a fidstr. The string \a path must name a path within the
450 * filesystem that contains the file being looked up, such as the
451 * filesystem root. The returned pointer should be freed with
452 * llapi_layout_free() when it is no longer needed. Failure is
453 * indicated with a NULL return value and an appropriate error code
456 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
457 const lustre_fid *fid,
461 * Allocate a new layout. Use this when creating a new file with
462 * llapi_layout_file_create().
464 struct llapi_layout *llapi_layout_alloc(void);
467 * Free memory allocated for \a layout.
469 void llapi_layout_free(struct llapi_layout *layout);
471 /** Not a valid stripe size, offset, or RAID pattern. */
472 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
475 * When specified or returned as the value for stripe count,
476 * stripe size, offset, or RAID pattern, the filesystem-wide
477 * default behavior will apply.
479 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
482 * When specified or returned as the value for stripe count, all
483 * available OSTs will be used.
485 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
488 * When specified as the value for layout pattern, file objects will be
489 * stored using RAID0. That is, data will be split evenly and without
490 * redundancy across all OSTs in the layout.
492 #define LLAPI_LAYOUT_RAID0 0
495 * The layout includes a specific set of OSTs on which to allocate.
497 #define LLAPI_LAYOUT_SPECIFIC 0x2000000000000000ULL
500 * A valid ost index should be less than maximum valid OST index (UINT_MAX).
502 #define LLAPI_LAYOUT_IDX_MAX 0x00000000FFFFFFFFULL
505 * Flags to modify how layouts are retrieved.
507 /******************** Stripe Count ********************/
510 * Store the stripe count of \a layout in \a count.
513 * \retval -1 Error with status code in errno.
515 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
519 * Set the stripe count of \a layout to \a count.
522 * \retval -1 Invalid argument, errno set to EINVAL.
524 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
526 /******************** Stripe Size ********************/
529 * Store the stripe size of \a layout in \a size.
532 * \retval -1 Invalid argument, errno set to EINVAL.
534 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
538 * Set the stripe size of \a layout to \a stripe_size.
541 * \retval -1 Invalid argument, errno set to EINVAL.
543 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
545 /******************** Stripe Pattern ********************/
548 * Store the stripe pattern of \a layout in \a pattern.
551 * \retval -1 Error with status code in errno.
553 int llapi_layout_pattern_get(const struct llapi_layout *layout,
557 * Set the stripe pattern of \a layout to \a pattern.
560 * \retval -1 Invalid argument, errno set to EINVAL.
562 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
564 /******************** OST Index ********************/
567 * Store the index of the OST where stripe number \a stripe_number is stored
570 * An error return value will result from a NULL layout, if \a
571 * stripe_number is out of range, or if \a layout was not initialized
572 * with llapi_layout_lookup_by{path,fd,fid}().
575 * \retval -1 Invalid argument, errno set to EINVAL.
577 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
578 uint64_t stripe_number, uint64_t *index);
581 * Set the OST index associated with stripe number \a stripe_number to
583 * NB: This is currently supported only for \a stripe_number = 0 and
584 * other usage will return ENOTSUPP in errno. A NULL \a layout or
585 * out-of-range \a stripe_number will return EINVAL in errno.
588 * \retval -1 Error with errno set to non-zero value.
590 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
593 /******************** Pool Name ********************/
596 * Store up to \a pool_name_len characters of the name of the pool of
597 * OSTs associated with \a layout into the buffer pointed to by
600 * The correct calling form is:
602 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
604 * A pool defines a set of OSTs from which file objects may be
605 * allocated for a file using \a layout.
607 * On success, the number of bytes stored is returned, excluding the
608 * terminating '\0' character (zero indicates that \a layout does not
609 * have an associated OST pool). On error, -1 is returned and errno is
610 * set appropriately. Possible sources of error include a NULL pointer
611 * argument or insufficient space in \a dest to store the pool name,
612 * in which cases errno will be set to EINVAL.
614 * \retval 0+ The number of bytes stored in \a dest.
615 * \retval -1 Invalid argument, errno set to EINVAL.
617 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
618 char *pool_name, size_t pool_name_len);
621 * Set the name of the pool of OSTs from which file objects will be
622 * allocated to \a pool_name.
624 * If the pool name uses "fsname.pool" notation to qualify the pool name
625 * with a filesystem name, the "fsname." portion will be silently
626 * discarded before storing the value. No validation that \a pool_name
627 * is an existing non-empty pool in filesystem \a fsname will be
628 * performed. Such validation can be performed by the application if
629 * desired using the llapi_search_ost() function. The maximum length of
630 * the stored value is defined by the constant LOV_MAXPOOLNAME.
633 * \retval -1 Invalid argument, errno set to EINVAL.
635 int llapi_layout_pool_name_set(struct llapi_layout *layout,
636 const char *pool_name);
638 /******************** File Creation ********************/
641 * Open an existing file at \a path, or create it with the specified
642 * \a layout and \a mode.
644 * One access mode and zero or more file creation flags and file status
645 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
646 * open file descriptor for the file. If \a layout is non-NULL and
647 * \a path is not on a Lustre filesystem this function will fail and set
650 * An already existing file may be opened with this function, but
651 * \a layout and \a mode will not be applied to it. Callers requiring a
652 * guarantee that the opened file is created with the specified
653 * \a layout and \a mode should use llapi_layout_file_create().
655 * A NULL \a layout may be specified, in which case the standard Lustre
656 * behavior for assigning layouts to newly-created files will apply.
658 * \retval 0+ An open file descriptor.
659 * \retval -1 Error with status code in errno.
661 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
662 const struct llapi_layout *layout);
665 * Create a new file at \a path with the specified \a layout and \a mode.
667 * One access mode and zero or more file creation flags and file status
668 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
669 * open file descriptor for the file. If \a layout is non-NULL and
670 * \a path is not on a Lustre filesystem this function will fail and set
675 * llapi_layout_file_create(path, open_flags, mode, layout)
677 * shall be equivalent to:
679 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
681 * It is an error if \a path specifies an existing file.
683 * A NULL \a layout may be specified, in which the standard Lustre
684 * behavior for assigning layouts to newly-created files will apply.
686 * \retval 0+ An open file descriptor.
687 * \retval -1 Error with status code in errno.
689 int llapi_layout_file_create(const char *path, int open_flags, int mode,
690 const struct llapi_layout *layout);