git.cworth.org Git - apitrace/blob - trace_writer.hpp

   1 /**************************************************************************
   2  *
   3  * Copyright 2007-2010 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  * Trace writing functions.
  28  */
  29
  30 #ifndef _TRACE_WRITER_HPP_
  31 #define _TRACE_WRITER_HPP_
  32
  33
  34 #include <stddef.h>
  35
  36 #include <vector>
  37
  38 #include "trace_model.hpp"
  39
  40
  41 namespace Trace {
  42
  43     class Writer {
  44     protected:
  45         void *g_gzFile;
  46         unsigned call_no;
  47
  48         std::vector<bool> functions;
  49         std::vector<bool> structs;
  50         std::vector<bool> enums;
  51         std::vector<bool> bitmasks;
  52
  53     public:
  54         Writer();
  55         ~Writer();
  56
  57         bool open(const char *filename);
  58         void close(void);
  59
  60         unsigned beginEnter(const FunctionSig *sig);
  61         void endEnter(void);
  62
  63         void beginLeave(unsigned call);
  64         void endLeave(void);
  65
  66         void beginArg(unsigned index);
  67         inline void endArg(void) {}
  68
  69         void beginReturn(void);
  70         inline void endReturn(void) {}
  71
  72         void beginArray(size_t length);
  73         inline void endArray(void) {}
  74
  75         inline void beginElement(void) {}
  76         inline void endElement(void) {}
  77
  78         void beginStruct(const StructSig *sig);
  79         inline void endStruct(void) {}
  80
  81         void writeBool(bool value);
  82         void writeSInt(signed long long value);
  83         void writeUInt(unsigned long long value);
  84         void writeFloat(float value);
  85         void writeDouble(double value);
  86         void writeString(const char *str);
  87         void writeString(const char *str, size_t size);
  88         void writeWString(const wchar_t *str);
  89         void writeBlob(const void *data, size_t size);
  90         void writeEnum(const EnumSig *sig);
  91         void writeBitmask(const BitmaskSig *sig, unsigned long long value);
  92         void writeNull(void);
  93         void writeOpaque(const void *ptr);
  94
  95         void writeCall(Call *call);
  96
  97     protected:
  98         void inline _write(const void *sBuffer, size_t dwBytesToWrite);
  99         void inline _writeByte(char c);
 100         void inline _writeUInt(unsigned long long value);
 101         void inline _writeFloat(float value);
 102         void inline _writeDouble(double value);
 103         void inline _writeString(const char *str);
 104
 105     };
 106
 107     /**
 108      * A specialized Writer class, mean to trace the current process.
 109      *
 110      * In particular:
 111      * - it creates a trace file based on the current process name
 112      * - uses mutexes to allow tracing from multiple threades
 113      * - flushes the output to ensure the last call is traced in event of
 114      *   abnormal termination
 115      */
 116     class LocalWriter : public Writer {
 117     protected:
 118         int acquired;
 119
 120     public:
 121         /**
 122          * Should never called directly -- use localWriter singleton below instead.
 123          */
 124         LocalWriter();
 125         ~LocalWriter();
 126
 127         void open(void);
 128
 129         unsigned beginEnter(const FunctionSig *sig);
 130         void endEnter(void);
 131
 132         void beginLeave(unsigned call);
 133         void endLeave(void);
 134
 135         void flush(void);
 136     };
 137
 138     /**
 139      * Singleton.
 140      */
 141     extern LocalWriter localWriter;
 142 }
 143
 144 #endif /* _TRACE_WRITER_HPP_ */