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