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         std::vector<bool> frames;
  54
  55     public:
  56         Writer();
  57         ~Writer();
  58
  59         bool open(const char *filename);
  60         void close(void);
  61
  62         unsigned beginEnter(const FunctionSig *sig, unsigned thread_id);
  63         void endEnter(void);
  64
  65         void beginLeave(unsigned call);
  66         void endLeave(void);
  67
  68         void beginArg(unsigned index);
  69         inline void endArg(void) {}
  70
  71         void beginReturn(void);
  72         inline void endReturn(void) {}
  73
  74         void beginBacktrace(unsigned num_frames);
  75         void writeStackFrame(const RawStackFrame *frame);
  76         inline void endBacktrace(void) {}
  77
  78         void beginArray(size_t length);
  79         inline void endArray(void) {}
  80
  81         inline void beginElement(void) {}
  82         inline void endElement(void) {}
  83
  84         void beginStruct(const StructSig *sig);
  85         inline void endStruct(void) {}
  86
  87         void beginRepr(void);
  88         inline void endRepr(void) {}
  89
  90         void writeBool(bool value);
  91         void writeSInt(signed long long value);
  92         void writeUInt(unsigned long long value);
  93         void writeFloat(float value);
  94         void writeDouble(double value);
  95         void writeString(const char *str);
  96         void writeString(const char *str, size_t size);
  97         void writeWString(const wchar_t *str);
  98         void writeBlob(const void *data, size_t size);
  99         void writeEnum(const EnumSig *sig, signed long long value);
 100         void writeBitmask(const BitmaskSig *sig, unsigned long long value);
 101         void writeNull(void);
 102         void writePointer(unsigned long long addr);
 103
 104         void writeCall(Call *call);
 105
 106     protected:
 107         void inline _write(const void *sBuffer, size_t dwBytesToWrite);
 108         void inline _writeByte(char c);
 109         void inline _writeUInt(unsigned long long value);
 110         void inline _writeFloat(float value);
 111         void inline _writeDouble(double value);
 112         void inline _writeString(const char *str);
 113
 114     };
 115
 116 } /* namespace trace */
 117
 118 #endif /* _TRACE_WRITER_HPP_ */