]> git.cworth.org Git - apitrace/blob - common/trace_parser.hpp
Backtrace via call detail
[apitrace] / 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 offset;
75     };
76
77     typedef SigState<FunctionSigFlags> FunctionSigState;
78     typedef SigState<StructSig> StructSigState;
79     typedef SigState<EnumSig> EnumSigState;
80     typedef SigState<BitmaskSig> BitmaskSigState;
81
82     typedef std::vector<FunctionSigState *> FunctionMap;
83     typedef std::vector<StructSigState *> StructMap;
84     typedef std::vector<EnumSigState *> EnumMap;
85     typedef std::vector<BitmaskSigState *> BitmaskMap;
86
87     FunctionMap functions;
88     StructMap structs;
89     EnumMap enums;
90     BitmaskMap bitmasks;
91
92     FunctionSig *glGetErrorSig;
93
94     unsigned next_call_no;
95
96 public:
97     unsigned long long version;
98     API api;
99
100     Parser();
101
102     ~Parser();
103
104     bool open(const char *filename);
105
106     void close(void);
107
108     Call *parse_call(void) {
109         return parse_call(FULL);
110     }
111
112     bool supportsOffsets() const
113     {
114         return file->supportsOffsets();
115     }
116
117     void getBookmark(ParseBookmark &bookmark);
118
119     void setBookmark(const ParseBookmark &bookmark);
120
121     int percentRead()
122     {
123         return file->percentRead();
124     }
125
126     Call *scan_call() {
127         return parse_call(SCAN);
128     }
129
130 protected:
131     Call *parse_call(Mode mode);
132
133     FunctionSigFlags *parse_function_sig(void);
134     StructSig *parse_struct_sig();
135     EnumSig *parse_old_enum_sig();
136     EnumSig *parse_enum_sig();
137     BitmaskSig *parse_bitmask_sig();
138     
139     static CallFlags
140     lookupCallFlags(const char *name);
141
142     Call *parse_Call(Mode mode);
143
144     void parse_enter(Mode mode);
145
146     Call *parse_leave(Mode mode);
147
148     bool parse_call_details(Call *call, Mode mode);
149
150     bool parse_call_backtrace(Call *call, Mode mode);
151
152     void adjust_call_flags(Call *call);
153
154     void parse_arg(Call *call, Mode mode);
155
156     Value *parse_value(void);
157     void scan_value(void);
158     inline Value *parse_value(Mode mode) {
159         if (mode == FULL) {
160             return parse_value();
161         } else {
162             scan_value();
163             return NULL;
164         }
165     }
166
167     Value *parse_sint();
168     void scan_sint();
169
170     Value *parse_uint();
171     void scan_uint();
172
173     Value *parse_float();
174     void scan_float();
175
176     Value *parse_double();
177     void scan_double();
178
179     Value *parse_string();
180     void scan_string();
181
182     Value *parse_enum();
183     void scan_enum();
184
185     Value *parse_bitmask();
186     void scan_bitmask();
187
188     Value *parse_array(void);
189     void scan_array(void);
190
191     Value *parse_blob(void);
192     void scan_blob(void);
193
194     Value *parse_struct();
195     void scan_struct();
196
197     Value *parse_opaque();
198     void scan_opaque();
199
200     Value *parse_repr();
201     void scan_repr();
202
203     const char * read_string(void);
204     void skip_string(void);
205
206     signed long long read_sint(void);
207     void skip_sint(void);
208
209     unsigned long long read_uint(void);
210     void skip_uint(void);
211
212     inline int read_byte(void);
213     inline void skip_byte(void);
214 };
215
216
217 } /* namespace trace */
218
219 #endif /* _TRACE_PARSER_HPP_ */