Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 1 | /* |
| 2 | * QEMU Error Objects |
| 3 | * |
| 4 | * Copyright IBM, Corp. 2011 |
Markus Armbruster | a29a37b | 2015-09-11 16:51:42 +0200 | [diff] [blame] | 5 | * Copyright (C) 2011-2015 Red Hat, Inc. |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 6 | * |
| 7 | * Authors: |
| 8 | * Anthony Liguori <aliguori@us.ibm.com> |
Markus Armbruster | a29a37b | 2015-09-11 16:51:42 +0200 | [diff] [blame] | 9 | * Markus Armbruster <armbru@redhat.com>, |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 10 | * |
| 11 | * This work is licensed under the terms of the GNU LGPL, version 2. See |
| 12 | * the COPYING.LIB file in the top-level directory. |
| 13 | */ |
Stefan Weil | e4ea5e2 | 2011-06-13 23:01:53 +0200 | [diff] [blame] | 14 | |
Peter Maydell | aafd758 | 2016-01-29 17:49:55 +0000 | [diff] [blame] | 15 | #include "qemu/osdep.h" |
Markus Armbruster | da34e65 | 2016-03-14 09:01:28 +0100 | [diff] [blame] | 16 | #include "qapi/error.h" |
Cole Robinson | 073a341 | 2014-03-21 19:42:28 -0400 | [diff] [blame] | 17 | #include "qemu/error-report.h" |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 18 | |
| 19 | struct Error |
| 20 | { |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 21 | char *msg; |
Luiz Capitulino | 13f59ae | 2012-07-27 14:09:29 -0300 | [diff] [blame] | 22 | ErrorClass err_class; |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 23 | const char *src, *func; |
| 24 | int line; |
Eric Blake | 50b7b00 | 2015-09-10 10:19:16 -0600 | [diff] [blame] | 25 | GString *hint; |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 26 | }; |
| 27 | |
Peter Crosthwaite | 5d24ee7 | 2014-01-01 18:46:59 -0800 | [diff] [blame] | 28 | Error *error_abort; |
Markus Armbruster | a29a37b | 2015-09-11 16:51:42 +0200 | [diff] [blame] | 29 | Error *error_fatal; |
Marc-André Lureau | 3ffef1a | 2023-02-21 16:47:50 +0400 | [diff] [blame] | 30 | Error *error_warn; |
Peter Crosthwaite | 5d24ee7 | 2014-01-01 18:46:59 -0800 | [diff] [blame] | 31 | |
Marc-André Lureau | 3ffef1a | 2023-02-21 16:47:50 +0400 | [diff] [blame] | 32 | static void error_handle(Error **errp, Error *err) |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 33 | { |
Markus Armbruster | a29a37b | 2015-09-11 16:51:42 +0200 | [diff] [blame] | 34 | if (errp == &error_abort) { |
| 35 | fprintf(stderr, "Unexpected error in %s() at %s:%d:\n", |
| 36 | err->func, err->src, err->line); |
Vladimir Sementsov-Ogievskiy | b922c05 | 2019-04-15 17:25:19 +0300 | [diff] [blame] | 37 | error_report("%s", error_get_pretty(err)); |
| 38 | if (err->hint) { |
| 39 | error_printf("%s", err->hint->str); |
| 40 | } |
Markus Armbruster | a29a37b | 2015-09-11 16:51:42 +0200 | [diff] [blame] | 41 | abort(); |
| 42 | } |
| 43 | if (errp == &error_fatal) { |
| 44 | error_report_err(err); |
| 45 | exit(1); |
| 46 | } |
Marc-André Lureau | 3ffef1a | 2023-02-21 16:47:50 +0400 | [diff] [blame] | 47 | if (errp == &error_warn) { |
| 48 | warn_report_err(err); |
Stefan Berger | cc40b8b | 2023-04-06 11:43:47 -0400 | [diff] [blame] | 49 | } else if (errp && !*errp) { |
| 50 | *errp = err; |
| 51 | } else { |
| 52 | error_free(err); |
Marc-André Lureau | 3ffef1a | 2023-02-21 16:47:50 +0400 | [diff] [blame] | 53 | } |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 54 | } |
| 55 | |
Daniel P. Berrangé | beede7e | 2022-12-19 08:02:03 -0500 | [diff] [blame] | 56 | G_GNUC_PRINTF(6, 0) |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 57 | static void error_setv(Error **errp, |
| 58 | const char *src, int line, const char *func, |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 59 | ErrorClass err_class, const char *fmt, va_list ap, |
| 60 | const char *suffix) |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 61 | { |
| 62 | Error *err; |
Max Reitz | b276d24 | 2013-11-07 20:10:29 +0100 | [diff] [blame] | 63 | int saved_errno = errno; |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 64 | |
| 65 | if (errp == NULL) { |
| 66 | return; |
| 67 | } |
Paolo Bonzini | d195325 | 2012-07-17 16:17:04 +0200 | [diff] [blame] | 68 | assert(*errp == NULL); |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 69 | |
Anthony Liguori | 7267c09 | 2011-08-20 22:09:37 -0500 | [diff] [blame] | 70 | err = g_malloc0(sizeof(*err)); |
Luiz Capitulino | df1e608 | 2012-07-27 17:51:03 -0300 | [diff] [blame] | 71 | err->msg = g_strdup_vprintf(fmt, ap); |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 72 | if (suffix) { |
| 73 | char *msg = err->msg; |
| 74 | err->msg = g_strdup_printf("%s: %s", msg, suffix); |
| 75 | g_free(msg); |
| 76 | } |
Luiz Capitulino | 13f59ae | 2012-07-27 14:09:29 -0300 | [diff] [blame] | 77 | err->err_class = err_class; |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 78 | err->src = src; |
| 79 | err->line = line; |
| 80 | err->func = func; |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 81 | |
Marc-André Lureau | 3ffef1a | 2023-02-21 16:47:50 +0400 | [diff] [blame] | 82 | error_handle(errp, err); |
Max Reitz | b276d24 | 2013-11-07 20:10:29 +0100 | [diff] [blame] | 83 | |
| 84 | errno = saved_errno; |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 85 | } |
| 86 | |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 87 | void error_set_internal(Error **errp, |
| 88 | const char *src, int line, const char *func, |
| 89 | ErrorClass err_class, const char *fmt, ...) |
Markus Armbruster | 5523750 | 2015-06-19 13:59:47 +0200 | [diff] [blame] | 90 | { |
| 91 | va_list ap; |
| 92 | |
| 93 | va_start(ap, fmt); |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 94 | error_setv(errp, src, line, func, err_class, fmt, ap, NULL); |
Markus Armbruster | 5523750 | 2015-06-19 13:59:47 +0200 | [diff] [blame] | 95 | va_end(ap); |
| 96 | } |
| 97 | |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 98 | void error_setg_internal(Error **errp, |
| 99 | const char *src, int line, const char *func, |
| 100 | const char *fmt, ...) |
Markus Armbruster | a9499dd | 2015-06-19 15:36:16 +0200 | [diff] [blame] | 101 | { |
| 102 | va_list ap; |
| 103 | |
| 104 | va_start(ap, fmt); |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 105 | error_setv(errp, src, line, func, ERROR_CLASS_GENERIC_ERROR, fmt, ap, NULL); |
Markus Armbruster | a9499dd | 2015-06-19 15:36:16 +0200 | [diff] [blame] | 106 | va_end(ap); |
| 107 | } |
| 108 | |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 109 | void error_setg_errno_internal(Error **errp, |
| 110 | const char *src, int line, const char *func, |
| 111 | int os_errno, const char *fmt, ...) |
Paolo Bonzini | 680d16d | 2012-10-02 09:00:45 +0200 | [diff] [blame] | 112 | { |
Paolo Bonzini | 680d16d | 2012-10-02 09:00:45 +0200 | [diff] [blame] | 113 | va_list ap; |
Max Reitz | b276d24 | 2013-11-07 20:10:29 +0100 | [diff] [blame] | 114 | int saved_errno = errno; |
Paolo Bonzini | 680d16d | 2012-10-02 09:00:45 +0200 | [diff] [blame] | 115 | |
Paolo Bonzini | 680d16d | 2012-10-02 09:00:45 +0200 | [diff] [blame] | 116 | va_start(ap, fmt); |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 117 | error_setv(errp, src, line, func, ERROR_CLASS_GENERIC_ERROR, fmt, ap, |
| 118 | os_errno != 0 ? strerror(os_errno) : NULL); |
Paolo Bonzini | 680d16d | 2012-10-02 09:00:45 +0200 | [diff] [blame] | 119 | va_end(ap); |
Paolo Bonzini | 680d16d | 2012-10-02 09:00:45 +0200 | [diff] [blame] | 120 | |
Max Reitz | b276d24 | 2013-11-07 20:10:29 +0100 | [diff] [blame] | 121 | errno = saved_errno; |
Paolo Bonzini | 680d16d | 2012-10-02 09:00:45 +0200 | [diff] [blame] | 122 | } |
| 123 | |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 124 | void error_setg_file_open_internal(Error **errp, |
| 125 | const char *src, int line, const char *func, |
| 126 | int os_errno, const char *filename) |
Luiz Capitulino | 54028d7 | 2013-06-07 14:24:49 -0400 | [diff] [blame] | 127 | { |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 128 | error_setg_errno_internal(errp, src, line, func, os_errno, |
| 129 | "Could not open '%s'", filename); |
Luiz Capitulino | 54028d7 | 2013-06-07 14:24:49 -0400 | [diff] [blame] | 130 | } |
| 131 | |
Vladimir Sementsov-Ogievskiy | 49fbc72 | 2019-12-05 20:46:17 +0300 | [diff] [blame] | 132 | void error_vprepend(Error *const *errp, const char *fmt, va_list ap) |
Markus Armbruster | 8277d2a | 2015-12-18 16:35:12 +0100 | [diff] [blame] | 133 | { |
| 134 | GString *newmsg; |
| 135 | |
| 136 | if (!errp) { |
| 137 | return; |
| 138 | } |
| 139 | |
| 140 | newmsg = g_string_new(NULL); |
| 141 | g_string_vprintf(newmsg, fmt, ap); |
| 142 | g_string_append(newmsg, (*errp)->msg); |
Max Reitz | 536eeea | 2017-04-13 18:09:52 +0200 | [diff] [blame] | 143 | g_free((*errp)->msg); |
Markus Armbruster | 8277d2a | 2015-12-18 16:35:12 +0100 | [diff] [blame] | 144 | (*errp)->msg = g_string_free(newmsg, 0); |
| 145 | } |
| 146 | |
Vladimir Sementsov-Ogievskiy | 49fbc72 | 2019-12-05 20:46:17 +0300 | [diff] [blame] | 147 | void error_prepend(Error *const *errp, const char *fmt, ...) |
Markus Armbruster | 8277d2a | 2015-12-18 16:35:12 +0100 | [diff] [blame] | 148 | { |
| 149 | va_list ap; |
| 150 | |
| 151 | va_start(ap, fmt); |
| 152 | error_vprepend(errp, fmt, ap); |
| 153 | va_end(ap); |
| 154 | } |
| 155 | |
Vladimir Sementsov-Ogievskiy | 49fbc72 | 2019-12-05 20:46:17 +0300 | [diff] [blame] | 156 | void error_append_hint(Error *const *errp, const char *fmt, ...) |
Eric Blake | 50b7b00 | 2015-09-10 10:19:16 -0600 | [diff] [blame] | 157 | { |
| 158 | va_list ap; |
| 159 | int saved_errno = errno; |
| 160 | Error *err; |
| 161 | |
| 162 | if (!errp) { |
| 163 | return; |
| 164 | } |
| 165 | err = *errp; |
Markus Armbruster | f4d0064 | 2015-12-18 16:35:08 +0100 | [diff] [blame] | 166 | assert(err && errp != &error_abort && errp != &error_fatal); |
Eric Blake | 50b7b00 | 2015-09-10 10:19:16 -0600 | [diff] [blame] | 167 | |
| 168 | if (!err->hint) { |
| 169 | err->hint = g_string_new(NULL); |
| 170 | } |
| 171 | va_start(ap, fmt); |
| 172 | g_string_append_vprintf(err->hint, fmt, ap); |
| 173 | va_end(ap); |
| 174 | |
| 175 | errno = saved_errno; |
| 176 | } |
| 177 | |
Tomoki Sekiyama | 20840d4 | 2013-08-07 11:40:11 -0400 | [diff] [blame] | 178 | #ifdef _WIN32 |
| 179 | |
Markus Armbruster | 1e9b65b | 2015-06-19 19:21:59 +0200 | [diff] [blame] | 180 | void error_setg_win32_internal(Error **errp, |
| 181 | const char *src, int line, const char *func, |
| 182 | int win32_err, const char *fmt, ...) |
Tomoki Sekiyama | 20840d4 | 2013-08-07 11:40:11 -0400 | [diff] [blame] | 183 | { |
Tomoki Sekiyama | 20840d4 | 2013-08-07 11:40:11 -0400 | [diff] [blame] | 184 | va_list ap; |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 185 | char *suffix = NULL; |
Tomoki Sekiyama | 20840d4 | 2013-08-07 11:40:11 -0400 | [diff] [blame] | 186 | |
| 187 | if (errp == NULL) { |
| 188 | return; |
| 189 | } |
Tomoki Sekiyama | 20840d4 | 2013-08-07 11:40:11 -0400 | [diff] [blame] | 190 | |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 191 | if (win32_err != 0) { |
| 192 | suffix = g_win32_error_message(win32_err); |
| 193 | } |
| 194 | |
Tomoki Sekiyama | 20840d4 | 2013-08-07 11:40:11 -0400 | [diff] [blame] | 195 | va_start(ap, fmt); |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 196 | error_setv(errp, src, line, func, ERROR_CLASS_GENERIC_ERROR, |
| 197 | fmt, ap, suffix); |
Markus Armbruster | 5523750 | 2015-06-19 13:59:47 +0200 | [diff] [blame] | 198 | va_end(ap); |
| 199 | |
Daniel P. Berrange | 20e2dec | 2016-03-09 17:28:24 +0000 | [diff] [blame] | 200 | g_free(suffix); |
Tomoki Sekiyama | 20840d4 | 2013-08-07 11:40:11 -0400 | [diff] [blame] | 201 | } |
| 202 | |
| 203 | #endif |
| 204 | |
Luiz Capitulino | 79020cf | 2011-12-05 16:04:05 -0200 | [diff] [blame] | 205 | Error *error_copy(const Error *err) |
| 206 | { |
| 207 | Error *err_new; |
| 208 | |
| 209 | err_new = g_malloc0(sizeof(*err)); |
| 210 | err_new->msg = g_strdup(err->msg); |
Luiz Capitulino | 13f59ae | 2012-07-27 14:09:29 -0300 | [diff] [blame] | 211 | err_new->err_class = err->err_class; |
Eric Blake | 88e2ce2 | 2015-09-10 10:34:50 -0600 | [diff] [blame] | 212 | err_new->src = err->src; |
| 213 | err_new->line = err->line; |
| 214 | err_new->func = err->func; |
Eric Blake | 50b7b00 | 2015-09-10 10:19:16 -0600 | [diff] [blame] | 215 | if (err->hint) { |
| 216 | err_new->hint = g_string_new(err->hint->str); |
| 217 | } |
Luiz Capitulino | 79020cf | 2011-12-05 16:04:05 -0200 | [diff] [blame] | 218 | |
| 219 | return err_new; |
| 220 | } |
| 221 | |
Luiz Capitulino | ea25fbc | 2012-08-01 16:29:38 -0300 | [diff] [blame] | 222 | ErrorClass error_get_class(const Error *err) |
| 223 | { |
| 224 | return err->err_class; |
| 225 | } |
| 226 | |
Daniel P. Berrange | d59ce6f | 2016-04-27 11:05:00 +0100 | [diff] [blame] | 227 | const char *error_get_pretty(const Error *err) |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 228 | { |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 229 | return err->msg; |
| 230 | } |
| 231 | |
Markus Armbruster | 2ee2f1e | 2015-02-06 15:27:19 +0100 | [diff] [blame] | 232 | void error_report_err(Error *err) |
| 233 | { |
| 234 | error_report("%s", error_get_pretty(err)); |
Eric Blake | 50b7b00 | 2015-09-10 10:19:16 -0600 | [diff] [blame] | 235 | if (err->hint) { |
Markus Armbruster | 4c8b7c8 | 2019-04-16 17:38:50 +0200 | [diff] [blame] | 236 | error_printf("%s", err->hint->str); |
Eric Blake | 50b7b00 | 2015-09-10 10:19:16 -0600 | [diff] [blame] | 237 | } |
Markus Armbruster | 2ee2f1e | 2015-02-06 15:27:19 +0100 | [diff] [blame] | 238 | error_free(err); |
| 239 | } |
| 240 | |
Alistair Francis | e43ead1 | 2017-07-12 06:57:52 -0700 | [diff] [blame] | 241 | void warn_report_err(Error *err) |
| 242 | { |
| 243 | warn_report("%s", error_get_pretty(err)); |
| 244 | if (err->hint) { |
Markus Armbruster | 4c8b7c8 | 2019-04-16 17:38:50 +0200 | [diff] [blame] | 245 | error_printf("%s", err->hint->str); |
Alistair Francis | e43ead1 | 2017-07-12 06:57:52 -0700 | [diff] [blame] | 246 | } |
| 247 | error_free(err); |
| 248 | } |
| 249 | |
Markus Armbruster | 8277d2a | 2015-12-18 16:35:12 +0100 | [diff] [blame] | 250 | void error_reportf_err(Error *err, const char *fmt, ...) |
| 251 | { |
| 252 | va_list ap; |
| 253 | |
| 254 | va_start(ap, fmt); |
| 255 | error_vprepend(&err, fmt, ap); |
| 256 | va_end(ap); |
| 257 | error_report_err(err); |
| 258 | } |
| 259 | |
Alistair Francis | e43ead1 | 2017-07-12 06:57:52 -0700 | [diff] [blame] | 260 | |
| 261 | void warn_reportf_err(Error *err, const char *fmt, ...) |
| 262 | { |
| 263 | va_list ap; |
| 264 | |
| 265 | va_start(ap, fmt); |
| 266 | error_vprepend(&err, fmt, ap); |
| 267 | va_end(ap); |
| 268 | warn_report_err(err); |
| 269 | } |
| 270 | |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 271 | void error_free(Error *err) |
| 272 | { |
| 273 | if (err) { |
Anthony Liguori | 7267c09 | 2011-08-20 22:09:37 -0500 | [diff] [blame] | 274 | g_free(err->msg); |
Eric Blake | 50b7b00 | 2015-09-10 10:19:16 -0600 | [diff] [blame] | 275 | if (err->hint) { |
| 276 | g_string_free(err->hint, true); |
| 277 | } |
Anthony Liguori | 7267c09 | 2011-08-20 22:09:37 -0500 | [diff] [blame] | 278 | g_free(err); |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 279 | } |
| 280 | } |
| 281 | |
Eric Blake | a12a5a1 | 2015-11-05 23:35:31 -0700 | [diff] [blame] | 282 | void error_free_or_abort(Error **errp) |
| 283 | { |
| 284 | assert(errp && *errp); |
| 285 | error_free(*errp); |
| 286 | *errp = NULL; |
| 287 | } |
| 288 | |
Markus Armbruster | 64dfefe | 2014-05-02 13:26:32 +0200 | [diff] [blame] | 289 | void error_propagate(Error **dst_errp, Error *local_err) |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 290 | { |
Markus Armbruster | a29a37b | 2015-09-11 16:51:42 +0200 | [diff] [blame] | 291 | if (!local_err) { |
| 292 | return; |
| 293 | } |
Marc-André Lureau | 3ffef1a | 2023-02-21 16:47:50 +0400 | [diff] [blame] | 294 | error_handle(dst_errp, local_err); |
Luiz Capitulino | d5ec4f2 | 2011-06-01 12:14:49 -0500 | [diff] [blame] | 295 | } |
Markus Armbruster | 4b57664 | 2018-10-17 10:26:25 +0200 | [diff] [blame] | 296 | |
| 297 | void error_propagate_prepend(Error **dst_errp, Error *err, |
| 298 | const char *fmt, ...) |
| 299 | { |
| 300 | va_list ap; |
| 301 | |
| 302 | if (dst_errp && !*dst_errp) { |
| 303 | va_start(ap, fmt); |
| 304 | error_vprepend(&err, fmt, ap); |
| 305 | va_end(ap); |
| 306 | } /* else error is being ignored, don't bother with prepending */ |
| 307 | error_propagate(dst_errp, err); |
| 308 | } |