git.cworth.org Git - apitrace/blob - trace_write.cpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2007-2009 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 <map>
  34
  35 #include <zlib.h>
  36
  37 #include "os.hpp"
  38 #include "trace_write.hpp"
  39 #include "trace_format.hpp"
  40
  41
  42 namespace Trace {
  43
  44
  45 static gzFile g_gzFile = NULL;
  46 static void _Close(void) {
  47    if(g_gzFile != NULL) {
  48       gzclose(g_gzFile);
  49       g_gzFile = NULL;
  50    }
  51 }
  52
  53 static void _Open(const char *szExtension) {
  54    _Close();
  55
  56    static unsigned dwCounter = 0;
  57
  58    char szFileName[PATH_MAX];
  59    const char *lpFileName;
  60
  61    lpFileName = getenv("TRACE_PATH");
  62    if (lpFileName) {
  63        strncpy(szFileName, lpFileName, PATH_MAX);
  64    }
  65    else {
  66        char szProcessName[PATH_MAX];
  67        char szCurrentDir[PATH_MAX];
  68        OS::GetProcessName(szProcessName, PATH_MAX);
  69        OS::GetCurrentDir(szCurrentDir, PATH_MAX);
  70
  71        for(;;) {
  72           FILE *file;
  73
  74           if (dwCounter)
  75              snprintf(szFileName, PATH_MAX, "%s%c%s.%u.%s", szCurrentDir, PATH_SEP, szProcessName, dwCounter, szExtension);
  76           else
  77              snprintf(szFileName, PATH_MAX, "%s%c%s.%s", szCurrentDir, PATH_SEP, szProcessName, szExtension);
  78
  79           file = fopen(szFileName, "rb");
  80           if(file == NULL)
  81              break;
  82
  83           fclose(file);
  84
  85           ++dwCounter;
  86        }
  87    }
  88
  89    OS::DebugMessage("apitrace: tracing to %s\n", szFileName);
  90
  91    g_gzFile = gzopen(szFileName, "wb");
  92 }
  93
  94 static inline void Write(const void *sBuffer, size_t dwBytesToWrite) {
  95    if (g_gzFile == NULL)
  96       return;
  97
  98    gzwrite(g_gzFile, sBuffer, dwBytesToWrite);
  99 }
 100
 101 static inline void
 102 WriteByte(char c) {
 103    Write(&c, 1);
 104 }
 105
 106 void inline
 107 WriteUInt(unsigned long long value) {
 108    char buf[2 * sizeof value];
 109    unsigned len;
 110
 111    len = 0;
 112    do {
 113       assert(len < sizeof buf);
 114       buf[len] = 0x80 | (value & 0x7f);
 115       value >>= 7;
 116       ++len;
 117    } while (value);
 118
 119    assert(len);
 120    buf[len - 1] &= 0x7f;
 121
 122    Write(buf, len);
 123 }
 124
 125 static inline void
 126 WriteFloat(float value) {
 127    assert(sizeof value == 4);
 128    Write((const char *)&value, sizeof value);
 129 }
 130
 131 static inline void
 132 WriteDouble(double value) {
 133    assert(sizeof value == 8);
 134    Write((const char *)&value, sizeof value);
 135 }
 136
 137 static inline void
 138 WriteString(const char *str) {
 139    size_t len = strlen(str);
 140    WriteUInt(len);
 141    Write(str, len);
 142 }
 143
 144 void Open(void) {
 145     if (!g_gzFile) {
 146         _Open("trace");
 147         WriteUInt(TRACE_VERSION);
 148     }
 149 }
 150
 151 void Close(void) {
 152    _Close();
 153 }
 154
 155 static unsigned call_no = 0;
 156
 157 static std::map<Id, bool> functions;
 158 static std::map<Id, bool> structs;
 159 static std::map<Id, bool> enums;
 160 static std::map<Id, bool> bitmasks;
 161
 162
 163 unsigned BeginEnter(const FunctionSig &function) {
 164    OS::AcquireMutex();
 165    Open();
 166    WriteByte(Trace::EVENT_ENTER);
 167    WriteUInt(function.id);
 168    if (!functions[function.id]) {
 169       WriteString(function.name);
 170       WriteUInt(function.num_args);
 171       for (unsigned i = 0; i < function.num_args; ++i) {
 172          WriteString(function.args[i]);
 173       }
 174       functions[function.id] = true;
 175    }
 176    return call_no++;
 177 }
 178
 179 void EndEnter(void) {
 180    WriteByte(Trace::CALL_END);
 181    gzflush(g_gzFile, Z_SYNC_FLUSH);
 182    OS::ReleaseMutex();
 183 }
 184
 185 void BeginLeave(unsigned call) {
 186    OS::AcquireMutex();
 187    WriteByte(Trace::EVENT_LEAVE);
 188    WriteUInt(call);
 189 }
 190
 191 void EndLeave(void) {
 192    WriteByte(Trace::CALL_END);
 193    gzflush(g_gzFile, Z_SYNC_FLUSH);
 194    OS::ReleaseMutex();
 195 }
 196
 197 void BeginArg(unsigned index) {
 198    WriteByte(Trace::CALL_ARG);
 199    WriteUInt(index);
 200 }
 201
 202 void BeginReturn(void) {
 203    WriteByte(Trace::CALL_RET);
 204 }
 205
 206 void BeginArray(size_t length) {
 207    WriteByte(Trace::TYPE_ARRAY);
 208    WriteUInt(length);
 209 }
 210
 211 void BeginStruct(const StructSig *sig) {
 212    WriteByte(Trace::TYPE_STRUCT);
 213    WriteUInt(sig->id);
 214    if (!structs[sig->id]) {
 215       WriteString(sig->name);
 216       WriteUInt(sig->num_members);
 217       for (unsigned i = 0; i < sig->num_members; ++i) {
 218          WriteString(sig->members[i]);
 219       }
 220       structs[sig->id] = true;
 221    }
 222 }
 223
 224 void LiteralBool(bool value) {
 225    WriteByte(value ? Trace::TYPE_TRUE : Trace::TYPE_FALSE);
 226 }
 227
 228 void LiteralSInt(signed long long value) {
 229    if (value < 0) {
 230       WriteByte(Trace::TYPE_SINT);
 231       WriteUInt(-value);
 232    } else {
 233       WriteByte(Trace::TYPE_UINT);
 234       WriteUInt(value);
 235    }
 236 }
 237
 238 void LiteralUInt(unsigned long long value) {
 239    WriteByte(Trace::TYPE_UINT);
 240    WriteUInt(value);
 241 }
 242
 243 void LiteralFloat(float value) {
 244    WriteByte(Trace::TYPE_FLOAT);
 245    WriteFloat(value);
 246 }
 247
 248 void LiteralFloat(double value) {
 249    WriteByte(Trace::TYPE_DOUBLE);
 250    WriteDouble(value);
 251 }
 252
 253 void LiteralString(const char *str) {
 254    if (!str) {
 255       LiteralNull();
 256       return;
 257    }
 258    WriteByte(Trace::TYPE_STRING);
 259    WriteString(str);
 260 }
 261
 262 void LiteralString(const char *str, size_t len) {
 263    if (!str) {
 264       LiteralNull();
 265       return;
 266    }
 267    WriteByte(Trace::TYPE_STRING);
 268    WriteUInt(len);
 269    Write(str, len);
 270 }
 271
 272 void LiteralWString(const wchar_t *str) {
 273    if (!str) {
 274       LiteralNull();
 275       return;
 276    }
 277    WriteByte(Trace::TYPE_STRING);
 278    WriteString("<wide-string>");
 279 }
 280
 281 void LiteralBlob(const void *data, size_t size) {
 282    if (!data) {
 283       LiteralNull();
 284       return;
 285    }
 286    WriteByte(Trace::TYPE_BLOB);
 287    WriteUInt(size);
 288    if (size) {
 289       Write(data, size);
 290    }
 291 }
 292
 293 void LiteralEnum(const EnumSig *sig) {
 294    WriteByte(Trace::TYPE_ENUM);
 295    WriteUInt(sig->id);
 296    if (!enums[sig->id]) {
 297       WriteString(sig->name);
 298       LiteralSInt(sig->value);
 299       enums[sig->id] = true;
 300    }
 301 }
 302
 303 void LiteralBitmask(const BitmaskSig &bitmask, unsigned long long value) {
 304    WriteByte(Trace::TYPE_BITMASK);
 305    WriteUInt(bitmask.id);
 306    if (!bitmasks[bitmask.id]) {
 307       WriteUInt(bitmask.count);
 308       for (unsigned i = 0; i < bitmask.count; ++i) {
 309          WriteString(bitmask.values[i].name);
 310          WriteUInt(bitmask.values[i].value);
 311       }
 312       bitmasks[bitmask.id] = true;
 313    }
 314    WriteUInt(value);
 315 }
 316
 317 void LiteralNull(void) {
 318    WriteByte(Trace::TYPE_NULL);
 319 }
 320
 321 void LiteralOpaque(const void *addr) {
 322    if (!addr) {
 323       LiteralNull();
 324       return;
 325    }
 326    WriteByte(Trace::TYPE_OPAQUE);
 327    WriteUInt((size_t)addr);
 328 }
 329
 330 void Abort(void) {
 331     Close();
 332     OS::Abort();
 333 }
 334
 335 } /* namespace Trace */