Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 1 | /* |
Luiz Capitulino | 41836a9 | 2010-05-12 16:34:42 -0300 | [diff] [blame] | 2 | * QError Module |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 3 | * |
| 4 | * Copyright (C) 2009 Red Hat Inc. |
| 5 | * |
| 6 | * Authors: |
| 7 | * Luiz Capitulino <lcapitulino@redhat.com> |
| 8 | * |
| 9 | * This work is licensed under the terms of the GNU LGPL, version 2.1 or later. |
| 10 | * See the COPYING.LIB file in the top-level directory. |
| 11 | */ |
Markus Armbruster | 0167f77 | 2010-03-22 10:29:05 +0100 | [diff] [blame] | 12 | |
| 13 | #include "monitor.h" |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 14 | #include "qjson.h" |
| 15 | #include "qerror.h" |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 16 | #include "qemu-common.h" |
| 17 | |
| 18 | static void qerror_destroy_obj(QObject *obj); |
| 19 | |
| 20 | static const QType qerror_type = { |
| 21 | .code = QTYPE_QERROR, |
| 22 | .destroy = qerror_destroy_obj, |
| 23 | }; |
| 24 | |
| 25 | /** |
| 26 | * The 'desc' parameter is a printf-like string, the format of the format |
| 27 | * string is: |
| 28 | * |
| 29 | * %(KEY) |
| 30 | * |
| 31 | * Where KEY is a QDict key, which has to be passed to qerror_from_info(). |
| 32 | * |
| 33 | * Example: |
| 34 | * |
| 35 | * "foo error on device: %(device) slot: %(slot_nr)" |
| 36 | * |
| 37 | * A single percent sign can be printed if followed by a second one, |
| 38 | * for example: |
| 39 | * |
| 40 | * "running out of foo: %(foo)%%" |
Markus Armbruster | 9d494c4 | 2010-03-25 17:22:30 +0100 | [diff] [blame] | 41 | * |
| 42 | * Please keep the entries in alphabetical order. |
Stefan Hajnoczi | 9737383 | 2012-01-04 22:23:32 +0000 | [diff] [blame] | 43 | * Use scripts/check-qerror.sh to check. |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 44 | */ |
Blue Swirl | d05ac8f | 2009-12-04 20:44:44 +0000 | [diff] [blame] | 45 | static const QErrorStringTable qerror_table[] = { |
Luiz Capitulino | 357b615 | 2009-11-18 23:05:32 -0200 | [diff] [blame] | 46 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 47 | .error_fmt = QERR_ADD_CLIENT_FAILED, |
| 48 | .desc = "Could not add client", |
| 49 | }, |
| 50 | { |
Paolo Bonzini | 11e35bf | 2012-02-02 12:37:53 +0100 | [diff] [blame] | 51 | .error_fmt = QERR_AMBIGUOUS_PATH, |
| 52 | .desc = "Path '%(path)' does not uniquely identify a %(object)" |
| 53 | }, |
| 54 | { |
Markus Armbruster | 56e9f56 | 2010-02-19 19:52:45 +0100 | [diff] [blame] | 55 | .error_fmt = QERR_BAD_BUS_FOR_DEVICE, |
| 56 | .desc = "Device '%(device)' can't go on a %(bad_bus_type) bus", |
| 57 | }, |
| 58 | { |
Marcelo Tosatti | 019b8cb | 2012-01-18 14:40:52 +0000 | [diff] [blame] | 59 | .error_fmt = QERR_BASE_NOT_FOUND, |
| 60 | .desc = "Base '%(base)' not found", |
| 61 | }, |
| 62 | { |
Anthony Liguori | 1ed520c | 2011-11-14 15:09:47 -0600 | [diff] [blame] | 63 | .error_fmt = QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED, |
| 64 | .desc = "Block format '%(format)' used by device '%(name)' does not support feature '%(feature)'", |
| 65 | }, |
| 66 | { |
Markus Armbruster | 8eae73b | 2010-02-19 19:53:36 +0100 | [diff] [blame] | 67 | .error_fmt = QERR_BUS_NO_HOTPLUG, |
| 68 | .desc = "Bus '%(bus)' does not support hotplugging", |
| 69 | }, |
| 70 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 71 | .error_fmt = QERR_BUS_NOT_FOUND, |
| 72 | .desc = "Bus '%(bus)' not found", |
Luiz Capitulino | 4b9d468 | 2009-11-26 22:58:57 -0200 | [diff] [blame] | 73 | }, |
| 74 | { |
Michael Roth | abd6cf6 | 2011-12-06 22:03:42 -0600 | [diff] [blame] | 75 | .error_fmt = QERR_COMMAND_DISABLED, |
| 76 | .desc = "The command %(name) has been disabled for this instance", |
| 77 | }, |
| 78 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 79 | .error_fmt = QERR_COMMAND_NOT_FOUND, |
| 80 | .desc = "The command %(name) has not been found", |
| 81 | }, |
| 82 | { |
Luiz Capitulino | 0df37c4 | 2009-12-07 21:36:59 +0100 | [diff] [blame] | 83 | .error_fmt = QERR_DEVICE_ENCRYPTED, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 84 | .desc = "Device '%(device)' is encrypted", |
Luiz Capitulino | 0df37c4 | 2009-12-07 21:36:59 +0100 | [diff] [blame] | 85 | }, |
| 86 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 87 | .error_fmt = QERR_DEVICE_FEATURE_BLOCKS_MIGRATION, |
| 88 | .desc = "Migration is disabled when using feature '%(feature)' in device '%(device)'", |
| 89 | }, |
| 90 | { |
Stefan Hajnoczi | 939a1cc | 2012-01-04 22:23:34 +0000 | [diff] [blame] | 91 | .error_fmt = QERR_DEVICE_HAS_NO_MEDIUM, |
| 92 | .desc = "Device '%(device)' has no medium", |
| 93 | }, |
| 94 | { |
Markus Armbruster | 4d9a1a1 | 2010-02-19 19:53:54 +0100 | [diff] [blame] | 95 | .error_fmt = QERR_DEVICE_INIT_FAILED, |
| 96 | .desc = "Device '%(device)' could not be initialized", |
| 97 | }, |
| 98 | { |
Markus Armbruster | 5124eb5 | 2010-03-25 17:22:39 +0100 | [diff] [blame] | 99 | .error_fmt = QERR_DEVICE_IN_USE, |
| 100 | .desc = "Device '%(device)' is in use", |
| 101 | }, |
| 102 | { |
Stefan Hajnoczi | 939a1cc | 2012-01-04 22:23:34 +0000 | [diff] [blame] | 103 | .error_fmt = QERR_DEVICE_IS_READ_ONLY, |
| 104 | .desc = "Device '%(device)' is read only", |
| 105 | }, |
| 106 | { |
Markus Armbruster | b086838 | 2009-12-07 21:37:03 +0100 | [diff] [blame] | 107 | .error_fmt = QERR_DEVICE_LOCKED, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 108 | .desc = "Device '%(device)' is locked", |
Markus Armbruster | b086838 | 2009-12-07 21:37:03 +0100 | [diff] [blame] | 109 | }, |
| 110 | { |
Markus Armbruster | 1ae7871 | 2010-02-19 18:05:59 +0100 | [diff] [blame] | 111 | .error_fmt = QERR_DEVICE_MULTIPLE_BUSSES, |
| 112 | .desc = "Device '%(device)' has multiple child busses", |
| 113 | }, |
| 114 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 115 | .error_fmt = QERR_DEVICE_NO_BUS, |
| 116 | .desc = "Device '%(device)' has no child bus", |
| 117 | }, |
| 118 | { |
| 119 | .error_fmt = QERR_DEVICE_NO_HOTPLUG, |
| 120 | .desc = "Device '%(device)' does not support hotplugging", |
| 121 | }, |
| 122 | { |
Luiz Capitulino | 055f612 | 2009-11-18 23:05:34 -0200 | [diff] [blame] | 123 | .error_fmt = QERR_DEVICE_NOT_ACTIVE, |
Luiz Capitulino | 8754c81 | 2010-06-23 12:37:47 -0300 | [diff] [blame] | 124 | .desc = "Device '%(device)' has not been activated", |
Luiz Capitulino | 055f612 | 2009-11-18 23:05:34 -0200 | [diff] [blame] | 125 | }, |
Luiz Capitulino | 82a6071 | 2009-11-18 23:05:35 -0200 | [diff] [blame] | 126 | { |
Markus Armbruster | 9d494c4 | 2010-03-25 17:22:30 +0100 | [diff] [blame] | 127 | .error_fmt = QERR_DEVICE_NOT_ENCRYPTED, |
| 128 | .desc = "Device '%(device)' is not encrypted", |
| 129 | }, |
| 130 | { |
Markus Armbruster | e16a181 | 2009-12-07 21:37:02 +0100 | [diff] [blame] | 131 | .error_fmt = QERR_DEVICE_NOT_FOUND, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 132 | .desc = "Device '%(device)' not found", |
Luiz Capitulino | 4b9d468 | 2009-11-26 22:58:57 -0200 | [diff] [blame] | 133 | }, |
| 134 | { |
Markus Armbruster | 5cfe026 | 2009-12-07 21:37:04 +0100 | [diff] [blame] | 135 | .error_fmt = QERR_DEVICE_NOT_REMOVABLE, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 136 | .desc = "Device '%(device)' is not removable", |
Markus Armbruster | 5cfe026 | 2009-12-07 21:37:04 +0100 | [diff] [blame] | 137 | }, |
| 138 | { |
Markus Armbruster | 7bc8401 | 2010-03-25 17:22:31 +0100 | [diff] [blame] | 139 | .error_fmt = QERR_DUPLICATE_ID, |
| 140 | .desc = "Duplicate ID '%(id)' for %(object)", |
| 141 | }, |
| 142 | { |
Markus Armbruster | c7c338c | 2009-12-07 21:37:10 +0100 | [diff] [blame] | 143 | .error_fmt = QERR_FD_NOT_FOUND, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 144 | .desc = "File descriptor named '%(name)' not found", |
Markus Armbruster | c7c338c | 2009-12-07 21:37:10 +0100 | [diff] [blame] | 145 | }, |
| 146 | { |
Markus Armbruster | 41471a2 | 2009-12-07 21:37:12 +0100 | [diff] [blame] | 147 | .error_fmt = QERR_FD_NOT_SUPPLIED, |
| 148 | .desc = "No file descriptor supplied via SCM_RIGHTS", |
| 149 | }, |
| 150 | { |
Luiz Capitulino | bf82632 | 2011-10-19 15:15:57 -0200 | [diff] [blame] | 151 | .error_fmt = QERR_FEATURE_DISABLED, |
| 152 | .desc = "The feature '%(name)' is not enabled", |
| 153 | }, |
| 154 | { |
Markus Armbruster | 17901e7 | 2009-12-07 21:37:06 +0100 | [diff] [blame] | 155 | .error_fmt = QERR_INVALID_BLOCK_FORMAT, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 156 | .desc = "Invalid block format '%(name)'", |
Markus Armbruster | 17901e7 | 2009-12-07 21:37:06 +0100 | [diff] [blame] | 157 | }, |
| 158 | { |
Markus Armbruster | 7a046f5 | 2009-12-07 21:37:13 +0100 | [diff] [blame] | 159 | .error_fmt = QERR_INVALID_PARAMETER, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 160 | .desc = "Invalid parameter '%(name)'", |
Markus Armbruster | 7a046f5 | 2009-12-07 21:37:13 +0100 | [diff] [blame] | 161 | }, |
| 162 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 163 | .error_fmt = QERR_INVALID_PARAMETER_COMBINATION, |
| 164 | .desc = "Invalid parameter combination", |
| 165 | }, |
| 166 | { |
Markus Armbruster | e16a181 | 2009-12-07 21:37:02 +0100 | [diff] [blame] | 167 | .error_fmt = QERR_INVALID_PARAMETER_TYPE, |
Anthony Liguori | 5eeee3f | 2011-12-22 14:40:54 -0600 | [diff] [blame] | 168 | .desc = "Invalid parameter type for '%(name)', expected: %(expected)", |
Markus Armbruster | e16a181 | 2009-12-07 21:37:02 +0100 | [diff] [blame] | 169 | }, |
| 170 | { |
Markus Armbruster | 985a3e5 | 2010-03-25 17:22:33 +0100 | [diff] [blame] | 171 | .error_fmt = QERR_INVALID_PARAMETER_VALUE, |
| 172 | .desc = "Parameter '%(name)' expects %(expected)", |
| 173 | }, |
| 174 | { |
Markus Armbruster | e16a181 | 2009-12-07 21:37:02 +0100 | [diff] [blame] | 175 | .error_fmt = QERR_INVALID_PASSWORD, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 176 | .desc = "Password incorrect", |
Markus Armbruster | e16a181 | 2009-12-07 21:37:02 +0100 | [diff] [blame] | 177 | }, |
| 178 | { |
Luiz Capitulino | 5889887 | 2011-11-22 16:29:52 -0200 | [diff] [blame] | 179 | .error_fmt = QERR_IO_ERROR, |
| 180 | .desc = "An IO error has occurred", |
| 181 | }, |
| 182 | { |
Michael Roth | ac32c78 | 2011-07-19 15:41:52 -0500 | [diff] [blame] | 183 | .error_fmt = QERR_JSON_PARSE_ERROR, |
| 184 | .desc = "JSON parse error, %(message)", |
| 185 | |
| 186 | }, |
| 187 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 188 | .error_fmt = QERR_JSON_PARSING, |
| 189 | .desc = "Invalid JSON syntax", |
| 190 | }, |
| 191 | { |
Luiz Capitulino | 82a6071 | 2009-11-18 23:05:35 -0200 | [diff] [blame] | 192 | .error_fmt = QERR_KVM_MISSING_CAP, |
| 193 | .desc = "Using KVM without %(capability), %(feature) unavailable", |
| 194 | }, |
Luiz Capitulino | 4b9d468 | 2009-11-26 22:58:57 -0200 | [diff] [blame] | 195 | { |
Luiz Capitulino | a4acc06 | 2011-12-02 14:58:12 -0200 | [diff] [blame^] | 196 | .error_fmt = QERR_MIGRATION_ACTIVE, |
| 197 | .desc = "There's a migration process in progress", |
| 198 | }, |
| 199 | { |
| 200 | .error_fmt = QERR_MIGRATION_NOT_SUPPORTED, |
| 201 | .desc = "State blocked by non-migratable device '%(device)'", |
| 202 | }, |
| 203 | { |
Amit Shah | 8e84865 | 2010-07-27 15:49:19 +0530 | [diff] [blame] | 204 | .error_fmt = QERR_MIGRATION_EXPECTED, |
| 205 | .desc = "An incoming migration is expected before this command can be executed", |
| 206 | }, |
| 207 | { |
Luiz Capitulino | 4b9d468 | 2009-11-26 22:58:57 -0200 | [diff] [blame] | 208 | .error_fmt = QERR_MISSING_PARAMETER, |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 209 | .desc = "Parameter '%(name)' is missing", |
| 210 | }, |
| 211 | { |
Markus Armbruster | fab5767 | 2010-02-19 19:54:06 +0100 | [diff] [blame] | 212 | .error_fmt = QERR_NO_BUS_FOR_DEVICE, |
| 213 | .desc = "No '%(bus)' bus found for device '%(device)'", |
| 214 | }, |
| 215 | { |
Stefan Hajnoczi | 12bd451 | 2012-01-18 14:40:46 +0000 | [diff] [blame] | 216 | .error_fmt = QERR_NOT_SUPPORTED, |
| 217 | .desc = "Not supported", |
| 218 | }, |
| 219 | { |
Markus Armbruster | fc5469d | 2010-02-19 17:42:46 +0100 | [diff] [blame] | 220 | .error_fmt = QERR_OPEN_FILE_FAILED, |
| 221 | .desc = "Could not open '%(filename)'", |
Luiz Capitulino | 4b9d468 | 2009-11-26 22:58:57 -0200 | [diff] [blame] | 222 | }, |
| 223 | { |
Anthony Liguori | 44677de | 2011-12-12 14:29:26 -0600 | [diff] [blame] | 224 | .error_fmt = QERR_PERMISSION_DENIED, |
| 225 | .desc = "Insufficient permission to perform this operation", |
| 226 | }, |
| 227 | { |
Markus Armbruster | c58a35f | 2010-02-19 13:11:41 +0100 | [diff] [blame] | 228 | .error_fmt = QERR_PROPERTY_NOT_FOUND, |
| 229 | .desc = "Property '%(device).%(property)' not found", |
| 230 | }, |
| 231 | { |
Markus Armbruster | 06b4a70 | 2010-02-19 13:17:58 +0100 | [diff] [blame] | 232 | .error_fmt = QERR_PROPERTY_VALUE_BAD, |
| 233 | .desc = "Property '%(device).%(property)' doesn't take value '%(value)'", |
| 234 | }, |
| 235 | { |
Markus Armbruster | 9c5eff9 | 2010-03-16 17:40:48 +0100 | [diff] [blame] | 236 | .error_fmt = QERR_PROPERTY_VALUE_IN_USE, |
| 237 | .desc = "Property '%(device).%(property)' can't take value '%(value)', it's in use", |
| 238 | }, |
| 239 | { |
Markus Armbruster | 84745d6 | 2010-03-16 17:44:38 +0100 | [diff] [blame] | 240 | .error_fmt = QERR_PROPERTY_VALUE_NOT_FOUND, |
| 241 | .desc = "Property '%(device).%(property)' can't find value '%(value)'", |
| 242 | }, |
| 243 | { |
Paolo Bonzini | 6aced82 | 2011-12-18 17:05:08 +0100 | [diff] [blame] | 244 | .error_fmt = QERR_PROPERTY_VALUE_OUT_OF_RANGE, |
| 245 | .desc = "Property '%(device).%(property)' doesn't take " |
| 246 | "value %(value) (minimum: %(min), maximum: %(max)'", |
| 247 | }, |
| 248 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 249 | .error_fmt = QERR_QGA_COMMAND_FAILED, |
| 250 | .desc = "Guest agent command failed, error was '%(message)'", |
| 251 | }, |
| 252 | { |
| 253 | .error_fmt = QERR_QGA_LOGGING_FAILED, |
| 254 | .desc = "Guest agent failed to log non-optional log statement", |
| 255 | }, |
| 256 | { |
Luiz Capitulino | 4b9d468 | 2009-11-26 22:58:57 -0200 | [diff] [blame] | 257 | .error_fmt = QERR_QMP_BAD_INPUT_OBJECT, |
Luiz Capitulino | abaf2f5 | 2010-04-07 14:53:49 -0300 | [diff] [blame] | 258 | .desc = "Expected '%(expected)' in QMP input", |
Luiz Capitulino | 4b9d468 | 2009-11-26 22:58:57 -0200 | [diff] [blame] | 259 | }, |
| 260 | { |
Luiz Capitulino | 7dfb612 | 2010-04-07 14:46:33 -0300 | [diff] [blame] | 261 | .error_fmt = QERR_QMP_BAD_INPUT_OBJECT_MEMBER, |
| 262 | .desc = "QMP input object member '%(member)' expects '%(expected)'", |
| 263 | }, |
| 264 | { |
Luiz Capitulino | 60d76d7 | 2010-06-01 16:15:23 -0300 | [diff] [blame] | 265 | .error_fmt = QERR_QMP_EXTRA_MEMBER, |
| 266 | .desc = "QMP input object member '%(member)' is unexpected", |
| 267 | }, |
| 268 | { |
Luiz Capitulino | 6667b23 | 2011-07-29 15:57:54 -0300 | [diff] [blame] | 269 | .error_fmt = QERR_RESET_REQUIRED, |
| 270 | .desc = "Resetting the Virtual Machine is required", |
| 271 | }, |
| 272 | { |
Markus Armbruster | 7a84cb2 | 2009-12-07 21:37:07 +0100 | [diff] [blame] | 273 | .error_fmt = QERR_SET_PASSWD_FAILED, |
| 274 | .desc = "Could not set password", |
| 275 | }, |
| 276 | { |
Markus Armbruster | a488be2 | 2009-12-07 21:37:14 +0100 | [diff] [blame] | 277 | .error_fmt = QERR_TOO_MANY_FILES, |
| 278 | .desc = "Too many open files", |
| 279 | }, |
| 280 | { |
Markus Armbruster | e16a181 | 2009-12-07 21:37:02 +0100 | [diff] [blame] | 281 | .error_fmt = QERR_UNDEFINED_ERROR, |
Dong Xu Wang | 07f3507 | 2011-11-22 18:06:26 +0800 | [diff] [blame] | 282 | .desc = "An undefined error has occurred", |
Luiz Capitulino | 4b9d468 | 2009-11-26 22:58:57 -0200 | [diff] [blame] | 283 | }, |
Markus Armbruster | a6906e3 | 2009-12-07 21:37:08 +0100 | [diff] [blame] | 284 | { |
Kevin Wolf | f54e364 | 2011-02-09 11:09:38 +0100 | [diff] [blame] | 285 | .error_fmt = QERR_UNKNOWN_BLOCK_FORMAT_FEATURE, |
| 286 | .desc = "'%(device)' uses a %(format) feature which is not " |
| 287 | "supported by this qemu version: %(feature)", |
| 288 | }, |
| 289 | { |
Stefan Hajnoczi | c130359 | 2012-01-04 17:38:22 +0000 | [diff] [blame] | 290 | .error_fmt = QERR_UNSUPPORTED, |
| 291 | .desc = "this feature or command is not currently supported", |
| 292 | }, |
| 293 | { |
Aneesh Kumar K.V | e9a0152 | 2011-12-04 22:35:28 +0530 | [diff] [blame] | 294 | .error_fmt = QERR_VIRTFS_FEATURE_BLOCKS_MIGRATION, |
| 295 | .desc = "Migration is disabled when VirtFS export path '%(path)' " |
| 296 | "is mounted in the guest using mount_tag '%(tag)'", |
| 297 | }, |
| 298 | { |
Markus Armbruster | a6906e3 | 2009-12-07 21:37:08 +0100 | [diff] [blame] | 299 | .error_fmt = QERR_VNC_SERVER_FAILED, |
| 300 | .desc = "Could not start VNC server on %(target)", |
| 301 | }, |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 302 | {} |
| 303 | }; |
| 304 | |
| 305 | /** |
| 306 | * qerror_new(): Create a new QError |
| 307 | * |
| 308 | * Return strong reference. |
| 309 | */ |
| 310 | QError *qerror_new(void) |
| 311 | { |
| 312 | QError *qerr; |
| 313 | |
Anthony Liguori | 7267c09 | 2011-08-20 22:09:37 -0500 | [diff] [blame] | 314 | qerr = g_malloc0(sizeof(*qerr)); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 315 | QOBJECT_INIT(qerr, &qerror_type); |
| 316 | |
| 317 | return qerr; |
| 318 | } |
| 319 | |
Stefan Weil | 8b7968f | 2010-09-23 21:28:05 +0200 | [diff] [blame] | 320 | static void GCC_FMT_ATTR(2, 3) qerror_abort(const QError *qerr, |
| 321 | const char *fmt, ...) |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 322 | { |
| 323 | va_list ap; |
| 324 | |
| 325 | fprintf(stderr, "qerror: bad call in function '%s':\n", qerr->func); |
| 326 | fprintf(stderr, "qerror: -> "); |
| 327 | |
| 328 | va_start(ap, fmt); |
| 329 | vfprintf(stderr, fmt, ap); |
| 330 | va_end(ap); |
| 331 | |
| 332 | fprintf(stderr, "\nqerror: call at %s:%d\n", qerr->file, qerr->linenr); |
| 333 | abort(); |
| 334 | } |
| 335 | |
Stefan Weil | 8b7968f | 2010-09-23 21:28:05 +0200 | [diff] [blame] | 336 | static void GCC_FMT_ATTR(2, 0) qerror_set_data(QError *qerr, |
| 337 | const char *fmt, va_list *va) |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 338 | { |
| 339 | QObject *obj; |
| 340 | |
| 341 | obj = qobject_from_jsonv(fmt, va); |
| 342 | if (!obj) { |
| 343 | qerror_abort(qerr, "invalid format '%s'", fmt); |
| 344 | } |
| 345 | if (qobject_type(obj) != QTYPE_QDICT) { |
| 346 | qerror_abort(qerr, "error format is not a QDict '%s'", fmt); |
| 347 | } |
| 348 | |
| 349 | qerr->error = qobject_to_qdict(obj); |
| 350 | |
| 351 | obj = qdict_get(qerr->error, "class"); |
| 352 | if (!obj) { |
| 353 | qerror_abort(qerr, "missing 'class' key in '%s'", fmt); |
| 354 | } |
| 355 | if (qobject_type(obj) != QTYPE_QSTRING) { |
| 356 | qerror_abort(qerr, "'class' key value should be a QString"); |
| 357 | } |
| 358 | |
| 359 | obj = qdict_get(qerr->error, "data"); |
| 360 | if (!obj) { |
| 361 | qerror_abort(qerr, "missing 'data' key in '%s'", fmt); |
| 362 | } |
| 363 | if (qobject_type(obj) != QTYPE_QDICT) { |
| 364 | qerror_abort(qerr, "'data' key value should be a QDICT"); |
| 365 | } |
| 366 | } |
| 367 | |
| 368 | static void qerror_set_desc(QError *qerr, const char *fmt) |
| 369 | { |
| 370 | int i; |
| 371 | |
| 372 | // FIXME: inefficient loop |
| 373 | |
| 374 | for (i = 0; qerror_table[i].error_fmt; i++) { |
| 375 | if (strcmp(qerror_table[i].error_fmt, fmt) == 0) { |
| 376 | qerr->entry = &qerror_table[i]; |
| 377 | return; |
| 378 | } |
| 379 | } |
| 380 | |
| 381 | qerror_abort(qerr, "error format '%s' not found", fmt); |
| 382 | } |
| 383 | |
| 384 | /** |
| 385 | * qerror_from_info(): Create a new QError from error information |
| 386 | * |
| 387 | * The information consists of: |
| 388 | * |
| 389 | * - file the file name of where the error occurred |
| 390 | * - linenr the line number of where the error occurred |
| 391 | * - func the function name of where the error occurred |
| 392 | * - fmt JSON printf-like dictionary, there must exist keys 'class' and |
| 393 | * 'data' |
| 394 | * - va va_list of all arguments specified by fmt |
| 395 | * |
| 396 | * Return strong reference. |
| 397 | */ |
| 398 | QError *qerror_from_info(const char *file, int linenr, const char *func, |
| 399 | const char *fmt, va_list *va) |
| 400 | { |
| 401 | QError *qerr; |
| 402 | |
| 403 | qerr = qerror_new(); |
Markus Armbruster | 827b081 | 2010-02-18 19:46:49 +0100 | [diff] [blame] | 404 | loc_save(&qerr->loc); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 405 | qerr->linenr = linenr; |
| 406 | qerr->file = file; |
| 407 | qerr->func = func; |
| 408 | |
| 409 | if (!fmt) { |
| 410 | qerror_abort(qerr, "QDict not specified"); |
| 411 | } |
| 412 | |
| 413 | qerror_set_data(qerr, fmt, va); |
| 414 | qerror_set_desc(qerr, fmt); |
| 415 | |
| 416 | return qerr; |
| 417 | } |
| 418 | |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 419 | static void parse_error(const QErrorStringTable *entry, int c) |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 420 | { |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 421 | fprintf(stderr, "expected '%c' in '%s'", c, entry->desc); |
| 422 | abort(); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 423 | } |
| 424 | |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 425 | static const char *append_field(QDict *error, QString *outstr, |
| 426 | const QErrorStringTable *entry, |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 427 | const char *start) |
| 428 | { |
| 429 | QObject *obj; |
| 430 | QDict *qdict; |
| 431 | QString *key_qs; |
| 432 | const char *end, *key; |
| 433 | |
| 434 | if (*start != '%') |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 435 | parse_error(entry, '%'); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 436 | start++; |
| 437 | if (*start != '(') |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 438 | parse_error(entry, '('); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 439 | start++; |
| 440 | |
| 441 | end = strchr(start, ')'); |
| 442 | if (!end) |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 443 | parse_error(entry, ')'); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 444 | |
| 445 | key_qs = qstring_from_substr(start, 0, end - start - 1); |
| 446 | key = qstring_get_str(key_qs); |
| 447 | |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 448 | qdict = qobject_to_qdict(qdict_get(error, "data")); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 449 | obj = qdict_get(qdict, key); |
| 450 | if (!obj) { |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 451 | abort(); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 452 | } |
| 453 | |
| 454 | switch (qobject_type(obj)) { |
| 455 | case QTYPE_QSTRING: |
| 456 | qstring_append(outstr, qdict_get_str(qdict, key)); |
| 457 | break; |
| 458 | case QTYPE_QINT: |
| 459 | qstring_append_int(outstr, qdict_get_int(qdict, key)); |
| 460 | break; |
| 461 | default: |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 462 | abort(); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 463 | } |
| 464 | |
| 465 | QDECREF(key_qs); |
| 466 | return ++end; |
| 467 | } |
| 468 | |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 469 | static QString *qerror_format_desc(QDict *error, |
| 470 | const QErrorStringTable *entry) |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 471 | { |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 472 | QString *qstring; |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 473 | const char *p; |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 474 | |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 475 | assert(entry != NULL); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 476 | |
| 477 | qstring = qstring_new(); |
| 478 | |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 479 | for (p = entry->desc; *p != '\0';) { |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 480 | if (*p != '%') { |
| 481 | qstring_append_chr(qstring, *p++); |
| 482 | } else if (*(p + 1) == '%') { |
| 483 | qstring_append_chr(qstring, '%'); |
| 484 | p += 2; |
| 485 | } else { |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 486 | p = append_field(error, qstring, entry, p); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 487 | } |
| 488 | } |
| 489 | |
Markus Armbruster | 77e595e | 2009-12-07 21:37:16 +0100 | [diff] [blame] | 490 | return qstring; |
| 491 | } |
| 492 | |
Luiz Capitulino | 87c2f59 | 2011-06-01 12:14:48 -0500 | [diff] [blame] | 493 | QString *qerror_format(const char *fmt, QDict *error) |
| 494 | { |
| 495 | const QErrorStringTable *entry = NULL; |
| 496 | int i; |
| 497 | |
| 498 | for (i = 0; qerror_table[i].error_fmt; i++) { |
| 499 | if (strcmp(qerror_table[i].error_fmt, fmt) == 0) { |
| 500 | entry = &qerror_table[i]; |
| 501 | break; |
| 502 | } |
| 503 | } |
| 504 | |
| 505 | return qerror_format_desc(error, entry); |
| 506 | } |
| 507 | |
Markus Armbruster | 77e595e | 2009-12-07 21:37:16 +0100 | [diff] [blame] | 508 | /** |
Luiz Capitulino | a12eeaa | 2011-06-01 12:14:47 -0500 | [diff] [blame] | 509 | * qerror_human(): Format QError data into human-readable string. |
| 510 | */ |
| 511 | QString *qerror_human(const QError *qerror) |
| 512 | { |
| 513 | return qerror_format_desc(qerror->error, qerror->entry); |
| 514 | } |
| 515 | |
| 516 | /** |
Markus Armbruster | 77e595e | 2009-12-07 21:37:16 +0100 | [diff] [blame] | 517 | * qerror_print(): Print QError data |
| 518 | * |
| 519 | * This function will print the member 'desc' of the specified QError object, |
Markus Armbruster | 1ecda02 | 2010-02-18 17:25:24 +0100 | [diff] [blame] | 520 | * it uses error_report() for this, so that the output is routed to the right |
Markus Armbruster | 77e595e | 2009-12-07 21:37:16 +0100 | [diff] [blame] | 521 | * place (ie. stderr or Monitor's device). |
| 522 | */ |
Markus Armbruster | 827b081 | 2010-02-18 19:46:49 +0100 | [diff] [blame] | 523 | void qerror_print(QError *qerror) |
Markus Armbruster | 77e595e | 2009-12-07 21:37:16 +0100 | [diff] [blame] | 524 | { |
| 525 | QString *qstring = qerror_human(qerror); |
Markus Armbruster | 827b081 | 2010-02-18 19:46:49 +0100 | [diff] [blame] | 526 | loc_push_restore(&qerror->loc); |
Markus Armbruster | 1ecda02 | 2010-02-18 17:25:24 +0100 | [diff] [blame] | 527 | error_report("%s", qstring_get_str(qstring)); |
Markus Armbruster | 827b081 | 2010-02-18 19:46:49 +0100 | [diff] [blame] | 528 | loc_pop(&qerror->loc); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 529 | QDECREF(qstring); |
| 530 | } |
| 531 | |
Markus Armbruster | 0167f77 | 2010-03-22 10:29:05 +0100 | [diff] [blame] | 532 | void qerror_report_internal(const char *file, int linenr, const char *func, |
| 533 | const char *fmt, ...) |
| 534 | { |
| 535 | va_list va; |
| 536 | QError *qerror; |
| 537 | |
| 538 | va_start(va, fmt); |
| 539 | qerror = qerror_from_info(file, linenr, func, fmt, &va); |
| 540 | va_end(va); |
| 541 | |
| 542 | if (monitor_cur_is_qmp()) { |
| 543 | monitor_set_error(cur_mon, qerror); |
| 544 | } else { |
| 545 | qerror_print(qerror); |
| 546 | QDECREF(qerror); |
| 547 | } |
| 548 | } |
| 549 | |
Anthony Liguori | 2a82d93 | 2011-09-02 12:34:45 -0500 | [diff] [blame] | 550 | /* Evil... */ |
| 551 | struct Error |
| 552 | { |
| 553 | QDict *obj; |
| 554 | const char *fmt; |
| 555 | char *msg; |
| 556 | }; |
| 557 | |
| 558 | void qerror_report_err(Error *err) |
| 559 | { |
| 560 | QError *qerr; |
| 561 | int i; |
| 562 | |
| 563 | qerr = qerror_new(); |
| 564 | loc_save(&qerr->loc); |
| 565 | QINCREF(err->obj); |
| 566 | qerr->error = err->obj; |
| 567 | |
| 568 | for (i = 0; qerror_table[i].error_fmt; i++) { |
| 569 | if (strcmp(qerror_table[i].error_fmt, err->fmt) == 0) { |
| 570 | qerr->entry = &qerror_table[i]; |
| 571 | break; |
| 572 | } |
| 573 | } |
| 574 | |
| 575 | if (monitor_cur_is_qmp()) { |
| 576 | monitor_set_error(cur_mon, qerr); |
| 577 | } else { |
| 578 | qerror_print(qerr); |
| 579 | QDECREF(qerr); |
| 580 | } |
| 581 | } |
| 582 | |
Paolo Bonzini | 59f971d | 2012-02-14 10:19:53 +0100 | [diff] [blame] | 583 | void assert_no_error(Error *err) |
| 584 | { |
| 585 | if (err) { |
| 586 | qerror_report_err(err); |
| 587 | abort(); |
| 588 | } |
| 589 | } |
| 590 | |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 591 | /** |
| 592 | * qobject_to_qerror(): Convert a QObject into a QError |
| 593 | */ |
| 594 | QError *qobject_to_qerror(const QObject *obj) |
| 595 | { |
| 596 | if (qobject_type(obj) != QTYPE_QERROR) { |
| 597 | return NULL; |
| 598 | } |
| 599 | |
| 600 | return container_of(obj, QError, base); |
| 601 | } |
| 602 | |
| 603 | /** |
| 604 | * qerror_destroy_obj(): Free all memory allocated by a QError |
| 605 | */ |
| 606 | static void qerror_destroy_obj(QObject *obj) |
| 607 | { |
| 608 | QError *qerr; |
| 609 | |
| 610 | assert(obj != NULL); |
| 611 | qerr = qobject_to_qerror(obj); |
| 612 | |
| 613 | QDECREF(qerr->error); |
Anthony Liguori | 7267c09 | 2011-08-20 22:09:37 -0500 | [diff] [blame] | 614 | g_free(qerr); |
Luiz Capitulino | 9f9daf9 | 2009-11-18 23:05:30 -0200 | [diff] [blame] | 615 | } |