2018-07-24 13:17:40 +00:00
|
|
|
/*
|
|
|
|
* be.h
|
|
|
|
*
|
|
|
|
* Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in>
|
|
|
|
* All rights reserved.
|
|
|
|
*
|
|
|
|
* Redistribution and use in source and binary forms, with or without
|
|
|
|
* modification, are permitted provided that the following conditions
|
|
|
|
* are met:
|
|
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer.
|
|
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
|
|
* documentation and/or other materials provided with the distribution.
|
|
|
|
*
|
|
|
|
* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
|
|
|
|
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
|
|
|
|
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
|
|
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
|
|
|
|
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
|
|
|
|
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
|
|
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
|
|
|
|
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
|
|
* SUCH DAMAGE.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _LIBBE_H
|
|
|
|
#define _LIBBE_H
|
|
|
|
|
2018-07-25 14:30:47 +00:00
|
|
|
#include <libnvpair.h>
|
2018-07-24 13:17:40 +00:00
|
|
|
#include <stdbool.h>
|
|
|
|
|
|
|
|
#define BE_MAXPATHLEN 512
|
|
|
|
|
|
|
|
typedef struct libbe_handle libbe_handle_t;
|
|
|
|
|
|
|
|
typedef enum be_error {
|
|
|
|
BE_ERR_SUCCESS = 0, /* No error */
|
|
|
|
BE_ERR_INVALIDNAME, /* invalid boot env name */
|
|
|
|
BE_ERR_EXISTS, /* boot env name already taken */
|
|
|
|
BE_ERR_NOENT, /* boot env doesn't exist */
|
|
|
|
BE_ERR_PERMS, /* insufficient permissions */
|
|
|
|
BE_ERR_DESTROYACT, /* cannot destroy active boot env */
|
|
|
|
BE_ERR_DESTROYMNT, /* destroying a mounted be requires force */
|
|
|
|
BE_ERR_PATHLEN, /* provided name exceeds maximum length limit */
|
|
|
|
BE_ERR_INVORIGIN, /* snapshot origin's mountpoint is not '/' */
|
|
|
|
BE_ERR_NOORIGIN, /* could not open snapshot's origin */
|
|
|
|
BE_ERR_MOUNTED, /* boot environment is already mounted */
|
|
|
|
BE_ERR_NOMOUNT, /* boot environment is not mounted */
|
|
|
|
BE_ERR_ZFSOPEN, /* calling zfs_open() failed */
|
|
|
|
BE_ERR_ZFSCLONE, /* error when calling zfs_clone to create be */
|
|
|
|
BE_ERR_UNKNOWN, /* unknown error */
|
|
|
|
} be_error_t;
|
|
|
|
|
|
|
|
|
|
|
|
/* Library handling functions: be.c */
|
|
|
|
libbe_handle_t *libbe_init(void);
|
|
|
|
void libbe_close(libbe_handle_t *);
|
|
|
|
|
|
|
|
/* Bootenv information functions: be_info.c */
|
|
|
|
const char *be_active_name(libbe_handle_t *);
|
|
|
|
const char *be_active_path(libbe_handle_t *);
|
2018-07-25 14:45:00 +00:00
|
|
|
const char *be_nextboot_name(libbe_handle_t *);
|
|
|
|
const char *be_nextboot_path(libbe_handle_t *);
|
2018-07-24 13:17:40 +00:00
|
|
|
const char *be_root_path(libbe_handle_t *);
|
|
|
|
|
2018-07-25 14:30:47 +00:00
|
|
|
int be_get_bootenv_props(libbe_handle_t *, nvlist_t *);
|
2018-08-05 04:40:13 +00:00
|
|
|
int be_get_dataset_props(libbe_handle_t *, const char *, nvlist_t *);
|
2018-08-05 19:38:56 +00:00
|
|
|
int be_get_dataset_snapshots(libbe_handle_t *, const char *, nvlist_t *);
|
2018-07-25 16:00:48 +00:00
|
|
|
int be_prop_list_alloc(nvlist_t **be_list);
|
2018-07-25 15:14:35 +00:00
|
|
|
void be_prop_list_free(nvlist_t *be_list);
|
2018-07-24 13:17:40 +00:00
|
|
|
|
|
|
|
int be_activate(libbe_handle_t *, char *, bool);
|
|
|
|
|
|
|
|
/* Bootenv creation functions */
|
|
|
|
int be_create(libbe_handle_t *, char *);
|
2018-07-25 15:14:35 +00:00
|
|
|
int be_create_from_existing(libbe_handle_t *, const char *, const char *);
|
|
|
|
int be_create_from_existing_snap(libbe_handle_t *, const char *, const char *);
|
|
|
|
int be_snapshot(libbe_handle_t *, const char *, const char *, bool, char *);
|
2018-07-24 13:17:40 +00:00
|
|
|
|
|
|
|
/* Bootenv manipulation functions */
|
|
|
|
int be_rename(libbe_handle_t *, char *, char *);
|
|
|
|
|
|
|
|
/* Bootenv removal functions */
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
BE_DESTROY_FORCE = 1 << 0,
|
|
|
|
} be_destroy_opt_t;
|
|
|
|
|
|
|
|
int be_destroy(libbe_handle_t *, char *, int);
|
|
|
|
|
|
|
|
/* Bootenv mounting functions: be_access.c */
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
BE_MNT_FORCE = 1 << 0,
|
|
|
|
BE_MNT_DEEP = 1 << 1,
|
|
|
|
} be_mount_opt_t;
|
|
|
|
|
|
|
|
int be_mount(libbe_handle_t *, char *, char *, int, char *);
|
|
|
|
int be_unmount(libbe_handle_t *, char *, int);
|
2018-07-26 03:13:07 +00:00
|
|
|
int be_mounted_at(libbe_handle_t *, const char *path, nvlist_t *);
|
2018-07-24 13:17:40 +00:00
|
|
|
|
|
|
|
/* Error related functions: be_error.c */
|
|
|
|
int libbe_errno(libbe_handle_t *);
|
|
|
|
const char *libbe_error_description(libbe_handle_t *);
|
|
|
|
void libbe_print_on_error(libbe_handle_t *, bool);
|
|
|
|
|
|
|
|
/* Utility Functions */
|
2018-07-25 15:14:35 +00:00
|
|
|
int be_root_concat(libbe_handle_t *, const char *, char *);
|
|
|
|
int be_validate_name(libbe_handle_t * __unused, const char *);
|
|
|
|
int be_validate_snap(libbe_handle_t *, const char *);
|
2018-07-24 13:17:40 +00:00
|
|
|
bool be_exists(libbe_handle_t *, char *);
|
|
|
|
|
|
|
|
int be_export(libbe_handle_t *, char *, int fd);
|
|
|
|
int be_import(libbe_handle_t *, char *, int fd);
|
|
|
|
|
|
|
|
int be_add_child(libbe_handle_t *, char *, bool);
|
2018-08-05 04:40:13 +00:00
|
|
|
void be_nicenum(uint64_t num, char *buf, size_t buflen);
|
2018-07-24 13:17:40 +00:00
|
|
|
|
|
|
|
#endif /* _LIBBE_H */
|