1 /**************************************************************************
3 * Copyright 2010 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 **************************************************************************/
27 * Trace binary format.
29 * This file defines the trace binary stream, which is then compressed by
33 #ifndef _TRACE_FORMAT_HPP_
34 #define _TRACE_FORMAT_HPP_
39 * Trace file version number.
41 * We keep backwards compatability reading old traces, i.e., it should always be
42 * possible to parse and retrace old trace files.
44 * So the trace version number refers not only to changes in the binary format
45 * representation, but also semantic changes in the way certain functions
48 * Writing/editing old traces will not be supported however. An older version
49 * of apitrace should be used in such circunstances.
54 * - initial implementation
57 * - support for GL user arrays -- a blob is provided whenever an user memory
58 * is referred (whereas before calls that operate wit user memory instead of
59 * VBOs should be ignore)
62 * - malloc/free memory calls -- allow to pass user memory as malloc memory
64 * - glFlushMappedBufferRange will emit a memcpy only for the flushed range
65 * (whereas previously it would emit a memcpy for the whole mapped range)
68 * - enums signatures are recorded for the a whole set of values (not as individual values)
71 * - call enter events include thread ID
73 #define TRACE_VERSION 4
81 * event = EVENT_ENTER thread_id call_sig call_detail+
82 * | EVENT_LEAVE call_no call_detail+
84 * call_sig = sig_id ( name arg_names )?
86 * call_detail = ARG index value
99 * | ENUM enum_sig value
100 * | BITMASK bitmask_sig value
101 * | ARRAY length value+
102 * | STRUCT struct_sig value+
106 * call_sig = id name arg_name*
109 * enum_sig = id count (name value)+
112 * bitmask_sig = id count (name value)+
115 * string = length (BYTE)*
140 TYPE_STRING, // Null terminated, human readible string
141 TYPE_BLOB, // Block of bytes
151 } /* namespace trace */
153 #endif /* _TRACE_FORMAT_HPP_ */