2011-06-01 19:14:49 +02:00
|
|
|
/*
|
|
|
|
* QEMU Error Objects
|
|
|
|
*
|
|
|
|
* Copyright IBM, Corp. 2011
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Anthony Liguori <aliguori@us.ibm.com>
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU LGPL, version 2. See
|
|
|
|
* the COPYING.LIB file in the top-level directory.
|
|
|
|
*/
|
|
|
|
#ifndef ERROR_H
|
|
|
|
#define ERROR_H
|
|
|
|
|
2012-12-17 18:20:00 +01:00
|
|
|
#include "qemu/compiler.h"
|
2012-07-27 19:09:29 +02:00
|
|
|
#include "qapi-types.h"
|
2011-06-01 19:14:49 +02:00
|
|
|
#include <stdbool.h>
|
|
|
|
|
|
|
|
/**
|
2012-07-27 22:51:03 +02:00
|
|
|
* A class representing internal errors within QEMU. An error has a ErrorClass
|
|
|
|
* code and a human message.
|
2011-06-01 19:14:49 +02:00
|
|
|
*/
|
|
|
|
typedef struct Error Error;
|
|
|
|
|
|
|
|
/**
|
2012-07-27 22:51:03 +02:00
|
|
|
* 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.
|
2011-06-01 19:14:49 +02:00
|
|
|
*/
|
2014-05-02 13:26:32 +02:00
|
|
|
void error_set(Error **errp, ErrorClass err_class, const char *fmt, ...)
|
|
|
|
GCC_FMT_ATTR(3, 4);
|
2011-06-01 19:14:49 +02:00
|
|
|
|
2012-10-02 09:00:45 +02:00
|
|
|
/**
|
|
|
|
* Set an indirect pointer to an error given a ErrorClass value and a
|
|
|
|
* printf-style human message, followed by a strerror() string if
|
|
|
|
* @os_error is not zero.
|
|
|
|
*/
|
2015-06-19 22:16:14 +02:00
|
|
|
void error_setg_errno(Error **errp, int os_error, const char *fmt, ...)
|
|
|
|
GCC_FMT_ATTR(3, 4);
|
2012-10-02 09:00:45 +02:00
|
|
|
|
2013-08-07 17:40:11 +02:00
|
|
|
#ifdef _WIN32
|
|
|
|
/**
|
|
|
|
* Set an indirect pointer to an error given a ErrorClass value and a
|
|
|
|
* printf-style human message, followed by a g_win32_error_message() string if
|
|
|
|
* @win32_err is not zero.
|
|
|
|
*/
|
qga: Clean up unnecessarily dirty casts
qga_vss_fsfreeze() casts error_set_win32() from
void (*)(Error **, int, ErrorClass, const char *, ...)
to
void (*)(void **, int, int, const char *, ...)
The result is later called. Since the two types are not compatible,
the call is undefined behavior. It works in practice anyway.
However, there's no real need for trickery here. Clean it up as
follows:
* Declare struct Error, and fix the first parameter.
* Switch to error_setg_win32(). This gets rid of the troublesome
ErrorClass parameter. Requires converting error_setg_win32() from
macro to function, but that's trivially easy, because this is the
only user of error_set_win32().
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
2015-06-19 20:44:54 +02:00
|
|
|
void error_setg_win32(Error **errp, int win32_err, const char *fmt, ...)
|
|
|
|
GCC_FMT_ATTR(3, 4);
|
2013-08-07 17:40:11 +02:00
|
|
|
#endif
|
|
|
|
|
2012-08-29 16:20:57 +02:00
|
|
|
/**
|
|
|
|
* Same as error_set(), but sets a generic error
|
|
|
|
*/
|
2015-06-19 15:36:16 +02:00
|
|
|
void error_setg(Error **errp, const char *fmt, ...)
|
|
|
|
GCC_FMT_ATTR(2, 3);
|
2012-08-29 16:20:57 +02:00
|
|
|
|
2013-06-07 20:24:49 +02:00
|
|
|
/**
|
|
|
|
* Helper for open() errors
|
|
|
|
*/
|
|
|
|
void error_setg_file_open(Error **errp, int os_errno, const char *filename);
|
|
|
|
|
2012-08-01 21:29:38 +02:00
|
|
|
/*
|
|
|
|
* Get the error class of an error object.
|
|
|
|
*/
|
|
|
|
ErrorClass error_get_class(const Error *err);
|
|
|
|
|
2011-12-05 19:04:05 +01:00
|
|
|
/**
|
|
|
|
* Returns an exact copy of the error passed as an argument.
|
|
|
|
*/
|
|
|
|
Error *error_copy(const Error *err);
|
|
|
|
|
2011-06-01 19:14:49 +02:00
|
|
|
/**
|
|
|
|
* Get a human readable representation of an error object.
|
|
|
|
*/
|
|
|
|
const char *error_get_pretty(Error *err);
|
|
|
|
|
2015-02-06 15:27:19 +01:00
|
|
|
/**
|
|
|
|
* Convenience function to error_report() and free an error object.
|
|
|
|
*/
|
|
|
|
void error_report_err(Error *);
|
|
|
|
|
2011-06-01 19:14:49 +02:00
|
|
|
/**
|
|
|
|
* Propagate an error to an indirect pointer to an error. This function will
|
|
|
|
* always transfer ownership of the error reference and handles the case where
|
2012-07-17 16:17:04 +02:00
|
|
|
* dst_err is NULL correctly. Errors after the first are discarded.
|
2011-06-01 19:14:49 +02:00
|
|
|
*/
|
2014-05-02 13:26:32 +02:00
|
|
|
void error_propagate(Error **dst_errp, Error *local_err);
|
2011-06-01 19:14:49 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Free an error object.
|
|
|
|
*/
|
|
|
|
void error_free(Error *err);
|
|
|
|
|
2014-01-02 03:46:59 +01:00
|
|
|
/**
|
|
|
|
* If passed to error_set and friends, abort().
|
|
|
|
*/
|
|
|
|
|
|
|
|
extern Error *error_abort;
|
|
|
|
|
2011-06-01 19:14:49 +02:00
|
|
|
#endif
|