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] == 'g' && 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
250 api = trace::API_EGL;
257 * Note down the signature of special functions for future reference.
259 * NOTE: If the number of comparisons increases we should move this to a
260 * separate function and use bisection.
262 if (sig->num_args == 0 &&
263 strcmp(sig->name, "glGetError") == 0) {
267 } else if (file->currentOffset() < sig->offset) {
268 /* skip over the signature */
269 skip_string(); /* name */
270 unsigned num_args = read_uint();
271 for (unsigned i = 0; i < num_args; ++i) {
272 skip_string(); /*arg_name*/
281 StructSig *Parser::parse_struct_sig() {
282 size_t id = read_uint();
284 StructSigState *sig = lookup(structs, id);
287 /* parse the signature */
288 sig = new StructSigState;
290 sig->name = read_string();
291 sig->num_members = read_uint();
292 const char **member_names = new const char *[sig->num_members];
293 for (unsigned i = 0; i < sig->num_members; ++i) {
294 member_names[i] = read_string();
296 sig->member_names = member_names;
297 sig->offset = file->currentOffset();
299 } else if (file->currentOffset() < sig->offset) {
300 /* skip over the signature */
301 skip_string(); /* name */
302 unsigned num_members = read_uint();
303 for (unsigned i = 0; i < num_members; ++i) {
304 skip_string(); /* member_name */
314 * Old enum signatures would cover a single name/value only:
316 * enum_sig = id name value
319 EnumSig *Parser::parse_old_enum_sig() {
320 size_t id = read_uint();
322 EnumSigState *sig = lookup(enums, id);
325 /* parse the signature */
326 sig = new EnumSigState;
329 EnumValue *values = new EnumValue[sig->num_values];
330 values->name = read_string();
331 values->value = read_sint();
332 sig->values = values;
333 sig->offset = file->currentOffset();
335 } else if (file->currentOffset() < sig->offset) {
336 /* skip over the signature */
337 skip_string(); /*name*/
346 EnumSig *Parser::parse_enum_sig() {
347 size_t id = read_uint();
349 EnumSigState *sig = lookup(enums, id);
352 /* parse the signature */
353 sig = new EnumSigState;
355 sig->num_values = read_uint();
356 EnumValue *values = new EnumValue[sig->num_values];
357 for (EnumValue *it = values; it != values + sig->num_values; ++it) {
358 it->name = read_string();
359 it->value = read_sint();
361 sig->values = values;
362 sig->offset = file->currentOffset();
364 } else if (file->currentOffset() < sig->offset) {
365 /* skip over the signature */
366 int num_values = read_uint();
367 for (int i = 0; i < num_values; ++i) {
368 skip_string(); /*name */
369 skip_sint(); /* value */
378 BitmaskSig *Parser::parse_bitmask_sig() {
379 size_t id = read_uint();
381 BitmaskSigState *sig = lookup(bitmasks, id);
384 /* parse the signature */
385 sig = new BitmaskSigState;
387 sig->num_flags = read_uint();
388 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
389 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
390 it->name = read_string();
391 it->value = read_uint();
392 if (it->value == 0 && it != flags) {
393 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
397 sig->offset = file->currentOffset();
399 } else if (file->currentOffset() < sig->offset) {
400 /* skip over the signature */
401 int num_flags = read_uint();
402 for (int i = 0; i < num_flags; ++i) {
403 skip_string(); /*name */
404 skip_uint(); /* value */
413 void Parser::parse_enter(Mode mode) {
417 thread_id = read_uint();
422 FunctionSigFlags *sig = parse_function_sig();
424 Call *call = new Call(sig, sig->flags, thread_id);
426 call->no = next_call_no++;
428 if (parse_call_details(call, mode)) {
429 calls.push_back(call);
436 Call *Parser::parse_leave(Mode mode) {
437 unsigned call_no = read_uint();
439 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
440 if ((*it)->no == call_no) {
450 if (parse_call_details(call, mode)) {
459 bool Parser::parse_call_details(Call *call, Mode mode) {
463 case trace::CALL_END:
465 case trace::CALL_ARG:
466 parse_arg(call, mode);
468 case trace::CALL_RET:
469 call->ret = parse_value(mode);
472 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
483 * Make adjustments to this particular call flags.
485 * NOTE: This is called per-call so no string comparisons should be done here.
486 * All name comparisons should be done when the signature is parsed instead.
488 void Parser::adjust_call_flags(Call *call) {
489 // Mark glGetError() = GL_NO_ERROR as verbose
490 if (call->sig == glGetErrorSig &&
492 call->ret->toSInt() == 0) {
493 call->flags |= CALL_FLAG_VERBOSE;
497 void Parser::parse_arg(Call *call, Mode mode) {
498 unsigned index = read_uint();
499 Value *value = parse_value(mode);
501 if (index >= call->args.size()) {
502 call->args.resize(index + 1);
504 call->args[index].value = value;
509 Value *Parser::parse_value(void) {
514 case trace::TYPE_NULL:
517 case trace::TYPE_FALSE:
518 value = new Bool(false);
520 case trace::TYPE_TRUE:
521 value = new Bool(true);
523 case trace::TYPE_SINT:
524 value = parse_sint();
526 case trace::TYPE_UINT:
527 value = parse_uint();
529 case trace::TYPE_FLOAT:
530 value = parse_float();
532 case trace::TYPE_DOUBLE:
533 value = parse_double();
535 case trace::TYPE_STRING:
536 value = parse_string();
538 case trace::TYPE_ENUM:
539 value = parse_enum();
541 case trace::TYPE_BITMASK:
542 value = parse_bitmask();
544 case trace::TYPE_ARRAY:
545 value = parse_array();
547 case trace::TYPE_STRUCT:
548 value = parse_struct();
550 case trace::TYPE_BLOB:
551 value = parse_blob();
553 case trace::TYPE_OPAQUE:
554 value = parse_opaque();
557 std::cerr << "error: unknown type " << c << "\n";
565 std::cerr << "\tVALUE " << value << "\n";
572 void Parser::scan_value(void) {
575 case trace::TYPE_NULL:
576 case trace::TYPE_FALSE:
577 case trace::TYPE_TRUE:
579 case trace::TYPE_SINT:
582 case trace::TYPE_UINT:
585 case trace::TYPE_FLOAT:
588 case trace::TYPE_DOUBLE:
591 case trace::TYPE_STRING:
594 case trace::TYPE_ENUM:
597 case trace::TYPE_BITMASK:
600 case trace::TYPE_ARRAY:
603 case trace::TYPE_STRUCT:
606 case trace::TYPE_BLOB:
609 case trace::TYPE_OPAQUE:
613 std::cerr << "error: unknown type " << c << "\n";
621 Value *Parser::parse_sint() {
622 return new SInt(-(signed long long)read_uint());
626 void Parser::scan_sint() {
631 Value *Parser::parse_uint() {
632 return new UInt(read_uint());
636 void Parser::scan_uint() {
641 Value *Parser::parse_float() {
643 file->read(&value, sizeof value);
644 return new Float(value);
648 void Parser::scan_float() {
649 file->skip(sizeof(float));
653 Value *Parser::parse_double() {
655 file->read(&value, sizeof value);
656 return new Double(value);
660 void Parser::scan_double() {
661 file->skip(sizeof(double));
665 Value *Parser::parse_string() {
666 return new String(read_string());
670 void Parser::scan_string() {
675 Value *Parser::parse_enum() {
677 signed long long value;
679 sig = parse_enum_sig();
682 sig = parse_old_enum_sig();
683 assert(sig->num_values == 1);
684 value = sig->values->value;
686 return new Enum(sig, value);
690 void Parser::scan_enum() {
695 parse_old_enum_sig();
700 Value *Parser::parse_bitmask() {
701 BitmaskSig *sig = parse_bitmask_sig();
703 unsigned long long value = read_uint();
705 return new Bitmask(sig, value);
709 void Parser::scan_bitmask() {
711 skip_uint(); /* value */
715 Value *Parser::parse_array(void) {
716 size_t len = read_uint();
717 Array *array = new Array(len);
718 for (size_t i = 0; i < len; ++i) {
719 array->values[i] = parse_value();
725 void Parser::scan_array(void) {
726 size_t len = read_uint();
727 for (size_t i = 0; i < len; ++i) {
733 Value *Parser::parse_blob(void) {
734 size_t size = read_uint();
735 Blob *blob = new Blob(size);
737 file->read(blob->buf, (unsigned)size);
743 void Parser::scan_blob(void) {
744 size_t size = read_uint();
751 Value *Parser::parse_struct() {
752 StructSig *sig = parse_struct_sig();
753 Struct *value = new Struct(sig);
755 for (size_t i = 0; i < sig->num_members; ++i) {
756 value->members[i] = parse_value();
763 void Parser::scan_struct() {
764 StructSig *sig = parse_struct_sig();
765 for (size_t i = 0; i < sig->num_members; ++i) {
771 Value *Parser::parse_opaque() {
772 unsigned long long addr;
774 return new Pointer(addr);
778 void Parser::scan_opaque() {
783 const char * Parser::read_string(void) {
784 size_t len = read_uint();
785 char * value = new char[len + 1];
787 file->read(value, (unsigned)len);
791 std::cerr << "\tSTRING \"" << value << "\"\n";
797 void Parser::skip_string(void) {
798 size_t len = read_uint();
804 * For the time being, a signed int is encoded as any other value, but we here parse
805 * it without the extra baggage of the Value class.
808 Parser::read_sint(void) {
812 case trace::TYPE_SINT:
814 case trace::TYPE_UINT:
817 std::cerr << "error: unexpected type " << c << "\n";
825 Parser::skip_sint(void) {
830 unsigned long long Parser::read_uint(void) {
831 unsigned long long value = 0;
839 value |= (unsigned long long)(c & 0x7f) << shift;
843 std::cerr << "\tUINT " << value << "\n";
849 void Parser::skip_uint(void) {
860 inline int Parser::read_byte(void) {
861 int c = file->getc();
864 std::cerr << "\tEOF" << "\n";
866 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
872 inline void Parser::skip_byte(void) {
877 } /* namespace trace */