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_parser.hpp"
36 #define TRACE_VERBOSE 0
57 bool Parser::open(const char *filename) {
59 file = File::createForRead(filename);
64 version = read_uint();
65 if (version > TRACE_VERSION) {
66 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;
133 for (unsigned value = 0; value < sig->num_values; ++value) {
134 delete [] sig->values[value].name;
136 delete [] sig->values;
142 for (BitmaskMap::iterator it = bitmasks.begin(); it != bitmasks.end(); ++it) {
143 BitmaskSigState *sig = *it;
145 for (unsigned flag = 0; flag < sig->num_flags; ++flag) {
146 delete [] sig->flags[flag].name;
148 delete [] sig->flags;
158 void Parser::getBookmark(ParseBookmark &bookmark) {
159 bookmark.offset = file->currentOffset();
160 bookmark.next_call_no = next_call_no;
164 void Parser::setBookmark(const ParseBookmark &bookmark) {
165 file->setCurrentOffset(bookmark.offset);
166 next_call_no = bookmark.next_call_no;
168 // Simply ignore all pending calls
173 Call *Parser::parse_call(Mode mode) {
178 case trace::EVENT_ENTER:
181 case trace::EVENT_LEAVE:
182 call = parse_leave(mode);
183 adjust_call_flags(call);
186 std::cerr << "error: unknown event " << c << "\n";
189 if (!calls.empty()) {
190 call = calls.front();
191 call->flags |= CALL_FLAG_INCOMPLETE;
193 adjust_call_flags(call);
203 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
206 T *lookup(std::vector<T *> &map, size_t index) {
207 if (index >= map.size()) {
208 map.resize(index + 1);
216 Parser::FunctionSigFlags *
217 Parser::parse_function_sig(void) {
218 size_t id = read_uint();
220 FunctionSigState *sig = lookup(functions, id);
223 /* parse the signature */
224 sig = new FunctionSigState;
226 sig->name = read_string();
227 sig->num_args = read_uint();
228 const char **arg_names = new const char *[sig->num_args];
229 for (unsigned i = 0; i < sig->num_args; ++i) {
230 arg_names[i] = read_string();
232 sig->arg_names = arg_names;
233 sig->flags = lookupCallFlags(sig->name);
234 sig->offset = file->currentOffset();
238 * Try to autodetect the API.
240 * XXX: Ideally we would allow to mix multiple APIs in a single trace,
241 * but as it stands today, retrace is done separately for each API.
243 if (api == API_UNKNOWN) {
244 const char *n = sig->name;
245 if ((n[0] == 'g' && n[1] == 'l' && n[2] == 'X') || // glX*
246 (n[0] == 'w' && n[1] == 'g' && n[2] == 'l' && n[3] >= 'A' && n[3] <= 'Z') || // wgl[A-Z]*
247 (n[0] == 'C' && n[1] == 'G' && n[2] == 'L')) { // CGL*
249 } else if (n[0] == 'e' && n[1] == 'g' && n[2] == 'l' && n[3] >= 'A' && n[3] <= 'Z') { // egl[A-Z]*
250 api = trace::API_EGL;
251 } else if (n[0] == 'D' &&
252 ((n[1] == 'i' && n[2] == 'r' && n[3] == 'e' && n[4] == 'c' && n[5] == 't') || // Direct*
253 (n[1] == '3' && n[2] == 'D'))) { // D3D*
261 * Note down the signature of special functions for future reference.
263 * NOTE: If the number of comparisons increases we should move this to a
264 * separate function and use bisection.
266 if (sig->num_args == 0 &&
267 strcmp(sig->name, "glGetError") == 0) {
271 } else if (file->currentOffset() < sig->offset) {
272 /* skip over the signature */
273 skip_string(); /* name */
274 unsigned num_args = read_uint();
275 for (unsigned i = 0; i < num_args; ++i) {
276 skip_string(); /*arg_name*/
285 StructSig *Parser::parse_struct_sig() {
286 size_t id = read_uint();
288 StructSigState *sig = lookup(structs, id);
291 /* parse the signature */
292 sig = new StructSigState;
294 sig->name = read_string();
295 sig->num_members = read_uint();
296 const char **member_names = new const char *[sig->num_members];
297 for (unsigned i = 0; i < sig->num_members; ++i) {
298 member_names[i] = read_string();
300 sig->member_names = member_names;
301 sig->offset = file->currentOffset();
303 } else if (file->currentOffset() < sig->offset) {
304 /* skip over the signature */
305 skip_string(); /* name */
306 unsigned num_members = read_uint();
307 for (unsigned i = 0; i < num_members; ++i) {
308 skip_string(); /* member_name */
318 * Old enum signatures would cover a single name/value only:
320 * enum_sig = id name value
323 EnumSig *Parser::parse_old_enum_sig() {
324 size_t id = read_uint();
326 EnumSigState *sig = lookup(enums, id);
329 /* parse the signature */
330 sig = new EnumSigState;
333 EnumValue *values = new EnumValue[sig->num_values];
334 values->name = read_string();
335 values->value = read_sint();
336 sig->values = values;
337 sig->offset = file->currentOffset();
339 } else if (file->currentOffset() < sig->offset) {
340 /* skip over the signature */
341 skip_string(); /*name*/
350 EnumSig *Parser::parse_enum_sig() {
351 size_t id = read_uint();
353 EnumSigState *sig = lookup(enums, id);
356 /* parse the signature */
357 sig = new EnumSigState;
359 sig->num_values = read_uint();
360 EnumValue *values = new EnumValue[sig->num_values];
361 for (EnumValue *it = values; it != values + sig->num_values; ++it) {
362 it->name = read_string();
363 it->value = read_sint();
365 sig->values = values;
366 sig->offset = file->currentOffset();
368 } else if (file->currentOffset() < sig->offset) {
369 /* skip over the signature */
370 int num_values = read_uint();
371 for (int i = 0; i < num_values; ++i) {
372 skip_string(); /*name */
373 skip_sint(); /* value */
382 BitmaskSig *Parser::parse_bitmask_sig() {
383 size_t id = read_uint();
385 BitmaskSigState *sig = lookup(bitmasks, id);
388 /* parse the signature */
389 sig = new BitmaskSigState;
391 sig->num_flags = read_uint();
392 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
393 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
394 it->name = read_string();
395 it->value = read_uint();
396 if (it->value == 0 && it != flags) {
397 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
401 sig->offset = file->currentOffset();
403 } else if (file->currentOffset() < sig->offset) {
404 /* skip over the signature */
405 int num_flags = read_uint();
406 for (int i = 0; i < num_flags; ++i) {
407 skip_string(); /*name */
408 skip_uint(); /* value */
417 void Parser::parse_enter(Mode mode) {
421 thread_id = read_uint();
426 FunctionSigFlags *sig = parse_function_sig();
428 Call *call = new Call(sig, sig->flags, thread_id);
430 call->no = next_call_no++;
432 if (parse_call_details(call, mode)) {
433 calls.push_back(call);
440 Call *Parser::parse_leave(Mode mode) {
441 unsigned call_no = read_uint();
443 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
444 if ((*it)->no == call_no) {
454 if (parse_call_details(call, mode)) {
463 bool Parser::parse_call_details(Call *call, Mode mode) {
467 case trace::CALL_END:
469 case trace::CALL_ARG:
470 parse_arg(call, mode);
472 case trace::CALL_RET:
473 call->ret = parse_value(mode);
476 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
487 * Make adjustments to this particular call flags.
489 * NOTE: This is called per-call so no string comparisons should be done here.
490 * All name comparisons should be done when the signature is parsed instead.
492 void Parser::adjust_call_flags(Call *call) {
493 // Mark glGetError() = GL_NO_ERROR as verbose
494 if (call->sig == glGetErrorSig &&
496 call->ret->toSInt() == 0) {
497 call->flags |= CALL_FLAG_VERBOSE;
501 void Parser::parse_arg(Call *call, Mode mode) {
502 unsigned index = read_uint();
503 Value *value = parse_value(mode);
505 if (index >= call->args.size()) {
506 call->args.resize(index + 1);
508 call->args[index].value = value;
513 Value *Parser::parse_value(void) {
518 case trace::TYPE_NULL:
521 case trace::TYPE_FALSE:
522 value = new Bool(false);
524 case trace::TYPE_TRUE:
525 value = new Bool(true);
527 case trace::TYPE_SINT:
528 value = parse_sint();
530 case trace::TYPE_UINT:
531 value = parse_uint();
533 case trace::TYPE_FLOAT:
534 value = parse_float();
536 case trace::TYPE_DOUBLE:
537 value = parse_double();
539 case trace::TYPE_STRING:
540 value = parse_string();
542 case trace::TYPE_ENUM:
543 value = parse_enum();
545 case trace::TYPE_BITMASK:
546 value = parse_bitmask();
548 case trace::TYPE_ARRAY:
549 value = parse_array();
551 case trace::TYPE_STRUCT:
552 value = parse_struct();
554 case trace::TYPE_BLOB:
555 value = parse_blob();
557 case trace::TYPE_OPAQUE:
558 value = parse_opaque();
560 case trace::TYPE_REPR:
561 value = parse_repr();
564 std::cerr << "error: unknown type " << c << "\n";
572 std::cerr << "\tVALUE " << value << "\n";
579 void Parser::scan_value(void) {
582 case trace::TYPE_NULL:
583 case trace::TYPE_FALSE:
584 case trace::TYPE_TRUE:
586 case trace::TYPE_SINT:
589 case trace::TYPE_UINT:
592 case trace::TYPE_FLOAT:
595 case trace::TYPE_DOUBLE:
598 case trace::TYPE_STRING:
601 case trace::TYPE_ENUM:
604 case trace::TYPE_BITMASK:
607 case trace::TYPE_ARRAY:
610 case trace::TYPE_STRUCT:
613 case trace::TYPE_BLOB:
616 case trace::TYPE_OPAQUE:
619 case trace::TYPE_REPR:
623 std::cerr << "error: unknown type " << c << "\n";
631 Value *Parser::parse_sint() {
632 return new SInt(-(signed long long)read_uint());
636 void Parser::scan_sint() {
641 Value *Parser::parse_uint() {
642 return new UInt(read_uint());
646 void Parser::scan_uint() {
651 Value *Parser::parse_float() {
653 file->read(&value, sizeof value);
654 return new Float(value);
658 void Parser::scan_float() {
659 file->skip(sizeof(float));
663 Value *Parser::parse_double() {
665 file->read(&value, sizeof value);
666 return new Double(value);
670 void Parser::scan_double() {
671 file->skip(sizeof(double));
675 Value *Parser::parse_string() {
676 return new String(read_string());
680 void Parser::scan_string() {
685 Value *Parser::parse_enum() {
687 signed long long value;
689 sig = parse_enum_sig();
692 sig = parse_old_enum_sig();
693 assert(sig->num_values == 1);
694 value = sig->values->value;
696 return new Enum(sig, value);
700 void Parser::scan_enum() {
705 parse_old_enum_sig();
710 Value *Parser::parse_bitmask() {
711 BitmaskSig *sig = parse_bitmask_sig();
713 unsigned long long value = read_uint();
715 return new Bitmask(sig, value);
719 void Parser::scan_bitmask() {
721 skip_uint(); /* value */
725 Value *Parser::parse_array(void) {
726 size_t len = read_uint();
727 Array *array = new Array(len);
728 for (size_t i = 0; i < len; ++i) {
729 array->values[i] = parse_value();
735 void Parser::scan_array(void) {
736 size_t len = read_uint();
737 for (size_t i = 0; i < len; ++i) {
743 Value *Parser::parse_blob(void) {
744 size_t size = read_uint();
745 Blob *blob = new Blob(size);
747 file->read(blob->buf, size);
753 void Parser::scan_blob(void) {
754 size_t size = read_uint();
761 Value *Parser::parse_struct() {
762 StructSig *sig = parse_struct_sig();
763 Struct *value = new Struct(sig);
765 for (size_t i = 0; i < sig->num_members; ++i) {
766 value->members[i] = parse_value();
773 void Parser::scan_struct() {
774 StructSig *sig = parse_struct_sig();
775 for (size_t i = 0; i < sig->num_members; ++i) {
781 Value *Parser::parse_opaque() {
782 unsigned long long addr;
784 return new Pointer(addr);
788 void Parser::scan_opaque() {
793 Value *Parser::parse_repr() {
794 Value *humanValue = parse_value();
795 Value *machineValue = parse_value();
796 return new Repr(humanValue, machineValue);
800 void Parser::scan_repr() {
806 const char * Parser::read_string(void) {
807 size_t len = read_uint();
808 char * value = new char[len + 1];
810 file->read(value, len);
814 std::cerr << "\tSTRING \"" << value << "\"\n";
820 void Parser::skip_string(void) {
821 size_t len = read_uint();
827 * For the time being, a signed int is encoded as any other value, but we here parse
828 * it without the extra baggage of the Value class.
831 Parser::read_sint(void) {
835 case trace::TYPE_SINT:
836 return -(signed long long)read_uint();
837 case trace::TYPE_UINT:
840 std::cerr << "error: unexpected type " << c << "\n";
848 Parser::skip_sint(void) {
853 unsigned long long Parser::read_uint(void) {
854 unsigned long long value = 0;
862 value |= (unsigned long long)(c & 0x7f) << shift;
866 std::cerr << "\tUINT " << value << "\n";
872 void Parser::skip_uint(void) {
883 inline int Parser::read_byte(void) {
884 int c = file->getc();
887 std::cerr << "\tEOF" << "\n";
889 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
895 inline void Parser::skip_byte(void) {
900 } /* namespace trace */