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:restriction>
 163 </xs:simpleType>
 164
 165 <xs:complexType name="event_context_type">
 166         <xs:choice>
 167                 <xs:element name="type" type="event_context_type_type"/>
 168                 <xs:element name="perf" type="event_perf_context_type"/>
 169                 <xs:element name="app" type="event_app_context_type"/>
 170         </xs:choice>
 171 </xs:complexType>
 172
 173 <xs:complexType name="event_context_list_type">
 174         <xs:sequence>
 175                 <xs:element name="context" type="event_context_type" minOccurs="0" maxOccurs="unbounded"/>
 176         </xs:sequence>
 177 </xs:complexType>
 178
 179 <!-- Maps to struct lttng_channel -->
 180 <xs:complexType name="channel_type">
 181         <xs:all>
 182                 <xs:element name="name" type="name_type"/>
 183                 <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0"/>
 184                 <xs:element name="overwrite_mode" type="channel_overwrite_mode_type" default="DISCARD" minOccurs="0"/>
 185                 <xs:element name="subbuffer_size" type="uint64_type" minOccurs="0"/> <!-- bytes -->
 186                 <xs:element name="subbuffer_count" type="uint64_type" default="4" minOccurs="0"/>
 187                 <xs:element name="switch_timer_interval" type="uint32_type" default="0" minOccurs="0"/>  <!-- usec -->
 188                 <xs:element name="read_timer_interval" type="uint32_type"/>  <!-- usec -->
 189                 <xs:element name="output_type" type="event_output_type"/>
 190                 <xs:element name="tracefile_size" type="uint64_type" default="0" minOccurs="0"/> <!-- bytes -->
 191                 <xs:element name="tracefile_count" type="uint64_type" default="0" minOccurs="0"/>
 192                 <xs:element name="live_timer_interval" type="uint32_type" default="0" minOccurs="0"/> <!-- usec -->
 193                 <xs:element name="events" type="event_list_type" minOccurs="0"/>
 194                 <xs:element name="contexts" type="event_context_list_type" minOccurs="0"/>
 195         </xs:all>
 196 </xs:complexType>
 197
 198 <!-- Maps to the lttng_domain_type enum -->
 199 <xs:simpleType name="domain_type_type">
 200         <xs:restriction base="xs:string">
 201                 <xs:enumeration value="KERNEL"/>
 202                 <xs:enumeration value="UST"/>
 203                 <xs:enumeration value="JUL"/>
 204                 <xs:enumeration value="LOG4J"/>
 205                 <xs:enumeration value="PYTHON"/>
 206         </xs:restriction>
 207 </xs:simpleType>
 208
 209 <!-- Maps to the lttng_buffer_type enum -->
 210 <xs:simpleType name="domain_buffer_type">
 211         <xs:restriction base="xs:string">
 212                 <xs:enumeration value="PER_PID"/>
 213                 <xs:enumeration value="PER_UID"/>
 214                 <xs:enumeration value="GLOBAL"/>
 215         </xs:restriction>
 216 </xs:simpleType>
 217
 218 <xs:complexType name="channel_list_type">
 219         <xs:sequence>
 220                 <xs:element name="channel" type="channel_type" minOccurs="0" maxOccurs="unbounded" />
 221         </xs:sequence>
 222 </xs:complexType>
 223
 224 <xs:complexType name="pid_target_type">
 225         <xs:all>
 226                 <xs:element name="pid" type="xs:integer" />
 227         </xs:all>
 228 </xs:complexType>
 229
 230 <!-- Maps to a list of pid_targets-->
 231 <xs:complexType name="targets_type">
 232         <xs:sequence>
 233                 <xs:choice>
 234                         <xs:element name="pid_target" type="pid_target_type" minOccurs="0" maxOccurs="unbounded" />
 235                 </xs:choice>
 236         </xs:sequence>
 237 </xs:complexType>
 238
 239 <!-- Maps to a pid_tracker-->
 240 <xs:complexType name="pid_tracker_type">
 241         <xs:all>
 242                 <xs:element name="targets" type="targets_type" />
 243         </xs:all>
 244 </xs:complexType>
 245
 246 <!-- Maps to a list of trackers-->
 247 <xs:complexType name="trackers_type">
 248         <xs:sequence minOccurs="0" maxOccurs="unbounded">
 249                 <xs:element name="pid_tracker" type="pid_tracker_type" maxOccurs="1" />
 250         </xs:sequence>
 251 </xs:complexType>
 252
 253 <!-- Maps to struct lttng_domain, contains channels and pid_tracker -->
 254 <xs:complexType name="domain_type">
 255         <xs:all>
 256                 <xs:element name="type" type="domain_type_type"/>
 257                 <xs:element name="buffer_type" type="domain_buffer_type"/>
 258                 <xs:element name="channels" type="channel_list_type" minOccurs="0"/>
 259                 <xs:element name="trackers" type="trackers_type" minOccurs="0"/>
 260         </xs:all>
 261 </xs:complexType>
 262
 263 <xs:complexType name="session_attributes_type">
 264         <xs:choice>
 265                 <xs:element name="snapshot_mode" type="xs:boolean"/>
 266                 <xs:element name="live_timer_interval" type="uint32_type"/> <!-- usec -->
 267         </xs:choice>
 268 </xs:complexType>
 269
 270 <xs:complexType name="domain_list_type">
 271         <xs:sequence>
 272                 <xs:element name="domain" type="domain_type" minOccurs="0" maxOccurs="unbounded"/>
 273         </xs:sequence>
 274 </xs:complexType>
 275
 276 <xs:complexType name="net_output_type">
 277         <xs:all>
 278                 <xs:element name="control_uri" type="xs:string"/>
 279                 <xs:element name="data_uri" type="xs:string"/>
 280         </xs:all>
 281 </xs:complexType>
 282
 283 <xs:complexType name="destination_type">
 284         <xs:choice>
 285                 <xs:element name="path" type="xs:string"/>
 286                 <xs:element name="net_output" type="net_output_type"/>
 287         </xs:choice>
 288 </xs:complexType>
 289
 290 <xs:complexType name="consumer_output_type">
 291         <xs:all>
 292                 <xs:element name="enabled" type="xs:boolean" default="true"/>
 293                 <xs:element name="destination" type="destination_type"/>
 294         </xs:all>
 295 </xs:complexType>
 296
 297 <xs:complexType name="snapshot_output_type">
 298         <xs:all>
 299                 <xs:element name="name" type="name_type"/>
 300                 <xs:element name="max_size" type="uint64_type"/>
 301                 <xs:element name="consumer_output" type="consumer_output_type"/>
 302         </xs:all>
 303 </xs:complexType>
 304
 305 <xs:complexType name="snapshot_output_list_type">
 306         <xs:sequence>
 307                 <xs:element name="output" type="snapshot_output_type" minOccurs="0" maxOccurs="unbounded"/>
 308         </xs:sequence>
 309 </xs:complexType>
 310
 311 <xs:complexType name="session_output_type">
 312         <xs:choice>
 313                 <xs:element name="snapshot_outputs" type="snapshot_output_list_type"/>
 314                 <xs:element name="consumer_output" type="consumer_output_type"/>
 315         </xs:choice>
 316 </xs:complexType>
 317
 318 <xs:complexType name="session_type">
 319         <xs:all>
 320                 <xs:element name="name" type="name_type"/>
 321                 <xs:element name="shared_memory_path" type="xs:string" minOccurs="0"/>
 322                 <xs:element name="domains" type="domain_list_type" minOccurs="0"/>
 323                 <xs:element name="started" type="xs:boolean" default="0" minOccurs="0"/>
 324                 <xs:element name="attributes" type="session_attributes_type" minOccurs="0"/>
 325                 <xs:element name="output" type="session_output_type" minOccurs="0"/>
 326         </xs:all>
 327 </xs:complexType>
 328
 329 <xs:element name="sessions">
 330         <xs:complexType>
 331                 <xs:sequence>
 332                         <xs:element name="session" type="session_type" maxOccurs="unbounded"/>
 333                 </xs:sequence>
 334         </xs:complexType>
 335 </xs:element>
 336
 337 </xs:schema>