git.cworth.org Git - apitrace/blob - trace_write.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_WRITE_HPP_
  31 #define _TRACE_WRITE_HPP_
  32
  33 #include <stddef.h>
  34
  35 namespace Trace {
  36
  37     typedef unsigned Id;
  38
  39     struct FunctionSig {
  40         Id id;
  41         const char *name;
  42         unsigned num_args;
  43         const char **args;
  44     };
  45
  46     struct StructSig {
  47         Id id;
  48         const char *name;
  49         unsigned num_members;
  50         const char **members;
  51     };
  52
  53     struct EnumSig {
  54         Id id;
  55         const char *name;
  56         signed long long value;
  57     };
  58
  59     struct BitmaskVal {
  60         const char *name;
  61         unsigned long long value;
  62     };
  63
  64     struct BitmaskSig {
  65         Id id;
  66         unsigned count;
  67         const BitmaskVal *values;
  68     };
  69
  70     void Open(void);
  71     void Close(void);
  72
  73     unsigned BeginEnter(const FunctionSig &function);
  74     void EndEnter(void);
  75
  76     void BeginLeave(unsigned call);
  77     void EndLeave(void);
  78
  79     void BeginArg(unsigned index);
  80     inline void EndArg(void) {}
  81
  82     void BeginReturn(void);
  83     inline void EndReturn(void) {}
  84
  85     void BeginArray(size_t length);
  86     inline void EndArray(void) {}
  87
  88     inline void BeginElement(void) {}
  89     inline void EndElement(void) {}
  90
  91     void BeginStruct(const StructSig *sig);
  92     inline void EndStruct(void) {}
  93
  94     void LiteralBool(bool value);
  95     void LiteralSInt(signed long long value);
  96     void LiteralUInt(unsigned long long value);
  97     void LiteralFloat(float value);
  98     void LiteralDouble(double value);
  99     void LiteralString(const char *str);
 100     void LiteralString(const char *str, size_t size);
 101     void LiteralWString(const wchar_t *str);
 102     void LiteralBlob(const void *data, size_t size);
 103     void LiteralEnum(const EnumSig *sig);
 104     void LiteralBitmask(const BitmaskSig &bitmask, unsigned long long value);
 105     void LiteralNull(void);
 106     void LiteralOpaque(const void *ptr);
 107
 108     void Abort(void);
 109 }
 110
 111 #endif /* _TRACE_WRITE_HPP_ */