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#include <sys/cdefs.h>
29#include "be.h"
30#include "be_impl.h"
31
32/*
33 * Usage
34 */
35int
36libbe_errno(libbe_handle_t *lbh)
37{
38
39	return (lbh->error);
40}
41
42
43const char *
44libbe_error_description(libbe_handle_t *lbh)
45{
46
47	switch (lbh->error) {
48	case BE_ERR_INVALIDNAME:
49		return ("invalid boot environment name");
50
51	case BE_ERR_EXISTS:
52		return ("boot environment name already taken");
53
54	case BE_ERR_NOENT:
55		return ("specified boot environment does not exist");
56
57	case BE_ERR_PERMS:
58		return ("insufficient permissions");
59
60	case BE_ERR_DESTROYACT:
61		return ("cannot destroy active boot environment");
62
63	case BE_ERR_DESTROYMNT:
64		return ("cannot destroy mounted boot env unless forced");
65
66	case BE_ERR_BADPATH:
67		return ("path not suitable for operation");
68
69	case BE_ERR_PATHBUSY:
70		return ("specified path is busy");
71
72	case BE_ERR_PATHLEN:
73		return ("provided path name exceeds maximum length limit");
74
75	case BE_ERR_BADMOUNT:
76		return ("mountpoint is not \"/\"");
77
78	case BE_ERR_NOORIGIN:
79		return ("could not open snapshot's origin");
80
81	case BE_ERR_MOUNTED:
82		return ("boot environment is already mounted");
83
84	case BE_ERR_NOMOUNT:
85		return ("boot environment is not mounted");
86
87	case BE_ERR_ZFSOPEN:
88		return ("calling zfs_open() failed");
89
90	case BE_ERR_ZFSCLONE:
91		return ("error when calling zfs_clone() to create boot env");
92
93	case BE_ERR_IO:
94		return ("input/output error");
95
96	case BE_ERR_NOPOOL:
97		return ("operation not supported on this pool");
98
99	case BE_ERR_NOMEM:
100		return ("insufficient memory");
101
102	case BE_ERR_UNKNOWN:
103		return ("unknown error");
104
105	case BE_ERR_INVORIGIN:
106		return ("invalid origin");
107
108	case BE_ERR_HASCLONES:
109		return ("snapshot has clones");
110
111	default:
112		assert(lbh->error == BE_ERR_SUCCESS);
113		return ("no error");
114	}
115}
116
117
118void
119libbe_print_on_error(libbe_handle_t *lbh, bool val)
120{
121
122	lbh->print_on_err = val;
123	libzfs_print_on_error(lbh->lzh, val);
124}
125
126
127int
128set_error(libbe_handle_t *lbh, be_error_t err)
129{
130
131	lbh->error = err;
132	if (lbh->print_on_err && (err != BE_ERR_SUCCESS))
133		fprintf(stderr, "%s\n", libbe_error_description(lbh));
134
135	return (err);
136}
137