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.sun.com/software/products/lustre/docs/GPLv2.pdf
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
27 * Copyright (c) 2004, 2010, Oracle and/or its affiliates. All rights reserved.
28 * Use is subject to license terms.
30 * Copyright (c) 2011, 2014, Intel Corporation.
33 * This file is part of Lustre, http://www.lustre.org/
34 * Lustre is a trademark of Sun Microsystems, Inc.
40 /** \defgroup llapi llapi
47 #include <lustre/lustre_user.h>
49 extern bool liblustreapi_initialized;
52 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
55 /* lustreapi message severity level */
56 enum llapi_message_level {
67 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
68 const char *fmt, va_list ap);
71 /* the bottom three bits reserved for llapi_message_level */
72 #define LLAPI_MSG_MASK 0x00000007
73 #define LLAPI_MSG_NO_ERRNO 0x00000010
75 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
77 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
81 if (level >= LLAPI_MSG_MAX)
86 extern void llapi_msg_set_level(int level);
87 int llapi_msg_get_level(void);
88 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
89 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
91 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
92 __attribute__((__format__(__printf__, 3, 4)));
93 #define llapi_err_noerrno(level, fmt, a...) \
94 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
95 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
96 __attribute__((__format__(__printf__, 2, 3)));
98 struct llapi_stripe_param {
99 unsigned long long lsp_stripe_size;
101 int lsp_stripe_offset;
102 int lsp_stripe_pattern;
103 /* Number of stripes. Size of lsp_osts[] if lsp_specific is true.*/
104 int lsp_stripe_count;
105 bool lsp_is_specific;
109 extern int llapi_file_open_param(const char *name, int flags, mode_t mode,
110 const struct llapi_stripe_param *param);
111 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
112 int stripe_offset, int stripe_count,
114 extern int llapi_file_open(const char *name, int flags, int mode,
115 unsigned long long stripe_size, int stripe_offset,
116 int stripe_count, int stripe_pattern);
117 extern int llapi_file_create_pool(const char *name,
118 unsigned long long stripe_size,
119 int stripe_offset, int stripe_count,
120 int stripe_pattern, char *pool_name);
121 extern int llapi_file_open_pool(const char *name, int flags, int mode,
122 unsigned long long stripe_size,
123 int stripe_offset, int stripe_count,
124 int stripe_pattern, char *pool_name);
125 extern int llapi_poollist(const char *name);
126 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
127 char *buffer, int buffer_size);
128 extern int llapi_get_poolmembers(const char *poolname, char **members,
129 int list_size, char *buffer, int buffer_size);
130 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
131 #define HAVE_LLAPI_FILE_LOOKUP
132 extern int llapi_file_lookup(int dirfd, const char *name);
134 #define VERBOSE_COUNT 0x1
135 #define VERBOSE_SIZE 0x2
136 #define VERBOSE_OFFSET 0x4
137 #define VERBOSE_POOL 0x8
138 #define VERBOSE_DETAIL 0x10
139 #define VERBOSE_OBJID 0x20
140 #define VERBOSE_GENERATION 0x40
141 #define VERBOSE_MDTINDEX 0x80
142 #define VERBOSE_LAYOUT 0x100
143 #define VERBOSE_ALL (VERBOSE_COUNT | VERBOSE_SIZE | \
144 VERBOSE_OFFSET | VERBOSE_POOL | \
145 VERBOSE_OBJID | VERBOSE_GENERATION |\
149 unsigned int fp_max_depth;
151 mode_t fp_type; /* S_IFIFO,... */
157 /* {a,m,c}sign cannot be bitfields due to using pointers to
158 * access them during argument parsing. */
162 /* these need to be signed values */
164 fp_stripe_size_sign:2,
165 fp_stripe_count_sign:2;
166 unsigned long long fp_size;
167 unsigned long long fp_size_units;
169 unsigned long fp_zero_end:1,
171 fp_exclude_pattern:1,
179 fp_check_pool:1, /* LOV pool name */
180 fp_check_size:1, /* file size */
186 fp_get_lmv:1, /* get MDT list from LMV */
187 fp_raw:1, /* do not fill in defaults */
188 fp_check_stripe_size:1, /* LOV stripe size */
189 fp_exclude_stripe_size:1,
190 fp_check_stripe_count:1, /* LOV stripe count */
191 fp_exclude_stripe_count:1,
194 fp_get_default_lmv:1, /* Get default LMV */
200 /* regular expression */
203 struct obd_uuid *fp_obd_uuid;
205 int fp_num_alloc_obds;
209 struct obd_uuid *fp_mdt_uuid;
211 int fp_num_alloc_mdts;
214 int fp_file_mdt_index;
217 struct lov_user_mds_data *fp_lmd;
219 char fp_poolname[LOV_MAXPOOLNAME + 1];
221 __u32 fp_lmv_stripe_count;
222 struct lmv_user_md *fp_lmv_md;
224 unsigned long long fp_stripe_size;
225 unsigned long long fp_stripe_size_units;
226 unsigned long long fp_stripe_count;
229 /* In-process parameters. */
230 unsigned long fp_got_uuids:1,
232 unsigned int fp_depth;
235 extern int llapi_ostlist(char *path, struct find_param *param);
236 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
237 extern int llapi_getstripe(char *path, struct find_param *param);
238 extern int llapi_find(char *path, struct find_param *param);
240 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
241 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
242 int stripe_count, int stripe_pattern,
243 const char *pool_name);
244 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
245 int stripe_count, int stripe_pattern,
246 const char *poolname);
247 int llapi_direntry_remove(char *dname);
248 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
249 struct obd_statfs *stat_buf,
250 struct obd_uuid *uuid_buf);
251 extern int llapi_ping(char *obd_type, char *obd_name);
252 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
253 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
254 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
255 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
256 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
257 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
258 extern int llapi_is_lustre_mnttype(const char *type);
259 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
260 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
261 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
262 unsigned long long *size_units, int bytes_spec);
263 extern int llapi_search_mounts(const char *pathname, int index,
264 char *mntdir, char *fsname);
265 extern int llapi_search_fsname(const char *pathname, char *fsname);
266 extern int llapi_getname(const char *path, char *buf, size_t size);
268 extern int llapi_search_rootpath(char *pathname, const char *fsname);
269 extern int llapi_nodemap_exists(const char *name);
270 extern int llapi_mv(char *path, struct find_param *param);
273 #define HAVE_LLAPI_IS_LUSTRE_MNT
274 extern int llapi_is_lustre_mnt(struct mntent *mnt);
275 extern int llapi_quotachown(char *path, int flag);
276 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
277 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
279 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
280 extern int llapi_lsetfacl(int argc, char *argv[]);
281 extern int llapi_lgetfacl(int argc, char *argv[]);
282 extern int llapi_rsetfacl(int argc, char *argv[]);
283 extern int llapi_rgetfacl(int argc, char *argv[]);
284 extern int llapi_cp(int argc, char *argv[]);
285 extern int llapi_ls(int argc, char *argv[]);
286 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
287 int pathlen, long long *recno, int *linkno);
288 extern int llapi_path2fid(const char *path, lustre_fid *fid);
289 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
291 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
292 /* get FID of parent dir + the related name of entry in this parent dir */
293 extern int llapi_path2parent(const char *path, unsigned int linkno,
294 lustre_fid *parent_fid, char *name,
296 extern int llapi_fd2parent(int fd, unsigned int linkno,
297 lustre_fid *parent_fid, char *name,
299 extern int llapi_chomp_string(char *buf);
300 extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid,
303 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
304 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
305 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
306 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
307 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
309 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
311 extern int llapi_hsm_register_event_fifo(const char *path);
312 extern int llapi_hsm_unregister_event_fifo(const char *path);
313 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
314 const char *fmt, va_list args);
316 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
317 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
318 static inline int llapi_create_volatile(char *directory, int mode)
320 return llapi_create_volatile_idx(directory, -1, mode);
324 extern int llapi_fswap_layouts(const int fd1, const int fd2,
325 __u64 dv1, __u64 dv2, __u64 flags);
326 extern int llapi_swap_layouts(const char *path1, const char *path2,
327 __u64 dv1, __u64 dv2, __u64 flags);
329 /* Changelog interface. priv is private state, managed internally by these
332 /* Records received are in extended format now, though most of them are still
333 * written in disk in changelog_rec format (to save space and time), it's
334 * converted to extended format in the lustre api to ease changelog analysis. */
335 #define HAVE_CHANGELOG_EXTEND_REC 1
337 extern int llapi_changelog_start(void **priv, enum changelog_send_flag flags,
338 const char *mdtname, long long startrec);
339 extern int llapi_changelog_fini(void **priv);
340 extern int llapi_changelog_recv(void *priv, struct changelog_rec **rech);
341 extern int llapi_changelog_free(struct changelog_rec **rech);
342 /* Allow records up to endrec to be destroyed; requires registered id. */
343 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
346 /* HSM copytool interface.
347 * priv is private state, managed internally by these functions
349 struct hsm_copytool_private;
350 struct hsm_copyaction_private;
352 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
353 const char *mnt, int archive_count,
354 int *archives, int rfd_flags);
355 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
356 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
357 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
358 struct hsm_action_list **hal, int *msgsize);
359 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
360 const struct hsm_copytool_private *ct,
361 const struct hsm_action_item *hai,
362 int restore_mdt_index, int restore_open_flags,
364 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
365 const struct hsm_extent *he,
366 int hp_flags, int errval);
367 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
368 const struct hsm_extent *he, __u64 total,
370 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
372 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
373 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
374 unsigned long long stripe_size, int stripe_offset,
375 int stripe_count, int stripe_pattern,
376 char *pool_name, lustre_fid *newfid);
378 /* HSM user interface */
379 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
381 extern int llapi_hsm_request(const char *path,
382 const struct hsm_user_request *request);
383 extern int llapi_hsm_current_action(const char *path,
384 struct hsm_current_action *hca);
387 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
388 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
389 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
390 char *key, __u32 type, void *val);
391 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
395 extern int llapi_lease_get(int fd, int mode);
396 extern int llapi_lease_check(int fd);
397 extern int llapi_lease_put(int fd);
400 int llapi_group_lock(int fd, int gid);
401 int llapi_group_unlock(int fd, int gid);
405 /* llapi_layout user interface */
407 /** Opaque data type abstracting the layout of a Lustre file. */
411 * Flags to control how layouts are retrieved.
414 /* Replace non-specified values with expected inherited values. */
415 #define LAYOUT_GET_EXPECTED 0x1
418 * Return a pointer to a newly-allocated opaque data structure containing
419 * the layout for the file at \a path. The pointer should be freed with
420 * llapi_layout_free() when it is no longer needed. Failure is indicated
421 * by a NULL return value and an appropriate error code stored in errno.
423 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
426 * Return a pointer to a newly-allocated opaque data type containing the
427 * layout for the file referenced by open file descriptor \a fd. The
428 * pointer should be freed with llapi_layout_free() when it is no longer
429 * needed. Failure is indicated by a NULL return value and an
430 * appropriate error code stored in errno.
432 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
435 * Return a pointer to a newly-allocated opaque data type containing the
436 * layout for the file associated with Lustre file identifier string
437 * \a fidstr. The string \a path must name a path within the
438 * filesystem that contains the file being looked up, such as the
439 * filesystem root. The returned pointer should be freed with
440 * llapi_layout_free() when it is no longer needed. Failure is
441 * indicated with a NULL return value and an appropriate error code
444 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
445 const lustre_fid *fid,
449 * Allocate a new layout. Use this when creating a new file with
450 * llapi_layout_file_create().
452 struct llapi_layout *llapi_layout_alloc(void);
455 * Free memory allocated for \a layout.
457 void llapi_layout_free(struct llapi_layout *layout);
459 /** Not a valid stripe size, offset, or RAID pattern. */
460 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
463 * When specified or returned as the value for stripe count,
464 * stripe size, offset, or RAID pattern, the filesystem-wide
465 * default behavior will apply.
467 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
470 * When specified or returned as the value for stripe count, all
471 * available OSTs will be used.
473 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
476 * When specified as the value for layout pattern, file objects will be
477 * stored using RAID0. That is, data will be split evenly and without
478 * redundancy across all OSTs in the layout.
480 #define LLAPI_LAYOUT_RAID0 0
483 * Flags to modify how layouts are retrieved.
485 /******************** Stripe Count ********************/
488 * Store the stripe count of \a layout in \a count.
491 * \retval -1 Error with status code in errno.
493 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
497 * Set the stripe count of \a layout to \a count.
500 * \retval -1 Invalid argument, errno set to EINVAL.
502 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
504 /******************** Stripe Size ********************/
507 * Store the stripe size of \a layout in \a size.
510 * \retval -1 Invalid argument, errno set to EINVAL.
512 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
516 * Set the stripe size of \a layout to \a stripe_size.
519 * \retval -1 Invalid argument, errno set to EINVAL.
521 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
523 /******************** Stripe Pattern ********************/
526 * Store the stripe pattern of \a layout in \a pattern.
529 * \retval -1 Error with status code in errno.
531 int llapi_layout_pattern_get(const struct llapi_layout *layout,
535 * Set the stripe pattern of \a layout to \a pattern.
538 * \retval -1 Invalid argument, errno set to EINVAL.
540 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
542 /******************** OST Index ********************/
545 * Store the index of the OST where stripe number \a stripe_number is stored
548 * An error return value will result from a NULL layout, if \a
549 * stripe_number is out of range, or if \a layout was not initialized
550 * with llapi_layout_lookup_by{path,fd,fid}().
553 * \retval -1 Invalid argument, errno set to EINVAL.
555 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
556 uint64_t stripe_number, uint64_t *index);
559 * Set the OST index associated with stripe number \a stripe_number to
561 * NB: This is currently supported only for \a stripe_number = 0 and
562 * other usage will return ENOTSUPP in errno. A NULL \a layout or
563 * out-of-range \a stripe_number will return EINVAL in errno.
566 * \retval -1 Error with errno set to non-zero value.
568 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
571 /******************** Pool Name ********************/
574 * Store up to \a pool_name_len characters of the name of the pool of
575 * OSTs associated with \a layout into the buffer pointed to by
578 * The correct calling form is:
580 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
582 * A pool defines a set of OSTs from which file objects may be
583 * allocated for a file using \a layout.
585 * On success, the number of bytes stored is returned, excluding the
586 * terminating '\0' character (zero indicates that \a layout does not
587 * have an associated OST pool). On error, -1 is returned and errno is
588 * set appropriately. Possible sources of error include a NULL pointer
589 * argument or insufficient space in \a dest to store the pool name,
590 * in which cases errno will be set to EINVAL.
592 * \retval 0+ The number of bytes stored in \a dest.
593 * \retval -1 Invalid argument, errno set to EINVAL.
595 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
596 char *pool_name, size_t pool_name_len);
599 * Set the name of the pool of OSTs from which file objects will be
600 * allocated to \a pool_name.
602 * If the pool name uses "fsname.pool" notation to qualify the pool name
603 * with a filesystem name, the "fsname." portion will be silently
604 * discarded before storing the value. No validation that \a pool_name
605 * is an existing non-empty pool in filesystem \a fsname will be
606 * performed. Such validation can be performed by the application if
607 * desired using the llapi_search_ost() function. The maximum length of
608 * the stored value is defined by the constant LOV_MAXPOOLNAME.
611 * \retval -1 Invalid argument, errno set to EINVAL.
613 int llapi_layout_pool_name_set(struct llapi_layout *layout,
614 const char *pool_name);
616 /******************** File Creation ********************/
619 * Open an existing file at \a path, or create it with the specified
620 * \a layout and \a mode.
622 * One access mode and zero or more file creation flags and file status
623 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
624 * open file descriptor for the file. If \a layout is non-NULL and
625 * \a path is not on a Lustre filesystem this function will fail and set
628 * An already existing file may be opened with this function, but
629 * \a layout and \a mode will not be applied to it. Callers requiring a
630 * guarantee that the opened file is created with the specified
631 * \a layout and \a mode should use llapi_layout_file_create().
633 * A NULL \a layout may be specified, in which case the standard Lustre
634 * behavior for assigning layouts to newly-created files will apply.
636 * \retval 0+ An open file descriptor.
637 * \retval -1 Error with status code in errno.
639 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
640 const struct llapi_layout *layout);
643 * Create a new file at \a path with the specified \a layout and \a mode.
645 * One access mode and zero or more file creation flags and file status
646 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
647 * open file descriptor for the file. If \a layout is non-NULL and
648 * \a path is not on a Lustre filesystem this function will fail and set
653 * llapi_layout_file_create(path, open_flags, mode, layout)
655 * shall be equivalent to:
657 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
659 * It is an error if \a path specifies an existing file.
661 * A NULL \a layout may be specified, in which the standard Lustre
662 * behavior for assigning layouts to newly-created files will apply.
664 * \retval 0+ An open file descriptor.
665 * \retval -1 Error with status code in errno.
667 int llapi_layout_file_create(const char *path, int open_flags, int mode,
668 const struct llapi_layout *layout);