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