qerror.h

   1 /*
   2  * QError Module
   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  */
  12 #ifndef QERROR_H
  13 #define QERROR_H
  14
  15 #include "qdict.h"
  16 #include "qstring.h"
  17 #include "qemu-error.h"
  18 #include "error.h"
  19 #include <stdarg.h>
  20
  21 typedef struct QErrorStringTable {
  22     const char *desc;
  23     const char *error_fmt;
  24 } QErrorStringTable;
  25
  26 typedef struct QError {
  27     QObject_HEAD;
  28     QDict *error;
  29     Location loc;
  30     int linenr;
  31     const char *file;
  32     const char *func;
  33     const QErrorStringTable *entry;
  34 } QError;
  35
  36 QError *qerror_new(void);
  37 QError *qerror_from_info(const char *file, int linenr, const char *func,
  38                          const char *fmt, va_list *va) GCC_FMT_ATTR(4, 0);
  39 QString *qerror_human(const QError *qerror);
  40 void qerror_print(QError *qerror);
  41 void qerror_report_internal(const char *file, int linenr, const char *func,
  42                             const char *fmt, ...) GCC_FMT_ATTR(4, 5);
  43 void qerror_report_err(Error *err);
  44 QString *qerror_format(const char *fmt, QDict *error);
  45 #define qerror_report(fmt, ...) \
  46     qerror_report_internal(__FILE__, __LINE__, __func__, fmt, ## __VA_ARGS__)
  47 QError *qobject_to_qerror(const QObject *obj);
  48
  49 /*
  50  * QError class list
  51  * Please keep the definitions in alphabetical order.
  52  * Use "grep '^#define QERR_' qerror.h | sort -c" to check.
  53  */
  54 #define QERR_BAD_BUS_FOR_DEVICE \
  55     "{ 'class': 'BadBusForDevice', 'data': { 'device': %s, 'bad_bus_type': %s } }"
  56
  57 #define QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED \
  58     "{ 'class': 'BlockFormatFeatureNotSupported', 'data': { 'format': %s, 'name': %s, 'feature': %s } }"
  59
  60 #define QERR_BUS_NOT_FOUND \
  61     "{ 'class': 'BusNotFound', 'data': { 'bus': %s } }"
  62
  63 #define QERR_BUS_NO_HOTPLUG \
  64     "{ 'class': 'BusNoHotplug', 'data': { 'bus': %s } }"
  65
  66 #define QERR_COMMAND_NOT_FOUND \
  67     "{ 'class': 'CommandNotFound', 'data': { 'name': %s } }"
  68
  69 #define QERR_COMMAND_DISABLED \
  70     "{ 'class': 'CommandDisabled', 'data': { 'name': %s } }"
  71
  72 #define QERR_DEVICE_ENCRYPTED \
  73     "{ 'class': 'DeviceEncrypted', 'data': { 'device': %s } }"
  74
  75 #define QERR_DEVICE_INIT_FAILED \
  76     "{ 'class': 'DeviceInitFailed', 'data': { 'device': %s } }"
  77
  78 #define QERR_DEVICE_IN_USE \
  79     "{ 'class': 'DeviceInUse', 'data': { 'device': %s } }"
  80
  81 #define QERR_DEVICE_FEATURE_BLOCKS_MIGRATION \
  82     "{ 'class': 'DeviceFeatureBlocksMigration', 'data': { 'device': %s, 'feature': %s } }"
  83
  84 #define QERR_DEVICE_LOCKED \
  85     "{ 'class': 'DeviceLocked', 'data': { 'device': %s } }"
  86
  87 #define QERR_DEVICE_MULTIPLE_BUSSES \
  88     "{ 'class': 'DeviceMultipleBusses', 'data': { 'device': %s } }"
  89
  90 #define QERR_DEVICE_NOT_ACTIVE \
  91     "{ 'class': 'DeviceNotActive', 'data': { 'device': %s } }"
  92
  93 #define QERR_DEVICE_NOT_ENCRYPTED \
  94     "{ 'class': 'DeviceNotEncrypted', 'data': { 'device': %s } }"
  95
  96 #define QERR_DEVICE_NOT_FOUND \
  97     "{ 'class': 'DeviceNotFound', 'data': { 'device': %s } }"
  98
  99 #define QERR_DEVICE_NOT_REMOVABLE \
 100     "{ 'class': 'DeviceNotRemovable', 'data': { 'device': %s } }"
 101
 102 #define QERR_DEVICE_NO_BUS \
 103     "{ 'class': 'DeviceNoBus', 'data': { 'device': %s } }"
 104
 105 #define QERR_DEVICE_NO_HOTPLUG \
 106     "{ 'class': 'DeviceNoHotplug', 'data': { 'device': %s } }"
 107
 108 #define QERR_DUPLICATE_ID \
 109     "{ 'class': 'DuplicateId', 'data': { 'id': %s, 'object': %s } }"
 110
 111 #define QERR_FD_NOT_FOUND \
 112     "{ 'class': 'FdNotFound', 'data': { 'name': %s } }"
 113
 114 #define QERR_FD_NOT_SUPPLIED \
 115     "{ 'class': 'FdNotSupplied', 'data': {} }"
 116
 117 #define QERR_INVALID_BLOCK_FORMAT \
 118     "{ 'class': 'InvalidBlockFormat', 'data': { 'name': %s } }"
 119
 120 #define QERR_INVALID_PARAMETER \
 121     "{ 'class': 'InvalidParameter', 'data': { 'name': %s } }"
 122
 123 #define QERR_INVALID_PARAMETER_TYPE \
 124     "{ 'class': 'InvalidParameterType', 'data': { 'name': %s,'expected': %s } }"
 125
 126 #define QERR_INVALID_PARAMETER_VALUE \
 127     "{ 'class': 'InvalidParameterValue', 'data': { 'name': %s, 'expected': %s } }"
 128
 129 #define QERR_INVALID_PASSWORD \
 130     "{ 'class': 'InvalidPassword', 'data': {} }"
 131
 132 #define QERR_IO_ERROR \
 133     "{ 'class': 'IOError', 'data': {} }"
 134
 135 #define QERR_JSON_PARSING \
 136     "{ 'class': 'JSONParsing', 'data': {} }"
 137
 138 #define QERR_JSON_PARSE_ERROR \
 139     "{ 'class': 'JSONParseError', 'data': { 'message': %s } }"
 140
 141 #define QERR_BUFFER_OVERRUN \
 142     "{ 'class': 'BufferOverrun', 'data': {} }"
 143
 144 #define QERR_KVM_MISSING_CAP \
 145     "{ 'class': 'KVMMissingCap', 'data': { 'capability': %s, 'feature': %s } }"
 146
 147 #define QERR_MIGRATION_EXPECTED \
 148     "{ 'class': 'MigrationExpected', 'data': {} }"
 149
 150 #define QERR_MISSING_PARAMETER \
 151     "{ 'class': 'MissingParameter', 'data': { 'name': %s } }"
 152
 153 #define QERR_NO_BUS_FOR_DEVICE \
 154     "{ 'class': 'NoBusForDevice', 'data': { 'device': %s, 'bus': %s } }"
 155
 156 #define QERR_OPEN_FILE_FAILED \
 157     "{ 'class': 'OpenFileFailed', 'data': { 'filename': %s } }"
 158
 159 #define QERR_PERMISSION_DENIED \
 160     "{ 'class': 'PermissionDenied', 'data': {} }"
 161
 162 #define QERR_PROPERTY_NOT_FOUND \
 163     "{ 'class': 'PropertyNotFound', 'data': { 'device': %s, 'property': %s } }"
 164
 165 #define QERR_PROPERTY_VALUE_BAD \
 166     "{ 'class': 'PropertyValueBad', 'data': { 'device': %s, 'property': %s, 'value': %s } }"
 167
 168 #define QERR_PROPERTY_VALUE_IN_USE \
 169     "{ 'class': 'PropertyValueInUse', 'data': { 'device': %s, 'property': %s, 'value': %s } }"
 170
 171 #define QERR_PROPERTY_VALUE_NOT_FOUND \
 172     "{ 'class': 'PropertyValueNotFound', 'data': { 'device': %s, 'property': %s, 'value': %s } }"
 173
 174 #define QERR_PROPERTY_VALUE_OUT_OF_RANGE \
 175     "{ 'class': 'PropertyValueOutOfRange', 'data': { 'device': %s, 'property': %s, 'value': %"PRId64", 'min': %"PRId64", 'max': %"PRId64" } }"
 176
 177 #define QERR_QMP_BAD_INPUT_OBJECT \
 178     "{ 'class': 'QMPBadInputObject', 'data': { 'expected': %s } }"
 179
 180 #define QERR_QMP_BAD_INPUT_OBJECT_MEMBER \
 181     "{ 'class': 'QMPBadInputObjectMember', 'data': { 'member': %s, 'expected': %s } }"
 182
 183 #define QERR_QMP_EXTRA_MEMBER \
 184     "{ 'class': 'QMPExtraInputObjectMember', 'data': { 'member': %s } }"
 185
 186 #define QERR_RESET_REQUIRED \
 187     "{ 'class': 'ResetRequired', 'data': {} }"
 188
 189 #define QERR_SET_PASSWD_FAILED \
 190     "{ 'class': 'SetPasswdFailed', 'data': {} }"
 191
 192 #define QERR_ADD_CLIENT_FAILED \
 193     "{ 'class': 'AddClientFailed', 'data': {} }"
 194
 195 #define QERR_TOO_MANY_FILES \
 196     "{ 'class': 'TooManyFiles', 'data': {} }"
 197
 198 #define QERR_UNDEFINED_ERROR \
 199     "{ 'class': 'UndefinedError', 'data': {} }"
 200
 201 #define QERR_UNSUPPORTED \
 202     "{ 'class': 'Unsupported', 'data': {} }"
 203
 204 #define QERR_UNKNOWN_BLOCK_FORMAT_FEATURE \
 205     "{ 'class': 'UnknownBlockFormatFeature', 'data': { 'device': %s, 'format': %s, 'feature': %s } }"
 206
 207 #define QERR_VIRTFS_FEATURE_BLOCKS_MIGRATION \
 208     "{ 'class': 'VirtFSFeatureBlocksMigration', 'data': { 'path': %s, 'tag': %s } }"
 209
 210 #define QERR_VNC_SERVER_FAILED \
 211     "{ 'class': 'VNCServerFailed', 'data': { 'target': %s } }"
 212
 213 #define QERR_FEATURE_DISABLED \
 214     "{ 'class': 'FeatureDisabled', 'data': { 'name': %s } }"
 215
 216 #define QERR_QGA_LOGGING_FAILED \
 217     "{ 'class': 'QgaLoggingFailed', 'data': {} }"
 218
 219 #define QERR_QGA_COMMAND_FAILED \
 220     "{ 'class': 'QgaCommandFailed', 'data': { 'message': %s } }"
 221
 222 #define QERR_INVALID_PARAMETER_COMBINATION \
 223     "{ 'class': 'InvalidParameterCombination', 'data': {} }"
 224
 225 #endif /* QERROR_H */