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 39 return (lbh->error); 40 } 41 42 43 const char * 44 libbe_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_PATHLEN: 67 return ("provided path name exceeds maximum length limit"); 68 69 case BE_ERR_INVORIGIN: 70 return ("snapshot origin's mountpoint is not \"/\""); 71 72 case BE_ERR_NOORIGIN: 73 return ("could not open snapshot's origin"); 74 75 case BE_ERR_MOUNTED: 76 return ("boot environment is already mounted"); 77 78 case BE_ERR_NOMOUNT: 79 return ("boot environment is not mounted"); 80 81 case BE_ERR_ZFSOPEN: 82 return ("calling zfs_open() failed"); 83 84 case BE_ERR_ZFSCLONE: 85 return ("error when calling zfs_clone() to create boot env"); 86 87 case BE_ERR_UNKNOWN: 88 return ("unknown error"); 89 90 default: 91 assert(lbh->error == BE_ERR_SUCCESS); 92 return ("no error"); 93 } 94 } 95 96 97 void 98 libbe_print_on_error(libbe_handle_t *lbh, bool val) 99 { 100 101 lbh->print_on_err = val; 102 libzfs_print_on_error(lbh->lzh, val); 103 } 104 105 106 int 107 set_error(libbe_handle_t *lbh, be_error_t err) 108 { 109 110 /* XXX TODO: should the old error be overwritten or no? */ 111 lbh->error = err; 112 if (lbh->print_on_err && (err != BE_ERR_SUCCESS)) 113 fprintf(stderr, "%s\n", libbe_error_description(lbh)); 114 115 return (err); 116 } 117