]>
Commit | Line | Data |
---|---|---|
0fcfd160 LT |
1 | /* |
2 | * GIT - The information manager from hell | |
3 | * | |
4 | * Copyright (C) Linus Torvalds, 2005 | |
5 | */ | |
a64acf72 | 6 | #include "git-compat-util.h" |
f394e093 | 7 | #include "gettext.h" |
a64acf72 | 8 | #include "trace2.h" |
d5ebb50d | 9 | #include "wrapper.h" |
0fcfd160 | 10 | |
f5c39c32 | 11 | static void vreportf(const char *prefix, const char *err, va_list params) |
0fcfd160 | 12 | { |
b5a9e435 | 13 | char msg[4096]; |
116d1fa6 JS |
14 | char *p, *pend = msg + sizeof(msg); |
15 | size_t prefix_len = strlen(prefix); | |
f4c3edc0 | 16 | |
116d1fa6 JS |
17 | if (sizeof(msg) <= prefix_len) { |
18 | fprintf(stderr, "BUG!!! too long a prefix '%s'\n", prefix); | |
19 | abort(); | |
20 | } | |
21 | memcpy(msg, prefix, prefix_len); | |
22 | p = msg + prefix_len; | |
23 | if (vsnprintf(p, pend - p, err, params) < 0) | |
24 | *p = '\0'; /* vsnprintf() failed, clip at prefix */ | |
25 | ||
26 | for (; p != pend - 1 && *p; p++) { | |
f2900898 JK |
27 | if (iscntrl(*p) && *p != '\t' && *p != '\n') |
28 | *p = '?'; | |
f4c3edc0 | 29 | } |
116d1fa6 JS |
30 | |
31 | *(p++) = '\n'; /* we no longer need a NUL */ | |
32 | fflush(stderr); | |
33 | write_in_full(2, msg, p - msg); | |
3bc4181f CB |
34 | } |
35 | ||
64b1cb74 | 36 | static NORETURN void usage_builtin(const char *err, va_list params) |
0fcfd160 | 37 | { |
a1fd2cf8 | 38 | vreportf(_("usage: "), err, params); |
ee4512ed JH |
39 | |
40 | /* | |
41 | * When we detect a usage error *before* the command dispatch in | |
42 | * cmd_main(), we don't know what verb to report. Force it to this | |
43 | * to facilitate post-processing. | |
44 | */ | |
45 | trace2_cmd_name("_usage_"); | |
46 | ||
47 | /* | |
48 | * Currently, the (err, params) are usually just the static usage | |
49 | * string which isn't very useful here. Usually, the call site | |
50 | * manually calls fprintf(stderr,...) with the actual detailed | |
51 | * syntax error before calling usage(). | |
52 | * | |
53 | * TODO It would be nice to update the call sites to pass both | |
54 | * the static usage string and the detailed error message. | |
55 | */ | |
56 | ||
5d1a5c02 | 57 | exit(129); |
0fcfd160 LT |
58 | } |
59 | ||
18568ee8 ÆAB |
60 | static void die_message_builtin(const char *err, va_list params) |
61 | { | |
62 | trace2_cmd_error_va(err, params); | |
a1fd2cf8 | 63 | vreportf(_("fatal: "), err, params); |
18568ee8 ÆAB |
64 | } |
65 | ||
c00c7382 ÆAB |
66 | /* |
67 | * We call trace2_cmd_error_va() in the below functions first and | |
68 | * expect it to va_copy 'params' before using it (because an 'ap' can | |
69 | * only be walked once). | |
70 | */ | |
ce88ac5b | 71 | static NORETURN void die_builtin(const char *err, va_list params) |
39a3f5ea | 72 | { |
18568ee8 | 73 | report_fn die_message_fn = get_die_message_routine(); |
ee4512ed | 74 | |
18568ee8 | 75 | die_message_fn(err, params); |
39a3f5ea PB |
76 | exit(128); |
77 | } | |
78 | ||
ce88ac5b | 79 | static void error_builtin(const char *err, va_list params) |
39a3f5ea | 80 | { |
ee4512ed JH |
81 | trace2_cmd_error_va(err, params); |
82 | ||
a1fd2cf8 | 83 | vreportf(_("error: "), err, params); |
39a3f5ea PB |
84 | } |
85 | ||
fa39b6b5 SP |
86 | static void warn_builtin(const char *warn, va_list params) |
87 | { | |
0ee10fd1 JT |
88 | trace2_cmd_error_va(warn, params); |
89 | ||
a1fd2cf8 | 90 | vreportf(_("warning: "), warn, params); |
fa39b6b5 | 91 | } |
39a3f5ea | 92 | |
c19a490e JK |
93 | static int die_is_recursing_builtin(void) |
94 | { | |
95 | static int dying; | |
2d3c02f5 ÆAB |
96 | /* |
97 | * Just an arbitrary number X where "a < x < b" where "a" is | |
98 | * "maximum number of pthreads we'll ever plausibly spawn" and | |
99 | * "b" is "something less than Inf", since the point is to | |
100 | * prevent infinite recursion. | |
101 | */ | |
102 | static const int recursion_limit = 1024; | |
103 | ||
104 | dying++; | |
105 | if (dying > recursion_limit) { | |
106 | return 1; | |
107 | } else if (dying == 2) { | |
108 | warning("die() called many times. Recursion error or racy threaded death!"); | |
109 | return 0; | |
110 | } else { | |
111 | return 0; | |
112 | } | |
c19a490e JK |
113 | } |
114 | ||
39a3f5ea PB |
115 | /* If we are in a dlopen()ed .so write to a global variable would segfault |
116 | * (ugh), so keep things static. */ | |
5710dcce JK |
117 | static NORETURN_PTR report_fn usage_routine = usage_builtin; |
118 | static NORETURN_PTR report_fn die_routine = die_builtin; | |
18568ee8 | 119 | static report_fn die_message_routine = die_message_builtin; |
5710dcce JK |
120 | static report_fn error_routine = error_builtin; |
121 | static report_fn warn_routine = warn_builtin; | |
c19a490e | 122 | static int (*die_is_recursing)(void) = die_is_recursing_builtin; |
39a3f5ea | 123 | |
5710dcce | 124 | void set_die_routine(NORETURN_PTR report_fn routine) |
39a3f5ea PB |
125 | { |
126 | die_routine = routine; | |
127 | } | |
128 | ||
18568ee8 ÆAB |
129 | report_fn get_die_message_routine(void) |
130 | { | |
131 | return die_message_routine; | |
132 | } | |
133 | ||
5710dcce | 134 | void set_error_routine(report_fn routine) |
3bc4181f CB |
135 | { |
136 | error_routine = routine; | |
137 | } | |
138 | ||
5710dcce | 139 | report_fn get_error_routine(void) |
725149be CC |
140 | { |
141 | return error_routine; | |
142 | } | |
143 | ||
5710dcce | 144 | void set_warn_routine(report_fn routine) |
b83f108b CC |
145 | { |
146 | warn_routine = routine; | |
147 | } | |
148 | ||
5710dcce | 149 | report_fn get_warn_routine(void) |
725149be CC |
150 | { |
151 | return warn_routine; | |
152 | } | |
153 | ||
c19a490e JK |
154 | void set_die_is_recursing_routine(int (*routine)(void)) |
155 | { | |
156 | die_is_recursing = routine; | |
157 | } | |
158 | ||
c2e86add | 159 | void NORETURN usagef(const char *err, ...) |
64b1cb74 JN |
160 | { |
161 | va_list params; | |
162 | ||
163 | va_start(params, err); | |
164 | usage_routine(err, params); | |
165 | va_end(params); | |
166 | } | |
167 | ||
c2e86add | 168 | void NORETURN usage(const char *err) |
39a3f5ea | 169 | { |
64b1cb74 | 170 | usagef("%s", err); |
39a3f5ea PB |
171 | } |
172 | ||
c2e86add | 173 | void NORETURN die(const char *err, ...) |
0fcfd160 LT |
174 | { |
175 | va_list params; | |
176 | ||
c19a490e | 177 | if (die_is_recursing()) { |
cd163d4b BC |
178 | fputs("fatal: recursion detected in die handler\n", stderr); |
179 | exit(128); | |
180 | } | |
cd163d4b | 181 | |
0fcfd160 | 182 | va_start(params, err); |
39a3f5ea | 183 | die_routine(err, params); |
0fcfd160 | 184 | va_end(params); |
0fcfd160 LT |
185 | } |
186 | ||
58e4e511 | 187 | static const char *fmt_with_err(char *buf, int n, const char *fmt) |
b875036e | 188 | { |
f8b5a8e1 JH |
189 | char str_error[256], *err; |
190 | int i, j; | |
191 | ||
192 | err = strerror(errno); | |
193 | for (i = j = 0; err[i] && j < sizeof(str_error) - 1; ) { | |
194 | if ((str_error[j++] = err[i++]) != '%') | |
195 | continue; | |
196 | if (j < sizeof(str_error) - 1) { | |
197 | str_error[j++] = '%'; | |
198 | } else { | |
199 | /* No room to double the '%', so we overwrite it with | |
200 | * '\0' below */ | |
201 | j--; | |
202 | break; | |
203 | } | |
204 | } | |
205 | str_error[j] = 0; | |
ac4896f0 | 206 | /* Truncation is acceptable here */ |
58e4e511 NTND |
207 | snprintf(buf, n, "%s: %s", fmt, str_error); |
208 | return buf; | |
209 | } | |
210 | ||
211 | void NORETURN die_errno(const char *fmt, ...) | |
212 | { | |
213 | char buf[1024]; | |
214 | va_list params; | |
215 | ||
216 | if (die_is_recursing()) { | |
217 | fputs("fatal: recursion detected in die_errno handler\n", | |
218 | stderr); | |
219 | exit(128); | |
220 | } | |
b875036e TR |
221 | |
222 | va_start(params, fmt); | |
58e4e511 | 223 | die_routine(fmt_with_err(buf, sizeof(buf), fmt), params); |
b875036e TR |
224 | va_end(params); |
225 | } | |
226 | ||
18568ee8 ÆAB |
227 | #undef die_message |
228 | int die_message(const char *err, ...) | |
229 | { | |
230 | va_list params; | |
231 | ||
232 | va_start(params, err); | |
233 | die_message_routine(err, params); | |
234 | va_end(params); | |
235 | return 128; | |
236 | } | |
237 | ||
24f6e6d6 ÆAB |
238 | #undef die_message_errno |
239 | int die_message_errno(const char *fmt, ...) | |
240 | { | |
241 | char buf[1024]; | |
242 | va_list params; | |
243 | ||
244 | va_start(params, fmt); | |
245 | die_message_routine(fmt_with_err(buf, sizeof(buf), fmt), params); | |
246 | va_end(params); | |
247 | return 128; | |
248 | } | |
249 | ||
4df5e918 | 250 | #undef error_errno |
fd1d6723 NTND |
251 | int error_errno(const char *fmt, ...) |
252 | { | |
253 | char buf[1024]; | |
254 | va_list params; | |
255 | ||
256 | va_start(params, fmt); | |
257 | error_routine(fmt_with_err(buf, sizeof(buf), fmt), params); | |
258 | va_end(params); | |
259 | return -1; | |
260 | } | |
261 | ||
e208f9cc | 262 | #undef error |
0fcfd160 LT |
263 | int error(const char *err, ...) |
264 | { | |
265 | va_list params; | |
266 | ||
267 | va_start(params, err); | |
39a3f5ea | 268 | error_routine(err, params); |
0fcfd160 LT |
269 | va_end(params); |
270 | return -1; | |
271 | } | |
fa39b6b5 | 272 | |
fd1d6723 NTND |
273 | void warning_errno(const char *warn, ...) |
274 | { | |
275 | char buf[1024]; | |
276 | va_list params; | |
277 | ||
278 | va_start(params, warn); | |
279 | warn_routine(fmt_with_err(buf, sizeof(buf), warn), params); | |
280 | va_end(params); | |
281 | } | |
282 | ||
46efd2d9 | 283 | void warning(const char *warn, ...) |
fa39b6b5 SP |
284 | { |
285 | va_list params; | |
286 | ||
287 | va_start(params, warn); | |
288 | warn_routine(warn, params); | |
289 | va_end(params); | |
290 | } | |
d8193743 | 291 | |
a86303cb JS |
292 | /* Only set this, ever, from t/helper/, when verifying that bugs are caught. */ |
293 | int BUG_exit_code; | |
294 | ||
0cc05b04 ÆAB |
295 | static void BUG_vfl_common(const char *file, int line, const char *fmt, |
296 | va_list params) | |
d8193743 JK |
297 | { |
298 | char prefix[256]; | |
299 | ||
300 | /* truncation via snprintf is OK here */ | |
56a29d2c | 301 | snprintf(prefix, sizeof(prefix), "BUG: %s:%d: ", file, line); |
d8193743 JK |
302 | |
303 | vreportf(prefix, fmt, params); | |
0cc05b04 ÆAB |
304 | } |
305 | ||
306 | static NORETURN void BUG_vfl(const char *file, int line, const char *fmt, va_list params) | |
307 | { | |
308 | va_list params_copy; | |
309 | static int in_bug; | |
310 | ||
311 | va_copy(params_copy, params); | |
312 | BUG_vfl_common(file, line, fmt, params); | |
0a9dde4a JT |
313 | |
314 | if (in_bug) | |
315 | abort(); | |
316 | in_bug = 1; | |
317 | ||
318 | trace2_cmd_error_va(fmt, params_copy); | |
319 | ||
a86303cb JS |
320 | if (BUG_exit_code) |
321 | exit(BUG_exit_code); | |
d8193743 JK |
322 | abort(); |
323 | } | |
324 | ||
3d7dd2d3 | 325 | NORETURN void BUG_fl(const char *file, int line, const char *fmt, ...) |
d8193743 JK |
326 | { |
327 | va_list ap; | |
0cc05b04 ÆAB |
328 | |
329 | bug_called_must_BUG = 0; | |
330 | ||
d8193743 JK |
331 | va_start(ap, fmt); |
332 | BUG_vfl(file, line, fmt, ap); | |
333 | va_end(ap); | |
334 | } | |
0e5bba53 | 335 | |
0cc05b04 ÆAB |
336 | int bug_called_must_BUG; |
337 | void bug_fl(const char *file, int line, const char *fmt, ...) | |
338 | { | |
f8535596 | 339 | va_list ap; |
0cc05b04 ÆAB |
340 | |
341 | bug_called_must_BUG = 1; | |
342 | ||
0cc05b04 ÆAB |
343 | va_start(ap, fmt); |
344 | BUG_vfl_common(file, line, fmt, ap); | |
345 | va_end(ap); | |
f8535596 JK |
346 | |
347 | va_start(ap, fmt); | |
348 | trace2_cmd_error_va(fmt, ap); | |
349 | va_end(ap); | |
0cc05b04 ÆAB |
350 | } |
351 | ||
0e5bba53 JK |
352 | #ifdef SUPPRESS_ANNOTATED_LEAKS |
353 | void unleak_memory(const void *ptr, size_t len) | |
354 | { | |
355 | static struct suppressed_leak_root { | |
356 | struct suppressed_leak_root *next; | |
357 | char data[FLEX_ARRAY]; | |
358 | } *suppressed_leaks; | |
359 | struct suppressed_leak_root *root; | |
360 | ||
361 | FLEX_ALLOC_MEM(root, data, ptr, len); | |
362 | root->next = suppressed_leaks; | |
363 | suppressed_leaks = root; | |
364 | } | |
365 | #endif |