git.cworth.org Git - apitrace/blob - common/trace_writer_local.cpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2007-2011 VMware, Inc.
   4  * All Rights Reserved.
   5  *
   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:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  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
  22  * THE SOFTWARE.
  23  *
  24  **************************************************************************/
  25
  26
  27 #include <assert.h>
  28 #include <stdarg.h>
  29 #include <stdio.h>
  30 #include <stdlib.h>
  31 #include <string.h>
  32
  33 #include "os.hpp"
  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"
  39
  40
  41 namespace trace {
  42
  43
  44 static const char *memcpy_args[3] = {"dest", "src", "n"};
  45 const FunctionSig memcpy_sig = {0, "memcpy", 3, memcpy_args};
  46
  47 static const char *malloc_args[1] = {"size"};
  48 const FunctionSig malloc_sig = {1, "malloc", 1, malloc_args};
  49
  50 static const char *free_args[1] = {"ptr"};
  51 const FunctionSig free_sig = {2, "free", 1, free_args};
  52
  53 static const char *realloc_args[2] = {"ptr", "size"};
  54 const FunctionSig realloc_sig = {3, "realloc", 2, realloc_args};
  55
  56
  57 static void exceptionCallback(void)
  58 {
  59     localWriter.flush();
  60 }
  61
  62
  63 LocalWriter::LocalWriter() :
  64     acquired(0)
  65 {
  66     os::log("apitrace: loaded\n");
  67
  68     // Install the signal handlers as early as possible, to prevent
  69     // interfering with the application's signal handling.
  70     os::setExceptionCallback(exceptionCallback);
  71 }
  72
  73 LocalWriter::~LocalWriter()
  74 {
  75     os::resetExceptionCallback();
  76     checkProcessId();
  77 }
  78
  79 void
  80 LocalWriter::open(void) {
  81     os::String szFileName;
  82
  83     const char *lpFileName;
  84
  85     lpFileName = getenv("TRACE_FILE");
  86     if (!lpFileName) {
  87         static unsigned dwCounter = 0;
  88
  89         os::String process = os::getProcessName();
  90 #ifdef _WIN32
  91         process.trimExtension();
  92 #endif
  93         process.trimDirectory();
  94
  95 #ifdef ANDROID
  96         os::String prefix = "/data";
  97 #else
  98         os::String prefix = os::getCurrentDir();
  99 #endif
 100         prefix.join(process);
 101
 102         for (;;) {
 103             FILE *file;
 104
 105             if (dwCounter)
 106                 szFileName = os::String::format("%s.%u.trace", prefix.str(), dwCounter);
 107             else
 108                 szFileName = os::String::format("%s.trace", prefix.str());
 109
 110             lpFileName = szFileName;
 111             file = fopen(lpFileName, "rb");
 112             if (file == NULL)
 113                 break;
 114
 115             fclose(file);
 116
 117             ++dwCounter;
 118         }
 119     }
 120
 121     os::log("apitrace: tracing to %s\n", lpFileName);
 122
 123     if (!Writer::open(lpFileName)) {
 124         os::log("apitrace: error: failed to open %s\n", lpFileName);
 125         os::abort();
 126     }
 127
 128     pid = os::getCurrentProcessId();
 129
 130 #if 0
 131     // For debugging the exception handler
 132     *((int *)0) = 0;
 133 #endif
 134 }
 135
 136 static uintptr_t next_thread_num = 1;
 137
 138 static OS_THREAD_SPECIFIC_PTR(void)
 139 thread_num;
 140
 141 void LocalWriter::checkProcessId(void) {
 142     if (m_file->isOpened() &&
 143         os::getCurrentProcessId() != pid) {
 144         // We are a forked child process that inherited the trace file, so
 145         // create a new file.  We can't call any method of the current
 146         // file, as it may cause it to flush and corrupt the parent's
 147         // trace, so we effectively leak the old file object.
 148         m_file = File::createSnappy();
 149         // Don't want to open the same file again
 150         os::unsetEnvironment("TRACE_FILE");
 151         open();
 152     }
 153 }
 154
 155 unsigned LocalWriter::beginEnter(const FunctionSig *sig) {
 156     mutex.lock();
 157     ++acquired;
 158
 159     checkProcessId();
 160     if (!m_file->isOpened()) {
 161         open();
 162     }
 163
 164     // Although thread_num is a void *, we actually use it as a uintptr_t
 165     uintptr_t this_thread_num =
 166         reinterpret_cast<uintptr_t>(static_cast<void *>(thread_num));
 167     if (!this_thread_num) {
 168         this_thread_num = next_thread_num++;
 169         thread_num = reinterpret_cast<void *>(this_thread_num);
 170     }
 171
 172     assert(this_thread_num);
 173     unsigned thread_id = this_thread_num - 1;
 174     return Writer::beginEnter(sig, thread_id);
 175 }
 176
 177 void LocalWriter::endEnter(void) {
 178     Writer::endEnter();
 179     --acquired;
 180     mutex.unlock();
 181 }
 182
 183 void LocalWriter::beginLeave(unsigned call) {
 184     mutex.lock();
 185     ++acquired;
 186     Writer::beginLeave(call);
 187 }
 188
 189 void LocalWriter::endLeave(void) {
 190     Writer::endLeave();
 191     --acquired;
 192     mutex.unlock();
 193 }
 194
 195 void LocalWriter::flush(void) {
 196     /*
 197      * Do nothing if the mutex is already acquired (e.g., if a segfault happen
 198      * while writing the file) as state could be inconsistent, therefore yield
 199      * inconsistent trace files and/or repeated segfaults till infinity.
 200      */
 201
 202     mutex.lock();
 203     if (acquired) {
 204         os::log("apitrace: ignoring exception while tracing\n");
 205     } else {
 206         ++acquired;
 207         if (m_file->isOpened()) {
 208             if (os::getCurrentProcessId() != pid) {
 209                 os::log("apitrace: ignoring exception in child process\n");
 210             } else {
 211                 os::log("apitrace: flushing trace due to an exception\n");
 212                 m_file->flush();
 213             }
 214         }
 215         --acquired;
 216     }
 217     mutex.unlock();
 218 }
 219
 220
 221 LocalWriter localWriter;
 222
 223
 224 } /* namespace trace */
 225