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(const Container &c)
89 deleteAll(c.begin(), c.end());
92 void Parser::close(void) {
100 deleteAll(functions);
107 Call *Parser::parse_call(void) {
111 case Trace::EVENT_ENTER:
114 case Trace::EVENT_LEAVE:
115 return parse_leave();
117 std::cerr << "error: unknown event " << c << "\n";
120 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
121 std::cerr << "warning: incomplete call " << (*it)->name() << "\n";
122 std::cerr << **it << "\n";
131 * Helper function to lookup an ID in a vector, resizing the vector if it doesn't fit.
134 T *lookup(std::vector<T *> &map, size_t index) {
135 if (index >= map.size()) {
136 map.resize(index + 1);
144 void Parser::parse_enter(void) {
145 size_t id = read_uint();
147 FunctionSig *sig = lookup(functions, id);
149 sig = new FunctionSig;
151 sig->name = read_string();
152 sig->num_args = read_uint();
153 const char **arg_names = new const char *[sig->num_args];
154 for (unsigned i = 0; i < sig->num_args; ++i) {
155 arg_names[i] = read_string();
157 sig->arg_names = arg_names;
162 Call *call = new Call(sig);
163 call->no = next_call_no++;
165 if (parse_call_details(call)) {
166 calls.push_back(call);
173 Call *Parser::parse_leave(void) {
174 unsigned call_no = read_uint();
176 for (CallList::iterator it = calls.begin(); it != calls.end(); ++it) {
177 if ((*it)->no == call_no) {
187 if (parse_call_details(call)) {
196 bool Parser::parse_call_details(Call *call) {
200 case Trace::CALL_END:
202 case Trace::CALL_ARG:
205 case Trace::CALL_RET:
206 call->ret = parse_value();
209 std::cerr << "error: ("<<call->name()<< ") unknown call detail "
219 void Parser::parse_arg(Call *call) {
220 unsigned index = read_uint();
221 Value *value = parse_value();
222 if (index >= call->args.size()) {
223 call->args.resize(index + 1);
225 call->args[index] = value;
229 Value *Parser::parse_value(void) {
234 case Trace::TYPE_NULL:
237 case Trace::TYPE_FALSE:
238 value = new Bool(false);
240 case Trace::TYPE_TRUE:
241 value = new Bool(true);
243 case Trace::TYPE_SINT:
244 value = parse_sint();
246 case Trace::TYPE_UINT:
247 value = parse_uint();
249 case Trace::TYPE_FLOAT:
250 value = parse_float();
252 case Trace::TYPE_DOUBLE:
253 value = parse_double();
255 case Trace::TYPE_STRING:
256 value = parse_string();
258 case Trace::TYPE_ENUM:
259 value = parse_enum();
261 case Trace::TYPE_BITMASK:
262 value = parse_bitmask();
264 case Trace::TYPE_ARRAY:
265 value = parse_array();
267 case Trace::TYPE_STRUCT:
268 value = parse_struct();
270 case Trace::TYPE_BLOB:
271 value = parse_blob();
273 case Trace::TYPE_OPAQUE:
274 value = parse_opaque();
277 std::cerr << "error: unknown type " << c << "\n";
285 std::cerr << "\tVALUE " << value << "\n";
292 Value *Parser::parse_sint() {
293 return new SInt(-(signed long long)read_uint());
297 Value *Parser::parse_uint() {
298 return new UInt(read_uint());
302 Value *Parser::parse_float() {
304 file->read(&value, sizeof value);
305 return new Float(value);
309 Value *Parser::parse_double() {
311 file->read(&value, sizeof value);
312 return new Float(value);
316 Value *Parser::parse_string() {
317 return new String(read_string());
321 Value *Parser::parse_enum() {
322 size_t id = read_uint();
323 EnumSig *sig = lookup(enums, id);
327 sig->name = read_string();
328 Value *value = parse_value();
329 sig->value = value->toSInt();
334 return new Enum(sig);
338 Value *Parser::parse_bitmask() {
339 size_t id = read_uint();
340 BitmaskSig *sig = lookup(bitmasks, id);
342 sig = new BitmaskSig;
344 sig->num_flags = read_uint();
345 BitmaskFlag *flags = new BitmaskFlag[sig->num_flags];
346 for (BitmaskFlag *it = flags; it != flags + sig->num_flags; ++it) {
347 it->name = read_string();
348 it->value = read_uint();
349 if (it->value == 0 && it != flags) {
350 std::cerr << "warning: bitmask " << it->name << " is zero but is not first flag\n";
358 unsigned long long value = read_uint();
360 return new Bitmask(sig, value);
364 Value *Parser::parse_array(void) {
365 size_t len = read_uint();
366 Array *array = new Array(len);
367 for (size_t i = 0; i < len; ++i) {
368 array->values[i] = parse_value();
374 Value *Parser::parse_blob(void) {
375 size_t size = read_uint();
376 Blob *blob = new Blob(size);
378 file->read(blob->buf, (unsigned)size);
384 Value *Parser::parse_struct() {
385 size_t id = read_uint();
387 StructSig *sig = lookup(structs, id);
391 sig->name = read_string();
392 sig->num_members = read_uint();
393 const char **member_names = new const char *[sig->num_members];
394 for (unsigned i = 0; i < sig->num_members; ++i) {
395 member_names[i] = read_string();
397 sig->member_names = member_names;
402 Struct *value = new Struct(sig);
404 for (size_t i = 0; i < sig->num_members; ++i) {
405 value->members[i] = parse_value();
412 Value *Parser::parse_opaque() {
413 unsigned long long addr;
415 return new Pointer(addr);
419 const char * Parser::read_string(void) {
420 size_t len = read_uint();
421 char * value = new char[len + 1];
423 file->read(value, (unsigned)len);
427 std::cerr << "\tSTRING \"" << value << "\"\n";
433 unsigned long long Parser::read_uint(void) {
434 unsigned long long value = 0;
442 value |= (unsigned long long)(c & 0x7f) << shift;
446 std::cerr << "\tUINT " << value << "\n";
452 inline int Parser::read_byte(void) {
453 int c = file->getc();
456 std::cerr << "\tEOF" << "\n";
458 std::cerr << "\tBYTE 0x" << std::hex << c << std::dec << "\n";
464 } /* namespace Trace */