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);
190 adjust_call_flags(call);
193 std::cerr << "error: unknown event " << c << "\n";
196 if (!calls.empty()) {
197 call = calls.front();
198 call->flags |= CALL_FLAG_INCOMPLETE;
200 adjust_call_flags(call);
210 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
213 T *lookup(std::vector<T *> &map, size_t index) {
214 if (index >= map.size()) {
215 map.resize(index + 1);
223 Parser::FunctionSigFlags *
224 Parser::parse_function_sig(void) {
225 size_t id = read_uint();
227 FunctionSigState *sig = lookup(functions, id);
230 /* parse the signature */
231 sig = new FunctionSigState;
233 sig->name = read_string();
234 sig->num_args = read_uint();
235 const char **arg_names = new const char *[sig->num_args];
236 for (unsigned i = 0; i < sig->num_args; ++i) {
237 arg_names[i] = read_string();
239 sig->arg_names = arg_names;
240 sig->flags = lookupCallFlags(sig->name);
241 sig->offset = file->currentOffset();
245 * Try to autodetect the API.
247 * XXX: Ideally we would allow to mix multiple APIs in a single trace,
248 * but as it stands today, retrace is done separately for each API.
250 if (api == API_UNKNOWN) {
251 const char *n = sig->name;
252 if ((n[0] == 'g' && n[1] == 'l' && n[2] == 'X') || // glX*
253 (n[0] == 'w' && n[1] == 'g' && n[2] == 'l' && n[3] >= 'A' && n[3] <= 'Z') || // wgl[A-Z]*
254 (n[0] == 'C' && n[1] == 'G' && n[2] == 'L')) { // CGL*
256 } else if (n[0] == 'e' && n[1] == 'g' && n[2] == 'l' && n[3] >= 'A' && n[3] <= 'Z') { // egl[A-Z]*
257 api = trace::API_EGL;
258 } else if ((n[0] == 'D' &&
259 ((n[1] == 'i' && n[2] == 'r' && n[3] == 'e' && n[4] == 'c' && n[5] == 't') || // Direct*
260 (n[1] == '3' && n[2] == 'D'))) || // D3D*
261 (n[0] == 'C' && n[1] == 'r' && n[2] == 'e' && n[3] == 'a' && n[4] == 't' && n[5] == 'e')) { // Create*
269 * Note down the signature of special functions for future reference.
271 * NOTE: If the number of comparisons increases we should move this to a
272 * separate function and use bisection.
274 if (sig->num_args == 0 &&
275 strcmp(sig->name, "glGetError") == 0) {
279 } else if (file->currentOffset() < sig->offset) {
280 /* skip over the signature */
281 skip_string(); /* name */
282 unsigned num_args = read_uint();
283 for (unsigned i = 0; i < num_args; ++i) {
284 skip_string(); /*arg_name*/
293 StructSig *Parser::parse_struct_sig() {
294 size_t id = read_uint();
296 StructSigState *sig = lookup(structs, id);
299 /* parse the signature */
300 sig = new StructSigState;
302 sig->name = read_string();
303 sig->num_members = read_uint();
304 const char **member_names = new const char *[sig->num_members];
305 for (unsigned i = 0; i < sig->num_members; ++i) {
306 member_names[i] = read_string();
308 sig->member_names = member_names;
309 sig->offset = file->currentOffset();
311 } else if (file->currentOffset() < sig->offset) {
312 /* skip over the signature */
313 skip_string(); /* name */
314 unsigned num_members = read_uint();
315 for (unsigned i = 0; i < num_members; ++i) {
316 skip_string(); /* member_name */
326 * Old enum signatures would cover a single name/value only:
328 * enum_sig = id name value
331 EnumSig *Parser::parse_old_enum_sig() {
332 size_t id = read_uint();
334 EnumSigState *sig = lookup(enums, id);
337 /* parse the signature */
338 sig = new EnumSigState;
341 EnumValue *values = new EnumValue[sig->num_values];
342 values->name = read_string();
343 values->value = read_sint();
344 sig->values = values;
345 sig->offset = file->currentOffset();
347 } else if (file->currentOffset() < sig->offset) {
348 /* skip over the signature */
349 skip_string(); /*name*/
358 EnumSig *Parser::parse_enum_sig() {
359 size_t id = read_uint();
361 EnumSigState *sig = lookup(enums, id);
364 /* parse the signature */
365 sig = new EnumSigState;
367 sig->num_values = read_uint();
368 EnumValue *values = new EnumValue[sig->num_values];
369 for (EnumValue *it = values; it != values + sig->num_values; ++it) {
370 it->name = read_string();
371 it->value = read_sint();
373 sig->values = values;
374 sig->offset = file->currentOffset();
376 } else if (file->currentOffset() < sig->offset) {
377 /* skip over the signature */
378 int num_values = read_uint();
379 for (int i = 0; i < num_values; ++i) {
380 skip_string(); /*name */
381 skip_sint(); /* value */
390 BitmaskSig *Parser::parse_bitmask_sig() {
391 size_t id = read_uint();
393 BitmaskSigState *sig = lookup(bitmasks, id);
396 /* parse the signature */
397 sig = new BitmaskSigState;
399 sig->num_flags = read_uint();
400 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
401 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
402 it->name = read_string();
403 it->value = read_uint();
404 if (it->value == 0 && it != flags) {
405 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
409 sig->offset = file->currentOffset();
411 } else if (file->currentOffset() < sig->offset) {
412 /* skip over the signature */
413 int num_flags = read_uint();
414 for (int i = 0; i < num_flags; ++i) {
415 skip_string(); /*name */
416 skip_uint(); /* value */
425 void Parser::parse_enter(Mode mode) {
429 thread_id = read_uint();
434 FunctionSigFlags *sig = parse_function_sig();
436 Call *call = new Call(sig, sig->flags, thread_id);
438 call->no = next_call_no++;
440 if (parse_call_details(call, mode)) {
441 calls.push_back(call);
448 Call *Parser::parse_leave(Mode mode) {
449 unsigned call_no = read_uint();
451 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
452 if ((*it)->no == call_no) {
462 if (parse_call_details(call, mode)) {
471 bool Parser::parse_call_details(Call *call, Mode mode) {
475 case trace::CALL_END:
477 std::cerr << "\tCALL_END\n";
480 case trace::CALL_ARG:
482 std::cerr << "\tCALL_ARG\n";
484 parse_arg(call, mode);
486 case trace::CALL_RET:
488 std::cerr << "\tCALL_RET\n";
490 call->ret = parse_value(mode);
493 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
504 * Make adjustments to this particular call flags.
506 * NOTE: This is called per-call so no string comparisons should be done here.
507 * All name comparisons should be done when the signature is parsed instead.
509 void Parser::adjust_call_flags(Call *call) {
510 // Mark glGetError() = GL_NO_ERROR as verbose
511 if (call->sig == glGetErrorSig &&
513 call->ret->toSInt() == 0) {
514 call->flags |= CALL_FLAG_VERBOSE;
518 void Parser::parse_arg(Call *call, Mode mode) {
519 unsigned index = read_uint();
520 Value *value = parse_value(mode);
522 if (index >= call->args.size()) {
523 call->args.resize(index + 1);
525 call->args[index].value = value;
530 Value *Parser::parse_value(void) {
535 case trace::TYPE_NULL:
538 case trace::TYPE_FALSE:
539 value = new Bool(false);
541 case trace::TYPE_TRUE:
542 value = new Bool(true);
544 case trace::TYPE_SINT:
545 value = parse_sint();
547 case trace::TYPE_UINT:
548 value = parse_uint();
550 case trace::TYPE_FLOAT:
551 value = parse_float();
553 case trace::TYPE_DOUBLE:
554 value = parse_double();
556 case trace::TYPE_STRING:
557 value = parse_string();
559 case trace::TYPE_ENUM:
560 value = parse_enum();
562 case trace::TYPE_BITMASK:
563 value = parse_bitmask();
565 case trace::TYPE_ARRAY:
566 value = parse_array();
568 case trace::TYPE_STRUCT:
569 value = parse_struct();
571 case trace::TYPE_BLOB:
572 value = parse_blob();
574 case trace::TYPE_OPAQUE:
575 value = parse_opaque();
577 case trace::TYPE_REPR:
578 value = parse_repr();
581 std::cerr << "error: unknown type " << c << "\n";
589 std::cerr << "\tVALUE ";
590 trace::dump(value, std::cerr);
598 void Parser::scan_value(void) {
601 case trace::TYPE_NULL:
602 case trace::TYPE_FALSE:
603 case trace::TYPE_TRUE:
605 case trace::TYPE_SINT:
608 case trace::TYPE_UINT:
611 case trace::TYPE_FLOAT:
614 case trace::TYPE_DOUBLE:
617 case trace::TYPE_STRING:
620 case trace::TYPE_ENUM:
623 case trace::TYPE_BITMASK:
626 case trace::TYPE_ARRAY:
629 case trace::TYPE_STRUCT:
632 case trace::TYPE_BLOB:
635 case trace::TYPE_OPAQUE:
638 case trace::TYPE_REPR:
642 std::cerr << "error: unknown type " << c << "\n";
650 Value *Parser::parse_sint() {
651 return new SInt(-(signed long long)read_uint());
655 void Parser::scan_sint() {
660 Value *Parser::parse_uint() {
661 return new UInt(read_uint());
665 void Parser::scan_uint() {
670 Value *Parser::parse_float() {
672 file->read(&value, sizeof value);
673 return new Float(value);
677 void Parser::scan_float() {
678 file->skip(sizeof(float));
682 Value *Parser::parse_double() {
684 file->read(&value, sizeof value);
685 return new Double(value);
689 void Parser::scan_double() {
690 file->skip(sizeof(double));
694 Value *Parser::parse_string() {
695 return new String(read_string());
699 void Parser::scan_string() {
704 Value *Parser::parse_enum() {
706 signed long long value;
708 sig = parse_enum_sig();
711 sig = parse_old_enum_sig();
712 assert(sig->num_values == 1);
713 value = sig->values->value;
715 return new Enum(sig, value);
719 void Parser::scan_enum() {
724 parse_old_enum_sig();
729 Value *Parser::parse_bitmask() {
730 BitmaskSig *sig = parse_bitmask_sig();
732 unsigned long long value = read_uint();
734 return new Bitmask(sig, value);
738 void Parser::scan_bitmask() {
740 skip_uint(); /* value */
744 Value *Parser::parse_array(void) {
745 size_t len = read_uint();
746 Array *array = new Array(len);
747 for (size_t i = 0; i < len; ++i) {
748 array->values[i] = parse_value();
754 void Parser::scan_array(void) {
755 size_t len = read_uint();
756 for (size_t i = 0; i < len; ++i) {
762 Value *Parser::parse_blob(void) {
763 size_t size = read_uint();
764 Blob *blob = new Blob(size);
766 file->read(blob->buf, size);
772 void Parser::scan_blob(void) {
773 size_t size = read_uint();
780 Value *Parser::parse_struct() {
781 StructSig *sig = parse_struct_sig();
782 Struct *value = new Struct(sig);
784 for (size_t i = 0; i < sig->num_members; ++i) {
785 value->members[i] = parse_value();
792 void Parser::scan_struct() {
793 StructSig *sig = parse_struct_sig();
794 for (size_t i = 0; i < sig->num_members; ++i) {
800 Value *Parser::parse_opaque() {
801 unsigned long long addr;
803 return new Pointer(addr);
807 void Parser::scan_opaque() {
812 Value *Parser::parse_repr() {
813 Value *humanValue = parse_value();
814 Value *machineValue = parse_value();
815 return new Repr(humanValue, machineValue);
819 void Parser::scan_repr() {
825 const char * Parser::read_string(void) {
826 size_t len = read_uint();
827 char * value = new char[len + 1];
829 file->read(value, len);
833 std::cerr << "\tSTRING \"" << value << "\"\n";
839 void Parser::skip_string(void) {
840 size_t len = read_uint();
846 * For the time being, a signed int is encoded as any other value, but we here parse
847 * it without the extra baggage of the Value class.
850 Parser::read_sint(void) {
854 case trace::TYPE_SINT:
855 return -(signed long long)read_uint();
856 case trace::TYPE_UINT:
859 std::cerr << "error: unexpected type " << c << "\n";
867 Parser::skip_sint(void) {
872 unsigned long long Parser::read_uint(void) {
873 unsigned long long value = 0;
881 value |= (unsigned long long)(c & 0x7f) << shift;
885 std::cerr << "\tUINT " << value << "\n";
891 void Parser::skip_uint(void) {
902 inline int Parser::read_byte(void) {
903 int c = file->getc();
906 std::cerr << "\tEOF" << "\n";
908 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
914 inline void Parser::skip_byte(void) {
919 } /* namespace trace */