projects / lttng-tools.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Mi disable-channel 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
89476427
JRJ		 161 <xs:complexType name="event_exclusion_list_type">
162 <xs:sequence>
163 <xs:element name="exclusion" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
164 </xs:sequence>
165 </xs:complexType>
166
c5e38b74
JR		 167 <!-- Maps to lttng_event struct -->
168 <xs:complexType name="event_type">
169 <xs:all>
170 <xs:element name="type" type="event_type_type" default="TRACEPOINT" minOccurs="0" />
171 <xs:element name="name" type="name_type" minOccurs="0" />
172 <xs:element name="loglevel_type" type="loglevel_type" default="ALL" minOccurs="0" />
173 <xs:element name="loglevel" type="loglevel_string_type" default="" minOccurs="0" />
174 <xs:element name="enabled" type="xs:boolean" default="false" minOccurs="0" />
175 <xs:element name="filter" type="xs:boolean" minOccurs="0" />
176 <xs:element name="exclusion" type="xs:boolean" minOccurs="0" />
89476427 177 <xs:element name="exclusions" type="event_exclusion_list_type" minOccurs="0"/>
c5e38b74
JR		 178 <xs:element name="attributes" type="event_attributes_type" minOccurs="0" />
179 <xs:element name="event_fields" type="event_fields_type" minOccurs="0" />
89476427 180 <xs:element name="success" type="xs:boolean" minOccurs="0" />
c5e38b74
JR		 181 </xs:all>
182 </xs:complexType>
183
184 <!-- Maps to mi_lttng_version struct -->
185 <xs:complexType name="version_type">
186 <xs:all>
187 <xs:element name="name" type="name_type" />
188 <xs:element name="string" type="name_type" />
189 <xs:element name="major" type="uint32_type" />
190 <xs:element name="url" type="xs:string" />
191 <xs:element name="minor" type="uint32_type" />
314d5222 192 <xs:element name="commit" type="xs:string" />
c5e38b74
JR		 193 <xs:element name="license" type="xs:string" />
194 <xs:element name="patchLevel" type="uint32_type" />
195 <xs:element name="description" type="xs:string" />
196 </xs:all>
197 </xs:complexType>
198
199 <xs:complexType name="event_list_type">
200 <xs:sequence>
201 <xs:element name="event" type="event_type" minOccurs="0" maxOccurs="unbounded" />
202 </xs:sequence>
203 </xs:complexType>
204
205 <!-- Maps to the lttng_domain_type enum -->
206 <xs:simpleType name="domain_type_type">
207 <xs:restriction base="xs:string">
208 <xs:enumeration value="KERNEL"/>
209 <xs:enumeration value="UST"/>
210 <xs:enumeration value="JUL"/>
211 </xs:restriction>
212 </xs:simpleType>
213
214 <!-- Maps to the lttng_buffer_type enum -->
215 <xs:simpleType name="domain_buffer_type">
216 <xs:restriction base="xs:string">
217 <xs:enumeration value="PER_PID"/>
218 <xs:enumeration value="PER_UID"/>
219 <xs:enumeration value="GLOBAL"/>
220 </xs:restriction>
221 </xs:simpleType>
222
223 <xs:simpleType name="channel_overwrite_mode_type">
224 <xs:restriction base="xs:string">
225 <xs:enumeration value="DISCARD" />
226 <xs:enumeration value="OVERWRITE" />
227 </xs:restriction>
228 </xs:simpleType>
229
230 <!-- Maps to the lttng_event_output enum -->
231 <xs:simpleType name="event_output_type">
232 <xs:restriction base="xs:string">
233 <xs:enumeration value="SPLICE" />
234 <xs:enumeration value="MMAP" />
235 </xs:restriction>
236 </xs:simpleType>
237
238 <xs:complexType name="pid_type">
239 <xs:all>
240 <xs:element name="id" type="xs:int"/>
241 <xs:element name="name" type="name_type"/>
242 <xs:element name="events" type="event_list_type" minOccurs="0" />
243 </xs:all>
244 </xs:complexType>
245
246 <xs:complexType name="pids_type">
247 <xs:sequence>
248 <xs:element name="pid" type="pid_type" minOccurs="0" maxOccurs="unbounded" />
249 </xs:sequence>
250 </xs:complexType>
251
252 <!-- Maps to struct lttng_domain and contains channels -->
253 <xs:complexType name="domain_type">
254 <xs:all>
255 <xs:element name="type" type="domain_type_type"/>
7e66b1b0 256 <xs:element name="buffer_type" type="domain_buffer_type" />
c5e38b74
JR		 257 <xs:element name="pids" type="pids_type" minOccurs="0" />
258 <xs:element name="channels" type="channels_type" minOccurs="0" />
259 <xs:element name="events" type="event_list_type" minOccurs="0" />
260 </xs:all>
261 </xs:complexType>
262
263 <!-- Maps to struct lttng_channel -->
264 <xs:complexType name="channel_type">
265 <xs:all>
266 <xs:element name="name" type="name_type"/>
267 <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0"/>
268 <xs:element name="attributes" type="channel_attributes_type" minOccurs="0"/>
e4d484a5 269 <xs:element name="events" type="event_list_type" minOccurs="0"/>
c5e38b74
JR		 270 </xs:all>
271 </xs:complexType>
272
273 <!-- Maps to struct lttng_channel_attr -->
274 <xs:complexType name="channel_attributes_type">
275 <xs:all>
276 <xs:element name="overwrite_mode" type="channel_overwrite_mode_type" default="DISCARD" minOccurs="0"/>
277 <xs:element name="subbuffer_size" type="uint64_type" minOccurs="0"/> <!-- bytes -->
278 <xs:element name="subbuffer_count" type="uint64_type" default="4" minOccurs="0"/>
279 <xs:element name="switch_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
280 <xs:element name="read_timer_interval" type="uint32_type"/> <!-- usec -->
281 <xs:element name="output_type" type="event_output_type"/>
282 <xs:element name="tracefile_size" type="uint64_type" default="0" minOccurs="0"/> <!-- bytes -->
283 <xs:element name="tracefile_count" type="uint64_type" default="0" minOccurs="0"/>
284 <xs:element name="live_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
285 </xs:all>
286 </xs:complexType>
287
50534d6f
JRJ		 288 <!-- Maps to struct lttng_snapshot_output -->
289 <xs:complexType name="snapshot_type">
290 <xs:all>
291 <xs:element name="id" type="uint32_type" minOccurs="0" />
292 <xs:element name="max_size" type="uint64_type" minOccurs="0" />
293 <xs:element name="name" type="name_type" minOccurs="0" />
294 <xs:element name="session_name" type="name_type" minOccurs="0" />
295 <xs:element name="ctrl_url" type="name_type" minOccurs="0"/>
296 <xs:element name="data_url" type="name_type" minOccurs="0"/>
297 </xs:all>
298 </xs:complexType>
299
300 <xs:complexType name="snapshots_type">
301 <xs:sequence>
302 <xs:element name="snapshot" type="snapshot_type" minOccurs="0" maxOccurs="unbounded" />
303 </xs:sequence>
304 </xs:complexType>
305
c5e38b74
JR		 306 <xs:complexType name="channels_type">
307 <xs:sequence>
308 <xs:element name="channel" type="channel_type" minOccurs="0" maxOccurs="unbounded" />
309 </xs:sequence>
310 </xs:complexType>
311
312 <xs:complexType name="session_type">
313 <xs:all>
314 <xs:element name="name" type="name_type" />
1734c658
JRJ		 315 <xs:element name="path" type="name_type" minOccurs="0" />
316 <xs:element name="enabled" type="xs:boolean" default="false" minOccurs="0" />
317 <xs:element name="snapshot_mode" type="uint32_type" minOccurs="0" />
318 <xs:element name="live_timer_interval" type="uint32_type" minOccurs="0" />
c5e38b74
JR		 319 <xs:element name="channels" type="channels_type" minOccurs="0" />
320 <xs:element name="domains" type="domains_type" minOccurs="0" />
50534d6f 321 <xs:element name="snapshots" type="snapshots_type" minOccurs="0" />
c5e38b74
JR		 322 </xs:all>
323 </xs:complexType>
324
325 <xs:complexType name="event_field_type">
326 <xs:all>
327 <xs:element name="name" type="name_type" />
328 <xs:element name="type" type="event_field_type_type"/>
329 <xs:element name="nowrite" type="xs:int"/>
330 </xs:all>
331 </xs:complexType>
332
1734c658
JRJ		 333 <!-- map to the save command -->
334 <xs:complexType name="save_type">
335 <xs:all>
336 <xs:element name="session" type="session_type" />
337 <xs:element name="path" type="name_type"/>
338 </xs:all>
339 </xs:complexType>
340
341 <!-- map to the load command -->
342 <xs:complexType name="load_type">
343 <xs:all>
344 <xs:element name="session" type="session_type" />
345 <xs:element name="path" type="name_type"/>
346 </xs:all>
347 </xs:complexType>
c5e38b74 348
7e66b1b0
JRJ		 349 <!-- Maps to struct lttng_calibrate -->
350 <xs:complexType name="calibrate_type">
351 <xs:all>
352 <xs:element name="type" type="calibrate_type_type" />
353 </xs:all>
354 </xs:complexType>
355
89b72577
JRJ		 356 <!-- Map to lttng_event_perf_counter_ctx -->
357 <xs:complexType name="perf_counter_context_type">
358 <xs:all>
359 <xs:element name="type" type="uint32_type" />
360 <xs:element name="config" type="uint64_type" />
361 <xs:element name="name" type="name_type" />
362 </xs:all>
363 </xs:complexType>
364
365 <!-- Map to lttng_event_context -->
366 <xs:complexType name="context_type">
367 <xs:all>
368 <xs:element name="type" type="context_type_type" />
369 <xs:element name="perf_counter_context" type="perf_counter_context_type" minOccurs="0" />
370 <!-- The success element is present only for lttng cli command add-context -->
371 <xs:element name="success" type="xs:boolean" default="false" minOccurs="0" />
372 </xs:all>
373 </xs:complexType>
374
c5e38b74
JR		 375 <xs:complexType name="domains_type">
376 <xs:sequence>
377 <xs:element name="domain" type="domain_type" minOccurs="0" maxOccurs="unbounded" />
378 </xs:sequence>
379 </xs:complexType>
380
381 <xs:complexType name="sessions_type">
382 <xs:sequence>
383 <xs:element name="session" type="session_type" minOccurs="0" maxOccurs="unbounded" />
384 </xs:sequence>
385 </xs:complexType>
386
387 <xs:complexType name="event_fields_type">
388 <xs:sequence>
389 <xs:element name="event_field" type="event_field_type" minOccurs="0" maxOccurs="unbounded" />
390 </xs:sequence>
391 </xs:complexType>
392
89b72577
JRJ		 393 <xs:complexType name="contexts_type">
394 <xs:sequence>
395 <xs:element name="context" type="context_type" minOccurs="0" maxOccurs="unbounded" />
396 </xs:sequence>
397 </xs:complexType>
398
50534d6f
JRJ		 399 <xs:complexType name="snapshot_action_type">
400 <xs:sequence>
401 <xs:element name="name" type="snapshot_actiontype_type" minOccurs="0" />
402 <xs:element name="output" type="output_type" minOccurs="0" />
403 </xs:sequence>
404 </xs:complexType>
405
406 <!-- Type of snapshot commands -->
407 <xs:simpleType name="snapshot_actiontype_type">
408 <xs:restriction base="xs:string">
409 <xs:enumeration value="list-output"/>
410 <xs:enumeration value="del-output"/>
411 <xs:enumeration value="add-output"/>
412 <xs:enumeration value="record-output"/>
413 </xs:restriction>
414 </xs:simpleType>
415
c5e38b74
JR		 416 <xs:complexType name="output_type">
417 <xs:choice>
418 <xs:element name="domains" type="domains_type" minOccurs="0" />
50534d6f 419 <xs:element name="session" type="session_type" minOccurs="0" />
c5e38b74 420 <xs:element name="sessions" type="sessions_type" minOccurs="0" />
37d03ff7 421 <xs:element name="session" type="session_type" minOccurs="0" />
50534d6f 422 <xs:element name="snapshot_action" type="snapshot_action_type" minOccurs="0" />
c5e38b74 423 <xs:element name="version" type="version_type" minOccurs="0" />
1734c658
JRJ		 424 <xs:element name="save" type="save_type" minOccurs="0" />
425 <xs:element name="load" type="load_type" minOccurs="0" />
7e66b1b0 426 <xs:element name="calibrate" type="calibrate_type" minOccurs="0" />
89b72577 427 <xs:element name="contexts" type="contexts_type" minOccurs="0" />
acc09215 428 <xs:element name="channels" type="channels_type" minOccurs="0" />
89476427 429 <xs:element name="events" type="event_list_type" minOccurs="0" />
e4d484a5 430 <xs:element name="channel" type="channel_type" minOccurs="0" />
50534d6f 431 <xs:element name="channels" type="channels_type" minOccurs="0" />
c5e38b74
JR		 432 </xs:choice>
433 </xs:complexType>
434
435 <!-- Maps to the mi_lttng commands -->
436 <xs:simpleType name="command_string_type">
437 <xs:restriction base="xs:string">
37d03ff7 438 <xs:enumeration value="create" />
c5e38b74 439 <xs:enumeration value="list" />
50534d6f 440 <xs:enumeration value="snapshot" />
c5e38b74 441 <xs:enumeration value="version" />
1734c658
JRJ		 442 <xs:enumeration value="save" />
443 <xs:enumeration value="load" />
1cfc0bc8 444 <xs:enumeration value="start" />
e5b83100 445 <xs:enumeration value="stop" />
65f25c66 446 <xs:enumeration value="destroy" />
7e66b1b0 447 <xs:enumeration value="calibrate" />
89b72577 448 <xs:enumeration value="add-context" />
acc09215 449 <xs:enumeration value="enable-channel" />
89476427 450 <xs:enumeration value="enable-event" />
ce91cd0b 451 <xs:enumeration value="set-session" />
e4d484a5 452 <xs:enumeration value="disable-event" />
50534d6f 453 <xs:enumeration value="disable-channel" />
c5e38b74
JR		 454 </xs:restriction>
455 </xs:simpleType>
456
457 <xs:element name="command">
458 <xs:complexType>
459 <xs:all>
460 <xs:element name="name" type="command_string_type" maxOccurs="1" />
461 <xs:element name="output" type="output_type" maxOccurs="1" />
1734c658 462 <xs:element name="success" type="xs:boolean" minOccurs="0" maxOccurs="1" />
c5e38b74
JR		 463 </xs:all>
464 </xs:complexType>
465 </xs:element>
466</xs:schema>
LTTng tools - Deliverables
This page took 0.04373 seconds and 5 git commands to generate.