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 void Parser::getBookmark(ParseBookmark &bookmark) {
109 bookmark.offset = file->currentOffset();
110 bookmark.next_call_no = next_call_no;
114 void Parser::setBookmark(const ParseBookmark &bookmark) {
115 file->setCurrentOffset(bookmark.offset);
116 next_call_no = bookmark.next_call_no;
118 // Simply ignore all pending calls
123 Call *Parser::parse_call(Mode mode) {
127 case Trace::EVENT_ENTER:
130 case Trace::EVENT_LEAVE:
131 return parse_leave(mode);
133 std::cerr << "error: unknown event " << c << "\n";
136 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
137 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
138 std::cerr << **it << "\n";
147 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
150 T *lookup(std::vector<T *> &map, size_t index) {
151 if (index >= map.size()) {
152 map.resize(index + 1);
160 FunctionSig *Parser::parse_function_sig(void) {
161 size_t id = read_uint();
163 FunctionSigState *sig = lookup(functions, id);
166 /* parse the signature */
167 sig = new FunctionSigState;
169 sig->name = read_string();
170 sig->num_args = read_uint();
171 const char **arg_names = new const char *[sig->num_args];
172 for (unsigned i = 0; i < sig->num_args; ++i) {
173 arg_names[i] = read_string();
175 sig->arg_names = arg_names;
176 sig->offset = file->currentOffset();
178 } else if (file->currentOffset() < sig->offset) {
179 /* skip over the signature */
180 skip_string(); /* name */
181 int num_args = read_uint();
182 for (unsigned i = 0; i < num_args; ++i) {
183 skip_string(); /*arg_name*/
192 StructSig *Parser::parse_struct_sig() {
193 size_t id = read_uint();
195 StructSigState *sig = lookup(structs, id);
198 /* parse the signature */
199 sig = new StructSigState;
201 sig->name = read_string();
202 sig->num_members = read_uint();
203 const char **member_names = new const char *[sig->num_members];
204 for (unsigned i = 0; i < sig->num_members; ++i) {
205 member_names[i] = read_string();
207 sig->member_names = member_names;
208 sig->offset = file->currentOffset();
210 } else if (file->currentOffset() < sig->offset) {
211 /* skip over the signature */
212 skip_string(); /* name */
213 unsigned num_members = read_uint();
214 for (unsigned i = 0; i < num_members; ++i) {
215 skip_string(); /* member_name */
224 EnumSig *Parser::parse_enum_sig() {
225 size_t id = read_uint();
227 EnumSigState *sig = lookup(enums, id);
230 /* parse the signature */
231 sig = new EnumSigState;
233 sig->name = read_string();
234 Value *value = parse_value();
235 sig->value = value->toSInt();
237 sig->offset = file->currentOffset();
239 } else if (file->currentOffset() < sig->offset) {
240 /* skip over the signature */
241 skip_string(); /*name*/
250 BitmaskSig *Parser::parse_bitmask_sig() {
251 size_t id = read_uint();
253 BitmaskSigState *sig = lookup(bitmasks, id);
256 /* parse the signature */
257 sig = new BitmaskSigState;
259 sig->num_flags = read_uint();
260 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
261 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
262 it->name = read_string();
263 it->value = read_uint();
264 if (it->value == 0 && it != flags) {
265 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
269 sig->offset = file->currentOffset();
271 } else if (file->currentOffset() < sig->offset) {
272 /* skip over the signature */
273 int num_flags = read_uint();
274 for (int i = 0; i < num_flags; ++i) {
275 skip_string(); /*name */
276 skip_uint(); /* value */
285 void Parser::parse_enter(Mode mode) {
286 FunctionSig *sig = parse_function_sig();
288 Call *call = new Call(sig);
290 call->no = next_call_no++;
292 if (parse_call_details(call, mode)) {
293 calls.push_back(call);
300 Call *Parser::parse_leave(Mode mode) {
301 unsigned call_no = read_uint();
303 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
304 if ((*it)->no == call_no) {
314 if (parse_call_details(call, mode)) {
323 bool Parser::parse_call_details(Call *call, Mode mode) {
327 case Trace::CALL_END:
329 case Trace::CALL_ARG:
330 parse_arg(call, mode);
332 case Trace::CALL_RET:
333 call->ret = parse_value(mode);
336 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
346 void Parser::parse_arg(Call *call, Mode mode) {
347 unsigned index = read_uint();
348 Value *value = parse_value(mode);
350 if (index >= call->args.size()) {
351 call->args.resize(index + 1);
353 call->args[index] = value;
358 Value *Parser::parse_value(void) {
363 case Trace::TYPE_NULL:
366 case Trace::TYPE_FALSE:
367 value = new Bool(false);
369 case Trace::TYPE_TRUE:
370 value = new Bool(true);
372 case Trace::TYPE_SINT:
373 value = parse_sint();
375 case Trace::TYPE_UINT:
376 value = parse_uint();
378 case Trace::TYPE_FLOAT:
379 value = parse_float();
381 case Trace::TYPE_DOUBLE:
382 value = parse_double();
384 case Trace::TYPE_STRING:
385 value = parse_string();
387 case Trace::TYPE_ENUM:
388 value = parse_enum();
390 case Trace::TYPE_BITMASK:
391 value = parse_bitmask();
393 case Trace::TYPE_ARRAY:
394 value = parse_array();
396 case Trace::TYPE_STRUCT:
397 value = parse_struct();
399 case Trace::TYPE_BLOB:
400 value = parse_blob();
402 case Trace::TYPE_OPAQUE:
403 value = parse_opaque();
406 std::cerr << "error: unknown type " << c << "\n";
414 std::cerr << "\tVALUE " << value << "\n";
421 void Parser::scan_value(void) {
424 case Trace::TYPE_NULL:
425 case Trace::TYPE_FALSE:
426 case Trace::TYPE_TRUE:
428 case Trace::TYPE_SINT:
431 case Trace::TYPE_UINT:
434 case Trace::TYPE_FLOAT:
437 case Trace::TYPE_DOUBLE:
440 case Trace::TYPE_STRING:
443 case Trace::TYPE_ENUM:
446 case Trace::TYPE_BITMASK:
449 case Trace::TYPE_ARRAY:
452 case Trace::TYPE_STRUCT:
455 case Trace::TYPE_BLOB:
458 case Trace::TYPE_OPAQUE:
462 std::cerr << "error: unknown type " << c << "\n";
470 Value *Parser::parse_sint() {
471 return new SInt(-(signed long long)read_uint());
475 void Parser::scan_sint() {
480 Value *Parser::parse_uint() {
481 return new UInt(read_uint());
485 void Parser::scan_uint() {
490 Value *Parser::parse_float() {
492 file->read(&value, sizeof value);
493 return new Float(value);
497 void Parser::scan_float() {
498 file->skip(sizeof(float));
502 Value *Parser::parse_double() {
504 file->read(&value, sizeof value);
505 return new Float(value);
509 void Parser::scan_double() {
510 file->skip(sizeof(double));
514 Value *Parser::parse_string() {
515 return new String(read_string());
519 void Parser::scan_string() {
524 Value *Parser::parse_enum() {
525 EnumSig *sig = parse_enum_sig();
526 return new Enum(sig);
530 void Parser::scan_enum() {
535 Value *Parser::parse_bitmask() {
536 BitmaskSig *sig = parse_bitmask_sig();
538 unsigned long long value = read_uint();
540 return new Bitmask(sig, value);
544 void Parser::scan_bitmask() {
546 skip_uint(); /* value */
550 Value *Parser::parse_array(void) {
551 size_t len = read_uint();
552 Array *array = new Array(len);
553 for (size_t i = 0; i < len; ++i) {
554 array->values[i] = parse_value();
560 void Parser::scan_array(void) {
561 size_t len = read_uint();
562 for (size_t i = 0; i < len; ++i) {
568 Value *Parser::parse_blob(void) {
569 size_t size = read_uint();
570 Blob *blob = new Blob(size);
572 file->read(blob->buf, (unsigned)size);
578 void Parser::scan_blob(void) {
579 size_t size = read_uint();
586 Value *Parser::parse_struct() {
587 StructSig *sig = parse_struct_sig();
588 Struct *value = new Struct(sig);
590 for (size_t i = 0; i < sig->num_members; ++i) {
591 value->members[i] = parse_value();
598 void Parser::scan_struct() {
599 StructSig *sig = parse_struct_sig();
600 for (size_t i = 0; i < sig->num_members; ++i) {
606 Value *Parser::parse_opaque() {
607 unsigned long long addr;
609 return new Pointer(addr);
613 void Parser::scan_opaque() {
618 const char * Parser::read_string(void) {
619 size_t len = read_uint();
620 char * value = new char[len + 1];
622 file->read(value, (unsigned)len);
626 std::cerr << "\tSTRING \"" << value << "\"\n";
632 void Parser::skip_string(void) {
633 size_t len = read_uint();
638 unsigned long long Parser::read_uint(void) {
639 unsigned long long value = 0;
647 value |= (unsigned long long)(c & 0x7f) << shift;
651 std::cerr << "\tUINT " << value << "\n";
657 void Parser::skip_uint(void) {
668 inline int Parser::read_byte(void) {
669 int c = file->getc();
672 std::cerr << "\tEOF" << "\n";
674 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
680 inline void Parser::skip_byte(void) {
685 } /* namespace Trace */