Merge branch 'ss/cherry-pick-x-doc'
[git] / trace.c
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
28 /* Get a trace file descriptor from "key" env variable. */
29 static int get_trace_fd(const char *key, int *need_close)
30 {
31         char *trace = getenv(key);
32
33         if (!trace || !strcmp(trace, "") ||
34             !strcmp(trace, "0") || !strcasecmp(trace, "false"))
35                 return 0;
36         if (!strcmp(trace, "1") || !strcasecmp(trace, "true"))
37                 return STDERR_FILENO;
38         if (strlen(trace) == 1 && isdigit(*trace))
39                 return atoi(trace);
40         if (is_absolute_path(trace)) {
41                 int fd = open(trace, O_WRONLY | O_APPEND | O_CREAT, 0666);
42                 if (fd == -1) {
43                         fprintf(stderr,
44                                 "Could not open '%s' for tracing: %s\n"
45                                 "Defaulting to tracing on stderr...\n",
46                                 trace, strerror(errno));
47                         return STDERR_FILENO;
48                 }
49                 *need_close = 1;
50                 return fd;
51         }
52
53         fprintf(stderr, "What does '%s' for %s mean?\n", trace, key);
54         fprintf(stderr, "If you want to trace into a file, "
55                 "then please set %s to an absolute pathname "
56                 "(starting with /).\n", key);
57         fprintf(stderr, "Defaulting to tracing on stderr...\n");
58
59         return STDERR_FILENO;
60 }
61
62 static const char err_msg[] = "Could not trace into fd given by "
63         "GIT_TRACE environment variable";
64
65 void trace_vprintf(const char *key, const char *fmt, va_list ap)
66 {
67         struct strbuf buf = STRBUF_INIT;
68
69         if (!trace_want(key))
70                 return;
71
72         set_try_to_free_routine(NULL);  /* is never reset */
73         strbuf_vaddf(&buf, fmt, ap);
74         trace_strbuf(key, &buf);
75         strbuf_release(&buf);
76 }
77
78 static void trace_printf_key(const char *key, const char *fmt, ...)
79 {
80         va_list ap;
81         va_start(ap, fmt);
82         trace_vprintf(key, fmt, ap);
83         va_end(ap);
84 }
85
86 void trace_printf(const char *fmt, ...)
87 {
88         va_list ap;
89         va_start(ap, fmt);
90         trace_vprintf("GIT_TRACE", fmt, ap);
91         va_end(ap);
92 }
93
94 void trace_strbuf(const char *key, const struct strbuf *buf)
95 {
96         int fd, need_close = 0;
97
98         fd = get_trace_fd(key, &need_close);
99         if (!fd)
100                 return;
101
102         write_or_whine_pipe(fd, buf->buf, buf->len, err_msg);
103
104         if (need_close)
105                 close(fd);
106 }
107
108 void trace_argv_printf(const char **argv, const char *fmt, ...)
109 {
110         struct strbuf buf = STRBUF_INIT;
111         va_list ap;
112         int fd, need_close = 0;
113
114         fd = get_trace_fd("GIT_TRACE", &need_close);
115         if (!fd)
116                 return;
117
118         set_try_to_free_routine(NULL);  /* is never reset */
119         va_start(ap, fmt);
120         strbuf_vaddf(&buf, fmt, ap);
121         va_end(ap);
122
123         sq_quote_argv(&buf, argv, 0);
124         strbuf_addch(&buf, '\n');
125         write_or_whine_pipe(fd, buf.buf, buf.len, err_msg);
126         strbuf_release(&buf);
127
128         if (need_close)
129                 close(fd);
130 }
131
132 static const char *quote_crnl(const char *path)
133 {
134         static char new_path[PATH_MAX];
135         const char *p2 = path;
136         char *p1 = new_path;
137
138         if (!path)
139                 return NULL;
140
141         while (*p2) {
142                 switch (*p2) {
143                 case '\\': *p1++ = '\\'; *p1++ = '\\'; break;
144                 case '\n': *p1++ = '\\'; *p1++ = 'n'; break;
145                 case '\r': *p1++ = '\\'; *p1++ = 'r'; break;
146                 default:
147                         *p1++ = *p2;
148                 }
149                 p2++;
150         }
151         *p1 = '\0';
152         return new_path;
153 }
154
155 /* FIXME: move prefix to startup_info struct and get rid of this arg */
156 void trace_repo_setup(const char *prefix)
157 {
158         static const char *key = "GIT_TRACE_SETUP";
159         const char *git_work_tree;
160         char cwd[PATH_MAX];
161
162         if (!trace_want(key))
163                 return;
164
165         if (!getcwd(cwd, PATH_MAX))
166                 die("Unable to get current working directory");
167
168         if (!(git_work_tree = get_git_work_tree()))
169                 git_work_tree = "(null)";
170
171         if (!prefix)
172                 prefix = "(null)";
173
174         trace_printf_key(key, "setup: git_dir: %s\n", quote_crnl(get_git_dir()));
175         trace_printf_key(key, "setup: worktree: %s\n", quote_crnl(git_work_tree));
176         trace_printf_key(key, "setup: cwd: %s\n", quote_crnl(cwd));
177         trace_printf_key(key, "setup: prefix: %s\n", quote_crnl(prefix));
178 }
179
180 int trace_want(const char *key)
181 {
182         const char *trace = getenv(key);
183
184         if (!trace || !strcmp(trace, "") ||
185             !strcmp(trace, "0") || !strcasecmp(trace, "false"))
186                 return 0;
187         return 1;
188 }