xref: /freebsd/lib/libbe/be_error.c (revision 8f5c6c31ae7b2fe787fbe11909e33fd151c6d524)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2017 Kyle J. Kneitinger <kyle@kneit.in>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
31 
32 #include "be.h"
33 #include "be_impl.h"
34 
35 /*
36  * Usage
37  */
38 int
39 libbe_errno(libbe_handle_t *lbh)
40 {
41 
42 	return (lbh->error);
43 }
44 
45 
46 const char *
47 libbe_error_description(libbe_handle_t *lbh)
48 {
49 
50 	switch (lbh->error) {
51 	case BE_ERR_INVALIDNAME:
52 		return ("invalid boot environment name");
53 
54 	case BE_ERR_EXISTS:
55 		return ("boot environment name already taken");
56 
57 	case BE_ERR_NOENT:
58 		return ("specified boot environment does not exist");
59 
60 	case BE_ERR_PERMS:
61 		return ("insufficient permissions");
62 
63 	case BE_ERR_DESTROYACT:
64 		return ("cannot destroy active boot environment");
65 
66 	case BE_ERR_DESTROYMNT:
67 		return ("cannot destroy mounted boot env unless forced");
68 
69 	case BE_ERR_BADPATH:
70 		return ("path not suitable for operation");
71 
72 	case BE_ERR_PATHBUSY:
73 		return ("specified path is busy");
74 
75 	case BE_ERR_PATHLEN:
76 		return ("provided path name exceeds maximum length limit");
77 
78 	case BE_ERR_BADMOUNT:
79 		return ("mountpoint is not \"/\"");
80 
81 	case BE_ERR_NOORIGIN:
82 		return ("could not open snapshot's origin");
83 
84 	case BE_ERR_MOUNTED:
85 		return ("boot environment is already mounted");
86 
87 	case BE_ERR_NOMOUNT:
88 		return ("boot environment is not mounted");
89 
90 	case BE_ERR_ZFSOPEN:
91 		return ("calling zfs_open() failed");
92 
93 	case BE_ERR_ZFSCLONE:
94 		return ("error when calling zfs_clone() to create boot env");
95 
96 	case BE_ERR_IO:
97 		return ("input/output error");
98 
99 	case BE_ERR_NOPOOL:
100 		return ("operation not supported on this pool");
101 
102 	case BE_ERR_NOMEM:
103 		return ("insufficient memory");
104 
105 	case BE_ERR_UNKNOWN:
106 		return ("unknown error");
107 
108 	case BE_ERR_INVORIGIN:
109 		return ("invalid origin");
110 
111 	case BE_ERR_HASCLONES:
112 		return ("snapshot has clones");
113 
114 	default:
115 		assert(lbh->error == BE_ERR_SUCCESS);
116 		return ("no error");
117 	}
118 }
119 
120 
121 void
122 libbe_print_on_error(libbe_handle_t *lbh, bool val)
123 {
124 
125 	lbh->print_on_err = val;
126 	libzfs_print_on_error(lbh->lzh, val);
127 }
128 
129 
130 int
131 set_error(libbe_handle_t *lbh, be_error_t err)
132 {
133 
134 	lbh->error = err;
135 	if (lbh->print_on_err && (err != BE_ERR_SUCCESS))
136 		fprintf(stderr, "%s\n", libbe_error_description(lbh));
137 
138 	return (err);
139 }
140