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_writer.hpp"
35 #include "trace_file.hpp"
36 #include "trace_format.hpp"
45 m_file = new Trace::SnappyFile;
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) {
138 _writeByte(Trace::EVENT_ENTER);
140 if (!lookup(functions, sig->id)) {
141 _writeString(sig->name);
142 _writeUInt(sig->num_args);
143 for (unsigned i = 0; i < sig->num_args; ++i) {
144 _writeString(sig->arg_names[i]);
146 functions[sig->id] = true;
152 void Writer::endEnter(void) {
153 _writeByte(Trace::CALL_END);
156 void Writer::beginLeave(unsigned call) {
157 _writeByte(Trace::EVENT_LEAVE);
161 void Writer::endLeave(void) {
162 _writeByte(Trace::CALL_END);
165 void Writer::beginArg(unsigned index) {
166 _writeByte(Trace::CALL_ARG);
170 void Writer::beginReturn(void) {
171 _writeByte(Trace::CALL_RET);
174 void Writer::beginArray(size_t length) {
175 _writeByte(Trace::TYPE_ARRAY);
179 void Writer::beginStruct(const StructSig *sig) {
180 _writeByte(Trace::TYPE_STRUCT);
182 if (!lookup(structs, sig->id)) {
183 _writeString(sig->name);
184 _writeUInt(sig->num_members);
185 for (unsigned i = 0; i < sig->num_members; ++i) {
186 _writeString(sig->member_names[i]);
188 structs[sig->id] = true;
192 void Writer::writeBool(bool value) {
193 _writeByte(value ? Trace::TYPE_TRUE : Trace::TYPE_FALSE);
196 void Writer::writeSInt(signed long long value) {
198 _writeByte(Trace::TYPE_SINT);
201 _writeByte(Trace::TYPE_UINT);
206 void Writer::writeUInt(unsigned long long value) {
207 _writeByte(Trace::TYPE_UINT);
211 void Writer::writeFloat(float value) {
212 _writeByte(Trace::TYPE_FLOAT);
216 void Writer::writeDouble(double value) {
217 _writeByte(Trace::TYPE_DOUBLE);
221 void Writer::writeString(const char *str) {
226 _writeByte(Trace::TYPE_STRING);
230 void Writer::writeString(const char *str, size_t len) {
235 _writeByte(Trace::TYPE_STRING);
240 void Writer::writeWString(const wchar_t *str) {
245 _writeByte(Trace::TYPE_STRING);
246 _writeString("<wide-string>");
249 void Writer::writeBlob(const void *data, size_t size) {
254 _writeByte(Trace::TYPE_BLOB);
261 void Writer::writeEnum(const EnumSig *sig) {
262 _writeByte(Trace::TYPE_ENUM);
264 if (!lookup(enums, sig->id)) {
265 _writeString(sig->name);
266 Writer::writeSInt(sig->value);
267 enums[sig->id] = true;
271 void Writer::writeBitmask(const BitmaskSig *sig, unsigned long long value) {
272 _writeByte(Trace::TYPE_BITMASK);
274 if (!lookup(bitmasks, sig->id)) {
275 _writeUInt(sig->num_flags);
276 for (unsigned i = 0; i < sig->num_flags; ++i) {
277 if (i != 0 && sig->flags[i].value == 0) {
278 OS::DebugMessage("apitrace: warning: sig %s is zero but is not first flag\n", sig->flags[i].name);
280 _writeString(sig->flags[i].name);
281 _writeUInt(sig->flags[i].value);
283 bitmasks[sig->id] = true;
288 void Writer::writeNull(void) {
289 _writeByte(Trace::TYPE_NULL);
292 void Writer::writeOpaque(const void *addr) {
297 _writeByte(Trace::TYPE_OPAQUE);
298 _writeUInt((size_t)addr);
303 LocalWriter::open(void) {
305 static unsigned dwCounter = 0;
307 const char *szExtension = "trace";
308 char szFileName[PATH_MAX];
309 const char *lpFileName;
311 lpFileName = getenv("TRACE_FILE");
313 strncpy(szFileName, lpFileName, PATH_MAX);
316 char szProcessName[PATH_MAX];
317 char szCurrentDir[PATH_MAX];
318 OS::GetProcessName(szProcessName, PATH_MAX);
319 OS::GetCurrentDir(szCurrentDir, PATH_MAX);
325 snprintf(szFileName, PATH_MAX, "%s%c%s.%u.%s", szCurrentDir, PATH_SEP, szProcessName, dwCounter, szExtension);
327 snprintf(szFileName, PATH_MAX, "%s%c%s.%s", szCurrentDir, PATH_SEP, szProcessName, szExtension);
329 file = fopen(szFileName, "rb");
339 OS::DebugMessage("apitrace: tracing to %s\n", szFileName);
341 Writer::open(szFileName);
344 unsigned LocalWriter::beginEnter(const FunctionSig *sig) {
347 if (!m_file->isOpened()) {
351 return Writer::beginEnter(sig);
354 void LocalWriter::endEnter(void) {
359 void LocalWriter::beginLeave(unsigned call) {
361 Writer::beginLeave(call);
364 void LocalWriter::endLeave(void) {
371 } /* namespace Trace */