Implement lttng-list for userspace-probe
[lttng-tools.git] / src / common / config / session.xsd
CommitLineData
ebfa5166 1<?xml version="1.0" encoding="UTF-8"?>
89aac4d5
JG
2<!--
3Copyright (c) 2014 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4
5Permission is hereby granted, free of charge, to any person obtaining a copy
6of this software and associated documentation files (the "Software"), to deal
7in the Software without restriction, including without limitation the rights
8to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9copies of the Software, and to permit persons to whom the Software is
10furnished to do so, subject to the following conditions:
11
12The above copyright notice and this permission notice shall be included in
13all copies or substantial portions of the Software.
14
15THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21THE SOFTWARE.
22-->
629bf5b0 23<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
259c2674 24elementFormDefault="qualified" version="2.11">
629bf5b0
JG
25
26<xs:simpleType name="name_type">
27 <xs:restriction base="xs:string">
28 <xs:maxLength value="255"/>
29 </xs:restriction>
30</xs:simpleType>
31
32<xs:simpleType name="uint64_type">
33 <xs:restriction base="xs:integer">
34 <xs:minInclusive value="0"/>
35 <xs:maxInclusive value="18446744073709551615"/>
36 </xs:restriction>
37</xs:simpleType>
38
39<xs:simpleType name="uint32_type">
40 <xs:restriction base="xs:integer">
41 <xs:minInclusive value="0"/>
42 <xs:maxInclusive value="4294967295"/>
43 </xs:restriction>
44</xs:simpleType>
45
491d1539
MD
46<!--
47Maps to the range allowed for blocking timeout: -1 (block forever),
480 (do not block), positive integer value (blocking time in usec) limited
49by its signed 32-bit representation when converted to msec.
50-->
51<xs:simpleType name="blocking_timeout_type">
52 <xs:restriction base="xs:integer">
53 <xs:minInclusive value="-1" />
54 <xs:maxInclusive value="2147483648000" />
55 </xs:restriction>
56</xs:simpleType>
57
629bf5b0
JG
58<xs:simpleType name="channel_overwrite_mode_type">
59 <xs:restriction base="xs:string">
60 <xs:enumeration value="DISCARD"/>
61 <xs:enumeration value="OVERWRITE"/>
62 </xs:restriction>
63</xs:simpleType>
64
65<!-- Maps to the lttng_event_output enum -->
66<xs:simpleType name="event_output_type">
67 <xs:restriction base="xs:string">
68 <xs:enumeration value="SPLICE"/>
69 <xs:enumeration value="MMAP"/>
70 </xs:restriction>
71</xs:simpleType>
72
73<!-- Maps to the lttng_loglevel_type enum -->
74<xs:simpleType name="loglevel_type">
75 <xs:restriction base="xs:string">
76 <xs:enumeration value="ALL"/>
77 <xs:enumeration value="RANGE"/>
78 <xs:enumeration value="SINGLE"/>
79 </xs:restriction>
80</xs:simpleType>
81
82<!-- Maps to the lttng_event_type enum -->
83<xs:simpleType name="event_type_type">
84 <xs:restriction base="xs:string">
85 <xs:enumeration value="ALL"/>
86 <xs:enumeration value="TRACEPOINT"/>
87 <xs:enumeration value="PROBE"/>
88 <xs:enumeration value="FUNCTION"/>
89 <xs:enumeration value="FUNCTION_ENTRY"/>
90 <xs:enumeration value="NOOP"/>
91 <xs:enumeration value="SYSCALL"/>
92 <xs:enumeration value="KPROBE"/>
93 <xs:enumeration value="KRETPROBE"/>
94 </xs:restriction>
95</xs:simpleType>
96
97<xs:complexType name="event_probe_attributes_type">
98 <xs:all>
99 <xs:element name="symbol_name" type="name_type" minOccurs="0"/>
100 <xs:element name="address" type="uint64_type" minOccurs="0"/>
101 <xs:element name="offset" type="uint64_type" minOccurs="0"/>
102 </xs:all>
103</xs:complexType>
104
105<xs:complexType name="event_ftrace_attributes_type">
106 <xs:all>
107 <xs:element name="symbol_name" type="name_type"/>
108 </xs:all>
109</xs:complexType>
110
111<xs:complexType name="event_attributes_type">
112 <xs:choice>
113 <xs:element name="probe_attributes" type="event_probe_attributes_type"/>
114 <xs:element name="function_attributes" type="event_ftrace_attributes_type"/>
115 </xs:choice>
116</xs:complexType>
117
118<xs:complexType name="event_exclusion_list_type">
119 <xs:sequence>
120 <xs:element name="exclusion" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
121 </xs:sequence>
122</xs:complexType>
123
124<xs:complexType name="event_type">
125 <xs:all>
126 <xs:element name="name" type="name_type" minOccurs="0"/>
127 <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0"/>
128 <xs:element name="type" type="event_type_type" default="TRACEPOINT" minOccurs="0"/>
129 <xs:element name="loglevel_type" type="loglevel_type" default="ALL" minOccurs="0"/>
130 <xs:element name="loglevel" type="xs:int" default="-1" minOccurs="0"/>
131 <xs:element name="filter" type="xs:string" minOccurs="0"/>
132 <xs:element name="exclusions" type="event_exclusion_list_type" minOccurs="0"/>
133 <xs:element name="attributes" type="event_attributes_type" minOccurs="0"/>
134 </xs:all>
135</xs:complexType>
136
137<xs:complexType name="event_list_type">
138 <xs:sequence>
139 <xs:element name="event" type="event_type" minOccurs="0" maxOccurs="unbounded"/>
140 </xs:sequence>
141</xs:complexType>
142
143<xs:complexType name="event_perf_context_type">
144 <xs:all>
145 <xs:element name="type" type="uint32_type"/>
146 <xs:element name="config" type="uint64_type"/>
147 <xs:element name="name" type="name_type"/>
148 </xs:all>
149</xs:complexType>
150
045fc617
JG
151<xs:complexType name="event_app_context_type">
152 <xs:all>
153 <xs:element name="provider_name" type="xs:string"/>
154 <xs:element name="ctx_name" type="xs:string"/>
155 </xs:all>
156</xs:complexType>
157
629bf5b0
JG
158<!-- Maps to the lttng_event_context_type enum -->
159<xs:simpleType name="event_context_type_type">
160 <xs:restriction base="xs:string">
161 <xs:enumeration value="PID"/>
162 <xs:enumeration value="PROCNAME"/>
163 <xs:enumeration value="PRIO"/>
164 <xs:enumeration value="NICE"/>
165 <xs:enumeration value="VPID"/>
166 <xs:enumeration value="TID"/>
167 <xs:enumeration value="VTID"/>
168 <xs:enumeration value="PPID"/>
169 <xs:enumeration value="VPPID"/>
170 <xs:enumeration value="PTHREAD_ID"/>
171 <xs:enumeration value="HOSTNAME"/>
172 <xs:enumeration value="IP"/>
045fc617 173 <xs:enumeration value="APP"/>
c460810b
FD
174 <xs:enumeration value="INTERRUPTIBLE" />
175 <xs:enumeration value="PREEMPTIBLE" />
176 <xs:enumeration value="NEED_RESCHEDULE" />
177 <xs:enumeration value="MIGRATABLE" />
16c4c991
FD
178 <xs:enumeration value="CALLSTACK_USER" />
179 <xs:enumeration value="CALLSTACK_KERNEL" />
629bf5b0
JG
180 </xs:restriction>
181</xs:simpleType>
182
183<xs:complexType name="event_context_type">
184 <xs:choice>
185 <xs:element name="type" type="event_context_type_type"/>
186 <xs:element name="perf" type="event_perf_context_type"/>
045fc617 187 <xs:element name="app" type="event_app_context_type"/>
629bf5b0
JG
188 </xs:choice>
189</xs:complexType>
190
191<xs:complexType name="event_context_list_type">
192 <xs:sequence>
193 <xs:element name="context" type="event_context_type" minOccurs="0" maxOccurs="unbounded"/>
194 </xs:sequence>
195</xs:complexType>
196
197<!-- Maps to struct lttng_channel -->
198<xs:complexType name="channel_type">
199 <xs:all>
200 <xs:element name="name" type="name_type"/>
201 <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0"/>
202 <xs:element name="overwrite_mode" type="channel_overwrite_mode_type" default="DISCARD" minOccurs="0"/>
203 <xs:element name="subbuffer_size" type="uint64_type" minOccurs="0"/> <!-- bytes -->
204 <xs:element name="subbuffer_count" type="uint64_type" default="4" minOccurs="0"/>
205 <xs:element name="switch_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
206 <xs:element name="read_timer_interval" type="uint32_type"/> <!-- usec -->
491d1539 207 <xs:element name="blocking_timeout" type="blocking_timeout_type" default="0" minOccurs="0" /> <!-- usec -->
629bf5b0
JG
208 <xs:element name="output_type" type="event_output_type"/>
209 <xs:element name="tracefile_size" type="uint64_type" default="0" minOccurs="0"/> <!-- bytes -->
210 <xs:element name="tracefile_count" type="uint64_type" default="0" minOccurs="0"/>
211 <xs:element name="live_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
212 <xs:element name="events" type="event_list_type" minOccurs="0"/>
213 <xs:element name="contexts" type="event_context_list_type" minOccurs="0"/>
4fc2b126 214 <xs:element name="monitor_timer_interval" type="uint64_type" default="0" minOccurs="0"/> <!-- usec -->
629bf5b0
JG
215 </xs:all>
216</xs:complexType>
217
218<!-- Maps to the lttng_domain_type enum -->
219<xs:simpleType name="domain_type_type">
220 <xs:restriction base="xs:string">
221 <xs:enumeration value="KERNEL"/>
222 <xs:enumeration value="UST"/>
223 <xs:enumeration value="JUL"/>
ff00898c 224 <xs:enumeration value="LOG4J"/>
0e115563 225 <xs:enumeration value="PYTHON"/>
629bf5b0
JG
226 </xs:restriction>
227</xs:simpleType>
228
229<!-- Maps to the lttng_buffer_type enum -->
230<xs:simpleType name="domain_buffer_type">
231 <xs:restriction base="xs:string">
232 <xs:enumeration value="PER_PID"/>
233 <xs:enumeration value="PER_UID"/>
234 <xs:enumeration value="GLOBAL"/>
235 </xs:restriction>
236</xs:simpleType>
237
238<xs:complexType name="channel_list_type">
239 <xs:sequence>
847a5916 240 <xs:element name="channel" type="channel_type" minOccurs="0" maxOccurs="unbounded" />
629bf5b0
JG
241 </xs:sequence>
242</xs:complexType>
243
847a5916
JR
244<xs:complexType name="pid_target_type">
245 <xs:all>
246 <xs:element name="pid" type="xs:integer" />
247 </xs:all>
248</xs:complexType>
249
250<!-- Maps to a list of pid_targets-->
251<xs:complexType name="targets_type">
252 <xs:sequence>
253 <xs:choice>
254 <xs:element name="pid_target" type="pid_target_type" minOccurs="0" maxOccurs="unbounded" />
255 </xs:choice>
256 </xs:sequence>
257</xs:complexType>
258
259<!-- Maps to a pid_tracker-->
260<xs:complexType name="pid_tracker_type">
261 <xs:all>
262 <xs:element name="targets" type="targets_type" />
263 </xs:all>
264</xs:complexType>
265
266<!-- Maps to a list of trackers-->
267<xs:complexType name="trackers_type">
268 <xs:sequence minOccurs="0" maxOccurs="unbounded">
269 <xs:element name="pid_tracker" type="pid_tracker_type" maxOccurs="1" />
270 </xs:sequence>
271</xs:complexType>
272
273<!-- Maps to struct lttng_domain, contains channels and pid_tracker -->
629bf5b0
JG
274<xs:complexType name="domain_type">
275 <xs:all>
276 <xs:element name="type" type="domain_type_type"/>
277 <xs:element name="buffer_type" type="domain_buffer_type"/>
278 <xs:element name="channels" type="channel_list_type" minOccurs="0"/>
847a5916 279 <xs:element name="trackers" type="trackers_type" minOccurs="0"/>
629bf5b0
JG
280 </xs:all>
281</xs:complexType>
282
ce6176f2
JG
283<xs:complexType name="periodic_rotation_schedule_type">
284 <xs:all>
285 <xs:element name="time_us" type="uint64_type" minOccurs="0" />
286 </xs:all>
287</xs:complexType>
288
289<xs:complexType name="size_threshold_rotation_schedule_type">
290 <xs:all>
291 <xs:element name="bytes" type="uint64_type" minOccurs="0" />
292 </xs:all>
293</xs:complexType>
294
295<xs:complexType name="rotation_schedule_type">
296 <xs:sequence>
297 <xs:choice maxOccurs="unbounded">
298 <xs:element name="periodic" type="periodic_rotation_schedule_type" maxOccurs="unbounded" />
299 <xs:element name="size_threshold" type="size_threshold_rotation_schedule_type" maxOccurs="unbounded" />
300 </xs:choice>
301 </xs:sequence>
302</xs:complexType>
303
629bf5b0 304<xs:complexType name="session_attributes_type">
259c2674
JD
305 <xs:all>
306 <xs:element name="snapshot_mode" type="xs:boolean" minOccurs="0"/>
307 <xs:element name="live_timer_interval" type="uint32_type" minOccurs="0"/> <!-- usec -->
ce6176f2 308 <xs:element name="rotation_schedules" type="rotation_schedule_type" minOccurs="0" />
259c2674 309 </xs:all>
629bf5b0
JG
310</xs:complexType>
311
312<xs:complexType name="domain_list_type">
313 <xs:sequence>
314 <xs:element name="domain" type="domain_type" minOccurs="0" maxOccurs="unbounded"/>
315 </xs:sequence>
316</xs:complexType>
317
318<xs:complexType name="net_output_type">
319 <xs:all>
320 <xs:element name="control_uri" type="xs:string"/>
321 <xs:element name="data_uri" type="xs:string"/>
322 </xs:all>
323</xs:complexType>
324
325<xs:complexType name="destination_type">
326 <xs:choice>
327 <xs:element name="path" type="xs:string"/>
328 <xs:element name="net_output" type="net_output_type"/>
329 </xs:choice>
330</xs:complexType>
331
332<xs:complexType name="consumer_output_type">
333 <xs:all>
334 <xs:element name="enabled" type="xs:boolean" default="true"/>
335 <xs:element name="destination" type="destination_type"/>
336 </xs:all>
337</xs:complexType>
338
339<xs:complexType name="snapshot_output_type">
340 <xs:all>
341 <xs:element name="name" type="name_type"/>
342 <xs:element name="max_size" type="uint64_type"/>
343 <xs:element name="consumer_output" type="consumer_output_type"/>
344 </xs:all>
345</xs:complexType>
346
347<xs:complexType name="snapshot_output_list_type">
348 <xs:sequence>
349 <xs:element name="output" type="snapshot_output_type" minOccurs="0" maxOccurs="unbounded"/>
350 </xs:sequence>
351</xs:complexType>
352
353<xs:complexType name="session_output_type">
354 <xs:choice>
355 <xs:element name="snapshot_outputs" type="snapshot_output_list_type"/>
356 <xs:element name="consumer_output" type="consumer_output_type"/>
357 </xs:choice>
358</xs:complexType>
359
360<xs:complexType name="session_type">
361 <xs:all>
362 <xs:element name="name" type="name_type"/>
9e7c9f56 363 <xs:element name="shared_memory_path" type="xs:string" minOccurs="0"/>
629bf5b0
JG
364 <xs:element name="domains" type="domain_list_type" minOccurs="0"/>
365 <xs:element name="started" type="xs:boolean" default="0" minOccurs="0"/>
366 <xs:element name="attributes" type="session_attributes_type" minOccurs="0"/>
367 <xs:element name="output" type="session_output_type" minOccurs="0"/>
368 </xs:all>
369</xs:complexType>
370
371<xs:element name="sessions">
372 <xs:complexType>
373 <xs:sequence>
374 <xs:element name="session" type="session_type" maxOccurs="unbounded"/>
375 </xs:sequence>
376 </xs:complexType>
377</xs:element>
378
379</xs:schema>
This page took 0.048215 seconds and 4 git commands to generate.