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, 2013, 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 typedef void (*llapi_cb_t)(char *obd_type_name, char *obd_name, char *obd_uuid,
52 /* lustreapi message severity level */
53 enum llapi_message_level {
64 typedef void (*llapi_log_callback_t)(enum llapi_message_level level, int err,
65 const char *fmt, va_list ap);
68 /* the bottom three bits reserved for llapi_message_level */
69 #define LLAPI_MSG_MASK 0x00000007
70 #define LLAPI_MSG_NO_ERRNO 0x00000010
72 static inline const char *llapi_msg_level2str(enum llapi_message_level level)
74 static const char *levels[LLAPI_MSG_MAX] = {"OFF", "FATAL", "ERROR",
78 if (level >= LLAPI_MSG_MAX)
83 extern void llapi_msg_set_level(int level);
84 int llapi_msg_get_level(void);
85 extern llapi_log_callback_t llapi_error_callback_set(llapi_log_callback_t cb);
86 extern llapi_log_callback_t llapi_info_callback_set(llapi_log_callback_t cb);
88 void llapi_error(enum llapi_message_level level, int err, const char *fmt, ...)
89 __attribute__((__format__(__printf__, 3, 4)));
90 #define llapi_err_noerrno(level, fmt, a...) \
91 llapi_error((level) | LLAPI_MSG_NO_ERRNO, 0, fmt, ## a)
92 void llapi_printf(enum llapi_message_level level, const char *fmt, ...)
93 __attribute__((__format__(__printf__, 2, 3)));
95 extern int llapi_file_create(const char *name, unsigned long long stripe_size,
96 int stripe_offset, int stripe_count,
98 extern int llapi_file_open(const char *name, int flags, int mode,
99 unsigned long long stripe_size, int stripe_offset,
100 int stripe_count, int stripe_pattern);
101 extern int llapi_file_create_pool(const char *name,
102 unsigned long long stripe_size,
103 int stripe_offset, int stripe_count,
104 int stripe_pattern, char *pool_name);
105 extern int llapi_file_open_pool(const char *name, int flags, int mode,
106 unsigned long long stripe_size,
107 int stripe_offset, int stripe_count,
108 int stripe_pattern, char *pool_name);
109 extern int llapi_poollist(const char *name);
110 extern int llapi_get_poollist(const char *name, char **poollist, int list_size,
111 char *buffer, int buffer_size);
112 extern int llapi_get_poolmembers(const char *poolname, char **members,
113 int list_size, char *buffer, int buffer_size);
114 extern int llapi_file_get_stripe(const char *path, struct lov_user_md *lum);
115 #define HAVE_LLAPI_FILE_LOOKUP
116 extern int llapi_file_lookup(int dirfd, const char *name);
118 #define VERBOSE_COUNT 0x1
119 #define VERBOSE_SIZE 0x2
120 #define VERBOSE_OFFSET 0x4
121 #define VERBOSE_POOL 0x8
122 #define VERBOSE_DETAIL 0x10
123 #define VERBOSE_OBJID 0x20
124 #define VERBOSE_GENERATION 0x40
125 #define VERBOSE_MDTINDEX 0x80
126 #define VERBOSE_LAYOUT 0x100
127 #define VERBOSE_ALL (VERBOSE_COUNT | VERBOSE_SIZE | \
128 VERBOSE_OFFSET | VERBOSE_POOL | \
129 VERBOSE_OBJID | VERBOSE_GENERATION |\
133 unsigned int fp_max_depth;
135 mode_t fp_type; /* S_IFIFO,... */
141 /* {a,m,c}sign cannot be bitfields due to using pointers to
142 * access them during argument parsing. */
146 /* these need to be signed values */
150 unsigned long long size;
151 unsigned long long size_units;
153 unsigned long zeroend:1,
163 check_pool:1, /* LOV pool name */
164 check_size:1, /* file size */
170 get_lmv:1, /* get MDT list from LMV */
171 raw:1, /* do not fill in defaults */
172 check_stripesize:1, /* LOV stripe size */
173 exclude_stripesize:1,
174 check_stripecount:1, /* LOV stripe count */
175 exclude_stripecount:1,
178 get_default_lmv:1, /* Get default LMV */
184 /* regular expression */
187 struct obd_uuid *obduuid;
193 struct obd_uuid *mdtuuid;
201 struct lov_user_mds_data *lmd;
203 char poolname[LOV_MAXPOOLNAME + 1];
206 struct lmv_user_md *fp_lmv_md;
208 unsigned long long stripesize;
209 unsigned long long stripesize_units;
210 unsigned long long stripecount;
213 /* In-process parameters. */
214 unsigned long got_uuids:1,
216 have_fileinfo:1; /* file attrs and LOV xattr */
217 unsigned int fp_depth;
220 extern int llapi_ostlist(char *path, struct find_param *param);
221 extern int llapi_uuid_match(char *real_uuid, char *search_uuid);
222 extern int llapi_getstripe(char *path, struct find_param *param);
223 extern int llapi_find(char *path, struct find_param *param);
225 extern int llapi_file_fget_mdtidx(int fd, int *mdtidx);
226 extern int llapi_dir_set_default_lmv_stripe(const char *name, int stripe_offset,
227 int stripe_count, int stripe_pattern,
228 const char *pool_name);
229 extern int llapi_dir_create_pool(const char *name, int flags, int stripe_offset,
230 int stripe_count, int stripe_pattern,
231 const char *poolname);
232 int llapi_direntry_remove(char *dname);
233 extern int llapi_obd_statfs(char *path, __u32 type, __u32 index,
234 struct obd_statfs *stat_buf,
235 struct obd_uuid *uuid_buf);
236 extern int llapi_ping(char *obd_type, char *obd_name);
237 extern int llapi_target_check(int num_types, char **obd_types, char *dir);
238 extern int llapi_file_get_lov_uuid(const char *path, struct obd_uuid *lov_uuid);
239 extern int llapi_file_get_lmv_uuid(const char *path, struct obd_uuid *lmv_uuid);
240 extern int llapi_file_fget_lov_uuid(int fd, struct obd_uuid *lov_uuid);
241 extern int llapi_lov_get_uuids(int fd, struct obd_uuid *uuidp, int *ost_count);
242 extern int llapi_lmv_get_uuids(int fd, struct obd_uuid *uuidp, int *mdt_count);
243 extern int llapi_is_lustre_mnttype(const char *type);
244 extern int llapi_search_ost(char *fsname, char *poolname, char *ostname);
245 extern int llapi_get_obd_count(char *mnt, int *count, int is_mdt);
246 extern int llapi_parse_size(const char *optarg, unsigned long long *size,
247 unsigned long long *size_units, int bytes_spec);
248 extern int llapi_search_mounts(const char *pathname, int index,
249 char *mntdir, char *fsname);
250 extern int llapi_search_fsname(const char *pathname, char *fsname);
251 extern int llapi_getname(const char *path, char *buf, size_t size);
253 extern int llapi_search_rootpath(char *pathname, const char *fsname);
254 extern int llapi_nodemap_exists(const char *name);
255 extern int llapi_mv(char *path, struct find_param *param);
258 #define HAVE_LLAPI_IS_LUSTRE_MNT
259 extern int llapi_is_lustre_mnt(struct mntent *mnt);
260 extern int llapi_quotachown(char *path, int flag);
261 extern int llapi_quotacheck(char *mnt, int check_type);
262 extern int llapi_poll_quotacheck(char *mnt, struct if_quotacheck *qchk);
263 extern int llapi_quotactl(char *mnt, struct if_quotactl *qctl);
264 extern int llapi_target_iterate(int type_num, char **obd_type, void *args,
266 extern int llapi_get_connect_flags(const char *mnt, __u64 *flags);
267 extern int llapi_lsetfacl(int argc, char *argv[]);
268 extern int llapi_lgetfacl(int argc, char *argv[]);
269 extern int llapi_rsetfacl(int argc, char *argv[]);
270 extern int llapi_rgetfacl(int argc, char *argv[]);
271 extern int llapi_cp(int argc, char *argv[]);
272 extern int llapi_ls(int argc, char *argv[]);
273 extern int llapi_fid2path(const char *device, const char *fidstr, char *path,
274 int pathlen, long long *recno, int *linkno);
275 extern int llapi_path2fid(const char *path, lustre_fid *fid);
276 extern int llapi_get_mdt_index_by_fid(int fd, const lustre_fid *fid,
278 extern int llapi_fd2fid(const int fd, lustre_fid *fid);
279 extern int llapi_chomp_string(char *buf);
280 extern int llapi_open_by_fid(const char *dir, const lustre_fid *fid,
283 extern int llapi_get_version(char *buffer, int buffer_size, char **version);
284 extern int llapi_get_data_version(int fd, __u64 *data_version, __u64 flags);
285 extern int llapi_hsm_state_get_fd(int fd, struct hsm_user_state *hus);
286 extern int llapi_hsm_state_get(const char *path, struct hsm_user_state *hus);
287 extern int llapi_hsm_state_set_fd(int fd, __u64 setmask, __u64 clearmask,
289 extern int llapi_hsm_state_set(const char *path, __u64 setmask, __u64 clearmask,
291 extern int llapi_hsm_register_event_fifo(const char *path);
292 extern int llapi_hsm_unregister_event_fifo(const char *path);
293 extern void llapi_hsm_log_error(enum llapi_message_level level, int _rc,
294 const char *fmt, va_list args);
296 extern int llapi_get_agent_uuid(char *path, char *buf, size_t bufsize);
297 extern int llapi_create_volatile_idx(char *directory, int idx, int mode);
298 static inline int llapi_create_volatile(char *directory, int mode)
300 return llapi_create_volatile_idx(directory, -1, mode);
304 extern int llapi_fswap_layouts(const int fd1, const int fd2,
305 __u64 dv1, __u64 dv2, __u64 flags);
306 extern int llapi_swap_layouts(const char *path1, const char *path2,
307 __u64 dv1, __u64 dv2, __u64 flags);
309 /* Changelog interface. priv is private state, managed internally
310 by these functions */
311 #define CHANGELOG_FLAG_FOLLOW 0x01 /* Not yet implemented */
312 #define CHANGELOG_FLAG_BLOCK 0x02 /* Blocking IO makes sense in case of
313 slow user parsing of the records, but it also prevents us from cleaning
314 up if the records are not consumed. */
316 /* Records received are in extentded format now, though most of them are still
317 * written in disk in changelog_rec format (to save space and time), it's
318 * converted to extented format in the lustre api to ease changelog analysis. */
319 #define HAVE_CHANGELOG_EXTEND_REC 1
321 extern int llapi_changelog_start(void **priv, int flags, const char *mdtname,
323 extern int llapi_changelog_fini(void **priv);
324 extern int llapi_changelog_recv(void *priv, struct changelog_ext_rec **rech);
325 extern int llapi_changelog_free(struct changelog_ext_rec **rech);
326 /* Allow records up to endrec to be destroyed; requires registered id. */
327 extern int llapi_changelog_clear(const char *mdtname, const char *idstr,
330 /* HSM copytool interface.
331 * priv is private state, managed internally by these functions
333 struct hsm_copytool_private;
334 struct hsm_copyaction_private;
336 extern int llapi_hsm_copytool_register(struct hsm_copytool_private **priv,
337 const char *mnt, int archive_count,
338 int *archives, int rfd_flags);
339 extern int llapi_hsm_copytool_unregister(struct hsm_copytool_private **priv);
340 extern int llapi_hsm_copytool_get_fd(struct hsm_copytool_private *ct);
341 extern int llapi_hsm_copytool_recv(struct hsm_copytool_private *priv,
342 struct hsm_action_list **hal, int *msgsize);
343 extern int llapi_hsm_action_begin(struct hsm_copyaction_private **phcp,
344 const struct hsm_copytool_private *ct,
345 const struct hsm_action_item *hai,
346 int restore_mdt_index, int restore_open_flags,
348 extern int llapi_hsm_action_end(struct hsm_copyaction_private **phcp,
349 const struct hsm_extent *he,
350 int hp_flags, int errval);
351 extern int llapi_hsm_action_progress(struct hsm_copyaction_private *hcp,
352 const struct hsm_extent *he, __u64 total,
354 extern int llapi_hsm_action_get_dfid(const struct hsm_copyaction_private *hcp,
356 extern int llapi_hsm_action_get_fd(const struct hsm_copyaction_private *hcp);
357 extern int llapi_hsm_import(const char *dst, int archive, const struct stat *st,
358 unsigned long long stripe_size, int stripe_offset,
359 int stripe_count, int stripe_pattern,
360 char *pool_name, lustre_fid *newfid);
362 /* HSM user interface */
363 extern struct hsm_user_request *llapi_hsm_user_request_alloc(int itemcount,
365 extern int llapi_hsm_request(const char *path,
366 const struct hsm_user_request *request);
367 extern int llapi_hsm_current_action(const char *path,
368 struct hsm_current_action *hca);
371 extern int llapi_json_init_list(struct llapi_json_item_list **item_list);
372 extern int llapi_json_destroy_list(struct llapi_json_item_list **item_list);
373 extern int llapi_json_add_item(struct llapi_json_item_list **item_list,
374 char *key, __u32 type, void *val);
375 extern int llapi_json_write_list(struct llapi_json_item_list **item_list,
379 extern int llapi_lease_get(int fd, int mode);
380 extern int llapi_lease_check(int fd);
381 extern int llapi_lease_put(int fd);
384 int llapi_group_lock(int fd, int gid);
385 int llapi_group_unlock(int fd, int gid);
389 /* llapi_layout user interface */
391 /** Opaque data type abstracting the layout of a Lustre file. */
395 * Flags to control how layouts are retrieved.
398 /* Replace non-specified values with expected inherited values. */
399 #define LAYOUT_GET_EXPECTED 0x1
402 * Return a pointer to a newly-allocated opaque data structure containing
403 * the layout for the file at \a path. The pointer should be freed with
404 * llapi_layout_free() when it is no longer needed. Failure is indicated
405 * by a NULL return value and an appropriate error code stored in errno.
407 struct llapi_layout *llapi_layout_get_by_path(const char *path, uint32_t flags);
410 * Return a pointer to a newly-allocated opaque data type containing the
411 * layout for the file referenced by open file descriptor \a fd. The
412 * pointer should be freed with llapi_layout_free() when it is no longer
413 * needed. Failure is indicated by a NULL return value and an
414 * appropriate error code stored in errno.
416 struct llapi_layout *llapi_layout_get_by_fd(int fd, uint32_t flags);
419 * Return a pointer to a newly-allocated opaque data type containing the
420 * layout for the file associated with Lustre file identifier string
421 * \a fidstr. The string \a path must name a path within the
422 * filesystem that contains the file being looked up, such as the
423 * filesystem root. The returned pointer should be freed with
424 * llapi_layout_free() when it is no longer needed. Failure is
425 * indicated with a NULL return value and an appropriate error code
428 struct llapi_layout *llapi_layout_get_by_fid(const char *path,
429 const lustre_fid *fid,
433 * Allocate a new layout. Use this when creating a new file with
434 * llapi_layout_file_create().
436 struct llapi_layout *llapi_layout_alloc(void);
439 * Free memory allocated for \a layout.
441 void llapi_layout_free(struct llapi_layout *layout);
443 /** Not a valid stripe size, offset, or RAID pattern. */
444 #define LLAPI_LAYOUT_INVALID 0x1000000000000001ULL
447 * When specified or returned as the value for stripe count,
448 * stripe size, offset, or RAID pattern, the filesystem-wide
449 * default behavior will apply.
451 #define LLAPI_LAYOUT_DEFAULT (LLAPI_LAYOUT_INVALID + 1)
454 * When specified or returned as the value for stripe count, all
455 * available OSTs will be used.
457 #define LLAPI_LAYOUT_WIDE (LLAPI_LAYOUT_INVALID + 2)
460 * When specified as the value for layout pattern, file objects will be
461 * stored using RAID0. That is, data will be split evenly and without
462 * redundancy across all OSTs in the layout.
464 #define LLAPI_LAYOUT_RAID0 0
467 * Flags to modify how layouts are retrieved.
469 /******************** Stripe Count ********************/
472 * Store the stripe count of \a layout in \a count.
475 * \retval -1 Error with status code in errno.
477 int llapi_layout_stripe_count_get(const struct llapi_layout *layout,
481 * Set the stripe count of \a layout to \a count.
484 * \retval -1 Invalid argument, errno set to EINVAL.
486 int llapi_layout_stripe_count_set(struct llapi_layout *layout, uint64_t count);
488 /******************** Stripe Size ********************/
491 * Store the stripe size of \a layout in \a size.
494 * \retval -1 Invalid argument, errno set to EINVAL.
496 int llapi_layout_stripe_size_get(const struct llapi_layout *layout,
500 * Set the stripe size of \a layout to \a stripe_size.
503 * \retval -1 Invalid argument, errno set to EINVAL.
505 int llapi_layout_stripe_size_set(struct llapi_layout *layout, uint64_t size);
507 /******************** Stripe Pattern ********************/
510 * Store the stripe pattern of \a layout in \a pattern.
513 * \retval -1 Error with status code in errno.
515 int llapi_layout_pattern_get(const struct llapi_layout *layout,
519 * Set the stripe pattern of \a layout to \a pattern.
522 * \retval -1 Invalid argument, errno set to EINVAL.
524 int llapi_layout_pattern_set(struct llapi_layout *layout, uint64_t pattern);
526 /******************** OST Index ********************/
529 * Store the index of the OST where stripe number \a stripe_number is stored
532 * An error return value will result from a NULL layout, if \a
533 * stripe_number is out of range, or if \a layout was not initialized
534 * with llapi_layout_lookup_by{path,fd,fid}().
537 * \retval -1 Invalid argument, errno set to EINVAL.
539 int llapi_layout_ost_index_get(const struct llapi_layout *layout,
540 uint64_t stripe_number, uint64_t *index);
543 * Set the OST index associated with stripe number \a stripe_number to
545 * NB: This is currently supported only for \a stripe_number = 0 and
546 * other usage will return ENOTSUPP in errno. A NULL \a layout or
547 * out-of-range \a stripe_number will return EINVAL in errno.
550 * \retval -1 Error with errno set to non-zero value.
552 int llapi_layout_ost_index_set(struct llapi_layout *layout, int stripe_number,
555 /******************** Pool Name ********************/
558 * Store up to \a pool_name_len characters of the name of the pool of
559 * OSTs associated with \a layout into the buffer pointed to by
562 * The correct calling form is:
564 * llapi_layout_pool_name_get(layout, pool_name, sizeof(pool_name));
566 * A pool defines a set of OSTs from which file objects may be
567 * allocated for a file using \a layout.
569 * On success, the number of bytes stored is returned, excluding the
570 * terminating '\0' character (zero indicates that \a layout does not
571 * have an associated OST pool). On error, -1 is returned and errno is
572 * set appropriately. Possible sources of error include a NULL pointer
573 * argument or insufficient space in \a dest to store the pool name,
574 * in which cases errno will be set to EINVAL.
576 * \retval 0+ The number of bytes stored in \a dest.
577 * \retval -1 Invalid argument, errno set to EINVAL.
579 int llapi_layout_pool_name_get(const struct llapi_layout *layout,
580 char *pool_name, size_t pool_name_len);
583 * Set the name of the pool of OSTs from which file objects will be
584 * allocated to \a pool_name.
586 * If the pool name uses "fsname.pool" notation to qualify the pool name
587 * with a filesystem name, the "fsname." portion will be silently
588 * discarded before storing the value. No validation that \a pool_name
589 * is an existing non-empty pool in filesystem \a fsname will be
590 * performed. Such validation can be performed by the application if
591 * desired using the llapi_search_ost() function. The maximum length of
592 * the stored value is defined by the constant LOV_MAXPOOLNAME.
595 * \retval -1 Invalid argument, errno set to EINVAL.
597 int llapi_layout_pool_name_set(struct llapi_layout *layout,
598 const char *pool_name);
600 /******************** File Creation ********************/
603 * Open an existing file at \a path, or create it with the specified
604 * \a layout and \a mode.
606 * One access mode and zero or more file creation flags and file status
607 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
608 * open file descriptor for the file. If \a layout is non-NULL and
609 * \a path is not on a Lustre filesystem this function will fail and set
612 * An already existing file may be opened with this function, but
613 * \a layout and \a mode will not be applied to it. Callers requiring a
614 * guarantee that the opened file is created with the specified
615 * \a layout and \a mode should use llapi_layout_file_create().
617 * A NULL \a layout may be specified, in which case the standard Lustre
618 * behavior for assigning layouts to newly-created files will apply.
620 * \retval 0+ An open file descriptor.
621 * \retval -1 Error with status code in errno.
623 int llapi_layout_file_open(const char *path, int open_flags, mode_t mode,
624 const struct llapi_layout *layout);
627 * Create a new file at \a path with the specified \a layout and \a mode.
629 * One access mode and zero or more file creation flags and file status
630 * flags May be bitwise-or'd in \a open_flags (see open(2)). Return an
631 * open file descriptor for the file. If \a layout is non-NULL and
632 * \a path is not on a Lustre filesystem this function will fail and set
637 * llapi_layout_file_create(path, open_flags, mode, layout)
639 * shall be equivalent to:
641 * llapi_layout_file_open(path, open_flags|O_CREAT|O_EXCL, mode, layout)
643 * It is an error if \a path specifies an existing file.
645 * A NULL \a layout may be specified, in which the standard Lustre
646 * behavior for assigning layouts to newly-created files will apply.
648 * \retval 0+ An open file descriptor.
649 * \retval -1 Error with status code in errno.
651 int llapi_layout_file_create(const char *path, int open_flags, int mode,
652 const struct llapi_layout *layout);