1 /**************************************************************************
3 * Copyright 2007-2009 VMware, Inc.
6 * Permission is hereby granted, free of charge, to any person obtaining a copy
7 * of this software and associated documentation files (the "Software"), to deal
8 * in the Software without restriction, including without limitation the rights
9 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 * copies of the Software, and to permit persons to whom the Software is
11 * furnished to do so, subject to the following conditions:
13 * The above copyright notice and this permission notice shall be included in
14 * all copies or substantial portions of the Software.
16 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24 **************************************************************************/
34 #include "trace_file.hpp"
35 #include "trace_writer.hpp"
36 #include "trace_format.hpp"
45 m_file = File::createSnappy();
62 Writer::open(const char *filename) {
65 if (!m_file->open(filename, File::Write)) {
75 _writeUInt(TRACE_VERSION);
81 Writer::_write(const void *sBuffer, size_t dwBytesToWrite) {
82 m_file->write(sBuffer, dwBytesToWrite);
86 Writer::_writeByte(char c) {
91 Writer::_writeUInt(unsigned long long value) {
92 char buf[2 * sizeof value];
97 assert(len < sizeof buf);
98 buf[len] = 0x80 | (value & 0x7f);
104 buf[len - 1] &= 0x7f;
110 Writer::_writeFloat(float value) {
111 assert(sizeof value == 4);
112 _write((const char *)&value, sizeof value);
116 Writer::_writeDouble(double value) {
117 assert(sizeof value == 8);
118 _write((const char *)&value, sizeof value);
122 Writer::_writeString(const char *str) {
123 size_t len = strlen(str);
128 inline bool lookup(std::vector<bool> &map, size_t index) {
129 if (index >= map.size()) {
130 map.resize(index + 1);
137 unsigned Writer::beginEnter(const FunctionSig *sig, unsigned thread_id) {
138 _writeByte(trace::EVENT_ENTER);
139 _writeUInt(thread_id);
141 if (!lookup(functions, sig->id)) {
142 _writeString(sig->name);
143 _writeUInt(sig->num_args);
144 for (unsigned i = 0; i < sig->num_args; ++i) {
145 _writeString(sig->arg_names[i]);
147 functions[sig->id] = true;
153 void Writer::endEnter(void) {
154 _writeByte(trace::CALL_END);
157 void Writer::beginLeave(unsigned call) {
158 _writeByte(trace::EVENT_LEAVE);
162 void Writer::endLeave(void) {
163 _writeByte(trace::CALL_END);
166 void Writer::beginArg(unsigned index) {
167 _writeByte(trace::CALL_ARG);
171 void Writer::beginReturn(void) {
172 _writeByte(trace::CALL_RET);
175 void Writer::beginArray(size_t length) {
176 _writeByte(trace::TYPE_ARRAY);
180 void Writer::beginStruct(const StructSig *sig) {
181 _writeByte(trace::TYPE_STRUCT);
183 if (!lookup(structs, sig->id)) {
184 _writeString(sig->name);
185 _writeUInt(sig->num_members);
186 for (unsigned i = 0; i < sig->num_members; ++i) {
187 _writeString(sig->member_names[i]);
189 structs[sig->id] = true;
193 void Writer::beginRepr(void) {
194 _writeByte(trace::TYPE_REPR);
197 void Writer::writeBool(bool value) {
198 _writeByte(value ? trace::TYPE_TRUE : trace::TYPE_FALSE);
201 void Writer::writeSInt(signed long long value) {
203 _writeByte(trace::TYPE_SINT);
206 _writeByte(trace::TYPE_UINT);
211 void Writer::writeUInt(unsigned long long value) {
212 _writeByte(trace::TYPE_UINT);
216 void Writer::writeFloat(float value) {
217 _writeByte(trace::TYPE_FLOAT);
221 void Writer::writeDouble(double value) {
222 _writeByte(trace::TYPE_DOUBLE);
226 void Writer::writeString(const char *str) {
231 _writeByte(trace::TYPE_STRING);
235 void Writer::writeString(const char *str, size_t len) {
240 _writeByte(trace::TYPE_STRING);
245 void Writer::writeWString(const wchar_t *str) {
250 _writeByte(trace::TYPE_STRING);
251 _writeString("<wide-string>");
254 void Writer::writeBlob(const void *data, size_t size) {
259 _writeByte(trace::TYPE_BLOB);
266 void Writer::writeEnum(const EnumSig *sig, signed long long value) {
267 _writeByte(trace::TYPE_ENUM);
269 if (!lookup(enums, sig->id)) {
270 _writeUInt(sig->num_values);
271 for (unsigned i = 0; i < sig->num_values; ++i) {
272 _writeString(sig->values[i].name);
273 writeSInt(sig->values[i].value);
275 enums[sig->id] = true;
280 void Writer::writeBitmask(const BitmaskSig *sig, unsigned long long value) {
281 _writeByte(trace::TYPE_BITMASK);
283 if (!lookup(bitmasks, sig->id)) {
284 _writeUInt(sig->num_flags);
285 for (unsigned i = 0; i < sig->num_flags; ++i) {
286 if (i != 0 && sig->flags[i].value == 0) {
287 os::log("apitrace: warning: sig %s is zero but is not first flag\n", sig->flags[i].name);
289 _writeString(sig->flags[i].name);
290 _writeUInt(sig->flags[i].value);
292 bitmasks[sig->id] = true;
297 void Writer::writeNull(void) {
298 _writeByte(trace::TYPE_NULL);
301 void Writer::writePointer(unsigned long long addr) {
306 _writeByte(trace::TYPE_OPAQUE);
311 } /* namespace trace */