2 * GIT - The information manager from hell
4 * Copyright (C) Linus Torvalds, 2005
6 #include "git-compat-util.h"
9 void vreportf(const char *prefix, const char *err, va_list params)
12 char *p, *pend = msg + sizeof(msg);
13 size_t prefix_len = strlen(prefix);
15 if (sizeof(msg) <= prefix_len) {
16 fprintf(stderr, "BUG!!! too long a prefix '%s'\n", prefix);
19 memcpy(msg, prefix, prefix_len);
21 if (vsnprintf(p, pend - p, err, params) < 0)
22 *p = '\0'; /* vsnprintf() failed, clip at prefix */
24 for (; p != pend - 1 && *p; p++) {
25 if (iscntrl(*p) && *p != '\t' && *p != '\n')
29 *(p++) = '\n'; /* we no longer need a NUL */
31 write_in_full(2, msg, p - msg);
34 static NORETURN void usage_builtin(const char *err, va_list params)
36 vreportf("usage: ", err, params);
39 * When we detect a usage error *before* the command dispatch in
40 * cmd_main(), we don't know what verb to report. Force it to this
41 * to facilitate post-processing.
43 trace2_cmd_name("_usage_");
46 * Currently, the (err, params) are usually just the static usage
47 * string which isn't very useful here. Usually, the call site
48 * manually calls fprintf(stderr,...) with the actual detailed
49 * syntax error before calling usage().
51 * TODO It would be nice to update the call sites to pass both
52 * the static usage string and the detailed error message.
59 * We call trace2_cmd_error_va() in the below functions first and
60 * expect it to va_copy 'params' before using it (because an 'ap' can
61 * only be walked once).
63 static NORETURN void die_builtin(const char *err, va_list params)
65 trace2_cmd_error_va(err, params);
67 vreportf("fatal: ", err, params);
72 static void error_builtin(const char *err, va_list params)
74 trace2_cmd_error_va(err, params);
76 vreportf("error: ", err, params);
79 static void warn_builtin(const char *warn, va_list params)
81 trace2_cmd_error_va(warn, params);
83 vreportf("warning: ", warn, params);
86 static int die_is_recursing_builtin(void)
90 * Just an arbitrary number X where "a < x < b" where "a" is
91 * "maximum number of pthreads we'll ever plausibly spawn" and
92 * "b" is "something less than Inf", since the point is to
93 * prevent infinite recursion.
95 static const int recursion_limit = 1024;
98 if (dying > recursion_limit) {
100 } else if (dying == 2) {
101 warning("die() called many times. Recursion error or racy threaded death!");
108 /* If we are in a dlopen()ed .so write to a global variable would segfault
109 * (ugh), so keep things static. */
110 static NORETURN_PTR report_fn usage_routine = usage_builtin;
111 static NORETURN_PTR report_fn die_routine = die_builtin;
112 static report_fn error_routine = error_builtin;
113 static report_fn warn_routine = warn_builtin;
114 static int (*die_is_recursing)(void) = die_is_recursing_builtin;
116 void set_die_routine(NORETURN_PTR report_fn routine)
118 die_routine = routine;
121 void set_error_routine(report_fn routine)
123 error_routine = routine;
126 report_fn get_error_routine(void)
128 return error_routine;
131 void set_warn_routine(report_fn routine)
133 warn_routine = routine;
136 report_fn get_warn_routine(void)
141 void set_die_is_recursing_routine(int (*routine)(void))
143 die_is_recursing = routine;
146 void NORETURN usagef(const char *err, ...)
150 va_start(params, err);
151 usage_routine(err, params);
155 void NORETURN usage(const char *err)
160 void NORETURN die(const char *err, ...)
164 if (die_is_recursing()) {
165 fputs("fatal: recursion detected in die handler\n", stderr);
169 va_start(params, err);
170 die_routine(err, params);
174 static const char *fmt_with_err(char *buf, int n, const char *fmt)
176 char str_error[256], *err;
179 err = strerror(errno);
180 for (i = j = 0; err[i] && j < sizeof(str_error) - 1; ) {
181 if ((str_error[j++] = err[i++]) != '%')
183 if (j < sizeof(str_error) - 1) {
184 str_error[j++] = '%';
186 /* No room to double the '%', so we overwrite it with
193 /* Truncation is acceptable here */
194 snprintf(buf, n, "%s: %s", fmt, str_error);
198 void NORETURN die_errno(const char *fmt, ...)
203 if (die_is_recursing()) {
204 fputs("fatal: recursion detected in die_errno handler\n",
209 va_start(params, fmt);
210 die_routine(fmt_with_err(buf, sizeof(buf), fmt), params);
215 int error_errno(const char *fmt, ...)
220 va_start(params, fmt);
221 error_routine(fmt_with_err(buf, sizeof(buf), fmt), params);
227 int error(const char *err, ...)
231 va_start(params, err);
232 error_routine(err, params);
237 void warning_errno(const char *warn, ...)
242 va_start(params, warn);
243 warn_routine(fmt_with_err(buf, sizeof(buf), warn), params);
247 void warning(const char *warn, ...)
251 va_start(params, warn);
252 warn_routine(warn, params);
256 /* Only set this, ever, from t/helper/, when verifying that bugs are caught. */
259 static NORETURN void BUG_vfl(const char *file, int line, const char *fmt, va_list params)
265 va_copy(params_copy, params);
267 /* truncation via snprintf is OK here */
269 snprintf(prefix, sizeof(prefix), "BUG: %s:%d: ", file, line);
271 snprintf(prefix, sizeof(prefix), "BUG: ");
273 vreportf(prefix, fmt, params);
279 trace2_cmd_error_va(fmt, params_copy);
286 #ifdef HAVE_VARIADIC_MACROS
287 NORETURN void BUG_fl(const char *file, int line, const char *fmt, ...)
291 BUG_vfl(file, line, fmt, ap);
295 NORETURN void BUG(const char *fmt, ...)
299 BUG_vfl(NULL, 0, fmt, ap);
304 #ifdef SUPPRESS_ANNOTATED_LEAKS
305 void unleak_memory(const void *ptr, size_t len)
307 static struct suppressed_leak_root {
308 struct suppressed_leak_root *next;
309 char data[FLEX_ARRAY];
311 struct suppressed_leak_root *root;
313 FLEX_ALLOC_MEM(root, data, ptr, len);
314 root->next = suppressed_leaks;
315 suppressed_leaks = root;