Commit df1e608a authored by Luiz Capitulino's avatar Luiz Capitulino
Browse files

error, qerror: pass desc string to error calls 



This commit changes all QERR_ macros to contain a human message (ie.
the desc string found in qerr_table[]) instead of a json dictionary
in string format.

Before this commit, error_set() and qerror_report() would receive
a json dictionary in string format and build a qobject from it. Now,
both function receive a human message instead and the qobject is
not built anymore.

Signed-off-by: default avatarLuiz Capitulino <lcapitulino@redhat.com>
Reviewed-by: default avatarMarkus Armbruster <armbru@redhat.com>
parent 7795b166

error.c

+1 −2
Original line number Diff line number Diff line
@@ -37,9 +37,8 @@ void error_set(Error **errp, ErrorClass err_class, const char *fmt, ...) 
    err = g_malloc0(sizeof(*err));



    va_start(ap, fmt);

    err->obj = qobject_to_qdict(qobject_from_jsonv(fmt, &ap));

    err->msg = g_strdup_vprintf(fmt, ap);

    va_end(ap);

    err->msg = qerror_format(fmt, err->obj);

    err->err_class = err_class;



    *errp = err;

error.h

+5 −5
Original line number Diff line number Diff line
@@ -17,15 +17,15 @@ 
#include <stdbool.h>



/**

 * A class representing internal errors within QEMU.  An error has a string

 * typename and optionally a set of named string parameters.

 * A class representing internal errors within QEMU.  An error has a ErrorClass

 * code and a human message.

 */

typedef struct Error Error;



/**

 * Set an indirect pointer to an error given a printf-style format parameter.

 * Currently, qerror.h defines these error formats.  This function is not

 * meant to be used outside of QEMU.

 * Set an indirect pointer to an error given a ErrorClass value and a

 * printf-style human message.  This function is not meant to be used outside

 * of QEMU.

 */

void error_set(Error **err, ErrorClass err_class, const char *fmt, ...) GCC_FMT_ATTR(3, 4);

qerror.c

+1 −41
Original line number Diff line number Diff line
@@ -342,45 +342,6 @@ static QError *qerror_new(void) 
    return qerr;

}



static QDict *error_obj_from_fmt_no_fail(const char *fmt, va_list *va)

{

    QObject *obj;

    QDict *ret;



    obj = qobject_from_jsonv(fmt, va);

    if (!obj) {

        fprintf(stderr, "invalid json in error dict '%s'\n", fmt);

        abort();

    }

    if (qobject_type(obj) != QTYPE_QDICT) {

        fprintf(stderr, "error is not a dict '%s'\n", fmt);

        abort();

    }



    ret = qobject_to_qdict(obj);

    obj = qdict_get(ret, "class");

    if (!obj) {

        fprintf(stderr, "missing 'class' key in '%s'\n", fmt);

        abort();

    }

    if (qobject_type(obj) != QTYPE_QSTRING) {

        fprintf(stderr, "'class' key value should be a string in '%s'\n", fmt);

        abort();

    }



    obj = qdict_get(ret, "data");

    if (!obj) {

        fprintf(stderr, "missing 'data' key in '%s'\n", fmt);

        abort();

    }

    if (qobject_type(obj) != QTYPE_QDICT) {

        fprintf(stderr, "'data' key value should be a dict in '%s'\n", fmt);

        abort();

    }



    return ret;

}



/**

 * qerror_from_info(): Create a new QError from error information

 *
@@ -394,9 +355,8 @@ static QError *qerror_from_info(ErrorClass err_class, const char *fmt, 
    qerr = qerror_new();

    loc_save(&qerr->loc);



    qerr->err_msg = g_strdup_vprintf(fmt, *va);

    qerr->err_class = err_class;

    qerr->error = error_obj_from_fmt_no_fail(fmt, va);

    qerr->err_msg = qerror_format(fmt, qerr->error);



    return qerr;

}

qerror.h

+70 −71
Original line number Diff line number Diff line
@@ -45,214 +45,213 @@ char *qerror_format(const char *fmt, QDict *error); 
 * Use scripts/check-qerror.sh to check.

 */

#define QERR_ADD_CLIENT_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'AddClientFailed', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Could not add client"



#define QERR_AMBIGUOUS_PATH \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'AmbiguousPath', 'data': { 'path': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Path '%s' does not uniquely identify an object"



#define QERR_BAD_BUS_FOR_DEVICE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'BadBusForDevice', 'data': { 'device': %s, 'bad_bus_type': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' can't go on a %s bus"



#define QERR_BASE_NOT_FOUND \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'BaseNotFound', 'data': { 'base': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Base '%s' not found"



#define QERR_BLOCK_FORMAT_FEATURE_NOT_SUPPORTED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'BlockFormatFeatureNotSupported', 'data': { 'format': %s, 'name': %s, 'feature': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Block format '%s' used by device '%s' does not support feature '%s'"



#define QERR_BUFFER_OVERRUN \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'BufferOverrun', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "An internal buffer overran"



#define QERR_BUS_NO_HOTPLUG \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'BusNoHotplug', 'data': { 'bus': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Bus '%s' does not support hotplugging"



