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