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) {
102 // Delete all signature data. Signatures are mere structures which don't
103 // own their own memory, so we need to destroy all data we created here.
105 for (FunctionMap::iterator it = functions.begin(); it != functions.end(); ++it) {
106 FunctionSigState *sig = *it;
109 for (unsigned arg = 0; arg < sig->num_args; ++arg) {
110 delete [] sig->arg_names[arg];
112 delete [] sig->arg_names;
118 for (StructMap::iterator it = structs.begin(); it != structs.end(); ++it) {
119 StructSigState *sig = *it;
122 for (unsigned member = 0; member < sig->num_members; ++member) {
123 delete [] sig->member_names[member];
125 delete [] sig->member_names;
131 for (EnumMap::iterator it = enums.begin(); it != enums.end(); ++it) {
132 EnumSigState *sig = *it;
140 for (BitmaskMap::iterator it = bitmasks.begin(); it != bitmasks.end(); ++it) {
141 BitmaskSigState *sig = *it;
143 for (unsigned flag = 0; flag < sig->num_flags; ++flag) {
144 delete [] sig->flags[flag].name;
146 delete [] sig->flags;
156 void Parser::getBookmark(ParseBookmark &bookmark) {
157 bookmark.offset = file->currentOffset();
158 bookmark.next_call_no = next_call_no;
162 void Parser::setBookmark(const ParseBookmark &bookmark) {
163 file->setCurrentOffset(bookmark.offset);
164 next_call_no = bookmark.next_call_no;
166 // Simply ignore all pending calls
171 Call *Parser::parse_call(Mode mode) {
175 case Trace::EVENT_ENTER:
178 case Trace::EVENT_LEAVE:
179 return parse_leave(mode);
181 std::cerr << "error: unknown event " << c << "\n";
184 if (!calls.empty()) {
185 Call *call = calls.front();
186 std::cerr << call->no << ": warning: incomplete call " << call->name() << "\n";
197 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
200 T *lookup(std::vector<T *> &map, size_t index) {
201 if (index >= map.size()) {
202 map.resize(index + 1);
210 FunctionSig *Parser::parse_function_sig(void) {
211 size_t id = read_uint();
213 FunctionSigState *sig = lookup(functions, id);
216 /* parse the signature */
217 sig = new FunctionSigState;
219 sig->name = read_string();
220 sig->num_args = read_uint();
221 const char **arg_names = new const char *[sig->num_args];
222 for (unsigned i = 0; i < sig->num_args; ++i) {
223 arg_names[i] = read_string();
225 sig->arg_names = arg_names;
226 sig->offset = file->currentOffset();
228 } else if (file->currentOffset() < sig->offset) {
229 /* skip over the signature */
230 skip_string(); /* name */
231 unsigned num_args = read_uint();
232 for (unsigned i = 0; i < num_args; ++i) {
233 skip_string(); /*arg_name*/
242 StructSig *Parser::parse_struct_sig() {
243 size_t id = read_uint();
245 StructSigState *sig = lookup(structs, id);
248 /* parse the signature */
249 sig = new StructSigState;
251 sig->name = read_string();
252 sig->num_members = read_uint();
253 const char **member_names = new const char *[sig->num_members];
254 for (unsigned i = 0; i < sig->num_members; ++i) {
255 member_names[i] = read_string();
257 sig->member_names = member_names;
258 sig->offset = file->currentOffset();
260 } else if (file->currentOffset() < sig->offset) {
261 /* skip over the signature */
262 skip_string(); /* name */
263 unsigned num_members = read_uint();
264 for (unsigned i = 0; i < num_members; ++i) {
265 skip_string(); /* member_name */
274 EnumSig *Parser::parse_enum_sig() {
275 size_t id = read_uint();
277 EnumSigState *sig = lookup(enums, id);
280 /* parse the signature */
281 sig = new EnumSigState;
283 sig->name = read_string();
284 Value *value = parse_value();
285 sig->value = value->toSInt();
287 sig->offset = file->currentOffset();
289 } else if (file->currentOffset() < sig->offset) {
290 /* skip over the signature */
291 skip_string(); /*name*/
300 BitmaskSig *Parser::parse_bitmask_sig() {
301 size_t id = read_uint();
303 BitmaskSigState *sig = lookup(bitmasks, id);
306 /* parse the signature */
307 sig = new BitmaskSigState;
309 sig->num_flags = read_uint();
310 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
311 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
312 it->name = read_string();
313 it->value = read_uint();
314 if (it->value == 0 && it != flags) {
315 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
319 sig->offset = file->currentOffset();
321 } else if (file->currentOffset() < sig->offset) {
322 /* skip over the signature */
323 int num_flags = read_uint();
324 for (int i = 0; i < num_flags; ++i) {
325 skip_string(); /*name */
326 skip_uint(); /* value */
335 void Parser::parse_enter(Mode mode) {
336 FunctionSig *sig = parse_function_sig();
338 Call *call = new Call(sig);
340 call->no = next_call_no++;
342 if (parse_call_details(call, mode)) {
343 calls.push_back(call);
350 Call *Parser::parse_leave(Mode mode) {
351 unsigned call_no = read_uint();
353 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
354 if ((*it)->no == call_no) {
364 if (parse_call_details(call, mode)) {
373 bool Parser::parse_call_details(Call *call, Mode mode) {
377 case Trace::CALL_END:
379 case Trace::CALL_ARG:
380 parse_arg(call, mode);
382 case Trace::CALL_RET:
383 call->ret = parse_value(mode);
386 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
396 void Parser::parse_arg(Call *call, Mode mode) {
397 unsigned index = read_uint();
398 Value *value = parse_value(mode);
400 if (index >= call->args.size()) {
401 call->args.resize(index + 1);
403 call->args[index] = value;
408 Value *Parser::parse_value(void) {
413 case Trace::TYPE_NULL:
416 case Trace::TYPE_FALSE:
417 value = new Bool(false);
419 case Trace::TYPE_TRUE:
420 value = new Bool(true);
422 case Trace::TYPE_SINT:
423 value = parse_sint();
425 case Trace::TYPE_UINT:
426 value = parse_uint();
428 case Trace::TYPE_FLOAT:
429 value = parse_float();
431 case Trace::TYPE_DOUBLE:
432 value = parse_double();
434 case Trace::TYPE_STRING:
435 value = parse_string();
437 case Trace::TYPE_ENUM:
438 value = parse_enum();
440 case Trace::TYPE_BITMASK:
441 value = parse_bitmask();
443 case Trace::TYPE_ARRAY:
444 value = parse_array();
446 case Trace::TYPE_STRUCT:
447 value = parse_struct();
449 case Trace::TYPE_BLOB:
450 value = parse_blob();
452 case Trace::TYPE_OPAQUE:
453 value = parse_opaque();
456 std::cerr << "error: unknown type " << c << "\n";
464 std::cerr << "\tVALUE " << value << "\n";
471 void Parser::scan_value(void) {
474 case Trace::TYPE_NULL:
475 case Trace::TYPE_FALSE:
476 case Trace::TYPE_TRUE:
478 case Trace::TYPE_SINT:
481 case Trace::TYPE_UINT:
484 case Trace::TYPE_FLOAT:
487 case Trace::TYPE_DOUBLE:
490 case Trace::TYPE_STRING:
493 case Trace::TYPE_ENUM:
496 case Trace::TYPE_BITMASK:
499 case Trace::TYPE_ARRAY:
502 case Trace::TYPE_STRUCT:
505 case Trace::TYPE_BLOB:
508 case Trace::TYPE_OPAQUE:
512 std::cerr << "error: unknown type " << c << "\n";
520 Value *Parser::parse_sint() {
521 return new SInt(-(signed long long)read_uint());
525 void Parser::scan_sint() {
530 Value *Parser::parse_uint() {
531 return new UInt(read_uint());
535 void Parser::scan_uint() {
540 Value *Parser::parse_float() {
542 file->read(&value, sizeof value);
543 return new Float(value);
547 void Parser::scan_float() {
548 file->skip(sizeof(float));
552 Value *Parser::parse_double() {
554 file->read(&value, sizeof value);
555 return new Float(value);
559 void Parser::scan_double() {
560 file->skip(sizeof(double));
564 Value *Parser::parse_string() {
565 return new String(read_string());
569 void Parser::scan_string() {
574 Value *Parser::parse_enum() {
575 EnumSig *sig = parse_enum_sig();
576 return new Enum(sig);
580 void Parser::scan_enum() {
585 Value *Parser::parse_bitmask() {
586 BitmaskSig *sig = parse_bitmask_sig();
588 unsigned long long value = read_uint();
590 return new Bitmask(sig, value);
594 void Parser::scan_bitmask() {
596 skip_uint(); /* value */
600 Value *Parser::parse_array(void) {
601 size_t len = read_uint();
602 Array *array = new Array(len);
603 for (size_t i = 0; i < len; ++i) {
604 array->values[i] = parse_value();
610 void Parser::scan_array(void) {
611 size_t len = read_uint();
612 for (size_t i = 0; i < len; ++i) {
618 Value *Parser::parse_blob(void) {
619 size_t size = read_uint();
620 Blob *blob = new Blob(size);
622 file->read(blob->buf, (unsigned)size);
628 void Parser::scan_blob(void) {
629 size_t size = read_uint();
636 Value *Parser::parse_struct() {
637 StructSig *sig = parse_struct_sig();
638 Struct *value = new Struct(sig);
640 for (size_t i = 0; i < sig->num_members; ++i) {
641 value->members[i] = parse_value();
648 void Parser::scan_struct() {
649 StructSig *sig = parse_struct_sig();
650 for (size_t i = 0; i < sig->num_members; ++i) {
656 Value *Parser::parse_opaque() {
657 unsigned long long addr;
659 return new Pointer(addr);
663 void Parser::scan_opaque() {
668 const char * Parser::read_string(void) {
669 size_t len = read_uint();
670 char * value = new char[len + 1];
672 file->read(value, (unsigned)len);
676 std::cerr << "\tSTRING \"" << value << "\"\n";
682 void Parser::skip_string(void) {
683 size_t len = read_uint();
688 unsigned long long Parser::read_uint(void) {
689 unsigned long long value = 0;
697 value |= (unsigned long long)(c & 0x7f) << shift;
701 std::cerr << "\tUINT " << value << "\n";
707 void Parser::skip_uint(void) {
718 inline int Parser::read_byte(void) {
719 int c = file->getc();
722 std::cerr << "\tEOF" << "\n";
724 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
730 inline void Parser::skip_byte(void) {
735 } /* namespace Trace */