barectf/config.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) 2015-2016 Philippe Proulx <pproulx@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 from barectf import metadata
  24 import collections
  25 import datetime
  26 import barectf
  27 import enum
  28 import yaml
  29 import uuid
  30 import copy
  31 import re
  32 import os
  33
  34
  35 class ConfigError(RuntimeError):
  36     def __init__(self, msg, prev=None):
  37         super().__init__(msg)
  38         self._prev = prev
  39
  40     @property
  41     def prev(self):
  42         return self._prev
  43
  44
  45 class Config:
  46     def __init__(self, version, prefix, metadata):
  47         self.prefix = prefix
  48         self.version = version
  49         self.metadata = metadata
  50
  51     def _validate_metadata(self, meta):
  52         try:
  53             validator = _MetadataTypesHistologyValidator()
  54             validator.validate(meta)
  55             validator = _MetadataDynamicTypesValidator()
  56             validator.validate(meta)
  57             validator = _MetadataSpecialFieldsValidator()
  58             validator.validate(meta)
  59         except Exception as e:
  60             raise ConfigError('metadata error', e)
  61
  62         try:
  63             validator = _BarectfMetadataValidator()
  64             validator.validate(meta)
  65         except Exception as e:
  66             raise ConfigError('barectf metadata error', e)
  67
  68     def _augment_metadata_env(self, meta):
  69         env = meta.env
  70
  71         env['domain'] = 'bare'
  72         env['tracer_name'] = 'barectf'
  73         version_tuple = barectf.get_version_tuple()
  74         env['tracer_major'] = version_tuple[0]
  75         env['tracer_minor'] = version_tuple[1]
  76         env['tracer_patch'] = version_tuple[2]
  77         env['barectf_gen_date'] = str(datetime.datetime.now().isoformat())
  78
  79     @property
  80     def version(self):
  81         return self._version
  82
  83     @version.setter
  84     def version(self, value):
  85         self._version = value
  86
  87     @property
  88     def metadata(self):
  89         return self._metadata
  90
  91     @metadata.setter
  92     def metadata(self, value):
  93         self._validate_metadata(value)
  94         self._augment_metadata_env(value)
  95         self._metadata = value
  96
  97     @property
  98     def prefix(self):
  99         return self._prefix
 100
 101     @prefix.setter
 102     def prefix(self, value):
 103         if not is_valid_identifier(value):
 104             raise ConfigError('prefix must be a valid C identifier')
 105
 106         self._prefix = value
 107
 108
 109 def _is_assoc_array_prop(node):
 110     return isinstance(node, dict)
 111
 112
 113 def _is_array_prop(node):
 114     return isinstance(node, list)
 115
 116
 117 def _is_int_prop(node):
 118     return type(node) is int
 119
 120
 121 def _is_str_prop(node):
 122     return type(node) is str
 123
 124
 125 def _is_bool_prop(node):
 126     return type(node) is bool
 127
 128
 129 def _is_valid_alignment(align):
 130     return ((align & (align - 1)) == 0) and align > 0
 131
 132
 133 def _byte_order_str_to_bo(bo_str):
 134     bo_str = bo_str.lower()
 135
 136     if bo_str == 'le':
 137         return metadata.ByteOrder.LE
 138     elif bo_str == 'be':
 139         return metadata.ByteOrder.BE
 140
 141
 142 def _encoding_str_to_encoding(encoding_str):
 143     encoding_str = encoding_str.lower()
 144
 145     if encoding_str == 'utf-8' or encoding_str == 'utf8':
 146         return metadata.Encoding.UTF8
 147     elif encoding_str == 'ascii':
 148         return metadata.Encoding.ASCII
 149     elif encoding_str == 'none':
 150         return metadata.Encoding.NONE
 151
 152
 153 _re_iden = re.compile(r'^[a-zA-Z][a-zA-Z0-9_]*$')
 154 _ctf_keywords = set([
 155     'align',
 156     'callsite',
 157     'clock',
 158     'enum',
 159     'env',
 160     'event',
 161     'floating_point',
 162     'integer',
 163     'stream',
 164     'string',
 165     'struct',
 166     'trace',
 167     'typealias',
 168     'typedef',
 169     'variant',
 170 ])
 171
 172
 173 def is_valid_identifier(iden):
 174     if not _re_iden.match(iden):
 175         return False
 176
 177     if _re_iden in _ctf_keywords:
 178         return False
 179
 180     return True
 181
 182
 183 def _get_first_unknown_prop(node, known_props):
 184     for prop_name in node:
 185         if prop_name in known_props:
 186             continue
 187
 188         return prop_name
 189
 190
 191 # This validator validates the configured metadata for barectf specific
 192 # needs.
 193 #
 194 # barectf needs:
 195 #
 196 #   * all header/contexts are at least byte-aligned
 197 #   * all integer and floating point number sizes to be <= 64
 198 #   * no inner structures, arrays, or variants
 199 class _BarectfMetadataValidator:
 200     def __init__(self):
 201         self._type_to_validate_type_func = {
 202             metadata.Integer: self._validate_int_type,
 203             metadata.FloatingPoint: self._validate_float_type,
 204             metadata.Enum: self._validate_enum_type,
 205             metadata.String: self._validate_string_type,
 206             metadata.Struct: self._validate_struct_type,
 207             metadata.Array: self._validate_array_type,
 208             metadata.Variant: self._validate_variant_type,
 209         }
 210
 211     def _validate_int_type(self, t, entity_root):
 212         if t.size > 64:
 213             raise ConfigError('integer type\'s size must be lesser than or equal to 64 bits')
 214
 215     def _validate_float_type(self, t, entity_root):
 216         if t.size > 64:
 217             raise ConfigError('floating point number type\'s size must be lesser than or equal to 64 bits')
 218
 219     def _validate_enum_type(self, t, entity_root):
 220         if t.value_type.size > 64:
 221             raise ConfigError('enumeration type\'s integer type\'s size must be lesser than or equal to 64 bits')
 222
 223     def _validate_string_type(self, t, entity_root):
 224         pass
 225
 226     def _validate_struct_type(self, t, entity_root):
 227         if not entity_root:
 228             raise ConfigError('inner structure types are not supported as of this version')
 229
 230         for field_name, field_type in t.fields.items():
 231             if entity_root and self._cur_entity is _Entity.TRACE_PACKET_HEADER:
 232                 if field_name == 'uuid':
 233                     # allow
 234                     continue
 235
 236             try:
 237                 self._validate_type(field_type, False)
 238             except Exception as e:
 239                 raise ConfigError('in structure type\'s field "{}"'.format(field_name), e)
 240
 241     def _validate_array_type(self, t, entity_root):
 242         raise ConfigError('array types are not supported as of this version')
 243
 244     def _validate_variant_type(self, t, entity_root):
 245         raise ConfigError('variant types are not supported as of this version')
 246
 247     def _validate_type(self, t, entity_root):
 248         self._type_to_validate_type_func[type(t)](t, entity_root)
 249
 250     def _validate_entity(self, t):
 251         if t is None:
 252             return
 253
 254         # make sure entity is byte-aligned
 255         if t.align < 8:
 256             raise ConfigError('type\'s alignment must be at least byte-aligned')
 257
 258         # make sure entity is a structure
 259         if type(t) is not metadata.Struct:
 260             raise ConfigError('expecting a structure type')
 261
 262         # validate types
 263         self._validate_type(t, True)
 264
 265     def _validate_entities_and_names(self, meta):
 266         self._cur_entity = _Entity.TRACE_PACKET_HEADER
 267
 268         try:
 269             self._validate_entity(meta.trace.packet_header_type)
 270         except Exception as e:
 271             raise ConfigError('invalid trace packet header type', e)
 272
 273         for stream_name, stream in meta.streams.items():
 274             if not is_valid_identifier(stream_name):
 275                 raise ConfigError('stream name "{}" is not a valid C identifier'.format(stream_name))
 276
 277             self._cur_entity = _Entity.STREAM_PACKET_CONTEXT
 278
 279             try:
 280                 self._validate_entity(stream.packet_context_type)
 281             except Exception as e:
 282                 raise ConfigError('invalid packet context type in stream "{}"'.format(stream_name), e)
 283
 284             self._cur_entity = _Entity.STREAM_EVENT_HEADER
 285
 286             try:
 287                 self._validate_entity(stream.event_header_type)
 288             except Exception as e:
 289                 raise ConfigError('invalid event header type in stream "{}"'.format(stream_name), e)
 290
 291             self._cur_entity = _Entity.STREAM_EVENT_CONTEXT
 292
 293             try:
 294                 self._validate_entity(stream.event_context_type)
 295             except Exception as e:
 296                 raise ConfigError('invalid event context type in stream "{}"'.format(stream_name), e)
 297
 298             try:
 299                 for ev_name, ev in stream.events.items():
 300                     if not is_valid_identifier(ev_name):
 301                         raise ConfigError('event name "{}" is not a valid C identifier'.format(ev_name))
 302
 303                     self._cur_entity = _Entity.EVENT_CONTEXT
 304
 305                     try:
 306                         self._validate_entity(ev.context_type)
 307                     except Exception as e:
 308                         raise ConfigError('invalid context type in event "{}"'.format(ev_name), e)
 309
 310                     self._cur_entity = _Entity.EVENT_PAYLOAD
 311
 312                     if ev.payload_type is None:
 313                         raise ConfigError('missing payload type in event "{}"'.format(ev_name), e)
 314
 315                     try:
 316                         self._validate_entity(ev.payload_type)
 317                     except Exception as e:
 318                         raise ConfigError('invalid payload type in event "{}"'.format(ev_name), e)
 319
 320                     if not ev.payload_type.fields:
 321                         raise ConfigError('empty payload type in event "{}"'.format(ev_name), e)
 322             except Exception as e:
 323                 raise ConfigError('invalid stream "{}"'.format(stream_name), e)
 324
 325     def validate(self, meta):
 326         self._validate_entities_and_names(meta)
 327
 328
 329 # This validator validates special fields of trace, stream, and event
 330 # types. For example, if checks that the "stream_id" field exists in the
 331 # trace packet header if there's more than one stream, and much more.
 332 class _MetadataSpecialFieldsValidator:
 333     def _validate_trace_packet_header_type(self, t):
 334         # needs "stream_id" field?
 335         if len(self._meta.streams) > 1:
 336             # yes
 337             if t is None:
 338                 raise ConfigError('need "stream_id" field in trace packet header type, but trace packet header type is missing')
 339
 340             if type(t) is not metadata.Struct:
 341                 raise ConfigError('need "stream_id" field in trace packet header type, but trace packet header type is not a structure type')
 342
 343             if 'stream_id' not in t.fields:
 344                 raise ConfigError('need "stream_id" field in trace packet header type')
 345
 346         # validate "magic" and "stream_id" types
 347         if type(t) is not metadata.Struct:
 348             return
 349
 350         for i, (field_name, field_type) in enumerate(t.fields.items()):
 351             if field_name == 'magic':
 352                 if type(field_type) is not metadata.Integer:
 353                     raise ConfigError('"magic" field in trace packet header type must be an integer type')
 354
 355                 if field_type.signed or field_type.size != 32:
 356                     raise ConfigError('"magic" field in trace packet header type must be a 32-bit unsigned integer type')
 357
 358                 if i != 0:
 359                     raise ConfigError('"magic" field must be the first trace packet header type\'s field')
 360             elif field_name == 'stream_id':
 361                 if type(field_type) is not metadata.Integer:
 362                     raise ConfigError('"stream_id" field in trace packet header type must be an integer type')
 363
 364                 if field_type.signed:
 365                     raise ConfigError('"stream_id" field in trace packet header type must be an unsigned integer type')
 366
 367                 # "id" size can fit all event IDs
 368                 if len(self._meta.streams) > (1 << field_type.size):
 369                     raise ConfigError('"stream_id" field\' size in trace packet header type is too small for the number of trace streams')
 370             elif field_name == 'uuid':
 371                 if self._meta.trace.uuid is None:
 372                     raise ConfigError('"uuid" field in trace packet header type specified, but no trace UUID provided')
 373
 374                 if type(field_type) is not metadata.Array:
 375                     raise ConfigError('"uuid" field in trace packet header type must be an array')
 376
 377                 if field_type.length != 16:
 378                     raise ConfigError('"uuid" field in trace packet header type must be an array of 16 bytes')
 379
 380                 element_type = field_type.element_type
 381
 382                 if type(element_type) is not metadata.Integer:
 383                     raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned bytes')
 384
 385                 if element_type.size != 8:
 386                     raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned bytes')
 387
 388                 if element_type.signed:
 389                     raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned bytes')
 390
 391                 if element_type.align != 8:
 392                     raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned, byte-aligned bytes')
 393
 394     def _validate_trace(self, meta):
 395         self._validate_trace_packet_header_type(meta.trace.packet_header_type)
 396
 397     def _validate_stream_packet_context(self, stream):
 398         t = stream.packet_context_type
 399
 400         if type(t) is None:
 401             raise ConfigError('missing "packet-context-type" property in stream object')
 402
 403         if type(t) is not metadata.Struct:
 404             raise ConfigError('"packet-context-type": expecting a structure type')
 405
 406         # "timestamp_begin", if exists, is an unsigned integer type,
 407         # mapped to a clock
 408         ts_begin = None
 409
 410         if 'timestamp_begin' in t.fields:
 411             ts_begin = t.fields['timestamp_begin']
 412
 413             if type(ts_begin) is not metadata.Integer:
 414                 raise ConfigError('"timestamp_begin" field in stream packet context type must be an integer type')
 415
 416             if ts_begin.signed:
 417                 raise ConfigError('"timestamp_begin" field in stream packet context type must be an unsigned integer type')
 418
 419             if not ts_begin.property_mappings:
 420                 raise ConfigError('"timestamp_begin" field in stream packet context type must be mapped to a clock')
 421
 422         # "timestamp_end", if exists, is an unsigned integer type,
 423         # mapped to a clock
 424         ts_end = None
 425
 426         if 'timestamp_end' in t.fields:
 427             ts_end = t.fields['timestamp_end']
 428
 429             if type(ts_end) is not metadata.Integer:
 430                 raise ConfigError('"timestamp_end" field in stream packet context type must be an integer type')
 431
 432             if ts_end.signed:
 433                 raise ConfigError('"timestamp_end" field in stream packet context type must be an unsigned integer type')
 434
 435             if not ts_end.property_mappings:
 436                 raise ConfigError('"timestamp_end" field in stream packet context type must be mapped to a clock')
 437
 438         # "timestamp_begin" and "timestamp_end" exist together
 439         if (('timestamp_begin' in t.fields) ^ ('timestamp_end' in t.fields)):
 440             raise ConfigError('"timestamp_begin" and "timestamp_end" fields must be defined together in stream packet context type')
 441
 442         # "timestamp_begin" and "timestamp_end" are mapped to the same clock
 443         if ts_begin is not None and ts_end is not None:
 444             if ts_begin.property_mappings[0].object.name != ts_end.property_mappings[0].object.name:
 445                 raise ConfigError('"timestamp_begin" and "timestamp_end" fields must be mapped to the same clock object in stream packet context type')
 446
 447         # "events_discarded", if exists, is an unsigned integer type
 448         if 'events_discarded' in t.fields:
 449             events_discarded = t.fields['events_discarded']
 450
 451             if type(events_discarded) is not metadata.Integer:
 452                 raise ConfigError('"events_discarded" field in stream packet context type must be an integer type')
 453
 454             if events_discarded.signed:
 455                 raise ConfigError('"events_discarded" field in stream packet context type must be an unsigned integer type')
 456
 457         # "packet_size" and "content_size" must exist
 458         if 'packet_size' not in t.fields:
 459             raise ConfigError('missing "packet_size" field in stream packet context type')
 460
 461         packet_size = t.fields['packet_size']
 462
 463         # "content_size" and "content_size" must exist
 464         if 'content_size' not in t.fields:
 465             raise ConfigError('missing "content_size" field in stream packet context type')
 466
 467         content_size = t.fields['content_size']
 468
 469         # "packet_size" is an unsigned integer type
 470         if type(packet_size) is not metadata.Integer:
 471             raise ConfigError('"packet_size" field in stream packet context type must be an integer type')
 472
 473         if packet_size.signed:
 474             raise ConfigError('"packet_size" field in stream packet context type must be an unsigned integer type')
 475
 476         # "content_size" is an unsigned integer type
 477         if type(content_size) is not metadata.Integer:
 478             raise ConfigError('"content_size" field in stream packet context type must be an integer type')
 479
 480         if content_size.signed:
 481             raise ConfigError('"content_size" field in stream packet context type must be an unsigned integer type')
 482
 483         # "packet_size" size should be greater than or equal to "content_size" size
 484         if content_size.size > packet_size.size:
 485             raise ConfigError('"content_size" field size must be lesser than or equal to "packet_size" field size')
 486
 487     def _validate_stream_event_header(self, stream):
 488         t = stream.event_header_type
 489
 490         # needs "id" field?
 491         if len(stream.events) > 1:
 492             # yes
 493             if t is None:
 494                 raise ConfigError('need "id" field in stream event header type, but stream event header type is missing')
 495
 496             if type(t) is not metadata.Struct:
 497                 raise ConfigError('need "id" field in stream event header type, but stream event header type is not a structure type')
 498
 499             if 'id' not in t.fields:
 500                 raise ConfigError('need "id" field in stream event header type')
 501
 502         # validate "id" and "timestamp" types
 503         if type(t) is not metadata.Struct:
 504             return
 505
 506         # "timestamp", if exists, is an unsigned integer type,
 507         # mapped to a clock
 508         if 'timestamp' in t.fields:
 509             ts = t.fields['timestamp']
 510
 511             if type(ts) is not metadata.Integer:
 512                 raise ConfigError('"timestamp" field in stream event header type must be an integer type')
 513
 514             if ts.signed:
 515                 raise ConfigError('"timestamp" field in stream event header type must be an unsigned integer type')
 516
 517             if not ts.property_mappings:
 518                 raise ConfigError('"timestamp" field in stream event header type must be mapped to a clock')
 519
 520         if 'id' in t.fields:
 521             eid = t.fields['id']
 522
 523             # "id" is an unsigned integer type
 524             if type(eid) is not metadata.Integer:
 525                 raise ConfigError('"id" field in stream event header type must be an integer type')
 526
 527             if eid.signed:
 528                 raise ConfigError('"id" field in stream event header type must be an unsigned integer type')
 529
 530             # "id" size can fit all event IDs
 531             if len(stream.events) > (1 << eid.size):
 532                 raise ConfigError('"id" field\' size in stream event header type is too small for the number of stream events')
 533
 534     def _validate_stream(self, stream):
 535         self._validate_stream_packet_context(stream)
 536         self._validate_stream_event_header(stream)
 537
 538     def validate(self, meta):
 539         self._meta = meta
 540         self._validate_trace(meta)
 541
 542         for stream in meta.streams.values():
 543             try:
 544                 self._validate_stream(stream)
 545             except Exception as e:
 546                 raise ConfigError('invalid stream "{}"'.format(stream.name), e)
 547
 548
 549 class _MetadataDynamicTypesValidatorStackEntry:
 550     def __init__(self, base_t):
 551         self._base_t = base_t
 552         self._index = 0
 553
 554     @property
 555     def index(self):
 556         return self._index
 557
 558     @index.setter
 559     def index(self, value):
 560         self._index = value
 561
 562     @property
 563     def base_t(self):
 564         return self._base_t
 565
 566     @base_t.setter
 567     def base_t(self, value):
 568         self._base_t = value
 569
 570
 571 # Entities. Order of values is important here.
 572 @enum.unique
 573 class _Entity(enum.IntEnum):
 574     TRACE_PACKET_HEADER = 0
 575     STREAM_PACKET_CONTEXT = 1
 576     STREAM_EVENT_HEADER = 2
 577     STREAM_EVENT_CONTEXT = 3
 578     EVENT_CONTEXT = 4
 579     EVENT_PAYLOAD = 5
 580
 581
 582 # This validator validates dynamic metadata types, that is, it ensures
 583 # variable-length array lengths and variant tags actually point to
 584 # something that exists. It also checks that variable-length array
 585 # lengths point to integer types and variant tags to enumeration types.
 586 class _MetadataDynamicTypesValidator:
 587     def __init__(self):
 588         self._type_to_visit_type_func = {
 589             metadata.Integer: None,
 590             metadata.FloatingPoint: None,
 591             metadata.Enum: None,
 592             metadata.String: None,
 593             metadata.Struct: self._visit_struct_type,
 594             metadata.Array: self._visit_array_type,
 595             metadata.Variant: self._visit_variant_type,
 596         }
 597
 598         self._cur_trace = None
 599         self._cur_stream = None
 600         self._cur_event = None
 601
 602     def _lookup_path_from_base(self, path, parts, base, start_index,
 603                                base_is_current, from_t):
 604         index = start_index
 605         cur_t = base
 606         found_path = []
 607
 608         while index < len(parts):
 609             part = parts[index]
 610             next_t = None
 611
 612             if type(cur_t) is metadata.Struct:
 613                 enumerated_items = enumerate(cur_t.fields.items())
 614
 615                 # lookup each field
 616                 for i, (field_name, field_type) in enumerated_items:
 617                     if field_name == part:
 618                         next_t = field_type
 619                         found_path.append((i, field_type))
 620
 621                 if next_t is None:
 622                     raise ConfigError('invalid path "{}": cannot find field "{}" in structure type'.format(path, part))
 623             elif type(cur_t) is metadata.Variant:
 624                 enumerated_items = enumerate(cur_t.types.items())
 625
 626                 # lookup each type
 627                 for i, (type_name, type_type) in enumerated_items:
 628                     if type_name == part:
 629                         next_t = type_type
 630                         found_path.append((i, type_type))
 631
 632                 if next_t is None:
 633                     raise ConfigError('invalid path "{}": cannot find type "{}" in variant type'.format(path, part))
 634             else:
 635                 raise ConfigError('invalid path "{}": requesting "{}" in a non-variant, non-structure type'.format(path, part))
 636
 637             cur_t = next_t
 638             index += 1
 639
 640         # make sure that the pointed type is not the pointing type
 641         if from_t is cur_t:
 642             raise ConfigError('invalid path "{}": pointing to self'.format(path))
 643
 644         # if we're here, we found the type; however, it could be located
 645         # _after_ the variant/VLA looking for it, if the pointing
 646         # and pointed types are in the same entity, so compare the
 647         # current stack entries indexes to our index path in that case
 648         if not base_is_current:
 649             return cur_t
 650
 651         for index, entry in enumerate(self._stack):
 652             if index == len(found_path):
 653                 # end of index path; valid so far
 654                 break
 655
 656             if found_path[index][0] > entry.index:
 657                 raise ConfigError('invalid path "{}": pointed type is after pointing type'.format(path))
 658
 659         # also make sure that both pointed and pointing types share
 660         # a common structure ancestor
 661         for index, entry in enumerate(self._stack):
 662             if index == len(found_path):
 663                 break
 664
 665             if entry.base_t is not found_path[index][1]:
 666                 # found common ancestor
 667                 if type(entry.base_t) is metadata.Variant:
 668                     raise ConfigError('invalid path "{}": type cannot be reached because pointed and pointing types are in the same variant type'.format(path))
 669
 670         return cur_t
 671
 672     def _lookup_path_from_top(self, path, parts):
 673         if len(parts) != 1:
 674             raise ConfigError('invalid path "{}": multipart relative path not supported'.format(path))
 675
 676         find_name = parts[0]
 677         index = len(self._stack) - 1
 678         got_struct = False
 679
 680         # check stack entries in reversed order
 681         for entry in reversed(self._stack):
 682             # structure base type
 683             if type(entry.base_t) is metadata.Struct:
 684                 got_struct = True
 685                 enumerated_items = enumerate(entry.base_t.fields.items())
 686
 687                 # lookup each field, until the current visiting index is met
 688                 for i, (field_name, field_type) in enumerated_items:
 689                     if i == entry.index:
 690                         break
 691
 692                     if field_name == find_name:
 693                         return field_type
 694
 695             # variant base type
 696             elif type(entry.base_t) is metadata.Variant:
 697                 enumerated_items = enumerate(entry.base_t.types.items())
 698
 699                 # lookup each type, until the current visiting index is met
 700                 for i, (type_name, type_type) in enumerated_items:
 701                     if i == entry.index:
 702                         break
 703
 704                     if type_name == find_name:
 705                         if not got_struct:
 706                             raise ConfigError('invalid path "{}": type cannot be reached because pointed and pointing types are in the same variant type'.format(path))
 707
 708                         return type_type
 709
 710         # nothing returned here: cannot find type
 711         raise ConfigError('invalid path "{}": cannot find type in current context'.format(path))
 712
 713     def _lookup_path(self, path, from_t):
 714         parts = path.lower().split('.')
 715         base = None
 716         base_is_current = False
 717
 718         if len(parts) >= 3:
 719             if parts[0] == 'trace':
 720                 if parts[1] == 'packet' and parts[2] == 'header':
 721                     # make sure packet header exists
 722                     if self._cur_trace.packet_header_type is None:
 723                         raise ConfigError('invalid path "{}": no defined trace packet header type'.format(path))
 724
 725                     base = self._cur_trace.packet_header_type
 726
 727                     if self._cur_entity == _Entity.TRACE_PACKET_HEADER:
 728                         base_is_current = True
 729                 else:
 730                     raise ConfigError('invalid path "{}": unknown names after "trace"'.format(path))
 731             elif parts[0] == 'stream':
 732                 if parts[1] == 'packet' and parts[2] == 'context':
 733                     if self._cur_entity < _Entity.STREAM_PACKET_CONTEXT:
 734                         raise ConfigError('invalid path "{}": cannot access stream packet context here'.format(path))
 735
 736                     if self._cur_stream.packet_context_type is None:
 737                         raise ConfigError('invalid path "{}": no defined stream packet context type'.format(path))
 738
 739                     base = self._cur_stream.packet_context_type
 740
 741                     if self._cur_entity == _Entity.STREAM_PACKET_CONTEXT:
 742                         base_is_current = True
 743                 elif parts[1] == 'event':
 744                     if parts[2] == 'header':
 745                         if self._cur_entity < _Entity.STREAM_EVENT_HEADER:
 746                             raise ConfigError('invalid path "{}": cannot access stream event header here'.format(path))
 747
 748                         if self._cur_stream.event_header_type is None:
 749                             raise ConfigError('invalid path "{}": no defined stream event header type'.format(path))
 750
 751                         base = self._cur_stream.event_header_type
 752
 753                         if self._cur_entity == _Entity.STREAM_EVENT_HEADER:
 754                             base_is_current = True
 755                     elif parts[2] == 'context':
 756                         if self._cur_entity < _Entity.STREAM_EVENT_CONTEXT:
 757                             raise ConfigError('invalid path "{}": cannot access stream event context here'.format(path))
 758
 759                         if self._cur_stream.event_context_type is None:
 760                             raise ConfigError('invalid path "{}": no defined stream event context type'.format(path))
 761
 762                         base = self._cur_stream.event_context_type
 763
 764                         if self._cur_entity == _Entity.STREAM_EVENT_CONTEXT:
 765                             base_is_current = True
 766                     else:
 767                         raise ConfigError('invalid path "{}": unknown names after "stream.event"'.format(path))
 768                 else:
 769                     raise ConfigError('invalid path "{}": unknown names after "stream"'.format(path))
 770
 771             if base is not None:
 772                 start_index = 3
 773
 774         if len(parts) >= 2 and base is None:
 775             if parts[0] == 'event':
 776                 if parts[1] == 'context':
 777                     if self._cur_entity < _Entity.EVENT_CONTEXT:
 778                         raise ConfigError('invalid path "{}": cannot access event context here'.format(path))
 779
 780                     if self._cur_event.context_type is None:
 781                         raise ConfigError('invalid path "{}": no defined event context type'.format(path))
 782
 783                     base = self._cur_event.context_type
 784
 785                     if self._cur_entity == _Entity.EVENT_CONTEXT:
 786                         base_is_current = True
 787                 elif parts[1] == 'payload' or parts[1] == 'fields':
 788                     if self._cur_entity < _Entity.EVENT_PAYLOAD:
 789                         raise ConfigError('invalid path "{}": cannot access event payload here'.format(path))
 790
 791                     if self._cur_event.payload_type is None:
 792                         raise ConfigError('invalid path "{}": no defined event payload type'.format(path))
 793
 794                     base = self._cur_event.payload_type
 795
 796                     if self._cur_entity == _Entity.EVENT_PAYLOAD:
 797                         base_is_current = True
 798                 else:
 799                     raise ConfigError('invalid path "{}": unknown names after "event"'.format(path))
 800
 801             if base is not None:
 802                 start_index = 2
 803
 804         if base is not None:
 805             return self._lookup_path_from_base(path, parts, base, start_index,
 806                                                base_is_current, from_t)
 807         else:
 808             return self._lookup_path_from_top(path, parts)
 809
 810     def _stack_reset(self):
 811         self._stack = []
 812
 813     def _stack_push(self, base_t):
 814         entry = _MetadataDynamicTypesValidatorStackEntry(base_t)
 815         self._stack.append(entry)
 816
 817     def _stack_pop(self):
 818         self._stack.pop()
 819
 820     def _stack_incr_index(self):
 821         self._stack[-1].index += 1
 822
 823     def _visit_struct_type(self, t):
 824         self._stack_push(t)
 825
 826         for field_name, field_type in t.fields.items():
 827             try:
 828                 self._visit_type(field_type)
 829             except Exception as e:
 830                 raise ConfigError('in structure type\'s field "{}"'.format(field_name), e)
 831
 832             self._stack_incr_index()
 833
 834         self._stack_pop()
 835
 836     def _visit_array_type(self, t):
 837         if t.is_variable_length:
 838             # find length type
 839             try:
 840                 length_type = self._lookup_path(t.length, t)
 841             except Exception as e:
 842                 raise ConfigError('invalid array type\'s length', e)
 843
 844             # make sure length type an unsigned integer
 845             if type(length_type) is not metadata.Integer:
 846                 raise ConfigError('array type\'s length does not point to an integer type')
 847
 848             if length_type.signed:
 849                 raise ConfigError('array type\'s length does not point to an unsigned integer type')
 850
 851         self._visit_type(t.element_type)
 852
 853     def _visit_variant_type(self, t):
 854         # find tag type
 855         try:
 856             tag_type = self._lookup_path(t.tag, t)
 857         except Exception as e:
 858             raise ConfigError('invalid variant type\'s tag', e)
 859
 860         # make sure tag type is an enumeration
 861         if type(tag_type) is not metadata.Enum:
 862             raise ConfigError('variant type\'s tag does not point to an enumeration type')
 863
 864         # verify that each variant type's type exists as an enumeration member
 865         for tag_name in t.types.keys():
 866             if tag_name not in tag_type.members:
 867                 raise ConfigError('cannot find variant type\'s type "{}" in pointed tag type'.format(tag_name))
 868
 869         self._stack_push(t)
 870
 871         for type_name, type_type in t.types.items():
 872             try:
 873                 self._visit_type(type_type)
 874             except Exception as e:
 875                 raise ConfigError('in variant type\'s type "{}"'.format(type_name), e)
 876
 877             self._stack_incr_index()
 878
 879         self._stack_pop()
 880
 881     def _visit_type(self, t):
 882         if t is None:
 883             return
 884
 885         if type(t) in self._type_to_visit_type_func:
 886             func = self._type_to_visit_type_func[type(t)]
 887
 888             if func is not None:
 889                 func(t)
 890
 891     def _visit_event(self, ev):
 892         ev_name = ev.name
 893
 894         # set current event
 895         self._cur_event = ev
 896
 897         # visit event context type
 898         self._stack_reset()
 899         self._cur_entity = _Entity.EVENT_CONTEXT
 900
 901         try:
 902             self._visit_type(ev.context_type)
 903         except Exception as e:
 904             raise ConfigError('invalid context type in event "{}"'.format(ev_name), e)
 905
 906         # visit event payload type
 907         self._stack_reset()
 908         self._cur_entity = _Entity.EVENT_PAYLOAD
 909
 910         try:
 911             self._visit_type(ev.payload_type)
 912         except Exception as e:
 913             raise ConfigError('invalid payload type in event "{}"'.format(ev_name), e)
 914
 915     def _visit_stream(self, stream):
 916         stream_name = stream.name
 917
 918         # set current stream
 919         self._cur_stream = stream
 920
 921         # reset current event
 922         self._cur_event = None
 923
 924         # visit stream packet context type
 925         self._stack_reset()
 926         self._cur_entity = _Entity.STREAM_PACKET_CONTEXT
 927
 928         try:
 929             self._visit_type(stream.packet_context_type)
 930         except Exception as e:
 931             raise ConfigError('invalid packet context type in stream "{}"'.format(stream_name), e)
 932
 933         # visit stream event header type
 934         self._stack_reset()
 935         self._cur_entity = _Entity.STREAM_EVENT_HEADER
 936
 937         try:
 938             self._visit_type(stream.event_header_type)
 939         except Exception as e:
 940             raise ConfigError('invalid event header type in stream "{}"'.format(stream_name), e)
 941
 942         # visit stream event context type
 943         self._stack_reset()
 944         self._cur_entity = _Entity.STREAM_EVENT_CONTEXT
 945
 946         try:
 947             self._visit_type(stream.event_context_type)
 948         except Exception as e:
 949             raise ConfigError('invalid event context type in stream "{}"'.format(stream_name), e)
 950
 951         # visit events
 952         for ev in stream.events.values():
 953             try:
 954                 self._visit_event(ev)
 955             except Exception as e:
 956                 raise ConfigError('invalid stream "{}"'.format(stream_name))
 957
 958     def validate(self, meta):
 959         # set current trace
 960         self._cur_trace = meta.trace
 961
 962         # visit trace packet header type
 963         self._stack_reset()
 964         self._cur_entity = _Entity.TRACE_PACKET_HEADER
 965
 966         try:
 967             self._visit_type(meta.trace.packet_header_type)
 968         except Exception as e:
 969             raise ConfigError('invalid packet header type in trace', e)
 970
 971         # visit streams
 972         for stream in meta.streams.values():
 973             self._visit_stream(stream)
 974
 975
 976 # Since type inheritance allows types to be only partially defined at
 977 # any place in the configuration, this validator validates that actual
 978 # trace, stream, and event types are all complete and valid. Therefore
 979 # an invalid, but unusued type alias is accepted.
 980 class _MetadataTypesHistologyValidator:
 981     def __init__(self):
 982         self._type_to_validate_type_histology_func = {
 983             metadata.Integer: self._validate_integer_histology,
 984             metadata.FloatingPoint: self._validate_float_histology,
 985             metadata.Enum: self._validate_enum_histology,
 986             metadata.String: self._validate_string_histology,
 987             metadata.Struct: self._validate_struct_histology,
 988             metadata.Array: self._validate_array_histology,
 989             metadata.Variant: self._validate_variant_histology,
 990         }
 991
 992     def _validate_integer_histology(self, t):
 993         # size is set
 994         if t.size is None:
 995             raise ConfigError('missing integer type\'s size')
 996
 997     def _validate_float_histology(self, t):
 998         # exponent digits is set
 999         if t.exp_size is None:
