1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in>
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * SUCH DAMAGE.
26 */
27
28#ifndef _LIBBE_H
29#define _LIBBE_H
30
31#include <libnvpair.h>
32#include <stdbool.h>
33
34#define BE_MAXPATHLEN    512
35
36typedef struct libbe_handle libbe_handle_t;
37
38typedef enum be_error {
39	BE_ERR_SUCCESS = 0,     /* No error */
40	BE_ERR_INVALIDNAME,     /* invalid boot env name */
41	BE_ERR_EXISTS,          /* boot env name already taken */
42	BE_ERR_NOENT,           /* boot env doesn't exist */
43	BE_ERR_PERMS,           /* insufficient permissions */
44	BE_ERR_DESTROYACT,      /* cannot destroy active boot env */
45	BE_ERR_DESTROYMNT,      /* destroying a mounted be requires force */
46	BE_ERR_BADPATH,		/* path not suitable for operation */
47	BE_ERR_PATHBUSY,	/* requested path is busy */
48	BE_ERR_PATHLEN,         /* provided name exceeds maximum length limit */
49	BE_ERR_BADMOUNT,        /* mountpoint is not '/' */
50	BE_ERR_NOORIGIN,        /* could not open snapshot's origin */
51	BE_ERR_MOUNTED,         /* boot environment is already mounted */
52	BE_ERR_NOMOUNT,         /* boot environment is not mounted */
53	BE_ERR_ZFSOPEN,         /* calling zfs_open() failed */
54	BE_ERR_ZFSCLONE,        /* error when calling zfs_clone to create be */
55	BE_ERR_IO,		/* error when doing some I/O operation */
56	BE_ERR_NOPOOL,		/* operation not supported on this pool */
57	BE_ERR_NOMEM,		/* insufficient memory */
58	BE_ERR_UNKNOWN,         /* unknown error */
59	BE_ERR_INVORIGIN,       /* invalid origin */
60	BE_ERR_HASCLONES,	/* snapshot has clones */
61} be_error_t;
62
63
64/* Library handling functions: be.c */
65libbe_handle_t *libbe_init(const char *root);
66void libbe_close(libbe_handle_t *);
67
68/* Bootenv information functions: be_info.c */
69const char *be_active_name(libbe_handle_t *);
70const char *be_active_path(libbe_handle_t *);
71const char *be_nextboot_name(libbe_handle_t *);
72const char *be_nextboot_path(libbe_handle_t *);
73const char *be_root_path(libbe_handle_t *);
74
75int be_get_bootenv_props(libbe_handle_t *, nvlist_t *);
76int be_get_dataset_props(libbe_handle_t *, const char *, nvlist_t *);
77int be_get_dataset_snapshots(libbe_handle_t *, const char *, nvlist_t *);
78int be_prop_list_alloc(nvlist_t **be_list);
79void be_prop_list_free(nvlist_t *be_list);
80
81int be_activate(libbe_handle_t *, const char *, bool);
82int be_deactivate(libbe_handle_t *, const char *, bool);
83
84bool be_is_auto_snapshot_name(libbe_handle_t *, const char *);
85
86/* Bootenv creation functions */
87int be_create(libbe_handle_t *, const char *);
88int be_create_depth(libbe_handle_t *, const char *, const char *, int);
89int be_create_from_existing(libbe_handle_t *, const char *, const char *);
90int be_create_from_existing_snap(libbe_handle_t *, const char *, const char *);
91int be_snapshot(libbe_handle_t *, const char *, const char *, bool, char *);
92
93/* Bootenv manipulation functions */
94int be_rename(libbe_handle_t *, const char *, const char *);
95
96/* Bootenv removal functions */
97
98typedef enum {
99	BE_DESTROY_FORCE	= 1 << 0,
100	BE_DESTROY_ORIGIN	= 1 << 1,
101	BE_DESTROY_AUTOORIGIN	= 1 << 2,
102} be_destroy_opt_t;
103
104int be_destroy(libbe_handle_t *, const char *, int);
105
106/* Bootenv mounting functions: be_access.c */
107
108typedef enum {
109	BE_MNT_FORCE		= 1 << 0,
110	BE_MNT_DEEP		= 1 << 1,
111} be_mount_opt_t;
112
113int be_mount(libbe_handle_t *, const char *, const char *, int, char *);
114int be_unmount(libbe_handle_t *, const char *, int);
115int be_mounted_at(libbe_handle_t *, const char *path, nvlist_t *);
116
117/* Error related functions: be_error.c */
118int libbe_errno(libbe_handle_t *);
119const char *libbe_error_description(libbe_handle_t *);
120void libbe_print_on_error(libbe_handle_t *, bool);
121
122/* Utility Functions */
123int be_root_concat(libbe_handle_t *, const char *, char *);
124int be_validate_name(libbe_handle_t * __unused, const char *);
125int be_validate_snap(libbe_handle_t *, const char *);
126int be_exists(libbe_handle_t *, const char *);
127
128int be_export(libbe_handle_t *, const char *, int fd);
129int be_import(libbe_handle_t *, const char *, int fd);
130
131#if SOON
132int be_add_child(libbe_handle_t *, const char *, bool);
133#endif
134void be_nicenum(uint64_t num, char *buf, size_t buflen);
135
136#endif  /* _LIBBE_H */
137