include/qemu/error-report.h

   1 /*
   2  * Error reporting
   3  *
   4  * Copyright (C) 2010 Red Hat Inc.
   5  *
   6  * Authors:
   7  *  Markus Armbruster <armbru@redhat.com>,
   8  *
   9  * This work is licensed under the terms of the GNU GPL, version 2 or later.
  10  * See the COPYING file in the top-level directory.
  11  */
  12
  13 #ifndef QEMU_ERROR_REPORT_H
  14 #define QEMU_ERROR_REPORT_H
  15
  16 typedef struct Location {
  17     /* all members are private to qemu-error.c */
  18     enum { LOC_NONE, LOC_CMDLINE, LOC_FILE } kind;
  19     int num;
  20     const void *ptr;
  21     struct Location *prev;
  22 } Location;
  23
  24 Location *loc_push_restore(Location *loc);
  25 Location *loc_push_none(Location *loc);
  26 Location *loc_pop(Location *loc);
  27 Location *loc_save(Location *loc);
  28 void loc_restore(Location *loc);
  29 void loc_set_none(void);
  30 void loc_set_cmdline(char **argv, int idx, int cnt);
  31 void loc_set_file(const char *fname, int lno);
  32
  33 int error_vprintf(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
  34 int error_printf(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
  35 int error_vprintf_unless_qmp(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
  36 int error_printf_unless_qmp(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
  37
  38 void error_vreport(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
  39 void warn_vreport(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
  40 void info_vreport(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
  41
  42 void error_report(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
  43 void warn_report(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
  44 void info_report(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
  45
  46 bool error_report_once_cond(bool *printed, const char *fmt, ...)
  47     GCC_FMT_ATTR(2, 3);
  48 bool warn_report_once_cond(bool *printed, const char *fmt, ...)
  49     GCC_FMT_ATTR(2, 3);
  50
  51 void error_init(const char *argv0);
  52
  53 /*
  54  * Similar to error_report(), except it prints the message just once.
  55  * Return true when it prints, false otherwise.
  56  */
  57 #define error_report_once(fmt, ...)                     \
  58     ({                                                  \
  59         static bool print_once_;                        \
  60         error_report_once_cond(&print_once_,            \
  61                                fmt, ##__VA_ARGS__);     \
  62     })
  63
  64 /*
  65  * Similar to warn_report(), except it prints the message just once.
  66  * Return true when it prints, false otherwise.
  67  */
  68 #define warn_report_once(fmt, ...)                      \
  69     ({                                                  \
  70         static bool print_once_;                        \
  71         warn_report_once_cond(&print_once_,             \
  72                               fmt, ##__VA_ARGS__);      \
  73     })
  74
  75 const char *error_get_progname(void);
  76
  77 extern bool error_with_timestamp;
  78
  79 #endif