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