git.cworth.org Git - apitrace/blob - common/trace_parser.hpp

   1 /**************************************************************************
   2  *
   3  * Copyright 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 #ifndef _TRACE_PARSER_HPP_
  27 #define _TRACE_PARSER_HPP_
  28
  29
  30 #include <iostream>
  31 #include <list>
  32
  33 #include "trace_file.hpp"
  34 #include "trace_format.hpp"
  35 #include "trace_model.hpp"
  36 #include "trace_api.hpp"
  37
  38
  39 namespace trace {
  40
  41
  42 struct ParseBookmark
  43 {
  44     File::Offset offset;
  45     unsigned next_call_no;
  46 };
  47
  48
  49 class Parser
  50 {
  51 protected:
  52     File *file;
  53
  54     enum Mode {
  55         FULL = 0,
  56         SCAN,
  57         SKIP
  58     };
  59
  60     typedef std::list<Call *> CallList;
  61     CallList calls;
  62
  63     struct FunctionSigFlags : public FunctionSig {
  64         CallFlags flags;
  65     };
  66
  67     // Helper template that extends a base signature structure, with additional
  68     // parsing information.
  69     template< class T >
  70     struct SigState : public T {
  71         // Offset in the file of where signature was defined.  It is used when
  72         // reparsing to determine whether the signature definition is to be
  73         // expected next or not.
  74         File::Offset fileOffset;
  75     };
  76
  77     typedef SigState<FunctionSigFlags> FunctionSigState;
  78     typedef SigState<StructSig> StructSigState;
  79     typedef SigState<EnumSig> EnumSigState;
  80     typedef SigState<BitmaskSig> BitmaskSigState;
  81     typedef SigState<StackFrame> StackFrameState;
  82
  83     typedef std::vector<FunctionSigState *> FunctionMap;
  84     typedef std::vector<StructSigState *> StructMap;
  85     typedef std::vector<EnumSigState *> EnumMap;
  86     typedef std::vector<BitmaskSigState *> BitmaskMap;
  87     typedef std::vector<StackFrameState *> StackFrameMap;
  88
  89     FunctionMap functions;
  90     StructMap structs;
  91     EnumMap enums;
  92     BitmaskMap bitmasks;
  93     StackFrameMap frames;
  94
  95     FunctionSig *glGetErrorSig;
  96
  97     unsigned next_call_no;
  98
  99 public:
 100     unsigned long long version;
 101     API api;
 102
 103     Parser();
 104
 105     ~Parser();
 106
 107     bool open(const char *filename);
 108
 109     void close(void);
 110
 111     Call *parse_call(void) {
 112         return parse_call(FULL);
 113     }
 114
 115     bool supportsOffsets() const
 116     {
 117         return file->supportsOffsets();
 118     }
 119
 120     void getBookmark(ParseBookmark &bookmark);
 121
 122     void setBookmark(const ParseBookmark &bookmark);
 123
 124     int percentRead()
 125     {
 126         return file->percentRead();
 127     }
 128
 129     Call *scan_call() {
 130         return parse_call(SCAN);
 131     }
 132
 133 protected:
 134     Call *parse_call(Mode mode);
 135
 136     FunctionSigFlags *parse_function_sig(void);
 137     StructSig *parse_struct_sig();
 138     EnumSig *parse_old_enum_sig();
 139     EnumSig *parse_enum_sig();
 140     BitmaskSig *parse_bitmask_sig();
 141
 142     static CallFlags
 143     lookupCallFlags(const char *name);
 144
 145     Call *parse_Call(Mode mode);
 146
 147     void parse_enter(Mode mode);
 148
 149     Call *parse_leave(Mode mode);
 150
 151     bool parse_call_details(Call *call, Mode mode);
 152
 153     bool parse_call_backtrace(Call *call, Mode mode);
 154     StackFrame * parse_backtrace_frame(Mode mode);
 155
 156     void adjust_call_flags(Call *call);
 157
 158     void parse_arg(Call *call, Mode mode);
 159
 160     Value *parse_value(void);
 161     void scan_value(void);
 162     inline Value *parse_value(Mode mode) {
 163         if (mode == FULL) {
 164             return parse_value();
 165         } else {
 166             scan_value();
 167             return NULL;
 168         }
 169     }
 170
 171     Value *parse_sint();
 172     void scan_sint();
 173
 174     Value *parse_uint();
 175     void scan_uint();
 176
 177     Value *parse_float();
 178     void scan_float();
 179
 180     Value *parse_double();
 181     void scan_double();
 182
 183     Value *parse_string();
 184     void scan_string();
 185
 186     Value *parse_enum();
 187     void scan_enum();
 188
 189     Value *parse_bitmask();
 190     void scan_bitmask();
 191
 192     Value *parse_array(void);
 193     void scan_array(void);
 194
 195     Value *parse_blob(void);
 196     void scan_blob(void);
 197
 198     Value *parse_struct();
 199     void scan_struct();
 200
 201     Value *parse_opaque();
 202     void scan_opaque();
 203
 204     Value *parse_repr();
 205     void scan_repr();
 206
 207     const char * read_string(void);
 208     void skip_string(void);
 209
 210     signed long long read_sint(void);
 211     void skip_sint(void);
 212
 213     unsigned long long read_uint(void);
 214     void skip_uint(void);
 215
 216     inline int read_byte(void);
 217     inline void skip_byte(void);
 218 };
 219
 220
 221 } /* namespace trace */
 222
 223 #endif /* _TRACE_PARSER_HPP_ */