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     // Install the signal handlers as early as possible, to prevent
  67     // interfering with the application's signal handling.
  68     os::setExceptionCallback(exceptionCallback);
  69 }
  70
  71 LocalWriter::~LocalWriter()
  72 {
  73     os::resetExceptionCallback();
  74 }
  75
  76 void
  77 LocalWriter::open(void) {
  78     os::String szFileName;
  79
  80     const char *lpFileName;
  81
  82     lpFileName = getenv("TRACE_FILE");
  83     if (!lpFileName) {
  84         static unsigned dwCounter = 0;
  85
  86         os::String process = os::getProcessName();
  87 #ifdef _WIN32
  88         process.trimExtension();
  89 #endif
  90         process.trimDirectory();
  91
  92 #ifdef ANDROID
  93         os::String prefix = "/data";
  94 #else
  95         os::String prefix = os::getCurrentDir();
  96 #endif
  97         prefix.join(process);
  98
  99         for (;;) {
 100             FILE *file;
 101
 102             if (dwCounter)
 103                 szFileName = os::String::format("%s.%u.trace", prefix.str(), dwCounter);
 104             else
 105                 szFileName = os::String::format("%s.trace", prefix.str());
 106
 107             lpFileName = szFileName;
 108             file = fopen(lpFileName, "rb");
 109             if (file == NULL)
 110                 break;
 111
 112             fclose(file);
 113
 114             ++dwCounter;
 115         }
 116     }
 117
 118     os::log("apitrace: tracing to %s\n", lpFileName);
 119
 120     if (!Writer::open(lpFileName)) {
 121         os::log("apitrace: error: failed to open %s\n", lpFileName);
 122         os::abort();
 123     }
 124
 125     pid = os::getCurrentProcessId();
 126
 127 #if 0
 128     // For debugging the exception handler
 129     *((int *)0) = 0;
 130 #endif
 131 }
 132
 133 static uintptr_t next_thread_num = 1;
 134
 135 static OS_THREAD_SPECIFIC_PTR(void)
 136 thread_num;
 137
 138 unsigned LocalWriter::beginEnter(const FunctionSig *sig) {
 139     mutex.lock();
 140     ++acquired;
 141
 142     if (!m_file->isOpened()) {
 143         open();
 144     } else {
 145         if (os::getCurrentProcessId() != pid) {
 146             // We are a forked child process that inherited the trace file, so
 147             // create a new file.  We can't call any method of the current
 148             // file, as it may cause it to flush and corrupt the parent's
 149             // trace, so we effectively leak the old file object.
 150             m_file = File::createSnappy();
 151             // Don't want to open the same file again
 152             os::unsetEnvironment("TRACE_FILE");
 153             open();
 154         }
 155     }
 156
 157     // Although thread_num is a void *, we actually use it as a uintptr_t
 158     uintptr_t this_thread_num =
 159         reinterpret_cast<uintptr_t>(static_cast<void *>(thread_num));
 160     if (!this_thread_num) {
 161         this_thread_num = next_thread_num++;
 162         thread_num = reinterpret_cast<void *>(this_thread_num);
 163     }
 164
 165     assert(this_thread_num);
 166     unsigned thread_id = this_thread_num - 1;
 167     return Writer::beginEnter(sig, thread_id);
 168 }
 169
 170 void LocalWriter::endEnter(void) {
 171     Writer::endEnter();
 172     --acquired;
 173     mutex.unlock();
 174 }
 175
 176 void LocalWriter::beginLeave(unsigned call) {
 177     mutex.lock();
 178     ++acquired;
 179     Writer::beginLeave(call);
 180 }
 181
 182 void LocalWriter::endLeave(void) {
 183     Writer::endLeave();
 184     --acquired;
 185     mutex.unlock();
 186 }
 187
 188 void LocalWriter::flush(void) {
 189     if (os::getCurrentProcessId() != pid) {
 190         os::log("apitrace: ignoring exception in child process\n");
 191         return;
 192     }
 193
 194     /*
 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.
 198      */
 199
 200     mutex.lock();
 201     if (acquired) {
 202         os::log("apitrace: ignoring exception while tracing\n");
 203     } else {
 204         ++acquired;
 205         if (m_file->isOpened()) {
 206             os::log("apitrace: flushing trace due to an exception\n");
 207             m_file->flush();
 208         }
 209         --acquired;
 210     }
 211     mutex.unlock();
 212 }
 213
 214
 215 LocalWriter localWriter;
 216
 217
 218 } /* namespace trace */
 219