xref: /freebsd-12.1/lib/libbe/be_error.c (revision 70a11a8e)
1 /*
2  * be_error.c
3  *
4  * Copyright (c) 2017 Kyle J. Kneitinger <[email protected]>
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 "be.h"
30 #include "be_impl.h"
31 
32 /*
33  * Usage
34  */
35 int
36 libbe_errno(libbe_handle_t *lbh)
37 {
38 	return (lbh->error);
39 }
40 
41 
42 const char *
43 libbe_error_description(libbe_handle_t *lbh)
44 {
45 	switch (lbh->error) {
46 	case BE_ERR_INVALIDNAME:
47 		return ("invalid boot environment name");
48 
49 	case BE_ERR_EXISTS:
50 		return ("boot environment name already taken");
51 
52 	case BE_ERR_NOENT:
53 		return ("specified boot environment does not exist");
54 
55 	case BE_ERR_PERMS:
56 		return ("insufficient permissions");
57 
58 	case BE_ERR_DESTROYACT:
59 		return ("cannot destroy active boot environment");
60 
61 	case BE_ERR_DESTROYMNT:
62 		return ("cannot destroy mounted boot env unless forced");
63 
64 	case BE_ERR_PATHLEN:
65 		return ("provided path name exceeds maximum length limit");
66 
67 	case BE_ERR_INVORIGIN:
68 		return ("snapshot origin's mountpoint is not \"/\"");
69 
70 	case BE_ERR_NOORIGIN:
71 		return ("could not open snapshot's origin");
72 
73 	case BE_ERR_MOUNTED:
74 		return ("boot environment is already mounted");
75 
76 	case BE_ERR_NOMOUNT:
77 		return ("boot environment is not mounted");
78 
79 	case BE_ERR_ZFSOPEN:
80 		return ("calling zfs_open() failed");
81 
82 	case BE_ERR_ZFSCLONE:
83 		return ("error when calling zfs_clone() to create boot env");
84 
85 	case BE_ERR_UNKNOWN:
86 		return ("unknown error");
87 
88 	default:
89 		assert(lbh->error == BE_ERR_SUCCESS);
90 		return ("no error");
91 	}
92 }
93 
94 
95 void
96 libbe_print_on_error(libbe_handle_t *lbh, bool val)
97 {
98 	lbh->print_on_err = val;
99 	libzfs_print_on_error(lbh->lzh, val);
100 }
101 
102 
103 int
104 set_error(libbe_handle_t *lbh, be_error_t err)
105 {
106 	// TODO: should the old error be overwritten or no?
107 
108 	lbh->error = err;
109 
110 	if (lbh->print_on_err && (err != BE_ERR_SUCCESS)) {
111 		fprintf(stderr, "%s\n", libbe_error_description(lbh));
112 	}
113 
114 	return (err);
115 }
116