1 /**************************************************************************
3 * Copyright 2010 VMware, Inc.
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:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
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
24 **************************************************************************/
26 #ifndef _TRACE_PARSER_HPP_
27 #define _TRACE_PARSER_HPP_
34 #include "trace_file.hpp"
35 #include "trace_format.hpp"
36 #include "trace_model.hpp"
46 typedef std::list<Call *> CallList;
49 // Helper template that extends a base signature structure, with additional
50 // parsing information.
52 struct SigState : public T {
53 // Offset in the file of where signature was defined. It is used when
54 // reparsing to determine whether the signature definition is to be
55 // expected next or not.
59 typedef SigState<FunctionSig> FunctionSigState;
60 typedef SigState<StructSig> StructSigState;
61 typedef SigState<EnumSig> EnumSigState;
62 typedef SigState<BitmaskSig> BitmaskSigState;
64 typedef std::vector<FunctionSigState *> FunctionMap;
65 typedef std::vector<StructSigState *> StructMap;
66 typedef std::vector<EnumSigState *> EnumMap;
67 typedef std::vector<BitmaskSigState *> BitmaskMap;
69 FunctionMap functions;
74 bool m_supportsSeeking;
76 unsigned next_call_no;
79 unsigned long long version;
85 bool open(const char *filename);
89 Call *parse_call(void);
91 bool supportsOffsets() const
93 return file->supportsOffsets();
96 File::Offset currentOffset()
98 return file->currentOffset();
101 void setCurrentOffset(const File::Offset &offset)
103 file->setCurrentOffset(offset);
106 unsigned currentCallNumber() const
111 void setCurrentCallNumber(unsigned num)
118 return file->percentRead();
124 FunctionSig *parse_function_sig(void);
125 StructSig *parse_struct_sig();
126 EnumSig *parse_enum_sig();
127 BitmaskSig *parse_bitmask_sig();
129 void parse_enter(void);
131 Call *parse_leave(void);
133 bool parse_call_details(Call *call);
135 void parse_arg(Call *call);
137 Value *parse_value(void);
143 Value *parse_float();
145 Value *parse_double();
147 Value *parse_string();
151 Value *parse_bitmask();
153 Value *parse_array(void);
155 Value *parse_blob(void);
157 Value *parse_struct();
159 Value *parse_opaque();
161 const char * read_string(void);
163 unsigned long long read_uint(void);
165 inline int read_byte(void);
168 void scan_enter(void);
170 Call *scan_leave(void);
172 bool scan_call_details(Call *call);
174 void scan_arg(Call *call);
176 void scan_value(void);
192 void scan_array(void);
194 void scan_blob(void);
200 void skip_string(void);
202 void skip_uint(void);
204 inline void skip_byte(void);
208 } /* namespace Trace */
210 #endif /* _TRACE_PARSER_HPP_ */