git-multimail: update to release 1.2.0
[git.git] / trace.c
blob7393926ebcd95404fe16cdd84e40fd4f1bb02f40
1 /*
2 * GIT - The information manager from hell
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
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.
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.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 #include "cache.h"
26 #include "quote.h"
28 /* Get a trace file descriptor from "key" env variable. */
29 static int get_trace_fd(struct trace_key *key)
31 static struct trace_key trace_default = { "GIT_TRACE" };
32 const char *trace;
34 /* use default "GIT_TRACE" if NULL */
35 if (!key)
36 key = &trace_default;
38 /* don't open twice */
39 if (key->initialized)
40 return key->fd;
42 trace = getenv(key->key);
44 if (!trace || !strcmp(trace, "") ||
45 !strcmp(trace, "0") || !strcasecmp(trace, "false"))
46 key->fd = 0;
47 else if (!strcmp(trace, "1") || !strcasecmp(trace, "true"))
48 key->fd = STDERR_FILENO;
49 else if (strlen(trace) == 1 && isdigit(*trace))
50 key->fd = atoi(trace);
51 else if (is_absolute_path(trace)) {
52 int fd = open(trace, O_WRONLY | O_APPEND | O_CREAT, 0666);
53 if (fd == -1) {
54 fprintf(stderr,
55 "Could not open '%s' for tracing: %s\n"
56 "Defaulting to tracing on stderr...\n",
57 trace, strerror(errno));
58 key->fd = STDERR_FILENO;
59 } else {
60 key->fd = fd;
61 key->need_close = 1;
63 } else {
64 fprintf(stderr, "What does '%s' for %s mean?\n"
65 "If you want to trace into a file, then please set "
66 "%s to an absolute pathname (starting with /).\n"
67 "Defaulting to tracing on stderr...\n",
68 trace, key->key, key->key);
69 key->fd = STDERR_FILENO;
72 key->initialized = 1;
73 return key->fd;
76 void trace_disable(struct trace_key *key)
78 if (key->need_close)
79 close(key->fd);
80 key->fd = 0;
81 key->initialized = 1;
82 key->need_close = 0;
85 static const char err_msg[] = "Could not trace into fd given by "
86 "GIT_TRACE environment variable";
88 static int prepare_trace_line(const char *file, int line,
89 struct trace_key *key, struct strbuf *buf)
91 static struct trace_key trace_bare = TRACE_KEY_INIT(BARE);
92 struct timeval tv;
93 struct tm tm;
94 time_t secs;
96 if (!trace_want(key))
97 return 0;
99 set_try_to_free_routine(NULL); /* is never reset */
101 /* unit tests may want to disable additional trace output */
102 if (trace_want(&trace_bare))
103 return 1;
105 /* print current timestamp */
106 gettimeofday(&tv, NULL);
107 secs = tv.tv_sec;
108 localtime_r(&secs, &tm);
109 strbuf_addf(buf, "%02d:%02d:%02d.%06ld ", tm.tm_hour, tm.tm_min,
110 tm.tm_sec, (long) tv.tv_usec);
112 #ifdef HAVE_VARIADIC_MACROS
113 /* print file:line */
114 strbuf_addf(buf, "%s:%d ", file, line);
115 /* align trace output (column 40 catches most files names in git) */
116 while (buf->len < 40)
117 strbuf_addch(buf, ' ');
118 #endif
120 return 1;
123 void trace_verbatim(struct trace_key *key, const void *buf, unsigned len)
125 if (!trace_want(key))
126 return;
127 write_or_whine_pipe(get_trace_fd(key), buf, len, err_msg);
130 static void print_trace_line(struct trace_key *key, struct strbuf *buf)
132 strbuf_complete_line(buf);
134 write_or_whine_pipe(get_trace_fd(key), buf->buf, buf->len, err_msg);
135 strbuf_release(buf);
138 static void trace_vprintf_fl(const char *file, int line, struct trace_key *key,
139 const char *format, va_list ap)
141 struct strbuf buf = STRBUF_INIT;
143 if (!prepare_trace_line(file, line, key, &buf))
144 return;
146 strbuf_vaddf(&buf, format, ap);
147 print_trace_line(key, &buf);
150 static void trace_argv_vprintf_fl(const char *file, int line,
151 const char **argv, const char *format,
152 va_list ap)
154 struct strbuf buf = STRBUF_INIT;
156 if (!prepare_trace_line(file, line, NULL, &buf))
157 return;
159 strbuf_vaddf(&buf, format, ap);
161 sq_quote_argv(&buf, argv, 0);
162 print_trace_line(NULL, &buf);
165 void trace_strbuf_fl(const char *file, int line, struct trace_key *key,
166 const struct strbuf *data)
168 struct strbuf buf = STRBUF_INIT;
170 if (!prepare_trace_line(file, line, key, &buf))
171 return;
173 strbuf_addbuf(&buf, data);
174 print_trace_line(key, &buf);
177 static struct trace_key trace_perf_key = TRACE_KEY_INIT(PERFORMANCE);
179 static void trace_performance_vprintf_fl(const char *file, int line,
180 uint64_t nanos, const char *format,
181 va_list ap)
183 struct strbuf buf = STRBUF_INIT;
185 if (!prepare_trace_line(file, line, &trace_perf_key, &buf))
186 return;
188 strbuf_addf(&buf, "performance: %.9f s", (double) nanos / 1000000000);
190 if (format && *format) {
191 strbuf_addstr(&buf, ": ");
192 strbuf_vaddf(&buf, format, ap);
195 print_trace_line(&trace_perf_key, &buf);
198 #ifndef HAVE_VARIADIC_MACROS
200 void trace_printf(const char *format, ...)
202 va_list ap;
203 va_start(ap, format);
204 trace_vprintf_fl(NULL, 0, NULL, format, ap);
205 va_end(ap);
208 void trace_printf_key(struct trace_key *key, const char *format, ...)
210 va_list ap;
211 va_start(ap, format);
212 trace_vprintf_fl(NULL, 0, key, format, ap);
213 va_end(ap);
216 void trace_argv_printf(const char **argv, const char *format, ...)
218 va_list ap;
219 va_start(ap, format);
220 trace_argv_vprintf_fl(NULL, 0, argv, format, ap);
221 va_end(ap);
224 void trace_strbuf(struct trace_key *key, const struct strbuf *data)
226 trace_strbuf_fl(NULL, 0, key, data);
229 void trace_performance(uint64_t nanos, const char *format, ...)
231 va_list ap;
232 va_start(ap, format);
233 trace_performance_vprintf_fl(NULL, 0, nanos, format, ap);
234 va_end(ap);
237 void trace_performance_since(uint64_t start, const char *format, ...)
239 va_list ap;
240 va_start(ap, format);
241 trace_performance_vprintf_fl(NULL, 0, getnanotime() - start,
242 format, ap);
243 va_end(ap);
246 #else
248 void trace_printf_key_fl(const char *file, int line, struct trace_key *key,
249 const char *format, ...)
251 va_list ap;
252 va_start(ap, format);
253 trace_vprintf_fl(file, line, key, format, ap);
254 va_end(ap);
257 void trace_argv_printf_fl(const char *file, int line, const char **argv,
258 const char *format, ...)
260 va_list ap;
261 va_start(ap, format);
262 trace_argv_vprintf_fl(file, line, argv, format, ap);
263 va_end(ap);
266 void trace_performance_fl(const char *file, int line, uint64_t nanos,
267 const char *format, ...)
269 va_list ap;
270 va_start(ap, format);
271 trace_performance_vprintf_fl(file, line, nanos, format, ap);
272 va_end(ap);
275 #endif /* HAVE_VARIADIC_MACROS */
278 static const char *quote_crnl(const char *path)
280 static char new_path[PATH_MAX];
281 const char *p2 = path;
282 char *p1 = new_path;
284 if (!path)
285 return NULL;
287 while (*p2) {
288 switch (*p2) {
289 case '\\': *p1++ = '\\'; *p1++ = '\\'; break;
290 case '\n': *p1++ = '\\'; *p1++ = 'n'; break;
291 case '\r': *p1++ = '\\'; *p1++ = 'r'; break;
292 default:
293 *p1++ = *p2;
295 p2++;
297 *p1 = '\0';
298 return new_path;
301 /* FIXME: move prefix to startup_info struct and get rid of this arg */
302 void trace_repo_setup(const char *prefix)
304 static struct trace_key key = TRACE_KEY_INIT(SETUP);
305 const char *git_work_tree;
306 char *cwd;
308 if (!trace_want(&key))
309 return;
311 cwd = xgetcwd();
313 if (!(git_work_tree = get_git_work_tree()))
314 git_work_tree = "(null)";
316 if (!prefix)
317 prefix = "(null)";
319 trace_printf_key(&key, "setup: git_dir: %s\n", quote_crnl(get_git_dir()));
320 trace_printf_key(&key, "setup: git_common_dir: %s\n", quote_crnl(get_git_common_dir()));
321 trace_printf_key(&key, "setup: worktree: %s\n", quote_crnl(git_work_tree));
322 trace_printf_key(&key, "setup: cwd: %s\n", quote_crnl(cwd));
323 trace_printf_key(&key, "setup: prefix: %s\n", quote_crnl(prefix));
325 free(cwd);
328 int trace_want(struct trace_key *key)
330 return !!get_trace_fd(key);
333 #if defined(HAVE_CLOCK_GETTIME) && defined(HAVE_CLOCK_MONOTONIC)
335 static inline uint64_t highres_nanos(void)
337 struct timespec ts;
338 if (clock_gettime(CLOCK_MONOTONIC, &ts))
339 return 0;
340 return (uint64_t) ts.tv_sec * 1000000000 + ts.tv_nsec;
343 #elif defined (GIT_WINDOWS_NATIVE)
345 static inline uint64_t highres_nanos(void)
347 static uint64_t high_ns, scaled_low_ns;
348 static int scale;
349 LARGE_INTEGER cnt;
351 if (!scale) {
352 if (!QueryPerformanceFrequency(&cnt))
353 return 0;
355 /* high_ns = number of ns per cnt.HighPart */
356 high_ns = (1000000000LL << 32) / (uint64_t) cnt.QuadPart;
359 * Number of ns per cnt.LowPart is 10^9 / frequency (or
360 * high_ns >> 32). For maximum precision, we scale this factor
361 * so that it just fits within 32 bit (i.e. won't overflow if
362 * multiplied with cnt.LowPart).
364 scaled_low_ns = high_ns;
365 scale = 32;
366 while (scaled_low_ns >= 0x100000000LL) {
367 scaled_low_ns >>= 1;
368 scale--;
372 /* if QPF worked on initialization, we expect QPC to work as well */
373 QueryPerformanceCounter(&cnt);
375 return (high_ns * cnt.HighPart) +
376 ((scaled_low_ns * cnt.LowPart) >> scale);
379 #else
380 # define highres_nanos() 0
381 #endif
383 static inline uint64_t gettimeofday_nanos(void)
385 struct timeval tv;
386 gettimeofday(&tv, NULL);
387 return (uint64_t) tv.tv_sec * 1000000000 + tv.tv_usec * 1000;
391 * Returns nanoseconds since the epoch (01/01/1970), for performance tracing
392 * (i.e. favoring high precision over wall clock time accuracy).
394 uint64_t getnanotime(void)
396 static uint64_t offset;
397 if (offset > 1) {
398 /* initialization succeeded, return offset + high res time */
399 return offset + highres_nanos();
400 } else if (offset == 1) {
401 /* initialization failed, fall back to gettimeofday */
402 return gettimeofday_nanos();
403 } else {
404 /* initialize offset if high resolution timer works */
405 uint64_t now = gettimeofday_nanos();
406 uint64_t highres = highres_nanos();
407 if (highres)
408 offset = now - highres;
409 else
410 offset = 1;
411 return now;
415 static uint64_t command_start_time;
416 static struct strbuf command_line = STRBUF_INIT;
418 static void print_command_performance_atexit(void)
420 trace_performance_since(command_start_time, "git command:%s",
421 command_line.buf);
424 void trace_command_performance(const char **argv)
426 if (!trace_want(&trace_perf_key))
427 return;
429 if (!command_start_time)
430 atexit(print_command_performance_atexit);
432 strbuf_reset(&command_line);
433 sq_quote_argv(&command_line, argv, 0);
434 command_start_time = getnanotime();