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 **************************************************************************/
32 #include "trace_file.hpp"
33 #include "trace_dump.hpp"
34 #include "trace_parser.hpp"
37 #define TRACE_VERBOSE 0
58 bool Parser::open(const char *filename) {
60 file = File::createForRead(filename);
65 version = read_uint();
66 if (version > TRACE_VERSION) {
67 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;
134 for (unsigned value = 0; value < sig->num_values; ++value) {
135 delete [] sig->values[value].name;
137 delete [] sig->values;
143 for (BitmaskMap::iterator it = bitmasks.begin(); it != bitmasks.end(); ++it) {
144 BitmaskSigState *sig = *it;
146 for (unsigned flag = 0; flag < sig->num_flags; ++flag) {
147 delete [] sig->flags[flag].name;
149 delete [] sig->flags;
159 void Parser::getBookmark(ParseBookmark &bookmark) {
160 bookmark.offset = file->currentOffset();
161 bookmark.next_call_no = next_call_no;
165 void Parser::setBookmark(const ParseBookmark &bookmark) {
166 file->setCurrentOffset(bookmark.offset);
167 next_call_no = bookmark.next_call_no;
169 // Simply ignore all pending calls
174 Call *Parser::parse_call(Mode mode) {
179 case trace::EVENT_ENTER:
181 std::cerr << "\tENTER\n";
185 case trace::EVENT_LEAVE:
187 std::cerr << "\tLEAVE\n";
189 call = parse_leave(mode);
191 adjust_call_flags(call);
196 std::cerr << "error: unknown event " << c << "\n";
199 if (!calls.empty()) {
200 call = calls.front();
201 call->flags |= CALL_FLAG_INCOMPLETE;
203 adjust_call_flags(call);
213 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
216 T *lookup(std::vector<T *> &map, size_t index) {
217 if (index >= map.size()) {
218 map.resize(index + 1);
226 Parser::FunctionSigFlags *
227 Parser::parse_function_sig(void) {
228 size_t id = read_uint();
230 FunctionSigState *sig = lookup(functions, id);
233 /* parse the signature */
234 sig = new FunctionSigState;
236 sig->name = read_string();
237 sig->num_args = read_uint();
238 const char **arg_names = new const char *[sig->num_args];
239 for (unsigned i = 0; i < sig->num_args; ++i) {
240 arg_names[i] = read_string();
242 sig->arg_names = arg_names;
243 sig->flags = lookupCallFlags(sig->name);
244 sig->fileOffset = file->currentOffset();
248 * Try to autodetect the API.
250 * XXX: Ideally we would allow to mix multiple APIs in a single trace,
251 * but as it stands today, retrace is done separately for each API.
253 if (api == API_UNKNOWN) {
254 const char *n = sig->name;
255 if ((n[0] == 'g' && n[1] == 'l' && n[2] == 'X') || // glX*
256 (n[0] == 'w' && n[1] == 'g' && n[2] == 'l' && n[3] >= 'A' && n[3] <= 'Z') || // wgl[A-Z]*
257 (n[0] == 'C' && n[1] == 'G' && n[2] == 'L')) { // CGL*
259 } else if (n[0] == 'e' && n[1] == 'g' && n[2] == 'l' && n[3] >= 'A' && n[3] <= 'Z') { // egl[A-Z]*
260 api = trace::API_EGL;
261 } else if ((n[0] == 'D' &&
262 ((n[1] == 'i' && n[2] == 'r' && n[3] == 'e' && n[4] == 'c' && n[5] == 't') || // Direct*
263 (n[1] == '3' && n[2] == 'D'))) || // D3D*
264 (n[0] == 'C' && n[1] == 'r' && n[2] == 'e' && n[3] == 'a' && n[4] == 't' && n[5] == 'e')) { // Create*
272 * Note down the signature of special functions for future reference.
274 * NOTE: If the number of comparisons increases we should move this to a
275 * separate function and use bisection.
277 if (sig->num_args == 0 &&
278 strcmp(sig->name, "glGetError") == 0) {
282 } else if (file->currentOffset() < sig->fileOffset) {
283 /* skip over the signature */
284 skip_string(); /* name */
285 unsigned num_args = read_uint();
286 for (unsigned i = 0; i < num_args; ++i) {
287 skip_string(); /*arg_name*/
296 StructSig *Parser::parse_struct_sig() {
297 size_t id = read_uint();
299 StructSigState *sig = lookup(structs, id);
302 /* parse the signature */
303 sig = new StructSigState;
305 sig->name = read_string();
306 sig->num_members = read_uint();
307 const char **member_names = new const char *[sig->num_members];
308 for (unsigned i = 0; i < sig->num_members; ++i) {
309 member_names[i] = read_string();
311 sig->member_names = member_names;
312 sig->fileOffset = file->currentOffset();
314 } else if (file->currentOffset() < sig->fileOffset) {
315 /* skip over the signature */
316 skip_string(); /* name */
317 unsigned num_members = read_uint();
318 for (unsigned i = 0; i < num_members; ++i) {
319 skip_string(); /* member_name */
329 * Old enum signatures would cover a single name/value only:
331 * enum_sig = id name value
334 EnumSig *Parser::parse_old_enum_sig() {
335 size_t id = read_uint();
337 EnumSigState *sig = lookup(enums, id);
340 /* parse the signature */
341 sig = new EnumSigState;
344 EnumValue *values = new EnumValue[sig->num_values];
345 values->name = read_string();
346 values->value = read_sint();
347 sig->values = values;
348 sig->fileOffset = file->currentOffset();
350 } else if (file->currentOffset() < sig->fileOffset) {
351 /* skip over the signature */
352 skip_string(); /*name*/
361 EnumSig *Parser::parse_enum_sig() {
362 size_t id = read_uint();
364 EnumSigState *sig = lookup(enums, id);
367 /* parse the signature */
368 sig = new EnumSigState;
370 sig->num_values = read_uint();
371 EnumValue *values = new EnumValue[sig->num_values];
372 for (EnumValue *it = values; it != values + sig->num_values; ++it) {
373 it->name = read_string();
374 it->value = read_sint();
376 sig->values = values;
377 sig->fileOffset = file->currentOffset();
379 } else if (file->currentOffset() < sig->fileOffset) {
380 /* skip over the signature */
381 int num_values = read_uint();
382 for (int i = 0; i < num_values; ++i) {
383 skip_string(); /*name */
384 skip_sint(); /* value */
393 BitmaskSig *Parser::parse_bitmask_sig() {
394 size_t id = read_uint();
396 BitmaskSigState *sig = lookup(bitmasks, id);
399 /* parse the signature */
400 sig = new BitmaskSigState;
402 sig->num_flags = read_uint();
403 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
404 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
405 it->name = read_string();
406 it->value = read_uint();
407 if (it->value == 0 && it != flags) {
408 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
412 sig->fileOffset = file->currentOffset();
414 } else if (file->currentOffset() < sig->fileOffset) {
415 /* skip over the signature */
416 int num_flags = read_uint();
417 for (int i = 0; i < num_flags; ++i) {
418 skip_string(); /*name */
419 skip_uint(); /* value */
428 void Parser::parse_enter(Mode mode) {
432 thread_id = read_uint();
437 FunctionSigFlags *sig = parse_function_sig();
439 Call *call = new Call(sig, sig->flags, thread_id);
441 call->no = next_call_no++;
443 if (parse_call_details(call, mode)) {
444 calls.push_back(call);
451 Call *Parser::parse_leave(Mode mode) {
452 unsigned call_no = read_uint();
454 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
455 if ((*it)->no == call_no) {
462 /* This might happen on random access, when an asynchronous call is stranded
463 * between two frames. We won't return this call, but we still need to skip
466 const FunctionSig sig = {0, NULL, 0, NULL};
467 call = new Call(&sig, 0, 0);
468 parse_call_details(call, SCAN);
473 if (parse_call_details(call, mode)) {
482 bool Parser::parse_call_details(Call *call, Mode mode) {
486 case trace::CALL_END:
488 std::cerr << "\tCALL_END\n";
491 case trace::CALL_ARG:
493 std::cerr << "\tCALL_ARG\n";
495 parse_arg(call, mode);
497 case trace::CALL_RET:
499 std::cerr << "\tCALL_RET\n";
501 call->ret = parse_value(mode);
503 case trace::CALL_BACKTRACE:
505 std::cerr << "\tCALL_BACKTRACE\n";
507 parse_call_backtrace(call, mode);
510 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
519 bool Parser::parse_call_backtrace(Call *call, Mode mode) {
520 unsigned num_frames = read_uint();
521 Backtrace* backtrace = new Backtrace(num_frames);
522 for (unsigned i = 0; i < num_frames; ++i) {
523 (*backtrace)[i] = parse_backtrace_frame(mode);
525 call->backtrace = backtrace;
529 StackFrame * Parser::parse_backtrace_frame(Mode mode) {
530 size_t id = read_uint();
532 StackFrameState *frame = lookup(frames, id);
535 frame = new StackFrameState;
537 while (c != trace::BACKTRACE_END &&
540 case trace::BACKTRACE_MODULE:
541 frame->module = read_string();
543 case trace::BACKTRACE_FUNCTION:
544 frame->function = read_string();
546 case trace::BACKTRACE_FILENAME:
547 frame->filename = read_string();
549 case trace::BACKTRACE_LINENUMBER:
550 frame->linenumber = read_uint();
552 case trace::BACKTRACE_OFFSET:
553 frame->offset = read_uint();
556 std::cerr << "error: unknown backtrace detail "
563 frame->fileOffset = file->currentOffset();
565 } else if (file->currentOffset() < frame->fileOffset) {
567 while (c != trace::BACKTRACE_END &&
570 case trace::BACKTRACE_MODULE:
573 case trace::BACKTRACE_FUNCTION:
576 case trace::BACKTRACE_FILENAME:
579 case trace::BACKTRACE_LINENUMBER:
582 case trace::BACKTRACE_OFFSET:
586 std::cerr << "error: unknown backtrace detail "
598 * Make adjustments to this particular call flags.
600 * NOTE: This is called per-call so no string comparisons should be done here.
601 * All name comparisons should be done when the signature is parsed instead.
603 void Parser::adjust_call_flags(Call *call) {
604 // Mark glGetError() = GL_NO_ERROR as verbose
605 if (call->sig == glGetErrorSig &&
607 call->ret->toSInt() == 0) {
608 call->flags |= CALL_FLAG_VERBOSE;
612 void Parser::parse_arg(Call *call, Mode mode) {
613 unsigned index = read_uint();
614 Value *value = parse_value(mode);
616 if (index >= call->args.size()) {
617 call->args.resize(index + 1);
619 call->args[index].value = value;
624 Value *Parser::parse_value(void) {
629 case trace::TYPE_NULL:
632 case trace::TYPE_FALSE:
633 value = new Bool(false);
635 case trace::TYPE_TRUE:
636 value = new Bool(true);
638 case trace::TYPE_SINT:
639 value = parse_sint();
641 case trace::TYPE_UINT:
642 value = parse_uint();
644 case trace::TYPE_FLOAT:
645 value = parse_float();
647 case trace::TYPE_DOUBLE:
648 value = parse_double();
650 case trace::TYPE_STRING:
651 value = parse_string();
653 case trace::TYPE_ENUM:
654 value = parse_enum();
656 case trace::TYPE_BITMASK:
657 value = parse_bitmask();
659 case trace::TYPE_ARRAY:
660 value = parse_array();
662 case trace::TYPE_STRUCT:
663 value = parse_struct();
665 case trace::TYPE_BLOB:
666 value = parse_blob();
668 case trace::TYPE_OPAQUE:
669 value = parse_opaque();
671 case trace::TYPE_REPR:
672 value = parse_repr();
675 std::cerr << "error: unknown type " << c << "\n";
683 std::cerr << "\tVALUE ";
684 trace::dump(value, std::cerr);
692 void Parser::scan_value(void) {
695 case trace::TYPE_NULL:
696 case trace::TYPE_FALSE:
697 case trace::TYPE_TRUE:
699 case trace::TYPE_SINT:
702 case trace::TYPE_UINT:
705 case trace::TYPE_FLOAT:
708 case trace::TYPE_DOUBLE:
711 case trace::TYPE_STRING:
714 case trace::TYPE_ENUM:
717 case trace::TYPE_BITMASK:
720 case trace::TYPE_ARRAY:
723 case trace::TYPE_STRUCT:
726 case trace::TYPE_BLOB:
729 case trace::TYPE_OPAQUE:
732 case trace::TYPE_REPR:
736 std::cerr << "error: unknown type " << c << "\n";
744 Value *Parser::parse_sint() {
745 return new SInt(-(signed long long)read_uint());
749 void Parser::scan_sint() {
754 Value *Parser::parse_uint() {
755 return new UInt(read_uint());
759 void Parser::scan_uint() {
764 Value *Parser::parse_float() {
766 file->read(&value, sizeof value);
767 return new Float(value);
771 void Parser::scan_float() {
772 file->skip(sizeof(float));
776 Value *Parser::parse_double() {
778 file->read(&value, sizeof value);
779 return new Double(value);
783 void Parser::scan_double() {
784 file->skip(sizeof(double));
788 Value *Parser::parse_string() {
789 return new String(read_string());
793 void Parser::scan_string() {
798 Value *Parser::parse_enum() {
800 signed long long value;
802 sig = parse_enum_sig();
805 sig = parse_old_enum_sig();
806 assert(sig->num_values == 1);
807 value = sig->values->value;
809 return new Enum(sig, value);
813 void Parser::scan_enum() {
818 parse_old_enum_sig();
823 Value *Parser::parse_bitmask() {
824 BitmaskSig *sig = parse_bitmask_sig();
826 unsigned long long value = read_uint();
828 return new Bitmask(sig, value);
832 void Parser::scan_bitmask() {
834 skip_uint(); /* value */
838 Value *Parser::parse_array(void) {
839 size_t len = read_uint();
840 Array *array = new Array(len);
841 for (size_t i = 0; i < len; ++i) {
842 array->values[i] = parse_value();
848 void Parser::scan_array(void) {
849 size_t len = read_uint();
850 for (size_t i = 0; i < len; ++i) {
856 Value *Parser::parse_blob(void) {
857 size_t size = read_uint();
858 Blob *blob = new Blob(size);
860 file->read(blob->buf, size);
866 void Parser::scan_blob(void) {
867 size_t size = read_uint();
874 Value *Parser::parse_struct() {
875 StructSig *sig = parse_struct_sig();
876 Struct *value = new Struct(sig);
878 for (size_t i = 0; i < sig->num_members; ++i) {
879 value->members[i] = parse_value();
886 void Parser::scan_struct() {
887 StructSig *sig = parse_struct_sig();
888 for (size_t i = 0; i < sig->num_members; ++i) {
894 Value *Parser::parse_opaque() {
895 unsigned long long addr;
897 return new Pointer(addr);
901 void Parser::scan_opaque() {
906 Value *Parser::parse_repr() {
907 Value *humanValue = parse_value();
908 Value *machineValue = parse_value();
909 return new Repr(humanValue, machineValue);
913 void Parser::scan_repr() {
919 const char * Parser::read_string(void) {
920 size_t len = read_uint();
921 char * value = new char[len + 1];
923 file->read(value, len);
927 std::cerr << "\tSTRING \"" << value << "\"\n";
933 void Parser::skip_string(void) {
934 size_t len = read_uint();
940 * For the time being, a signed int is encoded as any other value, but we here parse
941 * it without the extra baggage of the Value class.
944 Parser::read_sint(void) {
948 case trace::TYPE_SINT:
949 return -(signed long long)read_uint();
950 case trace::TYPE_UINT:
953 std::cerr << "error: unexpected type " << c << "\n";
961 Parser::skip_sint(void) {
966 unsigned long long Parser::read_uint(void) {
967 unsigned long long value = 0;
975 value |= (unsigned long long)(c & 0x7f) << shift;
979 std::cerr << "\tUINT " << value << "\n";
985 void Parser::skip_uint(void) {
996 inline int Parser::read_byte(void) {
997 int c = file->getc();
1000 std::cerr << "\tEOF" << "\n";
1002 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
1008 inline void Parser::skip_byte(void) {
1013 } /* namespace trace */