]>
Commit | Line | Data |
---|---|---|
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 | |
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 | |
23 | */ | |
24 | ||
25 | #include "cache.h" | |
26 | #include "quote.h" | |
27 | ||
06796607 | 28 | /* Get a trace file descriptor from "key" env variable. */ |
6aa30857 | 29 | static int get_trace_fd(struct trace_key *key) |
6ce4e61f | 30 | { |
6aa30857 KB |
31 | static struct trace_key trace_default = { "GIT_TRACE" }; |
32 | const char *trace; | |
33 | ||
34 | /* use default "GIT_TRACE" if NULL */ | |
35 | if (!key) | |
36 | key = &trace_default; | |
37 | ||
38 | /* don't open twice */ | |
39 | if (key->initialized) | |
40 | return key->fd; | |
41 | ||
42 | trace = getenv(key->key); | |
6ce4e61f | 43 | |
6844fc80 CC |
44 | if (!trace || !strcmp(trace, "") || |
45 | !strcmp(trace, "0") || !strcasecmp(trace, "false")) | |
6aa30857 KB |
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)) { | |
6ce4e61f CC |
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)); | |
6aa30857 KB |
58 | key->fd = STDERR_FILENO; |
59 | } else { | |
60 | key->fd = fd; | |
61 | key->need_close = 1; | |
6ce4e61f | 62 | } |
6aa30857 KB |
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; | |
6ce4e61f CC |
70 | } |
71 | ||
6aa30857 KB |
72 | key->initialized = 1; |
73 | return key->fd; | |
74 | } | |
6ce4e61f | 75 | |
6aa30857 KB |
76 | void trace_disable(struct trace_key *key) |
77 | { | |
78 | if (key->need_close) | |
79 | close(key->fd); | |
80 | key->fd = 0; | |
81 | key->initialized = 1; | |
82 | key->need_close = 0; | |
6ce4e61f CC |
83 | } |
84 | ||
85 | static const char err_msg[] = "Could not trace into fd given by " | |
86 | "GIT_TRACE environment variable"; | |
87 | ||
e05bed96 KB |
88 | static int prepare_trace_line(const char *file, int line, |
89 | struct trace_key *key, struct strbuf *buf) | |
c69dfd24 | 90 | { |
124647c4 | 91 | static struct trace_key trace_bare = TRACE_KEY_INIT(BARE); |
b72be02c KB |
92 | struct timeval tv; |
93 | struct tm tm; | |
94 | time_t secs; | |
124647c4 | 95 | |
c69dfd24 KB |
96 | if (!trace_want(key)) |
97 | return 0; | |
98 | ||
99 | set_try_to_free_routine(NULL); /* is never reset */ | |
100 | ||
124647c4 KB |
101 | /* unit tests may want to disable additional trace output */ |
102 | if (trace_want(&trace_bare)) | |
103 | return 1; | |
104 | ||
b72be02c KB |
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); | |
c69dfd24 | 111 | |
e05bed96 KB |
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 | |
119 | ||
c69dfd24 KB |
120 | return 1; |
121 | } | |
122 | ||
32359838 JK |
123 | void trace_verbatim(struct trace_key *key, const void *buf, unsigned len) |
124 | { | |
125 | if (!trace_want(key)) | |
126 | return; | |
127 | write_or_whine_pipe(get_trace_fd(key), buf, len, err_msg); | |
128 | } | |
129 | ||
c69dfd24 KB |
130 | static void print_trace_line(struct trace_key *key, struct strbuf *buf) |
131 | { | |
a0d4923d | 132 | strbuf_complete_line(buf); |
c69dfd24 KB |
133 | |
134 | write_or_whine_pipe(get_trace_fd(key), buf->buf, buf->len, err_msg); | |
135 | strbuf_release(buf); | |
136 | } | |
137 | ||
e05bed96 KB |
138 | static void trace_vprintf_fl(const char *file, int line, struct trace_key *key, |
139 | const char *format, va_list ap) | |
6ce4e61f | 140 | { |
ebeb6090 | 141 | struct strbuf buf = STRBUF_INIT; |
6ce4e61f | 142 | |
e05bed96 | 143 | if (!prepare_trace_line(file, line, key, &buf)) |
6ce4e61f CC |
144 | return; |
145 | ||
4a3b0b25 | 146 | strbuf_vaddf(&buf, format, ap); |
c69dfd24 | 147 | print_trace_line(key, &buf); |
6ce4e61f CC |
148 | } |
149 | ||
e05bed96 KB |
150 | static void trace_argv_vprintf_fl(const char *file, int line, |
151 | const char **argv, const char *format, | |
152 | va_list ap) | |
06796607 | 153 | { |
66f66c59 | 154 | struct strbuf buf = STRBUF_INIT; |
06796607 | 155 | |
e05bed96 | 156 | if (!prepare_trace_line(file, line, NULL, &buf)) |
66f66c59 KB |
157 | return; |
158 | ||
66f66c59 | 159 | strbuf_vaddf(&buf, format, ap); |
66f66c59 KB |
160 | |
161 | sq_quote_argv(&buf, argv, 0); | |
162 | print_trace_line(NULL, &buf); | |
c6053543 JK |
163 | } |
164 | ||
e05bed96 KB |
165 | void trace_strbuf_fl(const char *file, int line, struct trace_key *key, |
166 | const struct strbuf *data) | |
94b3b374 | 167 | { |
c69dfd24 KB |
168 | struct strbuf buf = STRBUF_INIT; |
169 | ||
e05bed96 | 170 | if (!prepare_trace_line(file, line, key, &buf)) |
94b3b374 JK |
171 | return; |
172 | ||
c69dfd24 KB |
173 | strbuf_addbuf(&buf, data); |
174 | print_trace_line(key, &buf); | |
94b3b374 JK |
175 | } |
176 | ||
09b2c1c7 KB |
177 | static struct trace_key trace_perf_key = TRACE_KEY_INIT(PERFORMANCE); |
178 | ||
179 | static void trace_performance_vprintf_fl(const char *file, int line, | |
180 | uint64_t nanos, const char *format, | |
181 | va_list ap) | |
182 | { | |
183 | struct strbuf buf = STRBUF_INIT; | |
184 | ||
185 | if (!prepare_trace_line(file, line, &trace_perf_key, &buf)) | |
186 | return; | |
187 | ||
188 | strbuf_addf(&buf, "performance: %.9f s", (double) nanos / 1000000000); | |
189 | ||
190 | if (format && *format) { | |
191 | strbuf_addstr(&buf, ": "); | |
192 | strbuf_vaddf(&buf, format, ap); | |
193 | } | |
194 | ||
195 | print_trace_line(&trace_perf_key, &buf); | |
196 | } | |
197 | ||
e05bed96 KB |
198 | #ifndef HAVE_VARIADIC_MACROS |
199 | ||
66f66c59 | 200 | void trace_printf(const char *format, ...) |
6ce4e61f | 201 | { |
19247e55 | 202 | va_list ap; |
4a3b0b25 | 203 | va_start(ap, format); |
e05bed96 | 204 | trace_vprintf_fl(NULL, 0, NULL, format, ap); |
19247e55 | 205 | va_end(ap); |
66f66c59 | 206 | } |
6ce4e61f | 207 | |
66f66c59 KB |
208 | void trace_printf_key(struct trace_key *key, const char *format, ...) |
209 | { | |
210 | va_list ap; | |
211 | va_start(ap, format); | |
e05bed96 KB |
212 | trace_vprintf_fl(NULL, 0, key, format, ap); |
213 | va_end(ap); | |
214 | } | |
215 | ||
216 | void trace_argv_printf(const char **argv, const char *format, ...) | |
217 | { | |
218 | va_list ap; | |
219 | va_start(ap, format); | |
220 | trace_argv_vprintf_fl(NULL, 0, argv, format, ap); | |
66f66c59 | 221 | va_end(ap); |
6ce4e61f | 222 | } |
a9ca8a85 | 223 | |
792a646a | 224 | void trace_strbuf(struct trace_key *key, const struct strbuf *data) |
e05bed96 KB |
225 | { |
226 | trace_strbuf_fl(NULL, 0, key, data); | |
227 | } | |
228 | ||
09b2c1c7 KB |
229 | void trace_performance(uint64_t nanos, const char *format, ...) |
230 | { | |
231 | va_list ap; | |
232 | va_start(ap, format); | |
233 | trace_performance_vprintf_fl(NULL, 0, nanos, format, ap); | |
234 | va_end(ap); | |
235 | } | |
236 | ||
237 | void trace_performance_since(uint64_t start, const char *format, ...) | |
238 | { | |
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); | |
244 | } | |
245 | ||
e05bed96 KB |
246 | #else |
247 | ||
248 | void trace_printf_key_fl(const char *file, int line, struct trace_key *key, | |
249 | const char *format, ...) | |
250 | { | |
251 | va_list ap; | |
252 | va_start(ap, format); | |
253 | trace_vprintf_fl(file, line, key, format, ap); | |
254 | va_end(ap); | |
255 | } | |
256 | ||
257 | void trace_argv_printf_fl(const char *file, int line, const char **argv, | |
258 | const char *format, ...) | |
259 | { | |
260 | va_list ap; | |
261 | va_start(ap, format); | |
262 | trace_argv_vprintf_fl(file, line, argv, format, ap); | |
263 | va_end(ap); | |
264 | } | |
265 | ||
09b2c1c7 KB |
266 | void trace_performance_fl(const char *file, int line, uint64_t nanos, |
267 | const char *format, ...) | |
268 | { | |
269 | va_list ap; | |
270 | va_start(ap, format); | |
271 | trace_performance_vprintf_fl(file, line, nanos, format, ap); | |
272 | va_end(ap); | |
273 | } | |
274 | ||
e05bed96 KB |
275 | #endif /* HAVE_VARIADIC_MACROS */ |
276 | ||
277 | ||
a9ca8a85 NTND |
278 | static const char *quote_crnl(const char *path) |
279 | { | |
280 | static char new_path[PATH_MAX]; | |
281 | const char *p2 = path; | |
282 | char *p1 = new_path; | |
283 | ||
284 | if (!path) | |
285 | return NULL; | |
286 | ||
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; | |
294 | } | |
295 | p2++; | |
296 | } | |
297 | *p1 = '\0'; | |
298 | return new_path; | |
299 | } | |
300 | ||
301 | /* FIXME: move prefix to startup_info struct and get rid of this arg */ | |
302 | void trace_repo_setup(const char *prefix) | |
303 | { | |
6aa30857 | 304 | static struct trace_key key = TRACE_KEY_INIT(SETUP); |
e83c267f | 305 | const char *git_work_tree; |
56b9f6e7 | 306 | char *cwd; |
a9ca8a85 | 307 | |
6aa30857 | 308 | if (!trace_want(&key)) |
a9ca8a85 NTND |
309 | return; |
310 | ||
56b9f6e7 | 311 | cwd = xgetcwd(); |
a9ca8a85 | 312 | |
e83c267f BC |
313 | if (!(git_work_tree = get_git_work_tree())) |
314 | git_work_tree = "(null)"; | |
315 | ||
316 | if (!prefix) | |
317 | prefix = "(null)"; | |
318 | ||
6aa30857 | 319 | trace_printf_key(&key, "setup: git_dir: %s\n", quote_crnl(get_git_dir())); |
31e26ebc | 320 | trace_printf_key(&key, "setup: git_common_dir: %s\n", quote_crnl(get_git_common_dir())); |
6aa30857 KB |
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)); | |
56b9f6e7 RS |
324 | |
325 | free(cwd); | |
a9ca8a85 | 326 | } |
39bc5e46 | 327 | |
6aa30857 | 328 | int trace_want(struct trace_key *key) |
39bc5e46 | 329 | { |
6aa30857 | 330 | return !!get_trace_fd(key); |
39bc5e46 | 331 | } |
148d6771 | 332 | |
a6c3c638 | 333 | #if defined(HAVE_CLOCK_GETTIME) && defined(HAVE_CLOCK_MONOTONIC) |
148d6771 KB |
334 | |
335 | static inline uint64_t highres_nanos(void) | |
336 | { | |
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; | |
341 | } | |
342 | ||
343 | #elif defined (GIT_WINDOWS_NATIVE) | |
344 | ||
345 | static inline uint64_t highres_nanos(void) | |
346 | { | |
347 | static uint64_t high_ns, scaled_low_ns; | |
348 | static int scale; | |
349 | LARGE_INTEGER cnt; | |
350 | ||
351 | if (!scale) { | |
352 | if (!QueryPerformanceFrequency(&cnt)) | |
353 | return 0; | |
354 | ||
355 | /* high_ns = number of ns per cnt.HighPart */ | |
356 | high_ns = (1000000000LL << 32) / (uint64_t) cnt.QuadPart; | |
357 | ||
358 | /* | |
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). | |
363 | */ | |
364 | scaled_low_ns = high_ns; | |
365 | scale = 32; | |
366 | while (scaled_low_ns >= 0x100000000LL) { | |
367 | scaled_low_ns >>= 1; | |
368 | scale--; | |
369 | } | |
370 | } | |
371 | ||
372 | /* if QPF worked on initialization, we expect QPC to work as well */ | |
373 | QueryPerformanceCounter(&cnt); | |
374 | ||
375 | return (high_ns * cnt.HighPart) + | |
376 | ((scaled_low_ns * cnt.LowPart) >> scale); | |
377 | } | |
378 | ||
379 | #else | |
380 | # define highres_nanos() 0 | |
381 | #endif | |
382 | ||
383 | static inline uint64_t gettimeofday_nanos(void) | |
384 | { | |
385 | struct timeval tv; | |
386 | gettimeofday(&tv, NULL); | |
387 | return (uint64_t) tv.tv_sec * 1000000000 + tv.tv_usec * 1000; | |
388 | } | |
389 | ||
390 | /* | |
391 | * Returns nanoseconds since the epoch (01/01/1970), for performance tracing | |
392 | * (i.e. favoring high precision over wall clock time accuracy). | |
393 | */ | |
6433d569 | 394 | uint64_t getnanotime(void) |
148d6771 KB |
395 | { |
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; | |
412 | } | |
413 | } | |
578da039 KB |
414 | |
415 | static uint64_t command_start_time; | |
416 | static struct strbuf command_line = STRBUF_INIT; | |
417 | ||
418 | static void print_command_performance_atexit(void) | |
419 | { | |
420 | trace_performance_since(command_start_time, "git command:%s", | |
421 | command_line.buf); | |
422 | } | |
423 | ||
424 | void trace_command_performance(const char **argv) | |
425 | { | |
426 | if (!trace_want(&trace_perf_key)) | |
427 | return; | |
428 | ||
429 | if (!command_start_time) | |
430 | atexit(print_command_performance_atexit); | |
431 | ||
432 | strbuf_reset(&command_line); | |
433 | sq_quote_argv(&command_line, argv, 0); | |
434 | command_start_time = getnanotime(); | |
435 | } |