Mi add-context command: support and validation
[lttng-tools.git] / src / common / mi_lttng.xsd
CommitLineData
c5e38b74
JR
1<?xml version="1.0" encoding="UTF-8"?>
2<!--
3Copyright (c) 2014 - Oliver Cotte <olivier.cotte@polymtl.ca>
4 - Jonathan Rajotte <jonathan.r.julien@gmail.com>
5
6Permission is hereby granted, free of charge, to any person obtaining a copy
7of this software and associated documentation files (the "Software"), to deal
8in the Software without restriction, including without limitation the rights
9to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10copies of the Software, and to permit persons to whom the Software is
11furnished to do so, subject to the following conditions:
12
13The above copyright notice and this permission notice shall be included in
14all copies or substantial portions of the Software.
15
16THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22THE SOFTWARE.
23-->
24<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
25 elementFormDefault="qualified" version="2.5">
26
27 <!-- Maps to the uint32_t type -->
28 <xs:simpleType name="uint32_type">
29 <xs:restriction base="xs:integer">
30 <xs:minInclusive value="0" />
31 <xs:maxInclusive value="4294967295" />
32 </xs:restriction>
33 </xs:simpleType>
34
35 <!-- Maps to the uint64_t type -->
36 <xs:simpleType name="uint64_type">
37 <xs:restriction base="xs:integer">
38 <xs:minInclusive value="0" />
39 <xs:maxInclusive value="18446744073709551615" />
40 </xs:restriction>
41 </xs:simpleType>
42
43 <!-- Maps to the char name[LTTNG_SYMBOL_NAME_LEN] -->
44 <xs:simpleType name="name_type">
45 <xs:restriction base="xs:string">
46 <xs:maxLength value="255" />
47 </xs:restriction>
48 </xs:simpleType>
49
50 <!-- Maps to the lttng_event_type enum -->
51 <xs:simpleType name="event_type_type">
52 <xs:restriction base="xs:string">
53 <xs:enumeration value="ALL" />
54 <xs:enumeration value="TRACEPOINT" />
55 <xs:enumeration value="PROBE" />
56 <xs:enumeration value="FUNCTION" />
57 <xs:enumeration value="FUNCTION_ENTRY" />
58 <xs:enumeration value="NOOP" />
59 <xs:enumeration value="SYSCALL" />
60 <xs:enumeration value="KPROBE" />
61 <xs:enumeration value="KRETPROBE" />
62 </xs:restriction>
63 </xs:simpleType>
64
65 <!-- Maps to the lttng_event_field_type enum -->
66 <xs:simpleType name="event_field_type_type">
67 <xs:restriction base="xs:string">
68 <xs:enumeration value="OTHER" />
69 <xs:enumeration value="INTEGER" />
70 <xs:enumeration value="ENUM" />
71 <xs:enumeration value="FLOAT" />
72 <xs:enumeration value="STRING" />
73 </xs:restriction>
74 </xs:simpleType>
75
76 <!-- Maps to the lttng_loglevel_type enum -->
77 <xs:simpleType name="loglevel_type">
78 <xs:restriction base="xs:string">
79 <xs:enumeration value="ALL" />
80 <xs:enumeration value="RANGE" />
81 <xs:enumeration value="SINGLE" />
82 <xs:enumeration value="UNKNOWN" />
83 </xs:restriction>
84 </xs:simpleType>
85
89b72577
JRJ
86 <!-- Maps to the lttng_loglevel_type enum -->
87 <xs:simpleType name="context_type_type">
88 <xs:restriction base="xs:string">
89 <xs:enumeration value="PERF_COUNTER" />
90 <xs:enumeration value="PERF_CPU_COUNTER" />
91 <xs:enumeration value="PERF_THREAD_COUNTER" />
92 <xs:enumeration value="PID" />
93 <xs:enumeration value="PROCNAME" />
94 <xs:enumeration value="PRIO" />
95 <xs:enumeration value="NICE" />
96 <xs:enumeration value="VPID" />
97 <xs:enumeration value="TID" />
98 <xs:enumeration value="VTID" />
99 <xs:enumeration value="PPID" />
100 <xs:enumeration value="VPPID" />
101 <xs:enumeration value="PTHREAD_ID" />
102 <xs:enumeration value="HOSTNAME" />
103 <xs:enumeration value="IP" />
104 </xs:restriction>
105 </xs:simpleType>
106
c5e38b74
JR
107 <!-- Maps to loglevel_string char * -->
108 <xs:simpleType name="loglevel_string_type">
109 <xs:restriction base="xs:string">
110 <xs:enumeration value="" />
111 <xs:enumeration value="TRACE_EMERG" />
112 <xs:enumeration value="TRACE_ALERT" />
113 <xs:enumeration value="TRACE_CRIT" />
114 <xs:enumeration value="TRACE_ERR" />
115 <xs:enumeration value="TRACE_WARNING" />
116 <xs:enumeration value="TRACE_NOTICE" />
117 <xs:enumeration value="TRACE_INFO" />
118 <xs:enumeration value="TRACE_DEBUG_SYSTEM" />
119 <xs:enumeration value="TRACE_DEBUG_PROGRAM" />
120 <xs:enumeration value="TRACE_DEBUG_PROCESS" />
121 <xs:enumeration value="TRACE_DEBUG_MODULE" />
122 <xs:enumeration value="TRACE_DEBUG_UNIT" />
123 <xs:enumeration value="TRACE_DEBUG_FUNCTION" />
124 <xs:enumeration value="TRACE_DEBUG_LINE" />
125 <xs:enumeration value="TRACE_DEBUG" />
126 <xs:enumeration value="UNKNOWN" />
127 </xs:restriction>
128 </xs:simpleType>
129
7e66b1b0
JRJ
130 <!-- Maps to the lttng_calibrate_type enum -->
131 <xs:simpleType name="calibrate_type_type">
132 <xs:restriction base="xs:string">
133 <xs:enumeration value="FUNCTION" />
134 </xs:restriction>
135 </xs:simpleType>
136
c5e38b74
JR
137 <!-- Maps to the lttng_event_probe_attr struct -->
138 <xs:complexType name="event_probe_attributes_type">
139 <xs:all>
140 <xs:element name="address" type="uint64_type" />
141 <xs:element name="offset" type="uint64_type" />
142 <xs:element name="symbol_name" type="name_type" />
143 </xs:all>
144 </xs:complexType>
145
146 <!-- Maps to the lttng_event_function_attr struct -->
147 <xs:complexType name="event_ftrace_attributes_type">
148 <xs:all>
149 <xs:element name="symbol_name" type="name_type" />
150 </xs:all>
151 </xs:complexType>
152
153 <!-- Maps to per event type configuration -->
154 <xs:complexType name="event_attributes_type">
155 <xs:choice>
156 <xs:element name="probe_attributes" type="event_probe_attributes_type" />
157 <xs:element name="function_attributes" type="event_ftrace_attributes_type" />
158 </xs:choice>
159 </xs:complexType>
160
161 <!-- Maps to lttng_event struct -->
162 <xs:complexType name="event_type">
163 <xs:all>
164 <xs:element name="type" type="event_type_type" default="TRACEPOINT" minOccurs="0" />
165 <xs:element name="name" type="name_type" minOccurs="0" />
166 <xs:element name="loglevel_type" type="loglevel_type" default="ALL" minOccurs="0" />
167 <xs:element name="loglevel" type="loglevel_string_type" default="" minOccurs="0" />
168 <xs:element name="enabled" type="xs:boolean" default="false" minOccurs="0" />
169 <xs:element name="filter" type="xs:boolean" minOccurs="0" />
170 <xs:element name="exclusion" type="xs:boolean" minOccurs="0" />
171 <xs:element name="attributes" type="event_attributes_type" minOccurs="0" />
172 <xs:element name="event_fields" type="event_fields_type" minOccurs="0" />
173 </xs:all>
174 </xs:complexType>
175
176 <!-- Maps to mi_lttng_version struct -->
177 <xs:complexType name="version_type">
178 <xs:all>
179 <xs:element name="name" type="name_type" />
180 <xs:element name="string" type="name_type" />
181 <xs:element name="major" type="uint32_type" />
182 <xs:element name="url" type="xs:string" />
183 <xs:element name="minor" type="uint32_type" />
314d5222 184 <xs:element name="commit" type="xs:string" />
c5e38b74
JR
185 <xs:element name="license" type="xs:string" />
186 <xs:element name="patchLevel" type="uint32_type" />
187 <xs:element name="description" type="xs:string" />
188 </xs:all>
189 </xs:complexType>
190
191 <xs:complexType name="event_list_type">
192 <xs:sequence>
193 <xs:element name="event" type="event_type" minOccurs="0" maxOccurs="unbounded" />
194 </xs:sequence>
195 </xs:complexType>
196
197 <!-- Maps to the lttng_domain_type enum -->
198 <xs:simpleType name="domain_type_type">
199 <xs:restriction base="xs:string">
200 <xs:enumeration value="KERNEL"/>
201 <xs:enumeration value="UST"/>
202 <xs:enumeration value="JUL"/>
203 </xs:restriction>
204 </xs:simpleType>
205
206 <!-- Maps to the lttng_buffer_type enum -->
207 <xs:simpleType name="domain_buffer_type">
208 <xs:restriction base="xs:string">
209 <xs:enumeration value="PER_PID"/>
210 <xs:enumeration value="PER_UID"/>
211 <xs:enumeration value="GLOBAL"/>
212 </xs:restriction>
213 </xs:simpleType>
214
215 <xs:simpleType name="channel_overwrite_mode_type">
216 <xs:restriction base="xs:string">
217 <xs:enumeration value="DISCARD" />
218 <xs:enumeration value="OVERWRITE" />
219 </xs:restriction>
220 </xs:simpleType>
221
222 <!-- Maps to the lttng_event_output enum -->
223 <xs:simpleType name="event_output_type">
224 <xs:restriction base="xs:string">
225 <xs:enumeration value="SPLICE" />
226 <xs:enumeration value="MMAP" />
227 </xs:restriction>
228 </xs:simpleType>
229
230 <xs:complexType name="pid_type">
231 <xs:all>
232 <xs:element name="id" type="xs:int"/>
233 <xs:element name="name" type="name_type"/>
234 <xs:element name="events" type="event_list_type" minOccurs="0" />
235 </xs:all>
236 </xs:complexType>
237
238 <xs:complexType name="pids_type">
239 <xs:sequence>
240 <xs:element name="pid" type="pid_type" minOccurs="0" maxOccurs="unbounded" />
241 </xs:sequence>
242 </xs:complexType>
243
244 <!-- Maps to struct lttng_domain and contains channels -->
245 <xs:complexType name="domain_type">
246 <xs:all>
247 <xs:element name="type" type="domain_type_type"/>
7e66b1b0 248 <xs:element name="buffer_type" type="domain_buffer_type" />
c5e38b74
JR
249 <xs:element name="pids" type="pids_type" minOccurs="0" />
250 <xs:element name="channels" type="channels_type" minOccurs="0" />
251 <xs:element name="events" type="event_list_type" minOccurs="0" />
252 </xs:all>
253 </xs:complexType>
254
255 <!-- Maps to struct lttng_channel -->
256 <xs:complexType name="channel_type">
257 <xs:all>
258 <xs:element name="name" type="name_type"/>
259 <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0"/>
260 <xs:element name="attributes" type="channel_attributes_type" minOccurs="0"/>
261 <xs:element name="events" type="event_list_type"/>
262 </xs:all>
263 </xs:complexType>
264
265 <!-- Maps to struct lttng_channel_attr -->
266 <xs:complexType name="channel_attributes_type">
267 <xs:all>
268 <xs:element name="overwrite_mode" type="channel_overwrite_mode_type" default="DISCARD" minOccurs="0"/>
269 <xs:element name="subbuffer_size" type="uint64_type" minOccurs="0"/> <!-- bytes -->
270 <xs:element name="subbuffer_count" type="uint64_type" default="4" minOccurs="0"/>
271 <xs:element name="switch_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
272 <xs:element name="read_timer_interval" type="uint32_type"/> <!-- usec -->
273 <xs:element name="output_type" type="event_output_type"/>
274 <xs:element name="tracefile_size" type="uint64_type" default="0" minOccurs="0"/> <!-- bytes -->
275 <xs:element name="tracefile_count" type="uint64_type" default="0" minOccurs="0"/>
276 <xs:element name="live_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
277 </xs:all>
278 </xs:complexType>
279
280 <xs:complexType name="channels_type">
281 <xs:sequence>
282 <xs:element name="channel" type="channel_type" minOccurs="0" maxOccurs="unbounded" />
283 </xs:sequence>
284 </xs:complexType>
285
286 <xs:complexType name="session_type">
287 <xs:all>
288 <xs:element name="name" type="name_type" />
1734c658
JRJ
289 <xs:element name="path" type="name_type" minOccurs="0" />
290 <xs:element name="enabled" type="xs:boolean" default="false" minOccurs="0" />
291 <xs:element name="snapshot_mode" type="uint32_type" minOccurs="0" />
292 <xs:element name="live_timer_interval" type="uint32_type" minOccurs="0" />
c5e38b74
JR
293 <xs:element name="channels" type="channels_type" minOccurs="0" />
294 <xs:element name="domains" type="domains_type" minOccurs="0" />
295 </xs:all>
296 </xs:complexType>
297
298 <xs:complexType name="event_field_type">
299 <xs:all>
300 <xs:element name="name" type="name_type" />
301 <xs:element name="type" type="event_field_type_type"/>
302 <xs:element name="nowrite" type="xs:int"/>
303 </xs:all>
304 </xs:complexType>
305
1734c658
JRJ
306 <!-- map to the save command -->
307 <xs:complexType name="save_type">
308 <xs:all>
309 <xs:element name="session" type="session_type" />
310 <xs:element name="path" type="name_type"/>
311 </xs:all>
312 </xs:complexType>
313
314 <!-- map to the load command -->
315 <xs:complexType name="load_type">
316 <xs:all>
317 <xs:element name="session" type="session_type" />
318 <xs:element name="path" type="name_type"/>
319 </xs:all>
320 </xs:complexType>
c5e38b74 321
7e66b1b0
JRJ
322 <!-- Maps to struct lttng_calibrate -->
323 <xs:complexType name="calibrate_type">
324 <xs:all>
325 <xs:element name="type" type="calibrate_type_type" />
326 </xs:all>
327 </xs:complexType>
328
89b72577
JRJ
329 <!-- Map to lttng_event_perf_counter_ctx -->
330 <xs:complexType name="perf_counter_context_type">
331 <xs:all>
332 <xs:element name="type" type="uint32_type" />
333 <xs:element name="config" type="uint64_type" />
334 <xs:element name="name" type="name_type" />
335 </xs:all>
336 </xs:complexType>
337
338 <!-- Map to lttng_event_context -->
339 <xs:complexType name="context_type">
340 <xs:all>
341 <xs:element name="type" type="context_type_type" />
342 <xs:element name="perf_counter_context" type="perf_counter_context_type" minOccurs="0" />
343 <!-- The success element is present only for lttng cli command add-context -->
344 <xs:element name="success" type="xs:boolean" default="false" minOccurs="0" />
345 </xs:all>
346 </xs:complexType>
347
c5e38b74
JR
348 <xs:complexType name="domains_type">
349 <xs:sequence>
350 <xs:element name="domain" type="domain_type" minOccurs="0" maxOccurs="unbounded" />
351 </xs:sequence>
352 </xs:complexType>
353
354 <xs:complexType name="sessions_type">
355 <xs:sequence>
356 <xs:element name="session" type="session_type" minOccurs="0" maxOccurs="unbounded" />
357 </xs:sequence>
358 </xs:complexType>
359
360 <xs:complexType name="event_fields_type">
361 <xs:sequence>
362 <xs:element name="event_field" type="event_field_type" minOccurs="0" maxOccurs="unbounded" />
363 </xs:sequence>
364 </xs:complexType>
365
89b72577
JRJ
366 <xs:complexType name="contexts_type">
367 <xs:sequence>
368 <xs:element name="context" type="context_type" minOccurs="0" maxOccurs="unbounded" />
369 </xs:sequence>
370 </xs:complexType>
371
c5e38b74
JR
372 <xs:complexType name="output_type">
373 <xs:choice>
374 <xs:element name="domains" type="domains_type" minOccurs="0" />
375 <xs:element name="sessions" type="sessions_type" minOccurs="0" />
37d03ff7 376 <xs:element name="session" type="session_type" minOccurs="0" />
c5e38b74 377 <xs:element name="version" type="version_type" minOccurs="0" />
1734c658
JRJ
378 <xs:element name="save" type="save_type" minOccurs="0" />
379 <xs:element name="load" type="load_type" minOccurs="0" />
7e66b1b0 380 <xs:element name="calibrate" type="calibrate_type" minOccurs="0" />
89b72577 381 <xs:element name="contexts" type="contexts_type" minOccurs="0" />
c5e38b74
JR
382 </xs:choice>
383 </xs:complexType>
384
385 <!-- Maps to the mi_lttng commands -->
386 <xs:simpleType name="command_string_type">
387 <xs:restriction base="xs:string">
37d03ff7 388 <xs:enumeration value="create" />
c5e38b74
JR
389 <xs:enumeration value="list" />
390 <xs:enumeration value="version" />
1734c658
JRJ
391 <xs:enumeration value="save" />
392 <xs:enumeration value="load" />
1cfc0bc8 393 <xs:enumeration value="start" />
e5b83100 394 <xs:enumeration value="stop" />
65f25c66 395 <xs:enumeration value="destroy" />
7e66b1b0 396 <xs:enumeration value="calibrate" />
89b72577 397 <xs:enumeration value="add-context" />
c5e38b74
JR
398 </xs:restriction>
399 </xs:simpleType>
400
401 <xs:element name="command">
402 <xs:complexType>
403 <xs:all>
404 <xs:element name="name" type="command_string_type" maxOccurs="1" />
405 <xs:element name="output" type="output_type" maxOccurs="1" />
1734c658 406 <xs:element name="success" type="xs:boolean" minOccurs="0" maxOccurs="1" />
c5e38b74
JR
407 </xs:all>
408 </xs:complexType>
409 </xs:element>
410</xs:schema>
This page took 0.039358 seconds and 4 git commands to generate.