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";
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) {
104 // Delete all signature data. Signatures are mere structures which don't
105 // own their own memory, so we need to destroy all data we created here.
107 for (FunctionMap::iterator it = functions.begin(); it != functions.end(); ++it) {
108 FunctionSigState *sig = *it;
111 for (unsigned arg = 0; arg < sig->num_args; ++arg) {
112 delete [] sig->arg_names[arg];
114 delete [] sig->arg_names;
120 for (StructMap::iterator it = structs.begin(); it != structs.end(); ++it) {
121 StructSigState *sig = *it;
124 for (unsigned member = 0; member < sig->num_members; ++member) {
125 delete [] sig->member_names[member];
127 delete [] sig->member_names;
133 for (EnumMap::iterator it = enums.begin(); it != enums.end(); ++it) {
134 EnumSigState *sig = *it;
136 for (unsigned value = 0; value < sig->num_values; ++value) {
137 delete [] sig->values[value].name;
139 delete [] sig->values;
145 for (BitmaskMap::iterator it = bitmasks.begin(); it != bitmasks.end(); ++it) {
146 BitmaskSigState *sig = *it;
148 for (unsigned flag = 0; flag < sig->num_flags; ++flag) {
149 delete [] sig->flags[flag].name;
151 delete [] sig->flags;
161 void Parser::getBookmark(ParseBookmark &bookmark) {
162 bookmark.offset = file->currentOffset();
163 bookmark.next_call_no = next_call_no;
167 void Parser::setBookmark(const ParseBookmark &bookmark) {
168 file->setCurrentOffset(bookmark.offset);
169 next_call_no = bookmark.next_call_no;
171 // Simply ignore all pending calls
176 Call *Parser::parse_call(Mode mode) {
181 case trace::EVENT_ENTER:
183 std::cerr << "\tENTER\n";
187 case trace::EVENT_LEAVE:
189 std::cerr << "\tLEAVE\n";
191 call = parse_leave(mode);
193 adjust_call_flags(call);
198 std::cerr << "error: unknown event " << c << "\n";
201 if (!calls.empty()) {
202 call = calls.front();
203 call->flags |= CALL_FLAG_INCOMPLETE;
205 adjust_call_flags(call);
215 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
218 T *lookup(std::vector<T *> &map, size_t index) {
219 if (index >= map.size()) {
220 map.resize(index + 1);
228 Parser::FunctionSigFlags *
229 Parser::parse_function_sig(void) {
230 size_t id = read_uint();
232 FunctionSigState *sig = lookup(functions, id);
235 /* parse the signature */
236 sig = new FunctionSigState;
238 sig->name = read_string();
239 sig->num_args = read_uint();
240 const char **arg_names = new const char *[sig->num_args];
241 for (unsigned i = 0; i < sig->num_args; ++i) {
242 arg_names[i] = read_string();
244 sig->arg_names = arg_names;
245 sig->flags = lookupCallFlags(sig->name);
246 sig->fileOffset = file->currentOffset();
250 * Try to autodetect the API.
252 * XXX: Ideally we would allow to mix multiple APIs in a single trace,
253 * but as it stands today, retrace is done separately for each API.
255 if (api == API_UNKNOWN) {
256 const char *n = sig->name;
257 if ((n[0] == 'g' && n[1] == 'l' && n[2] == 'X') || // glX*
258 (n[0] == 'w' && n[1] == 'g' && n[2] == 'l' && n[3] >= 'A' && n[3] <= 'Z') || // wgl[A-Z]*
259 (n[0] == 'C' && n[1] == 'G' && n[2] == 'L')) { // CGL*
261 } else if (n[0] == 'e' && n[1] == 'g' && n[2] == 'l' && n[3] >= 'A' && n[3] <= 'Z') { // egl[A-Z]*
262 api = trace::API_EGL;
263 } else if ((n[0] == 'D' &&
264 ((n[1] == 'i' && n[2] == 'r' && n[3] == 'e' && n[4] == 'c' && n[5] == 't') || // Direct*
265 (n[1] == '3' && n[2] == 'D'))) || // D3D*
266 (n[0] == 'C' && n[1] == 'r' && n[2] == 'e' && n[3] == 'a' && n[4] == 't' && n[5] == 'e')) { // Create*
274 * Note down the signature of special functions for future reference.
276 * NOTE: If the number of comparisons increases we should move this to a
277 * separate function and use bisection.
279 if (sig->num_args == 0 &&
280 strcmp(sig->name, "glGetError") == 0) {
284 } else if (file->currentOffset() < sig->fileOffset) {
285 /* skip over the signature */
286 skip_string(); /* name */
287 unsigned num_args = read_uint();
288 for (unsigned i = 0; i < num_args; ++i) {
289 skip_string(); /*arg_name*/
298 StructSig *Parser::parse_struct_sig() {
299 size_t id = read_uint();
301 StructSigState *sig = lookup(structs, id);
304 /* parse the signature */
305 sig = new StructSigState;
307 sig->name = read_string();
308 sig->num_members = read_uint();
309 const char **member_names = new const char *[sig->num_members];
310 for (unsigned i = 0; i < sig->num_members; ++i) {
311 member_names[i] = read_string();
313 sig->member_names = member_names;
314 sig->fileOffset = file->currentOffset();
316 } else if (file->currentOffset() < sig->fileOffset) {
317 /* skip over the signature */
318 skip_string(); /* name */
319 unsigned num_members = read_uint();
320 for (unsigned i = 0; i < num_members; ++i) {
321 skip_string(); /* member_name */
331 * Old enum signatures would cover a single name/value only:
333 * enum_sig = id name value
336 EnumSig *Parser::parse_old_enum_sig() {
337 size_t id = read_uint();
339 EnumSigState *sig = lookup(enums, id);
342 /* parse the signature */
343 sig = new EnumSigState;
346 EnumValue *values = new EnumValue[sig->num_values];
347 values->name = read_string();
348 values->value = read_sint();
349 sig->values = values;
350 sig->fileOffset = file->currentOffset();
352 } else if (file->currentOffset() < sig->fileOffset) {
353 /* skip over the signature */
354 skip_string(); /*name*/
363 EnumSig *Parser::parse_enum_sig() {
364 size_t id = read_uint();
366 EnumSigState *sig = lookup(enums, id);
369 /* parse the signature */
370 sig = new EnumSigState;
372 sig->num_values = read_uint();
373 EnumValue *values = new EnumValue[sig->num_values];
374 for (EnumValue *it = values; it != values + sig->num_values; ++it) {
375 it->name = read_string();
376 it->value = read_sint();
378 sig->values = values;
379 sig->fileOffset = file->currentOffset();
381 } else if (file->currentOffset() < sig->fileOffset) {
382 /* skip over the signature */
383 int num_values = read_uint();
384 for (int i = 0; i < num_values; ++i) {
385 skip_string(); /*name */
386 skip_sint(); /* value */
395 BitmaskSig *Parser::parse_bitmask_sig() {
396 size_t id = read_uint();
398 BitmaskSigState *sig = lookup(bitmasks, id);
401 /* parse the signature */
402 sig = new BitmaskSigState;
404 sig->num_flags = read_uint();
405 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
406 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
407 it->name = read_string();
408 it->value = read_uint();
409 if (it->value == 0 && it != flags) {
410 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
414 sig->fileOffset = file->currentOffset();
416 } else if (file->currentOffset() < sig->fileOffset) {
417 /* skip over the signature */
418 int num_flags = read_uint();
419 for (int i = 0; i < num_flags; ++i) {
420 skip_string(); /*name */
421 skip_uint(); /* value */
430 void Parser::parse_enter(Mode mode) {
434 thread_id = read_uint();
439 FunctionSigFlags *sig = parse_function_sig();
441 Call *call = new Call(sig, sig->flags, thread_id);
443 call->no = next_call_no++;
445 if (parse_call_details(call, mode)) {
446 calls.push_back(call);
453 Call *Parser::parse_leave(Mode mode) {
454 unsigned call_no = read_uint();
456 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
457 if ((*it)->no == call_no) {
464 /* This might happen on random access, when an asynchronous call is stranded
465 * between two frames. We won't return this call, but we still need to skip
468 const FunctionSig sig = {0, NULL, 0, NULL};
469 call = new Call(&sig, 0, 0);
470 parse_call_details(call, SCAN);
475 if (parse_call_details(call, mode)) {
484 bool Parser::parse_call_details(Call *call, Mode mode) {
488 case trace::CALL_END:
490 std::cerr << "\tCALL_END\n";
493 case trace::CALL_ARG:
495 std::cerr << "\tCALL_ARG\n";
497 parse_arg(call, mode);
499 case trace::CALL_RET:
501 std::cerr << "\tCALL_RET\n";
503 call->ret = parse_value(mode);
505 case trace::CALL_BACKTRACE:
507 std::cerr << "\tCALL_BACKTRACE\n";
509 parse_call_backtrace(call, mode);
512 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
521 bool Parser::parse_call_backtrace(Call *call, Mode mode) {
522 unsigned num_frames = read_uint();
523 Backtrace* backtrace = new Backtrace(num_frames);
524 for (unsigned i = 0; i < num_frames; ++i) {
525 (*backtrace)[i] = parse_backtrace_frame(mode);
527 call->backtrace = backtrace;
531 StackFrame * Parser::parse_backtrace_frame(Mode mode) {
532 size_t id = read_uint();
534 StackFrameState *frame = lookup(frames, id);
537 frame = new StackFrameState;
539 while (c != trace::BACKTRACE_END &&
542 case trace::BACKTRACE_MODULE:
543 frame->module = read_string();
545 case trace::BACKTRACE_FUNCTION:
546 frame->function = read_string();
548 case trace::BACKTRACE_FILENAME:
549 frame->filename = read_string();
551 case trace::BACKTRACE_LINENUMBER:
552 frame->linenumber = read_uint();
554 case trace::BACKTRACE_OFFSET:
555 frame->offset = read_uint();
558 std::cerr << "error: unknown backtrace detail "
565 frame->fileOffset = file->currentOffset();
567 } else if (file->currentOffset() < frame->fileOffset) {
569 while (c != trace::BACKTRACE_END &&
572 case trace::BACKTRACE_MODULE:
575 case trace::BACKTRACE_FUNCTION:
578 case trace::BACKTRACE_FILENAME:
581 case trace::BACKTRACE_LINENUMBER:
584 case trace::BACKTRACE_OFFSET:
588 std::cerr << "error: unknown backtrace detail "
600 * Make adjustments to this particular call flags.
602 * NOTE: This is called per-call so no string comparisons should be done here.
603 * All name comparisons should be done when the signature is parsed instead.
605 void Parser::adjust_call_flags(Call *call) {
606 // Mark glGetError() = GL_NO_ERROR as verbose
607 if (call->sig == glGetErrorSig &&
609 call->ret->toSInt() == 0) {
610 call->flags |= CALL_FLAG_VERBOSE;
614 void Parser::parse_arg(Call *call, Mode mode) {
615 unsigned index = read_uint();
616 Value *value = parse_value(mode);
618 if (index >= call->args.size()) {
619 call->args.resize(index + 1);
621 call->args[index].value = value;
626 Value *Parser::parse_value(void) {
631 case trace::TYPE_NULL:
634 case trace::TYPE_FALSE:
635 value = new Bool(false);
637 case trace::TYPE_TRUE:
638 value = new Bool(true);
640 case trace::TYPE_SINT:
641 value = parse_sint();
643 case trace::TYPE_UINT:
644 value = parse_uint();
646 case trace::TYPE_FLOAT:
647 value = parse_float();
649 case trace::TYPE_DOUBLE:
650 value = parse_double();
652 case trace::TYPE_STRING:
653 value = parse_string();
655 case trace::TYPE_ENUM:
656 value = parse_enum();
658 case trace::TYPE_BITMASK:
659 value = parse_bitmask();
661 case trace::TYPE_ARRAY:
662 value = parse_array();
664 case trace::TYPE_STRUCT:
665 value = parse_struct();
667 case trace::TYPE_BLOB:
668 value = parse_blob();
670 case trace::TYPE_OPAQUE:
671 value = parse_opaque();
673 case trace::TYPE_REPR:
674 value = parse_repr();
677 std::cerr << "error: unknown type " << c << "\n";
685 std::cerr << "\tVALUE ";
686 trace::dump(value, std::cerr);
694 void Parser::scan_value(void) {
697 case trace::TYPE_NULL:
698 case trace::TYPE_FALSE:
699 case trace::TYPE_TRUE:
701 case trace::TYPE_SINT:
704 case trace::TYPE_UINT:
707 case trace::TYPE_FLOAT:
710 case trace::TYPE_DOUBLE:
713 case trace::TYPE_STRING:
716 case trace::TYPE_ENUM:
719 case trace::TYPE_BITMASK:
722 case trace::TYPE_ARRAY:
725 case trace::TYPE_STRUCT:
728 case trace::TYPE_BLOB:
731 case trace::TYPE_OPAQUE:
734 case trace::TYPE_REPR:
738 std::cerr << "error: unknown type " << c << "\n";
746 Value *Parser::parse_sint() {
747 return new SInt(-(signed long long)read_uint());
751 void Parser::scan_sint() {
756 Value *Parser::parse_uint() {
757 return new UInt(read_uint());
761 void Parser::scan_uint() {
766 Value *Parser::parse_float() {
768 file->read(&value, sizeof value);
769 return new Float(value);
773 void Parser::scan_float() {
774 file->skip(sizeof(float));
778 Value *Parser::parse_double() {
780 file->read(&value, sizeof value);
781 return new Double(value);
785 void Parser::scan_double() {
786 file->skip(sizeof(double));
790 Value *Parser::parse_string() {
791 return new String(read_string());
795 void Parser::scan_string() {
800 Value *Parser::parse_enum() {
802 signed long long value;
804 sig = parse_enum_sig();
807 sig = parse_old_enum_sig();
808 assert(sig->num_values == 1);
809 value = sig->values->value;
811 return new Enum(sig, value);
815 void Parser::scan_enum() {
820 parse_old_enum_sig();
825 Value *Parser::parse_bitmask() {
826 BitmaskSig *sig = parse_bitmask_sig();
828 unsigned long long value = read_uint();
830 return new Bitmask(sig, value);
834 void Parser::scan_bitmask() {
836 skip_uint(); /* value */
840 Value *Parser::parse_array(void) {
841 size_t len = read_uint();
842 Array *array = new Array(len);
843 for (size_t i = 0; i < len; ++i) {
844 array->values[i] = parse_value();
850 void Parser::scan_array(void) {
851 size_t len = read_uint();
852 for (size_t i = 0; i < len; ++i) {
858 Value *Parser::parse_blob(void) {
859 size_t size = read_uint();
860 Blob *blob = new Blob(size);
862 file->read(blob->buf, size);
868 void Parser::scan_blob(void) {
869 size_t size = read_uint();
876 Value *Parser::parse_struct() {
877 StructSig *sig = parse_struct_sig();
878 Struct *value = new Struct(sig);
880 for (size_t i = 0; i < sig->num_members; ++i) {
881 value->members[i] = parse_value();
888 void Parser::scan_struct() {
889 StructSig *sig = parse_struct_sig();
890 for (size_t i = 0; i < sig->num_members; ++i) {
896 Value *Parser::parse_opaque() {
897 unsigned long long addr;
899 return new Pointer(addr);
903 void Parser::scan_opaque() {
908 Value *Parser::parse_repr() {
909 Value *humanValue = parse_value();
910 Value *machineValue = parse_value();
911 return new Repr(humanValue, machineValue);
915 void Parser::scan_repr() {
921 const char * Parser::read_string(void) {
922 size_t len = read_uint();
923 char * value = new char[len + 1];
925 file->read(value, len);
929 std::cerr << "\tSTRING \"" << value << "\"\n";
935 void Parser::skip_string(void) {
936 size_t len = read_uint();
942 * For the time being, a signed int is encoded as any other value, but we here parse
943 * it without the extra baggage of the Value class.
946 Parser::read_sint(void) {
950 case trace::TYPE_SINT:
951 return -(signed long long)read_uint();
952 case trace::TYPE_UINT:
955 std::cerr << "error: unexpected type " << c << "\n";
963 Parser::skip_sint(void) {
968 unsigned long long Parser::read_uint(void) {
969 unsigned long long value = 0;
977 value |= (unsigned long long)(c & 0x7f) << shift;
981 std::cerr << "\tUINT " << value << "\n";
987 void Parser::skip_uint(void) {
998 inline int Parser::read_byte(void) {
999 int c = file->getc();
1002 std::cerr << "\tEOF" << "\n";
1004 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
1010 inline void Parser::skip_byte(void) {
1015 } /* namespace trace */