Source/WTF/wtf/DataLog.cpp

   1 /*
   2  * Copyright (C) 2012 Apple Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #include "config.h"
  27 #include "DataLog.h"
  28 #include <stdarg.h>
  29 #include <wtf/Threading.h>
  30
  31 #define DATA_LOG_TO_FILE 0
  32
  33 // Uncomment to force logging to the given file regardless of what the environment variable says.
  34 // #define DATA_LOG_FILENAME "/tmp/WTFLog.txt"
  35
  36 namespace WTF {
  37
  38 #if DATA_LOG_TO_FILE
  39 static FILE* file;
  40
  41 static void initializeLogFileOnce()
  42 {
  43 #ifdef DATA_LOG_FILENAME
  44     const char* filename = DATA_LOG_FILENAME;
  45 #else
  46     const char* filename = getenv("WTF_DATA_LOG_FILENAME");
  47 #endif
  48     if (filename) {
  49         file = fopen(filename, "w");
  50         if (!file)
  51             fprintf(stderr, "Warning: Could not open log file %s for writing.\n", filename);
  52     }
  53     if (!file)
  54         file = stderr;
  55
  56     setvbuf(file, 0, _IONBF, 0); // Prefer unbuffered output, so that we get a full log upon crash or deadlock.
  57 }
  58
  59 #if OS(DARWIN)
  60 static pthread_once_t initializeLogFileOnceKey = PTHREAD_ONCE_INIT;
  61 #endif
  62
  63 static void initializeLogFile()
  64 {
  65 #if OS(DARWIN)
  66     pthread_once(&initializeLogFileOnceKey, initializeLogFileOnce);
  67 #else
  68     if (!file)
  69         initializeLogFileOnce();
  70 #endif
  71 }
  72
  73 FILE* dataFile()
  74 {
  75     initializeLogFile();
  76     return file;
  77 }
  78 #else // DATA_LOG_TO_FILE
  79 FILE* dataFile()
  80 {
  81     return stderr;
  82 }
  83 #endif // DATA_LOG_TO_FILE
  84
  85 void dataLogV(const char* format, va_list argList)
  86 {
  87     vfprintf(dataFile(), format, argList);
  88 }
  89
  90 void dataLog(const char* format, ...)
  91 {
  92     va_list argList;
  93     va_start(argList, format);
  94     dataLogV(format, argList);
  95     va_end(argList);
  96 }
  97
  98 void dataLogString(const char* str)
  99 {
 100     fputs(str, dataFile());
 101 }
 102
 103 } // namespace WTF
 104