qga: replace deprecated g_get_current_time()
[qemu.git] / util / qemu-error.c
blob7769aee8e791053383f9477df7b8c0594cc1f78f
1 /*
2 * Error reporting
4 * Copyright (C) 2010 Red Hat Inc.
6 * Authors:
7 * Markus Armbruster <armbru@redhat.com>,
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.
13 #include "qemu/osdep.h"
14 #include "monitor/monitor.h"
15 #include "qemu/error-report.h"
18 * @report_type is the type of message: error, warning or
19 * informational.
21 typedef enum {
22 REPORT_TYPE_ERROR,
23 REPORT_TYPE_WARNING,
24 REPORT_TYPE_INFO,
25 } report_type;
27 /* Prepend timestamp to messages */
28 bool message_with_timestamp;
29 bool error_with_guestname;
30 const char *error_guest_name;
32 int error_printf(const char *fmt, ...)
34 va_list ap;
35 int ret;
37 va_start(ap, fmt);
38 ret = error_vprintf(fmt, ap);
39 va_end(ap);
40 return ret;
43 int error_printf_unless_qmp(const char *fmt, ...)
45 va_list ap;
46 int ret;
48 va_start(ap, fmt);
49 ret = error_vprintf_unless_qmp(fmt, ap);
50 va_end(ap);
51 return ret;
54 static Location std_loc = {
55 .kind = LOC_NONE
57 static Location *cur_loc = &std_loc;
60 * Push location saved in LOC onto the location stack, return it.
61 * The top of that stack is the current location.
62 * Needs a matching loc_pop().
64 Location *loc_push_restore(Location *loc)
66 assert(!loc->prev);
67 loc->prev = cur_loc;
68 cur_loc = loc;
69 return loc;
73 * Initialize *LOC to "nowhere", push it onto the location stack.
74 * The top of that stack is the current location.
75 * Needs a matching loc_pop().
76 * Return LOC.
78 Location *loc_push_none(Location *loc)
80 loc->kind = LOC_NONE;
81 loc->prev = NULL;
82 return loc_push_restore(loc);
86 * Pop the location stack.
87 * LOC must be the current location, i.e. the top of the stack.
89 Location *loc_pop(Location *loc)
91 assert(cur_loc == loc && loc->prev);
92 cur_loc = loc->prev;
93 loc->prev = NULL;
94 return loc;
98 * Save the current location in LOC, return LOC.
100 Location *loc_save(Location *loc)
102 *loc = *cur_loc;
103 loc->prev = NULL;
104 return loc;
108 * Change the current location to the one saved in LOC.
110 void loc_restore(Location *loc)
112 Location *prev = cur_loc->prev;
113 assert(!loc->prev);
114 *cur_loc = *loc;
115 cur_loc->prev = prev;
119 * Change the current location to "nowhere in particular".
121 void loc_set_none(void)
123 cur_loc->kind = LOC_NONE;
127 * Change the current location to argument ARGV[IDX..IDX+CNT-1].
129 void loc_set_cmdline(char **argv, int idx, int cnt)
131 cur_loc->kind = LOC_CMDLINE;
132 cur_loc->num = cnt;
133 cur_loc->ptr = argv + idx;
137 * Change the current location to file FNAME, line LNO.
139 void loc_set_file(const char *fname, int lno)
141 assert (fname || cur_loc->kind == LOC_FILE);
142 cur_loc->kind = LOC_FILE;
143 cur_loc->num = lno;
144 if (fname) {
145 cur_loc->ptr = fname;
150 * Print current location to current monitor if we have one, else to stderr.
152 static void print_loc(void)
154 const char *sep = "";
155 int i;
156 const char *const *argp;
158 if (!monitor_cur() && g_get_prgname()) {
159 fprintf(stderr, "%s:", g_get_prgname());
160 sep = " ";
162 switch (cur_loc->kind) {
163 case LOC_CMDLINE:
164 argp = cur_loc->ptr;
165 for (i = 0; i < cur_loc->num; i++) {
166 error_printf("%s%s", sep, argp[i]);
167 sep = " ";
169 error_printf(": ");
170 break;
171 case LOC_FILE:
172 error_printf("%s:", (const char *)cur_loc->ptr);
173 if (cur_loc->num) {
174 error_printf("%d:", cur_loc->num);
176 error_printf(" ");
177 break;
178 default:
179 error_printf("%s", sep);
184 * Print a message to current monitor if we have one, else to stderr.
185 * @report_type is the type of message: error, warning or informational.
186 * Format arguments like vsprintf(). The resulting message should be
187 * a single phrase, with no newline or trailing punctuation.
188 * Prepend the current location and append a newline.
190 static void vreport(report_type type, const char *fmt, va_list ap)
192 GTimeVal tv;
193 gchar *timestr;
195 if (message_with_timestamp && !monitor_cur()) {
196 g_get_current_time(&tv);
197 timestr = g_time_val_to_iso8601(&tv);
198 error_printf("%s ", timestr);
199 g_free(timestr);
202 /* Only prepend guest name if -msg guest-name and -name guest=... are set */
203 if (error_with_guestname && error_guest_name && !monitor_cur()) {
204 error_printf("%s ", error_guest_name);
207 print_loc();
209 switch (type) {
210 case REPORT_TYPE_ERROR:
211 break;
212 case REPORT_TYPE_WARNING:
213 error_printf("warning: ");
214 break;
215 case REPORT_TYPE_INFO:
216 error_printf("info: ");
217 break;
220 error_vprintf(fmt, ap);
221 error_printf("\n");
225 * Print an error message to current monitor if we have one, else to stderr.
226 * Format arguments like vsprintf(). The resulting message should be
227 * a single phrase, with no newline or trailing punctuation.
228 * Prepend the current location and append a newline.
229 * It's wrong to call this in a QMP monitor. Use error_setg() there.
231 void error_vreport(const char *fmt, va_list ap)
233 vreport(REPORT_TYPE_ERROR, fmt, ap);
237 * Print a warning message to current monitor if we have one, else to stderr.
238 * Format arguments like vsprintf(). The resulting message should be
239 * a single phrase, with no newline or trailing punctuation.
240 * Prepend the current location and append a newline.
242 void warn_vreport(const char *fmt, va_list ap)
244 vreport(REPORT_TYPE_WARNING, fmt, ap);
248 * Print an information message to current monitor if we have one, else to
249 * stderr.
250 * Format arguments like vsprintf(). The resulting message should be
251 * a single phrase, with no newline or trailing punctuation.
252 * Prepend the current location and append a newline.
254 void info_vreport(const char *fmt, va_list ap)
256 vreport(REPORT_TYPE_INFO, fmt, ap);
260 * Print an error message to current monitor if we have one, else to stderr.
261 * Format arguments like sprintf(). The resulting message should be
262 * a single phrase, with no newline or trailing punctuation.
263 * Prepend the current location and append a newline.
264 * It's wrong to call this in a QMP monitor. Use error_setg() there.
266 void error_report(const char *fmt, ...)
268 va_list ap;
270 va_start(ap, fmt);
271 vreport(REPORT_TYPE_ERROR, fmt, ap);
272 va_end(ap);
276 * Print a warning message to current monitor if we have one, else to stderr.
277 * Format arguments like sprintf(). The resulting message should be a
278 * single phrase, with no newline or trailing punctuation.
279 * Prepend the current location and append a newline.
281 void warn_report(const char *fmt, ...)
283 va_list ap;
285 va_start(ap, fmt);
286 vreport(REPORT_TYPE_WARNING, fmt, ap);
287 va_end(ap);
291 * Print an information message to current monitor if we have one, else to
292 * stderr.
293 * Format arguments like sprintf(). The resulting message should be a
294 * single phrase, with no newline or trailing punctuation.
295 * Prepend the current location and append a newline.
297 void info_report(const char *fmt, ...)
299 va_list ap;
301 va_start(ap, fmt);
302 vreport(REPORT_TYPE_INFO, fmt, ap);
303 va_end(ap);
307 * Like error_report(), except print just once.
308 * If *printed is false, print the message, and flip *printed to true.
309 * Return whether the message was printed.
311 bool error_report_once_cond(bool *printed, const char *fmt, ...)
313 va_list ap;
315 assert(printed);
316 if (*printed) {
317 return false;
319 *printed = true;
320 va_start(ap, fmt);
321 vreport(REPORT_TYPE_ERROR, fmt, ap);
322 va_end(ap);
323 return true;
327 * Like warn_report(), except print just once.
328 * If *printed is false, print the message, and flip *printed to true.
329 * Return whether the message was printed.
331 bool warn_report_once_cond(bool *printed, const char *fmt, ...)
333 va_list ap;
335 assert(printed);
336 if (*printed) {
337 return false;
339 *printed = true;
340 va_start(ap, fmt);
341 vreport(REPORT_TYPE_WARNING, fmt, ap);
342 va_end(ap);
343 return true;
346 static char *qemu_glog_domains;
348 static void qemu_log_func(const gchar *log_domain,
349 GLogLevelFlags log_level,
350 const gchar *message,
351 gpointer user_data)
353 switch (log_level & G_LOG_LEVEL_MASK) {
354 case G_LOG_LEVEL_DEBUG:
355 case G_LOG_LEVEL_INFO:
357 * Use same G_MESSAGES_DEBUG logic as glib to enable/disable debug
358 * messages
360 if (qemu_glog_domains == NULL) {
361 break;
363 if (strcmp(qemu_glog_domains, "all") != 0 &&
364 (log_domain == NULL || !strstr(qemu_glog_domains, log_domain))) {
365 break;
367 /* Fall through */
368 case G_LOG_LEVEL_MESSAGE:
369 info_report("%s%s%s",
370 log_domain ?: "", log_domain ? ": " : "", message);
372 break;
373 case G_LOG_LEVEL_WARNING:
374 warn_report("%s%s%s",
375 log_domain ?: "", log_domain ? ": " : "", message);
376 break;
377 case G_LOG_LEVEL_CRITICAL:
378 case G_LOG_LEVEL_ERROR:
379 error_report("%s%s%s",
380 log_domain ?: "", log_domain ? ": " : "", message);
381 break;
385 void error_init(const char *argv0)
387 const char *p = strrchr(argv0, '/');
389 /* Set the program name for error_print_loc(). */
390 g_set_prgname(p ? p + 1 : argv0);
393 * This sets up glib logging so libraries using it also print their logs
394 * through error_report(), warn_report(), info_report().
396 g_log_set_default_handler(qemu_log_func, NULL);
397 g_warn_if_fail(qemu_glog_domains == NULL);
398 qemu_glog_domains = g_strdup(g_getenv("G_MESSAGES_DEBUG"));