src/common/mi_lttng.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!--
   3 Copyright (c) 2014 - Oliver Cotte <olivier.cotte@polymtl.ca>
   4                    - Jonathan Rajotte <jonathan.r.julien@gmail.com>
   5
   6 Permission is hereby granted, free of charge, to any person obtaining a copy
   7 of this software and associated documentation files (the "Software"), to deal
   8 in the Software without restriction, including without limitation the rights
   9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 copies of the Software, and to permit persons to whom the Software is
  11 furnished to do so, subject to the following conditions:
  12
  13 The above copyright notice and this permission notice shall be included in
  14 all copies or substantial portions of the Software.
  15
  16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  22 THE 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
  86         <!-- Maps to the lttng_event_context_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
 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="JUL_OFF" />
 127                         <xs:enumeration value="JUL_SEVERE" />
 128                         <xs:enumeration value="JUL_WARNING" />
 129                         <xs:enumeration value="JUL_INFO" />
 130                         <xs:enumeration value="JUL_CONFIG" />
 131                         <xs:enumeration value="JUL_FINE" />
 132                         <xs:enumeration value="JUL_FINER" />
 133                         <xs:enumeration value="JUL_FINEST" />
 134                         <xs:enumeration value="JUL_ALL" />
 135                         <xs:enumeration value="LOG4J_OFF" />
 136                         <xs:enumeration value="LOG4J_FATAL" />
 137                         <xs:enumeration value="LOG4J_ERROR" />
 138                         <xs:enumeration value="LOG4J_WARN" />
 139                         <xs:enumeration value="LOG4J_INFO" />
 140                         <xs:enumeration value="LOG4J_DEBUG" />
 141                         <xs:enumeration value="LOG4J_TRACE" />
 142                         <xs:enumeration value="LOG4J_ALL" />
 143                         <xs:enumeration value="UNKNOWN" />
 144                 </xs:restriction>
 145         </xs:simpleType>
 146
 147         <!-- Maps to the lttng_calibrate_type enum -->
 148         <xs:simpleType name="calibrate_type_type">
 149                 <xs:restriction base="xs:string">
 150                         <xs:enumeration value="FUNCTION" />
 151                 </xs:restriction>
 152         </xs:simpleType>
 153
 154         <!-- Maps to the lttng_event_probe_attr struct -->
 155         <xs:complexType name="event_probe_attributes_type">
 156                 <xs:all>
 157                         <xs:element name="address" type="uint64_type" minOccurs="0" />
 158                         <xs:element name="offset" type="uint64_type" minOccurs="0" />
 159                         <xs:element name="symbol_name" type="name_type" minOccurs="0" />
 160                 </xs:all>
 161         </xs:complexType>
 162
 163         <!-- Maps to the lttng_event_function_attr struct -->
 164         <xs:complexType name="event_ftrace_attributes_type">
 165                 <xs:all>
 166                         <xs:element name="symbol_name" type="name_type" />
 167                 </xs:all>
 168         </xs:complexType>
 169
 170         <!-- Maps to per event type configuration -->
 171         <xs:complexType name="event_attributes_type">
 172                 <xs:choice>
 173                         <xs:element name="probe_attributes" type="event_probe_attributes_type" />
 174                         <xs:element name="function_attributes" type="event_ftrace_attributes_type" />
 175                 </xs:choice>
 176         </xs:complexType>
 177
 178         <!-- Maps to exclusion type -->
 179         <xs:complexType name="event_exclusion_list_type">
 180                 <xs:sequence>
 181                         <xs:element name="exclusion" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
 182                 </xs:sequence>
 183         </xs:complexType>
 184
 185         <!-- Maps to lttng_event struct -->
 186         <xs:complexType name="event_type">
 187                 <xs:all>
 188                         <xs:element name="type" type="event_type_type" default="TRACEPOINT" minOccurs="0" />
 189                         <xs:element name="name" type="name_type" minOccurs="0" />
 190                         <xs:element name="loglevel_type" type="loglevel_type" default="ALL" minOccurs="0" />
 191                         <xs:element name="loglevel" type="loglevel_string_type" default="" minOccurs="0" />
 192                         <xs:element name="enabled" type="xs:boolean" default="false" minOccurs="0" />
 193                         <xs:element name="filter" type="xs:boolean" minOccurs="0" />
 194                         <xs:element name="exclusion" type="xs:boolean" minOccurs="0" />
 195                         <xs:element name="exclusions" type="event_exclusion_list_type" minOccurs="0"/>
 196                         <xs:element name="attributes" type="event_attributes_type" minOccurs="0" />
 197                         <xs:element name="event_fields" type="event_fields_type" minOccurs="0" />
 198                         <xs:element name="success" type="xs:boolean" minOccurs="0" />
 199                 </xs:all>
 200         </xs:complexType>
 201
 202         <!-- Maps to mi_lttng_version struct -->
 203         <xs:complexType name="version_type">
 204                 <xs:all>
 205                         <xs:element name="name" type="name_type" />
 206                         <xs:element name="string" type="name_type" />
 207                         <xs:element name="major" type="uint32_type" />
 208                         <xs:element name="url" type="xs:string" />
 209                         <xs:element name="minor" type="uint32_type" />
 210                         <xs:element name="commit" type="xs:string" />
 211                         <xs:element name="license" type="xs:string" />
 212                         <xs:element name="patchLevel" type="uint32_type" />
 213                         <xs:element name="description" type="xs:string" />
 214                 </xs:all>
 215         </xs:complexType>
 216
 217         <!-- Maps to an array of event -->
 218         <xs:complexType name="event_list_type">
 219                 <xs:sequence>
 220                         <xs:element name="event" type="event_type" minOccurs="0" maxOccurs="unbounded" />
 221                 </xs:sequence>
 222         </xs:complexType>
 223
 224         <!-- Maps to the lttng_domain_type enum -->
 225         <xs:simpleType name="domain_type_type">
 226                 <xs:restriction base="xs:string">
 227                         <xs:enumeration value="KERNEL"/>
 228                         <xs:enumeration value="UST"/>
 229                         <xs:enumeration value="JUL"/>
 230                         <xs:enumeration value="LOG4J"/>
 231                 </xs:restriction>
 232         </xs:simpleType>
 233
 234         <!-- Maps to the lttng_buffer_type enum -->
 235         <xs:simpleType name="domain_buffer_type">
 236                 <xs:restriction base="xs:string">
 237                         <xs:enumeration value="PER_PID"/>
 238                         <xs:enumeration value="PER_UID"/>
 239                         <xs:enumeration value="GLOBAL"/>
 240                 </xs:restriction>
 241         </xs:simpleType>
 242
 243         <!-- Maps to the type mode of a channel -->
 244         <xs:simpleType name="channel_overwrite_mode_type">
 245                 <xs:restriction base="xs:string">
 246                         <xs:enumeration value="DISCARD" />
 247                         <xs:enumeration value="OVERWRITE" />
 248                 </xs:restriction>
 249         </xs:simpleType>
 250
 251         <!-- Maps to the lttng_event_output enum -->
 252         <xs:simpleType name="event_output_type">
 253                 <xs:restriction base="xs:string">
 254                         <xs:enumeration value="SPLICE" />
 255                         <xs:enumeration value="MMAP" />
 256                 </xs:restriction>
 257         </xs:simpleType>
 258
 259         <!-- map to a pid -->
 260         <xs:complexType name="pid_type">
 261                 <xs:all>
 262                         <xs:element name="id" type="xs:int" />
 263                         <xs:element name="name" type="name_type" />
 264                         <xs:element name="events" type="event_list_type" minOccurs="0" />
 265                 </xs:all>
 266         </xs:complexType>
 267
 268         <!-- maps to an array of pid -->
 269         <xs:complexType name="pids_type">
 270                 <xs:sequence>
 271                         <xs:element name="pid" type="pid_type" minOccurs="0" maxOccurs="unbounded" />
 272                 </xs:sequence>
 273         </xs:complexType>
 274
 275         <!-- Maps to struct lttng_domain and contains channels -->
 276         <xs:complexType name="domain_type">
 277                 <xs:all>
 278                         <xs:element name="type" type="domain_type_type" />
 279                         <xs:element name="buffer_type" type="domain_buffer_type" />
 280                         <xs:element name="pids" type="pids_type" minOccurs="0" />
 281                         <xs:element name="channels" type="channels_type" minOccurs="0" />
 282                         <xs:element name="events" type="event_list_type" minOccurs="0" />
 283                 </xs:all>
 284         </xs:complexType>
 285
 286         <!-- Maps to struct lttng_channel -->
 287         <xs:complexType name="channel_type">
 288                 <xs:all>
 289                         <xs:element name="name" type="name_type" />
 290                         <xs:element name="enabled" type="xs:boolean" default="true" minOccurs="0" />
 291                         <xs:element name="attributes" type="channel_attributes_type" minOccurs="0" />
 292                         <xs:element name="events" type="event_list_type" minOccurs="0" />
 293                         <xs:element name="success" type="xs:boolean" default="false" minOccurs="0" />
 294                 </xs:all>
 295         </xs:complexType>
 296
 297         <!-- Maps to struct lttng_channel_attr -->
 298         <xs:complexType name="channel_attributes_type">
 299                 <xs:all>
 300                         <xs:element name="overwrite_mode" type="channel_overwrite_mode_type" default="DISCARD" minOccurs="0" />
 301                         <xs:element name="subbuffer_size" type="uint64_type" minOccurs="0" /> <!-- bytes -->
 302                         <xs:element name="subbuffer_count" type="uint64_type" default="4" minOccurs="0" />
 303                         <xs:element name="switch_timer_interval" type="uint32_type" default="0" minOccurs="0" />  <!-- usec -->
 304                         <xs:element name="read_timer_interval" type="uint32_type" />  <!-- usec -->
 305                         <xs:element name="output_type" type="event_output_type" />
 306                         <xs:element name="tracefile_size" type="uint64_type" default="0" minOccurs="0" /> <!-- bytes -->
 307                         <xs:element name="tracefile_count" type="uint64_type" default="0" minOccurs="0" />
 308                         <xs:element name="live_timer_interval" type="uint32_type" default="0" minOccurs="0" /> <!-- usec -->
 309                 </xs:all>
 310         </xs:complexType>
 311
 312         <!-- Maps to struct lttng_snapshot_output -->
 313         <xs:complexType name="snapshot_type">
 314                 <xs:all>
 315                         <xs:element name="id" type="uint32_type" minOccurs="0" />
 316                         <xs:element name="max_size" type="uint64_type" minOccurs="0" />
 317                         <xs:element name="name" type="name_type" minOccurs="0" />
 318                         <xs:element name="session_name" type="name_type" minOccurs="0" />
 319                         <xs:element name="ctrl_url" type="name_type" minOccurs="0" />
 320                         <xs:element name="data_url" type="name_type" minOccurs="0" />
 321                 </xs:all>
 322         </xs:complexType>
 323
 324         <xs:complexType name="snapshots_type">
 325                 <xs:sequence>
 326                         <xs:element name="snapshot" type="snapshot_type" minOccurs="0" maxOccurs="unbounded" />
 327                 </xs:sequence>
 328         </xs:complexType>
 329
 330         <xs:complexType name="channels_type">
 331                 <xs:sequence>
 332                         <xs:element name="channel" type="channel_type" minOccurs="0" maxOccurs="unbounded" />
 333                 </xs:sequence>
 334         </xs:complexType>
 335
 336         <!-- Maps to a lttng_session -->
 337         <xs:complexType name="session_type">
 338                 <xs:all>
 339                         <xs:element name="name" type="name_type" />
 340                         <xs:element name="path" type="name_type" minOccurs="0" />
 341                         <xs:element name="enabled" type="xs:boolean" default="false" minOccurs="0" />
 342                         <xs:element name="snapshot_mode" type="uint32_type" minOccurs="0" />
 343                         <xs:element name="live_timer_interval" type="uint32_type" minOccurs="0" />
 344                         <xs:element name="channels" type="channels_type" minOccurs="0" />
 345                         <xs:element name="domains" type="domains_type" minOccurs="0" />
 346                         <xs:element name="snapshots" type="snapshots_type" minOccurs="0" />
 347                 </xs:all>
 348         </xs:complexType>
 349
 350         <!-- Maps to a lttng_event_field -->
 351         <xs:complexType name="event_field_type">
 352                 <xs:all>
 353                         <xs:element name="name" type="name_type" />
 354                         <xs:element name="type" type="event_field_type_type" />
 355                         <xs:element name="nowrite" type="xs:int" />
 356                 </xs:all>
 357         </xs:complexType>
 358
 359         <!-- Map to the save command -->
 360         <xs:complexType name="save_type">
 361                 <xs:all>
 362                         <xs:element name="session" type="session_type" />
 363                         <xs:element name="path" type="name_type" />
 364                 </xs:all>
 365         </xs:complexType>
 366
 367         <!-- Map to the load command -->
 368         <xs:complexType name="load_type">
 369                 <xs:all>
 370                         <xs:element name="session" type="session_type" />
 371                         <xs:element name="path" type="name_type" />
 372                 </xs:all>
 373         </xs:complexType>
 374
 375         <!-- Maps to struct lttng_calibrate -->
 376         <xs:complexType name="calibrate_type">
 377                 <xs:all>
 378                         <xs:element name="type" type="calibrate_type_type" />
 379                 </xs:all>
 380         </xs:complexType>
 381
 382         <!-- Map to lttng_event_perf_counter_ctx -->
 383         <xs:complexType name="perf_counter_context_type">
 384                 <xs:all>
 385                         <xs:element name="type" type="uint32_type" />
 386                         <xs:element name="config" type="uint64_type" />
 387                         <xs:element name="name" type="name_type" />
 388                 </xs:all>
 389         </xs:complexType>
 390
 391         <!-- Map to lttng_event_context -->
 392         <xs:complexType name="context_type">
 393                 <xs:all>
 394                         <xs:element name="type" type="context_type_type" />
 395                         <xs:element name="perf_counter_context" type="perf_counter_context_type" minOccurs="0" />
 396                         <xs:element name="success" type="xs:boolean" default="false" minOccurs="0" />
 397                 </xs:all>
 398         </xs:complexType>
 399
 400         <!-- Maps to an array of domain -->
 401         <xs:complexType name="domains_type">
 402                 <xs:sequence>
 403                         <xs:element name="domain" type="domain_type" minOccurs="0" maxOccurs="unbounded" />
 404                 </xs:sequence>
 405         </xs:complexType>
 406
 407         <!-- Maps to an array of session -->
 408         <xs:complexType name="sessions_type">
 409                 <xs:sequence>
 410                         <xs:element name="session" type="session_type" minOccurs="0" maxOccurs="unbounded" />
 411                 </xs:sequence>
 412         </xs:complexType>
 413
 414         <!-- Maps to an array of event_field -->
 415         <xs:complexType name="event_fields_type">
 416                 <xs:sequence>
 417                         <xs:element name="event_field" type="event_field_type" minOccurs="0" maxOccurs="unbounded" />
 418                 </xs:sequence>
 419         </xs:complexType>
 420
 421         <!-- Maps to an array of context -->
 422         <xs:complexType name="contexts_type">
 423                 <xs:sequence>
 424                         <xs:element name="context" type="context_type" minOccurs="0" maxOccurs="unbounded" />
 425                 </xs:sequence>
 426         </xs:complexType>
 427
 428         <!-- Maps to an action dutring snapshot command -->
 429         <xs:complexType name="snapshot_action_type">
 430                 <xs:sequence>
 431                         <xs:element name="name" type="snapshot_actiontype_type" minOccurs="0" />
 432                         <xs:element name="output" type="output_type" minOccurs="0" />
 433                 </xs:sequence>
 434         </xs:complexType>
 435
 436         <!-- Type of snapshot commands -->
 437         <xs:simpleType name="snapshot_actiontype_type">
 438                 <xs:restriction base="xs:string">
 439                         <xs:enumeration value="list-output" />
 440                         <xs:enumeration value="del-output" />
 441                         <xs:enumeration value="add-output" />
 442                         <xs:enumeration value="record-output" />
 443                 </xs:restriction>
 444         </xs:simpleType>
 445
 446         <xs:complexType name="output_type">
 447                 <xs:choice>
 448                         <xs:element name="domains" type="domains_type" minOccurs="0" />
 449                         <xs:element name="sessions" type="sessions_type" minOccurs="0" />
 450                         <xs:element name="session" type="session_type" minOccurs="0" />
 451                         <xs:element name="snapshot_action" type="snapshot_action_type" minOccurs="0" />
 452                         <xs:element name="snapshot" type="snapshot_type" minOccurs="0" />
 453                         <xs:element name="version" type="version_type" minOccurs="0" />
 454                         <xs:element name="save" type="save_type" minOccurs="0" />
 455                         <xs:element name="load" type="load_type" minOccurs="0" />
 456                         <xs:element name="calibrate" type="calibrate_type" minOccurs="0" />
 457                         <xs:element name="contexts" type="contexts_type" minOccurs="0" />
 458                         <xs:element name="channels" type="channels_type" minOccurs="0" />
 459                         <xs:element name="events" type="event_list_type" minOccurs="0" />
 460                         <xs:element name="channel" type="channel_type" minOccurs="0" />
 461                 </xs:choice>
 462         </xs:complexType>
 463
 464         <!-- Maps to the mi_lttng commands -->
 465         <xs:simpleType name="command_string_type">
 466                 <xs:restriction base="xs:string">
 467                         <xs:enumeration value="create" />
 468                         <xs:enumeration value="list" />
 469                         <xs:enumeration value="snapshot" />
 470                         <xs:enumeration value="version" />
 471                         <xs:enumeration value="save" />
 472                         <xs:enumeration value="load" />
 473                         <xs:enumeration value="start" />
 474                         <xs:enumeration value="stop" />
 475                         <xs:enumeration value="destroy" />
 476                         <xs:enumeration value="calibrate" />
 477                         <xs:enumeration value="add-context" />
 478                         <xs:enumeration value="enable-channel" />
 479                         <xs:enumeration value="enable-event" />
 480                         <xs:enumeration value="set-session" />
 481                         <xs:enumeration value="disable-event" />
 482                         <xs:enumeration value="disable-channel" />
 483                 </xs:restriction>
 484         </xs:simpleType>
 485
 486         <xs:element name="command">
 487                 <xs:complexType>
 488                         <xs:all>
 489                                 <xs:element name="name" type="command_string_type" maxOccurs="1" />
 490                                 <xs:element name="output" type="output_type" maxOccurs="1" />
 491                                 <xs:element name="success" type="xs:boolean" minOccurs="0" maxOccurs="1" />
 492                         </xs:all>
 493                 </xs:complexType>
 494         </xs:element>
 495 </xs:schema>