rebase: clearer names for directory variables
[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 GIT_TRACE env variable. */
29 static int get_trace_fd(int *need_close)
30 {
31         char *trace = getenv("GIT_TRACE");
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 GIT_TRACE mean?\n", trace);
54         fprintf(stderr, "If you want to trace into a file, "
55                 "then please set GIT_TRACE to an absolute pathname "
56                 "(starting with /).\n");
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_printf(const char *fmt, ...)
66 {
67         struct strbuf buf;
68         va_list ap;
69         int fd, len, need_close = 0;
70
71         fd = get_trace_fd(&need_close);
72         if (!fd)
73                 return;
74
75         set_try_to_free_routine(NULL);  /* is never reset */
76         strbuf_init(&buf, 64);
77         va_start(ap, fmt);
78         len = vsnprintf(buf.buf, strbuf_avail(&buf), fmt, ap);
79         va_end(ap);
80         if (len >= strbuf_avail(&buf)) {
81                 strbuf_grow(&buf, len - strbuf_avail(&buf) + 128);
82                 va_start(ap, fmt);
83                 len = vsnprintf(buf.buf, strbuf_avail(&buf), fmt, ap);
84                 va_end(ap);
85                 if (len >= strbuf_avail(&buf))
86                         die("broken vsnprintf");
87         }
88         strbuf_setlen(&buf, len);
89
90         write_or_whine_pipe(fd, buf.buf, buf.len, err_msg);
91         strbuf_release(&buf);
92
93         if (need_close)
94                 close(fd);
95 }
96
97 void trace_argv_printf(const char **argv, const char *fmt, ...)
98 {
99         struct strbuf buf;
100         va_list ap;
101         int fd, len, need_close = 0;
102
103         fd = get_trace_fd(&need_close);
104         if (!fd)
105                 return;
106
107         set_try_to_free_routine(NULL);  /* is never reset */
108         strbuf_init(&buf, 64);
109         va_start(ap, fmt);
110         len = vsnprintf(buf.buf, strbuf_avail(&buf), fmt, ap);
111         va_end(ap);
112         if (len >= strbuf_avail(&buf)) {
113                 strbuf_grow(&buf, len - strbuf_avail(&buf) + 128);
114                 va_start(ap, fmt);
115                 len = vsnprintf(buf.buf, strbuf_avail(&buf), fmt, ap);
116                 va_end(ap);
117                 if (len >= strbuf_avail(&buf))
118                         die("broken vsnprintf");
119         }
120         strbuf_setlen(&buf, len);
121
122         sq_quote_argv(&buf, argv, 0);
123         strbuf_addch(&buf, '\n');
124         write_or_whine_pipe(fd, buf.buf, buf.len, err_msg);
125         strbuf_release(&buf);
126
127         if (need_close)
128                 close(fd);
129 }
130
131 static const char *quote_crnl(const char *path)
132 {
133         static char new_path[PATH_MAX];
134         const char *p2 = path;
135         char *p1 = new_path;
136
137         if (!path)
138                 return NULL;
139
140         while (*p2) {
141                 switch (*p2) {
142                 case '\\': *p1++ = '\\'; *p1++ = '\\'; break;
143                 case '\n': *p1++ = '\\'; *p1++ = 'n'; break;
144                 case '\r': *p1++ = '\\'; *p1++ = 'r'; break;
145                 default:
146                         *p1++ = *p2;
147                 }
148                 p2++;
149         }
150         *p1 = '\0';
151         return new_path;
152 }
153
154 /* FIXME: move prefix to startup_info struct and get rid of this arg */
155 void trace_repo_setup(const char *prefix)
156 {
157         const char *git_work_tree;
158         char cwd[PATH_MAX];
159         char *trace = getenv("GIT_TRACE");
160
161         if (!trace || !strcmp(trace, "") ||
162             !strcmp(trace, "0") || !strcasecmp(trace, "false"))
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("setup: git_dir: %s\n", quote_crnl(get_git_dir()));
175         trace_printf("setup: worktree: %s\n", quote_crnl(git_work_tree));
176         trace_printf("setup: cwd: %s\n", quote_crnl(cwd));
177         trace_printf("setup: prefix: %s\n", quote_crnl(prefix));
178 }