xref: /openbmc/qemu/include/qemu/error-report.h (revision 99d46107)
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 void error_vprintf(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
34 void error_printf(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
35 void error_vprintf_unless_qmp(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
36 void error_printf_unless_qmp(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
37 void error_set_progname(const char *argv0);
38 
39 void error_vreport(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
40 void warn_vreport(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
41 void info_vreport(const char *fmt, va_list ap) GCC_FMT_ATTR(1, 0);
42 
43 void error_report(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
44 void warn_report(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
45 void info_report(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
46 
47 bool error_report_once_cond(bool *printed, const char *fmt, ...)
48     GCC_FMT_ATTR(2, 3);
49 bool warn_report_once_cond(bool *printed, const char *fmt, ...)
50     GCC_FMT_ATTR(2, 3);
51 
52 /*
53  * Similar to error_report(), except it prints the message just once.
54  * Return true when it prints, false otherwise.
55  */
56 #define error_report_once(fmt, ...)                     \
57     ({                                                  \
58         static bool print_once_;                        \
59         error_report_once_cond(&print_once_,            \
60                                fmt, ##__VA_ARGS__);     \
61     })
62 
63 /*
64  * Similar to warn_report(), except it prints the message just once.
65  * Return true when it prints, false otherwise.
66  */
67 #define warn_report_once(fmt, ...)                      \
68     ({                                                  \
69         static bool print_once_;                        \
70         warn_report_once_cond(&print_once_,             \
71                               fmt, ##__VA_ARGS__);      \
72     })
73 
74 const char *error_get_progname(void);
75 extern bool enable_timestamp_msg;
76 
77 #endif
78