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