#define QERR_BUS_NOT_FOUND \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'BusNotFound', 'data': { 'bus': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Bus '%s' not found"



#define QERR_COMMAND_DISABLED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'CommandDisabled', 'data': { 'name': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "The command %s has been disabled for this instance"



#define QERR_COMMAND_NOT_FOUND \

    ERROR_CLASS_COMMAND_NOT_FOUND, "{ 'class': 'CommandNotFound', 'data': { 'name': %s } }"

    ERROR_CLASS_COMMAND_NOT_FOUND, "The command %s has not been found"



#define QERR_DEVICE_ENCRYPTED \

    ERROR_CLASS_DEVICE_ENCRYPTED, "{ 'class': 'DeviceEncrypted', 'data': { 'device': %s, 'filename': %s } }"

    ERROR_CLASS_DEVICE_ENCRYPTED, "'%s' (%s) is encrypted"



#define QERR_DEVICE_FEATURE_BLOCKS_MIGRATION \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceFeatureBlocksMigration', 'data': { 'device': %s, 'feature': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Migration is disabled when using feature '%s' in device '%s'"



#define QERR_DEVICE_HAS_NO_MEDIUM \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceHasNoMedium', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' has no medium"



#define QERR_DEVICE_INIT_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceInitFailed', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' could not be initialized"



#define QERR_DEVICE_IN_USE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceInUse', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' is in use"



#define QERR_DEVICE_IS_READ_ONLY \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceIsReadOnly', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' is read only"



#define QERR_DEVICE_LOCKED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceLocked', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' is locked"



#define QERR_DEVICE_MULTIPLE_BUSSES \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceMultipleBusses', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' has multiple child busses"



#define QERR_DEVICE_NO_BUS \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceNoBus', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' has no child bus"



#define QERR_DEVICE_NO_HOTPLUG \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceNoHotplug', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' does not support hotplugging"



#define QERR_DEVICE_NOT_ACTIVE \

    ERROR_CLASS_DEVICE_NOT_ACTIVE, "{ 'class': 'DeviceNotActive', 'data': { 'device': %s } }"

    ERROR_CLASS_DEVICE_NOT_ACTIVE, "Device '%s' has not been activated"



#define QERR_DEVICE_NOT_ENCRYPTED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceNotEncrypted', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' is not encrypted"



#define QERR_DEVICE_NOT_FOUND \

    ERROR_CLASS_DEVICE_NOT_FOUND, "{ 'class': 'DeviceNotFound', 'data': { 'device': %s } }"

    ERROR_CLASS_DEVICE_NOT_FOUND, "Device '%s' not found"



#define QERR_DEVICE_NOT_REMOVABLE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DeviceNotRemovable', 'data': { 'device': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Device '%s' is not removable"



#define QERR_DUPLICATE_ID \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'DuplicateId', 'data': { 'id': %s, 'object': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Duplicate ID '%s' for %s"



#define QERR_FD_NOT_FOUND \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'FdNotFound', 'data': { 'name': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "File descriptor named '%s' not found"



#define QERR_FD_NOT_SUPPLIED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'FdNotSupplied', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "No file descriptor supplied via SCM_RIGHTS"



#define QERR_FEATURE_DISABLED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'FeatureDisabled', 'data': { 'name': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "The feature '%s' is not enabled"



#define QERR_INVALID_BLOCK_FORMAT \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'InvalidBlockFormat', 'data': { 'name': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Invalid block format '%s'"



#define QERR_INVALID_OPTION_GROUP \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'InvalidOptionGroup', 'data': { 'group': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "There is no option group '%s'"



#define QERR_INVALID_PARAMETER \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'InvalidParameter', 'data': { 'name': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Invalid parameter '%s'"



#define QERR_INVALID_PARAMETER_COMBINATION \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'InvalidParameterCombination', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Invalid parameter combination"



#define QERR_INVALID_PARAMETER_TYPE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'InvalidParameterType', 'data': { 'name': %s,'expected': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Invalid parameter type for '%s', expected: %s"



#define QERR_INVALID_PARAMETER_VALUE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'InvalidParameterValue', 'data': { 'name': %s, 'expected': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Parameter '%s' expects %s"



#define QERR_INVALID_PASSWORD \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'InvalidPassword', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Password incorrect"



#define QERR_IO_ERROR \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'IOError', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "An IO error has occurred"



#define QERR_JSON_PARSE_ERROR \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'JSONParseError', 'data': { 'message': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "JSON parse error, %s"



#define QERR_JSON_PARSING \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'JSONParsing', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Invalid JSON syntax"



#define QERR_KVM_MISSING_CAP \

    ERROR_CLASS_K_V_M_MISSING_CAP, "{ 'class': 'KVMMissingCap', 'data': { 'capability': %s, 'feature': %s } }"

    ERROR_CLASS_K_V_M_MISSING_CAP, "Using KVM without %s, %s unavailable"



#define QERR_MIGRATION_ACTIVE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'MigrationActive', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "There's a migration process in progress"



#define QERR_MIGRATION_NOT_SUPPORTED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'MigrationNotSupported', 'data': {'device': %s} }"

    ERROR_CLASS_GENERIC_ERROR, "State blocked by non-migratable device '%s'"



