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 **************************************************************************/
31 #include "trace_file.hpp"
32 #include "trace_snappyfile.hpp"
33 #include "trace_parser.hpp"
36 #define TRACE_VERBOSE 0
54 bool Parser::open(const char *filename) {
56 if (File::isZLibCompressed(filename)) {
59 file = new SnappyFile;
62 if (!file->open(filename, File::Read)) {
66 version = read_uint();
67 if (version > TRACE_VERSION) {
68 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) {
101 deleteAll(functions);
108 Call *Parser::parse_call(void) {
112 case Trace::EVENT_ENTER:
115 case Trace::EVENT_LEAVE:
116 return parse_leave();
118 std::cerr << "error: unknown event " << c << "\n";
121 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
122 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
123 std::cerr << **it << "\n";
132 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
135 T *lookup(std::vector<T *> &map, size_t index) {
136 if (index >= map.size()) {
137 map.resize(index + 1);
145 void Parser::parse_enter(void) {
146 size_t id = read_uint();
148 FunctionSig *sig = lookup(functions, id);
149 const File::Offset offset = file->currentOffset();
150 bool callWithSig = callWithSignature(offset);
151 if (!sig || callWithSig) {
153 sig = new FunctionSig;
155 sig->name = read_string();
156 sig->num_args = read_uint();
157 const char **arg_names = new const char *[sig->num_args];
158 for (unsigned i = 0; i < sig->num_args; ++i) {
159 arg_names[i] = read_string();
161 sig->arg_names = arg_names;
163 m_callSigOffsets.insert(offset);
165 /* skip over the signature */
166 read_string(); /* name */
167 int num_args = read_uint();
168 for (unsigned i = 0; i < num_args; ++i) {
169 read_string(); /*arg_name*/
175 Call *call = new Call(sig);
177 if (hasCallBeenParsed(offset)) {
178 call->no = callNumForOffset(offset);
180 call->no = next_call_no++;
181 m_callNumOffsets.insert(
182 std::pair<File::Offset, unsigned>(offset, call->no));
185 if (parse_call_details(call)) {
186 calls.push_back(call);
193 Call *Parser::parse_leave(void) {
194 unsigned call_no = read_uint();
196 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
197 if ((*it)->no == call_no) {
207 if (parse_call_details(call)) {
216 bool Parser::parse_call_details(Call *call) {
220 case Trace::CALL_END:
222 case Trace::CALL_ARG:
225 case Trace::CALL_RET:
226 call->ret = parse_value();
229 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
239 void Parser::parse_arg(Call *call) {
240 unsigned index = read_uint();
241 Value *value = parse_value();
242 if (index >= call->args.size()) {
243 call->args.resize(index + 1);
245 call->args[index] = value;
249 Value *Parser::parse_value(void) {
254 case Trace::TYPE_NULL:
257 case Trace::TYPE_FALSE:
258 value = new Bool(false);
260 case Trace::TYPE_TRUE:
261 value = new Bool(true);
263 case Trace::TYPE_SINT:
264 value = parse_sint();
266 case Trace::TYPE_UINT:
267 value = parse_uint();
269 case Trace::TYPE_FLOAT:
270 value = parse_float();
272 case Trace::TYPE_DOUBLE:
273 value = parse_double();
275 case Trace::TYPE_STRING:
276 value = parse_string();
278 case Trace::TYPE_ENUM:
279 value = parse_enum();
281 case Trace::TYPE_BITMASK:
282 value = parse_bitmask();
284 case Trace::TYPE_ARRAY:
285 value = parse_array();
287 case Trace::TYPE_STRUCT:
288 value = parse_struct();
290 case Trace::TYPE_BLOB:
291 value = parse_blob();
293 case Trace::TYPE_OPAQUE:
294 value = parse_opaque();
297 std::cerr << "error: unknown type " << c << "\n";
305 std::cerr << "\tVALUE " << value << "\n";
312 Value *Parser::parse_sint() {
313 return new SInt(-(signed long long)read_uint());
317 Value *Parser::parse_uint() {
318 return new UInt(read_uint());
322 Value *Parser::parse_float() {
324 file->read(&value, sizeof value);
325 return new Float(value);
329 Value *Parser::parse_double() {
331 file->read(&value, sizeof value);
332 return new Float(value);
336 Value *Parser::parse_string() {
337 return new String(read_string());
341 Value *Parser::parse_enum() {
342 size_t id = read_uint();
343 EnumSig *sig = lookup(enums, id);
344 const File::Offset offset = file->currentOffset();
345 bool enumWithSig = enumWithSignature(offset);
346 if (!sig || enumWithSig) {
350 sig->name = read_string();
351 Value *value = parse_value();
352 sig->value = value->toSInt();
355 m_enumSigOffsets.insert(offset);
357 read_string(); /*name*/
358 Value *value = parse_value();
363 return new Enum(sig);
367 Value *Parser::parse_bitmask() {
368 size_t id = read_uint();
369 BitmaskSig *sig = lookup(bitmasks, id);
370 const File::Offset offset = file->currentOffset();
371 bool bitmaskWithSig = bitmaskWithSignature(offset);
372 if (!sig || bitmaskWithSig) {
374 sig = new BitmaskSig;
376 sig->num_flags = read_uint();
377 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
378 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
379 it->name = read_string();
380 it->value = read_uint();
381 if (it->value == 0 && it != flags) {
382 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
387 m_bitmaskSigOffsets.insert(offset);
389 int num_flags = read_uint();
390 for (int i = 0; i < num_flags; ++i) {
391 read_string(); /*name */
392 read_uint(); /* value */
398 unsigned long long value = read_uint();
400 return new Bitmask(sig, value);
404 Value *Parser::parse_array(void) {
405 size_t len = read_uint();
406 Array *array = new Array(len);
407 for (size_t i = 0; i < len; ++i) {
408 array->values[i] = parse_value();
414 Value *Parser::parse_blob(void) {
415 size_t size = read_uint();
416 Blob *blob = new Blob(size);
418 file->read(blob->buf, (unsigned)size);
424 Value *Parser::parse_struct() {
425 size_t id = read_uint();
427 StructSig *sig = lookup(structs, id);
428 const File::Offset offset = file->currentOffset();
429 bool structWithSig = structWithSignature(offset);
430 if (!sig || structWithSig) {
434 sig->name = read_string();
435 sig->num_members = read_uint();
436 const char **member_names = new const char *[sig->num_members];
437 for (unsigned i = 0; i < sig->num_members; ++i) {
438 member_names[i] = read_string();
440 sig->member_names = member_names;
442 m_structSigOffsets.insert(offset);
444 read_string(); /* name */
445 unsigned num_members = read_uint();
446 for (unsigned i = 0; i < num_members; ++i) {
447 read_string(); /* member_name */
453 Struct *value = new Struct(sig);
455 for (size_t i = 0; i < sig->num_members; ++i) {
456 value->members[i] = parse_value();
463 Value *Parser::parse_opaque() {
464 unsigned long long addr;
466 return new Pointer(addr);
470 const char * Parser::read_string(void) {
471 size_t len = read_uint();
472 char * value = new char[len + 1];
474 file->read(value, (unsigned)len);
478 std::cerr << "\tSTRING \"" << value << "\"\n";
484 unsigned long long Parser::read_uint(void) {
485 unsigned long long value = 0;
493 value |= (unsigned long long)(c & 0x7f) << shift;
497 std::cerr << "\tUINT " << value << "\n";
503 inline int Parser::read_byte(void) {
504 int c = file->getc();
507 std::cerr << "\tEOF" << "\n";
509 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
515 inline bool Parser::callWithSignature(const File::Offset &offset) const
517 return m_callSigOffsets.find(offset) != m_callSigOffsets.end();
520 inline bool Parser::structWithSignature(const File::Offset &offset) const
522 return m_structSigOffsets.find(offset) != m_structSigOffsets.end();
525 inline bool Parser::enumWithSignature(const File::Offset &offset) const
527 return m_enumSigOffsets.find(offset) != m_enumSigOffsets.end();
530 inline bool Parser::bitmaskWithSignature(const File::Offset &offset) const
532 return m_bitmaskSigOffsets.find(offset) != m_bitmaskSigOffsets.end();
535 bool Parser::hasCallBeenParsed(const File::Offset &offset) const
537 return m_callNumOffsets.find(offset) != m_callNumOffsets.end();
540 unsigned Parser::callNumForOffset(const File::Offset &offset) const
542 CallNumOffsets::const_iterator itr = m_callNumOffsets.find(offset);
543 assert(itr != m_callNumOffsets.end());
547 } /* namespace Trace */