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;
154 void Parser::getBookmark(ParseBookmark &bookmark) {
155 bookmark.offset = file->currentOffset();
156 bookmark.next_call_no = next_call_no;
160 void Parser::setBookmark(const ParseBookmark &bookmark) {
161 file->setCurrentOffset(bookmark.offset);
162 next_call_no = bookmark.next_call_no;
164 // Simply ignore all pending calls
169 Call *Parser::parse_call(Mode mode) {
173 case Trace::EVENT_ENTER:
176 case Trace::EVENT_LEAVE:
177 return parse_leave(mode);
179 std::cerr << "error: unknown event " << c << "\n";
182 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
183 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
184 std::cerr << **it << "\n";
193 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
196 T *lookup(std::vector<T *> &map, size_t index) {
197 if (index >= map.size()) {
198 map.resize(index + 1);
206 FunctionSig *Parser::parse_function_sig(void) {
207 size_t id = read_uint();
209 FunctionSigState *sig = lookup(functions, id);
212 /* parse the signature */
213 sig = new FunctionSigState;
215 sig->name = read_string();
216 sig->num_args = read_uint();
217 const char **arg_names = new const char *[sig->num_args];
218 for (unsigned i = 0; i < sig->num_args; ++i) {
219 arg_names[i] = read_string();
221 sig->arg_names = arg_names;
222 sig->offset = file->currentOffset();
224 } else if (file->currentOffset() < sig->offset) {
225 /* skip over the signature */
226 skip_string(); /* name */
227 int num_args = read_uint();
228 for (unsigned i = 0; i < num_args; ++i) {
229 skip_string(); /*arg_name*/
238 StructSig *Parser::parse_struct_sig() {
239 size_t id = read_uint();
241 StructSigState *sig = lookup(structs, id);
244 /* parse the signature */
245 sig = new StructSigState;
247 sig->name = read_string();
248 sig->num_members = read_uint();
249 const char **member_names = new const char *[sig->num_members];
250 for (unsigned i = 0; i < sig->num_members; ++i) {
251 member_names[i] = read_string();
253 sig->member_names = member_names;
254 sig->offset = file->currentOffset();
256 } else if (file->currentOffset() < sig->offset) {
257 /* skip over the signature */
258 skip_string(); /* name */
259 unsigned num_members = read_uint();
260 for (unsigned i = 0; i < num_members; ++i) {
261 skip_string(); /* member_name */
270 EnumSig *Parser::parse_enum_sig() {
271 size_t id = read_uint();
273 EnumSigState *sig = lookup(enums, id);
276 /* parse the signature */
277 sig = new EnumSigState;
279 sig->name = read_string();
280 Value *value = parse_value();
281 sig->value = value->toSInt();
283 sig->offset = file->currentOffset();
285 } else if (file->currentOffset() < sig->offset) {
286 /* skip over the signature */
287 skip_string(); /*name*/
296 BitmaskSig *Parser::parse_bitmask_sig() {
297 size_t id = read_uint();
299 BitmaskSigState *sig = lookup(bitmasks, id);
302 /* parse the signature */
303 sig = new BitmaskSigState;
305 sig->num_flags = read_uint();
306 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
307 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
308 it->name = read_string();
309 it->value = read_uint();
310 if (it->value == 0 && it != flags) {
311 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
315 sig->offset = file->currentOffset();
317 } else if (file->currentOffset() < sig->offset) {
318 /* skip over the signature */
319 int num_flags = read_uint();
320 for (int i = 0; i < num_flags; ++i) {
321 skip_string(); /*name */
322 skip_uint(); /* value */
331 void Parser::parse_enter(Mode mode) {
332 FunctionSig *sig = parse_function_sig();
334 Call *call = new Call(sig);
336 call->no = next_call_no++;
338 if (parse_call_details(call, mode)) {
339 calls.push_back(call);
346 Call *Parser::parse_leave(Mode mode) {
347 unsigned call_no = read_uint();
349 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
350 if ((*it)->no == call_no) {
360 if (parse_call_details(call, mode)) {
369 bool Parser::parse_call_details(Call *call, Mode mode) {
373 case Trace::CALL_END:
375 case Trace::CALL_ARG:
376 parse_arg(call, mode);
378 case Trace::CALL_RET:
379 call->ret = parse_value(mode);
382 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
392 void Parser::parse_arg(Call *call, Mode mode) {
393 unsigned index = read_uint();
394 Value *value = parse_value(mode);
396 if (index >= call->args.size()) {
397 call->args.resize(index + 1);
399 call->args[index] = value;
404 Value *Parser::parse_value(void) {
409 case Trace::TYPE_NULL:
412 case Trace::TYPE_FALSE:
413 value = new Bool(false);
415 case Trace::TYPE_TRUE:
416 value = new Bool(true);
418 case Trace::TYPE_SINT:
419 value = parse_sint();
421 case Trace::TYPE_UINT:
422 value = parse_uint();
424 case Trace::TYPE_FLOAT:
425 value = parse_float();
427 case Trace::TYPE_DOUBLE:
428 value = parse_double();
430 case Trace::TYPE_STRING:
431 value = parse_string();
433 case Trace::TYPE_ENUM:
434 value = parse_enum();
436 case Trace::TYPE_BITMASK:
437 value = parse_bitmask();
439 case Trace::TYPE_ARRAY:
440 value = parse_array();
442 case Trace::TYPE_STRUCT:
443 value = parse_struct();
445 case Trace::TYPE_BLOB:
446 value = parse_blob();
448 case Trace::TYPE_OPAQUE:
449 value = parse_opaque();
452 std::cerr << "error: unknown type " << c << "\n";
460 std::cerr << "\tVALUE " << value << "\n";
467 void Parser::scan_value(void) {
470 case Trace::TYPE_NULL:
471 case Trace::TYPE_FALSE:
472 case Trace::TYPE_TRUE:
474 case Trace::TYPE_SINT:
477 case Trace::TYPE_UINT:
480 case Trace::TYPE_FLOAT:
483 case Trace::TYPE_DOUBLE:
486 case Trace::TYPE_STRING:
489 case Trace::TYPE_ENUM:
492 case Trace::TYPE_BITMASK:
495 case Trace::TYPE_ARRAY:
498 case Trace::TYPE_STRUCT:
501 case Trace::TYPE_BLOB:
504 case Trace::TYPE_OPAQUE:
508 std::cerr << "error: unknown type " << c << "\n";
516 Value *Parser::parse_sint() {
517 return new SInt(-(signed long long)read_uint());
521 void Parser::scan_sint() {
526 Value *Parser::parse_uint() {
527 return new UInt(read_uint());
531 void Parser::scan_uint() {
536 Value *Parser::parse_float() {
538 file->read(&value, sizeof value);
539 return new Float(value);
543 void Parser::scan_float() {
544 file->skip(sizeof(float));
548 Value *Parser::parse_double() {
550 file->read(&value, sizeof value);
551 return new Float(value);
555 void Parser::scan_double() {
556 file->skip(sizeof(double));
560 Value *Parser::parse_string() {
561 return new String(read_string());
565 void Parser::scan_string() {
570 Value *Parser::parse_enum() {
571 EnumSig *sig = parse_enum_sig();
572 return new Enum(sig);
576 void Parser::scan_enum() {
581 Value *Parser::parse_bitmask() {
582 BitmaskSig *sig = parse_bitmask_sig();
584 unsigned long long value = read_uint();
586 return new Bitmask(sig, value);
590 void Parser::scan_bitmask() {
592 skip_uint(); /* value */
596 Value *Parser::parse_array(void) {
597 size_t len = read_uint();
598 Array *array = new Array(len);
599 for (size_t i = 0; i < len; ++i) {
600 array->values[i] = parse_value();
606 void Parser::scan_array(void) {
607 size_t len = read_uint();
608 for (size_t i = 0; i < len; ++i) {
614 Value *Parser::parse_blob(void) {
615 size_t size = read_uint();
616 Blob *blob = new Blob(size);
618 file->read(blob->buf, (unsigned)size);
624 void Parser::scan_blob(void) {
625 size_t size = read_uint();
632 Value *Parser::parse_struct() {
633 StructSig *sig = parse_struct_sig();
634 Struct *value = new Struct(sig);
636 for (size_t i = 0; i < sig->num_members; ++i) {
637 value->members[i] = parse_value();
644 void Parser::scan_struct() {
645 StructSig *sig = parse_struct_sig();
646 for (size_t i = 0; i < sig->num_members; ++i) {
652 Value *Parser::parse_opaque() {
653 unsigned long long addr;
655 return new Pointer(addr);
659 void Parser::scan_opaque() {
664 const char * Parser::read_string(void) {
665 size_t len = read_uint();
666 char * value = new char[len + 1];
668 file->read(value, (unsigned)len);
672 std::cerr << "\tSTRING \"" << value << "\"\n";
678 void Parser::skip_string(void) {
679 size_t len = read_uint();
684 unsigned long long Parser::read_uint(void) {
685 unsigned long long value = 0;
693 value |= (unsigned long long)(c & 0x7f) << shift;
697 std::cerr << "\tUINT " << value << "\n";
703 void Parser::skip_uint(void) {
714 inline int Parser::read_byte(void) {
715 int c = file->getc();
718 std::cerr << "\tEOF" << "\n";
720 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
726 inline void Parser::skip_byte(void) {
731 } /* namespace Trace */