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_parser.hpp"
35 #define TRACE_VERBOSE 0
53 bool Parser::open(const char *filename) {
55 if (File::isZLibCompressed(filename)) {
56 file = File::createZLib();
58 file = File::createSnappy();
61 if (!file->open(filename, File::Read)) {
65 version = read_uint();
66 if (version > TRACE_VERSION) {
67 std::cerr << "error: unsupported trace format version " << version << "\n";
74 template <typename Iter>
76 deleteAll(Iter begin, Iter end)
78 while (begin != end) {
84 template <typename Container>
86 deleteAll(Container &c)
88 deleteAll(c.begin(), c.end());
92 void Parser::close(void) {
101 // Delete all signature data. Signatures are mere structures which don't
102 // own their own memory, so we need to destroy all data we created here.
104 for (FunctionMap::iterator it = functions.begin(); it != functions.end(); ++it) {
105 FunctionSigState *sig = *it;
108 for (unsigned arg = 0; arg < sig->num_args; ++arg) {
109 delete [] sig->arg_names[arg];
111 delete [] sig->arg_names;
117 for (StructMap::iterator it = structs.begin(); it != structs.end(); ++it) {
118 StructSigState *sig = *it;
121 for (unsigned member = 0; member < sig->num_members; ++member) {
122 delete [] sig->member_names[member];
124 delete [] sig->member_names;
130 for (EnumMap::iterator it = enums.begin(); it != enums.end(); ++it) {
131 EnumSigState *sig = *it;
139 for (BitmaskMap::iterator it = bitmasks.begin(); it != bitmasks.end(); ++it) {
140 BitmaskSigState *sig = *it;
142 for (unsigned flag = 0; flag < sig->num_flags; ++flag) {
143 delete [] sig->flags[flag].name;
145 delete [] sig->flags;
155 void Parser::getBookmark(ParseBookmark &bookmark) {
156 bookmark.offset = file->currentOffset();
157 bookmark.next_call_no = next_call_no;
161 void Parser::setBookmark(const ParseBookmark &bookmark) {
162 file->setCurrentOffset(bookmark.offset);
163 next_call_no = bookmark.next_call_no;
165 // Simply ignore all pending calls
170 Call *Parser::parse_call(Mode mode) {
174 case trace::EVENT_ENTER:
177 case trace::EVENT_LEAVE:
178 return parse_leave(mode);
180 std::cerr << "error: unknown event " << c << "\n";
183 if (!calls.empty()) {
184 Call *call = calls.front();
185 std::cerr << call->no << ": warning: incomplete call " << call->name() << "\n";
196 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
199 T *lookup(std::vector<T *> &map, size_t index) {
200 if (index >= map.size()) {
201 map.resize(index + 1);
209 FunctionSig *Parser::parse_function_sig(void) {
210 size_t id = read_uint();
212 FunctionSigState *sig = lookup(functions, id);
215 /* parse the signature */
216 sig = new FunctionSigState;
218 sig->name = read_string();
219 sig->num_args = read_uint();
220 const char **arg_names = new const char *[sig->num_args];
221 for (unsigned i = 0; i < sig->num_args; ++i) {
222 arg_names[i] = read_string();
224 sig->arg_names = arg_names;
225 sig->offset = file->currentOffset();
227 } else if (file->currentOffset() < sig->offset) {
228 /* skip over the signature */
229 skip_string(); /* name */
230 unsigned num_args = read_uint();
231 for (unsigned i = 0; i < num_args; ++i) {
232 skip_string(); /*arg_name*/
241 StructSig *Parser::parse_struct_sig() {
242 size_t id = read_uint();
244 StructSigState *sig = lookup(structs, id);
247 /* parse the signature */
248 sig = new StructSigState;
250 sig->name = read_string();
251 sig->num_members = read_uint();
252 const char **member_names = new const char *[sig->num_members];
253 for (unsigned i = 0; i < sig->num_members; ++i) {
254 member_names[i] = read_string();
256 sig->member_names = member_names;
257 sig->offset = file->currentOffset();
259 } else if (file->currentOffset() < sig->offset) {
260 /* skip over the signature */
261 skip_string(); /* name */
262 unsigned num_members = read_uint();
263 for (unsigned i = 0; i < num_members; ++i) {
264 skip_string(); /* member_name */
273 EnumSig *Parser::parse_enum_sig() {
274 size_t id = read_uint();
276 EnumSigState *sig = lookup(enums, id);
279 /* parse the signature */
280 sig = new EnumSigState;
282 sig->name = read_string();
283 Value *value = parse_value();
284 sig->value = value->toSInt();
286 sig->offset = file->currentOffset();
288 } else if (file->currentOffset() < sig->offset) {
289 /* skip over the signature */
290 skip_string(); /*name*/
299 BitmaskSig *Parser::parse_bitmask_sig() {
300 size_t id = read_uint();
302 BitmaskSigState *sig = lookup(bitmasks, id);
305 /* parse the signature */
306 sig = new BitmaskSigState;
308 sig->num_flags = read_uint();
309 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
310 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
311 it->name = read_string();
312 it->value = read_uint();
313 if (it->value == 0 && it != flags) {
314 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
318 sig->offset = file->currentOffset();
320 } else if (file->currentOffset() < sig->offset) {
321 /* skip over the signature */
322 int num_flags = read_uint();
323 for (int i = 0; i < num_flags; ++i) {
324 skip_string(); /*name */
325 skip_uint(); /* value */
334 void Parser::parse_enter(Mode mode) {
335 FunctionSig *sig = parse_function_sig();
337 Call *call = new Call(sig);
339 call->no = next_call_no++;
341 if (parse_call_details(call, mode)) {
342 calls.push_back(call);
349 Call *Parser::parse_leave(Mode mode) {
350 unsigned call_no = read_uint();
352 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
353 if ((*it)->no == call_no) {
363 if (parse_call_details(call, mode)) {
372 bool Parser::parse_call_details(Call *call, Mode mode) {
376 case trace::CALL_END:
378 case trace::CALL_ARG:
379 parse_arg(call, mode);
381 case trace::CALL_RET:
382 call->ret = parse_value(mode);
385 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
395 void Parser::parse_arg(Call *call, Mode mode) {
396 unsigned index = read_uint();
397 Value *value = parse_value(mode);
399 if (index >= call->args.size()) {
400 call->args.resize(index + 1);
402 call->args[index] = value;
407 Value *Parser::parse_value(void) {
412 case trace::TYPE_NULL:
415 case trace::TYPE_FALSE:
416 value = new Bool(false);
418 case trace::TYPE_TRUE:
419 value = new Bool(true);
421 case trace::TYPE_SINT:
422 value = parse_sint();
424 case trace::TYPE_UINT:
425 value = parse_uint();
427 case trace::TYPE_FLOAT:
428 value = parse_float();
430 case trace::TYPE_DOUBLE:
431 value = parse_double();
433 case trace::TYPE_STRING:
434 value = parse_string();
436 case trace::TYPE_ENUM:
437 value = parse_enum();
439 case trace::TYPE_BITMASK:
440 value = parse_bitmask();
442 case trace::TYPE_ARRAY:
443 value = parse_array();
445 case trace::TYPE_STRUCT:
446 value = parse_struct();
448 case trace::TYPE_BLOB:
449 value = parse_blob();
451 case trace::TYPE_OPAQUE:
452 value = parse_opaque();
455 std::cerr << "error: unknown type " << c << "\n";
463 std::cerr << "\tVALUE " << value << "\n";
470 void Parser::scan_value(void) {
473 case trace::TYPE_NULL:
474 case trace::TYPE_FALSE:
475 case trace::TYPE_TRUE:
477 case trace::TYPE_SINT:
480 case trace::TYPE_UINT:
483 case trace::TYPE_FLOAT:
486 case trace::TYPE_DOUBLE:
489 case trace::TYPE_STRING:
492 case trace::TYPE_ENUM:
495 case trace::TYPE_BITMASK:
498 case trace::TYPE_ARRAY:
501 case trace::TYPE_STRUCT:
504 case trace::TYPE_BLOB:
507 case trace::TYPE_OPAQUE:
511 std::cerr << "error: unknown type " << c << "\n";
519 Value *Parser::parse_sint() {
520 return new SInt(-(signed long long)read_uint());
524 void Parser::scan_sint() {
529 Value *Parser::parse_uint() {
530 return new UInt(read_uint());
534 void Parser::scan_uint() {
539 Value *Parser::parse_float() {
541 file->read(&value, sizeof value);
542 return new Float(value);
546 void Parser::scan_float() {
547 file->skip(sizeof(float));
551 Value *Parser::parse_double() {
553 file->read(&value, sizeof value);
554 return new Float(value);
558 void Parser::scan_double() {
559 file->skip(sizeof(double));
563 Value *Parser::parse_string() {
564 return new String(read_string());
568 void Parser::scan_string() {
573 Value *Parser::parse_enum() {
574 EnumSig *sig = parse_enum_sig();
575 return new Enum(sig);
579 void Parser::scan_enum() {
584 Value *Parser::parse_bitmask() {
585 BitmaskSig *sig = parse_bitmask_sig();
587 unsigned long long value = read_uint();
589 return new Bitmask(sig, value);
593 void Parser::scan_bitmask() {
595 skip_uint(); /* value */
599 Value *Parser::parse_array(void) {
600 size_t len = read_uint();
601 Array *array = new Array(len);
602 for (size_t i = 0; i < len; ++i) {
603 array->values[i] = parse_value();
609 void Parser::scan_array(void) {
610 size_t len = read_uint();
611 for (size_t i = 0; i < len; ++i) {
617 Value *Parser::parse_blob(void) {
618 size_t size = read_uint();
619 Blob *blob = new Blob(size);
621 file->read(blob->buf, (unsigned)size);
627 void Parser::scan_blob(void) {
628 size_t size = read_uint();
635 Value *Parser::parse_struct() {
636 StructSig *sig = parse_struct_sig();
637 Struct *value = new Struct(sig);
639 for (size_t i = 0; i < sig->num_members; ++i) {
640 value->members[i] = parse_value();
647 void Parser::scan_struct() {
648 StructSig *sig = parse_struct_sig();
649 for (size_t i = 0; i < sig->num_members; ++i) {
655 Value *Parser::parse_opaque() {
656 unsigned long long addr;
658 return new Pointer(addr);
662 void Parser::scan_opaque() {
667 const char * Parser::read_string(void) {
668 size_t len = read_uint();
669 char * value = new char[len + 1];
671 file->read(value, (unsigned)len);
675 std::cerr << "\tSTRING \"" << value << "\"\n";
681 void Parser::skip_string(void) {
682 size_t len = read_uint();
687 unsigned long long Parser::read_uint(void) {
688 unsigned long long value = 0;
696 value |= (unsigned long long)(c & 0x7f) << shift;
700 std::cerr << "\tUINT " << value << "\n";
706 void Parser::skip_uint(void) {
717 inline int Parser::read_byte(void) {
718 int c = file->getc();
721 std::cerr << "\tEOF" << "\n";
723 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
729 inline void Parser::skip_byte(void) {
734 } /* namespace trace */