e8ce619696f1024173d9133cebd12b61f5e0e071
   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. */
  29static int get_trace_fd(struct trace_key *key)
  30{
  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);
  43
  44        if (!trace || !strcmp(trace, "") ||
  45            !strcmp(trace, "0") || !strcasecmp(trace, "false"))
  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)) {
  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));
  58                        key->fd = STDERR_FILENO;
  59                } else {
  60                        key->fd = fd;
  61                        key->need_close = 1;
  62                }
  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;
  70        }
  71
  72        key->initialized = 1;
  73        return key->fd;
  74}
  75
  76void 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;
  83}
  84
  85static const char err_msg[] = "Could not trace into fd given by "
  86        "GIT_TRACE environment variable";
  87
  88static int prepare_trace_line(struct trace_key *key, struct strbuf *buf)
  89{
  90        static struct trace_key trace_bare = TRACE_KEY_INIT(BARE);
  91        struct timeval tv;
  92        struct tm tm;
  93        time_t secs;
  94
  95        if (!trace_want(key))
  96                return 0;
  97
  98        set_try_to_free_routine(NULL);  /* is never reset */
  99
 100        /* unit tests may want to disable additional trace output */
 101        if (trace_want(&trace_bare))
 102                return 1;
 103
 104        /* print current timestamp */
 105        gettimeofday(&tv, NULL);
 106        secs = tv.tv_sec;
 107        localtime_r(&secs, &tm);
 108        strbuf_addf(buf, "%02d:%02d:%02d.%06ld ", tm.tm_hour, tm.tm_min,
 109                    tm.tm_sec, (long) tv.tv_usec);
 110
 111        return 1;
 112}
 113
 114static void print_trace_line(struct trace_key *key, struct strbuf *buf)
 115{
 116        /* append newline if missing */
 117        if (buf->len && buf->buf[buf->len - 1] != '\n')
 118                strbuf_addch(buf, '\n');
 119
 120        write_or_whine_pipe(get_trace_fd(key), buf->buf, buf->len, err_msg);
 121        strbuf_release(buf);
 122}
 123
 124static void trace_vprintf(struct trace_key *key, const char *format, va_list ap)
 125{
 126        struct strbuf buf = STRBUF_INIT;
 127
 128        if (!prepare_trace_line(key, &buf))
 129                return;
 130
 131        strbuf_vaddf(&buf, format, ap);
 132        print_trace_line(key, &buf);
 133}
 134
 135void trace_argv_printf(const char **argv, const char *format, ...)
 136{
 137        struct strbuf buf = STRBUF_INIT;
 138        va_list ap;
 139
 140        if (!prepare_trace_line(NULL, &buf))
 141                return;
 142
 143        va_start(ap, format);
 144        strbuf_vaddf(&buf, format, ap);
 145        va_end(ap);
 146
 147        sq_quote_argv(&buf, argv, 0);
 148        print_trace_line(NULL, &buf);
 149}
 150
 151void trace_strbuf(struct trace_key *key, const struct strbuf *data)
 152{
 153        struct strbuf buf = STRBUF_INIT;
 154
 155        if (!prepare_trace_line(key, &buf))
 156                return;
 157
 158        strbuf_addbuf(&buf, data);
 159        print_trace_line(key, &buf);
 160}
 161
 162void trace_printf(const char *format, ...)
 163{
 164        va_list ap;
 165        va_start(ap, format);
 166        trace_vprintf(NULL, format, ap);
 167        va_end(ap);
 168}
 169
 170void trace_printf_key(struct trace_key *key, const char *format, ...)
 171{
 172        va_list ap;
 173        va_start(ap, format);
 174        trace_vprintf(key, format, ap);
 175        va_end(ap);
 176}
 177
 178static const char *quote_crnl(const char *path)
 179{
 180        static char new_path[PATH_MAX];
 181        const char *p2 = path;
 182        char *p1 = new_path;
 183
 184        if (!path)
 185                return NULL;
 186
 187        while (*p2) {
 188                switch (*p2) {
 189                case '\\': *p1++ = '\\'; *p1++ = '\\'; break;
 190                case '\n': *p1++ = '\\'; *p1++ = 'n'; break;
 191                case '\r': *p1++ = '\\'; *p1++ = 'r'; break;
 192                default:
 193                        *p1++ = *p2;
 194                }
 195                p2++;
 196        }
 197        *p1 = '\0';
 198        return new_path;
 199}
 200
 201/* FIXME: move prefix to startup_info struct and get rid of this arg */
 202void trace_repo_setup(const char *prefix)
 203{
 204        static struct trace_key key = TRACE_KEY_INIT(SETUP);
 205        const char *git_work_tree;
 206        char cwd[PATH_MAX];
 207
 208        if (!trace_want(&key))
 209                return;
 210
 211        if (!getcwd(cwd, PATH_MAX))
 212                die("Unable to get current working directory");
 213
 214        if (!(git_work_tree = get_git_work_tree()))
 215                git_work_tree = "(null)";
 216
 217        if (!prefix)
 218                prefix = "(null)";
 219
 220        trace_printf_key(&key, "setup: git_dir: %s\n", quote_crnl(get_git_dir()));
 221        trace_printf_key(&key, "setup: worktree: %s\n", quote_crnl(git_work_tree));
 222        trace_printf_key(&key, "setup: cwd: %s\n", quote_crnl(cwd));
 223        trace_printf_key(&key, "setup: prefix: %s\n", quote_crnl(prefix));
 224}
 225
 226int trace_want(struct trace_key *key)
 227{
 228        return !!get_trace_fd(key);
 229}