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
46 m_supportsSeeking = false;
55 bool Parser::open(const char *filename) {
57 if (File::isZLibCompressed(filename)) {
60 file = new SnappyFile;
63 if (!file->open(filename, File::Read)) {
66 m_supportsSeeking = file->supportsOffsets();
68 version = read_uint();
69 if (version > TRACE_VERSION) {
70 std::cerr << "error: unsupported trace format version " << version << "\n";
77 template <typename Iter>
79 deleteAll(Iter begin, Iter end)
81 while (begin != end) {
87 template <typename Container>
89 deleteAll(Container &c)
91 deleteAll(c.begin(), c.end());
95 void Parser::close(void) {
103 deleteAll(functions);
110 Call *Parser::parse_call(void) {
114 case Trace::EVENT_ENTER:
117 case Trace::EVENT_LEAVE:
118 return parse_leave();
120 std::cerr << "error: unknown event " << c << "\n";
123 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
124 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
125 std::cerr << **it << "\n";
134 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
137 T *lookup(std::vector<T *> &map, size_t index) {
138 if (index >= map.size()) {
139 map.resize(index + 1);
147 void Parser::parse_enter(void) {
148 size_t id = read_uint();
150 FunctionSig *sig = lookup(functions, id);
154 bool callWithSig = false;
155 if (m_supportsSeeking) {
156 offset = file->currentOffset();
157 callWithSig = callWithSignature(offset);
160 if (!sig || callWithSig) {
162 sig = new FunctionSig;
164 sig->name = read_string();
165 sig->num_args = read_uint();
166 const char **arg_names = new const char *[sig->num_args];
167 for (unsigned i = 0; i < sig->num_args; ++i) {
168 arg_names[i] = read_string();
170 sig->arg_names = arg_names;
172 if (m_supportsSeeking) {
173 m_callSigOffsets.insert(offset);
176 /* skip over the signature */
177 skip_string(); /* name */
178 int num_args = read_uint();
179 for (unsigned i = 0; i < num_args; ++i) {
180 skip_string(); /*arg_name*/
186 Call *call = new Call(sig);
189 call->no = next_call_no++;
191 if (parse_call_details(call)) {
192 calls.push_back(call);
199 Call *Parser::parse_leave(void) {
200 unsigned call_no = read_uint();
202 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
203 if ((*it)->no == call_no) {
213 if (parse_call_details(call)) {
222 bool Parser::parse_call_details(Call *call) {
226 case Trace::CALL_END:
228 case Trace::CALL_ARG:
231 case Trace::CALL_RET:
232 call->ret = parse_value();
235 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
245 void Parser::parse_arg(Call *call) {
246 unsigned index = read_uint();
247 Value *value = parse_value();
248 if (index >= call->args.size()) {
249 call->args.resize(index + 1);
251 call->args[index] = value;
255 Value *Parser::parse_value(void) {
260 case Trace::TYPE_NULL:
263 case Trace::TYPE_FALSE:
264 value = new Bool(false);
266 case Trace::TYPE_TRUE:
267 value = new Bool(true);
269 case Trace::TYPE_SINT:
270 value = parse_sint();
272 case Trace::TYPE_UINT:
273 value = parse_uint();
275 case Trace::TYPE_FLOAT:
276 value = parse_float();
278 case Trace::TYPE_DOUBLE:
279 value = parse_double();
281 case Trace::TYPE_STRING:
282 value = parse_string();
284 case Trace::TYPE_ENUM:
285 value = parse_enum();
287 case Trace::TYPE_BITMASK:
288 value = parse_bitmask();
290 case Trace::TYPE_ARRAY:
291 value = parse_array();
293 case Trace::TYPE_STRUCT:
294 value = parse_struct();
296 case Trace::TYPE_BLOB:
297 value = parse_blob();
299 case Trace::TYPE_OPAQUE:
300 value = parse_opaque();
303 std::cerr << "error: unknown type " << c << "\n";
311 std::cerr << "\tVALUE " << value << "\n";
318 Value *Parser::parse_sint() {
319 return new SInt(-(signed long long)read_uint());
323 Value *Parser::parse_uint() {
324 return new UInt(read_uint());
328 Value *Parser::parse_float() {
330 file->read(&value, sizeof value);
331 return new Float(value);
335 Value *Parser::parse_double() {
337 file->read(&value, sizeof value);
338 return new Float(value);
342 Value *Parser::parse_string() {
343 return new String(read_string());
347 Value *Parser::parse_enum() {
348 size_t id = read_uint();
349 EnumSig *sig = lookup(enums, id);
351 bool enumWithSig = false;
353 if (m_supportsSeeking) {
354 offset = file->currentOffset();
355 enumWithSig = enumWithSignature(offset);
358 if (!sig || enumWithSig) {
362 sig->name = read_string();
363 Value *value = parse_value();
364 sig->value = value->toSInt();
367 if (m_supportsSeeking) {
368 m_enumSigOffsets.insert(offset);
371 skip_string(); /*name*/
376 return new Enum(sig);
380 Value *Parser::parse_bitmask() {
381 size_t id = read_uint();
382 BitmaskSig *sig = lookup(bitmasks, id);
384 bool bitmaskWithSig = false;
386 if (m_supportsSeeking) {
387 offset = file->currentOffset();
388 bitmaskWithSig = bitmaskWithSignature(offset);
391 if (!sig || bitmaskWithSig) {
393 sig = new BitmaskSig;
395 sig->num_flags = read_uint();
396 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
397 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
398 it->name = read_string();
399 it->value = read_uint();
400 if (it->value == 0 && it != flags) {
401 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
406 if (m_supportsSeeking) {
407 m_bitmaskSigOffsets.insert(offset);
410 int num_flags = read_uint();
411 for (int i = 0; i < num_flags; ++i) {
412 skip_string(); /*name */
413 skip_uint(); /* value */
419 unsigned long long value = read_uint();
421 return new Bitmask(sig, value);
425 Value *Parser::parse_array(void) {
426 size_t len = read_uint();
427 Array *array = new Array(len);
428 for (size_t i = 0; i < len; ++i) {
429 array->values[i] = parse_value();
435 Value *Parser::parse_blob(void) {
436 size_t size = read_uint();
437 Blob *blob = new Blob(size);
439 file->read(blob->buf, (unsigned)size);
445 Value *Parser::parse_struct() {
446 size_t id = read_uint();
448 StructSig *sig = lookup(structs, id);
450 bool structWithSig = false;
452 if (m_supportsSeeking) {
453 offset = file->currentOffset();
454 structWithSig = structWithSignature(offset);
457 if (!sig || structWithSig) {
461 sig->name = read_string();
462 sig->num_members = read_uint();
463 const char **member_names = new const char *[sig->num_members];
464 for (unsigned i = 0; i < sig->num_members; ++i) {
465 member_names[i] = read_string();
467 sig->member_names = member_names;
469 if (m_supportsSeeking) {
470 m_structSigOffsets.insert(offset);
473 skip_string(); /* name */
474 unsigned num_members = read_uint();
475 for (unsigned i = 0; i < num_members; ++i) {
476 skip_string(); /* member_name */
482 Struct *value = new Struct(sig);
484 for (size_t i = 0; i < sig->num_members; ++i) {
485 value->members[i] = parse_value();
492 Value *Parser::parse_opaque() {
493 unsigned long long addr;
495 return new Pointer(addr);
499 const char * Parser::read_string(void) {
500 size_t len = read_uint();
501 char * value = new char[len + 1];
503 file->read(value, (unsigned)len);
507 std::cerr << "\tSTRING \"" << value << "\"\n";
513 unsigned long long Parser::read_uint(void) {
514 unsigned long long value = 0;
522 value |= (unsigned long long)(c & 0x7f) << shift;
526 std::cerr << "\tUINT " << value << "\n";
532 inline int Parser::read_byte(void) {
533 int c = file->getc();
536 std::cerr << "\tEOF" << "\n";
538 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
544 inline bool Parser::callWithSignature(const File::Offset &offset) const
546 return m_callSigOffsets.find(offset) != m_callSigOffsets.end();
549 inline bool Parser::structWithSignature(const File::Offset &offset) const
551 return m_structSigOffsets.find(offset) != m_structSigOffsets.end();
554 inline bool Parser::enumWithSignature(const File::Offset &offset) const
556 return m_enumSigOffsets.find(offset) != m_enumSigOffsets.end();
559 inline bool Parser::bitmaskWithSignature(const File::Offset &offset) const
561 return m_bitmaskSigOffsets.find(offset) != m_bitmaskSigOffsets.end();
564 Call * Parser::scan_call()
566 assert(m_supportsSeeking);
570 case Trace::EVENT_ENTER:
573 case Trace::EVENT_LEAVE:
576 std::cerr << "error: unknown event " << c << "\n";
579 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
580 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
581 std::cerr << **it << "\n";
588 void Parser::scan_enter(void) {
589 size_t id = read_uint();
591 FunctionSig *sig = lookup(functions, id);
592 const File::Offset offset = file->currentOffset();
594 sig = new FunctionSig;
596 sig->name = read_string();
597 sig->num_args = read_uint();
598 const char **arg_names = new const char *[sig->num_args];
599 for (unsigned i = 0; i < sig->num_args; ++i) {
600 arg_names[i] = read_string();
602 sig->arg_names = arg_names;
604 m_callSigOffsets.insert(offset);
608 Call *call = new Call(sig);
609 call->no = next_call_no++;
611 if (scan_call_details(call)) {
612 calls.push_back(call);
618 Call *Parser::scan_leave(void) {
619 unsigned call_no = read_uint();
621 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
622 if ((*it)->no == call_no) {
632 if (scan_call_details(call)) {
640 bool Parser::scan_call_details(Call *call) {
644 case Trace::CALL_END:
646 case Trace::CALL_ARG:
649 case Trace::CALL_RET:
653 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
662 void Parser::scan_arg(Call *call) {
663 skip_uint(); /* index */
664 scan_value(); /* value */
668 void Parser::scan_value(void) {
671 case Trace::TYPE_NULL:
672 case Trace::TYPE_FALSE:
673 case Trace::TYPE_TRUE:
675 case Trace::TYPE_SINT:
678 case Trace::TYPE_UINT:
681 case Trace::TYPE_FLOAT:
684 case Trace::TYPE_DOUBLE:
687 case Trace::TYPE_STRING:
690 case Trace::TYPE_ENUM:
693 case Trace::TYPE_BITMASK:
696 case Trace::TYPE_ARRAY:
699 case Trace::TYPE_STRUCT:
702 case Trace::TYPE_BLOB:
705 case Trace::TYPE_OPAQUE:
709 std::cerr << "error: unknown type " << c << "\n";
717 void Parser::scan_sint() {
722 void Parser::scan_uint() {
727 void Parser::scan_float() {
728 file->skip(sizeof(float));
732 void Parser::scan_double() {
733 file->skip(sizeof(double));
737 void Parser::scan_string() {
742 void Parser::scan_enum() {
743 size_t id = read_uint();
744 EnumSig *sig = lookup(enums, id);
745 const File::Offset offset = file->currentOffset();
749 sig->name = read_string();
750 Value *value = parse_value();
751 sig->value = value->toSInt();
754 m_enumSigOffsets.insert(offset);
760 void Parser::scan_bitmask() {
761 size_t id = read_uint();
762 BitmaskSig *sig = lookup(bitmasks, id);
763 const File::Offset offset = file->currentOffset();
765 sig = new BitmaskSig;
767 sig->num_flags = read_uint();
768 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
769 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
770 it->name = read_string();
771 it->value = read_uint();
772 if (it->value == 0 && it != flags) {
773 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
778 m_bitmaskSigOffsets.insert(offset);
782 skip_uint(); /* value */
786 void Parser::scan_array(void) {
787 size_t len = read_uint();
788 for (size_t i = 0; i < len; ++i) {
794 void Parser::scan_blob(void) {
795 size_t size = read_uint();
797 file->skip((unsigned)size);
802 void Parser::scan_struct() {
803 size_t id = read_uint();
805 StructSig *sig = lookup(structs, id);
806 const File::Offset offset = file->currentOffset();
810 sig->name = read_string();
811 sig->num_members = read_uint();
812 const char **member_names = new const char *[sig->num_members];
813 for (unsigned i = 0; i < sig->num_members; ++i) {
814 member_names[i] = read_string();
816 sig->member_names = member_names;
818 m_structSigOffsets.insert(offset);
822 for (size_t i = 0; i < sig->num_members; ++i) {
828 void Parser::scan_opaque() {
833 void Parser::skip_string(void) {
834 size_t len = read_uint();
835 file->skip((unsigned)len);
839 void Parser::skip_uint(void) {
850 inline void Parser::skip_byte(void) {
855 } /* namespace Trace */