Fix typos in error descriptions
[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"
847a5916 24elementFormDefault="qualified" version="2.7">
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
46<xs:simpleType name="channel_overwrite_mode_type">
47 <xs:restriction base="xs:string">
48 <xs:enumeration value="DISCARD"/>
49 <xs:enumeration value="OVERWRITE"/>
50 </xs:restriction>
51</xs:simpleType>
52
53<!-- Maps to the lttng_event_output enum -->
54<xs:simpleType name="event_output_type">
55 <xs:restriction base="xs:string">
56 <xs:enumeration value="SPLICE"/>
57 <xs:enumeration value="MMAP"/>
58 </xs:restriction>
59</xs:simpleType>
60
61<!-- Maps to the lttng_loglevel_type enum -->
62<xs:simpleType name="loglevel_type">
63 <xs:restriction base="xs:string">
64 <xs:enumeration value="ALL"/>
65 <xs:enumeration value="RANGE"/>
66 <xs:enumeration value="SINGLE"/>
67 </xs:restriction>
68</xs:simpleType>
69
70<!-- Maps to the lttng_event_type enum -->
71<xs:simpleType name="event_type_type">
72 <xs:restriction base="xs:string">
73 <xs:enumeration value="ALL"/>
74 <xs:enumeration value="TRACEPOINT"/>
75 <xs:enumeration value="PROBE"/>
76 <xs:enumeration value="FUNCTION"/>
77 <xs:enumeration value="FUNCTION_ENTRY"/>
78 <xs:enumeration value="NOOP"/>
79 <xs:enumeration value="SYSCALL"/>
80 <xs:enumeration value="KPROBE"/>
81 <xs:enumeration value="KRETPROBE"/>
82 </xs:restriction>
83</xs:simpleType>
84
85<xs:complexType name="event_probe_attributes_type">
86 <xs:all>
87 <xs:element name="symbol_name" type="name_type" minOccurs="0"/>
88 <xs:element name="address" type="uint64_type" minOccurs="0"/>
89 <xs:element name="offset" type="uint64_type" minOccurs="0"/>
90 </xs:all>
91</xs:complexType>
92
93<xs:complexType name="event_ftrace_attributes_type">
94 <xs:all>
95 <xs:element name="symbol_name" type="name_type"/>
96 </xs:all>
97</xs:complexType>
98
99<xs:complexType name="event_attributes_type">
100 <xs:choice>
101 <xs:element name="probe_attributes" type="event_probe_attributes_type"/>
102 <xs:element name="function_attributes" type="event_ftrace_attributes_type"/>
103 </xs:choice>
104</xs:complexType>
105
106<xs:complexType name="event_exclusion_list_type">
107 <xs:sequence>
108 <xs:element name="exclusion" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
109 </xs:sequence>
110</xs:complexType>
111
112<xs:complexType name="event_type">
113 <xs:all>
114 <xs:element name="name" type="name_type" minOccurs="0"/>
115 <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0"/>
116 <xs:element name="type" type="event_type_type" default="TRACEPOINT" minOccurs="0"/>
117 <xs:element name="loglevel_type" type="loglevel_type" default="ALL" minOccurs="0"/>
118 <xs:element name="loglevel" type="xs:int" default="-1" minOccurs="0"/>
119 <xs:element name="filter" type="xs:string" minOccurs="0"/>
120 <xs:element name="exclusions" type="event_exclusion_list_type" minOccurs="0"/>
121 <xs:element name="attributes" type="event_attributes_type" minOccurs="0"/>
122 </xs:all>
123</xs:complexType>
124
125<xs:complexType name="event_list_type">
126 <xs:sequence>
127 <xs:element name="event" type="event_type" minOccurs="0" maxOccurs="unbounded"/>
128 </xs:sequence>
129</xs:complexType>
130
131<xs:complexType name="event_perf_context_type">
132 <xs:all>
133 <xs:element name="type" type="uint32_type"/>
134 <xs:element name="config" type="uint64_type"/>
135 <xs:element name="name" type="name_type"/>
136 </xs:all>
137</xs:complexType>
138
139<!-- Maps to the lttng_event_context_type enum -->
140<xs:simpleType name="event_context_type_type">
141 <xs:restriction base="xs:string">
142 <xs:enumeration value="PID"/>
143 <xs:enumeration value="PROCNAME"/>
144 <xs:enumeration value="PRIO"/>
145 <xs:enumeration value="NICE"/>
146 <xs:enumeration value="VPID"/>
147 <xs:enumeration value="TID"/>
148 <xs:enumeration value="VTID"/>
149 <xs:enumeration value="PPID"/>
150 <xs:enumeration value="VPPID"/>
151 <xs:enumeration value="PTHREAD_ID"/>
152 <xs:enumeration value="HOSTNAME"/>
153 <xs:enumeration value="IP"/>
154 </xs:restriction>
155</xs:simpleType>
156
157<xs:complexType name="event_context_type">
158 <xs:choice>
159 <xs:element name="type" type="event_context_type_type"/>
160 <xs:element name="perf" type="event_perf_context_type"/>
161 </xs:choice>
162</xs:complexType>
163
164<xs:complexType name="event_context_list_type">
165 <xs:sequence>
166 <xs:element name="context" type="event_context_type" minOccurs="0" maxOccurs="unbounded"/>
167 </xs:sequence>
168</xs:complexType>
169
170<!-- Maps to struct lttng_channel -->
171<xs:complexType name="channel_type">
172 <xs:all>
173 <xs:element name="name" type="name_type"/>
174 <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0"/>
175 <xs:element name="overwrite_mode" type="channel_overwrite_mode_type" default="DISCARD" minOccurs="0"/>
176 <xs:element name="subbuffer_size" type="uint64_type" minOccurs="0"/> <!-- bytes -->
177 <xs:element name="subbuffer_count" type="uint64_type" default="4" minOccurs="0"/>
178 <xs:element name="switch_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
179 <xs:element name="read_timer_interval" type="uint32_type"/> <!-- usec -->
180 <xs:element name="output_type" type="event_output_type"/>
181 <xs:element name="tracefile_size" type="uint64_type" default="0" minOccurs="0"/> <!-- bytes -->
182 <xs:element name="tracefile_count" type="uint64_type" default="0" minOccurs="0"/>
183 <xs:element name="live_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
184 <xs:element name="events" type="event_list_type" minOccurs="0"/>
185 <xs:element name="contexts" type="event_context_list_type" minOccurs="0"/>
186 </xs:all>
187</xs:complexType>
188
189<!-- Maps to the lttng_domain_type enum -->
190<xs:simpleType name="domain_type_type">
191 <xs:restriction base="xs:string">
192 <xs:enumeration value="KERNEL"/>
193 <xs:enumeration value="UST"/>
194 <xs:enumeration value="JUL"/>
ff00898c 195 <xs:enumeration value="LOG4J"/>
0e115563 196 <xs:enumeration value="PYTHON"/>
629bf5b0
JG
197 </xs:restriction>
198</xs:simpleType>
199
200<!-- Maps to the lttng_buffer_type enum -->
201<xs:simpleType name="domain_buffer_type">
202 <xs:restriction base="xs:string">
203 <xs:enumeration value="PER_PID"/>
204 <xs:enumeration value="PER_UID"/>
205 <xs:enumeration value="GLOBAL"/>
206 </xs:restriction>
207</xs:simpleType>
208
209<xs:complexType name="channel_list_type">
210 <xs:sequence>
847a5916 211 <xs:element name="channel" type="channel_type" minOccurs="0" maxOccurs="unbounded" />
629bf5b0
JG
212 </xs:sequence>
213</xs:complexType>
214
847a5916
JR
215<xs:complexType name="pid_target_type">
216 <xs:all>
217 <xs:element name="pid" type="xs:integer" />
218 </xs:all>
219</xs:complexType>
220
221<!-- Maps to a list of pid_targets-->
222<xs:complexType name="targets_type">
223 <xs:sequence>
224 <xs:choice>
225 <xs:element name="pid_target" type="pid_target_type" minOccurs="0" maxOccurs="unbounded" />
226 </xs:choice>
227 </xs:sequence>
228</xs:complexType>
229
230<!-- Maps to a pid_tracker-->
231<xs:complexType name="pid_tracker_type">
232 <xs:all>
233 <xs:element name="targets" type="targets_type" />
234 </xs:all>
235</xs:complexType>
236
237<!-- Maps to a list of trackers-->
238<xs:complexType name="trackers_type">
239 <xs:sequence minOccurs="0" maxOccurs="unbounded">
240 <xs:element name="pid_tracker" type="pid_tracker_type" maxOccurs="1" />
241 </xs:sequence>
242</xs:complexType>
243
244<!-- Maps to struct lttng_domain, contains channels and pid_tracker -->
629bf5b0
JG
245<xs:complexType name="domain_type">
246 <xs:all>
247 <xs:element name="type" type="domain_type_type"/>
248 <xs:element name="buffer_type" type="domain_buffer_type"/>
249 <xs:element name="channels" type="channel_list_type" minOccurs="0"/>
847a5916 250 <xs:element name="trackers" type="trackers_type" minOccurs="0"/>
629bf5b0
JG
251 </xs:all>
252</xs:complexType>
253
254<xs:complexType name="session_attributes_type">
255 <xs:choice>
256 <xs:element name="snapshot_mode" type="xs:boolean"/>
257 <xs:element name="live_timer_interval" type="uint32_type"/> <!-- usec -->
258 </xs:choice>
259</xs:complexType>
260
261<xs:complexType name="domain_list_type">
262 <xs:sequence>
263 <xs:element name="domain" type="domain_type" minOccurs="0" maxOccurs="unbounded"/>
264 </xs:sequence>
265</xs:complexType>
266
267<xs:complexType name="net_output_type">
268 <xs:all>
269 <xs:element name="control_uri" type="xs:string"/>
270 <xs:element name="data_uri" type="xs:string"/>
271 </xs:all>
272</xs:complexType>
273
274<xs:complexType name="destination_type">
275 <xs:choice>
276 <xs:element name="path" type="xs:string"/>
277 <xs:element name="net_output" type="net_output_type"/>
278 </xs:choice>
279</xs:complexType>
280
281<xs:complexType name="consumer_output_type">
282 <xs:all>
283 <xs:element name="enabled" type="xs:boolean" default="true"/>
284 <xs:element name="destination" type="destination_type"/>
285 </xs:all>
286</xs:complexType>
287
288<xs:complexType name="snapshot_output_type">
289 <xs:all>
290 <xs:element name="name" type="name_type"/>
291 <xs:element name="max_size" type="uint64_type"/>
292 <xs:element name="consumer_output" type="consumer_output_type"/>
293 </xs:all>
294</xs:complexType>
295
296<xs:complexType name="snapshot_output_list_type">
297 <xs:sequence>
298 <xs:element name="output" type="snapshot_output_type" minOccurs="0" maxOccurs="unbounded"/>
299 </xs:sequence>
300</xs:complexType>
301
302<xs:complexType name="session_output_type">
303 <xs:choice>
304 <xs:element name="snapshot_outputs" type="snapshot_output_list_type"/>
305 <xs:element name="consumer_output" type="consumer_output_type"/>
306 </xs:choice>
307</xs:complexType>
308
309<xs:complexType name="session_type">
310 <xs:all>
311 <xs:element name="name" type="name_type"/>
9e7c9f56 312 <xs:element name="shared_memory_path" type="xs:string" minOccurs="0"/>
629bf5b0
JG
313 <xs:element name="domains" type="domain_list_type" minOccurs="0"/>
314 <xs:element name="started" type="xs:boolean" default="0" minOccurs="0"/>
315 <xs:element name="attributes" type="session_attributes_type" minOccurs="0"/>
316 <xs:element name="output" type="session_output_type" minOccurs="0"/>
317 </xs:all>
318</xs:complexType>
319
320<xs:element name="sessions">
321 <xs:complexType>
322 <xs:sequence>
323 <xs:element name="session" type="session_type" maxOccurs="unbounded"/>
324 </xs:sequence>
325 </xs:complexType>
326</xs:element>
327
328</xs:schema>
This page took 0.04393 seconds and 5 git commands to generate.