1000             raise ConfigError('missing floating point number type\'s exponent size')
1001
1002         # mantissa digits is set
1003         if t.mant_size is None:
1004             raise ConfigError('missing floating point number type\'s mantissa size')
1005
1006         # exponent and mantissa sum is a multiple of 8
1007         if (t.exp_size + t.mant_size) % 8 != 0:
1008             raise ConfigError('floating point number type\'s mantissa and exponent sizes sum must be a multiple of 8')
1009
1010     def _validate_enum_histology(self, t):
1011         # integer type is set
1012         if t.value_type is None:
1013             raise ConfigError('missing enumeration type\'s value type')
1014
1015         # there's at least one member
1016         if not t.members:
1017             raise ConfigError('enumeration type needs at least one member')
1018
1019         # no overlapping values and all values are valid considering
1020         # the value type
1021         ranges = []
1022
1023         if t.value_type.signed:
1024             value_min = -(1 << t.value_type.size - 1)
1025             value_max = (1 << (t.value_type.size - 1)) - 1
1026         else:
1027             value_min = 0
1028             value_max = (1 << t.value_type.size) - 1
1029
1030         for label, value in t.members.items():
1031             for rg in ranges:
1032                 if value[0] <= rg[1] and rg[0] <= value[1]:
1033                     raise ConfigError('enumeration type\'s member "{}" overlaps another member'.format(label))
1034
1035             fmt = 'enumeration type\'s member "{}": value {} is outside the value type range [{}, {}]'
1036
1037             if value[0] < value_min or value[0] > value_max:
1038                 raise ConfigError(fmt.format(label, value[0], value_min, value_max))
1039
1040             if value[1] < value_min or value[1] > value_max:
1041                 raise ConfigError(fmt.format(label, value[1], value_min, value_max))
1042
1043             ranges.append(value)
1044
1045     def _validate_string_histology(self, t):
1046         # always valid
1047         pass
1048
1049     def _validate_struct_histology(self, t):
1050         # all fields are valid
1051         for field_name, field_type in t.fields.items():
1052             try:
1053                 self._validate_type_histology(field_type)
1054             except Exception as e:
1055                 raise ConfigError('invalid structure type\'s field "{}"'.format(field_name), e)
1056
1057     def _validate_array_histology(self, t):
1058         # length is set
1059         if t.length is None:
1060             raise ConfigError('missing array type\'s length')
1061
1062         # element type is set
1063         if t.element_type is None:
1064             raise ConfigError('missing array type\'s element type')
1065
1066         # element type is valid
1067         try:
1068             self._validate_type_histology(t.element_type)
1069         except Exception as e:
1070             raise ConfigError('invalid array type\'s element type', e)
1071
1072     def _validate_variant_histology(self, t):
1073         # tag is set
1074         if t.tag is None:
1075             raise ConfigError('missing variant type\'s tag')
1076
1077         # there's at least one type
1078         if not t.types:
1079             raise ConfigError('variant type needs at least one type')
1080
1081         # all types are valid
1082         for type_name, type_t in t.types.items():
1083             try:
1084                 self._validate_type_histology(type_t)
1085             except Exception as e:
1086                 raise ConfigError('invalid variant type\'s type "{}"'.format(type_name), e)
1087
1088     def _validate_type_histology(self, t):
1089         if t is None:
1090             return
1091
1092         self._type_to_validate_type_histology_func[type(t)](t)
1093
1094     def _validate_entity_type_histology(self, t):
1095         if t is None:
1096             return
1097
1098         if type(t) is not metadata.Struct:
1099             raise ConfigError('expecting a structure type')
1100
1101         self._validate_type_histology(t)
1102
1103     def _validate_event_types_histology(self, ev):
1104         ev_name = ev.name
1105
1106         # validate event context type
1107         try:
1108             self._validate_entity_type_histology(ev.context_type)
1109         except Exception as e:
1110             raise ConfigError('invalid event context type for event "{}"'.format(ev_name), e)
1111
1112         # validate event payload type
1113         if ev.payload_type is None:
1114             raise ConfigError('event payload type must exist in event "{}"'.format(ev_name))
1115
1116         # TODO: also check arrays, sequences, and variants
1117         if type(ev.payload_type) is metadata.Struct:
1118             if not ev.payload_type.fields:
1119                 raise ConfigError('event payload type must have at least one field for event "{}"'.format(ev_name))
1120
1121         try:
1122             self._validate_entity_type_histology(ev.payload_type)
1123         except Exception as e:
1124             raise ConfigError('invalid event payload type for event "{}"'.format(ev_name), e)
1125
1126     def _validate_stream_types_histology(self, stream):
1127         stream_name = stream.name
1128
1129         # validate stream packet context type
1130         try:
1131             self._validate_entity_type_histology(stream.packet_context_type)
1132         except Exception as e:
1133             raise ConfigError('invalid stream packet context type for stream "{}"'.format(stream_name), e)
1134
1135         # validate stream event header type
1136         try:
1137             self._validate_entity_type_histology(stream.event_header_type)
1138         except Exception as e:
1139             raise ConfigError('invalid stream event header type for stream "{}"'.format(stream_name), e)
1140
1141         # validate stream event context type
1142         try:
1143             self._validate_entity_type_histology(stream.event_context_type)
1144         except Exception as e:
1145             raise ConfigError('invalid stream event context type for stream "{}"'.format(stream_name), e)
1146
1147         # validate events
1148         for ev in stream.events.values():
1149             try:
1150                 self._validate_event_types_histology(ev)
1151             except Exception as e:
1152                 raise ConfigError('invalid event in stream "{}"'.format(stream_name), e)
1153
1154     def validate(self, meta):
1155         # validate trace packet header type
1156         try:
1157             self._validate_entity_type_histology(meta.trace.packet_header_type)
1158         except Exception as e:
1159             raise ConfigError('invalid trace packet header type', e)
1160
1161         # validate streams
1162         for stream in meta.streams.values():
1163             self._validate_stream_types_histology(stream)
1164
1165
1166 class _YamlConfigParser:
1167     def __init__(self, include_dirs, ignore_include_not_found, dump_config):
1168         self._class_name_to_create_type_func = {
1169             'int': self._create_integer,
1170             'integer': self._create_integer,
1171             'flt': self._create_float,
1172             'float': self._create_float,
1173             'floating-point': self._create_float,
1174             'enum': self._create_enum,
1175             'enumeration': self._create_enum,
1176             'str': self._create_string,
1177             'string': self._create_string,
1178             'struct': self._create_struct,
1179             'structure': self._create_struct,
1180             'array': self._create_array,
1181             'var': self._create_variant,
1182             'variant': self._create_variant,
1183         }
1184         self._type_to_create_type_func = {
1185             metadata.Integer: self._create_integer,
1186             metadata.FloatingPoint: self._create_float,
1187             metadata.Enum: self._create_enum,
1188             metadata.String: self._create_string,
1189             metadata.Struct: self._create_struct,
1190             metadata.Array: self._create_array,
1191             metadata.Variant: self._create_variant,
1192         }
1193         self._include_dirs = include_dirs
1194         self._ignore_include_not_found = ignore_include_not_found
1195         self._dump_config = dump_config
1196
1197     def _set_byte_order(self, metadata_node):
1198         if 'trace' not in metadata_node:
1199             raise ConfigError('missing "trace" property (metadata)')
1200
1201         trace_node = metadata_node['trace']
1202
1203         if not _is_assoc_array_prop(trace_node):
1204             raise ConfigError('"trace" property (metadata) must be an associative array')
1205
1206         if 'byte-order' not in trace_node:
1207             raise ConfigError('missing "byte-order" property (trace)')
1208
1209         bo_node = trace_node['byte-order']
1210
1211         if not _is_str_prop(bo_node):
1212             raise ConfigError('"byte-order" property of trace object must be a string ("le" or "be")')
1213
1214         self._bo = _byte_order_str_to_bo(bo_node)
1215
1216         if self._bo is None:
1217             raise ConfigError('invalid "byte-order" property (trace): must be "le" or "be"')
1218
1219     def _lookup_type_alias(self, name):
1220         if name in self._tas:
1221             return copy.deepcopy(self._tas[name])
1222
1223     def _set_int_clock_prop_mapping(self, int_obj, prop_mapping_node):
1224         unk_prop = _get_first_unknown_prop(prop_mapping_node, ['type', 'name', 'property'])
1225
1226         if unk_prop:
1227             raise ConfigError('unknown property in integer type object\'s clock property mapping: "{}"'.format(unk_prop))
1228
1229         if 'name' not in prop_mapping_node:
1230             raise ConfigError('missing "name" property in integer type object\'s clock property mapping')
1231
1232         if 'property' not in prop_mapping_node:
1233             raise ConfigError('missing "property" property in integer type object\'s clock property mapping')
1234
1235         clock_name = prop_mapping_node['name']
1236         prop = prop_mapping_node['property']
1237
1238         if not _is_str_prop(clock_name):
1239             raise ConfigError('"name" property of integer type object\'s clock property mapping must be a string')
1240
1241         if not _is_str_prop(prop):
1242             raise ConfigError('"property" property of integer type object\'s clock property mapping must be a string')
1243
1244         if clock_name not in self._clocks:
1245             raise ConfigError('invalid clock name "{}" in integer type object\'s clock property mapping'.format(clock_name))
1246
1247         if prop != 'value':
1248             raise ConfigError('invalid "property" property in integer type object\'s clock property mapping: "{}"'.format(prop))
1249
1250         mapped_clock = self._clocks[clock_name]
1251         int_obj.property_mappings.append(metadata.PropertyMapping(mapped_clock, prop))
1252
1253     def _get_first_unknown_type_prop(self, type_node, known_props):
1254         kp = known_props + ['inherit', 'class']
1255
1256         if self._version >= 201:
1257             kp.append('$inherit')
1258
1259         return _get_first_unknown_prop(type_node, kp)
1260
1261     def _create_integer(self, obj, node):
1262         if obj is None:
1263             # create integer object
1264             obj = metadata.Integer()
1265
1266         unk_prop = self._get_first_unknown_type_prop(node, [
1267             'size',
1268             'align',
1269             'signed',
1270             'byte-order',
1271             'base',
1272             'encoding',
1273             'property-mappings',
1274         ])
1275
1276         if unk_prop:
1277             raise ConfigError('unknown integer type object property: "{}"'.format(unk_prop))
1278
1279         # size
1280         if 'size' in node:
1281             size = node['size']
1282
1283             if not _is_int_prop(size):
1284                 raise ConfigError('"size" property of integer type object must be an integer')
1285
1286             if size < 1:
1287                 raise ConfigError('invalid integer size: {}'.format(size))
1288
1289             obj.size = size
1290
1291         # align
1292         if 'align' in node:
1293             align = node['align']
1294
1295             if align is None:
1296                 obj.set_default_align()
1297             else:
1298                 if not _is_int_prop(align):
1299                     raise ConfigError('"align" property of integer type object must be an integer')
1300
1301                 if not _is_valid_alignment(align):
1302                     raise ConfigError('invalid alignment: {}'.format(align))
1303
1304                 obj.align = align
1305
1306         # signed
1307         if 'signed' in node:
1308             signed = node['signed']
1309
1310             if signed is None:
1311                 obj.set_default_signed()
1312             else:
1313                 if not _is_bool_prop(signed):
1314                     raise ConfigError('"signed" property of integer type object must be a boolean')
1315
1316                 obj.signed = signed
1317
1318         # byte order
1319         if 'byte-order' in node:
1320             byte_order = node['byte-order']
1321
1322             if byte_order is None:
1323                 obj.byte_order = self._bo
1324             else:
1325                 if not _is_str_prop(byte_order):
1326                     raise ConfigError('"byte-order" property of integer type object must be a string ("le" or "be")')
1327
1328                 byte_order = _byte_order_str_to_bo(byte_order)
1329
1330                 if byte_order is None:
1331                     raise ConfigError('invalid "byte-order" property in integer type object')
1332
1333                 obj.byte_order = byte_order
1334         else:
1335             obj.byte_order = self._bo
1336
1337         # base
1338         if 'base' in node:
1339             base = node['base']
1340
1341             if base is None:
1342                 obj.set_default_base()
1343             else:
1344                 if not _is_str_prop(base):
1345                     raise ConfigError('"base" property of integer type object must be a string ("bin", "oct", "dec", or "hex")')
1346
1347                 if base == 'bin':
1348                     base = 2
1349                 elif base == 'oct':
1350                     base = 8
1351                 elif base == 'dec':
1352                     base = 10
1353                 elif base == 'hex':
1354                     base = 16
1355                 else:
1356                     raise ConfigError('unknown "base" property value: "{}" ("bin", "oct", "dec", and "hex" are accepted)'.format(base))
1357
1358                 obj.base = base
1359
1360         # encoding
1361         if 'encoding' in node:
1362             encoding = node['encoding']
1363
1364             if encoding is None:
1365                 obj.set_default_encoding()
1366             else:
1367                 if not _is_str_prop(encoding):
1368                     raise ConfigError('"encoding" property of integer type object must be a string ("none", "ascii", or "utf-8")')
1369
1370                 encoding = _encoding_str_to_encoding(encoding)
1371
1372                 if encoding is None:
1373                     raise ConfigError('invalid "encoding" property in integer type object')
1374
1375                 obj.encoding = encoding
1376
1377         # property mappings
1378         if 'property-mappings' in node:
1379             prop_mappings = node['property-mappings']
1380
1381             if prop_mappings is None:
1382                 obj.set_default_property_mappings()
1383             else:
1384                 if not _is_array_prop(prop_mappings):
1385                     raise ConfigError('"property-mappings" property of integer type object must be an array')
1386
1387                 if len(prop_mappings) > 1:
1388                     raise ConfigError('length of "property-mappings" array in integer type object must be 1')
1389
1390                 for index, prop_mapping in enumerate(prop_mappings):
1391                     if not _is_assoc_array_prop(prop_mapping):
1392                         raise ConfigError('elements of "property-mappings" property of integer type object must be associative arrays')
1393
1394                     if 'type' not in prop_mapping:
1395                         raise ConfigError('missing "type" property in integer type object\'s "property-mappings" array\'s element #{}'.format(index))
1396
1397                     prop_type = prop_mapping['type']
1398
1399                     if not _is_str_prop(prop_type):
1400                         raise ConfigError('"type" property of integer type object\'s "property-mappings" array\'s element #{} must be a string'.format(index))
1401
1402                     if prop_type == 'clock':
1403                         self._set_int_clock_prop_mapping(obj, prop_mapping)
1404                     else:
1405                         raise ConfigError('unknown property mapping type "{}" in integer type object\'s "property-mappings" array\'s element #{}'.format(prop_type, index))
1406
1407         return obj
1408
1409     def _create_float(self, obj, node):
1410         if obj is None:
1411             # create floating point number object
1412             obj = metadata.FloatingPoint()
1413
1414         unk_prop = self._get_first_unknown_type_prop(node, [
1415             'size',
1416             'align',
1417             'byte-order',
1418         ])
1419
1420         if unk_prop:
1421             raise ConfigError('unknown floating point number type object property: "{}"'.format(unk_prop))
1422
1423         # size
1424         if 'size' in node:
1425             size = node['size']
1426
1427             if not _is_assoc_array_prop(size):
1428                 raise ConfigError('"size" property of floating point number type object must be an associative array')
1429
1430             unk_prop = _get_first_unknown_prop(size, ['exp', 'mant'])
1431
1432             if unk_prop:
1433                 raise ConfigError('unknown floating point number type object\'s "size" property: "{}"'.format(unk_prop))
1434
1435             if 'exp' in size:
1436                 exp = size['exp']
1437
1438                 if not _is_int_prop(exp):
1439                     raise ConfigError('"exp" property of floating point number type object\'s "size" property must be an integer')
1440
1441                 if exp < 1:
1442                     raise ConfigError('invalid floating point number exponent size: {}')
1443
1444                 obj.exp_size = exp
1445
1446             if 'mant' in size:
1447                 mant = size['mant']
1448
1449                 if not _is_int_prop(mant):
1450                     raise ConfigError('"mant" property of floating point number type object\'s "size" property must be an integer')
1451
1452                 if mant < 1:
1453                     raise ConfigError('invalid floating point number mantissa size: {}')
1454
1455                 obj.mant_size = mant
1456
1457         # align
1458         if 'align' in node:
1459             align = node['align']
1460
1461             if align is None:
1462                 obj.set_default_align()
1463             else:
1464                 if not _is_int_prop(align):
1465                     raise ConfigError('"align" property of floating point number type object must be an integer')
1466
1467                 if not _is_valid_alignment(align):
1468                     raise ConfigError('invalid alignment: {}'.format(align))
1469
1470                 obj.align = align
1471
1472         # byte order
1473         if 'byte-order' in node:
1474             byte_order = node['byte-order']
1475
1476             if byte_order is None:
1477                 obj.byte_order = self._bo
1478             else:
1479                 if not _is_str_prop(byte_order):
1480                     raise ConfigError('"byte-order" property of floating point number type object must be a string ("le" or "be")')
1481
1482                 byte_order = _byte_order_str_to_bo(byte_order)
1483
1484                 if byte_order is None:
1485                     raise ConfigError('invalid "byte-order" property in floating point number type object')
1486         else:
1487             obj.byte_order = self._bo
1488
1489         return obj
1490
1491     def _create_enum(self, obj, node):
1492         if obj is None:
1493             # create enumeration object
1494             obj = metadata.Enum()
1495
1496         unk_prop = self._get_first_unknown_type_prop(node, [
1497             'value-type',
1498             'members',
1499         ])
1500
1501         if unk_prop:
1502             raise ConfigError('unknown enumeration type object property: "{}"'.format(unk_prop))
1503
1504         # value type
1505         if 'value-type' in node:
1506             try:
1507                 obj.value_type = self._create_type(node['value-type'])
1508             except Exception as e:
1509                 raise ConfigError('cannot create enumeration type\'s integer type', e)
1510
1511         # members
1512         if 'members' in node:
1513             members_node = node['members']
1514
1515             if not _is_array_prop(members_node):
1516                 raise ConfigError('"members" property of enumeration type object must be an array')
1517
1518             cur = 0
1519
1520             for index, m_node in enumerate(members_node):
1521                 if not _is_str_prop(m_node) and not _is_assoc_array_prop(m_node):
1522                     raise ConfigError('invalid enumeration member #{}: expecting a string or an associative array'.format(index))
1523
1524                 if _is_str_prop(m_node):
1525                     label = m_node
1526                     value = (cur, cur)
1527                     cur += 1
1528                 else:
1529                     unk_prop = _get_first_unknown_prop(m_node, [
1530                         'label',
1531                         'value',
1532                     ])
1533
1534                     if unk_prop:
1535                         raise ConfigError('unknown enumeration type member object property: "{}"'.format(unk_prop))
1536
1537                     if 'label' not in m_node:
1538                         raise ConfigError('missing "label" property in enumeration member #{}'.format(index))
1539
1540                     label = m_node['label']
1541
1542                     if not _is_str_prop(label):
1543                         raise ConfigError('"label" property of enumeration member #{} must be a string'.format(index))
1544
1545                     if 'value' not in m_node:
1546                         raise ConfigError('missing "value" property in enumeration member ("{}")'.format(label))
1547
1548                     value = m_node['value']
1549
1550                     if not _is_int_prop(value) and not _is_array_prop(value):
1551                         raise ConfigError('invalid enumeration member ("{}"): expecting an integer or an array'.format(label))
1552
1553                     if _is_int_prop(value):
1554                         cur = value + 1
1555                         value = (value, value)
1556                     else:
1557                         if len(value) != 2:
1558                             raise ConfigError('invalid enumeration member ("{}"): range must have exactly two items'.format(label))
1559
1560                         mn = value[0]
1561                         mx = value[1]
1562
1563                         if mn > mx:
1564                             raise ConfigError('invalid enumeration member ("{}"): invalid range ({} > {})'.format(label, mn, mx))
1565
1566                         value = (mn, mx)
1567                         cur = mx + 1
1568
1569                 obj.members[label] = value
1570
1571         return obj
1572
1573     def _create_string(self, obj, node):
1574         if obj is None:
1575             # create string object
1576             obj = metadata.String()
1577
1578         unk_prop = self._get_first_unknown_type_prop(node, [
1579             'encoding',
1580         ])
1581
1582         if unk_prop:
1583             raise ConfigError('unknown string type object property: "{}"'.format(unk_prop))
1584
1585         # encoding
1586         if 'encoding' in node:
1587             encoding = node['encoding']
1588
1589             if not _is_str_prop(encoding):
1590                 raise ConfigError('"encoding" property of string type object must be a string ("none", "ascii", or "utf-8")')
1591
1592             encoding = _encoding_str_to_encoding(encoding)
1593
1594             if encoding is None:
1595                 raise ConfigError('invalid "encoding" property in string type object')
1596
1597             obj.encoding = encoding
1598
1599         return obj
1600
1601     def _create_struct(self, obj, node):
1602         if obj is None:
1603             # create structure object
1604             obj = metadata.Struct()
1605
1606         unk_prop = self._get_first_unknown_type_prop(node, [
1607             'min-align',
1608             'fields',
1609         ])
1610
1611         if unk_prop:
1612             raise ConfigError('unknown string type object property: "{}"'.format(unk_prop))
1613
1614         # minimum alignment
1615         if 'min-align' in node:
1616             min_align = node['min-align']
1617
1618             if not _is_int_prop(min_align):
1619                 raise ConfigError('"min-align" property of structure type object must be an integer')
1620
1621             if not _is_valid_alignment(min_align):
1622                 raise ConfigError('invalid minimum alignment: {}'.format(min_align))
1623
1624             obj.min_align = min_align
1625
1626         # fields
1627         if 'fields' in node:
1628             fields = node['fields']
1629
1630             if not _is_assoc_array_prop(fields):
1631                 raise ConfigError('"fields" property of structure type object must be an associative array')
1632
1633             for field_name, field_node in fields.items():
1634                 if not is_valid_identifier(field_name):
1635                     raise ConfigError('"{}" is not a valid field name for structure type'.format(field_name))
1636
1637                 try:
1638                     obj.fields[field_name] = self._create_type(field_node)
1639                 except Exception as e:
1640                     raise ConfigError('cannot create structure type\'s field "{}"'.format(field_name), e)
1641
1642         return obj
1643
1644     def _create_array(self, obj, node):
1645         if obj is None:
1646             # create array object
1647             obj = metadata.Array()
1648
1649         unk_prop = self._get_first_unknown_type_prop(node, [
1650             'length',
1651             'element-type',
1652         ])
1653
1654         if unk_prop:
1655             raise ConfigError('unknown array type object property: "{}"'.format(unk_prop))
1656
1657         # length
1658         if 'length' in node:
1659             length = node['length']
1660
1661             if not _is_int_prop(length) and not _is_str_prop(length):
1662                 raise ConfigError('"length" property of array type object must be an integer or a string')
1663
1664             if type(length) is int and length < 0:
1665                 raise ConfigError('invalid static array length: {}'.format(length))
1666
1667             obj.length = length
1668
1669         # element type
1670         if 'element-type' in node:
1671             try:
1672                 obj.element_type = self._create_type(node['element-type'])
1673             except Exception as e:
1674                 raise ConfigError('cannot create array type\'s element type', e)
1675
1676         return obj
1677
1678     def _create_variant(self, obj, node):
1679         if obj is None:
1680             # create variant object
1681             obj = metadata.Variant()
1682
1683         unk_prop = self._get_first_unknown_type_prop(node, [
1684             'tag',
1685             'types',
1686         ])
1687
1688         if unk_prop:
1689             raise ConfigError('unknown variant type object property: "{}"'.format(unk_prop))
1690
1691         # tag
1692         if 'tag' in node:
1693             tag = node['tag']
1694
1695             if not _is_str_prop(tag):
1696                 raise ConfigError('"tag" property of variant type object must be a string')
1697
1698             # do not validate variant tag for the moment; will be done in a
1699             # second phase
1700             obj.tag = tag
1701
1702         # element type
1703         if 'types' in node:
1704             types = node['types']
1705
1706             if not _is_assoc_array_prop(types):
1707                 raise ConfigError('"types" property of variant type object must be an associative array')
1708
1709             # do not validate type names for the moment; will be done in a
1710             # second phase
1711             for type_name, type_node in types.items():
1712                 if not is_valid_identifier(type_name):
1713                     raise ConfigError('"{}" is not a valid type name for variant type'.format(type_name))
1714
1715                 try:
1716                     obj.types[type_name] = self._create_type(type_node)
1717                 except Exception as e:
1718                     raise ConfigError('cannot create variant type\'s type "{}"'.format(type_name), e)
1719
1720         return obj
1721
1722     def _create_type(self, type_node):
1723         if type(type_node) is str:
1724             t = self._lookup_type_alias(type_node)
1725
1726             if t is None:
1727                 raise ConfigError('unknown type alias "{}"'.format(type_node))
1728
1729             return t
1730
1731         if not _is_assoc_array_prop(type_node):
1732             raise ConfigError('type objects must be associative arrays or strings (type alias name)')
1733
1734         # inherit:
1735         #   v2.0:  "inherit"
1736         #   v2.1+: "$inherit"
1737         inherit_node = None
1738
1739         if self._version >= 200:
1740             if 'inherit' in type_node:
1741                 inherit_prop = 'inherit'
1742                 inherit_node = type_node[inherit_prop]
1743
1744         if self._version >= 201:
1745             if '$inherit' in type_node:
1746                 if inherit_node is not None:
1747                     raise ConfigError('cannot specify both "inherit" and "$inherit" properties of type object: prefer "$inherit"')
1748
1749                 inherit_prop = '$inherit'
1750                 inherit_node = type_node[inherit_prop]
1751
1752         if inherit_node is not None and 'class' in type_node:
1753             raise ConfigError('cannot specify both "{}" and "class" properties in type object'.format(inherit_prop))
1754
1755         if inherit_node is not None:
1756             if not _is_str_prop(inherit_node):
1757                 raise ConfigError('"{}" property of type object must be a string'.format(inherit_prop))
1758
1759             base = self._lookup_type_alias(inherit_node)
1760
1761             if base is None:
1762                 raise ConfigError('cannot inherit from type alias "{}": type alias does not exist at this point'.format(inherit_node))
1763
1764             func = self._type_to_create_type_func[type(base)]
1765         else:
1766             if 'class' not in type_node:
1767                 raise ConfigError('type objects which do not inherit must have a "class" property')
1768
1769             class_name = type_node['class']
1770
1771             if type(class_name) is not str:
1772                 raise ConfigError('type objects\' "class" property must be a string')
1773
1774             if class_name not in self._class_name_to_create_type_func:
1775                 raise ConfigError('unknown type class "{}"'.format(class_name))
1776
1777             base = None
1778             func = self._class_name_to_create_type_func[class_name]
1779
1780         return func(base, type_node)
1781
1782     def _register_type_aliases(self, metadata_node):
1783         self._tas = dict()
1784
1785         if 'type-aliases' not in metadata_node:
1786             return
1787
1788         ta_node = metadata_node['type-aliases']
1789
1790         if not _is_assoc_array_prop(ta_node):
1791             raise ConfigError('"type-aliases" property (metadata) must be an associative array')
1792
1793         for ta_name, ta_type in ta_node.items():
1794             if ta_name in self._tas:
1795                 raise ConfigError('duplicate type alias "{}"'.format(ta_name))
1796
1797             try:
1798                 t = self._create_type(ta_type)
1799             except Exception as e:
1800                 raise ConfigError('cannot create type alias "{}"'.format(ta_name), e)
1801
1802             self._tas[ta_name] = t
1803
1804     def _create_clock(self, node):
1805         # create clock object
1806         clock = metadata.Clock()
1807
1808         if not _is_assoc_array_prop(node):
1809             raise ConfigError('clock objects must be associative arrays')
1810
1811         known_props = [
1812             'uuid',
1813             'description',
1814             'freq',
1815             'error-cycles',
1816             'offset',
1817             'absolute',
1818             'return-ctype',
1819         ]
1820
1821         if self._version >= 201:
1822             known_props.append('$return-ctype')
1823
1824         unk_prop = _get_first_unknown_prop(node, known_props)
1825
1826         if unk_prop:
1827             raise ConfigError('unknown clock object property: "{}"'.format(unk_prop))
1828
1829         # UUID
1830         if 'uuid' in node:
1831             uuidp = node['uuid']
1832
1833             if not _is_str_prop(uuidp):
1834                 raise ConfigError('"uuid" property of clock object must be a string')
1835
1836             try:
1837                 uuidp = uuid.UUID(uuidp)
1838             except:
1839                 raise ConfigError('malformed UUID (clock object): "{}"'.format(uuidp))
1840
1841             clock.uuid = uuidp
1842
1843         # description
1844         if 'description' in node:
1845             desc = node['description']
1846
1847             if not _is_str_prop(desc):
1848                 raise ConfigError('"description" property of clock object must be a string')
1849
1850             clock.description = desc
1851
1852         # frequency
1853         if 'freq' in node:
1854             freq = node['freq']
1855
1856             if not _is_int_prop(freq):
1857                 raise ConfigError('"freq" property of clock object must be an integer')
1858
1859             if freq < 1:
1860                 raise ConfigError('invalid clock frequency: {}'.format(freq))
1861
1862             clock.freq = freq
1863
1864         # error cycles
1865         if 'error-cycles' in node:
1866             error_cycles = node['error-cycles']
1867
1868             if not _is_int_prop(error_cycles):
1869                 raise ConfigError('"error-cycles" property of clock object must be an integer')
1870
1871             if error_cycles < 0:
1872                 raise ConfigError('invalid clock error cycles: {}'.format(error_cycles))
1873
1874             clock.error_cycles = error_cycles
1875
1876         # offset
1877         if 'offset' in node:
1878             offset = node['offset']
1879
1880             if not _is_assoc_array_prop(offset):
1881                 raise ConfigError('"offset" property of clock object must be an associative array')
1882
1883             unk_prop = _get_first_unknown_prop(offset, ['cycles', 'seconds'])
1884
1885             if unk_prop:
1886                 raise ConfigError('unknown clock object\'s offset property: "{}"'.format(unk_prop))
1887
1888             # cycles
1889             if 'cycles' in offset:
1890                 offset_cycles = offset['cycles']
1891
1892                 if not _is_int_prop(offset_cycles):
1893                     raise ConfigError('"cycles" property of clock object\'s offset property must be an integer')
1894
1895                 if offset_cycles < 0:
1896                     raise ConfigError('invalid clock offset cycles: {}'.format(offset_cycles))
1897
1898                 clock.offset_cycles = offset_cycles
1899
1900             # seconds
1901             if 'seconds' in offset:
1902                 offset_seconds = offset['seconds']
1903
1904                 if not _is_int_prop(offset_seconds):
1905                     raise ConfigError('"seconds" property of clock object\'s offset property must be an integer')
1906
1907                 if offset_seconds < 0:
1908                     raise ConfigError('invalid clock offset seconds: {}'.format(offset_seconds))
1909
1910                 clock.offset_seconds = offset_seconds
1911
1912         # absolute
1913         if 'absolute' in node:
1914             absolute = node['absolute']
1915
1916             if not _is_bool_prop(absolute):
1917                 raise ConfigError('"absolute" property of clock object must be a boolean')
1918
1919             clock.absolute = absolute
1920
1921         # return C type:
1922         #   v2.0:  "return-ctype"
1923         #   v2.1+: "$return-ctype"
1924         return_ctype_node = None
1925
1926         if self._version >= 200:
1927             if 'return-ctype' in node:
1928                 return_ctype_prop = 'return-ctype'
1929                 return_ctype_node = node[return_ctype_prop]
1930
1931         if self._version >= 201:
1932             if '$return-ctype' in node:
1933                 if return_ctype_node is not None:
1934                     raise ConfigError('cannot specify both "return-ctype" and "$return-ctype" properties of clock object: prefer "$return-ctype"')
1935
1936                 return_ctype_prop = '$return-ctype'
1937                 return_ctype_node = node[return_ctype_prop]
1938
1939         if return_ctype_node is not None:
1940             if not _is_str_prop(return_ctype_node):
1941                 raise ConfigError('"{}" property of clock object must be a string'.format(return_ctype_prop))
1942
1943             clock.return_ctype = return_ctype_node
1944
1945         return clock
1946
1947     def _register_clocks(self, metadata_node):
1948         self._clocks = collections.OrderedDict()
1949
1950         if 'clocks' not in metadata_node:
1951             return
1952
1953         clocks_node = metadata_node['clocks']
1954
1955         if not _is_assoc_array_prop(clocks_node):
1956             raise ConfigError('"clocks" property (metadata) must be an associative array')
1957
1958         for clock_name, clock_node in clocks_node.items():
1959             if not is_valid_identifier(clock_name):
1960                 raise ConfigError('invalid clock name: "{}"'.format(clock_name))
1961
1962             if clock_name in self._clocks:
1963                 raise ConfigError('duplicate clock "{}"'.format(clock_name))
1964
1965             try:
1966                 clock = self._create_clock(clock_node)
1967             except Exception as e:
1968                 raise ConfigError('cannot create clock "{}"'.format(clock_name), e)
1969
1970             clock.name = clock_name
1971             self._clocks[clock_name] = clock
1972
1973     def _create_env(self, metadata_node):
1974         env = collections.OrderedDict()
1975
1976         if 'env' not in metadata_node:
1977             return env
1978
1979         env_node = metadata_node['env']
1980
1981         if not _is_assoc_array_prop(env_node):
1982             raise ConfigError('"env" property (metadata) must be an associative array')
1983
1984         for env_name, env_value in env_node.items():
1985             if env_name in env:
1986                 raise ConfigError('duplicate environment variable "{}"'.format(env_name))
1987
1988             if not is_valid_identifier(env_name):
1989                 raise ConfigError('invalid environment variable name: "{}"'.format(env_name))
1990
1991             if not _is_int_prop(env_value) and not _is_str_prop(env_value):
1992                 raise ConfigError('invalid environment variable value ("{}"): expecting integer or string'.format(env_name))
1993
1994             env[env_name] = env_value
1995
1996         return env
1997
1998     def _register_log_levels(self, metadata_node):
1999         self._log_levels = dict()
2000
2001         # log levels:
2002         #   v2.0:  "log-levels"
2003         #   v2.1+: "$log-levels"
2004         log_levels_node = None
2005
2006         if self._version >= 200:
2007             if 'log-levels' in metadata_node:
2008                 log_levels_prop = 'log-levels'
2009                 log_levels_node = metadata_node[log_levels_prop]
2010
2011         if self._version >= 201:
2012             if '$log-levels' in metadata_node:
2013                 if log_levels_node is not None:
2014                     raise ConfigError('cannot specify both "log-levels" and "$log-levels" properties of metadata object: prefer "$log-levels"')
2015
2016                 log_levels_prop = '$log-levels'
2017                 log_levels_node = metadata_node[log_levels_prop]
2018
2019         if log_levels_node is None:
2020             return
2021
2022         if not _is_assoc_array_prop(log_levels_node):
2023             raise ConfigError('"{}" property (metadata) must be an associative array'.format(log_levels_prop))
2024
2025         for ll_name, ll_value in log_levels_node.items():
2026             if ll_name in self._log_levels:
2027                 raise ConfigError('duplicate log level entry "{}"'.format(ll_name))
2028
2029             if not _is_int_prop(ll_value):
2030                 raise ConfigError('invalid log level entry ("{}"): expecting an integer'.format(ll_name))
2031
2032             if ll_value < 0:
2033                 raise ConfigError('invalid log level entry ("{}"): log level value must be positive'.format(ll_name))
2034
2035             self._log_levels[ll_name] = ll_value
2036
2037     def _create_trace(self, metadata_node):
2038         # create trace object
2039         trace = metadata.Trace()
2040
2041         if 'trace' not in metadata_node:
2042             raise ConfigError('missing "trace" property (metadata)')
2043
2044         trace_node = metadata_node['trace']
2045
2046         if not _is_assoc_array_prop(trace_node):
2047             raise ConfigError('"trace" property (metadata) must be an associative array')
2048
2049         unk_prop = _get_first_unknown_prop(trace_node, [
2050             'byte-order',
2051             'uuid',
2052             'packet-header-type',
2053         ])
2054
2055         if unk_prop:
2056             raise ConfigError('unknown trace object property: "{}"'.format(unk_prop))
2057
2058         # set byte order (already parsed)
2059         trace.byte_order = self._bo
2060
2061         # UUID
2062         if 'uuid' in trace_node:
2063             uuidp = trace_node['uuid']
2064
2065             if not _is_str_prop(uuidp):
2066                 raise ConfigError('"uuid" property of trace object must be a string')
2067
2068             if uuidp == 'auto':
2069                 uuidp = uuid.uuid1()
2070             else:
2071                 try:
2072                     uuidp = uuid.UUID(uuidp)
2073                 except:
2074                     raise ConfigError('malformed UUID (trace object): "{}"'.format(uuidp))
2075
2076             trace.uuid = uuidp
2077
2078         # packet header type
2079         if 'packet-header-type' in trace_node:
2080             try:
2081                 ph_type = self._create_type(trace_node['packet-header-type'])
2082             except Exception as e:
2083                 raise ConfigError('cannot create packet header type (trace)', e)
2084
2085             trace.packet_header_type = ph_type
2086
2087         return trace
2088
2089     def _lookup_log_level(self, ll):
2090         if _is_int_prop(ll):
2091             return ll
2092         elif _is_str_prop(ll) and ll in self._log_levels:
2093             return self._log_levels[ll]
2094
2095     def _create_event(self, event_node):
2096         event = metadata.Event()
2097
2098         if not _is_assoc_array_prop(event_node):
2099             raise ConfigError('event objects must be associative arrays')
2100
2101         unk_prop = _get_first_unknown_prop(event_node, [
2102             'log-level',
2103             'context-type',
2104             'payload-type',
2105         ])
2106
2107         if unk_prop:
2108             raise ConfigError('unknown event object property: "{}"'.format(unk_prop))
2109
2110         if 'log-level' in event_node:
2111             ll_node = event_node['log-level']
2112
2113             if _is_str_prop(ll_node):
2114                 ll_value = self._lookup_log_level(event_node['log-level'])
2115
2116                 if ll_value is None:
2117                     raise ConfigError('cannot find log level "{}"'.format(ll_node))
2118
2119                 ll = metadata.LogLevel(event_node['log-level'], ll_value)
2120             elif _is_int_prop(ll_node):
2121                 if ll_node < 0:
2122                     raise ConfigError('invalid log level value {}: value must be positive'.format(ll_node))
2123
2124                 ll = metadata.LogLevel(None, ll_node)
2125             else:
2126                 raise ConfigError('"log-level" property must be either a string or an integer')
2127
2128             event.log_level = ll
2129
2130         if 'context-type' in event_node:
2131             try:
2132                 t = self._create_type(event_node['context-type'])
2133             except Exception as e:
2134                 raise ConfigError('cannot create event\'s context type object', e)
2135
2136             event.context_type = t
2137
2138         if 'payload-type' not in event_node:
2139             raise ConfigError('missing "payload-type" property in event object')
2140
2141         try:
2142             t = self._create_type(event_node['payload-type'])
2143         except Exception as e:
2144             raise ConfigError('cannot create event\'s payload type object', e)
2145
2146         event.payload_type = t
2147
2148         return event
2149
2150     def _create_stream(self, stream_node):
2151         stream = metadata.Stream()
2152
2153         if not _is_assoc_array_prop(stream_node):
2154             raise ConfigError('stream objects must be associative arrays')
2155
2156         unk_prop = _get_first_unknown_prop(stream_node, [
2157             'packet-context-type',
2158             'event-header-type',
2159             'event-context-type',
2160             'events',
2161         ])
2162
2163         if unk_prop:
2164             raise ConfigError('unknown stream object property: "{}"'.format(unk_prop))
2165
2166         if 'packet-context-type' in stream_node:
2167             try:
2168                 t = self._create_type(stream_node['packet-context-type'])
2169             except Exception as e:
2170                 raise ConfigError('cannot create stream\'s packet context type object', e)
2171
2172             stream.packet_context_type = t
2173
2174         if 'event-header-type' in stream_node:
2175             try:
2176                 t = self._create_type(stream_node['event-header-type'])
2177             except Exception as e:
2178                 raise ConfigError('cannot create stream\'s event header type object', e)
2179
2180             stream.event_header_type = t
2181
2182         if 'event-context-type' in stream_node:
2183             try:
2184                 t = self._create_type(stream_node['event-context-type'])
2185             except Exception as e:
2186                 raise ConfigError('cannot create stream\'s event context type object', e)
2187
2188             stream.event_context_type = t
2189
2190         if 'events' not in stream_node:
2191             raise ConfigError('missing "events" property in stream object')
2192
2193         events = stream_node['events']
2194
2195         if not _is_assoc_array_prop(events):
2196             raise ConfigError('"events" property of stream object must be an associative array')
2197
2198         if not events:
2199             raise ConfigError('at least one event is needed within a stream object')
2200
2201         cur_id = 0
2202
2203         for ev_name, ev_node in events.items():
2204             try:
2205                 ev = self._create_event(ev_node)
2206             except Exception as e:
2207                 raise ConfigError('cannot create event "{}"'.format(ev_name), e)
2208
2209             ev.id = cur_id
2210             ev.name = ev_name
2211             stream.events[ev_name] = ev
2212             cur_id += 1
2213
2214         return stream
2215
2216     def _create_streams(self, metadata_node):
2217         streams = collections.OrderedDict()
2218
2219         if 'streams' not in metadata_node:
2220             raise ConfigError('missing "streams" property (metadata)')
2221
2222         streams_node = metadata_node['streams']
2223
2224         if not _is_assoc_array_prop(streams_node):
2225             raise ConfigError('"streams" property (metadata) must be an associative array')
2226
2227         if not streams_node:
2228             raise ConfigError('at least one stream is needed (metadata)')
2229
2230         cur_id = 0
2231
2232         for stream_name, stream_node in streams_node.items():
2233             try:
2234                 stream = self._create_stream(stream_node)
2235             except Exception as e:
2236                 raise ConfigError('cannot create stream "{}"'.format(stream_name), e)
2237
2238             stream.id = cur_id
2239             stream.name = str(stream_name)
2240             streams[stream_name] = stream
2241             cur_id += 1
2242
2243         return streams
2244
2245     def _create_metadata(self, root):
2246         meta = metadata.Metadata()
2247
2248         if 'metadata' not in root:
2249             raise ConfigError('missing "metadata" property (configuration)')
2250
2251         metadata_node = root['metadata']
2252
2253         if not _is_assoc_array_prop(metadata_node):
2254             raise ConfigError('"metadata" property (configuration) must be an associative array')
2255
2256         known_props = [
2257             'type-aliases',
2258             'log-levels',
2259             'trace',
2260             'env',
2261             'clocks',
2262             'streams',
2263         ]
2264
2265         if self._version >= 201:
2266             known_props.append('$log-levels')
2267
2268         unk_prop = _get_first_unknown_prop(metadata_node, known_props)
2269
2270         if unk_prop:
2271             add = ''
2272
2273             if unk_prop == '$include':
2274                 add = ' (use version 2.1 or greater)'
2275
2276             raise ConfigError('unknown metadata property{}: "{}"'.format(add, unk_prop))
2277
2278         self._set_byte_order(metadata_node)
2279         self._register_clocks(metadata_node)
2280         meta.clocks = self._clocks
2281         self._register_type_aliases(metadata_node)
2282         meta.env = self._create_env(metadata_node)
2283         meta.trace = self._create_trace(metadata_node)
2284         self._register_log_levels(metadata_node)
2285         meta.streams = self._create_streams(metadata_node)
2286
2287         return meta
2288
2289     def _get_version(self, root):
2290         if 'version' not in root:
2291             raise ConfigError('missing "version" property (configuration)')
2292
2293         version_node = root['version']
2294
2295         if not _is_str_prop(version_node):
2296             raise ConfigError('"version" property (configuration) must be a string')
2297
2298         version_node = version_node.strip()
2299
2300         if version_node not in ['2.0', '2.1']:
2301             raise ConfigError('unsupported version ({}): versions 2.0 and 2.1 are supported'.format(version_node))
2302
2303         # convert version string to comparable version integer
2304         parts = version_node.split('.')
2305         version = int(parts[0]) * 100 + int(parts[1])
2306
2307         return version
2308
2309     def _get_prefix(self, root):
2310         if 'prefix' not in root:
2311             return 'barectf_'
2312
2313         prefix_node = root['prefix']
2314
2315         if not _is_str_prop(prefix_node):
2316             raise ConfigError('"prefix" property (configuration) must be a string')
2317
2318         if not is_valid_identifier(prefix_node):
2319             raise ConfigError('"prefix" property (configuration) must be a valid C identifier')
2320
2321         return prefix_node
2322
2323     def _get_last_include_file(self):
2324         if self._include_stack:
2325             return self._include_stack[-1]
2326
2327         return self._root_yaml_path
2328
2329     def _load_include(self, yaml_path):
2330         for inc_dir in self._include_dirs:
2331             # current include dir + file name path
2332             # note: os.path.join() only takes the last arg if it's absolute
2333             inc_path = os.path.join(inc_dir, yaml_path)
2334
2335             # real path (symbolic links resolved)
2336             real_path = os.path.realpath(inc_path)
2337
2338             # normalized path (weird stuff removed!)
2339             norm_path = os.path.normpath(real_path)
2340
2341             if not os.path.isfile(norm_path):
2342                 # file does not exist: skip
2343                 continue
2344
2345             if norm_path in self._include_stack:
2346                 base_path = self._get_last_include_file()
2347                 raise ConfigError('in "{}": cannot recursively include file "{}"'.format(base_path, norm_path))
2348
2349             self._include_stack.append(norm_path)
2350
2351             # load raw content
2352             return self._yaml_ordered_load(norm_path)
2353
2354         if not self._ignore_include_not_found:
2355             base_path = self._get_last_include_file()
2356             raise ConfigError('in "{}": cannot include file "{}": file not found in include directories'.format(base_path, yaml_path))
2357
2358         return None
2359
2360     def _get_include_paths(self, include_node):
2361         if _is_str_prop(include_node):
2362             return [include_node]
2363         elif _is_array_prop(include_node):
2364             for include_path in include_node:
2365                 if not _is_str_prop(include_path):
2366                     raise ConfigError('invalid include property: expecting array of strings')
2367
2368             return include_node
2369
2370         raise ConfigError('invalid include property: expecting string or array of strings')
2371
2372     def _update_node(self, base_node, overlay_node):
2373         for olay_key, olay_value in overlay_node.items():
2374             if olay_key in base_node:
2375                 base_value = base_node[olay_key]
2376
2377                 if _is_assoc_array_prop(olay_value) and _is_assoc_array_prop(base_value):
2378                     # merge dictionaries
2379                     self._update_node(base_value, olay_value)
2380                 elif _is_array_prop(olay_value) and _is_array_prop(base_value):
2381                     # append extension array items to base items
2382                     base_value += olay_value
2383                 else:
2384                     # fall back to replacing
2385                     base_node[olay_key] = olay_value
2386             else:
2387                 base_node[olay_key] = olay_value
2388
2389     def _process_node_include(self, last_overlay_node, name,
2390                               process_base_include_cb,
2391                               process_children_include_cb=None):
2392         if not _is_assoc_array_prop(last_overlay_node):
2393             raise ConfigError('{} objects must be associative arrays'.format(name))
2394
2395         # process children inclusions first
2396         if process_children_include_cb:
2397             process_children_include_cb(last_overlay_node)
2398
2399         if '$include' in last_overlay_node:
2400             include_node = last_overlay_node['$include']
2401         else:
2402             # no includes!
2403             return last_overlay_node
2404
2405         include_paths = self._get_include_paths(include_node)
2406         cur_base_path = self._get_last_include_file()
2407         base_node = None
2408
2409         # keep the include paths and remove the include property
2410         include_paths = copy.deepcopy(include_paths)
2411         del last_overlay_node['$include']
2412
2413         for include_path in include_paths:
2414             # load raw YAML from included file
2415             overlay_node = self._load_include(include_path)
2416
2417             if overlay_node is None:
2418                 # cannot find include file, but we're ignoring those
2419                 # errors, otherwise _load_include() itself raises
2420                 # a config error
2421                 continue
2422
2423             # recursively process includes
2424             try:
2425                 overlay_node = process_base_include_cb(overlay_node)
2426             except Exception as e:
2427                 raise ConfigError('in "{}"'.format(cur_base_path), e)
2428
2429             # pop include stack now that we're done including
2430             del self._include_stack[-1]
2431
2432             # at this point, base_node is fully resolved (does not
2433             # contain any include property)
2434             if base_node is None:
2435                 base_node = overlay_node
2436             else:
2437                 self._update_node(base_node, overlay_node)
2438
2439         # finally, we update the latest base node with our last overlay
2440         # node
2441         if base_node is None:
2442             # nothing was included, which is possible when we're
2443             # ignoring include errors
2444             return last_overlay_node
2445
2446         self._update_node(base_node, last_overlay_node)
2447
2448         return base_node
2449
2450     def _process_event_include(self, event_node):
2451         return self._process_node_include(event_node, 'event',
2452                                           self._process_event_include)
2453
2454     def _process_stream_include(self, stream_node):
2455         def process_children_include(stream_node):
2456             if 'events' in stream_node:
2457                 events_node = stream_node['events']
2458
2459                 if not _is_assoc_array_prop(events_node):
2460                     raise ConfigError('"events" property must be an associative array')
2461
2462                 events_node_keys = list(events_node.keys())
2463
2464                 for key in events_node_keys:
2465                     event_node = events_node[key]
2466
2467                     try:
2468                         events_node[key] = self._process_event_include(event_node)
2469                     except Exception as e:
2470                         raise ConfigError('cannot process includes of event object "{}"'.format(key), e)
2471
2472         return self._process_node_include(stream_node, 'stream',
2473                                           self._process_stream_include,
2474                                           process_children_include)
2475
2476     def _process_trace_include(self, trace_node):
2477         return self._process_node_include(trace_node, 'trace',
2478                                           self._process_trace_include)
2479
2480     def _process_clock_include(self, clock_node):
2481         return self._process_node_include(clock_node, 'clock',
2482                                           self._process_clock_include)
2483
2484     def _process_metadata_include(self, metadata_node):
2485         def process_children_include(metadata_node):
2486             if 'trace' in metadata_node:
2487                 metadata_node['trace'] = self._process_trace_include(metadata_node['trace'])
2488
2489             if 'clocks' in metadata_node:
2490                 clocks_node = metadata_node['clocks']
2491
2492                 if not _is_assoc_array_prop(clocks_node):
2493                     raise ConfigError('"clocks" property (metadata) must be an associative array')
2494
2495                 clocks_node_keys = list(clocks_node.keys())
2496
2497                 for key in clocks_node_keys:
2498                     clock_node = clocks_node[key]
2499
2500                     try:
2501                         clocks_node[key] = self._process_clock_include(clock_node)
2502                     except Exception as e:
2503                         raise ConfigError('cannot process includes of clock object "{}"'.format(key), e)
2504
2505             if 'streams' in metadata_node:
2506                 streams_node = metadata_node['streams']
2507
2508                 if not _is_assoc_array_prop(streams_node):
2509                     raise ConfigError('"streams" property (metadata) must be an associative array')
2510
2511                 streams_node_keys = list(streams_node.keys())
2512
2513                 for key in streams_node_keys:
2514                     stream_node = streams_node[key]
2515
2516                     try:
2517                         streams_node[key] = self._process_stream_include(stream_node)
2518                     except Exception as e:
2519                         raise ConfigError('cannot process includes of stream object "{}"'.format(key), e)
2520
2521         return self._process_node_include(metadata_node, 'metadata',
2522                                           self._process_metadata_include,
2523                                           process_children_include)
2524
2525     def _process_root_includes(self, root):
2526         # The following config objects support includes:
2527         #
2528         #   * Metadata object
2529         #   * Trace object
2530         #   * Stream object
2531         #   * Event object
2532         #
2533         # We need to process the event includes first, then the stream
2534         # includes, then the trace includes, and finally the metadata
2535         # includes.
2536         #
2537         # In each object, only one of the $include and $include-replace
2538         # special properties is allowed.
2539         #
2540         # We keep a stack of absolute paths to included files to detect
2541         # recursion.
2542         if 'metadata' in root:
2543             root['metadata'] = self._process_metadata_include(root['metadata'])
2544
2545         return root
2546
2547     def _yaml_ordered_dump(self, node, **kwds):
2548         class ODumper(yaml.Dumper):
2549             pass
2550
2551         def dict_representer(dumper, node):
2552             return dumper.represent_mapping(yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG,
2553                                             node.items())
2554
2555         ODumper.add_representer(collections.OrderedDict, dict_representer)
2556
2557         return yaml.dump(node, Dumper=ODumper, **kwds)
2558
2559     def _yaml_ordered_load(self, yaml_path):
2560         class OLoader(yaml.Loader):
2561             pass
2562
2563         def construct_mapping(loader, node):
2564             loader.flatten_mapping(node)
2565
2566             return collections.OrderedDict(loader.construct_pairs(node))
2567
2568         OLoader.add_constructor(yaml.resolver.BaseResolver.DEFAULT_MAPPING_TAG,
2569                                 construct_mapping)
2570
2571         # YAML -> Python
2572         try:
2573             with open(yaml_path, 'r') as f:
2574                 node = yaml.load(f, OLoader)
2575         except (OSError, IOError) as e:
2576             raise ConfigError('cannot open file "{}"'.format(yaml_path))
2577         except Exception as e:
2578             raise ConfigError('unknown error while trying to load file "{}"'.format(yaml_path), e)
2579
2580         # loaded node must be an associate array
2581         if not _is_assoc_array_prop(node):
2582             raise ConfigError('root of YAML file "{}" must be an associative array'.format(yaml_path))
2583
2584         return node
2585
2586     def _reset(self):
2587         self._version = None
2588         self._include_stack = []
2589
2590     def parse(self, yaml_path):
2591         self._reset()
2592         self._root_yaml_path = yaml_path
2593
2594         try:
2595             root = self._yaml_ordered_load(yaml_path)
2596         except Exception as e:
2597             raise ConfigError('cannot parse YAML file "{}"'.format(yaml_path), e)
2598
2599         if not _is_assoc_array_prop(root):
2600             raise ConfigError('configuration must be an associative array')
2601
2602         unk_prop = _get_first_unknown_prop(root, [
2603             'version',
2604             'prefix',
2605             'metadata',
2606         ])
2607
2608         if unk_prop:
2609             raise ConfigError('unknown configuration property: "{}"'.format(unk_prop))
2610
2611         # get the config version
2612         self._version = self._get_version(root)
2613
2614         # process includes if supported
2615         if self._version >= 201:
2616             root = self._process_root_includes(root)
2617
2618         # dump config if required
2619         if self._dump_config:
2620             print(self._yaml_ordered_dump(root, indent=2,
2621                                           default_flow_style=False))
2622
2623         # get prefix and metadata
2624         prefix = self._get_prefix(root)
2625         meta = self._create_metadata(root)
2626
2627         return Config(self._version, prefix, meta)
2628
2629
2630 def from_yaml_file(path, include_dirs, ignore_include_not_found, dump_config):
2631     try:
2632         parser = _YamlConfigParser(include_dirs, ignore_include_not_found,
2633                                    dump_config)
2634         cfg = parser.parse(path)
2635
2636         return cfg
2637     except Exception as e:
2638         raise ConfigError('cannot create configuration from YAML file "{}"'.format(path), e)