third_party/WebKit/Source/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
  29 #if OS(POSIX)
  30 #include <pthread.h>
  31 #include <unistd.h>
  32 #endif
  33
  34 #define DATA_LOG_TO_FILE 0
  35
  36 // Uncomment to force logging to the given file regardless of what the environment variable says. Note that
  37 // we will append ".<pid>.txt" where <pid> is the PID.
  38
  39 // This path won't work on Windows, make sure to change to something like C:\\Users\\<more path>\\log.txt.
  40 #define DATA_LOG_FILENAME "/tmp/WTFLog"
  41
  42 namespace WTF {
  43
  44 #if USE(PTHREADS)
  45 static pthread_once_t initializeLogFileOnceKey = PTHREAD_ONCE_INIT;
  46 #endif
  47
  48 static FilePrintStream* file;
  49
  50 static void initializeLogFileOnce()
  51 {
  52 #if DATA_LOG_TO_FILE
  53 #ifdef DATA_LOG_FILENAME
  54     const char* filename = DATA_LOG_FILENAME;
  55 #else
  56     const char* filename = getenv("WTF_DATA_LOG_FILENAME");
  57 #endif
  58     char actualFilename[1024];
  59
  60     snprintf(actualFilename, sizeof(actualFilename), "%s.%d.txt", filename, getpid());
  61
  62     if (filename) {
  63         file = FilePrintStream::open(actualFilename, "w").leakPtr();
  64         if (!file)
  65             fprintf(stderr, "Warning: Could not open log file %s for writing.\n", actualFilename);
  66     }
  67 #endif // DATA_LOG_TO_FILE
  68     if (!file)
  69         file = new FilePrintStream(stderr, FilePrintStream::Borrow);
  70
  71     setvbuf(file->file(), 0, _IONBF, 0); // Prefer unbuffered output, so that we get a full log upon crash or deadlock.
  72 }
  73
  74 static void initializeLogFile()
  75 {
  76 #if USE(PTHREADS)
  77     pthread_once(&initializeLogFileOnceKey, initializeLogFileOnce);
  78 #else
  79     if (!file)
  80         initializeLogFileOnce();
  81 #endif
  82 }
  83
  84 FilePrintStream& dataFile()
  85 {
  86     initializeLogFile();
  87     return *file;
  88 }
  89
  90 void dataLogFV(const char* format, va_list argList)
  91 {
  92     dataFile().vprintf(format, argList);
  93 }
  94
  95 void dataLogF(const char* format, ...)
  96 {
  97     va_list argList;
  98     va_start(argList, format);
  99     dataLogFV(format, argList);
 100     va_end(argList);
 101 }
 102
 103 void dataLogFString(const char* str)
 104 {
 105     dataFile().printf("%s", str);
 106 }
 107
 108 } // namespace WTF
 109