2 id: lttng-modules-tp-struct-entry
5 This table describes possible entries for the `TP_STRUCT__entry()` part
6 of `LTTNG_TRACEPOINT_EVENT()`:
9 <table class="func-desc">
13 <th>Description/arguments</th>
20 <li><code class="no-bg">__field(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
24 <p>Standard integer, displayed in base 10</p>
27 <code class="arg">t</code> integer C type
28 (<code>int</code>, <code>unsigned char</code>,
29 <code>size_t</code>, ...)
31 <li><code class="arg">n</code> field name</li>
38 <li><code class="no-bg">__field_hex(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
42 <p>Standard integer, displayed in base 16</p>
44 <li><code class="arg">t</code> integer C type</li>
45 <li><code class="arg">n</code> field name</li>
52 <li><code class="no-bg">__field_oct(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
56 <p>Standard integer, displayed in base 8</p>
59 <code class="arg">t</code> integer C type
61 <li><code class="arg">n</code> field name</li>
68 <li><code class="no-bg">__field_network(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
73 Integer in network byte order (big endian),
74 displayed in base 10
78 <code class="arg">t</code> integer C type
80 <li><code class="arg">n</code> field name</li>
87 <li><code class="no-bg">__field_network_hex(<span class="arg">t</span>, <span class="arg">n</span>)</code></li>
92 Integer in network byte order (big endian),
93 displayed in base 16
97 <code class="arg">t</code> integer C type
99 <li><code class="arg">n</code> field name</li>
106 <li><code class="no-bg">__array(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
110 <p>Statically-sized array, elements displayed in base 10</p>
113 <code class="arg">t</code> array element C type
115 <li><code class="arg">n</code> field name</li>
116 <li><code class="arg">s</code> number of elements</li>
123 <li><code class="no-bg">__array_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
127 <p>Statically-sized array, elements displayed in base 16</p>
130 <code class="arg">t</code> array element C type
132 <li><code class="arg">n</code> field name</li>
133 <li><code class="arg">s</code> number of elements</li>
140 <li><code class="no-bg">__array_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
144 <p>Statically-sized array, displayed as text</p>
147 <code class="arg">t</code> array element C type
148 (always <code>char</code>)
150 <li><code class="arg">n</code> field name</li>
151 <li><code class="arg">s</code> number of elements</li>
158 <li><code class="no-bg">__dynamic_array(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
162 <p>Dynamically-sized array, displayed in base 10</p>
165 <code class="arg">t</code> array element C type
167 <li><code class="arg">n</code> field name</li>
168 <li><code class="arg">s</code> length C expression</li>
175 <li><code class="no-bg">__dynamic_array_hex(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
179 <p>Dynamically-sized array, displayed in base 16</p>
182 <code class="arg">t</code> array element C type
184 <li><code class="arg">n</code> field name</li>
185 <li><code class="arg">s</code> length C expression</li>
192 <li><code class="no-bg">__dynamic_array_text(<span class="arg">t</span>, <span class="arg">n</span>, <span class="arg">s</span>)</code></li>
196 <p>Dynamically-sized array, displayed as text</p>
199 <code class="arg">t</code> array element C type
200 (always <code>char</code>)
202 <li><code class="arg">n</code> field name</li>
203 <li><code class="arg">s</code> length C expression</li>
210 <li><code class="no-bg">__string(<span class="arg">n</span>, <span class="arg">s</span>)</code></li>
215 Null-terminated string; undefined behavior
216 if <code class="arg">s</code> is <code>NULL</code>
219 <li><code class="arg">n</code> field name</li>
220 <li><code class="arg">s</code> string source (pointer)</li>
228 The above macros should cover the majority of cases. For advanced items,
229 see `probes/lttng-events.h`.