]>
Commit | Line | Data |
---|---|---|
0fcfd160 LT |
1 | /* |
2 | * GIT - The information manager from hell | |
3 | * | |
4 | * Copyright (C) Linus Torvalds, 2005 | |
5 | */ | |
4050c0df | 6 | #include "git-compat-util.h" |
3bc4181f | 7 | #include "cache.h" |
0fcfd160 | 8 | |
ebaa79f4 | 9 | void vreportf(const char *prefix, const char *err, va_list params) |
0fcfd160 | 10 | { |
b5a9e435 | 11 | char msg[4096]; |
116d1fa6 JS |
12 | char *p, *pend = msg + sizeof(msg); |
13 | size_t prefix_len = strlen(prefix); | |
f4c3edc0 | 14 | |
116d1fa6 JS |
15 | if (sizeof(msg) <= prefix_len) { |
16 | fprintf(stderr, "BUG!!! too long a prefix '%s'\n", prefix); | |
17 | abort(); | |
18 | } | |
19 | memcpy(msg, prefix, prefix_len); | |
20 | p = msg + prefix_len; | |
21 | if (vsnprintf(p, pend - p, err, params) < 0) | |
22 | *p = '\0'; /* vsnprintf() failed, clip at prefix */ | |
23 | ||
24 | for (; p != pend - 1 && *p; p++) { | |
f2900898 JK |
25 | if (iscntrl(*p) && *p != '\t' && *p != '\n') |
26 | *p = '?'; | |
f4c3edc0 | 27 | } |
116d1fa6 JS |
28 | |
29 | *(p++) = '\n'; /* we no longer need a NUL */ | |
30 | fflush(stderr); | |
31 | write_in_full(2, msg, p - msg); | |
3bc4181f CB |
32 | } |
33 | ||
64b1cb74 | 34 | static NORETURN void usage_builtin(const char *err, va_list params) |
0fcfd160 | 35 | { |
ebaa79f4 | 36 | vreportf("usage: ", err, params); |
ee4512ed JH |
37 | |
38 | /* | |
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. | |
42 | */ | |
43 | trace2_cmd_name("_usage_"); | |
44 | ||
45 | /* | |
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(). | |
50 | * | |
51 | * TODO It would be nice to update the call sites to pass both | |
52 | * the static usage string and the detailed error message. | |
53 | */ | |
54 | ||
5d1a5c02 | 55 | exit(129); |
0fcfd160 LT |
56 | } |
57 | ||
c00c7382 ÆAB |
58 | /* |
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). | |
62 | */ | |
ce88ac5b | 63 | static NORETURN void die_builtin(const char *err, va_list params) |
39a3f5ea | 64 | { |
ee4512ed JH |
65 | trace2_cmd_error_va(err, params); |
66 | ||
ebaa79f4 | 67 | vreportf("fatal: ", err, params); |
ee4512ed | 68 | |
39a3f5ea PB |
69 | exit(128); |
70 | } | |
71 | ||
ce88ac5b | 72 | static void error_builtin(const char *err, va_list params) |
39a3f5ea | 73 | { |
ee4512ed JH |
74 | trace2_cmd_error_va(err, params); |
75 | ||
ebaa79f4 | 76 | vreportf("error: ", err, params); |
39a3f5ea PB |
77 | } |
78 | ||
fa39b6b5 SP |
79 | static void warn_builtin(const char *warn, va_list params) |
80 | { | |
0ee10fd1 JT |
81 | trace2_cmd_error_va(warn, params); |
82 | ||
ebaa79f4 | 83 | vreportf("warning: ", warn, params); |
fa39b6b5 | 84 | } |
39a3f5ea | 85 | |
c19a490e JK |
86 | static int die_is_recursing_builtin(void) |
87 | { | |
88 | static int dying; | |
2d3c02f5 ÆAB |
89 | /* |
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. | |
94 | */ | |
95 | static const int recursion_limit = 1024; | |
96 | ||
97 | dying++; | |
98 | if (dying > recursion_limit) { | |
99 | return 1; | |
100 | } else if (dying == 2) { | |
101 | warning("die() called many times. Recursion error or racy threaded death!"); | |
102 | return 0; | |
103 | } else { | |
104 | return 0; | |
105 | } | |
c19a490e JK |
106 | } |
107 | ||
39a3f5ea PB |
108 | /* If we are in a dlopen()ed .so write to a global variable would segfault |
109 | * (ugh), so keep things static. */ | |
5710dcce JK |
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; | |
c19a490e | 114 | static int (*die_is_recursing)(void) = die_is_recursing_builtin; |
39a3f5ea | 115 | |
5710dcce | 116 | void set_die_routine(NORETURN_PTR report_fn routine) |
39a3f5ea PB |
117 | { |
118 | die_routine = routine; | |
119 | } | |
120 | ||
5710dcce | 121 | void set_error_routine(report_fn routine) |
3bc4181f CB |
122 | { |
123 | error_routine = routine; | |
124 | } | |
125 | ||
5710dcce | 126 | report_fn get_error_routine(void) |
725149be CC |
127 | { |
128 | return error_routine; | |
129 | } | |
130 | ||
5710dcce | 131 | void set_warn_routine(report_fn routine) |
b83f108b CC |
132 | { |
133 | warn_routine = routine; | |
134 | } | |
135 | ||
5710dcce | 136 | report_fn get_warn_routine(void) |
725149be CC |
137 | { |
138 | return warn_routine; | |
139 | } | |
140 | ||
c19a490e JK |
141 | void set_die_is_recursing_routine(int (*routine)(void)) |
142 | { | |
143 | die_is_recursing = routine; | |
144 | } | |
145 | ||
c2e86add | 146 | void NORETURN usagef(const char *err, ...) |
64b1cb74 JN |
147 | { |
148 | va_list params; | |
149 | ||
150 | va_start(params, err); | |
151 | usage_routine(err, params); | |
152 | va_end(params); | |
153 | } | |
154 | ||
c2e86add | 155 | void NORETURN usage(const char *err) |
39a3f5ea | 156 | { |
64b1cb74 | 157 | usagef("%s", err); |
39a3f5ea PB |
158 | } |
159 | ||
c2e86add | 160 | void NORETURN die(const char *err, ...) |
0fcfd160 LT |
161 | { |
162 | va_list params; | |
163 | ||
c19a490e | 164 | if (die_is_recursing()) { |
cd163d4b BC |
165 | fputs("fatal: recursion detected in die handler\n", stderr); |
166 | exit(128); | |
167 | } | |
cd163d4b | 168 | |
0fcfd160 | 169 | va_start(params, err); |
39a3f5ea | 170 | die_routine(err, params); |
0fcfd160 | 171 | va_end(params); |
0fcfd160 LT |
172 | } |
173 | ||
58e4e511 | 174 | static const char *fmt_with_err(char *buf, int n, const char *fmt) |
b875036e | 175 | { |
f8b5a8e1 JH |
176 | char str_error[256], *err; |
177 | int i, j; | |
178 | ||
179 | err = strerror(errno); | |
180 | for (i = j = 0; err[i] && j < sizeof(str_error) - 1; ) { | |
181 | if ((str_error[j++] = err[i++]) != '%') | |
182 | continue; | |
183 | if (j < sizeof(str_error) - 1) { | |
184 | str_error[j++] = '%'; | |
185 | } else { | |
186 | /* No room to double the '%', so we overwrite it with | |
187 | * '\0' below */ | |
188 | j--; | |
189 | break; | |
190 | } | |
191 | } | |
192 | str_error[j] = 0; | |
ac4896f0 | 193 | /* Truncation is acceptable here */ |
58e4e511 NTND |
194 | snprintf(buf, n, "%s: %s", fmt, str_error); |
195 | return buf; | |
196 | } | |
197 | ||
198 | void NORETURN die_errno(const char *fmt, ...) | |
199 | { | |
200 | char buf[1024]; | |
201 | va_list params; | |
202 | ||
203 | if (die_is_recursing()) { | |
204 | fputs("fatal: recursion detected in die_errno handler\n", | |
205 | stderr); | |
206 | exit(128); | |
207 | } | |
b875036e TR |
208 | |
209 | va_start(params, fmt); | |
58e4e511 | 210 | die_routine(fmt_with_err(buf, sizeof(buf), fmt), params); |
b875036e TR |
211 | va_end(params); |
212 | } | |
213 | ||
4df5e918 | 214 | #undef error_errno |
fd1d6723 NTND |
215 | int error_errno(const char *fmt, ...) |
216 | { | |
217 | char buf[1024]; | |
218 | va_list params; | |
219 | ||
220 | va_start(params, fmt); | |
221 | error_routine(fmt_with_err(buf, sizeof(buf), fmt), params); | |
222 | va_end(params); | |
223 | return -1; | |
224 | } | |
225 | ||
e208f9cc | 226 | #undef error |
0fcfd160 LT |
227 | int error(const char *err, ...) |
228 | { | |
229 | va_list params; | |
230 | ||
231 | va_start(params, err); | |
39a3f5ea | 232 | error_routine(err, params); |
0fcfd160 LT |
233 | va_end(params); |
234 | return -1; | |
235 | } | |
fa39b6b5 | 236 | |
fd1d6723 NTND |
237 | void warning_errno(const char *warn, ...) |
238 | { | |
239 | char buf[1024]; | |
240 | va_list params; | |
241 | ||
242 | va_start(params, warn); | |
243 | warn_routine(fmt_with_err(buf, sizeof(buf), warn), params); | |
244 | va_end(params); | |
245 | } | |
246 | ||
46efd2d9 | 247 | void warning(const char *warn, ...) |
fa39b6b5 SP |
248 | { |
249 | va_list params; | |
250 | ||
251 | va_start(params, warn); | |
252 | warn_routine(warn, params); | |
253 | va_end(params); | |
254 | } | |
d8193743 | 255 | |
a86303cb JS |
256 | /* Only set this, ever, from t/helper/, when verifying that bugs are caught. */ |
257 | int BUG_exit_code; | |
258 | ||
d8193743 JK |
259 | static NORETURN void BUG_vfl(const char *file, int line, const char *fmt, va_list params) |
260 | { | |
261 | char prefix[256]; | |
0a9dde4a JT |
262 | va_list params_copy; |
263 | static int in_bug; | |
264 | ||
265 | va_copy(params_copy, params); | |
d8193743 JK |
266 | |
267 | /* truncation via snprintf is OK here */ | |
268 | if (file) | |
269 | snprintf(prefix, sizeof(prefix), "BUG: %s:%d: ", file, line); | |
270 | else | |
271 | snprintf(prefix, sizeof(prefix), "BUG: "); | |
272 | ||
273 | vreportf(prefix, fmt, params); | |
0a9dde4a JT |
274 | |
275 | if (in_bug) | |
276 | abort(); | |
277 | in_bug = 1; | |
278 | ||
279 | trace2_cmd_error_va(fmt, params_copy); | |
280 | ||
a86303cb JS |
281 | if (BUG_exit_code) |
282 | exit(BUG_exit_code); | |
d8193743 JK |
283 | abort(); |
284 | } | |
285 | ||
286 | #ifdef HAVE_VARIADIC_MACROS | |
3d7dd2d3 | 287 | NORETURN void BUG_fl(const char *file, int line, const char *fmt, ...) |
d8193743 JK |
288 | { |
289 | va_list ap; | |
290 | va_start(ap, fmt); | |
291 | BUG_vfl(file, line, fmt, ap); | |
292 | va_end(ap); | |
293 | } | |
294 | #else | |
3d7dd2d3 | 295 | NORETURN void BUG(const char *fmt, ...) |
d8193743 JK |
296 | { |
297 | va_list ap; | |
298 | va_start(ap, fmt); | |
299 | BUG_vfl(NULL, 0, fmt, ap); | |
300 | va_end(ap); | |
301 | } | |
302 | #endif | |
0e5bba53 JK |
303 | |
304 | #ifdef SUPPRESS_ANNOTATED_LEAKS | |
305 | void unleak_memory(const void *ptr, size_t len) | |
306 | { | |
307 | static struct suppressed_leak_root { | |
308 | struct suppressed_leak_root *next; | |
309 | char data[FLEX_ARRAY]; | |
310 | } *suppressed_leaks; | |
311 | struct suppressed_leak_root *root; | |
312 | ||
313 | FLEX_ALLOC_MEM(root, data, ptr, len); | |
314 | root->next = suppressed_leaks; | |
315 | suppressed_leaks = root; | |
316 | } | |
317 | #endif |