1 # The MIT License (MIT)
3 # Copyright (c) 2015-2016 Philippe Proulx <pproulx@efficios.com>
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:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
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
23 from barectf
import metadata
35 class ConfigError(RuntimeError):
36 def __init__(self
, msg
, prev
=None):
46 def __init__(self
, version
, prefix
, metadata
):
48 self
.version
= version
49 self
.metadata
= metadata
51 def _validate_metadata(self
, meta
):
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
)
63 validator
= _BarectfMetadataValidator()
64 validator
.validate(meta
)
65 except Exception as e
:
66 raise ConfigError('barectf metadata error', e
)
68 def _augment_metadata_env(self
, meta
):
69 version_tuple
= barectf
.get_version_tuple()
72 'tracer_name': 'barectf' ,
73 'tracer_major': version_tuple
[0],
74 'tracer_minor': version_tuple
[1],
75 'tracer_patch': version_tuple
[2],
76 'barectf_gen_date': str(datetime
.datetime
.now().isoformat()),
79 base_env
.update(meta
.env
)
87 def version(self
, value
):
95 def metadata(self
, value
):
96 self
._validate
_metadata
(value
)
97 self
._augment
_metadata
_env
(value
)
98 self
._metadata
= value
105 def prefix(self
, value
):
106 if not _is_valid_identifier(value
):
107 raise ConfigError('prefix must be a valid C identifier')
112 def _is_assoc_array_prop(node
):
113 return isinstance(node
, dict)
116 def _is_array_prop(node
):
117 return isinstance(node
, list)
120 def _is_int_prop(node
):
121 return type(node
) is int
124 def _is_str_prop(node
):
125 return type(node
) is str
128 def _is_bool_prop(node
):
129 return type(node
) is bool
132 def _is_valid_alignment(align
):
133 return ((align
& (align
- 1)) == 0) and align
> 0
136 def _byte_order_str_to_bo(bo_str
):
137 bo_str
= bo_str
.lower()
140 return metadata
.ByteOrder
.LE
142 return metadata
.ByteOrder
.BE
145 def _encoding_str_to_encoding(encoding_str
):
146 encoding_str
= encoding_str
.lower()
148 if encoding_str
== 'utf-8' or encoding_str
== 'utf8':
149 return metadata
.Encoding
.UTF8
150 elif encoding_str
== 'ascii':
151 return metadata
.Encoding
.ASCII
152 elif encoding_str
== 'none':
153 return metadata
.Encoding
.NONE
156 _re_iden
= re
.compile(r
'^[a-zA-Z][a-zA-Z0-9_]*$')
157 _ctf_keywords
= set([
176 def _is_valid_identifier(iden
):
177 if not _re_iden
.match(iden
):
180 if _re_iden
in _ctf_keywords
:
186 def _get_first_unknown_prop(node
, known_props
):
187 for prop_name
in node
:
188 if prop_name
in known_props
:
194 # This validator validates the configured metadata for barectf specific
199 # * all header/contexts are at least byte-aligned
200 # * all integer and floating point number sizes to be <= 64
201 # * no inner structures, arrays, or variants
202 class _BarectfMetadataValidator
:
204 self
._type
_to
_validate
_type
_func
= {
205 metadata
.Integer
: self
._validate
_int
_type
,
206 metadata
.FloatingPoint
: self
._validate
_float
_type
,
207 metadata
.Enum
: self
._validate
_enum
_type
,
208 metadata
.String
: self
._validate
_string
_type
,
209 metadata
.Struct
: self
._validate
_struct
_type
,
210 metadata
.Array
: self
._validate
_array
_type
,
211 metadata
.Variant
: self
._validate
_variant
_type
,
214 def _validate_int_type(self
, t
, entity_root
):
216 raise ConfigError('integer type\'s size must be lesser than or equal to 64 bits')
218 def _validate_float_type(self
, t
, entity_root
):
220 raise ConfigError('floating point number type\'s size must be lesser than or equal to 64 bits')
222 def _validate_enum_type(self
, t
, entity_root
):
223 if t
.value_type
.size
> 64:
224 raise ConfigError('enumeration type\'s integer type\'s size must be lesser than or equal to 64 bits')
226 def _validate_string_type(self
, t
, entity_root
):
229 def _validate_struct_type(self
, t
, entity_root
):
231 raise ConfigError('inner structure types are not supported as of this version')
233 for field_name
, field_type
in t
.fields
.items():
234 if entity_root
and self
._cur
_entity
is _Entity
.TRACE_PACKET_HEADER
:
235 if field_name
== 'uuid':
240 self
._validate
_type
(field_type
, False)
241 except Exception as e
:
242 raise ConfigError('in structure type\'s field "{}"'.format(field_name
), e
)
244 def _validate_array_type(self
, t
, entity_root
):
245 raise ConfigError('array types are not supported as of this version')
247 def _validate_variant_type(self
, t
, entity_root
):
248 raise ConfigError('variant types are not supported as of this version')
250 def _validate_type(self
, t
, entity_root
):
251 self
._type
_to
_validate
_type
_func
[type(t
)](t
, entity_root
)
253 def _validate_entity(self
, t
):
257 # make sure entity is byte-aligned
259 raise ConfigError('type\'s alignment must be at least byte-aligned')
261 # make sure entity is a structure
262 if type(t
) is not metadata
.Struct
:
263 raise ConfigError('expecting a structure type')
266 self
._validate
_type
(t
, True)
268 def _validate_entities_and_names(self
, meta
):
269 self
._cur
_entity
= _Entity
.TRACE_PACKET_HEADER
272 self
._validate
_entity
(meta
.trace
.packet_header_type
)
273 except Exception as e
:
274 raise ConfigError('invalid trace packet header type', e
)
276 for stream_name
, stream
in meta
.streams
.items():
277 if not _is_valid_identifier(stream_name
):
278 raise ConfigError('stream name "{}" is not a valid C identifier'.format(stream_name
))
280 self
._cur
_entity
= _Entity
.STREAM_PACKET_CONTEXT
283 self
._validate
_entity
(stream
.packet_context_type
)
284 except Exception as e
:
285 raise ConfigError('invalid packet context type in stream "{}"'.format(stream_name
), e
)
287 self
._cur
_entity
= _Entity
.STREAM_EVENT_HEADER
290 self
._validate
_entity
(stream
.event_header_type
)
291 except Exception as e
:
292 raise ConfigError('invalid event header type in stream "{}"'.format(stream_name
), e
)
294 self
._cur
_entity
= _Entity
.STREAM_EVENT_CONTEXT
297 self
._validate
_entity
(stream
.event_context_type
)
298 except Exception as e
:
299 raise ConfigError('invalid event context type in stream "{}"'.format(stream_name
), e
)
302 for ev_name
, ev
in stream
.events
.items():
303 if not _is_valid_identifier(ev_name
):
304 raise ConfigError('event name "{}" is not a valid C identifier'.format(ev_name
))
306 self
._cur
_entity
= _Entity
.EVENT_CONTEXT
309 self
._validate
_entity
(ev
.context_type
)
310 except Exception as e
:
311 raise ConfigError('invalid context type in event "{}"'.format(ev_name
), e
)
313 self
._cur
_entity
= _Entity
.EVENT_PAYLOAD
316 self
._validate
_entity
(ev
.payload_type
)
317 except Exception as e
:
318 raise ConfigError('invalid payload type in event "{}"'.format(ev_name
), e
)
320 if stream
.is_event_empty(ev
):
321 raise ConfigError('event "{}" is empty'.format(ev_name
))
322 except Exception as e
:
323 raise ConfigError('invalid stream "{}"'.format(stream_name
), e
)
325 def validate(self
, meta
):
326 self
._validate
_entities
_and
_names
(meta
)
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:
338 raise ConfigError('need "stream_id" field in trace packet header type (more than one stream), but trace packet header type is missing')
340 if type(t
) is not metadata
.Struct
:
341 raise ConfigError('need "stream_id" field in trace packet header type (more than one stream), but trace packet header type is not a structure type')
343 if 'stream_id' not in t
.fields
:
344 raise ConfigError('need "stream_id" field in trace packet header type (more than one stream)')
346 # validate "magic" and "stream_id" types
347 if type(t
) is not metadata
.Struct
:
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')
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')
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')
364 if field_type
.signed
:
365 raise ConfigError('"stream_id" field in trace packet header type must be an unsigned integer type')
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')
374 if type(field_type
) is not metadata
.Array
:
375 raise ConfigError('"uuid" field in trace packet header type must be an array')
377 if field_type
.length
!= 16:
378 raise ConfigError('"uuid" field in trace packet header type must be an array of 16 bytes')
380 element_type
= field_type
.element_type
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')
385 if element_type
.size
!= 8:
386 raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned bytes')
388 if element_type
.signed
:
389 raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned bytes')
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')
394 def _validate_trace(self
, meta
):
395 self
._validate
_trace
_packet
_header
_type
(meta
.trace
.packet_header_type
)
397 def _validate_stream_packet_context(self
, stream
):
398 t
= stream
.packet_context_type
401 raise ConfigError('missing "packet-context-type" property in stream object')
403 if type(t
) is not metadata
.Struct
:
404 raise ConfigError('"packet-context-type": expecting a structure type')
406 # "timestamp_begin", if exists, is an unsigned integer type,
410 if 'timestamp_begin' in t
.fields
:
411 ts_begin
= t
.fields
['timestamp_begin']
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')
417 raise ConfigError('"timestamp_begin" field in stream packet context type must be an unsigned integer type')
419 if not ts_begin
.property_mappings
:
420 raise ConfigError('"timestamp_begin" field in stream packet context type must be mapped to a clock')
422 # "timestamp_end", if exists, is an unsigned integer type,
426 if 'timestamp_end' in t
.fields
:
427 ts_end
= t
.fields
['timestamp_end']
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')
433 raise ConfigError('"timestamp_end" field in stream packet context type must be an unsigned integer type')
435 if not ts_end
.property_mappings
:
436 raise ConfigError('"timestamp_end" field in stream packet context type must be mapped to a clock')
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')
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')
447 # "events_discarded", if exists, is an unsigned integer type
448 if 'events_discarded' in t
.fields
:
449 events_discarded
= t
.fields
['events_discarded']
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')
454 if events_discarded
.signed
:
455 raise ConfigError('"events_discarded" field in stream packet context type must be an unsigned integer type')
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')
461 packet_size
= t
.fields
['packet_size']
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')
467 content_size
= t
.fields
['content_size']
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')
473 if packet_size
.signed
:
474 raise ConfigError('"packet_size" field in stream packet context type must be an unsigned integer type')
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')
480 if content_size
.signed
:
481 raise ConfigError('"content_size" field in stream packet context type must be an unsigned integer type')
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')
487 def _validate_stream_event_header(self
, stream
):
488 t
= stream
.event_header_type
491 if len(stream
.events
) > 1:
494 raise ConfigError('need "id" field in stream event header type (more than one event), but stream event header type is missing')
496 if type(t
) is not metadata
.Struct
:
497 raise ConfigError('need "id" field in stream event header type (more than one event), but stream event header type is not a structure type')
499 if 'id' not in t
.fields
:
500 raise ConfigError('need "id" field in stream event header type (more than one event)')
502 # validate "id" and "timestamp" types
503 if type(t
) is not metadata
.Struct
:
506 # "timestamp", if exists, is an unsigned integer type,
508 if 'timestamp' in t
.fields
:
509 ts
= t
.fields
['timestamp']
511 if type(ts
) is not metadata
.Integer
:
512 raise ConfigError('"timestamp" field in stream event header type must be an integer type')
515 raise ConfigError('"timestamp" field in stream event header type must be an unsigned integer type')
517 if not ts
.property_mappings
:
518 raise ConfigError('"timestamp" field in stream event header type must be mapped to a clock')
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')
528 raise ConfigError('"id" field in stream event header type must be an unsigned integer type')
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')
534 def _validate_stream(self
, stream
):
535 self
._validate
_stream
_packet
_context
(stream
)
536 self
._validate
_stream
_event
_header
(stream
)
538 def validate(self
, meta
):
540 self
._validate
_trace
(meta
)
542 for stream
in meta
.streams
.values():
544 self
._validate
_stream
(stream
)
545 except Exception as e
:
546 raise ConfigError('invalid stream "{}"'.format(stream
.name
), e
)
549 class _MetadataDynamicTypesValidatorStackEntry
:
550 def __init__(self
, base_t
):
551 self
._base
_t
= base_t
559 def index(self
, value
):
567 def base_t(self
, value
):
571 # Entities. Order of values is important here.
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
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
:
588 self
._type
_to
_visit
_type
_func
= {
589 metadata
.Integer
: None,
590 metadata
.FloatingPoint
: 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
,
598 self
._cur
_trace
= None
599 self
._cur
_stream
= None
600 self
._cur
_event
= None
602 def _lookup_path_from_base(self
, path
, parts
, base
, start_index
,
603 base_is_current
, from_t
):
608 while index
< len(parts
):
612 if type(cur_t
) is metadata
.Struct
:
613 enumerated_items
= enumerate(cur_t
.fields
.items())
616 for i
, (field_name
, field_type
) in enumerated_items
:
617 if field_name
== part
:
619 found_path
.append((i
, field_type
))
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())
627 for i
, (type_name
, type_type
) in enumerated_items
:
628 if type_name
== part
:
630 found_path
.append((i
, type_type
))
633 raise ConfigError('invalid path "{}": cannot find type "{}" in variant type'.format(path
, part
))
635 raise ConfigError('invalid path "{}": requesting "{}" in a non-variant, non-structure type'.format(path
, part
))
640 # make sure that the pointed type is not the pointing type
642 raise ConfigError('invalid path "{}": pointing to self'.format(path
))
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
:
651 for index
, entry
in enumerate(self
._stack
):
652 if index
== len(found_path
):
653 # end of index path; valid so far
656 if found_path
[index
][0] > entry
.index
:
657 raise ConfigError('invalid path "{}": pointed type is after pointing type'.format(path
))
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
):
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
))
672 def _lookup_path_from_top(self
, path
, parts
):
674 raise ConfigError('invalid path "{}": multipart relative path not supported'.format(path
))
677 index
= len(self
._stack
) - 1
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
:
685 enumerated_items
= enumerate(entry
.base_t
.fields
.items())
687 # lookup each field, until the current visiting index is met
688 for i
, (field_name
, field_type
) in enumerated_items
:
692 if field_name
== find_name
:
696 elif type(entry
.base_t
) is metadata
.Variant
:
697 enumerated_items
= enumerate(entry
.base_t
.types
.items())
699 # lookup each type, until the current visiting index is met
700 for i
, (type_name
, type_type
) in enumerated_items
:
704 if type_name
== find_name
:
706 raise ConfigError('invalid path "{}": type cannot be reached because pointed and pointing types are in the same variant type'.format(path
))
710 # nothing returned here: cannot find type
711 raise ConfigError('invalid path "{}": cannot find type in current context'.format(path
))
713 def _lookup_path(self
, path
, from_t
):
714 parts
= path
.lower().split('.')
716 base_is_current
= False
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
))
725 base
= self
._cur
_trace
.packet_header_type
727 if self
._cur
_entity
== _Entity
.TRACE_PACKET_HEADER
:
728 base_is_current
= True
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
))
736 if self
._cur
_stream
.packet_context_type
is None:
737 raise ConfigError('invalid path "{}": no defined stream packet context type'.format(path
))
739 base
= self
._cur
_stream
.packet_context_type
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
))
748 if self
._cur
_stream
.event_header_type
is None:
749 raise ConfigError('invalid path "{}": no defined stream event header type'.format(path
))
751 base
= self
._cur
_stream
.event_header_type
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
))
759 if self
._cur
_stream
.event_context_type
is None:
760 raise ConfigError('invalid path "{}": no defined stream event context type'.format(path
))
762 base
= self
._cur
_stream
.event_context_type
764 if self
._cur
_entity
== _Entity
.STREAM_EVENT_CONTEXT
:
765 base_is_current
= True
767 raise ConfigError('invalid path "{}": unknown names after "stream.event"'.format(path
))
769 raise ConfigError('invalid path "{}": unknown names after "stream"'.format(path
))
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
))
780 if self
._cur
_event
.context_type
is None:
781 raise ConfigError('invalid path "{}": no defined event context type'.format(path
))
783 base
= self
._cur
_event
.context_type
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
))
791 if self
._cur
_event
.payload_type
is None:
792 raise ConfigError('invalid path "{}": no defined event payload type'.format(path
))
794 base
= self
._cur
_event
.payload_type
796 if self
._cur
_entity
== _Entity
.EVENT_PAYLOAD
:
797 base_is_current
= True
799 raise ConfigError('invalid path "{}": unknown names after "event"'.format(path
))
805 return self
._lookup
_path
_from
_base
(path
, parts
, base
, start_index
,
806 base_is_current
, from_t
)
808 return self
._lookup
_path
_from
_top
(path
, parts
)
810 def _stack_reset(self
):
813 def _stack_push(self
, base_t
):
814 entry
= _MetadataDynamicTypesValidatorStackEntry(base_t
)
815 self
._stack
.append(entry
)
817 def _stack_pop(self
):
820 def _stack_incr_index(self
):
821 self
._stack
[-1].index
+= 1
823 def _visit_struct_type(self
, t
):
826 for field_name
, field_type
in t
.fields
.items():
828 self
._visit
_type
(field_type
)
829 except Exception as e
:
830 raise ConfigError('in structure type\'s field "{}"'.format(field_name
), e
)
832 self
._stack
_incr
_index
()
836 def _visit_array_type(self
, t
):
837 if t
.is_variable_length
:
840 length_type
= self
._lookup
_path
(t
.length
, t
)
841 except Exception as e
:
842 raise ConfigError('invalid array type\'s length', e
)
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')
848 if length_type
.signed
:
849 raise ConfigError('array type\'s length does not point to an unsigned integer type')
851 self
._visit
_type
(t
.element_type
)
853 def _visit_variant_type(self
, t
):
856 tag_type
= self
._lookup
_path
(t
.tag
, t
)
857 except Exception as e
:
858 raise ConfigError('invalid variant type\'s tag', e
)
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')
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
))
871 for type_name
, type_type
in t
.types
.items():
873 self
._visit
_type
(type_type
)
874 except Exception as e
:
875 raise ConfigError('in variant type\'s type "{}"'.format(type_name
), e
)
877 self
._stack
_incr
_index
()
881 def _visit_type(self
, t
):
885 if type(t
) in self
._type
_to
_visit
_type
_func
:
886 func
= self
._type
_to
_visit
_type
_func
[type(t
)]
891 def _visit_event(self
, ev
):
897 # visit event context type
899 self
._cur
_entity
= _Entity
.EVENT_CONTEXT
902 self
._visit
_type
(ev
.context_type
)
903 except Exception as e
:
904 raise ConfigError('invalid context type in event "{}"'.format(ev_name
), e
)
906 # visit event payload type
908 self
._cur
_entity
= _Entity
.EVENT_PAYLOAD
911 self
._visit
_type
(ev
.payload_type
)
912 except Exception as e
:
913 raise ConfigError('invalid payload type in event "{}"'.format(ev_name
), e
)
915 def _visit_stream(self
, stream
):
916 stream_name
= stream
.name
919 self
._cur
_stream
= stream
921 # reset current event
922 self
._cur
_event
= None
924 # visit stream packet context type
926 self
._cur
_entity
= _Entity
.STREAM_PACKET_CONTEXT
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
)
933 # visit stream event header type
935 self
._cur
_entity
= _Entity
.STREAM_EVENT_HEADER
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
)
942 # visit stream event context type
944 self
._cur
_entity
= _Entity
.STREAM_EVENT_CONTEXT
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
)
952 for ev
in stream
.events
.values():
954 self
._visit
_event
(ev
)
955 except Exception as e
:
956 raise ConfigError('invalid stream "{}"'.format(stream_name
))
958 def validate(self
, meta
):
960 self
._cur
_trace
= meta
.trace
962 # visit trace packet header type
964 self
._cur
_entity
= _Entity
.TRACE_PACKET_HEADER
967 self
._visit
_type
(meta
.trace
.packet_header_type
)
968 except Exception as e
:
969 raise ConfigError('invalid packet header type in trace', e
)
972 for stream
in meta
.streams
.values():
973 self
._visit
_stream
(stream
)
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
:
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
,
992 def _validate_integer_histology(self
, t
):
995 raise ConfigError('missing integer type\'s size')
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')
1002 # mantissa digits is set
1003 if t
.mant_size
is None:
1004 raise ConfigError('missing floating point number type\'s mantissa size')
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')
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')
1015 # there's at least one member
1017 raise ConfigError('enumeration type needs at least one member')
1019 # no overlapping values and all values are valid considering
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
1028 value_max
= (1 << t
.value_type
.size
) - 1
1030 for label
, value
in t
.members
.items():
1032 if value
[0] <= rg
[1] and rg
[0] <= value
[1]:
1033 raise ConfigError('enumeration type\'s member "{}" overlaps another member'.format(label
))
1035 fmt
= 'enumeration type\'s member "{}": value {} is outside the value type range [{}, {}]'
1037 if value
[0] < value_min
or value
[0] > value_max
:
1038 raise ConfigError(fmt
.format(label
, value
[0], value_min
, value_max
))
1040 if value
[1] < value_min
or value
[1] > value_max
:
1041 raise ConfigError(fmt
.format(label
, value
[1], value_min
, value_max
))
1043 ranges
.append(value
)
1045 def _validate_string_histology(self
, t
):
1049 def _validate_struct_histology(self
, t
):
1050 # all fields are valid
1051 for field_name
, field_type
in t
.fields
.items():
1053 self
._validate
_type
_histology
(field_type
)
1054 except Exception as e
:
1055 raise ConfigError('invalid structure type\'s field "{}"'.format(field_name
), e
)
1057 def _validate_array_histology(self
, t
):
1059 if t
.length
is None:
1060 raise ConfigError('missing array type\'s length')
1062 # element type is set
1063 if t
.element_type
is None:
1064 raise ConfigError('missing array type\'s element type')
1066 # element type is valid
1068 self
._validate
_type
_histology
(t
.element_type
)
1069 except Exception as e
:
1070 raise ConfigError('invalid array type\'s element type', e
)
1072 def _validate_variant_histology(self
, t
):
1075 raise ConfigError('missing variant type\'s tag')
1077 # there's at least one type
1079 raise ConfigError('variant type needs at least one type')
1081 # all types are valid
1082 for type_name
, type_t
in t
.types
.items():
1084 self
._validate
_type
_histology
(type_t
)
1085 except Exception as e
:
1086 raise ConfigError('invalid variant type\'s type "{}"'.format(type_name
), e
)
1088 def _validate_type_histology(self
, t
):
1092 self
._type
_to
_validate
_type
_histology
_func
[type(t
)](t
)
1094 def _validate_entity_type_histology(self
, t
):
1098 if type(t
) is not metadata
.Struct
:
1099 raise ConfigError('expecting a structure type')
1101 self
._validate
_type
_histology
(t
)
1103 def _validate_event_types_histology(self
, ev
):
1106 # validate event context type
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
)
1112 # validate event payload type
1114 self
._validate
_entity
_type
_histology
(ev
.payload_type
)
1115 except Exception as e
:
1116 raise ConfigError('invalid event payload type for event "{}"'.format(ev_name
), e
)
1118 def _validate_stream_types_histology(self
, stream
):
1119 stream_name
= stream
.name
1121 # validate stream packet context type
1123 self
._validate
_entity
_type
_histology
(stream
.packet_context_type
)
1124 except Exception as e
:
1125 raise ConfigError('invalid stream packet context type for stream "{}"'.format(stream_name
), e
)
1127 # validate stream event header type
1129 self
._validate
_entity
_type
_histology
(stream
.event_header_type
)
1130 except Exception as e
:
1131 raise ConfigError('invalid stream event header type for stream "{}"'.format(stream_name
), e
)
1133 # validate stream event context type
1135 self
._validate
_entity
_type
_histology
(stream
.event_context_type
)
1136 except Exception as e
:
1137 raise ConfigError('invalid stream event context type for stream "{}"'.format(stream_name
), e
)
1140 for ev
in stream
.events
.values():
1142 self
._validate
_event
_types
_histology
(ev
)
1143 except Exception as e
:
1144 raise ConfigError('invalid event in stream "{}"'.format(stream_name
), e
)
1146 def validate(self
, meta
):
1147 # validate trace packet header type
1149 self
._validate
_entity
_type
_histology
(meta
.trace
.packet_header_type
)
1150 except Exception as e
:
1151 raise ConfigError('invalid trace packet header type', e
)
1154 for stream
in meta
.streams
.values():
1155 self
._validate
_stream
_types
_histology
(stream
)
1158 class _YamlConfigParser
:
1159 def __init__(self
, include_dirs
, ignore_include_not_found
, dump_config
):
1160 self
._class
_name
_to
_create
_type
_func
= {
1161 'int': self
._create
_integer
,
1162 'integer': self
._create
_integer
,
1163 'flt': self
._create
_float
,
1164 'float': self
._create
_float
,
1165 'floating-point': self
._create
_float
,
1166 'enum': self
._create
_enum
,
1167 'enumeration': self
._create
_enum
,
1168 'str': self
._create
_string
,
1169 'string': self
._create
_string
,
1170 'struct': self
._create
_struct
,
1171 'structure': self
._create
_struct
,
1172 'array': self
._create
_array
,
1173 'var': self
._create
_variant
,
1174 'variant': self
._create
_variant
,
1176 self
._type
_to
_create
_type
_func
= {
1177 metadata
.Integer
: self
._create
_integer
,
1178 metadata
.FloatingPoint
: self
._create
_float
,
1179 metadata
.Enum
: self
._create
_enum
,
1180 metadata
.String
: self
._create
_string
,
1181 metadata
.Struct
: self
._create
_struct
,
1182 metadata
.Array
: self
._create
_array
,
1183 metadata
.Variant
: self
._create
_variant
,
1185 self
._include
_dirs
= include_dirs
1186 self
._ignore
_include
_not
_found
= ignore_include_not_found
1187 self
._dump
_config
= dump_config
1189 def _set_byte_order(self
, metadata_node
):
1190 if 'trace' not in metadata_node
:
1191 raise ConfigError('missing "trace" property (metadata)')
1193 trace_node
= metadata_node
['trace']
1195 if not _is_assoc_array_prop(trace_node
):
1196 raise ConfigError('"trace" property (metadata) must be an associative array')
1198 if 'byte-order' not in trace_node
:
1199 raise ConfigError('missing "byte-order" property (trace)')
1201 bo_node
= trace_node
['byte-order']
1203 if not _is_str_prop(bo_node
):
1204 raise ConfigError('"byte-order" property of trace object must be a string ("le" or "be")')
1206 self
._bo
= _byte_order_str_to_bo(bo_node
)
1208 if self
._bo
is None:
1209 raise ConfigError('invalid "byte-order" property (trace): must be "le" or "be"')
1211 def _lookup_type_alias(self
, name
):
1212 if name
in self
._tas
:
1213 return copy
.deepcopy(self
._tas
[name
])
1215 def _set_int_clock_prop_mapping(self
, int_obj
, prop_mapping_node
):
1216 unk_prop
= _get_first_unknown_prop(prop_mapping_node
, ['type', 'name', 'property'])
1219 raise ConfigError('unknown property in integer type object\'s clock property mapping: "{}"'.format(unk_prop
))
1221 if 'name' not in prop_mapping_node
:
1222 raise ConfigError('missing "name" property in integer type object\'s clock property mapping')
1224 if 'property' not in prop_mapping_node
:
1225 raise ConfigError('missing "property" property in integer type object\'s clock property mapping')
1227 clock_name
= prop_mapping_node
['name']
1228 prop
= prop_mapping_node
['property']
1230 if not _is_str_prop(clock_name
):
1231 raise ConfigError('"name" property of integer type object\'s clock property mapping must be a string')
1233 if not _is_str_prop(prop
):
1234 raise ConfigError('"property" property of integer type object\'s clock property mapping must be a string')
1236 if clock_name
not in self
._clocks
:
1237 raise ConfigError('invalid clock name "{}" in integer type object\'s clock property mapping'.format(clock_name
))
1240 raise ConfigError('invalid "property" property in integer type object\'s clock property mapping: "{}"'.format(prop
))
1242 mapped_clock
= self
._clocks
[clock_name
]
1243 int_obj
.property_mappings
.append(metadata
.PropertyMapping(mapped_clock
, prop
))
1245 def _get_first_unknown_type_prop(self
, type_node
, known_props
):
1246 kp
= known_props
+ ['inherit', 'class']
1248 if self
._version
>= 201:
1249 kp
.append('$inherit')
1251 return _get_first_unknown_prop(type_node
, kp
)
1253 def _create_integer(self
, obj
, node
):
1255 # create integer object
1256 obj
= metadata
.Integer()
1258 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1265 'property-mappings',
1269 raise ConfigError('unknown integer type object property: "{}"'.format(unk_prop
))
1275 if not _is_int_prop(size
):
1276 raise ConfigError('"size" property of integer type object must be an integer')
1279 raise ConfigError('invalid integer size: {}'.format(size
))
1285 align
= node
['align']
1288 obj
.set_default_align()
1290 if not _is_int_prop(align
):
1291 raise ConfigError('"align" property of integer type object must be an integer')
1293 if not _is_valid_alignment(align
):
1294 raise ConfigError('invalid alignment: {}'.format(align
))
1299 if 'signed' in node
:
1300 signed
= node
['signed']
1303 obj
.set_default_signed()
1305 if not _is_bool_prop(signed
):
1306 raise ConfigError('"signed" property of integer type object must be a boolean')
1311 if 'byte-order' in node
:
1312 byte_order
= node
['byte-order']
1314 if byte_order
is None:
1315 obj
.byte_order
= self
._bo
1317 if not _is_str_prop(byte_order
):
1318 raise ConfigError('"byte-order" property of integer type object must be a string ("le" or "be")')
1320 byte_order
= _byte_order_str_to_bo(byte_order
)
1322 if byte_order
is None:
1323 raise ConfigError('invalid "byte-order" property in integer type object')
1325 obj
.byte_order
= byte_order
1327 obj
.byte_order
= self
._bo
1334 obj
.set_default_base()
1336 if not _is_str_prop(base
):
1337 raise ConfigError('"base" property of integer type object must be a string ("bin", "oct", "dec", or "hex")')
1348 raise ConfigError('unknown "base" property value: "{}" ("bin", "oct", "dec", and "hex" are accepted)'.format(base
))
1353 if 'encoding' in node
:
1354 encoding
= node
['encoding']
1356 if encoding
is None:
1357 obj
.set_default_encoding()
1359 if not _is_str_prop(encoding
):
1360 raise ConfigError('"encoding" property of integer type object must be a string ("none", "ascii", or "utf-8")')
1362 encoding
= _encoding_str_to_encoding(encoding
)
1364 if encoding
is None:
1365 raise ConfigError('invalid "encoding" property in integer type object')
1367 obj
.encoding
= encoding
1370 if 'property-mappings' in node
:
1371 prop_mappings
= node
['property-mappings']
1373 if prop_mappings
is None:
1374 obj
.set_default_property_mappings()
1376 if not _is_array_prop(prop_mappings
):
1377 raise ConfigError('"property-mappings" property of integer type object must be an array')
1379 if len(prop_mappings
) > 1:
1380 raise ConfigError('length of "property-mappings" array in integer type object must be 1')
1382 for index
, prop_mapping
in enumerate(prop_mappings
):
1383 if not _is_assoc_array_prop(prop_mapping
):
1384 raise ConfigError('elements of "property-mappings" property of integer type object must be associative arrays')
1386 if 'type' not in prop_mapping
:
1387 raise ConfigError('missing "type" property in integer type object\'s "property-mappings" array\'s element #{}'.format(index
))
1389 prop_type
= prop_mapping
['type']
1391 if not _is_str_prop(prop_type
):
1392 raise ConfigError('"type" property of integer type object\'s "property-mappings" array\'s element #{} must be a string'.format(index
))
1394 if prop_type
== 'clock':
1395 self
._set
_int
_clock
_prop
_mapping
(obj
, prop_mapping
)
1397 raise ConfigError('unknown property mapping type "{}" in integer type object\'s "property-mappings" array\'s element #{}'.format(prop_type
, index
))
1401 def _create_float(self
, obj
, node
):
1403 # create floating point number object
1404 obj
= metadata
.FloatingPoint()
1406 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1413 raise ConfigError('unknown floating point number type object property: "{}"'.format(unk_prop
))
1419 if not _is_assoc_array_prop(size
):
1420 raise ConfigError('"size" property of floating point number type object must be an associative array')
1422 unk_prop
= _get_first_unknown_prop(size
, ['exp', 'mant'])
1425 raise ConfigError('unknown floating point number type object\'s "size" property: "{}"'.format(unk_prop
))
1430 if not _is_int_prop(exp
):
1431 raise ConfigError('"exp" property of floating point number type object\'s "size" property must be an integer')
1434 raise ConfigError('invalid floating point number exponent size: {}')
1441 if not _is_int_prop(mant
):
1442 raise ConfigError('"mant" property of floating point number type object\'s "size" property must be an integer')
1445 raise ConfigError('invalid floating point number mantissa size: {}')
1447 obj
.mant_size
= mant
1451 align
= node
['align']
1454 obj
.set_default_align()
1456 if not _is_int_prop(align
):
1457 raise ConfigError('"align" property of floating point number type object must be an integer')
1459 if not _is_valid_alignment(align
):
1460 raise ConfigError('invalid alignment: {}'.format(align
))
1465 if 'byte-order' in node
:
1466 byte_order
= node
['byte-order']
1468 if byte_order
is None:
1469 obj
.byte_order
= self
._bo
1471 if not _is_str_prop(byte_order
):
1472 raise ConfigError('"byte-order" property of floating point number type object must be a string ("le" or "be")')
1474 byte_order
= _byte_order_str_to_bo(byte_order
)
1476 if byte_order
is None:
1477 raise ConfigError('invalid "byte-order" property in floating point number type object')
1479 obj
.byte_order
= self
._bo
1483 def _create_enum(self
, obj
, node
):
1485 # create enumeration object
1486 obj
= metadata
.Enum()
1488 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1494 raise ConfigError('unknown enumeration type object property: "{}"'.format(unk_prop
))
1497 if 'value-type' in node
:
1498 value_type_node
= node
['value-type']
1501 obj
.value_type
= self
._create
_type
(value_type_node
)
1502 except Exception as e
:
1503 raise ConfigError('cannot create enumeration type\'s integer type', e
)
1506 if 'members' in node
:
1507 members_node
= node
['members']
1509 if not _is_array_prop(members_node
):
1510 raise ConfigError('"members" property of enumeration type object must be an array')
1513 last_value
= obj
.last_value
1515 if last_value
is None:
1518 cur
= last_value
+ 1
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
))
1524 if _is_str_prop(m_node
):
1529 unk_prop
= _get_first_unknown_prop(m_node
, [
1535 raise ConfigError('unknown enumeration type member object property: "{}"'.format(unk_prop
))
1537 if 'label' not in m_node
:
1538 raise ConfigError('missing "label" property in enumeration member #{}'.format(index
))
1540 label
= m_node
['label']
1542 if not _is_str_prop(label
):
1543 raise ConfigError('"label" property of enumeration member #{} must be a string'.format(index
))
1545 if 'value' not in m_node
:
1546 raise ConfigError('missing "value" property in enumeration member ("{}")'.format(label
))
1548 value
= m_node
['value']
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
))
1553 if _is_int_prop(value
):
1555 value
= (value
, value
)
1558 raise ConfigError('invalid enumeration member ("{}"): range must have exactly two items'.format(label
))
1564 raise ConfigError('invalid enumeration member ("{}"): invalid range ({} > {})'.format(label
, mn
, mx
))
1569 obj
.members
[label
] = value
1573 def _create_string(self
, obj
, node
):
1575 # create string object
1576 obj
= metadata
.String()
1578 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1583 raise ConfigError('unknown string type object property: "{}"'.format(unk_prop
))
1586 if 'encoding' in node
:
1587 encoding
= node
['encoding']
1589 if encoding
is None:
1590 obj
.set_default_encoding()
1592 if not _is_str_prop(encoding
):
1593 raise ConfigError('"encoding" property of string type object must be a string ("none", "ascii", or "utf-8")')
1595 encoding
= _encoding_str_to_encoding(encoding
)
1597 if encoding
is None:
1598 raise ConfigError('invalid "encoding" property in string type object')
1600 obj
.encoding
= encoding
1604 def _create_struct(self
, obj
, node
):
1606 # create structure object
1607 obj
= metadata
.Struct()
1609 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1615 raise ConfigError('unknown string type object property: "{}"'.format(unk_prop
))
1618 if 'min-align' in node
:
1619 min_align
= node
['min-align']
1621 if min_align
is None:
1622 obj
.set_default_min_align()
1624 if not _is_int_prop(min_align
):
1625 raise ConfigError('"min-align" property of structure type object must be an integer')
1627 if not _is_valid_alignment(min_align
):
1628 raise ConfigError('invalid minimum alignment: {}'.format(min_align
))
1630 obj
.min_align
= min_align
1633 if 'fields' in node
:
1634 fields
= node
['fields']
1637 obj
.set_default_fields()
1639 if not _is_assoc_array_prop(fields
):
1640 raise ConfigError('"fields" property of structure type object must be an associative array')
1642 for field_name
, field_node
in fields
.items():
1643 if not _is_valid_identifier(field_name
):
1644 raise ConfigError('"{}" is not a valid field name for structure type'.format(field_name
))
1647 obj
.fields
[field_name
] = self
._create
_type
(field_node
)
1648 except Exception as e
:
1649 raise ConfigError('cannot create structure type\'s field "{}"'.format(field_name
), e
)
1653 def _create_array(self
, obj
, node
):
1655 # create array object
1656 obj
= metadata
.Array()
1658 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1664 raise ConfigError('unknown array type object property: "{}"'.format(unk_prop
))
1667 if 'length' in node
:
1668 length
= node
['length']
1670 if not _is_int_prop(length
) and not _is_str_prop(length
):
1671 raise ConfigError('"length" property of array type object must be an integer or a string')
1673 if type(length
) is int and length
< 0:
1674 raise ConfigError('invalid static array length: {}'.format(length
))
1679 if 'element-type' in node
:
1680 element_type_node
= node
['element-type']
1683 obj
.element_type
= self
._create
_type
(node
['element-type'])
1684 except Exception as e
:
1685 raise ConfigError('cannot create array type\'s element type', e
)
1689 def _create_variant(self
, obj
, node
):
1691 # create variant object
1692 obj
= metadata
.Variant()
1694 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1700 raise ConfigError('unknown variant type object property: "{}"'.format(unk_prop
))
1706 if not _is_str_prop(tag
):
1707 raise ConfigError('"tag" property of variant type object must be a string')
1709 # do not validate variant tag for the moment; will be done in a
1715 types
= node
['types']
1717 if not _is_assoc_array_prop(types
):
1718 raise ConfigError('"types" property of variant type object must be an associative array')
1720 # do not validate type names for the moment; will be done in a
1722 for type_name
, type_node
in types
.items():
1723 if not _is_valid_identifier(type_name
):
1724 raise ConfigError('"{}" is not a valid type name for variant type'.format(type_name
))
1727 obj
.types
[type_name
] = self
._create
_type
(type_node
)
1728 except Exception as e
:
1729 raise ConfigError('cannot create variant type\'s type "{}"'.format(type_name
), e
)
1733 def _create_type(self
, type_node
):
1734 if type(type_node
) is str:
1735 t
= self
._lookup
_type
_alias
(type_node
)
1738 raise ConfigError('unknown type alias "{}"'.format(type_node
))
1742 if not _is_assoc_array_prop(type_node
):
1743 raise ConfigError('type objects must be associative arrays or strings (type alias name)')
1750 if self
._version
>= 200:
1751 if 'inherit' in type_node
:
1752 inherit_prop
= 'inherit'
1753 inherit_node
= type_node
[inherit_prop
]
1755 if self
._version
>= 201:
1756 if '$inherit' in type_node
:
1757 if inherit_node
is not None:
1758 raise ConfigError('cannot specify both "inherit" and "$inherit" properties of type object: prefer "$inherit"')
1760 inherit_prop
= '$inherit'
1761 inherit_node
= type_node
[inherit_prop
]
1763 if inherit_node
is not None and 'class' in type_node
:
1764 raise ConfigError('cannot specify both "{}" and "class" properties in type object'.format(inherit_prop
))
1766 if inherit_node
is not None:
1767 if not _is_str_prop(inherit_node
):
1768 raise ConfigError('"{}" property of type object must be a string'.format(inherit_prop
))
1770 base
= self
._lookup
_type
_alias
(inherit_node
)
1773 raise ConfigError('cannot inherit from type alias "{}": type alias does not exist at this point'.format(inherit_node
))
1775 func
= self
._type
_to
_create
_type
_func
[type(base
)]
1777 if 'class' not in type_node
:
1778 raise ConfigError('type objects which do not inherit must have a "class" property')
1780 class_name
= type_node
['class']
1782 if type(class_name
) is not str:
1783 raise ConfigError('type objects\' "class" property must be a string')
1785 if class_name
not in self
._class
_name
_to
_create
_type
_func
:
1786 raise ConfigError('unknown type class "{}"'.format(class_name
))
1789 func
= self
._class
_name
_to
_create
_type
_func
[class_name
]
1791 return func(base
, type_node
)
1793 def _register_type_aliases(self
, metadata_node
):
1796 if 'type-aliases' not in metadata_node
:
1799 ta_node
= metadata_node
['type-aliases']
1804 if not _is_assoc_array_prop(ta_node
):
1805 raise ConfigError('"type-aliases" property (metadata) must be an associative array')
1807 for ta_name
, ta_type
in ta_node
.items():
1808 if ta_name
in self
._tas
:
1809 raise ConfigError('duplicate type alias "{}"'.format(ta_name
))
1812 t
= self
._create
_type
(ta_type
)
1813 except Exception as e
:
1814 raise ConfigError('cannot create type alias "{}"'.format(ta_name
), e
)
1816 self
._tas
[ta_name
] = t
1818 def _create_clock(self
, node
):
1819 # create clock object
1820 clock
= metadata
.Clock()
1822 if not _is_assoc_array_prop(node
):
1823 raise ConfigError('clock objects must be associative arrays')
1835 if self
._version
>= 201:
1836 known_props
.append('$return-ctype')
1838 unk_prop
= _get_first_unknown_prop(node
, known_props
)
1841 raise ConfigError('unknown clock object property: "{}"'.format(unk_prop
))
1845 uuidp
= node
['uuid']
1848 clock
.set_default_uuid()
1850 if not _is_str_prop(uuidp
):
1851 raise ConfigError('"uuid" property of clock object must be a string')
1854 uuidp
= uuid
.UUID(uuidp
)
1856 raise ConfigError('malformed UUID (clock object): "{}"'.format(uuidp
))
1861 if 'description' in node
:
1862 desc
= node
['description']
1865 clock
.set_default_description()
1867 if not _is_str_prop(desc
):
1868 raise ConfigError('"description" property of clock object must be a string')
1870 clock
.description
= desc
1877 clock
.set_default_freq()
1879 if not _is_int_prop(freq
):
1880 raise ConfigError('"freq" property of clock object must be an integer')
1883 raise ConfigError('invalid clock frequency: {}'.format(freq
))
1888 if 'error-cycles' in node
:
1889 error_cycles
= node
['error-cycles']
1891 if error_cycles
is None:
1892 clock
.set_default_error_cycles()
1894 if not _is_int_prop(error_cycles
):
1895 raise ConfigError('"error-cycles" property of clock object must be an integer')
1897 if error_cycles
< 0:
1898 raise ConfigError('invalid clock error cycles: {}'.format(error_cycles
))
1900 clock
.error_cycles
= error_cycles
1903 if 'offset' in node
:
1904 offset
= node
['offset']
1907 clock
.set_default_offset_seconds()
1908 clock
.set_default_offset_cycles()
1910 if not _is_assoc_array_prop(offset
):
1911 raise ConfigError('"offset" property of clock object must be an associative array')
1913 unk_prop
= _get_first_unknown_prop(offset
, ['cycles', 'seconds'])
1916 raise ConfigError('unknown clock object\'s offset property: "{}"'.format(unk_prop
))
1919 if 'cycles' in offset
:
1920 offset_cycles
= offset
['cycles']
1922 if offset_cycles
is None:
1923 clock
.set_default_offset_cycles()
1925 if not _is_int_prop(offset_cycles
):
1926 raise ConfigError('"cycles" property of clock object\'s offset property must be an integer')
1928 if offset_cycles
< 0:
1929 raise ConfigError('invalid clock offset cycles: {}'.format(offset_cycles
))
1931 clock
.offset_cycles
= offset_cycles
1934 if 'seconds' in offset
:
1935 offset_seconds
= offset
['seconds']
1937 if offset_seconds
is None:
1938 clock
.set_default_offset_seconds()
1940 if not _is_int_prop(offset_seconds
):
1941 raise ConfigError('"seconds" property of clock object\'s offset property must be an integer')
1943 if offset_seconds
< 0:
1944 raise ConfigError('invalid clock offset seconds: {}'.format(offset_seconds
))
1946 clock
.offset_seconds
= offset_seconds
1949 if 'absolute' in node
:
1950 absolute
= node
['absolute']
1952 if absolute
is None:
1953 clock
.set_default_absolute()
1955 if not _is_bool_prop(absolute
):
1956 raise ConfigError('"absolute" property of clock object must be a boolean')
1958 clock
.absolute
= absolute
1961 # v2.0: "return-ctype"
1962 # v2.1+: "$return-ctype"
1963 return_ctype_node
= None
1965 if self
._version
>= 200:
1966 if 'return-ctype' in node
:
1967 return_ctype_prop
= 'return-ctype'
1968 return_ctype_node
= node
[return_ctype_prop
]
1970 if self
._version
>= 201:
1971 if '$return-ctype' in node
:
1972 if return_ctype_node
is not None:
1973 raise ConfigError('cannot specify both "return-ctype" and "$return-ctype" properties of clock object: prefer "$return-ctype"')
1975 return_ctype_prop
= '$return-ctype'
1976 return_ctype_node
= node
[return_ctype_prop
]
1978 if return_ctype_node
is not None:
1979 if return_ctype_node
is None:
1980 clock
.set_default_return_ctype()
1982 if not _is_str_prop(return_ctype_node
):
1983 raise ConfigError('"{}" property of clock object must be a string'.format(return_ctype_prop
))
1985 clock
.return_ctype
= return_ctype_node
1989 def _register_clocks(self
, metadata_node
):
1990 self
._clocks
= collections
.OrderedDict()
1992 if 'clocks' not in metadata_node
:
1995 clocks_node
= metadata_node
['clocks']
1997 if clocks_node
is None:
2000 if not _is_assoc_array_prop(clocks_node
):
2001 raise ConfigError('"clocks" property (metadata) must be an associative array')
2003 for clock_name
, clock_node
in clocks_node
.items():
2004 if not _is_valid_identifier(clock_name
):
2005 raise ConfigError('invalid clock name: "{}"'.format(clock_name
))
2007 if clock_name
in self
._clocks
:
2008 raise ConfigError('duplicate clock "{}"'.format(clock_name
))
2011 clock
= self
._create
_clock
(clock_node
)
2012 except Exception as e
:
2013 raise ConfigError('cannot create clock "{}"'.format(clock_name
), e
)
2015 clock
.name
= clock_name
2016 self
._clocks
[clock_name
] = clock
2018 def _create_env(self
, metadata_node
):
2019 env
= collections
.OrderedDict()
2021 if 'env' not in metadata_node
:
2024 env_node
= metadata_node
['env']
2026 if env_node
is None:
2029 if not _is_assoc_array_prop(env_node
):
2030 raise ConfigError('"env" property (metadata) must be an associative array')
2032 for env_name
, env_value
in env_node
.items():
2034 raise ConfigError('duplicate environment variable "{}"'.format(env_name
))
2036 if not _is_valid_identifier(env_name
):
2037 raise ConfigError('invalid environment variable name: "{}"'.format(env_name
))
2039 if not _is_int_prop(env_value
) and not _is_str_prop(env_value
):
2040 raise ConfigError('invalid environment variable value ("{}"): expecting integer or string'.format(env_name
))
2042 env
[env_name
] = env_value
2046 def _register_log_levels(self
, metadata_node
):
2047 self
._log
_levels
= dict()
2050 # v2.0: "log-levels"
2051 # v2.1+: "$log-levels"
2052 log_levels_node
= None
2054 if self
._version
>= 200:
2055 if 'log-levels' in metadata_node
:
2056 log_levels_prop
= 'log-levels'
2057 log_levels_node
= metadata_node
[log_levels_prop
]
2059 if self
._version
>= 201:
2060 if '$log-levels' in metadata_node
:
2061 if log_levels_node
is not None:
2062 raise ConfigError('cannot specify both "log-levels" and "$log-levels" properties of metadata object: prefer "$log-levels"')
2064 log_levels_prop
= '$log-levels'
2065 log_levels_node
= metadata_node
[log_levels_prop
]
2067 if log_levels_node
is None:
2070 if not _is_assoc_array_prop(log_levels_node
):
2071 raise ConfigError('"{}" property (metadata) must be an associative array'.format(log_levels_prop
))
2073 for ll_name
, ll_value
in log_levels_node
.items():
2074 if ll_name
in self
._log
_levels
:
2075 raise ConfigError('duplicate log level entry "{}"'.format(ll_name
))
2077 if not _is_int_prop(ll_value
):
2078 raise ConfigError('invalid log level entry ("{}"): expecting an integer'.format(ll_name
))
2081 raise ConfigError('invalid log level entry ("{}"): log level value must be positive'.format(ll_name
))
2083 self
._log
_levels
[ll_name
] = ll_value
2085 def _create_trace(self
, metadata_node
):
2086 # create trace object
2087 trace
= metadata
.Trace()
2089 if 'trace' not in metadata_node
:
2090 raise ConfigError('missing "trace" property (metadata)')
2092 trace_node
= metadata_node
['trace']
2094 if not _is_assoc_array_prop(trace_node
):
2095 raise ConfigError('"trace" property (metadata) must be an associative array')
2097 unk_prop
= _get_first_unknown_prop(trace_node
, [
2100 'packet-header-type',
2104 raise ConfigError('unknown trace object property: "{}"'.format(unk_prop
))
2106 # set byte order (already parsed)
2107 trace
.byte_order
= self
._bo
2110 if 'uuid' in trace_node
and trace_node
['uuid'] is not None:
2111 uuidp
= trace_node
['uuid']
2113 if not _is_str_prop(uuidp
):
2114 raise ConfigError('"uuid" property of trace object must be a string')
2117 uuidp
= uuid
.uuid1()
2120 uuidp
= uuid
.UUID(uuidp
)
2122 raise ConfigError('malformed UUID (trace object): "{}"'.format(uuidp
))
2126 # packet header type
2127 if 'packet-header-type' in trace_node
and trace_node
['packet-header-type'] is not None:
2129 ph_type
= self
._create
_type
(trace_node
['packet-header-type'])
2130 except Exception as e
:
2131 raise ConfigError('cannot create packet header type (trace)', e
)
2133 trace
.packet_header_type
= ph_type
2137 def _lookup_log_level(self
, ll
):
2138 if _is_int_prop(ll
):
2140 elif _is_str_prop(ll
) and ll
in self
._log
_levels
:
2141 return self
._log
_levels
[ll
]
2143 def _create_event(self
, event_node
):
2144 event
= metadata
.Event()
2146 if not _is_assoc_array_prop(event_node
):
2147 raise ConfigError('event objects must be associative arrays')
2149 unk_prop
= _get_first_unknown_prop(event_node
, [
2156 raise ConfigError('unknown event object property: "{}"'.format(unk_prop
))
2158 if 'log-level' in event_node
and event_node
['log-level'] is not None:
2159 ll_node
= event_node
['log-level']
2161 if _is_str_prop(ll_node
):
2162 ll_value
= self
._lookup
_log
_level
(event_node
['log-level'])
2164 if ll_value
is None:
2165 raise ConfigError('cannot find log level "{}"'.format(ll_node
))
2167 ll
= metadata
.LogLevel(event_node
['log-level'], ll_value
)
2168 elif _is_int_prop(ll_node
):
2170 raise ConfigError('invalid log level value {}: value must be positive'.format(ll_node
))
2172 ll
= metadata
.LogLevel(None, ll_node
)
2174 raise ConfigError('"log-level" property must be either a string or an integer')
2176 event
.log_level
= ll
2178 if 'context-type' in event_node
and event_node
['context-type'] is not None:
2179 ctx_type_node
= event_node
['context-type']
2182 t
= self
._create
_type
(event_node
['context-type'])
2183 except Exception as e
:
2184 raise ConfigError('cannot create event\'s context type object', e
)
2186 event
.context_type
= t
2188 if 'payload-type' in event_node
and event_node
['payload-type'] is not None:
2190 t
= self
._create
_type
(event_node
['payload-type'])
2191 except Exception as e
:
2192 raise ConfigError('cannot create event\'s payload type object', e
)
2194 event
.payload_type
= t
2198 def _create_stream(self
, stream_node
):
2199 stream
= metadata
.Stream()
2201 if not _is_assoc_array_prop(stream_node
):
2202 raise ConfigError('stream objects must be associative arrays')
2204 unk_prop
= _get_first_unknown_prop(stream_node
, [
2205 'packet-context-type',
2206 'event-header-type',
2207 'event-context-type',
2212 raise ConfigError('unknown stream object property: "{}"'.format(unk_prop
))
2214 if 'packet-context-type' in stream_node
and stream_node
['packet-context-type'] is not None:
2216 t
= self
._create
_type
(stream_node
['packet-context-type'])
2217 except Exception as e
:
2218 raise ConfigError('cannot create stream\'s packet context type object', e
)
2220 stream
.packet_context_type
= t
2222 if 'event-header-type' in stream_node
and stream_node
['event-header-type'] is not None:
2224 t
= self
._create
_type
(stream_node
['event-header-type'])
2225 except Exception as e
:
2226 raise ConfigError('cannot create stream\'s event header type object', e
)
2228 stream
.event_header_type
= t
2230 if 'event-context-type' in stream_node
and stream_node
['event-context-type'] is not None:
2232 t
= self
._create
_type
(stream_node
['event-context-type'])
2233 except Exception as e
:
2234 raise ConfigError('cannot create stream\'s event context type object', e
)
2236 stream
.event_context_type
= t
2238 if 'events' not in stream_node
:
2239 raise ConfigError('missing "events" property in stream object')
2241 events
= stream_node
['events']
2243 if events
is not None:
2244 if not _is_assoc_array_prop(events
):
2245 raise ConfigError('"events" property of stream object must be an associative array')
2248 raise ConfigError('at least one event is needed within a stream object')
2252 for ev_name
, ev_node
in events
.items():
2254 ev
= self
._create
_event
(ev_node
)
2255 except Exception as e
:
2256 raise ConfigError('cannot create event "{}"'.format(ev_name
), e
)
2260 stream
.events
[ev_name
] = ev
2265 def _create_streams(self
, metadata_node
):
2266 streams
= collections
.OrderedDict()
2268 if 'streams' not in metadata_node
:
2269 raise ConfigError('missing "streams" property (metadata)')
2271 streams_node
= metadata_node
['streams']
2273 if not _is_assoc_array_prop(streams_node
):
2274 raise ConfigError('"streams" property (metadata) must be an associative array')
2276 if not streams_node
:
2277 raise ConfigError('at least one stream is needed (metadata)')
2281 for stream_name
, stream_node
in streams_node
.items():
2283 stream
= self
._create
_stream
(stream_node
)
2284 except Exception as e
:
2285 raise ConfigError('cannot create stream "{}"'.format(stream_name
), e
)
2288 stream
.name
= str(stream_name
)
2289 streams
[stream_name
] = stream
2294 def _create_metadata(self
, root
):
2295 meta
= metadata
.Metadata()
2297 if 'metadata' not in root
:
2298 raise ConfigError('missing "metadata" property (configuration)')
2300 metadata_node
= root
['metadata']
2302 if not _is_assoc_array_prop(metadata_node
):
2303 raise ConfigError('"metadata" property (configuration) must be an associative array')
2314 if self
._version
>= 201:
2315 known_props
.append('$log-levels')
2317 unk_prop
= _get_first_unknown_prop(metadata_node
, known_props
)
2322 if unk_prop
== '$include':
2323 add
= ' (use version 2.1 or greater)'
2325 raise ConfigError('unknown metadata property{}: "{}"'.format(add
, unk_prop
))
2327 self
._set
_byte
_order
(metadata_node
)
2328 self
._register
_clocks
(metadata_node
)
2329 meta
.clocks
= self
._clocks
2330 self
._register
_type
_aliases
(metadata_node
)
2331 meta
.env
= self
._create
_env
(metadata_node
)
2332 meta
.trace
= self
._create
_trace
(metadata_node
)
2333 self
._register
_log
_levels
(metadata_node
)
2334 meta
.streams
= self
._create
_streams
(metadata_node
)
2338 def _get_version(self
, root
):
2339 if 'version' not in root
:
2340 raise ConfigError('missing "version" property (configuration)')
2342 version_node
= root
['version']
2344 if not _is_str_prop(version_node
):
2345 raise ConfigError('"version" property (configuration) must be a string')
2347 version_node
= version_node
.strip()
2349 if version_node
not in ['2.0', '2.1']:
2350 raise ConfigError('unsupported version ({}): versions 2.0 and 2.1 are supported'.format(version_node
))
2352 # convert version string to comparable version integer
2353 parts
= version_node
.split('.')
2354 version
= int(parts
[0]) * 100 + int(parts
[1])
2358 def _get_prefix(self
, root
):
2359 def_prefix
= 'barectf_'
2361 if 'prefix' not in root
:
2364 prefix_node
= root
['prefix']
2366 if prefix_node
is None:
2369 if not _is_str_prop(prefix_node
):
2370 raise ConfigError('"prefix" property (configuration) must be a string')
2372 if not _is_valid_identifier(prefix_node
):
2373 raise ConfigError('"prefix" property (configuration) must be a valid C identifier')
2377 def _get_last_include_file(self
):
2378 if self
._include
_stack
:
2379 return self
._include
_stack
[-1]
2381 return self
._root
_yaml
_path
2383 def _load_include(self
, yaml_path
):
2384 for inc_dir
in self
._include
_dirs
:
2385 # current include dir + file name path
2386 # note: os.path.join() only takes the last arg if it's absolute
2387 inc_path
= os
.path
.join(inc_dir
, yaml_path
)
2389 # real path (symbolic links resolved)
2390 real_path
= os
.path
.realpath(inc_path
)
2392 # normalized path (weird stuff removed!)
2393 norm_path
= os
.path
.normpath(real_path
)
2395 if not os
.path
.isfile(norm_path
):
2396 # file does not exist: skip
2399 if norm_path
in self
._include
_stack
:
2400 base_path
= self
._get
_last
_include
_file
()
2401 raise ConfigError('in "{}": cannot recursively include file "{}"'.format(base_path
, norm_path
))
2403 self
._include
_stack
.append(norm_path
)
2406 return self
._yaml
_ordered
_load
(norm_path
)
2408 if not self
._ignore
_include
_not
_found
:
2409 base_path
= self
._get
_last
_include
_file
()
2410 raise ConfigError('in "{}": cannot include file "{}": file not found in include directories'.format(base_path
, yaml_path
))
2414 def _get_include_paths(self
, include_node
):
2415 if include_node
is None:
2418 if _is_str_prop(include_node
):
2419 return [include_node
]
2421 if _is_array_prop(include_node
):
2422 for include_path
in include_node
:
2423 if not _is_str_prop(include_path
):
2424 raise ConfigError('invalid include property: expecting array of strings')
2428 raise ConfigError('invalid include property: expecting string or array of strings')
2430 def _update_node(self
, base_node
, overlay_node
):
2431 for olay_key
, olay_value
in overlay_node
.items():
2432 if olay_key
in base_node
:
2433 base_value
= base_node
[olay_key
]
2435 if _is_assoc_array_prop(olay_value
) and _is_assoc_array_prop(base_value
):
2436 # merge dictionaries
2437 self
._update
_node
(base_value
, olay_value
)
2438 elif _is_array_prop(olay_value
) and _is_array_prop(base_value
):
2439 # append extension array items to base items
2440 base_value
+= olay_value
2442 # fall back to replacing
2443 base_node
[olay_key
] = olay_value
2445 base_node
[olay_key
] = olay_value
2447 def _process_node_include(self
, last_overlay_node
, name
,
2448 process_base_include_cb
,
2449 process_children_include_cb
=None):
2450 if not _is_assoc_array_prop(last_overlay_node
):
2451 raise ConfigError('{} objects must be associative arrays'.format(name
))
2453 # process children inclusions first
2454 if process_children_include_cb
:
2455 process_children_include_cb(last_overlay_node
)
2457 if '$include' in last_overlay_node
:
2458 include_node
= last_overlay_node
['$include']
2461 return last_overlay_node
2463 include_paths
= self
._get
_include
_paths
(include_node
)
2464 cur_base_path
= self
._get
_last
_include
_file
()
2467 # keep the include paths and remove the include property
2468 include_paths
= copy
.deepcopy(include_paths
)
2469 del last_overlay_node
['$include']
2471 for include_path
in include_paths
:
2472 # load raw YAML from included file
2473 overlay_node
= self
._load
_include
(include_path
)
2475 if overlay_node
is None:
2476 # cannot find include file, but we're ignoring those
2477 # errors, otherwise _load_include() itself raises
2481 # recursively process includes
2483 overlay_node
= process_base_include_cb(overlay_node
)
2484 except Exception as e
:
2485 raise ConfigError('in "{}"'.format(cur_base_path
), e
)
2487 # pop include stack now that we're done including
2488 del self
._include
_stack
[-1]
2490 # at this point, base_node is fully resolved (does not
2491 # contain any include property)
2492 if base_node
is None:
2493 base_node
= overlay_node
2495 self
._update
_node
(base_node
, overlay_node
)
2497 # finally, we update the latest base node with our last overlay
2499 if base_node
is None:
2500 # nothing was included, which is possible when we're
2501 # ignoring include errors
2502 return last_overlay_node
2504 self
._update
_node
(base_node
, last_overlay_node
)
2508 def _process_event_include(self
, event_node
):
2509 return self
._process
_node
_include
(event_node
, 'event',
2510 self
._process
_event
_include
)
2512 def _process_stream_include(self
, stream_node
):
2513 def process_children_include(stream_node
):
2514 if 'events' in stream_node
:
2515 events_node
= stream_node
['events']
2517 if not _is_assoc_array_prop(events_node
):
2518 raise ConfigError('"events" property must be an associative array')
2520 events_node_keys
= list(events_node
.keys())
2522 for key
in events_node_keys
:
2523 event_node
= events_node
[key
]
2526 events_node
[key
] = self
._process
_event
_include
(event_node
)
2527 except Exception as e
:
2528 raise ConfigError('cannot process includes of event object "{}"'.format(key
), e
)
2530 return self
._process
_node
_include
(stream_node
, 'stream',
2531 self
._process
_stream
_include
,
2532 process_children_include
)
2534 def _process_trace_include(self
, trace_node
):
2535 return self
._process
_node
_include
(trace_node
, 'trace',
2536 self
._process
_trace
_include
)
2538 def _process_clock_include(self
, clock_node
):
2539 return self
._process
_node
_include
(clock_node
, 'clock',
2540 self
._process
_clock
_include
)
2542 def _process_metadata_include(self
, metadata_node
):
2543 def process_children_include(metadata_node
):
2544 if 'trace' in metadata_node
:
2545 metadata_node
['trace'] = self
._process
_trace
_include
(metadata_node
['trace'])
2547 if 'clocks' in metadata_node
:
2548 clocks_node
= metadata_node
['clocks']
2550 if not _is_assoc_array_prop(clocks_node
):
2551 raise ConfigError('"clocks" property (metadata) must be an associative array')
2553 clocks_node_keys
= list(clocks_node
.keys())
2555 for key
in clocks_node_keys
:
2556 clock_node
= clocks_node
[key
]
2559 clocks_node
[key
] = self
._process
_clock
_include
(clock_node
)
2560 except Exception as e
:
2561 raise ConfigError('cannot process includes of clock object "{}"'.format(key
), e
)
2563 if 'streams' in metadata_node
:
2564 streams_node
= metadata_node
['streams']
2566 if not _is_assoc_array_prop(streams_node
):
2567 raise ConfigError('"streams" property (metadata) must be an associative array')
2569 streams_node_keys
= list(streams_node
.keys())
2571 for key
in streams_node_keys
:
2572 stream_node
= streams_node
[key
]
2575 streams_node
[key
] = self
._process
_stream
_include
(stream_node
)
2576 except Exception as e
:
2577 raise ConfigError('cannot process includes of stream object "{}"'.format(key
), e
)
2579 return self
._process
_node
_include
(metadata_node
, 'metadata',
2580 self
._process
_metadata
_include
,
2581 process_children_include
)
2583 def _process_root_includes(self
, root
):
2584 # The following config objects support includes:
2591 # We need to process the event includes first, then the stream
2592 # includes, then the trace includes, and finally the metadata
2595 # In each object, only one of the $include and $include-replace
2596 # special properties is allowed.
2598 # We keep a stack of absolute paths to included files to detect
2600 if 'metadata' in root
:
2601 root
['metadata'] = self
._process
_metadata
_include
(root
['metadata'])
2605 def _yaml_ordered_dump(self
, node
, **kwds
):
2606 class ODumper(yaml
.Dumper
):
2609 def dict_representer(dumper
, node
):
2610 return dumper
.represent_mapping(yaml
.resolver
.BaseResolver
.DEFAULT_MAPPING_TAG
,
2613 ODumper
.add_representer(collections
.OrderedDict
, dict_representer
)
2615 return yaml
.dump(node
, Dumper
=ODumper
, **kwds
)
2617 def _yaml_ordered_load(self
, yaml_path
):
2618 class OLoader(yaml
.Loader
):
2621 def construct_mapping(loader
, node
):
2622 loader
.flatten_mapping(node
)
2624 return collections
.OrderedDict(loader
.construct_pairs(node
))
2626 OLoader
.add_constructor(yaml
.resolver
.BaseResolver
.DEFAULT_MAPPING_TAG
,
2631 with
open(yaml_path
, 'r') as f
:
2632 node
= yaml
.load(f
, OLoader
)
2633 except (OSError, IOError) as e
:
2634 raise ConfigError('cannot open file "{}"'.format(yaml_path
))
2635 except Exception as e
:
2636 raise ConfigError('unknown error while trying to load file "{}"'.format(yaml_path
), e
)
2638 # loaded node must be an associate array
2639 if not _is_assoc_array_prop(node
):
2640 raise ConfigError('root of YAML file "{}" must be an associative array'.format(yaml_path
))
2645 self
._version
= None
2646 self
._include
_stack
= []
2648 def parse(self
, yaml_path
):
2650 self
._root
_yaml
_path
= yaml_path
2653 root
= self
._yaml
_ordered
_load
(yaml_path
)
2654 except Exception as e
:
2655 raise ConfigError('cannot parse YAML file "{}"'.format(yaml_path
), e
)
2657 if not _is_assoc_array_prop(root
):
2658 raise ConfigError('configuration must be an associative array')
2660 unk_prop
= _get_first_unknown_prop(root
, [
2667 raise ConfigError('unknown configuration property: "{}"'.format(unk_prop
))
2669 # get the config version
2670 self
._version
= self
._get
_version
(root
)
2672 # process includes if supported
2673 if self
._version
>= 201:
2674 root
= self
._process
_root
_includes
(root
)
2676 # dump config if required
2677 if self
._dump
_config
:
2678 print(self
._yaml
_ordered
_dump
(root
, indent
=2,
2679 default_flow_style
=False))
2681 # get prefix and metadata
2682 prefix
= self
._get
_prefix
(root
)
2683 meta
= self
._create
_metadata
(root
)
2685 return Config(self
._version
, prefix
, meta
)
2688 def from_yaml_file(path
, include_dirs
, ignore_include_not_found
, dump_config
):
2690 parser
= _YamlConfigParser(include_dirs
, ignore_include_not_found
,
2692 cfg
= parser
.parse(path
)
2695 except Exception as e
:
2696 raise ConfigError('cannot create configuration from YAML file "{}"'.format(path
), e
)