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
):
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())
84 def version(self
, value
):
92 def metadata(self
, value
):
93 self
._validate
_metadata
(value
)
94 self
._augment
_metadata
_env
(value
)
95 self
._metadata
= value
102 def prefix(self
, value
):
103 if not is_valid_identifier(value
):
104 raise ConfigError('prefix must be a valid C identifier')
109 def _is_assoc_array_prop(node
):
110 return isinstance(node
, dict)
113 def _is_array_prop(node
):
114 return isinstance(node
, list)
117 def _is_int_prop(node
):
118 return type(node
) is int
121 def _is_str_prop(node
):
122 return type(node
) is str
125 def _is_bool_prop(node
):
126 return type(node
) is bool
129 def _is_valid_alignment(align
):
130 return ((align
& (align
- 1)) == 0) and align
> 0
133 def _byte_order_str_to_bo(bo_str
):
134 bo_str
= bo_str
.lower()
137 return metadata
.ByteOrder
.LE
139 return metadata
.ByteOrder
.BE
142 def _encoding_str_to_encoding(encoding_str
):
143 encoding_str
= encoding_str
.lower()
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
153 _re_iden
= re
.compile(r
'^[a-zA-Z][a-zA-Z0-9_]*$')
154 _ctf_keywords
= set([
173 def is_valid_identifier(iden
):
174 if not _re_iden
.match(iden
):
177 if _re_iden
in _ctf_keywords
:
183 def _get_first_unknown_prop(node
, known_props
):
184 for prop_name
in node
:
185 if prop_name
in known_props
:
191 # This validator validates the configured metadata for barectf specific
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
:
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
,
211 def _validate_int_type(self
, t
, entity_root
):
213 raise ConfigError('integer type\'s size must be lesser than or equal to 64 bits')
215 def _validate_float_type(self
, t
, entity_root
):
217 raise ConfigError('floating point number type\'s size must be lesser than or equal to 64 bits')
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')
223 def _validate_string_type(self
, t
, entity_root
):
226 def _validate_struct_type(self
, t
, entity_root
):
228 raise ConfigError('inner structure types are not supported as of this version')
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':
237 self
._validate
_type
(field_type
, False)
238 except Exception as e
:
239 raise ConfigError('in structure type\'s field "{}"'.format(field_name
), e
)
241 def _validate_array_type(self
, t
, entity_root
):
242 raise ConfigError('array types are not supported as of this version')
244 def _validate_variant_type(self
, t
, entity_root
):
245 raise ConfigError('variant types are not supported as of this version')
247 def _validate_type(self
, t
, entity_root
):
248 self
._type
_to
_validate
_type
_func
[type(t
)](t
, entity_root
)
250 def _validate_entity(self
, t
):
254 # make sure entity is byte-aligned
256 raise ConfigError('type\'s alignment must be at least byte-aligned')
258 # make sure entity is a structure
259 if type(t
) is not metadata
.Struct
:
260 raise ConfigError('expecting a structure type')
263 self
._validate
_type
(t
, True)
265 def _validate_entities_and_names(self
, meta
):
266 self
._cur
_entity
= _Entity
.TRACE_PACKET_HEADER
269 self
._validate
_entity
(meta
.trace
.packet_header_type
)
270 except Exception as e
:
271 raise ConfigError('invalid trace packet header type', e
)
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
))
277 self
._cur
_entity
= _Entity
.STREAM_PACKET_CONTEXT
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
)
284 self
._cur
_entity
= _Entity
.STREAM_EVENT_HEADER
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
)
291 self
._cur
_entity
= _Entity
.STREAM_EVENT_CONTEXT
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
)
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
))
303 self
._cur
_entity
= _Entity
.EVENT_CONTEXT
306 self
._validate
_entity
(ev
.context_type
)
307 except Exception as e
:
308 raise ConfigError('invalid context type in event "{}"'.format(ev_name
), e
)
310 self
._cur
_entity
= _Entity
.EVENT_PAYLOAD
312 if ev
.payload_type
is None:
313 raise ConfigError('missing payload type in event "{}"'.format(ev_name
), e
)
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 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
)
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, 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, 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')
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, 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, 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')
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
1113 if ev
.payload_type
is None:
1114 raise ConfigError('event payload type must exist in event "{}"'.format(ev_name
))
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
))
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
)
1126 def _validate_stream_types_histology(self
, stream
):
1127 stream_name
= stream
.name
1129 # validate stream packet context type
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
)
1135 # validate stream event header type
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
)
1141 # validate stream event context type
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
)
1148 for ev
in stream
.events
.values():
1150 self
._validate
_event
_types
_histology
(ev
)
1151 except Exception as e
:
1152 raise ConfigError('invalid event in stream "{}"'.format(stream_name
), e
)
1154 def validate(self
, meta
):
1155 # validate trace packet header type
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
)
1162 for stream
in meta
.streams
.values():
1163 self
._validate
_stream
_types
_histology
(stream
)
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
,
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
,
1193 self
._include
_dirs
= include_dirs
1194 self
._ignore
_include
_not
_found
= ignore_include_not_found
1195 self
._dump
_config
= dump_config
1197 def _set_byte_order(self
, metadata_node
):
1198 if 'trace' not in metadata_node
:
1199 raise ConfigError('missing "trace" property (metadata)')
1201 trace_node
= metadata_node
['trace']
1203 if not _is_assoc_array_prop(trace_node
):
1204 raise ConfigError('"trace" property (metadata) must be an associative array')
1206 if 'byte-order' not in trace_node
:
1207 raise ConfigError('missing "byte-order" property (trace)')
1209 bo_node
= trace_node
['byte-order']
1211 if not _is_str_prop(bo_node
):
1212 raise ConfigError('"byte-order" property of trace object must be a string ("le" or "be")')
1214 self
._bo
= _byte_order_str_to_bo(bo_node
)
1216 if self
._bo
is None:
1217 raise ConfigError('invalid "byte-order" property (trace): must be "le" or "be"')
1219 def _lookup_type_alias(self
, name
):
1220 if name
in self
._tas
:
1221 return copy
.deepcopy(self
._tas
[name
])
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'])
1227 raise ConfigError('unknown property in integer type object\'s clock property mapping: "{}"'.format(unk_prop
))
1229 if 'name' not in prop_mapping_node
:
1230 raise ConfigError('missing "name" property in integer type object\'s clock property mapping')
1232 if 'property' not in prop_mapping_node
:
1233 raise ConfigError('missing "property" property in integer type object\'s clock property mapping')
1235 clock_name
= prop_mapping_node
['name']
1236 prop
= prop_mapping_node
['property']
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')
1241 if not _is_str_prop(prop
):
1242 raise ConfigError('"property" property of integer type object\'s clock property mapping must be a string')
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
))
1248 raise ConfigError('invalid "property" property in integer type object\'s clock property mapping: "{}"'.format(prop
))
1250 mapped_clock
= self
._clocks
[clock_name
]
1251 int_obj
.property_mappings
.append(metadata
.PropertyMapping(mapped_clock
, prop
))
1253 def _get_first_unknown_type_prop(self
, type_node
, known_props
):
1254 kp
= known_props
+ ['inherit', 'class']
1256 if self
._version
>= 201:
1257 kp
.append('$inherit')
1259 return _get_first_unknown_prop(type_node
, kp
)
1261 def _create_integer(self
, obj
, node
):
1263 # create integer object
1264 obj
= metadata
.Integer()
1266 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1273 'property-mappings',
1277 raise ConfigError('unknown integer type object property: "{}"'.format(unk_prop
))
1283 if not _is_int_prop(size
):
1284 raise ConfigError('"size" property of integer type object must be an integer')
1287 raise ConfigError('invalid integer size: {}'.format(size
))
1293 align
= node
['align']
1295 if not _is_int_prop(align
):
1296 raise ConfigError('"align" property of integer type object must be an integer')
1298 if not _is_valid_alignment(align
):
1299 raise ConfigError('invalid alignment: {}'.format(align
))
1304 if 'signed' in node
:
1305 signed
= node
['signed']
1307 if not _is_bool_prop(signed
):
1308 raise ConfigError('"signed" property of integer type object must be a boolean')
1313 if 'byte-order' in node
:
1314 byte_order
= node
['byte-order']
1316 if not _is_str_prop(byte_order
):
1317 raise ConfigError('"byte-order" property of integer type object must be a string ("le" or "be")')
1319 byte_order
= _byte_order_str_to_bo(byte_order
)
1321 if byte_order
is None:
1322 raise ConfigError('invalid "byte-order" property in integer type object')
1324 byte_order
= self
._bo
1326 obj
.byte_order
= byte_order
1332 if not _is_str_prop(base
):
1333 raise ConfigError('"base" property of integer type object must be a string ("bin", "oct", "dec", or "hex")')
1344 raise ConfigError('unknown "base" property value: "{}" ("bin", "oct", "dec", and "hex" are accepted)'.format(base
))
1349 if 'encoding' in node
:
1350 encoding
= node
['encoding']
1352 if not _is_str_prop(encoding
):
1353 raise ConfigError('"encoding" property of integer type object must be a string ("none", "ascii", or "utf-8")')
1355 encoding
= _encoding_str_to_encoding(encoding
)
1357 if encoding
is None:
1358 raise ConfigError('invalid "encoding" property in integer type object')
1360 obj
.encoding
= encoding
1363 if 'property-mappings' in node
:
1364 prop_mappings
= node
['property-mappings']
1366 if not _is_array_prop(prop_mappings
):
1367 raise ConfigError('"property-mappings" property of integer type object must be an array')
1369 if len(prop_mappings
) > 1:
1370 raise ConfigError('length of "property-mappings" array in integer type object must be 1')
1372 del obj
.property_mappings
[:]
1374 for index
, prop_mapping
in enumerate(prop_mappings
):
1375 if not _is_assoc_array_prop(prop_mapping
):
1376 raise ConfigError('elements of "property-mappings" property of integer type object must be associative arrays')
1378 if 'type' not in prop_mapping
:
1379 raise ConfigError('missing "type" property in integer type object\'s "property-mappings" array\'s element #{}'.format(index
))
1381 prop_type
= prop_mapping
['type']
1383 if not _is_str_prop(prop_type
):
1384 raise ConfigError('"type" property of integer type object\'s "property-mappings" array\'s element #{} must be a string'.format(index
))
1386 if prop_type
== 'clock':
1387 self
._set
_int
_clock
_prop
_mapping
(obj
, prop_mapping
)
1389 raise ConfigError('unknown property mapping type "{}" in integer type object\'s "property-mappings" array\'s element #{}'.format(prop_type
, index
))
1393 def _create_float(self
, obj
, node
):
1395 # create floating point number object
1396 obj
= metadata
.FloatingPoint()
1398 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1405 raise ConfigError('unknown floating point number type object property: "{}"'.format(unk_prop
))
1411 if not _is_assoc_array_prop(size
):
1412 raise ConfigError('"size" property of floating point number type object must be an associative array')
1414 unk_prop
= _get_first_unknown_prop(size
, ['exp', 'mant'])
1417 raise ConfigError('unknown floating point number type object\'s "size" property: "{}"'.format(unk_prop
))
1422 if not _is_int_prop(exp
):
1423 raise ConfigError('"exp" property of floating point number type object\'s "size" property must be an integer')
1426 raise ConfigError('invalid floating point number exponent size: {}')
1433 if not _is_int_prop(mant
):
1434 raise ConfigError('"mant" property of floating point number type object\'s "size" property must be an integer')
1437 raise ConfigError('invalid floating point number mantissa size: {}')
1439 obj
.mant_size
= mant
1443 align
= node
['align']
1445 if not _is_int_prop(align
):
1446 raise ConfigError('"align" property of floating point number type object must be an integer')
1448 if not _is_valid_alignment(align
):
1449 raise ConfigError('invalid alignment: {}'.format(align
))
1454 if 'byte-order' in node
:
1455 byte_order
= node
['byte-order']
1457 if not _is_str_prop(byte_order
):
1458 raise ConfigError('"byte-order" property of floating point number type object must be a string ("le" or "be")')
1460 byte_order
= _byte_order_str_to_bo(byte_order
)
1462 if byte_order
is None:
1463 raise ConfigError('invalid "byte-order" property in floating point number type object')
1465 byte_order
= self
._bo
1467 obj
.byte_order
= byte_order
1471 def _create_enum(self
, obj
, node
):
1473 # create enumeration object
1474 obj
= metadata
.Enum()
1476 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1482 raise ConfigError('unknown enumeration type object property: "{}"'.format(unk_prop
))
1485 if 'value-type' in node
:
1487 obj
.value_type
= self
._create
_type
(node
['value-type'])
1488 except Exception as e
:
1489 raise ConfigError('cannot create enumeration type\'s integer type', e
)
1492 if 'members' in node
:
1493 members_node
= node
['members']
1495 if not _is_array_prop(members_node
):
1496 raise ConfigError('"members" property of enumeration type object must be an array')
1500 for index
, m_node
in enumerate(members_node
):
1501 if not _is_str_prop(m_node
) and not _is_assoc_array_prop(m_node
):
1502 raise ConfigError('invalid enumeration member #{}: expecting a string or an associative array'.format(index
))
1504 if _is_str_prop(m_node
):
1509 unk_prop
= _get_first_unknown_prop(m_node
, [
1515 raise ConfigError('unknown enumeration type member object property: "{}"'.format(unk_prop
))
1517 if 'label' not in m_node
:
1518 raise ConfigError('missing "label" property in enumeration member #{}'.format(index
))
1520 label
= m_node
['label']
1522 if not _is_str_prop(label
):
1523 raise ConfigError('"label" property of enumeration member #{} must be a string'.format(index
))
1525 if 'value' not in m_node
:
1526 raise ConfigError('missing "value" property in enumeration member ("{}")'.format(label
))
1528 value
= m_node
['value']
1530 if not _is_int_prop(value
) and not _is_array_prop(value
):
1531 raise ConfigError('invalid enumeration member ("{}"): expecting an integer or an array'.format(label
))
1533 if _is_int_prop(value
):
1535 value
= (value
, value
)
1538 raise ConfigError('invalid enumeration member ("{}"): range must have exactly two items'.format(label
))
1544 raise ConfigError('invalid enumeration member ("{}"): invalid range ({} > {})'.format(label
, mn
, mx
))
1549 obj
.members
[label
] = value
1553 def _create_string(self
, obj
, node
):
1555 # create string object
1556 obj
= metadata
.String()
1558 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1563 raise ConfigError('unknown string type object property: "{}"'.format(unk_prop
))
1566 if 'encoding' in node
:
1567 encoding
= node
['encoding']
1569 if not _is_str_prop(encoding
):
1570 raise ConfigError('"encoding" property of string type object must be a string ("none", "ascii", or "utf-8")')
1572 encoding
= _encoding_str_to_encoding(encoding
)
1574 if encoding
is None:
1575 raise ConfigError('invalid "encoding" property in string type object')
1577 obj
.encoding
= encoding
1581 def _create_struct(self
, obj
, node
):
1583 # create structure object
1584 obj
= metadata
.Struct()
1586 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1592 raise ConfigError('unknown string type object property: "{}"'.format(unk_prop
))
1595 if 'min-align' in node
:
1596 min_align
= node
['min-align']
1598 if not _is_int_prop(min_align
):
1599 raise ConfigError('"min-align" property of structure type object must be an integer')
1601 if not _is_valid_alignment(min_align
):
1602 raise ConfigError('invalid minimum alignment: {}'.format(min_align
))
1604 obj
.min_align
= min_align
1607 if 'fields' in node
:
1608 fields
= node
['fields']
1610 if not _is_assoc_array_prop(fields
):
1611 raise ConfigError('"fields" property of structure type object must be an associative array')
1613 for field_name
, field_node
in fields
.items():
1614 if not is_valid_identifier(field_name
):
1615 raise ConfigError('"{}" is not a valid field name for structure type'.format(field_name
))
1618 obj
.fields
[field_name
] = self
._create
_type
(field_node
)
1619 except Exception as e
:
1620 raise ConfigError('cannot create structure type\'s field "{}"'.format(field_name
), e
)
1624 def _create_array(self
, obj
, node
):
1626 # create array object
1627 obj
= metadata
.Array()
1629 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1635 raise ConfigError('unknown array type object property: "{}"'.format(unk_prop
))
1638 if 'length' in node
:
1639 length
= node
['length']
1641 if not _is_int_prop(length
) and not _is_str_prop(length
):
1642 raise ConfigError('"length" property of array type object must be an integer or a string')
1644 if type(length
) is int and length
< 0:
1645 raise ConfigError('invalid static array length: {}'.format(length
))
1650 if 'element-type' in node
:
1652 obj
.element_type
= self
._create
_type
(node
['element-type'])
1653 except Exception as e
:
1654 raise ConfigError('cannot create array type\'s element type', e
)
1658 def _create_variant(self
, obj
, node
):
1660 # create variant object
1661 obj
= metadata
.Variant()
1663 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1669 raise ConfigError('unknown variant type object property: "{}"'.format(unk_prop
))
1675 if not _is_str_prop(tag
):
1676 raise ConfigError('"tag" property of variant type object must be a string')
1678 # do not validate variant tag for the moment; will be done in a
1684 types
= node
['types']
1686 if not _is_assoc_array_prop(types
):
1687 raise ConfigError('"types" property of variant type object must be an associative array')
1689 # do not validate type names for the moment; will be done in a
1691 for type_name
, type_node
in types
.items():
1692 if not is_valid_identifier(type_name
):
1693 raise ConfigError('"{}" is not a valid type name for variant type'.format(type_name
))
1696 obj
.types
[type_name
] = self
._create
_type
(type_node
)
1697 except Exception as e
:
1698 raise ConfigError('cannot create variant type\'s type "{}"'.format(type_name
), e
)
1702 def _create_type(self
, type_node
):
1703 if type(type_node
) is str:
1704 t
= self
._lookup
_type
_alias
(type_node
)
1707 raise ConfigError('unknown type alias "{}"'.format(type_node
))
1711 if not _is_assoc_array_prop(type_node
):
1712 raise ConfigError('type objects must be associative arrays or strings (type alias name)')
1719 if self
._version
>= 200:
1720 if 'inherit' in type_node
:
1721 inherit_prop
= 'inherit'
1722 inherit_node
= type_node
[inherit_prop
]
1724 if self
._version
>= 201:
1725 if '$inherit' in type_node
:
1726 if inherit_node
is not None:
1727 raise ConfigError('cannot specify both "inherit" and "$inherit" properties of type object: prefer "$inherit"')
1729 inherit_prop
= '$inherit'
1730 inherit_node
= type_node
[inherit_prop
]
1732 if inherit_node
is not None and 'class' in type_node
:
1733 raise ConfigError('cannot specify both "{}" and "class" properties in type object'.format(inherit_prop
))
1735 if inherit_node
is not None:
1736 if not _is_str_prop(inherit_node
):
1737 raise ConfigError('"{}" property of type object must be a string'.format(inherit_prop
))
1739 base
= self
._lookup
_type
_alias
(inherit_node
)
1742 raise ConfigError('cannot inherit from type alias "{}": type alias does not exist at this point'.format(inherit_node
))
1744 func
= self
._type
_to
_create
_type
_func
[type(base
)]
1746 if 'class' not in type_node
:
1747 raise ConfigError('type objects which do not inherit must have a "class" property')
1749 class_name
= type_node
['class']
1751 if type(class_name
) is not str:
1752 raise ConfigError('type objects\' "class" property must be a string')
1754 if class_name
not in self
._class
_name
_to
_create
_type
_func
:
1755 raise ConfigError('unknown type class "{}"'.format(class_name
))
1758 func
= self
._class
_name
_to
_create
_type
_func
[class_name
]
1760 return func(base
, type_node
)
1762 def _register_type_aliases(self
, metadata_node
):
1765 if 'type-aliases' not in metadata_node
:
1768 ta_node
= metadata_node
['type-aliases']
1770 if not _is_assoc_array_prop(ta_node
):
1771 raise ConfigError('"type-aliases" property (metadata) must be an associative array')
1773 for ta_name
, ta_type
in ta_node
.items():
1774 if ta_name
in self
._tas
:
1775 raise ConfigError('duplicate type alias "{}"'.format(ta_name
))
1778 t
= self
._create
_type
(ta_type
)
1779 except Exception as e
:
1780 raise ConfigError('cannot create type alias "{}"'.format(ta_name
), e
)
1782 self
._tas
[ta_name
] = t
1784 def _create_clock(self
, node
):
1785 # create clock object
1786 clock
= metadata
.Clock()
1788 if not _is_assoc_array_prop(node
):
1789 raise ConfigError('clock objects must be associative arrays')
1801 if self
._version
>= 201:
1802 known_props
.append('$return-ctype')
1804 unk_prop
= _get_first_unknown_prop(node
, known_props
)
1807 raise ConfigError('unknown clock object property: "{}"'.format(unk_prop
))
1811 uuidp
= node
['uuid']
1813 if not _is_str_prop(uuidp
):
1814 raise ConfigError('"uuid" property of clock object must be a string')
1817 uuidp
= uuid
.UUID(uuidp
)
1819 raise ConfigError('malformed UUID (clock object): "{}"'.format(uuidp
))
1824 if 'description' in node
:
1825 desc
= node
['description']
1827 if not _is_str_prop(desc
):
1828 raise ConfigError('"description" property of clock object must be a string')
1830 clock
.description
= desc
1836 if not _is_int_prop(freq
):
1837 raise ConfigError('"freq" property of clock object must be an integer')
1840 raise ConfigError('invalid clock frequency: {}'.format(freq
))
1845 if 'error-cycles' in node
:
1846 error_cycles
= node
['error-cycles']
1848 if not _is_int_prop(error_cycles
):
1849 raise ConfigError('"error-cycles" property of clock object must be an integer')
1851 if error_cycles
< 0:
1852 raise ConfigError('invalid clock error cycles: {}'.format(error_cycles
))
1854 clock
.error_cycles
= error_cycles
1857 if 'offset' in node
:
1858 offset
= node
['offset']
1860 if not _is_assoc_array_prop(offset
):
1861 raise ConfigError('"offset" property of clock object must be an associative array')
1863 unk_prop
= _get_first_unknown_prop(offset
, ['cycles', 'seconds'])
1866 raise ConfigError('unknown clock object\'s offset property: "{}"'.format(unk_prop
))
1869 if 'cycles' in offset
:
1870 offset_cycles
= offset
['cycles']
1872 if not _is_int_prop(offset_cycles
):
1873 raise ConfigError('"cycles" property of clock object\'s offset property must be an integer')
1875 if offset_cycles
< 0:
1876 raise ConfigError('invalid clock offset cycles: {}'.format(offset_cycles
))
1878 clock
.offset_cycles
= offset_cycles
1881 if 'seconds' in offset
:
1882 offset_seconds
= offset
['seconds']
1884 if not _is_int_prop(offset_seconds
):
1885 raise ConfigError('"seconds" property of clock object\'s offset property must be an integer')
1887 if offset_seconds
< 0:
1888 raise ConfigError('invalid clock offset seconds: {}'.format(offset_seconds
))
1890 clock
.offset_seconds
= offset_seconds
1893 if 'absolute' in node
:
1894 absolute
= node
['absolute']
1896 if not _is_bool_prop(absolute
):
1897 raise ConfigError('"absolute" property of clock object must be a boolean')
1899 clock
.absolute
= absolute
1902 # v2.0: "return-ctype"
1903 # v2.1+: "$return-ctype"
1904 return_ctype_node
= None
1906 if self
._version
>= 200:
1907 if 'return-ctype' in node
:
1908 return_ctype_prop
= 'return-ctype'
1909 return_ctype_node
= node
[return_ctype_prop
]
1911 if self
._version
>= 201:
1912 if '$return-ctype' in node
:
1913 if return_ctype_node
is not None:
1914 raise ConfigError('cannot specify both "return-ctype" and "$return-ctype" properties of clock object: prefer "$return-ctype"')
1916 return_ctype_prop
= '$return-ctype'
1917 return_ctype_node
= node
[return_ctype_prop
]
1919 if return_ctype_node
is not None:
1920 if not _is_str_prop(return_ctype_node
):
1921 raise ConfigError('"{}" property of clock object must be a string'.format(return_ctype_prop
))
1923 clock
.return_ctype
= return_ctype_node
1927 def _register_clocks(self
, metadata_node
):
1928 self
._clocks
= collections
.OrderedDict()
1930 if 'clocks' not in metadata_node
:
1933 clocks_node
= metadata_node
['clocks']
1935 if not _is_assoc_array_prop(clocks_node
):
1936 raise ConfigError('"clocks" property (metadata) must be an associative array')
1938 for clock_name
, clock_node
in clocks_node
.items():
1939 if not is_valid_identifier(clock_name
):
1940 raise ConfigError('invalid clock name: "{}"'.format(clock_name
))
1942 if clock_name
in self
._clocks
:
1943 raise ConfigError('duplicate clock "{}"'.format(clock_name
))
1946 clock
= self
._create
_clock
(clock_node
)
1947 except Exception as e
:
1948 raise ConfigError('cannot create clock "{}"'.format(clock_name
), e
)
1950 clock
.name
= clock_name
1951 self
._clocks
[clock_name
] = clock
1953 def _create_env(self
, metadata_node
):
1954 env
= collections
.OrderedDict()
1956 if 'env' not in metadata_node
:
1959 env_node
= metadata_node
['env']
1961 if not _is_assoc_array_prop(env_node
):
1962 raise ConfigError('"env" property (metadata) must be an associative array')
1964 for env_name
, env_value
in env_node
.items():
1966 raise ConfigError('duplicate environment variable "{}"'.format(env_name
))
1968 if not is_valid_identifier(env_name
):
1969 raise ConfigError('invalid environment variable name: "{}"'.format(env_name
))
1971 if not _is_int_prop(env_value
) and not _is_str_prop(env_value
):
1972 raise ConfigError('invalid environment variable value ("{}"): expecting integer or string'.format(env_name
))
1974 env
[env_name
] = env_value
1978 def _register_log_levels(self
, metadata_node
):
1979 self
._log
_levels
= dict()
1982 # v2.0: "log-levels"
1983 # v2.1+: "$log-levels"
1984 log_levels_node
= None
1986 if self
._version
>= 200:
1987 if 'log-levels' in metadata_node
:
1988 log_levels_prop
= 'log-levels'
1989 log_levels_node
= metadata_node
[log_levels_prop
]
1991 if self
._version
>= 201:
1992 if '$log-levels' in metadata_node
:
1993 if log_levels_node
is not None:
1994 raise ConfigError('cannot specify both "log-levels" and "$log-levels" properties of metadata object: prefer "$log-levels"')
1996 log_levels_prop
= '$log-levels'
1997 log_levels_node
= metadata_node
[log_levels_prop
]
1999 if log_levels_node
is None:
2002 if not _is_assoc_array_prop(log_levels_node
):
2003 raise ConfigError('"{}" property (metadata) must be an associative array'.format(log_levels_prop
))
2005 for ll_name
, ll_value
in log_levels_node
.items():
2006 if ll_name
in self
._log
_levels
:
2007 raise ConfigError('duplicate log level entry "{}"'.format(ll_name
))
2009 if not _is_int_prop(ll_value
):
2010 raise ConfigError('invalid log level entry ("{}"): expecting an integer'.format(ll_name
))
2013 raise ConfigError('invalid log level entry ("{}"): log level value must be positive'.format(ll_name
))
2015 self
._log
_levels
[ll_name
] = ll_value
2017 def _create_trace(self
, metadata_node
):
2018 # create trace object
2019 trace
= metadata
.Trace()
2021 if 'trace' not in metadata_node
:
2022 raise ConfigError('missing "trace" property (metadata)')
2024 trace_node
= metadata_node
['trace']
2026 if not _is_assoc_array_prop(trace_node
):
2027 raise ConfigError('"trace" property (metadata) must be an associative array')
2029 unk_prop
= _get_first_unknown_prop(trace_node
, [
2032 'packet-header-type',
2036 raise ConfigError('unknown trace object property: "{}"'.format(unk_prop
))
2038 # set byte order (already parsed)
2039 trace
.byte_order
= self
._bo
2042 if 'uuid' in trace_node
:
2043 uuidp
= trace_node
['uuid']
2045 if not _is_str_prop(uuidp
):
2046 raise ConfigError('"uuid" property of trace object must be a string')
2049 uuidp
= uuid
.uuid1()
2052 uuidp
= uuid
.UUID(uuidp
)
2054 raise ConfigError('malformed UUID (trace object): "{}"'.format(uuidp
))
2058 # packet header type
2059 if 'packet-header-type' in trace_node
:
2061 ph_type
= self
._create
_type
(trace_node
['packet-header-type'])
2062 except Exception as e
:
2063 raise ConfigError('cannot create packet header type (trace)', e
)
2065 trace
.packet_header_type
= ph_type
2069 def _lookup_log_level(self
, ll
):
2070 if _is_int_prop(ll
):
2072 elif _is_str_prop(ll
) and ll
in self
._log
_levels
:
2073 return self
._log
_levels
[ll
]
2075 def _create_event(self
, event_node
):
2076 event
= metadata
.Event()
2078 if not _is_assoc_array_prop(event_node
):
2079 raise ConfigError('event objects must be associative arrays')
2081 unk_prop
= _get_first_unknown_prop(event_node
, [
2088 raise ConfigError('unknown event object property: "{}"'.format(unk_prop
))
2090 if 'log-level' in event_node
:
2091 ll_node
= event_node
['log-level']
2093 if _is_str_prop(ll_node
):
2094 ll
= self
._lookup
_log
_level
(event_node
['log-level'])
2097 raise ConfigError('cannot find log level "{}"'.format(ll_node
))
2098 elif _is_int_prop(ll_node
):
2100 raise ConfigError('invalid log level value {}: value must be positive'.format(ll_node
))
2104 raise ConfigError('"log-level" property must be either a string or an integer')
2106 event
.log_level
= ll
2108 if 'context-type' in event_node
:
2110 t
= self
._create
_type
(event_node
['context-type'])
2111 except Exception as e
:
2112 raise ConfigError('cannot create event\'s context type object', e
)
2114 event
.context_type
= t
2116 if 'payload-type' not in event_node
:
2117 raise ConfigError('missing "payload-type" property in event object')
2120 t
= self
._create
_type
(event_node
['payload-type'])
2121 except Exception as e
:
2122 raise ConfigError('cannot create event\'s payload type object', e
)
2124 event
.payload_type
= t
2128 def _create_stream(self
, stream_node
):
2129 stream
= metadata
.Stream()
2131 if not _is_assoc_array_prop(stream_node
):
2132 raise ConfigError('stream objects must be associative arrays')
2134 unk_prop
= _get_first_unknown_prop(stream_node
, [
2135 'packet-context-type',
2136 'event-header-type',
2137 'event-context-type',
2142 raise ConfigError('unknown stream object property: "{}"'.format(unk_prop
))
2144 if 'packet-context-type' in stream_node
:
2146 t
= self
._create
_type
(stream_node
['packet-context-type'])
2147 except Exception as e
:
2148 raise ConfigError('cannot create stream\'s packet context type object', e
)
2150 stream
.packet_context_type
= t
2152 if 'event-header-type' in stream_node
:
2154 t
= self
._create
_type
(stream_node
['event-header-type'])
2155 except Exception as e
:
2156 raise ConfigError('cannot create stream\'s event header type object', e
)
2158 stream
.event_header_type
= t
2160 if 'event-context-type' in stream_node
:
2162 t
= self
._create
_type
(stream_node
['event-context-type'])
2163 except Exception as e
:
2164 raise ConfigError('cannot create stream\'s event context type object', e
)
2166 stream
.event_context_type
= t
2168 if 'events' not in stream_node
:
2169 raise ConfigError('missing "events" property in stream object')
2171 events
= stream_node
['events']
2173 if not _is_assoc_array_prop(events
):
2174 raise ConfigError('"events" property of stream object must be an associative array')
2177 raise ConfigError('at least one event is needed within a stream object')
2181 for ev_name
, ev_node
in events
.items():
2183 ev
= self
._create
_event
(ev_node
)
2184 except Exception as e
:
2185 raise ConfigError('cannot create event "{}"'.format(ev_name
), e
)
2189 stream
.events
[ev_name
] = ev
2194 def _create_streams(self
, metadata_node
):
2195 streams
= collections
.OrderedDict()
2197 if 'streams' not in metadata_node
:
2198 raise ConfigError('missing "streams" property (metadata)')
2200 streams_node
= metadata_node
['streams']
2202 if not _is_assoc_array_prop(streams_node
):
2203 raise ConfigError('"streams" property (metadata) must be an associative array')
2205 if not streams_node
:
2206 raise ConfigError('at least one stream is needed (metadata)')
2210 for stream_name
, stream_node
in streams_node
.items():
2212 stream
= self
._create
_stream
(stream_node
)
2213 except Exception as e
:
2214 raise ConfigError('cannot create stream "{}"'.format(stream_name
), e
)
2217 stream
.name
= str(stream_name
)
2218 streams
[stream_name
] = stream
2223 def _create_metadata(self
, root
):
2224 meta
= metadata
.Metadata()
2226 if 'metadata' not in root
:
2227 raise ConfigError('missing "metadata" property (configuration)')
2229 metadata_node
= root
['metadata']
2231 if not _is_assoc_array_prop(metadata_node
):
2232 raise ConfigError('"metadata" property (configuration) must be an associative array')
2243 if self
._version
>= 201:
2244 known_props
.append('$log-levels')
2246 unk_prop
= _get_first_unknown_prop(metadata_node
, known_props
)
2251 if unk_prop
== '$include':
2252 add
= ' (use version 2.1 or greater)'
2254 raise ConfigError('unknown metadata property{}: "{}"'.format(add
, unk_prop
))
2256 self
._set
_byte
_order
(metadata_node
)
2257 self
._register
_clocks
(metadata_node
)
2258 meta
.clocks
= self
._clocks
2259 self
._register
_type
_aliases
(metadata_node
)
2260 meta
.env
= self
._create
_env
(metadata_node
)
2261 meta
.trace
= self
._create
_trace
(metadata_node
)
2262 self
._register
_log
_levels
(metadata_node
)
2263 meta
.streams
= self
._create
_streams
(metadata_node
)
2267 def _get_version(self
, root
):
2268 if 'version' not in root
:
2269 raise ConfigError('missing "version" property (configuration)')
2271 version_node
= root
['version']
2273 if not _is_str_prop(version_node
):
2274 raise ConfigError('"version" property (configuration) must be a string')
2276 version_node
= version_node
.strip()
2278 if version_node
not in ['2.0', '2.1']:
2279 raise ConfigError('unsupported version ({}): versions 2.0 and 2.1 are supported'.format(version_node
))
2281 # convert version string to comparable version integer
2282 parts
= version_node
.split('.')
2283 version
= int(parts
[0]) * 100 + int(parts
[1])
2287 def _get_prefix(self
, root
):
2288 if 'prefix' not in root
:
2291 prefix_node
= root
['prefix']
2293 if not _is_str_prop(prefix_node
):
2294 raise ConfigError('"prefix" property (configuration) must be a string')
2296 if not is_valid_identifier(prefix_node
):
2297 raise ConfigError('"prefix" property (configuration) must be a valid C identifier')
2301 def _get_last_include_file(self
):
2302 if self
._include
_stack
:
2303 return self
._include
_stack
[-1]
2305 return self
._root
_yaml
_path
2307 def _load_include(self
, yaml_path
):
2308 for inc_dir
in self
._include
_dirs
:
2309 # current include dir + file name path
2310 # note: os.path.join() only takes the last arg if it's absolute
2311 inc_path
= os
.path
.join(inc_dir
, yaml_path
)
2313 # real path (symbolic links resolved)
2314 real_path
= os
.path
.realpath(inc_path
)
2316 # normalized path (weird stuff removed!)
2317 norm_path
= os
.path
.normpath(real_path
)
2319 if not os
.path
.isfile(norm_path
):
2320 # file does not exist: skip
2323 if norm_path
in self
._include
_stack
:
2324 base_path
= self
._get
_last
_include
_file
()
2325 raise ConfigError('in "{}": cannot recursively include file "{}"'.format(base_path
, norm_path
))
2327 self
._include
_stack
.append(norm_path
)
2330 return self
._yaml
_ordered
_load
(norm_path
)
2332 if not self
._ignore
_include
_not
_found
:
2333 base_path
= self
._get
_last
_include
_file
()
2334 raise ConfigError('in "{}": cannot include file "{}": file not found in include directories'.format(base_path
, yaml_path
))
2338 def _get_include_paths(self
, include_node
):
2339 if _is_str_prop(include_node
):
2340 return [include_node
]
2341 elif _is_array_prop(include_node
):
2342 for include_path
in include_node
:
2343 if not _is_str_prop(include_path
):
2344 raise ConfigError('invalid include property: expecting array of strings')
2348 raise ConfigError('invalid include property: expecting string or array of strings')
2350 def _update_node(self
, base_node
, overlay_node
):
2351 for olay_key
, olay_value
in overlay_node
.items():
2352 if olay_key
in base_node
:
2353 base_value
= base_node
[olay_key
]
2355 if _is_assoc_array_prop(olay_value
) and _is_assoc_array_prop(base_value
):
2356 # merge dictionaries
2357 self
._update
_node
(base_value
, olay_value
)
2358 elif _is_array_prop(olay_value
) and _is_array_prop(base_value
):
2359 # append extension array items to base items
2360 base_value
+= olay_value
2362 # fall back to replacing
2363 base_node
[olay_key
] = olay_value
2365 base_node
[olay_key
] = olay_value
2367 def _process_node_include(self
, last_overlay_node
, name
,
2368 process_base_include_cb
,
2369 process_children_include_cb
=None):
2370 if not _is_assoc_array_prop(last_overlay_node
):
2371 raise ConfigError('{} objects must be associative arrays'.format(name
))
2373 # process children inclusions first
2374 if process_children_include_cb
:
2375 process_children_include_cb(last_overlay_node
)
2377 if '$include' in last_overlay_node
:
2378 include_node
= last_overlay_node
['$include']
2381 return last_overlay_node
2383 include_paths
= self
._get
_include
_paths
(include_node
)
2384 cur_base_path
= self
._get
_last
_include
_file
()
2387 # keep the include paths and remove the include property
2388 include_paths
= copy
.deepcopy(include_paths
)
2389 del last_overlay_node
['$include']
2391 for include_path
in include_paths
:
2392 # load raw YAML from included file
2393 overlay_node
= self
._load
_include
(include_path
)
2395 if overlay_node
is None:
2396 # cannot find include file, but we're ignoring those
2397 # errors, otherwise _load_include() itself raises
2401 # recursively process includes
2403 overlay_node
= process_base_include_cb(overlay_node
)
2404 except Exception as e
:
2405 raise ConfigError('in "{}"'.format(cur_base_path
), e
)
2407 # pop include stack now that we're done including
2408 del self
._include
_stack
[-1]
2410 # at this point, base_node is fully resolved (does not
2411 # contain any include property)
2412 if base_node
is None:
2413 base_node
= overlay_node
2415 self
._update
_node
(base_node
, overlay_node
)
2417 # finally, we update the latest base node with our last overlay
2419 if base_node
is None:
2420 # nothing was included, which is possible when we're
2421 # ignoring include errors
2422 return last_overlay_node
2424 self
._update
_node
(base_node
, last_overlay_node
)
2428 def _process_event_include(self
, event_node
):
2429 return self
._process
_node
_include
(event_node
, 'event',
2430 self
._process
_event
_include
)
2432 def _process_stream_include(self
, stream_node
):
2433 def process_children_include(stream_node
):
2434 if 'events' in stream_node
:
2435 events_node
= stream_node
['events']
2437 if not _is_assoc_array_prop(events_node
):
2438 raise ConfigError('"events" property must be an associative array')
2440 events_node_keys
= list(events_node
.keys())
2442 for key
in events_node_keys
:
2443 event_node
= events_node
[key
]
2446 events_node
[key
] = self
._process
_event
_include
(event_node
)
2447 except Exception as e
:
2448 raise ConfigError('cannot process includes of event object "{}"'.format(key
), e
)
2450 return self
._process
_node
_include
(stream_node
, 'stream',
2451 self
._process
_stream
_include
,
2452 process_children_include
)
2454 def _process_trace_include(self
, trace_node
):
2455 return self
._process
_node
_include
(trace_node
, 'trace',
2456 self
._process
_trace
_include
)
2458 def _process_clock_include(self
, clock_node
):
2459 return self
._process
_node
_include
(clock_node
, 'clock',
2460 self
._process
_clock
_include
)
2462 def _process_metadata_include(self
, metadata_node
):
2463 def process_children_include(metadata_node
):
2464 if 'trace' in metadata_node
:
2465 metadata_node
['trace'] = self
._process
_trace
_include
(metadata_node
['trace'])
2467 if 'clocks' in metadata_node
:
2468 clocks_node
= metadata_node
['clocks']
2470 if not _is_assoc_array_prop(clocks_node
):
2471 raise ConfigError('"clocks" property (metadata) must be an associative array')
2473 clocks_node_keys
= list(clocks_node
.keys())
2475 for key
in clocks_node_keys
:
2476 clock_node
= clocks_node
[key
]
2479 clocks_node
[key
] = self
._process
_clock
_include
(clock_node
)
2480 except Exception as e
:
2481 raise ConfigError('cannot process includes of clock object "{}"'.format(key
), e
)
2483 if 'streams' in metadata_node
:
2484 streams_node
= metadata_node
['streams']
2486 if not _is_assoc_array_prop(streams_node
):
2487 raise ConfigError('"streams" property (metadata) must be an associative array')
2489 streams_node_keys
= list(streams_node
.keys())
2491 for key
in streams_node_keys
:
2492 stream_node
= streams_node
[key
]
2495 streams_node
[key
] = self
._process
_stream
_include
(stream_node
)
2496 except Exception as e
:
2497 raise ConfigError('cannot process includes of stream object "{}"'.format(key
), e
)
2499 return self
._process
_node
_include
(metadata_node
, 'metadata',
2500 self
._process
_metadata
_include
,
2501 process_children_include
)
2503 def _process_root_includes(self
, root
):
2504 # The following config objects support includes:
2511 # We need to process the event includes first, then the stream
2512 # includes, then the trace includes, and finally the metadata
2515 # In each object, only one of the $include and $include-replace
2516 # special properties is allowed.
2518 # We keep a stack of absolute paths to included files to detect
2520 if 'metadata' in root
:
2521 root
['metadata'] = self
._process
_metadata
_include
(root
['metadata'])
2525 def _yaml_ordered_dump(self
, node
, **kwds
):
2526 class ODumper(yaml
.Dumper
):
2529 def dict_representer(dumper
, node
):
2530 return dumper
.represent_mapping(yaml
.resolver
.BaseResolver
.DEFAULT_MAPPING_TAG
,
2533 ODumper
.add_representer(collections
.OrderedDict
, dict_representer
)
2535 return yaml
.dump(node
, Dumper
=ODumper
, **kwds
)
2537 def _yaml_ordered_load(self
, yaml_path
):
2538 class OLoader(yaml
.Loader
):
2541 def construct_mapping(loader
, node
):
2542 loader
.flatten_mapping(node
)
2544 return collections
.OrderedDict(loader
.construct_pairs(node
))
2546 OLoader
.add_constructor(yaml
.resolver
.BaseResolver
.DEFAULT_MAPPING_TAG
,
2551 with
open(yaml_path
, 'r') as f
:
2552 node
= yaml
.load(f
, OLoader
)
2553 except (OSError, IOError) as e
:
2554 raise ConfigError('cannot open file "{}"'.format(yaml_path
))
2555 except Exception as e
:
2556 raise ConfigError('unknown error while trying to load file "{}"'.format(yaml_path
), e
)
2558 # loaded node must be an associate array
2559 if not _is_assoc_array_prop(node
):
2560 raise ConfigError('root of YAML file "{}" must be an associative array'.format(yaml_path
))
2565 self
._version
= None
2566 self
._include
_stack
= []
2568 def parse(self
, yaml_path
):
2570 self
._root
_yaml
_path
= yaml_path
2573 root
= self
._yaml
_ordered
_load
(yaml_path
)
2574 except Exception as e
:
2575 raise ConfigError('cannot parse YAML file "{}"'.format(yaml_path
), e
)
2577 if not _is_assoc_array_prop(root
):
2578 raise ConfigError('configuration must be an associative array')
2580 unk_prop
= _get_first_unknown_prop(root
, [
2587 raise ConfigError('unknown configuration property: "{}"'.format(unk_prop
))
2589 # get the config version
2590 self
._version
= self
._get
_version
(root
)
2592 # process includes if supported
2593 if self
._version
>= 201:
2594 root
= self
._process
_root
_includes
(root
)
2596 # dump config if required
2597 if self
._dump
_config
:
2598 print(self
._yaml
_ordered
_dump
(root
, indent
=2,
2599 default_flow_style
=False))
2601 # get prefix and metadata
2602 prefix
= self
._get
_prefix
(root
)
2603 meta
= self
._create
_metadata
(root
)
2605 return Config(self
._version
, prefix
, meta
)
2608 def from_yaml_file(path
, include_dirs
, ignore_include_not_found
, dump_config
):
2610 parser
= _YamlConfigParser(include_dirs
, ignore_include_not_found
,
2612 cfg
= parser
.parse(path
)
2615 except Exception as e
:
2616 raise ConfigError('cannot create configuration from YAML file "{}"'.format(path
), e
)