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
56 bool Parser::open(const char *filename) {
58 file = File::createForRead(filename);
63 version = read_uint();
64 if (version > TRACE_VERSION) {
65 std::cerr << "error: unsupported trace format version " << version << "\n";
72 template <typename Iter>
74 deleteAll(Iter begin, Iter end)
76 while (begin != end) {
82 template <typename Container>
84 deleteAll(Container &c)
86 deleteAll(c.begin(), c.end());
90 void Parser::close(void) {
99 // Delete all signature data. Signatures are mere structures which don't
100 // own their own memory, so we need to destroy all data we created here.
102 for (FunctionMap::iterator it = functions.begin(); it != functions.end(); ++it) {
103 FunctionSigState *sig = *it;
106 for (unsigned arg = 0; arg < sig->num_args; ++arg) {
107 delete [] sig->arg_names[arg];
109 delete [] sig->arg_names;
115 for (StructMap::iterator it = structs.begin(); it != structs.end(); ++it) {
116 StructSigState *sig = *it;
119 for (unsigned member = 0; member < sig->num_members; ++member) {
120 delete [] sig->member_names[member];
122 delete [] sig->member_names;
128 for (EnumMap::iterator it = enums.begin(); it != enums.end(); ++it) {
129 EnumSigState *sig = *it;
137 for (BitmaskMap::iterator it = bitmasks.begin(); it != bitmasks.end(); ++it) {
138 BitmaskSigState *sig = *it;
140 for (unsigned flag = 0; flag < sig->num_flags; ++flag) {
141 delete [] sig->flags[flag].name;
143 delete [] sig->flags;
153 void Parser::getBookmark(ParseBookmark &bookmark) {
154 bookmark.offset = file->currentOffset();
155 bookmark.next_call_no = next_call_no;
159 void Parser::setBookmark(const ParseBookmark &bookmark) {
160 file->setCurrentOffset(bookmark.offset);
161 next_call_no = bookmark.next_call_no;
163 // Simply ignore all pending calls
168 Call *Parser::parse_call(Mode mode) {
173 case trace::EVENT_ENTER:
176 case trace::EVENT_LEAVE:
177 call = parse_leave(mode);
178 adjust_call_flags(call);
181 std::cerr << "error: unknown event " << c << "\n";
184 if (!calls.empty()) {
185 call = calls.front();
186 call->flags |= CALL_FLAG_INCOMPLETE;
188 adjust_call_flags(call);
198 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
201 T *lookup(std::vector<T *> &map, size_t index) {
202 if (index >= map.size()) {
203 map.resize(index + 1);
211 Parser::FunctionSigFlags *
212 Parser::parse_function_sig(void) {
213 size_t id = read_uint();
215 FunctionSigState *sig = lookup(functions, id);
218 /* parse the signature */
219 sig = new FunctionSigState;
221 sig->name = read_string();
222 sig->num_args = read_uint();
223 const char **arg_names = new const char *[sig->num_args];
224 for (unsigned i = 0; i < sig->num_args; ++i) {
225 arg_names[i] = read_string();
227 sig->arg_names = arg_names;
228 sig->flags = lookupCallFlags(sig->name);
229 sig->offset = file->currentOffset();
233 * Note down the signature of special functions for future reference.
235 * NOTE: If the number of comparisons increases we should move this to a
236 * separate function and use bisection.
238 if (sig->num_args == 0 &&
239 strcmp(sig->name, "glGetError") == 0) {
243 } else if (file->currentOffset() < sig->offset) {
244 /* skip over the signature */
245 skip_string(); /* name */
246 unsigned num_args = read_uint();
247 for (unsigned i = 0; i < num_args; ++i) {
248 skip_string(); /*arg_name*/
257 StructSig *Parser::parse_struct_sig() {
258 size_t id = read_uint();
260 StructSigState *sig = lookup(structs, id);
263 /* parse the signature */
264 sig = new StructSigState;
266 sig->name = read_string();
267 sig->num_members = read_uint();
268 const char **member_names = new const char *[sig->num_members];
269 for (unsigned i = 0; i < sig->num_members; ++i) {
270 member_names[i] = read_string();
272 sig->member_names = member_names;
273 sig->offset = file->currentOffset();
275 } else if (file->currentOffset() < sig->offset) {
276 /* skip over the signature */
277 skip_string(); /* name */
278 unsigned num_members = read_uint();
279 for (unsigned i = 0; i < num_members; ++i) {
280 skip_string(); /* member_name */
289 EnumSig *Parser::parse_enum_sig() {
290 size_t id = read_uint();
292 EnumSigState *sig = lookup(enums, id);
295 /* parse the signature */
296 sig = new EnumSigState;
298 sig->name = read_string();
299 Value *value = parse_value();
300 sig->value = value->toSInt();
302 sig->offset = file->currentOffset();
304 } else if (file->currentOffset() < sig->offset) {
305 /* skip over the signature */
306 skip_string(); /*name*/
315 BitmaskSig *Parser::parse_bitmask_sig() {
316 size_t id = read_uint();
318 BitmaskSigState *sig = lookup(bitmasks, id);
321 /* parse the signature */
322 sig = new BitmaskSigState;
324 sig->num_flags = read_uint();
325 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
326 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
327 it->name = read_string();
328 it->value = read_uint();
329 if (it->value == 0 && it != flags) {
330 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
334 sig->offset = file->currentOffset();
336 } else if (file->currentOffset() < sig->offset) {
337 /* skip over the signature */
338 int num_flags = read_uint();
339 for (int i = 0; i < num_flags; ++i) {
340 skip_string(); /*name */
341 skip_uint(); /* value */
350 void Parser::parse_enter(Mode mode) {
351 FunctionSigFlags *sig = parse_function_sig();
353 Call *call = new Call(sig, sig->flags);
355 call->no = next_call_no++;
357 if (parse_call_details(call, mode)) {
358 calls.push_back(call);
365 Call *Parser::parse_leave(Mode mode) {
366 unsigned call_no = read_uint();
368 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
369 if ((*it)->no == call_no) {
379 if (parse_call_details(call, mode)) {
388 bool Parser::parse_call_details(Call *call, Mode mode) {
392 case trace::CALL_END:
394 case trace::CALL_ARG:
395 parse_arg(call, mode);
397 case trace::CALL_RET:
398 call->ret = parse_value(mode);
401 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
412 * Make adjustments to this particular call flags.
414 * NOTE: This is called per-call so no string comparisons should be done here.
415 * All name comparisons should be done when the signature is parsed instead.
417 void Parser::adjust_call_flags(Call *call) {
418 // Mark glGetError() = GL_NO_ERROR as verbose
419 if (call->sig == glGetErrorSig &&
421 call->ret->toSInt() == 0) {
422 call->flags |= CALL_FLAG_VERBOSE;
426 void Parser::parse_arg(Call *call, Mode mode) {
427 unsigned index = read_uint();
428 Value *value = parse_value(mode);
430 if (index >= call->args.size()) {
431 call->args.resize(index + 1);
433 call->args[index] = value;
438 Value *Parser::parse_value(void) {
443 case trace::TYPE_NULL:
446 case trace::TYPE_FALSE:
447 value = new Bool(false);
449 case trace::TYPE_TRUE:
450 value = new Bool(true);
452 case trace::TYPE_SINT:
453 value = parse_sint();
455 case trace::TYPE_UINT:
456 value = parse_uint();
458 case trace::TYPE_FLOAT:
459 value = parse_float();
461 case trace::TYPE_DOUBLE:
462 value = parse_double();
464 case trace::TYPE_STRING:
465 value = parse_string();
467 case trace::TYPE_ENUM:
468 value = parse_enum();
470 case trace::TYPE_BITMASK:
471 value = parse_bitmask();
473 case trace::TYPE_ARRAY:
474 value = parse_array();
476 case trace::TYPE_STRUCT:
477 value = parse_struct();
479 case trace::TYPE_BLOB:
480 value = parse_blob();
482 case trace::TYPE_OPAQUE:
483 value = parse_opaque();
486 std::cerr << "error: unknown type " << c << "\n";
494 std::cerr << "\tVALUE " << value << "\n";
501 void Parser::scan_value(void) {
504 case trace::TYPE_NULL:
505 case trace::TYPE_FALSE:
506 case trace::TYPE_TRUE:
508 case trace::TYPE_SINT:
511 case trace::TYPE_UINT:
514 case trace::TYPE_FLOAT:
517 case trace::TYPE_DOUBLE:
520 case trace::TYPE_STRING:
523 case trace::TYPE_ENUM:
526 case trace::TYPE_BITMASK:
529 case trace::TYPE_ARRAY:
532 case trace::TYPE_STRUCT:
535 case trace::TYPE_BLOB:
538 case trace::TYPE_OPAQUE:
542 std::cerr << "error: unknown type " << c << "\n";
550 Value *Parser::parse_sint() {
551 return new SInt(-(signed long long)read_uint());
555 void Parser::scan_sint() {
560 Value *Parser::parse_uint() {
561 return new UInt(read_uint());
565 void Parser::scan_uint() {
570 Value *Parser::parse_float() {
572 file->read(&value, sizeof value);
573 return new Float(value);
577 void Parser::scan_float() {
578 file->skip(sizeof(float));
582 Value *Parser::parse_double() {
584 file->read(&value, sizeof value);
585 return new Double(value);
589 void Parser::scan_double() {
590 file->skip(sizeof(double));
594 Value *Parser::parse_string() {
595 return new String(read_string());
599 void Parser::scan_string() {
604 Value *Parser::parse_enum() {
605 EnumSig *sig = parse_enum_sig();
606 return new Enum(sig);
610 void Parser::scan_enum() {
615 Value *Parser::parse_bitmask() {
616 BitmaskSig *sig = parse_bitmask_sig();
618 unsigned long long value = read_uint();
620 return new Bitmask(sig, value);
624 void Parser::scan_bitmask() {
626 skip_uint(); /* value */
630 Value *Parser::parse_array(void) {
631 size_t len = read_uint();
632 Array *array = new Array(len);
633 for (size_t i = 0; i < len; ++i) {
634 array->values[i] = parse_value();
640 void Parser::scan_array(void) {
641 size_t len = read_uint();
642 for (size_t i = 0; i < len; ++i) {
648 Value *Parser::parse_blob(void) {
649 size_t size = read_uint();
650 Blob *blob = new Blob(size);
652 file->read(blob->buf, (unsigned)size);
658 void Parser::scan_blob(void) {
659 size_t size = read_uint();
666 Value *Parser::parse_struct() {
667 StructSig *sig = parse_struct_sig();
668 Struct *value = new Struct(sig);
670 for (size_t i = 0; i < sig->num_members; ++i) {
671 value->members[i] = parse_value();
678 void Parser::scan_struct() {
679 StructSig *sig = parse_struct_sig();
680 for (size_t i = 0; i < sig->num_members; ++i) {
686 Value *Parser::parse_opaque() {
687 unsigned long long addr;
689 return new Pointer(addr);
693 void Parser::scan_opaque() {
698 const char * Parser::read_string(void) {
699 size_t len = read_uint();
700 char * value = new char[len + 1];
702 file->read(value, (unsigned)len);
706 std::cerr << "\tSTRING \"" << value << "\"\n";
712 void Parser::skip_string(void) {
713 size_t len = read_uint();
718 unsigned long long Parser::read_uint(void) {
719 unsigned long long value = 0;
727 value |= (unsigned long long)(c & 0x7f) << shift;
731 std::cerr << "\tUINT " << value << "\n";
737 void Parser::skip_uint(void) {
748 inline int Parser::read_byte(void) {
749 int c = file->getc();
752 std::cerr << "\tEOF" << "\n";
754 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
760 inline void Parser::skip_byte(void) {
765 } /* namespace trace */