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 "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 string
  21  * typename and optionally a set of named string parameters.
  22  */
  23 typedef struct Error Error;
  24
  25 /**
  26  * Set an indirect pointer to an error given a printf-style format parameter.
  27  * Currently, qerror.h defines these error formats.  This function is not
  28  * meant to be used outside of QEMU.
  29  */
  30 void error_set(Error **err, ErrorClass err_class, const char *fmt, ...) GCC_FMT_ATTR(3, 4);
  31
  32 /**
  33  * Returns true if an indirect pointer to an error is pointing to a valid
  34  * error object.
  35  */
  36 bool error_is_set(Error **err);
  37
  38 /**
  39  * Returns an exact copy of the error passed as an argument.
  40  */
  41 Error *error_copy(const Error *err);
  42
  43 /**
  44  * Get a human readable representation of an error object.
  45  */
  46 const char *error_get_pretty(Error *err);
  47
  48 /**
  49  * Get an individual named error field.
  50  */
  51 const char *error_get_field(Error *err, const char *field);
  52
  53 /**
  54  * Get an individual named error field.
  55  */
  56 void error_set_field(Error *err, const char *field, const char *value);
  57
  58 /**
  59  * Propagate an error to an indirect pointer to an error.  This function will
  60  * always transfer ownership of the error reference and handles the case where
  61  * dst_err is NULL correctly.  Errors after the first are discarded.
  62  */
  63 void error_propagate(Error **dst_err, Error *local_err);
  64
  65 /**
  66  * Free an error object.
  67  */
  68 void error_free(Error *err);
  69
  70 /**
  71  * Determine if an error is of a speific type (based on the qerror format).
  72  * Non-QEMU users should get the `class' field to identify the error type.
  73  */
  74 bool error_is_type(Error *err, ErrorClass err_class, const char *fmt);
  75
  76 #endif