2 id: liblttng-ust-tp-fields
5 The available macros to define tracepoint fields, which should be listed
6 within `TP_FIELDS()` in `TRACEPOINT_EVENT()`, are:
9 <table class="func-desc">
13 <th>Description/arguments</th>
20 <li><code class="no-bg">ctf_integer(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
21 <li><code class="no-bg">ctf_integer_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
25 <p>Standard integer, displayed in base 10</p>
28 <code class="arg"><strong>t</strong></code> integer C type
29 (<code>int</code>, <code>long</code>,
30 <code>size_t</code>, etc.)
32 <li><code class="arg"><strong>n</strong></code> field name</li>
33 <li><code class="arg"><strong>e</strong></code> argument expression</li>
38 <td><code class="no-bg">ctf_integer_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></td>
40 <p>Standard integer, displayed in base 16</p>
42 <li><code class="arg"><strong>t</strong></code> integer C type</li>
43 <li><code class="arg">n</code> field name</li>
44 <li><code class="arg">e</code> argument expression</li>
49 <td><code class="no-bg">ctf_integer_network(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></td>
52 Integer in network byte order (big endian),
53 displayed in base 10
56 <li><code class="arg">t</code> integer C type</li>
57 <li><code class="arg">n</code> field name</li>
58 <li><code class="arg">e</code> argument expression</li>
63 <td><code class="no-bg">ctf_integer_network_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></td>
66 Integer in network byte order, displayed
69 <li><code class="arg">t</code> integer C type</li>
70 <li><code class="arg">n</code> field name</li>
71 <li><code class="arg">e</code> argument expression</li>
78 <li><code class="no-bg">ctf_float(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
79 <li><code class="no-bg">ctf_float_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>)</code></li>
83 <p>Floating point number</p>
86 <code class="arg">t</code> floating point number
87 C type (<code>float</code>, <code>double</code>)
89 <li><code class="arg">n</code> field name</li>
90 <li><code class="arg">e</code> argument expression</li>
97 <li><code class="no-bg">ctf_string(<span class="arg">n</span>, <span class="arg">e</span>)</code></li>
98 <li><code class="no-bg">ctf_string_nowrite(<span class="arg">n</span>, <span class="arg">e</span>)</code></li>
103 Null-terminated string; undefined behavior if
104 <code class="arg">e</code> is <code>NULL</code>
107 <li><code class="arg">n</code> field name</li>
108 <li><code class="arg">e</code> argument expression</li>
115 <li><code class="no-bg">ctf_array(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
116 <li><code class="no-bg">ctf_array_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
120 <p>Statically-sized array of integers</p>
122 <li><code class="arg">t</code> array element C type</li>
123 <li><code class="arg">n</code> field name</li>
124 <li><code class="arg">e</code> argument expression</li>
125 <li><code class="arg">s</code> number of elements</li>
132 <li><code class="no-bg">ctf_array_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
133 <li><code class="no-bg">ctf_array_nowrite_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">s</span>)</code></li>
138 Statically-sized array, printed as text; no need to be
142 <li><code class="arg">t</code> array element C type (always <code>char</code>)</li>
143 <li><code class="arg">n</code> field name</li>
144 <li><code class="arg">e</code> argument expression</li>
145 <li><code class="arg">s</code> number of elements</li>
152 <li><code class="no-bg">ctf_sequence(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
153 <li><code class="no-bg">ctf_sequence_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
158 Dynamically-sized array of integers; type of
159 <code class="arg">E</code> needs to be unsigned
162 <li><code class="arg">t</code> sequence element C type</li>
163 <li><code class="arg">n</code> field name</li>
164 <li><code class="arg">e</code> argument expression</li>
165 <li><code class="arg">T</code> length expression C type</li>
166 <li><code class="arg">E</code> length expression</li>
173 <li><code class="no-bg">ctf_sequence_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
174 <li><code class="no-bg">ctf_sequence_text_nowrite(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">e</span>, <span class="arg">T</span>, <span class="arg">E</span>)</code></li>
179 Dynamically-sized array, displayed as text; no need to
180 be null-terminated; undefined behavior if
181 <code class="arg">e</code> is <code>NULL</code></p>
183 <li><code class="arg">t</code> sequence element C type (always <code>char</code>)</li>
184 <li><code class="arg">n</code> field name</li>
185 <li><code class="arg">e</code> argument expression</li>
186 <li><code class="arg">T</code> length expression C type</li>
187 <li><code class="arg">E</code> length expression</li>
195 The `_nowrite` versions omit themselves from the session trace, but are
196 otherwise identical. This means the `_nowrite` fields won't be written
197 in the recorded trace. Their primary purpose is to make some
198 of the event context available to the
199 [event filters](#doc-enabling-disabling-events) without having to
200 commit the data to sub-buffers.