Unreviewed, rolling out r234489.
[WebKit-https.git] / 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 <string.h>
30 #include <wtf/FilePrintStream.h>
31 #include <wtf/LockedPrintStream.h>
32 #include <wtf/ProcessID.h>
33 #include <wtf/Threading.h>
34 #include <mutex>
35 #include <thread>
36
37 #if OS(UNIX) || OS(DARWIN)
38 #include <unistd.h>
39 #endif
40
41 #define DATA_LOG_TO_FILE 0
42
43 // Set to 1 to use the temp directory from confstr instead of hardcoded directory.
44 // The last component of DATA_LOG_FILENAME will still be used.
45 #define DATA_LOG_TO_DARWIN_TEMP_DIR 0
46
47 // Uncomment to force logging to the given file regardless of what the environment variable says.
48 // Note that we will append ".<pid>.txt" where <pid> is the PID.
49 // This path won't work on Windows, make sure to change to something like C:\\Users\\<more path>\\log.txt.
50 #define DATA_LOG_FILENAME "/tmp/WTFLog"
51
52 namespace WTF {
53
54 static const size_t maxPathLength = 1024;
55
56 static PrintStream* s_file;
57 static uint64_t s_fileData[(sizeof(FilePrintStream) + 7) / 8];
58 static uint64_t s_lockedFileData[(sizeof(LockedPrintStream) + 7) / 8];
59
60 static void initializeLogFileOnce()
61 {
62     const char* filename = nullptr;
63
64     if (s_file)
65         return;
66
67 #if DATA_LOG_TO_FILE
68 #if DATA_LOG_TO_DARWIN_TEMP_DIR
69     char filenameBuffer[maxPathLength + 1];
70 #if defined(DATA_LOG_FILENAME)
71     const char* logBasename = strrchr(DATA_LOG_FILENAME, '/');
72     if (!logBasename)
73         logBasename = (char*)DATA_LOG_FILENAME;
74 #else
75     const char* logBasename = "WTFLog";
76 #endif
77
78     bool success = confstr(_CS_DARWIN_USER_TEMP_DIR, filenameBuffer, sizeof(filenameBuffer));
79     if (success) {
80         // FIXME: Assert that the path ends with a slash instead of adding a slash if it does not exist
81         // once <rdar://problem/23579077> is fixed in all iOS Simulator versions that we use.
82         size_t lastComponentLength = strlen(logBasename) + 20; // More than enough for ".<pid>.txt"
83         size_t dirnameLength = strlen(filenameBuffer);
84         bool shouldAddPathSeparator = filenameBuffer[dirnameLength - 1] != '/' && logBasename[0] != '/';
85         if (lastComponentLength + shouldAddPathSeparator <= sizeof(filenameBuffer) - dirnameLength - 1) {
86             if (shouldAddPathSeparator)
87                 strncat(filenameBuffer, "/", 1);
88             strncat(filenameBuffer, logBasename, sizeof(filenameBuffer) - strlen(filenameBuffer) - 1);
89             filename = filenameBuffer;
90         }
91     }
92 #elif defined(DATA_LOG_FILENAME)
93     filename = DATA_LOG_FILENAME;
94 #else
95     filename = getenv("WTF_DATA_LOG_FILENAME");
96 #endif
97     char actualFilename[maxPathLength + 1];
98
99     if (filename && !strstr(filename, "%pid")) {
100         snprintf(actualFilename, sizeof(actualFilename), "%s.%%pid.txt", filename);
101         filename = actualFilename;
102     }
103 #endif // DATA_LOG_TO_FILE
104
105     setDataFile(filename);
106 }
107
108 static void initializeLogFile()
109 {
110     static std::once_flag once;
111     std::call_once(
112         once,
113         [] {
114             initializeLogFileOnce();
115         });
116 }
117
118 void setDataFile(const char* path)
119 {
120     FilePrintStream* file = nullptr;
121     char formattedPath[maxPathLength + 1];
122     const char* pathToOpen = path;
123
124     if (path) {
125         const char* pidFormat = strstr(path, "%pid");
126         if (pidFormat) {
127             size_t leadingPathLength = pidFormat - path;
128             size_t pathCharactersAvailable = std::min(maxPathLength, leadingPathLength);
129             strncpy(formattedPath, path, pathCharactersAvailable);
130             char* nextDest = formattedPath + pathCharactersAvailable;
131             pathCharactersAvailable = maxPathLength - pathCharactersAvailable;
132             if (pathCharactersAvailable) {
133                 int pidTextLength = snprintf(nextDest, pathCharactersAvailable, "%d", getCurrentProcessID());
134
135                 if (pidTextLength < 0 || static_cast<size_t>(pidTextLength) >= pathCharactersAvailable)
136                     pathCharactersAvailable = 0;
137                 else {
138                     pathCharactersAvailable -= static_cast<size_t>(pidTextLength);
139                     nextDest += pidTextLength;
140                     strncpy(nextDest, pidFormat + 4, pathCharactersAvailable);
141                 }
142             }
143             formattedPath[maxPathLength] = '\0';
144             pathToOpen = formattedPath;
145         }
146
147         file = FilePrintStream::open(pathToOpen, "w").release();
148         if (file)
149             WTFLogAlways("*** DataLog output to \"%s\" ***\n", pathToOpen);
150         else
151             WTFLogAlways("Warning: Could not open DataLog file %s for writing.\n", pathToOpen);
152     }
153
154     if (!file) {
155         // Use placement new; this makes it easier to use dataLog() to debug
156         // fastMalloc.
157         file = new (s_fileData) FilePrintStream(stderr, FilePrintStream::Borrow);
158     }
159
160     setvbuf(file->file(), 0, _IONBF, 0); // Prefer unbuffered output, so that we get a full log upon crash or deadlock.
161
162     if (s_file)
163         s_file->flush();
164
165     s_file = new (s_lockedFileData) LockedPrintStream(std::unique_ptr<FilePrintStream>(file));
166 }
167
168 PrintStream& dataFile()
169 {
170     initializeLogFile();
171     return *s_file;
172 }
173
174 void dataLogFV(const char* format, va_list argList)
175 {
176     dataFile().vprintf(format, argList);
177 }
178
179 void dataLogF(const char* format, ...)
180 {
181     va_list argList;
182     va_start(argList, format);
183     dataLogFV(format, argList);
184     va_end(argList);
185 }
186
187 void dataLogFString(const char* str)
188 {
189     dataFile().printf("%s", str);
190 }
191
192 } // namespace WTF
193