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