sq_quote_argv: drop maxlen parameter
[git/git.git] / trace.c
CommitLineData
6ce4e61f
CC
1/*
2 * GIT - The information manager from hell
3 *
4 * Copyright (C) 2000-2002 Michael R. Elkins <me@mutt.org>
5 * Copyright (C) 2002-2004 Oswald Buddenhagen <ossi@users.sf.net>
6 * Copyright (C) 2004 Theodore Y. Ts'o <tytso@mit.edu>
7 * Copyright (C) 2006 Mike McCormack
8 * Copyright (C) 2006 Christian Couder
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
48425792 21 * along with this program; if not, see <http://www.gnu.org/licenses/>.
6ce4e61f
CC
22 */
23
24#include "cache.h"
25#include "quote.h"
26
406102a7 27struct trace_key trace_default_key = { "GIT_TRACE", 0, 0, 0 };
8eeb25c6 28struct trace_key trace_perf_key = TRACE_KEY_INIT(PERFORMANCE);
c81539b5 29
06796607 30/* Get a trace file descriptor from "key" env variable. */
6aa30857 31static int get_trace_fd(struct trace_key *key)
6ce4e61f 32{
6aa30857
KB
33 const char *trace;
34
6aa30857
KB
35 /* don't open twice */
36 if (key->initialized)
37 return key->fd;
38
39 trace = getenv(key->key);
6ce4e61f 40
6844fc80
CC
41 if (!trace || !strcmp(trace, "") ||
42 !strcmp(trace, "0") || !strcasecmp(trace, "false"))
6aa30857
KB
43 key->fd = 0;
44 else if (!strcmp(trace, "1") || !strcasecmp(trace, "true"))
45 key->fd = STDERR_FILENO;
46 else if (strlen(trace) == 1 && isdigit(*trace))
47 key->fd = atoi(trace);
48 else if (is_absolute_path(trace)) {
6ce4e61f
CC
49 int fd = open(trace, O_WRONLY | O_APPEND | O_CREAT, 0666);
50 if (fd == -1) {
6f253057 51 warning("could not open '%s' for tracing: %s",
6ce4e61f 52 trace, strerror(errno));
6f253057 53 trace_disable(key);
6aa30857
KB
54 } else {
55 key->fd = fd;
56 key->need_close = 1;
6ce4e61f 57 }
6aa30857 58 } else {
b3a1c5da
JK
59 warning("unknown trace value for '%s': %s\n"
60 " If you want to trace into a file, then please set %s\n"
6f253057 61 " to an absolute pathname (starting with /)",
b3a1c5da 62 key->key, trace, key->key);
6f253057 63 trace_disable(key);
6ce4e61f
CC
64 }
65
6aa30857
KB
66 key->initialized = 1;
67 return key->fd;
68}
6ce4e61f 69
6aa30857
KB
70void trace_disable(struct trace_key *key)
71{
72 if (key->need_close)
73 close(key->fd);
74 key->fd = 0;
75 key->initialized = 1;
76 key->need_close = 0;
6ce4e61f
CC
77}
78
e05bed96
KB
79static int prepare_trace_line(const char *file, int line,
80 struct trace_key *key, struct strbuf *buf)
c69dfd24 81{
124647c4 82 static struct trace_key trace_bare = TRACE_KEY_INIT(BARE);
b72be02c
KB
83 struct timeval tv;
84 struct tm tm;
85 time_t secs;
124647c4 86
c69dfd24
KB
87 if (!trace_want(key))
88 return 0;
89
90 set_try_to_free_routine(NULL); /* is never reset */
91
124647c4
KB
92 /* unit tests may want to disable additional trace output */
93 if (trace_want(&trace_bare))
94 return 1;
95
b72be02c
KB
96 /* print current timestamp */
97 gettimeofday(&tv, NULL);
98 secs = tv.tv_sec;
99 localtime_r(&secs, &tm);
100 strbuf_addf(buf, "%02d:%02d:%02d.%06ld ", tm.tm_hour, tm.tm_min,
101 tm.tm_sec, (long) tv.tv_usec);
c69dfd24 102
e05bed96
KB
103#ifdef HAVE_VARIADIC_MACROS
104 /* print file:line */
105 strbuf_addf(buf, "%s:%d ", file, line);
106 /* align trace output (column 40 catches most files names in git) */
107 while (buf->len < 40)
108 strbuf_addch(buf, ' ');
109#endif
110
c69dfd24
KB
111 return 1;
112}
113
c0222e76
JK
114static void trace_write(struct trace_key *key, const void *buf, unsigned len)
115{
3b0c3ab7 116 if (write_in_full(get_trace_fd(key), buf, len) < 0) {
3b0c3ab7
JK
117 warning("unable to write trace for %s: %s",
118 key->key, strerror(errno));
46ac74b7 119 trace_disable(key);
3b0c3ab7 120 }
c0222e76
JK
121}
122
32359838
JK
123void trace_verbatim(struct trace_key *key, const void *buf, unsigned len)
124{
125 if (!trace_want(key))
126 return;
c0222e76 127 trace_write(key, buf, len);
32359838
JK
128}
129
c69dfd24
KB
130static void print_trace_line(struct trace_key *key, struct strbuf *buf)
131{
a0d4923d 132 strbuf_complete_line(buf);
c0222e76 133 trace_write(key, buf->buf, buf->len);
c69dfd24
KB
134 strbuf_release(buf);
135}
136
e05bed96
KB
137static void trace_vprintf_fl(const char *file, int line, struct trace_key *key,
138 const char *format, va_list ap)
6ce4e61f 139{
ebeb6090 140 struct strbuf buf = STRBUF_INIT;
6ce4e61f 141
e05bed96 142 if (!prepare_trace_line(file, line, key, &buf))
6ce4e61f
CC
143 return;
144
4a3b0b25 145 strbuf_vaddf(&buf, format, ap);
c69dfd24 146 print_trace_line(key, &buf);
6ce4e61f
CC
147}
148
e05bed96
KB
149static void trace_argv_vprintf_fl(const char *file, int line,
150 const char **argv, const char *format,
151 va_list ap)
06796607 152{
66f66c59 153 struct strbuf buf = STRBUF_INIT;
06796607 154
406102a7 155 if (!prepare_trace_line(file, line, &trace_default_key, &buf))
66f66c59
KB
156 return;
157
66f66c59 158 strbuf_vaddf(&buf, format, ap);
66f66c59 159
e35f11c2 160 sq_quote_argv(&buf, argv);
406102a7 161 print_trace_line(&trace_default_key, &buf);
c6053543
JK
162}
163
e05bed96
KB
164void trace_strbuf_fl(const char *file, int line, struct trace_key *key,
165 const struct strbuf *data)
94b3b374 166{
c69dfd24
KB
167 struct strbuf buf = STRBUF_INIT;
168
e05bed96 169 if (!prepare_trace_line(file, line, key, &buf))
94b3b374
JK
170 return;
171
c69dfd24
KB
172 strbuf_addbuf(&buf, data);
173 print_trace_line(key, &buf);
94b3b374
JK
174}
175
09b2c1c7
KB
176static void trace_performance_vprintf_fl(const char *file, int line,
177 uint64_t nanos, const char *format,
178 va_list ap)
179{
180 struct strbuf buf = STRBUF_INIT;
181
182 if (!prepare_trace_line(file, line, &trace_perf_key, &buf))
183 return;
184
185 strbuf_addf(&buf, "performance: %.9f s", (double) nanos / 1000000000);
186
187 if (format && *format) {
188 strbuf_addstr(&buf, ": ");
189 strbuf_vaddf(&buf, format, ap);
190 }
191
192 print_trace_line(&trace_perf_key, &buf);
193}
194
e05bed96
KB
195#ifndef HAVE_VARIADIC_MACROS
196
66f66c59 197void trace_printf(const char *format, ...)
6ce4e61f 198{
19247e55 199 va_list ap;
4a3b0b25 200 va_start(ap, format);
406102a7 201 trace_vprintf_fl(NULL, 0, &trace_default_key, format, ap);
19247e55 202 va_end(ap);
66f66c59 203}
6ce4e61f 204
66f66c59
KB
205void trace_printf_key(struct trace_key *key, const char *format, ...)
206{
207 va_list ap;
208 va_start(ap, format);
e05bed96
KB
209 trace_vprintf_fl(NULL, 0, key, format, ap);
210 va_end(ap);
211}
212
213void trace_argv_printf(const char **argv, const char *format, ...)
214{
215 va_list ap;
216 va_start(ap, format);
217 trace_argv_vprintf_fl(NULL, 0, argv, format, ap);
66f66c59 218 va_end(ap);
6ce4e61f 219}
a9ca8a85 220
792a646a 221void trace_strbuf(struct trace_key *key, const struct strbuf *data)
e05bed96
KB
222{
223 trace_strbuf_fl(NULL, 0, key, data);
224}
225
09b2c1c7
KB
226void trace_performance(uint64_t nanos, const char *format, ...)
227{
228 va_list ap;
229 va_start(ap, format);
230 trace_performance_vprintf_fl(NULL, 0, nanos, format, ap);
231 va_end(ap);
232}
233
234void trace_performance_since(uint64_t start, const char *format, ...)
235{
236 va_list ap;
237 va_start(ap, format);
238 trace_performance_vprintf_fl(NULL, 0, getnanotime() - start,
239 format, ap);
240 va_end(ap);
241}
242
e05bed96
KB
243#else
244
245void trace_printf_key_fl(const char *file, int line, struct trace_key *key,
246 const char *format, ...)
247{
248 va_list ap;
249 va_start(ap, format);
250 trace_vprintf_fl(file, line, key, format, ap);
251 va_end(ap);
252}
253
254void trace_argv_printf_fl(const char *file, int line, const char **argv,
255 const char *format, ...)
256{
257 va_list ap;
258 va_start(ap, format);
259 trace_argv_vprintf_fl(file, line, argv, format, ap);
260 va_end(ap);
261}
262
09b2c1c7
KB
263void trace_performance_fl(const char *file, int line, uint64_t nanos,
264 const char *format, ...)
265{
266 va_list ap;
267 va_start(ap, format);
268 trace_performance_vprintf_fl(file, line, nanos, format, ap);
269 va_end(ap);
270}
271
e05bed96
KB
272#endif /* HAVE_VARIADIC_MACROS */
273
274
a9ca8a85
NTND
275static const char *quote_crnl(const char *path)
276{
0bb443fd 277 static struct strbuf new_path = STRBUF_INIT;
a9ca8a85
NTND
278
279 if (!path)
280 return NULL;
281
0bb443fd
JK
282 strbuf_reset(&new_path);
283
284 while (*path) {
285 switch (*path) {
286 case '\\': strbuf_addstr(&new_path, "\\\\"); break;
287 case '\n': strbuf_addstr(&new_path, "\\n"); break;
288 case '\r': strbuf_addstr(&new_path, "\\r"); break;
a9ca8a85 289 default:
0bb443fd 290 strbuf_addch(&new_path, *path);
a9ca8a85 291 }
0bb443fd 292 path++;
a9ca8a85 293 }
0bb443fd 294 return new_path.buf;
a9ca8a85
NTND
295}
296
297/* FIXME: move prefix to startup_info struct and get rid of this arg */
298void trace_repo_setup(const char *prefix)
299{
6aa30857 300 static struct trace_key key = TRACE_KEY_INIT(SETUP);
e83c267f 301 const char *git_work_tree;
56b9f6e7 302 char *cwd;
a9ca8a85 303
6aa30857 304 if (!trace_want(&key))
a9ca8a85
NTND
305 return;
306
56b9f6e7 307 cwd = xgetcwd();
a9ca8a85 308
e83c267f
BC
309 if (!(git_work_tree = get_git_work_tree()))
310 git_work_tree = "(null)";
311
312 if (!prefix)
313 prefix = "(null)";
314
6aa30857 315 trace_printf_key(&key, "setup: git_dir: %s\n", quote_crnl(get_git_dir()));
31e26ebc 316 trace_printf_key(&key, "setup: git_common_dir: %s\n", quote_crnl(get_git_common_dir()));
6aa30857
KB
317 trace_printf_key(&key, "setup: worktree: %s\n", quote_crnl(git_work_tree));
318 trace_printf_key(&key, "setup: cwd: %s\n", quote_crnl(cwd));
319 trace_printf_key(&key, "setup: prefix: %s\n", quote_crnl(prefix));
56b9f6e7
RS
320
321 free(cwd);
a9ca8a85 322}
39bc5e46 323
6aa30857 324int trace_want(struct trace_key *key)
39bc5e46 325{
6aa30857 326 return !!get_trace_fd(key);
39bc5e46 327}
148d6771 328
a6c3c638 329#if defined(HAVE_CLOCK_GETTIME) && defined(HAVE_CLOCK_MONOTONIC)
148d6771
KB
330
331static inline uint64_t highres_nanos(void)
332{
333 struct timespec ts;
334 if (clock_gettime(CLOCK_MONOTONIC, &ts))
335 return 0;
336 return (uint64_t) ts.tv_sec * 1000000000 + ts.tv_nsec;
337}
338
339#elif defined (GIT_WINDOWS_NATIVE)
340
341static inline uint64_t highres_nanos(void)
342{
343 static uint64_t high_ns, scaled_low_ns;
344 static int scale;
345 LARGE_INTEGER cnt;
346
347 if (!scale) {
348 if (!QueryPerformanceFrequency(&cnt))
349 return 0;
350
351 /* high_ns = number of ns per cnt.HighPart */
352 high_ns = (1000000000LL << 32) / (uint64_t) cnt.QuadPart;
353
354 /*
355 * Number of ns per cnt.LowPart is 10^9 / frequency (or
356 * high_ns >> 32). For maximum precision, we scale this factor
357 * so that it just fits within 32 bit (i.e. won't overflow if
358 * multiplied with cnt.LowPart).
359 */
360 scaled_low_ns = high_ns;
361 scale = 32;
362 while (scaled_low_ns >= 0x100000000LL) {
363 scaled_low_ns >>= 1;
364 scale--;
365 }
366 }
367
368 /* if QPF worked on initialization, we expect QPC to work as well */
369 QueryPerformanceCounter(&cnt);
370
371 return (high_ns * cnt.HighPart) +
372 ((scaled_low_ns * cnt.LowPart) >> scale);
373}
374
375#else
376# define highres_nanos() 0
377#endif
378
379static inline uint64_t gettimeofday_nanos(void)
380{
381 struct timeval tv;
382 gettimeofday(&tv, NULL);
383 return (uint64_t) tv.tv_sec * 1000000000 + tv.tv_usec * 1000;
384}
385
386/*
387 * Returns nanoseconds since the epoch (01/01/1970), for performance tracing
388 * (i.e. favoring high precision over wall clock time accuracy).
389 */
6433d569 390uint64_t getnanotime(void)
148d6771
KB
391{
392 static uint64_t offset;
393 if (offset > 1) {
394 /* initialization succeeded, return offset + high res time */
395 return offset + highres_nanos();
396 } else if (offset == 1) {
397 /* initialization failed, fall back to gettimeofday */
398 return gettimeofday_nanos();
399 } else {
400 /* initialize offset if high resolution timer works */
401 uint64_t now = gettimeofday_nanos();
402 uint64_t highres = highres_nanos();
403 if (highres)
404 offset = now - highres;
405 else
406 offset = 1;
407 return now;
408 }
409}
578da039
KB
410
411static uint64_t command_start_time;
412static struct strbuf command_line = STRBUF_INIT;
413
414static void print_command_performance_atexit(void)
415{
416 trace_performance_since(command_start_time, "git command:%s",
417 command_line.buf);
418}
419
420void trace_command_performance(const char **argv)
421{
422 if (!trace_want(&trace_perf_key))
423 return;
424
425 if (!command_start_time)
426 atexit(print_command_performance_atexit);
427
428 strbuf_reset(&command_line);
e35f11c2 429 sq_quote_argv(&command_line, argv);
578da039
KB
430 command_start_time = getnanotime();
431}