1 /**************************************************************************
3 * Copyright 2007-2011 VMware, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 **************************************************************************/
34 #include "os_thread.hpp"
35 #include "os_string.hpp"
36 #include "trace_file.hpp"
37 #include "trace_writer_local.hpp"
38 #include "trace_format.hpp"
44 static const char *memcpy_args[3] = {"dest", "src", "n"};
45 const FunctionSig memcpy_sig = {0, "memcpy", 3, memcpy_args};
47 static const char *malloc_args[1] = {"size"};
48 const FunctionSig malloc_sig = {1, "malloc", 1, malloc_args};
50 static const char *free_args[1] = {"ptr"};
51 const FunctionSig free_sig = {2, "free", 1, free_args};
53 static const char *realloc_args[2] = {"ptr", "size"};
54 const FunctionSig realloc_sig = {3, "realloc", 2, realloc_args};
57 static void exceptionCallback(void)
63 LocalWriter::LocalWriter() :
66 // Install the signal handlers as early as possible, to prevent
67 // interfering with the application's signal handling.
68 os::setExceptionCallback(exceptionCallback);
71 LocalWriter::~LocalWriter()
73 os::resetExceptionCallback();
78 LocalWriter::open(void) {
79 os::String szFileName;
81 const char *lpFileName;
83 lpFileName = getenv("TRACE_FILE");
85 static unsigned dwCounter = 0;
87 os::String process = os::getProcessName();
89 process.trimExtension();
91 process.trimDirectory();
94 os::String prefix = "/data";
96 os::String prefix = os::getCurrentDir();
104 szFileName = os::String::format("%s.%u.trace", prefix.str(), dwCounter);
106 szFileName = os::String::format("%s.trace", prefix.str());
108 lpFileName = szFileName;
109 file = fopen(lpFileName, "rb");
119 os::log("apitrace: tracing to %s\n", lpFileName);
121 if (!Writer::open(lpFileName)) {
122 os::log("apitrace: error: failed to open %s\n", lpFileName);
126 pid = os::getCurrentProcessId();
129 // For debugging the exception handler
134 static uintptr_t next_thread_num = 1;
136 static OS_THREAD_SPECIFIC_PTR(void)
139 void LocalWriter::checkProcessId(void) {
140 if (m_file->isOpened() &&
141 os::getCurrentProcessId() != pid) {
142 // We are a forked child process that inherited the trace file, so
143 // create a new file. We can't call any method of the current
144 // file, as it may cause it to flush and corrupt the parent's
145 // trace, so we effectively leak the old file object.
146 m_file = File::createSnappy();
147 // Don't want to open the same file again
148 os::unsetEnvironment("TRACE_FILE");
153 unsigned LocalWriter::beginEnter(const FunctionSig *sig) {
158 if (!m_file->isOpened()) {
162 // Although thread_num is a void *, we actually use it as a uintptr_t
163 uintptr_t this_thread_num =
164 reinterpret_cast<uintptr_t>(static_cast<void *>(thread_num));
165 if (!this_thread_num) {
166 this_thread_num = next_thread_num++;
167 thread_num = reinterpret_cast<void *>(this_thread_num);
170 assert(this_thread_num);
171 unsigned thread_id = this_thread_num - 1;
172 return Writer::beginEnter(sig, thread_id);
175 void LocalWriter::endEnter(void) {
181 void LocalWriter::beginLeave(unsigned call) {
184 Writer::beginLeave(call);
187 void LocalWriter::endLeave(void) {
193 void LocalWriter::flush(void) {
195 * Do nothing if the mutex is already acquired (e.g., if a segfault happen
196 * while writing the file) as state could be inconsistent, therefore yield
197 * inconsistent trace files and/or repeated segfaults till infinity.
202 os::log("apitrace: ignoring exception while tracing\n");
205 if (m_file->isOpened()) {
206 if (os::getCurrentProcessId() != pid) {
207 os::log("apitrace: ignoring exception in child process\n");
209 os::log("apitrace: flushing trace due to an exception\n");
219 LocalWriter localWriter;
222 } /* namespace trace */