Merge branch 'maint'
[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 /* Stolen from "imap-send.c". */
29 int nfvasprintf(char **strp, const char *fmt, va_list ap)
30 {
31         int len;
32         char tmp[1024];
33
34         if ((len = vsnprintf(tmp, sizeof(tmp), fmt, ap)) < 0 ||
35             !(*strp = xmalloc(len + 1)))
36                 die("Fatal: Out of memory\n");
37         if (len >= (int)sizeof(tmp))
38                 vsprintf(*strp, fmt, ap);
39         else
40                 memcpy(*strp, tmp, len + 1);
41         return len;
42 }
43
44 int nfasprintf(char **str, const char *fmt, ...)
45 {
46         int rc;
47         va_list args;
48
49         va_start(args, fmt);
50         rc = nfvasprintf(str, fmt, args);
51         va_end(args);
52         return rc;
53 }
54
55 /* Get a trace file descriptor from GIT_TRACE env variable. */
56 static int get_trace_fd(int *need_close)
57 {
58         char *trace = getenv("GIT_TRACE");
59
60         if (!trace || !strcmp(trace, "") ||
61             !strcmp(trace, "0") || !strcasecmp(trace, "false"))
62                 return 0;
63         if (!strcmp(trace, "1") || !strcasecmp(trace, "true"))
64                 return STDERR_FILENO;
65         if (strlen(trace) == 1 && isdigit(*trace))
66                 return atoi(trace);
67         if (*trace == '/') {
68                 int fd = open(trace, O_WRONLY | O_APPEND | O_CREAT, 0666);
69                 if (fd == -1) {
70                         fprintf(stderr,
71                                 "Could not open '%s' for tracing: %s\n"
72                                 "Defaulting to tracing on stderr...\n",
73                                 trace, strerror(errno));
74                         return STDERR_FILENO;
75                 }
76                 *need_close = 1;
77                 return fd;
78         }
79
80         fprintf(stderr, "What does '%s' for GIT_TRACE means ?\n", trace);
81         fprintf(stderr, "If you want to trace into a file, "
82                 "then please set GIT_TRACE to an absolute pathname "
83                 "(starting with /).\n");
84         fprintf(stderr, "Defaulting to tracing on stderr...\n");
85
86         return STDERR_FILENO;
87 }
88
89 static const char err_msg[] = "Could not trace into fd given by "
90         "GIT_TRACE environment variable";
91
92 void trace_printf(const char *format, ...)
93 {
94         char *trace_str;
95         va_list rest;
96         int need_close = 0;
97         int fd = get_trace_fd(&need_close);
98
99         if (!fd)
100                 return;
101
102         va_start(rest, format);
103         nfvasprintf(&trace_str, format, rest);
104         va_end(rest);
105
106         write_or_whine_pipe(fd, trace_str, strlen(trace_str), err_msg);
107
108         free(trace_str);
109
110         if (need_close)
111                 close(fd);
112 }
113
114 void trace_argv_printf(const char **argv, int count, const char *format, ...)
115 {
116         char *argv_str, *format_str, *trace_str;
117         size_t argv_len, format_len, trace_len;
118         va_list rest;
119         int need_close = 0;
120         int fd = get_trace_fd(&need_close);
121
122         if (!fd)
123                 return;
124
125         /* Get the argv string. */
126         argv_str = sq_quote_argv(argv, count);
127         argv_len = strlen(argv_str);
128
129         /* Get the formated string. */
130         va_start(rest, format);
131         nfvasprintf(&format_str, format, rest);
132         va_end(rest);
133
134         /* Allocate buffer for trace string. */
135         format_len = strlen(format_str);
136         trace_len = argv_len + format_len + 1; /* + 1 for \n */
137         trace_str = xmalloc(trace_len + 1);
138
139         /* Copy everything into the trace string. */
140         strncpy(trace_str, format_str, format_len);
141         strncpy(trace_str + format_len, argv_str, argv_len);
142         strcpy(trace_str + trace_len - 1, "\n");
143
144         write_or_whine_pipe(fd, trace_str, trace_len, err_msg);
145
146         free(argv_str);
147         free(format_str);
148         free(trace_str);
149
150         if (need_close)
151                 close(fd);
152 }