]>
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 | |
48425792 | 21 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
6ce4e61f CC |
22 | */ |
23 | ||
5579f44d | 24 | #include "git-compat-util.h" |
0b027f6c | 25 | #include "abspath.h" |
32a8f510 | 26 | #include "environment.h" |
6ce4e61f | 27 | #include "quote.h" |
e38da487 | 28 | #include "setup.h" |
74ea5c95 | 29 | #include "trace.h" |
d5ebb50d | 30 | #include "wrapper.h" |
6ce4e61f | 31 | |
406102a7 | 32 | struct trace_key trace_default_key = { "GIT_TRACE", 0, 0, 0 }; |
8eeb25c6 | 33 | struct trace_key trace_perf_key = TRACE_KEY_INIT(PERFORMANCE); |
cb507619 | 34 | struct trace_key trace_setup_key = TRACE_KEY_INIT(SETUP); |
c81539b5 | 35 | |
06796607 | 36 | /* Get a trace file descriptor from "key" env variable. */ |
7167a62b | 37 | static int get_trace_fd(struct trace_key *key, const char *override_envvar) |
6ce4e61f | 38 | { |
6aa30857 KB |
39 | const char *trace; |
40 | ||
6aa30857 KB |
41 | /* don't open twice */ |
42 | if (key->initialized) | |
43 | return key->fd; | |
44 | ||
7167a62b | 45 | trace = override_envvar ? override_envvar : getenv(key->key); |
6ce4e61f | 46 | |
6844fc80 CC |
47 | if (!trace || !strcmp(trace, "") || |
48 | !strcmp(trace, "0") || !strcasecmp(trace, "false")) | |
6aa30857 KB |
49 | key->fd = 0; |
50 | else if (!strcmp(trace, "1") || !strcasecmp(trace, "true")) | |
51 | key->fd = STDERR_FILENO; | |
52 | else if (strlen(trace) == 1 && isdigit(*trace)) | |
53 | key->fd = atoi(trace); | |
54 | else if (is_absolute_path(trace)) { | |
6ce4e61f CC |
55 | int fd = open(trace, O_WRONLY | O_APPEND | O_CREAT, 0666); |
56 | if (fd == -1) { | |
6f253057 | 57 | warning("could not open '%s' for tracing: %s", |
6ce4e61f | 58 | trace, strerror(errno)); |
6f253057 | 59 | trace_disable(key); |
6aa30857 KB |
60 | } else { |
61 | key->fd = fd; | |
62 | key->need_close = 1; | |
6ce4e61f | 63 | } |
6aa30857 | 64 | } else { |
b3a1c5da JK |
65 | warning("unknown trace value for '%s': %s\n" |
66 | " If you want to trace into a file, then please set %s\n" | |
6f253057 | 67 | " to an absolute pathname (starting with /)", |
b3a1c5da | 68 | key->key, trace, key->key); |
6f253057 | 69 | trace_disable(key); |
6ce4e61f CC |
70 | } |
71 | ||
6aa30857 KB |
72 | key->initialized = 1; |
73 | return key->fd; | |
74 | } | |
6ce4e61f | 75 | |
7167a62b JT |
76 | void trace_override_envvar(struct trace_key *key, const char *value) |
77 | { | |
78 | trace_disable(key); | |
79 | key->initialized = 0; | |
80 | ||
81 | /* | |
82 | * Invoke get_trace_fd() to initialize key using the given value | |
83 | * instead of the value of the environment variable. | |
84 | */ | |
85 | get_trace_fd(key, value); | |
86 | } | |
87 | ||
6aa30857 KB |
88 | void trace_disable(struct trace_key *key) |
89 | { | |
90 | if (key->need_close) | |
91 | close(key->fd); | |
92 | key->fd = 0; | |
93 | key->initialized = 1; | |
94 | key->need_close = 0; | |
6ce4e61f CC |
95 | } |
96 | ||
e05bed96 KB |
97 | static int prepare_trace_line(const char *file, int line, |
98 | struct trace_key *key, struct strbuf *buf) | |
c69dfd24 | 99 | { |
124647c4 | 100 | static struct trace_key trace_bare = TRACE_KEY_INIT(BARE); |
b72be02c KB |
101 | struct timeval tv; |
102 | struct tm tm; | |
103 | time_t secs; | |
124647c4 | 104 | |
c69dfd24 KB |
105 | if (!trace_want(key)) |
106 | return 0; | |
107 | ||
124647c4 KB |
108 | /* unit tests may want to disable additional trace output */ |
109 | if (trace_want(&trace_bare)) | |
110 | return 1; | |
111 | ||
b72be02c KB |
112 | /* print current timestamp */ |
113 | gettimeofday(&tv, NULL); | |
114 | secs = tv.tv_sec; | |
115 | localtime_r(&secs, &tm); | |
56a29d2c ÆAB |
116 | strbuf_addf(buf, "%02d:%02d:%02d.%06ld %s:%d", tm.tm_hour, tm.tm_min, |
117 | tm.tm_sec, (long) tv.tv_usec, file, line); | |
e05bed96 KB |
118 | /* align trace output (column 40 catches most files names in git) */ |
119 | while (buf->len < 40) | |
120 | strbuf_addch(buf, ' '); | |
e05bed96 | 121 | |
c69dfd24 KB |
122 | return 1; |
123 | } | |
124 | ||
c0222e76 JK |
125 | static void trace_write(struct trace_key *key, const void *buf, unsigned len) |
126 | { | |
7167a62b | 127 | if (write_in_full(get_trace_fd(key, NULL), buf, len) < 0) { |
3b0c3ab7 JK |
128 | warning("unable to write trace for %s: %s", |
129 | key->key, strerror(errno)); | |
46ac74b7 | 130 | trace_disable(key); |
3b0c3ab7 | 131 | } |
c0222e76 JK |
132 | } |
133 | ||
32359838 JK |
134 | void trace_verbatim(struct trace_key *key, const void *buf, unsigned len) |
135 | { | |
136 | if (!trace_want(key)) | |
137 | return; | |
c0222e76 | 138 | trace_write(key, buf, len); |
32359838 JK |
139 | } |
140 | ||
c69dfd24 KB |
141 | static void print_trace_line(struct trace_key *key, struct strbuf *buf) |
142 | { | |
a0d4923d | 143 | strbuf_complete_line(buf); |
c0222e76 | 144 | trace_write(key, buf->buf, buf->len); |
c69dfd24 KB |
145 | } |
146 | ||
e05bed96 KB |
147 | static void trace_vprintf_fl(const char *file, int line, struct trace_key *key, |
148 | const char *format, va_list ap) | |
6ce4e61f | 149 | { |
ebeb6090 | 150 | struct strbuf buf = STRBUF_INIT; |
6ce4e61f | 151 | |
e05bed96 | 152 | if (!prepare_trace_line(file, line, key, &buf)) |
6ce4e61f CC |
153 | return; |
154 | ||
4a3b0b25 | 155 | strbuf_vaddf(&buf, format, ap); |
c69dfd24 | 156 | print_trace_line(key, &buf); |
33011e76 | 157 | strbuf_release(&buf); |
6ce4e61f CC |
158 | } |
159 | ||
e05bed96 KB |
160 | static void trace_argv_vprintf_fl(const char *file, int line, |
161 | const char **argv, const char *format, | |
162 | va_list ap) | |
06796607 | 163 | { |
66f66c59 | 164 | struct strbuf buf = STRBUF_INIT; |
06796607 | 165 | |
406102a7 | 166 | if (!prepare_trace_line(file, line, &trace_default_key, &buf)) |
66f66c59 KB |
167 | return; |
168 | ||
66f66c59 | 169 | strbuf_vaddf(&buf, format, ap); |
66f66c59 | 170 | |
1fbdab21 | 171 | sq_quote_argv_pretty(&buf, argv); |
406102a7 | 172 | print_trace_line(&trace_default_key, &buf); |
33011e76 | 173 | strbuf_release(&buf); |
c6053543 JK |
174 | } |
175 | ||
e05bed96 KB |
176 | void trace_strbuf_fl(const char *file, int line, struct trace_key *key, |
177 | const struct strbuf *data) | |
94b3b374 | 178 | { |
c69dfd24 KB |
179 | struct strbuf buf = STRBUF_INIT; |
180 | ||
e05bed96 | 181 | if (!prepare_trace_line(file, line, key, &buf)) |
94b3b374 JK |
182 | return; |
183 | ||
c69dfd24 KB |
184 | strbuf_addbuf(&buf, data); |
185 | print_trace_line(key, &buf); | |
33011e76 | 186 | strbuf_release(&buf); |
94b3b374 JK |
187 | } |
188 | ||
c46c406a NTND |
189 | static uint64_t perf_start_times[10]; |
190 | static int perf_indent; | |
191 | ||
192 | uint64_t trace_performance_enter(void) | |
193 | { | |
194 | uint64_t now; | |
195 | ||
196 | if (!trace_want(&trace_perf_key)) | |
197 | return 0; | |
198 | ||
199 | now = getnanotime(); | |
200 | perf_start_times[perf_indent] = now; | |
201 | if (perf_indent + 1 < ARRAY_SIZE(perf_start_times)) | |
202 | perf_indent++; | |
203 | else | |
204 | BUG("Too deep indentation"); | |
205 | return now; | |
206 | } | |
207 | ||
09b2c1c7 KB |
208 | static void trace_performance_vprintf_fl(const char *file, int line, |
209 | uint64_t nanos, const char *format, | |
210 | va_list ap) | |
211 | { | |
c46c406a | 212 | static const char space[] = " "; |
09b2c1c7 KB |
213 | struct strbuf buf = STRBUF_INIT; |
214 | ||
215 | if (!prepare_trace_line(file, line, &trace_perf_key, &buf)) | |
216 | return; | |
217 | ||
218 | strbuf_addf(&buf, "performance: %.9f s", (double) nanos / 1000000000); | |
219 | ||
220 | if (format && *format) { | |
c46c406a NTND |
221 | if (perf_indent >= strlen(space)) |
222 | BUG("Too deep indentation"); | |
223 | ||
224 | strbuf_addf(&buf, ":%.*s ", perf_indent, space); | |
09b2c1c7 KB |
225 | strbuf_vaddf(&buf, format, ap); |
226 | } | |
227 | ||
228 | print_trace_line(&trace_perf_key, &buf); | |
33011e76 | 229 | strbuf_release(&buf); |
09b2c1c7 KB |
230 | } |
231 | ||
e05bed96 KB |
232 | void trace_printf_key_fl(const char *file, int line, struct trace_key *key, |
233 | const char *format, ...) | |
234 | { | |
235 | va_list ap; | |
236 | va_start(ap, format); | |
237 | trace_vprintf_fl(file, line, key, format, ap); | |
238 | va_end(ap); | |
239 | } | |
240 | ||
241 | void trace_argv_printf_fl(const char *file, int line, const char **argv, | |
242 | const char *format, ...) | |
243 | { | |
244 | va_list ap; | |
245 | va_start(ap, format); | |
246 | trace_argv_vprintf_fl(file, line, argv, format, ap); | |
247 | va_end(ap); | |
248 | } | |
249 | ||
09b2c1c7 KB |
250 | void trace_performance_fl(const char *file, int line, uint64_t nanos, |
251 | const char *format, ...) | |
252 | { | |
253 | va_list ap; | |
254 | va_start(ap, format); | |
255 | trace_performance_vprintf_fl(file, line, nanos, format, ap); | |
256 | va_end(ap); | |
257 | } | |
258 | ||
c46c406a NTND |
259 | void trace_performance_leave_fl(const char *file, int line, |
260 | uint64_t nanos, const char *format, ...) | |
261 | { | |
262 | va_list ap; | |
263 | uint64_t since; | |
264 | ||
265 | if (perf_indent) | |
266 | perf_indent--; | |
267 | ||
268 | if (!format) /* Allow callers to leave without tracing anything */ | |
269 | return; | |
270 | ||
271 | since = perf_start_times[perf_indent]; | |
272 | va_start(ap, format); | |
273 | trace_performance_vprintf_fl(file, line, nanos - since, format, ap); | |
274 | va_end(ap); | |
275 | } | |
276 | ||
a9ca8a85 NTND |
277 | static const char *quote_crnl(const char *path) |
278 | { | |
0bb443fd | 279 | static struct strbuf new_path = STRBUF_INIT; |
a9ca8a85 NTND |
280 | |
281 | if (!path) | |
282 | return NULL; | |
283 | ||
0bb443fd JK |
284 | strbuf_reset(&new_path); |
285 | ||
286 | while (*path) { | |
287 | switch (*path) { | |
288 | case '\\': strbuf_addstr(&new_path, "\\\\"); break; | |
289 | case '\n': strbuf_addstr(&new_path, "\\n"); break; | |
290 | case '\r': strbuf_addstr(&new_path, "\\r"); break; | |
a9ca8a85 | 291 | default: |
0bb443fd | 292 | strbuf_addch(&new_path, *path); |
a9ca8a85 | 293 | } |
0bb443fd | 294 | path++; |
a9ca8a85 | 295 | } |
0bb443fd | 296 | return new_path.buf; |
a9ca8a85 NTND |
297 | } |
298 | ||
17ab64e1 | 299 | void trace_repo_setup(void) |
a9ca8a85 | 300 | { |
17ab64e1 | 301 | const char *git_work_tree, *prefix = startup_info->prefix; |
56b9f6e7 | 302 | char *cwd; |
a9ca8a85 | 303 | |
cb507619 | 304 | if (!trace_want(&trace_setup_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 | ||
17ab64e1 | 312 | if (!startup_info->prefix) |
e83c267f BC |
313 | prefix = "(null)"; |
314 | ||
cb507619 NTND |
315 | trace_printf_key(&trace_setup_key, "setup: git_dir: %s\n", quote_crnl(get_git_dir())); |
316 | trace_printf_key(&trace_setup_key, "setup: git_common_dir: %s\n", quote_crnl(get_git_common_dir())); | |
317 | trace_printf_key(&trace_setup_key, "setup: worktree: %s\n", quote_crnl(git_work_tree)); | |
318 | trace_printf_key(&trace_setup_key, "setup: cwd: %s\n", quote_crnl(cwd)); | |
319 | trace_printf_key(&trace_setup_key, "setup: prefix: %s\n", quote_crnl(prefix)); | |
56b9f6e7 RS |
320 | |
321 | free(cwd); | |
a9ca8a85 | 322 | } |
39bc5e46 | 323 | |
6aa30857 | 324 | int trace_want(struct trace_key *key) |
39bc5e46 | 325 | { |
7167a62b | 326 | return !!get_trace_fd(key, NULL); |
39bc5e46 | 327 | } |
148d6771 | 328 | |
a6c3c638 | 329 | #if defined(HAVE_CLOCK_GETTIME) && defined(HAVE_CLOCK_MONOTONIC) |
148d6771 KB |
330 | |
331 | static 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 | ||
341 | static 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 | ||
379 | static 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 | 390 | uint64_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 | 410 | |
578da039 KB |
411 | static struct strbuf command_line = STRBUF_INIT; |
412 | ||
413 | static void print_command_performance_atexit(void) | |
414 | { | |
c46c406a | 415 | trace_performance_leave("git command:%s", command_line.buf); |
578da039 KB |
416 | } |
417 | ||
418 | void trace_command_performance(const char **argv) | |
419 | { | |
420 | if (!trace_want(&trace_perf_key)) | |
421 | return; | |
422 | ||
c46c406a | 423 | if (!command_line.len) |
578da039 KB |
424 | atexit(print_command_performance_atexit); |
425 | ||
426 | strbuf_reset(&command_line); | |
1fbdab21 | 427 | sq_quote_argv_pretty(&command_line, argv); |
c46c406a | 428 | trace_performance_enter(); |
578da039 | 429 | } |