include/qapi/error.h

   1 /*
   2  * QEMU Error Objects
   3  *
   4  * Copyright IBM, Corp. 2011
   5  *
   6  * Authors:
   7  *  Anthony Liguori   <aliguori@us.ibm.com>
   8  *
   9  * This work is licensed under the terms of the GNU LGPL, version 2.  See
  10  * the COPYING.LIB file in the top-level directory.
  11  */
  12 #ifndef ERROR_H
  13 #define ERROR_H
  14
  15 #include "qemu/compiler.h"
  16 #include "qapi-types.h"
  17 #include <stdbool.h>
  18
  19 /**
  20  * A class representing internal errors within QEMU.  An error has a ErrorClass
  21  * code and a human message.
  22  */
  23 typedef struct Error Error;
  24
  25 /**
  26  * Set an indirect pointer to an error given a ErrorClass value and a
  27  * printf-style human message.  This function is not meant to be used outside
  28  * of QEMU.
  29  */
  30 void error_set(Error **errp, ErrorClass err_class, const char *fmt, ...)
  31     GCC_FMT_ATTR(3, 4);
  32
  33 /**
  34  * Set an indirect pointer to an error given a ErrorClass value and a
  35  * printf-style human message, followed by a strerror() string if
  36  * @os_error is not zero.
  37  */
  38 void error_setg_errno(Error **errp, int os_error, const char *fmt, ...)
  39     GCC_FMT_ATTR(3, 4);
  40
  41 #ifdef _WIN32
  42 /**
  43  * Set an indirect pointer to an error given a ErrorClass value and a
  44  * printf-style human message, followed by a g_win32_error_message() string if
  45  * @win32_err is not zero.
  46  */
  47 void error_setg_win32(Error **errp, int win32_err, const char *fmt, ...)
  48     GCC_FMT_ATTR(3, 4);
  49 #endif
  50
  51 /**
  52  * Same as error_set(), but sets a generic error
  53  */
  54 void error_setg(Error **errp, const char *fmt, ...)
  55     GCC_FMT_ATTR(2, 3);
  56
  57 /**
  58  * Helper for open() errors
  59  */
  60 void error_setg_file_open(Error **errp, int os_errno, const char *filename);
  61
  62 /*
  63  * Get the error class of an error object.
  64  */
  65 ErrorClass error_get_class(const Error *err);
  66
  67 /**
  68  * Returns an exact copy of the error passed as an argument.
  69  */
  70 Error *error_copy(const Error *err);
  71
  72 /**
  73  * Get a human readable representation of an error object.
  74  */
  75 const char *error_get_pretty(Error *err);
  76
  77 /**
  78  * Convenience function to error_report() and free an error object.
  79  */
  80 void error_report_err(Error *);
  81
  82 /**
  83  * Propagate an error to an indirect pointer to an error.  This function will
  84  * always transfer ownership of the error reference and handles the case where
  85  * dst_err is NULL correctly.  Errors after the first are discarded.
  86  */
  87 void error_propagate(Error **dst_errp, Error *local_err);
  88
  89 /**
  90  * Free an error object.
  91  */
  92 void error_free(Error *err);
  93
  94 /**
  95  * If passed to error_set and friends, abort().
  96  */
  97
  98 extern Error *error_abort;
  99
 100 #endif