src/common/config/session.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3 Copyright (c) 2014 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   4
   5 Permission is hereby granted, free of charge, to any person obtaining a copy
   6 of this software and associated documentation files (the "Software"), to deal
   7 in the Software without restriction, including without limitation the rights
   8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 copies of the Software, and to permit persons to whom the Software is
  10 furnished to do so, subject to the following conditions:
  11
  12 The above copyright notice and this permission notice shall be included in
  13 all copies or substantial portions of the Software.
  14
  15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 THE SOFTWARE.
  22 -->
  23 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
  24 elementFormDefault="qualified" version="2.8">
  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 <xs:complexType name="event_app_context_type">
 140         <xs:all>
 141           <xs:element name="provider_name" type="xs:string"/>
 142           <xs:element name="ctx_name" type="xs:string"/>
 143         </xs:all>
 144 </xs:complexType>
 145
 146 <!-- Maps to the lttng_event_context_type enum -->
 147 <xs:simpleType name="event_context_type_type">
 148         <xs:restriction base="xs:string">
 149                 <xs:enumeration value="PID"/>
 150                 <xs:enumeration value="PROCNAME"/>
 151                 <xs:enumeration value="PRIO"/>
 152                 <xs:enumeration value="NICE"/>
 153                 <xs:enumeration value="VPID"/>
 154                 <xs:enumeration value="TID"/>
 155                 <xs:enumeration value="VTID"/>
 156                 <xs:enumeration value="PPID"/>
 157                 <xs:enumeration value="VPPID"/>
 158                 <xs:enumeration value="PTHREAD_ID"/>
 159                 <xs:enumeration value="HOSTNAME"/>
 160                 <xs:enumeration value="IP"/>
 161                 <xs:enumeration value="APP"/>
 162                 <xs:enumeration value="INTERRUPTIBLE" />
 163                 <xs:enumeration value="PREEMPTIBLE" />
 164                 <xs:enumeration value="NEED_RESCHEDULE" />
 165                 <xs:enumeration value="MIGRATABLE" />
 166         </xs:restriction>
 167 </xs:simpleType>
 168
 169 <xs:complexType name="event_context_type">
 170         <xs:choice>
 171                 <xs:element name="type" type="event_context_type_type"/>
 172                 <xs:element name="perf" type="event_perf_context_type"/>
 173                 <xs:element name="app" type="event_app_context_type"/>
 174         </xs:choice>
 175 </xs:complexType>
 176
 177 <xs:complexType name="event_context_list_type">
 178         <xs:sequence>
 179                 <xs:element name="context" type="event_context_type" minOccurs="0" maxOccurs="unbounded"/>
 180         </xs:sequence>
 181 </xs:complexType>
 182
 183 <!-- Maps to struct lttng_channel -->
 184 <xs:complexType name="channel_type">
 185         <xs:all>
 186                 <xs:element name="name" type="name_type"/>
 187                 <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0"/>
 188                 <xs:element name="overwrite_mode" type="channel_overwrite_mode_type" default="DISCARD" minOccurs="0"/>
 189                 <xs:element name="subbuffer_size" type="uint64_type" minOccurs="0"/> <!-- bytes -->
 190                 <xs:element name="subbuffer_count" type="uint64_type" default="4" minOccurs="0"/>
 191                 <xs:element name="switch_timer_interval" type="uint32_type" default="0" minOccurs="0"/>  <!-- usec -->
 192                 <xs:element name="read_timer_interval" type="uint32_type"/>  <!-- usec -->
 193                 <xs:element name="output_type" type="event_output_type"/>
 194                 <xs:element name="tracefile_size" type="uint64_type" default="0" minOccurs="0"/> <!-- bytes -->
 195                 <xs:element name="tracefile_count" type="uint64_type" default="0" minOccurs="0"/>
 196                 <xs:element name="live_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
 197                 <xs:element name="events" type="event_list_type" minOccurs="0"/>
 198                 <xs:element name="contexts" type="event_context_list_type" minOccurs="0"/>
 199         </xs:all>
 200 </xs:complexType>
 201
 202 <!-- Maps to the lttng_domain_type enum -->
 203 <xs:simpleType name="domain_type_type">
 204         <xs:restriction base="xs:string">
 205                 <xs:enumeration value="KERNEL"/>
 206                 <xs:enumeration value="UST"/>
 207                 <xs:enumeration value="JUL"/>
 208                 <xs:enumeration value="LOG4J"/>
 209                 <xs:enumeration value="PYTHON"/>
 210         </xs:restriction>
 211 </xs:simpleType>
 212
 213 <!-- Maps to the lttng_buffer_type enum -->
 214 <xs:simpleType name="domain_buffer_type">
 215         <xs:restriction base="xs:string">
 216                 <xs:enumeration value="PER_PID"/>
 217                 <xs:enumeration value="PER_UID"/>
 218                 <xs:enumeration value="GLOBAL"/>
 219         </xs:restriction>
 220 </xs:simpleType>
 221
 222 <xs:complexType name="channel_list_type">
 223         <xs:sequence>
 224                 <xs:element name="channel" type="channel_type" minOccurs="0" maxOccurs="unbounded" />
 225         </xs:sequence>
 226 </xs:complexType>
 227
 228 <xs:complexType name="pid_target_type">
 229         <xs:choice minOccurs="0">
 230                 <xs:element name="pid" type="xs:integer" />
 231                 <xs:element name="id" type="xs:integer" />
 232         </xs:choice>
 233 </xs:complexType>
 234
 235 <!-- Maps to a list of pid_targets-->
 236 <xs:complexType name="pid_targets_type">
 237         <xs:sequence>
 238                 <xs:choice minOccurs="0" maxOccurs="unbounded" >
 239                         <xs:element name="pid_target" type="pid_target_type" />
 240                 </xs:choice>
 241         </xs:sequence>
 242 </xs:complexType>
 243
 244 <!-- Maps to a pid_tracker-->
 245 <xs:complexType name="pid_tracker_type">
 246         <xs:all>
 247                 <xs:element name="targets" type="pid_targets_type" />
 248         </xs:all>
 249 </xs:complexType>
 250
 251 <xs:complexType name="vpid_target_type">
 252         <xs:all>
 253                 <xs:element name="id" type="xs:integer" />
 254         </xs:all>
 255 </xs:complexType>
 256
 257 <!-- Maps to a list of vpid_targets-->
 258 <xs:complexType name="vpid_targets_type">
 259         <xs:sequence>
 260                 <xs:element name="vpid_target" type="vpid_target_type" minOccurs="0" maxOccurs="unbounded" />
 261         </xs:sequence>
 262 </xs:complexType>
 263
 264 <!-- Maps to a pid_tracker-->
 265 <xs:complexType name="vpid_tracker_type">
 266         <xs:all>
 267                 <xs:element name="targets" type="vpid_targets_type" />
 268         </xs:all>
 269 </xs:complexType>
 270
 271 <xs:complexType name="uid_target_type">
 272         <xs:choice>
 273                 <xs:element name="id" type="xs:integer" />
 274                 <xs:element name="name" type="xs:string" />
 275         </xs:choice>
 276 </xs:complexType>
 277
 278 <!-- Maps to a list of uid_targets-->
 279 <xs:complexType name="uid_targets_type">
 280         <xs:sequence>
 281                 <xs:element name="uid_target" type="uid_target_type" minOccurs="0" maxOccurs="unbounded" />
 282         </xs:sequence>
 283 </xs:complexType>
 284
 285 <!-- Maps to a uid_tracker-->
 286 <xs:complexType name="uid_tracker_type">
 287         <xs:all>
 288                 <xs:element name="targets" type="uid_targets_type" />
 289         </xs:all>
 290 </xs:complexType>
 291
 292 <xs:complexType name="vuid_target_type">
 293         <xs:choice>
 294                 <xs:element name="id" type="xs:integer" />
 295                 <xs:element name="name" type="xs:string" />
 296         </xs:choice>
 297 </xs:complexType>
 298
 299 <!-- Maps to a list of vuid_targets-->
 300 <xs:complexType name="vuid_targets_type">
 301         <xs:sequence>
 302                 <xs:element name="vuid_target" type="vuid_target_type" minOccurs="0" maxOccurs="unbounded" />
 303         </xs:sequence>
 304 </xs:complexType>
 305
 306 <!-- Maps to a uid_tracker-->
 307 <xs:complexType name="vuid_tracker_type">
 308         <xs:all>
 309                 <xs:element name="targets" type="vuid_targets_type" />
 310         </xs:all>
 311 </xs:complexType>
 312
 313 <xs:complexType name="gid_target_type">
 314         <xs:choice>
 315                 <xs:element name="id" type="xs:integer" />
 316                 <xs:element name="name" type="xs:string" />
 317         </xs:choice>
 318 </xs:complexType>
 319
 320 <!-- Maps to a list of gid_targets-->
 321 <xs:complexType name="gid_targets_type">
 322         <xs:sequence>
 323                 <xs:element name="gid_target" type="gid_target_type" minOccurs="0" maxOccurs="unbounded" />
 324         </xs:sequence>
 325 </xs:complexType>
 326
 327 <!-- Maps to a gid_tracker-->
 328 <xs:complexType name="gid_tracker_type">
 329         <xs:all>
 330                 <xs:element name="targets" type="gid_targets_type" />
 331         </xs:all>
 332 </xs:complexType>
 333
 334 <xs:complexType name="vgid_target_type">
 335         <xs:choice>
 336                 <xs:element name="id" type="xs:integer" />
 337                 <xs:element name="name" type="xs:string" />
 338         </xs:choice>
 339 </xs:complexType>
 340
 341 <!-- Maps to a list of vgid_targets-->
 342 <xs:complexType name="vgid_targets_type">
 343         <xs:sequence>
 344                 <xs:element name="vgid_target" type="vgid_target_type" minOccurs="0" maxOccurs="unbounded" />
 345         </xs:sequence>
 346 </xs:complexType>
 347
 348 <!-- Maps to a gid_tracker-->
 349 <xs:complexType name="vgid_tracker_type">
 350         <xs:all>
 351                 <xs:element name="targets" type="vgid_targets_type" />
 352         </xs:all>
 353 </xs:complexType>
 354
 355 <!-- Maps to a list of trackers-->
 356 <xs:complexType name="trackers_type">
 357         <xs:sequence>
 358                 <xs:choice minOccurs="0" maxOccurs="unbounded" >
 359                         <xs:element name="pid_tracker" type="pid_tracker_type" maxOccurs="1" />
 360                         <xs:element name="vpid_tracker" type="vpid_tracker_type" maxOccurs="1" />
 361                         <xs:element name="uid_tracker" type="uid_tracker_type" maxOccurs="1" />
 362                         <xs:element name="vuid_tracker" type="vuid_tracker_type" maxOccurs="1" />
 363                         <xs:element name="gid_tracker" type="gid_tracker_type" maxOccurs="1" />
 364                         <xs:element name="vgid_tracker" type="vgid_tracker_type" maxOccurs="1" />
 365                 </xs:choice>
 366         </xs:sequence>
 367 </xs:complexType>
 368
 369 <!-- Maps to struct lttng_domain, contains channels and pid_tracker -->
 370 <xs:complexType name="domain_type">
 371         <xs:all>
 372                 <xs:element name="type" type="domain_type_type"/>
 373                 <xs:element name="buffer_type" type="domain_buffer_type"/>
 374                 <xs:element name="channels" type="channel_list_type" minOccurs="0"/>
 375                 <xs:element name="trackers" type="trackers_type" minOccurs="0"/>
 376         </xs:all>
 377 </xs:complexType>
 378
 379 <xs:complexType name="session_attributes_type">
 380         <xs:choice>
 381                 <xs:element name="snapshot_mode" type="xs:boolean"/>
 382                 <xs:element name="live_timer_interval" type="uint32_type"/> <!-- usec -->
 383         </xs:choice>
 384 </xs:complexType>
 385
 386 <xs:complexType name="domain_list_type">
 387         <xs:sequence>
 388                 <xs:element name="domain" type="domain_type" minOccurs="0" maxOccurs="unbounded"/>
 389         </xs:sequence>
 390 </xs:complexType>
 391
 392 <xs:complexType name="net_output_type">
 393         <xs:all>
 394                 <xs:element name="control_uri" type="xs:string"/>
 395                 <xs:element name="data_uri" type="xs:string"/>
 396         </xs:all>
 397 </xs:complexType>
 398
 399 <xs:complexType name="destination_type">
 400         <xs:choice>
 401                 <xs:element name="path" type="xs:string"/>
 402                 <xs:element name="net_output" type="net_output_type"/>
 403         </xs:choice>
 404 </xs:complexType>
 405
 406 <xs:complexType name="consumer_output_type">
 407         <xs:all>
 408                 <xs:element name="enabled" type="xs:boolean" default="true"/>
 409                 <xs:element name="destination" type="destination_type"/>
 410         </xs:all>
 411 </xs:complexType>
 412
 413 <xs:complexType name="snapshot_output_type">
 414         <xs:all>
 415                 <xs:element name="name" type="name_type"/>
 416                 <xs:element name="max_size" type="uint64_type"/>
 417                 <xs:element name="consumer_output" type="consumer_output_type"/>
 418         </xs:all>
 419 </xs:complexType>
 420
 421 <xs:complexType name="snapshot_output_list_type">
 422         <xs:sequence>
 423                 <xs:element name="output" type="snapshot_output_type" minOccurs="0" maxOccurs="unbounded"/>
 424         </xs:sequence>
 425 </xs:complexType>
 426
 427 <xs:complexType name="session_output_type">
 428         <xs:choice>
 429                 <xs:element name="snapshot_outputs" type="snapshot_output_list_type"/>
 430                 <xs:element name="consumer_output" type="consumer_output_type"/>
 431         </xs:choice>
 432 </xs:complexType>
 433
 434 <xs:complexType name="session_type">
 435         <xs:all>
 436                 <xs:element name="name" type="name_type"/>
 437                 <xs:element name="shared_memory_path" type="xs:string" minOccurs="0"/>
 438                 <xs:element name="domains" type="domain_list_type" minOccurs="0"/>
 439                 <xs:element name="started" type="xs:boolean" default="0" minOccurs="0"/>
 440                 <xs:element name="attributes" type="session_attributes_type" minOccurs="0"/>
 441                 <xs:element name="output" type="session_output_type" minOccurs="0"/>
 442         </xs:all>
 443 </xs:complexType>
 444
 445 <xs:element name="sessions">
 446         <xs:complexType>
 447                 <xs:sequence>
 448                         <xs:element name="session" type="session_type" maxOccurs="unbounded"/>
 449                 </xs:sequence>
 450         </xs:complexType>
 451 </xs:element>
 452
 453 </xs:schema>