#define QERR_MIGRATION_EXPECTED \

    ERROR_CLASS_MIGRATION_EXPECTED, "{ 'class': 'MigrationExpected', 'data': {} }"

    ERROR_CLASS_MIGRATION_EXPECTED, "An incoming migration is expected before this command can be executed"



#define QERR_MISSING_PARAMETER \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'MissingParameter', 'data': { 'name': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Parameter '%s' is missing"



#define QERR_NO_BUS_FOR_DEVICE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'NoBusForDevice', 'data': { 'device': %s, 'bus': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "No '%s' bus found for device '%s'"



#define QERR_NOT_SUPPORTED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'NotSupported', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Not supported"



#define QERR_OPEN_FILE_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'OpenFileFailed', 'data': { 'filename': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Could not open '%s'"



#define QERR_PERMISSION_DENIED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'PermissionDenied', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Insufficient permission to perform this operation"



#define QERR_PROPERTY_NOT_FOUND \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'PropertyNotFound', 'data': { 'device': %s, 'property': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Property '%s.%s' not found"



#define QERR_PROPERTY_VALUE_BAD \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'PropertyValueBad', 'data': { 'device': %s, 'property': %s, 'value': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Property '%s.%s' doesn't take value '%s'"



#define QERR_PROPERTY_VALUE_IN_USE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'PropertyValueInUse', 'data': { 'device': %s, 'property': %s, 'value': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Property '%s.%s' can't take value '%s', it's in use"



#define QERR_PROPERTY_VALUE_NOT_FOUND \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'PropertyValueNotFound', 'data': { 'device': %s, 'property': %s, 'value': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Property '%s.%s' can't find value '%s'"



#define QERR_PROPERTY_VALUE_NOT_POWER_OF_2 \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'PropertyValueNotPowerOf2', 'data': { " \

    "'device': %s, 'property': %s, 'value': %"PRId64" } }"

    ERROR_CLASS_GENERIC_ERROR, "Property %s.%s doesn't take value '%" PRId64 "', it's not a power of 2"



#define QERR_PROPERTY_VALUE_OUT_OF_RANGE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'PropertyValueOutOfRange', 'data': { 'device': %s, 'property': %s, 'value': %"PRId64", 'min': %"PRId64", 'max': %"PRId64" } }"

    ERROR_CLASS_GENERIC_ERROR, "Property %s.%s doesn't take value %" PRId64 " (minimum: %" PRId64 ", maximum: %" PRId64 ")"



#define QERR_QGA_COMMAND_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'QgaCommandFailed', 'data': { 'message': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Guest agent command failed, error was '%s'"



#define QERR_QGA_LOGGING_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'QgaLoggingFailed', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Guest agent failed to log non-optional log statement"



#define QERR_QMP_BAD_INPUT_OBJECT \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'QMPBadInputObject', 'data': { 'expected': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Expected '%s' in QMP input"



#define QERR_QMP_BAD_INPUT_OBJECT_MEMBER \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'QMPBadInputObjectMember', 'data': { 'member': %s, 'expected': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "QMP input object member '%s' expects '%s'"



#define QERR_QMP_EXTRA_MEMBER \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'QMPExtraInputObjectMember', 'data': { 'member': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "QMP input object member '%s' is unexpected"



#define QERR_RESET_REQUIRED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'ResetRequired', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Resetting the Virtual Machine is required"



#define QERR_SET_PASSWD_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'SetPasswdFailed', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Could not set password"



#define QERR_TOO_MANY_FILES \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'TooManyFiles', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Too many open files"



#define QERR_UNDEFINED_ERROR \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'UndefinedError', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "An undefined error has occurred"



#define QERR_UNKNOWN_BLOCK_FORMAT_FEATURE \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'UnknownBlockFormatFeature', 'data': { 'device': %s, 'format': %s, 'feature': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "'%s' uses a %s feature which is not supported by this qemu version: %s"



#define QERR_UNSUPPORTED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'Unsupported', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "this feature or command is not currently supported"



#define QERR_VIRTFS_FEATURE_BLOCKS_MIGRATION \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'VirtFSFeatureBlocksMigration', 'data': { 'path': %s, 'tag': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Migration is disabled when VirtFS export path '%s' is mounted in the guest using mount_tag '%s'"



#define QERR_VNC_SERVER_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'VNCServerFailed', 'data': { 'target': %s } }"

    ERROR_CLASS_GENERIC_ERROR, "Could not start VNC server on %s"



#define QERR_SOCKET_CONNECT_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'SockConnectFailed', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Failed to connect to socket"



#define QERR_SOCKET_LISTEN_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'SockListenFailed', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Failed to set socket to listening mode"



#define QERR_SOCKET_BIND_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'SockBindFailed', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Failed to bind socket"



#define QERR_SOCKET_CREATE_FAILED \

    ERROR_CLASS_GENERIC_ERROR, "{ 'class': 'SockCreateFailed', 'data': {} }"

    ERROR_CLASS_GENERIC_ERROR, "Failed to create socket"



#endif /* QERROR_H */