git.cworth.org Git - apitrace/blob - common/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 #include "trace_backtrace.hpp"
  40
  41 namespace trace {
  42     class File;
  43
  44     class Writer {
  45     protected:
  46         File *m_file;
  47         unsigned call_no;
  48
  49         std::vector<bool> functions;
  50         std::vector<bool> structs;
  51         std::vector<bool> enums;
  52         std::vector<bool> bitmasks;
  53
  54     public:
  55         Writer();
  56         ~Writer();
  57
  58         bool open(const char *filename);
  59         void close(void);
  60
  61         void writeBacktrace(std::vector<RawStackFrame> backtrace);
  62         void beginBacktrace(void);
  63         void endBacktrace(void);
  64         void beginStackFrame(void);
  65         inline void endStackFrame(void) {}
  66         void beginStackFrameModule(void);
  67         inline void endStackFrameModule(void) {}
  68         void beginStackFrameFunction(void);
  69         inline void endStackFrameFunction(void) {}
  70         void beginStackFrameFilename(void);
  71         inline void endStackFrameFilename(void) {}
  72         void beginStackFrameLinenumber(void);
  73         inline void endStackFrameLinenumber(void) {}
  74         void beginStackFrameOffset(void);
  75         inline void endStackFrameOffset(void) {}
  76
  77         unsigned beginEnter(FunctionSig *sig, unsigned thread_id);
  78         void endEnter(void);
  79
  80         void beginLeave(unsigned call);
  81         void endLeave(void);
  82
  83         void beginArg(unsigned index);
  84         inline void endArg(void) {}
  85
  86         void beginReturn(void);
  87         inline void endReturn(void) {}
  88
  89         void beginArray(size_t length);
  90         inline void endArray(void) {}
  91
  92         inline void beginElement(void) {}
  93         inline void endElement(void) {}
  94
  95         void beginStruct(const StructSig *sig);
  96         inline void endStruct(void) {}
  97
  98         void beginRepr(void);
  99         inline void endRepr(void) {}
 100
 101         void writeBool(bool value);
 102         void writeSInt(signed long long value);
 103         void writeUInt(unsigned long long value);
 104         void writeFloat(float value);
 105         void writeDouble(double value);
 106         void writeString(const char *str);
 107         void writeString(const char *str, size_t size);
 108         void writeWString(const wchar_t *str);
 109         void writeBlob(const void *data, size_t size);
 110         void writeEnum(const EnumSig *sig, signed long long value);
 111         void writeBitmask(const BitmaskSig *sig, unsigned long long value);
 112         void writeNull(void);
 113         void writePointer(unsigned long long addr);
 114
 115         void writeCall(Call *call);
 116
 117     protected:
 118         void inline _write(const void *sBuffer, size_t dwBytesToWrite);
 119         void inline _writeByte(char c);
 120         void inline _writeUInt(unsigned long long value);
 121         void inline _writeFloat(float value);
 122         void inline _writeDouble(double value);
 123         void inline _writeString(const char *str);
 124
 125     };
 126
 127 } /* namespace trace */
 128
 129 #endif /* _TRACE_WRITER_HPP_ */