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_path.hpp"
  35 #include "trace_file.hpp"
  36 #include "trace_writer.hpp"
  37 #include "trace_format.hpp"
  38
  39
  40 namespace trace {
  41
  42
  43 static const char *memcpy_args[3] = {"dest", "src", "n"};
  44 const FunctionSig memcpy_sig = {0, "memcpy", 3, memcpy_args};
  45
  46 static const char *malloc_args[1] = {"size"};
  47 const FunctionSig malloc_sig = {1, "malloc", 1, malloc_args};
  48
  49 static const char *free_args[1] = {"ptr"};
  50 const FunctionSig free_sig = {2, "free", 1, free_args};
  51
  52 static const char *realloc_args[2] = {"ptr", "size"};
  53 const FunctionSig realloc_sig = {3, "realloc", 2, realloc_args};
  54
  55
  56 static void exceptionCallback(void)
  57 {
  58     localWriter.flush();
  59 }
  60
  61
  62 LocalWriter::LocalWriter() :
  63     acquired(0)
  64 {
  65     // Install the signal handlers as early as possible, to prevent
  66     // interfering with the application's signal handling.
  67     os::setExceptionCallback(exceptionCallback);
  68 }
  69
  70 LocalWriter::~LocalWriter()
  71 {
  72     os::resetExceptionCallback();
  73 }
  74
  75 void
  76 LocalWriter::open(void) {
  77     os::Path szFileName;
  78
  79     const char *lpFileName;
  80
  81     lpFileName = getenv("TRACE_FILE");
  82     if (!lpFileName) {
  83         static unsigned dwCounter = 0;
  84
  85         os::Path process = os::getProcessName();
  86 #ifdef _WIN32
  87         process.trimExtension();
  88 #endif
  89         process.trimDirectory();
  90
  91         os::Path prefix = os::getCurrentDir();
  92         prefix.join(process);
  93
  94         for (;;) {
  95             FILE *file;
  96
  97             if (dwCounter)
  98                 szFileName = os::Path::format("%s.%u.trace", prefix.str(), dwCounter);
  99             else
 100                 szFileName = os::Path::format("%s.trace", prefix.str());
 101
 102             file = fopen(lpFileName, "rb");
 103             if (file == NULL)
 104                 break;
 105
 106             fclose(file);
 107
 108             ++dwCounter;
 109         }
 110
 111         lpFileName = szFileName;
 112     }
 113
 114     os::log("apitrace: tracing to %s\n", lpFileName);
 115
 116     Writer::open(lpFileName);
 117
 118 #if 0
 119     // For debugging the exception handler
 120     *((int *)0) = 0;
 121 #endif
 122 }
 123
 124 unsigned LocalWriter::beginEnter(const FunctionSig *sig) {
 125     os::acquireMutex();
 126     ++acquired;
 127
 128     if (!m_file->isOpened()) {
 129         open();
 130     }
 131
 132     return Writer::beginEnter(sig);
 133 }
 134
 135 void LocalWriter::endEnter(void) {
 136     Writer::endEnter();
 137     --acquired;
 138     os::releaseMutex();
 139 }
 140
 141 void LocalWriter::beginLeave(unsigned call) {
 142     os::acquireMutex();
 143     ++acquired;
 144     Writer::beginLeave(call);
 145 }
 146
 147 void LocalWriter::endLeave(void) {
 148     Writer::endLeave();
 149     --acquired;
 150     os::releaseMutex();
 151 }
 152
 153 void LocalWriter::flush(void) {
 154     /*
 155      * Do nothing if the mutex is already acquired (e.g., if a segfault happen
 156      * while writing the file) to prevent dead-lock.
 157      */
 158
 159     if (!acquired) {
 160         os::acquireMutex();
 161         if (m_file->isOpened()) {
 162             os::log("apitrace: flushing trace due to an exception\n");
 163             m_file->flush();
 164         }
 165         os::releaseMutex();
 166     }
 167 }
 168
 169
 170 LocalWriter localWriter;
 171
 172
 173 } /* namespace trace */
 174