1 /**************************************************************************
3 * Copyright 2011 Jose Fonseca
4 * Copyright 2010 VMware, Inc.
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 **************************************************************************/
31 #include "trace_file.hpp"
32 #include "trace_snappyfile.hpp"
33 #include "trace_parser.hpp"
36 #define TRACE_VERBOSE 0
54 bool Parser::open(const char *filename) {
56 if (File::isZLibCompressed(filename)) {
59 file = new SnappyFile;
62 if (!file->open(filename, File::Read)) {
66 version = read_uint();
67 if (version > TRACE_VERSION) {
68 std::cerr << "error: unsupported trace format version " << version << "\n";
75 template <typename Iter>
77 deleteAll(Iter begin, Iter end)
79 while (begin != end) {
85 template <typename Container>
87 deleteAll(Container &c)
89 deleteAll(c.begin(), c.end());
93 void Parser::close(void) {
101 deleteAll(functions);
108 Call *Parser::parse_call(void) {
112 case Trace::EVENT_ENTER:
115 case Trace::EVENT_LEAVE:
116 return parse_leave();
118 std::cerr << "error: unknown event " << c << "\n";
121 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
122 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
123 std::cerr << **it << "\n";
132 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
135 T *lookup(std::vector<T *> &map, size_t index) {
136 if (index >= map.size()) {
137 map.resize(index + 1);
145 void Parser::parse_enter(void) {
146 size_t id = read_uint();
148 FunctionSig *sig = lookup(functions, id);
150 sig = new FunctionSig;
152 sig->name = read_string();
153 sig->num_args = read_uint();
154 const char **arg_names = new const char *[sig->num_args];
155 for (unsigned i = 0; i < sig->num_args; ++i) {
156 arg_names[i] = read_string();
158 sig->arg_names = arg_names;
163 Call *call = new Call(sig);
164 call->no = next_call_no++;
166 if (parse_call_details(call)) {
167 calls.push_back(call);
174 Call *Parser::parse_leave(void) {
175 unsigned call_no = read_uint();
177 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
178 if ((*it)->no == call_no) {
188 if (parse_call_details(call)) {
197 bool Parser::parse_call_details(Call *call) {
201 case Trace::CALL_END:
203 case Trace::CALL_ARG:
206 case Trace::CALL_RET:
207 call->ret = parse_value();
210 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
220 void Parser::parse_arg(Call *call) {
221 unsigned index = read_uint();
222 Value *value = parse_value();
223 if (index >= call->args.size()) {
224 call->args.resize(index + 1);
226 call->args[index] = value;
230 Value *Parser::parse_value(void) {
235 case Trace::TYPE_NULL:
238 case Trace::TYPE_FALSE:
239 value = new Bool(false);
241 case Trace::TYPE_TRUE:
242 value = new Bool(true);
244 case Trace::TYPE_SINT:
245 value = parse_sint();
247 case Trace::TYPE_UINT:
248 value = parse_uint();
250 case Trace::TYPE_FLOAT:
251 value = parse_float();
253 case Trace::TYPE_DOUBLE:
254 value = parse_double();
256 case Trace::TYPE_STRING:
257 value = parse_string();
259 case Trace::TYPE_ENUM:
260 value = parse_enum();
262 case Trace::TYPE_BITMASK:
263 value = parse_bitmask();
265 case Trace::TYPE_ARRAY:
266 value = parse_array();
268 case Trace::TYPE_STRUCT:
269 value = parse_struct();
271 case Trace::TYPE_BLOB:
272 value = parse_blob();
274 case Trace::TYPE_OPAQUE:
275 value = parse_opaque();
278 std::cerr << "error: unknown type " << c << "\n";
286 std::cerr << "\tVALUE " << value << "\n";
293 Value *Parser::parse_sint() {
294 return new SInt(-(signed long long)read_uint());
298 Value *Parser::parse_uint() {
299 return new UInt(read_uint());
303 Value *Parser::parse_float() {
305 file->read(&value, sizeof value);
306 return new Float(value);
310 Value *Parser::parse_double() {
312 file->read(&value, sizeof value);
313 return new Float(value);
317 Value *Parser::parse_string() {
318 return new String(read_string());
322 Value *Parser::parse_enum() {
323 size_t id = read_uint();
324 EnumSig *sig = lookup(enums, id);
328 sig->name = read_string();
329 Value *value = parse_value();
330 sig->value = value->toSInt();
335 return new Enum(sig);
339 Value *Parser::parse_bitmask() {
340 size_t id = read_uint();
341 BitmaskSig *sig = lookup(bitmasks, id);
343 sig = new BitmaskSig;
345 sig->num_flags = read_uint();
346 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
347 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
348 it->name = read_string();
349 it->value = read_uint();
350 if (it->value == 0 && it != flags) {
351 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
359 unsigned long long value = read_uint();
361 return new Bitmask(sig, value);
365 Value *Parser::parse_array(void) {
366 size_t len = read_uint();
367 Array *array = new Array(len);
368 for (size_t i = 0; i < len; ++i) {
369 array->values[i] = parse_value();
375 Value *Parser::parse_blob(void) {
376 size_t size = read_uint();
377 Blob *blob = new Blob(size);
379 file->read(blob->buf, (unsigned)size);
385 Value *Parser::parse_struct() {
386 size_t id = read_uint();
388 StructSig *sig = lookup(structs, id);
392 sig->name = read_string();
393 sig->num_members = read_uint();
394 const char **member_names = new const char *[sig->num_members];
395 for (unsigned i = 0; i < sig->num_members; ++i) {
396 member_names[i] = read_string();
398 sig->member_names = member_names;
403 Struct *value = new Struct(sig);
405 for (size_t i = 0; i < sig->num_members; ++i) {
406 value->members[i] = parse_value();
413 Value *Parser::parse_opaque() {
414 unsigned long long addr;
416 return new Pointer(addr);
420 const char * Parser::read_string(void) {
421 size_t len = read_uint();
422 char * value = new char[len + 1];
424 file->read(value, (unsigned)len);
428 std::cerr << "\tSTRING \"" << value << "\"\n";
434 unsigned long long Parser::read_uint(void) {
435 unsigned long long value = 0;
443 value |= (unsigned long long)(c & 0x7f) << shift;
447 std::cerr << "\tUINT " << value << "\n";
453 inline int Parser::read_byte(void) {
454 int c = file->getc();
457 std::cerr << "\tEOF" << "\n";
459 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
465 } /* namespace Trace */