1 # The MIT License (MIT)
3 # Copyright (c) 2015 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')
366 elif field_name
== 'uuid':
367 if self
._meta
.trace
.uuid
is None:
368 raise ConfigError('"uuid" field in trace packet header type specified, but no trace UUID provided')
370 if type(field_type
) is not metadata
.Array
:
371 raise ConfigError('"uuid" field in trace packet header type must be an array')
373 if field_type
.length
!= 16:
374 raise ConfigError('"uuid" field in trace packet header type must be an array of 16 bytes')
376 element_type
= field_type
.element_type
378 if type(element_type
) is not metadata
.Integer
:
379 raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned bytes')
381 if element_type
.size
!= 8:
382 raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned bytes')
384 if element_type
.signed
:
385 raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned bytes')
387 if element_type
.align
!= 8:
388 raise ConfigError('"uuid" field in trace packet header type must be an array of 16 unsigned, byte-aligned bytes')
390 def _validate_trace(self
, meta
):
391 self
._validate
_trace
_packet
_header
_type
(meta
.trace
.packet_header_type
)
393 def _validate_stream_packet_context(self
, stream
):
394 t
= stream
.packet_context_type
399 if type(t
) is not metadata
.Struct
:
402 # "timestamp_begin", if exists, is an unsigned integer type,
404 if 'timestamp_begin' in t
.fields
:
405 ts_begin
= t
.fields
['timestamp_begin']
407 if type(ts_begin
) is not metadata
.Integer
:
408 raise ConfigError('"timestamp_begin" field in stream packet context type must be an integer type')
411 raise ConfigError('"timestamp_begin" field in stream packet context type must be an unsigned integer type')
413 if not ts_begin
.property_mappings
:
414 raise ConfigError('"timestamp_begin" field in stream packet context type must be mapped to a clock')
416 # "timestamp_end", if exists, is an unsigned integer type,
418 if 'timestamp_end' in t
.fields
:
419 ts_end
= t
.fields
['timestamp_end']
421 if type(ts_end
) is not metadata
.Integer
:
422 raise ConfigError('"timestamp_end" field in stream packet context type must be an integer type')
425 raise ConfigError('"timestamp_end" field in stream packet context type must be an unsigned integer type')
427 if not ts_end
.property_mappings
:
428 raise ConfigError('"timestamp_end" field in stream packet context type must be mapped to a clock')
430 # "timestamp_begin" and "timestamp_end" exist together
431 if (('timestamp_begin' in t
.fields
) ^
('timestamp_end' in t
.fields
)):
432 raise ConfigError('"timestamp_begin" and "timestamp_end" fields must be defined together in stream packet context type')
434 # "events_discarded", if exists, is an unsigned integer type
435 if 'events_discarded' in t
.fields
:
436 events_discarded
= t
.fields
['events_discarded']
438 if type(events_discarded
) is not metadata
.Integer
:
439 raise ConfigError('"events_discarded" field in stream packet context type must be an integer type')
441 if events_discarded
.signed
:
442 raise ConfigError('"events_discarded" field in stream packet context type must be an unsigned integer type')
444 # "packet_size" and "content_size" must exist
445 if 'packet_size' not in t
.fields
:
446 raise ConfigError('missing "packet_size" field in stream packet context type')
448 packet_size
= t
.fields
['packet_size']
450 # "content_size" and "content_size" must exist
451 if 'content_size' not in t
.fields
:
452 raise ConfigError('missing "content_size" field in stream packet context type')
454 content_size
= t
.fields
['content_size']
456 # "packet_size" is an unsigned integer type
457 if type(packet_size
) is not metadata
.Integer
:
458 raise ConfigError('"packet_size" field in stream packet context type must be an integer type')
460 if packet_size
.signed
:
461 raise ConfigError('"packet_size" field in stream packet context type must be an unsigned integer type')
463 # "content_size" is an unsigned integer type
464 if type(content_size
) is not metadata
.Integer
:
465 raise ConfigError('"content_size" field in stream packet context type must be an integer type')
467 if content_size
.signed
:
468 raise ConfigError('"content_size" field in stream packet context type must be an unsigned integer type')
470 def _validate_stream_event_header(self
, stream
):
471 t
= stream
.event_header_type
474 if len(stream
.events
) > 1:
477 raise ConfigError('need "id" field in stream event header type, but stream event header type is missing')
479 if type(t
) is not metadata
.Struct
:
480 raise ConfigError('need "id" field in stream event header type, but stream event header type is not a structure type')
482 if 'id' not in t
.fields
:
483 raise ConfigError('need "id" field in stream event header type')
485 # validate "id" and "timestamp" types
486 if type(t
) is not metadata
.Struct
:
489 # "timestamp", if exists, is an unsigned integer type,
491 if 'timestamp' in t
.fields
:
492 ts
= t
.fields
['timestamp']
494 if type(ts
) is not metadata
.Integer
:
495 raise ConfigError('"ts" field in stream event header type must be an integer type')
498 raise ConfigError('"ts" field in stream event header type must be an unsigned integer type')
500 if not ts
.property_mappings
:
501 raise ConfigError('"ts" field in stream event header type must be mapped to a clock')
503 # "id" is an unsigned integer type
507 if type(eid
) is not metadata
.Integer
:
508 raise ConfigError('"id" field in stream event header type must be an integer type')
511 raise ConfigError('"id" field in stream event header type must be an unsigned integer type')
513 def _validate_stream(self
, stream
):
514 self
._validate
_stream
_packet
_context
(stream
)
515 self
._validate
_stream
_event
_header
(stream
)
517 def validate(self
, meta
):
519 self
._validate
_trace
(meta
)
521 for stream
in meta
.streams
.values():
523 self
._validate
_stream
(stream
)
524 except Exception as e
:
525 raise ConfigError('invalid stream "{}"'.format(stream
.name
), e
)
528 class _MetadataDynamicTypesValidatorStackEntry
:
529 def __init__(self
, base_t
):
530 self
._base
_t
= base_t
538 def index(self
, value
):
546 def base_t(self
, value
):
550 # Entities. Order of values is important here.
552 class _Entity(enum
.IntEnum
):
553 TRACE_PACKET_HEADER
= 0
554 STREAM_PACKET_CONTEXT
= 1
555 STREAM_EVENT_HEADER
= 2
556 STREAM_EVENT_CONTEXT
= 3
561 # This validator validates dynamic metadata types, that is, it ensures
562 # variable-length array lengths and variant tags actually point to
563 # something that exists. It also checks that variable-length array
564 # lengths point to integer types and variant tags to enumeration types.
565 class _MetadataDynamicTypesValidator
:
567 self
._type
_to
_visit
_type
_func
= {
568 metadata
.Integer
: None,
569 metadata
.FloatingPoint
: None,
571 metadata
.String
: None,
572 metadata
.Struct
: self
._visit
_struct
_type
,
573 metadata
.Array
: self
._visit
_array
_type
,
574 metadata
.Variant
: self
._visit
_variant
_type
,
577 self
._cur
_trace
= None
578 self
._cur
_stream
= None
579 self
._cur
_event
= None
581 def _lookup_path_from_base(self
, path
, parts
, base
, start_index
,
582 base_is_current
, from_t
):
587 while index
< len(parts
):
591 if type(cur_t
) is metadata
.Struct
:
592 enumerated_items
= enumerate(cur_t
.fields
.items())
595 for i
, (field_name
, field_type
) in enumerated_items
:
596 if field_name
== part
:
598 found_path
.append((i
, field_type
))
601 raise ConfigError('invalid path "{}": cannot find field "{}" in structure type'.format(path
, part
))
602 elif type(cur_t
) is metadata
.Variant
:
603 enumerated_items
= enumerate(cur_t
.types
.items())
606 for i
, (type_name
, type_type
) in enumerated_items
:
607 if type_name
== part
:
609 found_path
.append((i
, type_type
))
612 raise ConfigError('invalid path "{}": cannot find type "{}" in variant type'.format(path
, part
))
614 raise ConfigError('invalid path "{}": requesting "{}" in a non-variant, non-structure type'.format(path
, part
))
619 # make sure that the pointed type is not the pointing type
621 raise ConfigError('invalid path "{}": pointing to self'.format(path
))
623 # if we're here, we found the type; however, it could be located
624 # _after_ the variant/VLA looking for it, if the pointing
625 # and pointed types are in the same entity, so compare the
626 # current stack entries indexes to our index path in that case
627 if not base_is_current
:
630 for index
, entry
in enumerate(self
._stack
):
631 if index
== len(found_path
):
632 # end of index path; valid so far
635 if found_path
[index
][0] > entry
.index
:
636 raise ConfigError('invalid path "{}": pointed type is after pointing type'.format(path
))
638 # also make sure that both pointed and pointing types share
639 # a common structure ancestor
640 for index
, entry
in enumerate(self
._stack
):
641 if index
== len(found_path
):
644 if entry
.base_t
is not found_path
[index
][1]:
645 # found common ancestor
646 if type(entry
.base_t
) is metadata
.Variant
:
647 raise ConfigError('invalid path "{}": type cannot be reached because pointed and pointing types are in the same variant type'.format(path
))
651 def _lookup_path_from_top(self
, path
, parts
):
653 raise ConfigError('invalid path "{}": multipart relative path not supported'.format(path
))
656 index
= len(self
._stack
) - 1
659 # check stack entries in reversed order
660 for entry
in reversed(self
._stack
):
661 # structure base type
662 if type(entry
.base_t
) is metadata
.Struct
:
664 enumerated_items
= enumerate(entry
.base_t
.fields
.items())
666 # lookup each field, until the current visiting index is met
667 for i
, (field_name
, field_type
) in enumerated_items
:
671 if field_name
== find_name
:
675 elif type(entry
.base_t
) is metadata
.Variant
:
676 enumerated_items
= enumerate(entry
.base_t
.types
.items())
678 # lookup each type, until the current visiting index is met
679 for i
, (type_name
, type_type
) in enumerated_items
:
683 if type_name
== find_name
:
685 raise ConfigError('invalid path "{}": type cannot be reached because pointed and pointing types are in the same variant type'.format(path
))
689 # nothing returned here: cannot find type
690 raise ConfigError('invalid path "{}": cannot find type in current context'.format(path
))
692 def _lookup_path(self
, path
, from_t
):
693 parts
= path
.lower().split('.')
695 base_is_current
= False
698 if parts
[0] == 'trace':
699 if parts
[1] == 'packet' and parts
[2] == 'header':
700 # make sure packet header exists
701 if self
._cur
_trace
.packet_header_type
is None:
702 raise ConfigError('invalid path "{}": no defined trace packet header type'.format(path
))
704 base
= self
._cur
_trace
.packet_header_type
706 if self
._cur
_entity
== _Entity
.TRACE_PACKET_HEADER
:
707 base_is_current
= True
709 raise ConfigError('invalid path "{}": unknown names after "trace"'.format(path
))
710 elif parts
[0] == 'stream':
711 if parts
[1] == 'packet' and parts
[2] == 'context':
712 if self
._cur
_entity
< _Entity
.STREAM_PACKET_CONTEXT
:
713 raise ConfigError('invalid path "{}": cannot access stream packet context here'.format(path
))
715 if self
._cur
_stream
.packet_context_type
is None:
716 raise ConfigError('invalid path "{}": no defined stream packet context type'.format(path
))
718 base
= self
._cur
_stream
.packet_context_type
720 if self
._cur
_entity
== _Entity
.STREAM_PACKET_CONTEXT
:
721 base_is_current
= True
722 elif parts
[1] == 'event':
723 if parts
[2] == 'header':
724 if self
._cur
_entity
< _Entity
.STREAM_EVENT_HEADER
:
725 raise ConfigError('invalid path "{}": cannot access stream event header here'.format(path
))
727 if self
._cur
_stream
.event_header_type
is None:
728 raise ConfigError('invalid path "{}": no defined stream event header type'.format(path
))
730 base
= self
._cur
_stream
.event_header_type
732 if self
._cur
_entity
== _Entity
.STREAM_EVENT_HEADER
:
733 base_is_current
= True
734 elif parts
[2] == 'context':
735 if self
._cur
_entity
< _Entity
.STREAM_EVENT_CONTEXT
:
736 raise ConfigError('invalid path "{}": cannot access stream event context here'.format(path
))
738 if self
._cur
_stream
.event_context_type
is None:
739 raise ConfigError('invalid path "{}": no defined stream event context type'.format(path
))
741 base
= self
._cur
_stream
.event_context_type
743 if self
._cur
_entity
== _Entity
.STREAM_EVENT_CONTEXT
:
744 base_is_current
= True
746 raise ConfigError('invalid path "{}": unknown names after "stream.event"'.format(path
))
748 raise ConfigError('invalid path "{}": unknown names after "stream"'.format(path
))
753 if len(parts
) >= 2 and base
is None:
754 if parts
[0] == 'event':
755 if parts
[1] == 'context':
756 if self
._cur
_entity
< _Entity
.EVENT_CONTEXT
:
757 raise ConfigError('invalid path "{}": cannot access event context here'.format(path
))
759 if self
._cur
_event
.context_type
is None:
760 raise ConfigError('invalid path "{}": no defined event context type'.format(path
))
762 base
= self
._cur
_event
.context_type
764 if self
._cur
_entity
== _Entity
.EVENT_CONTEXT
:
765 base_is_current
= True
766 elif parts
[1] == 'payload' or parts
[1] == 'fields':
767 if self
._cur
_entity
< _Entity
.EVENT_PAYLOAD
:
768 raise ConfigError('invalid path "{}": cannot access event payload here'.format(path
))
770 if self
._cur
_event
.payload_type
is None:
771 raise ConfigError('invalid path "{}": no defined event payload type'.format(path
))
773 base
= self
._cur
_event
.payload_type
775 if self
._cur
_entity
== _Entity
.EVENT_PAYLOAD
:
776 base_is_current
= True
778 raise ConfigError('invalid path "{}": unknown names after "event"'.format(path
))
784 return self
._lookup
_path
_from
_base
(path
, parts
, base
, start_index
,
785 base_is_current
, from_t
)
787 return self
._lookup
_path
_from
_top
(path
, parts
)
789 def _stack_reset(self
):
792 def _stack_push(self
, base_t
):
793 entry
= _MetadataDynamicTypesValidatorStackEntry(base_t
)
794 self
._stack
.append(entry
)
796 def _stack_pop(self
):
799 def _stack_incr_index(self
):
800 self
._stack
[-1].index
+= 1
802 def _visit_struct_type(self
, t
):
805 for field_name
, field_type
in t
.fields
.items():
807 self
._visit
_type
(field_type
)
808 except Exception as e
:
809 raise ConfigError('in structure type\'s field "{}"'.format(field_name
), e
)
811 self
._stack
_incr
_index
()
815 def _visit_array_type(self
, t
):
819 length_type
= self
._lookup
_path
(t
.length
, t
)
820 except Exception as e
:
821 raise ConfigError('invalid array type\'s length', e
)
823 # make sure length type an unsigned integer
824 if type(length_type
) is not metadata
.Integer
:
825 raise ConfigError('array type\'s length does not point to an integer type')
827 if length_type
.signed
:
828 raise ConfigError('array type\'s length does not point to an unsigned integer type')
830 self
._visit
_type
(t
.element_type
)
832 def _visit_variant_type(self
, t
):
835 tag_type
= self
._lookup
_path
(t
.tag
, t
)
836 except Exception as e
:
837 raise ConfigError('invalid variant type\'s tag', e
)
839 # make sure tag type is an enumeration
840 if type(tag_type
) is not metadata
.Enum
:
841 raise ConfigError('variant type\'s tag does not point to an enumeration type')
843 # verify that each variant type's type exists as an enumeration member
844 for tag_name
in t
.types
.keys():
845 if tag_name
not in tag_type
.members
:
846 raise ConfigError('cannot find variant type\'s type "{}" in pointed tag type'.format(tag_name
))
850 for type_name
, type_type
in t
.types
.items():
852 self
._visit
_type
(type_type
)
853 except Exception as e
:
854 raise ConfigError('in variant type\'s type "{}"'.format(type_name
), e
)
856 self
._stack
_incr
_index
()
860 def _visit_type(self
, t
):
864 if type(t
) in self
._type
_to
_visit
_type
_func
:
865 func
= self
._type
_to
_visit
_type
_func
[type(t
)]
870 def _visit_event(self
, ev
):
876 # visit event context type
878 self
._cur
_entity
= _Entity
.EVENT_CONTEXT
881 self
._visit
_type
(ev
.context_type
)
882 except Exception as e
:
883 raise ConfigError('invalid context type in event "{}"'.format(ev_name
), e
)
885 # visit event payload type
887 self
._cur
_entity
= _Entity
.EVENT_PAYLOAD
890 self
._visit
_type
(ev
.payload_type
)
891 except Exception as e
:
892 raise ConfigError('invalid payload type in event "{}"'.format(ev_name
), e
)
894 def _visit_stream(self
, stream
):
895 stream_name
= stream
.name
898 self
._cur
_stream
= stream
900 # reset current event
901 self
._cur
_event
= None
903 # visit stream packet context type
905 self
._cur
_entity
= _Entity
.STREAM_PACKET_CONTEXT
908 self
._visit
_type
(stream
.packet_context_type
)
909 except Exception as e
:
910 raise ConfigError('invalid packet context type in stream "{}"'.format(stream_name
), e
)
912 # visit stream event header type
914 self
._cur
_entity
= _Entity
.STREAM_EVENT_HEADER
917 self
._visit
_type
(stream
.event_header_type
)
918 except Exception as e
:
919 raise ConfigError('invalid event header type in stream "{}"'.format(stream_name
), e
)
921 # visit stream event context type
923 self
._cur
_entity
= _Entity
.STREAM_EVENT_CONTEXT
926 self
._visit
_type
(stream
.event_context_type
)
927 except Exception as e
:
928 raise ConfigError('invalid event context type in stream "{}"'.format(stream_name
), e
)
931 for ev
in stream
.events
.values():
933 self
._visit
_event
(ev
)
934 except Exception as e
:
935 raise ConfigError('invalid stream "{}"'.format(stream_name
))
937 def validate(self
, meta
):
939 self
._cur
_trace
= meta
.trace
941 # visit trace packet header type
943 self
._cur
_entity
= _Entity
.TRACE_PACKET_HEADER
946 self
._visit
_type
(meta
.trace
.packet_header_type
)
947 except Exception as e
:
948 raise ConfigError('invalid packet header type in trace', e
)
951 for stream
in meta
.streams
.values():
952 self
._visit
_stream
(stream
)
955 # Since type inheritance allows types to be only partially defined at
956 # any place in the configuration, this validator validates that actual
957 # trace, stream, and event types are all complete and valid.
958 class _MetadataTypesHistologyValidator
:
960 self
._type
_to
_validate
_type
_histology
_func
= {
961 metadata
.Integer
: self
._validate
_integer
_histology
,
962 metadata
.FloatingPoint
: self
._validate
_float
_histology
,
963 metadata
.Enum
: self
._validate
_enum
_histology
,
964 metadata
.String
: self
._validate
_string
_histology
,
965 metadata
.Struct
: self
._validate
_struct
_histology
,
966 metadata
.Array
: self
._validate
_array
_histology
,
967 metadata
.Variant
: self
._validate
_variant
_histology
,
970 def _validate_integer_histology(self
, t
):
973 raise ConfigError('missing integer type\'s size')
975 def _validate_float_histology(self
, t
):
976 # exponent digits is set
977 if t
.exp_size
is None:
978 raise ConfigError('missing floating point number type\'s exponent size')
980 # mantissa digits is set
981 if t
.mant_size
is None:
982 raise ConfigError('missing floating point number type\'s mantissa size')
984 # exponent and mantissa sum is a multiple of 8
985 if (t
.exp_size
+ t
.mant_size
) % 8 != 0:
986 raise ConfigError('floating point number type\'s mantissa and exponent sizes sum must be a multiple of 8')
988 def _validate_enum_histology(self
, t
):
989 # integer type is set
990 if t
.value_type
is None:
991 raise ConfigError('missing enumeration type\'s value type')
993 # there's at least one member
995 raise ConfigError('enumeration type needs at least one member')
997 # no overlapping values and all values are valid considering
1001 if t
.value_type
.signed
:
1002 value_min
= -(1 << t
.value_type
.size
- 1)
1003 value_max
= (1 << (t
.value_type
.size
- 1)) - 1
1006 value_max
= (1 << t
.value_type
.size
) - 1
1008 for label
, value
in t
.members
.items():
1010 if value
[0] <= rg
[1] and rg
[0] <= value
[1]:
1011 raise ConfigError('enumeration type\'s member "{}" overlaps another member'.format(label
))
1013 fmt
= 'enumeration type\'s member "{}": value {} is outside the value type range [{}, {}]'
1015 if value
[0] < value_min
or value
[0] > value_max
:
1016 raise ConfigError(fmt
.format(label
, value
[0], value_min
, value_max
))
1018 if value
[1] < value_min
or value
[1] > value_max
:
1019 raise ConfigError(fmt
.format(label
, value
[1], value_min
, value_max
))
1021 ranges
.append(value
)
1023 def _validate_string_histology(self
, t
):
1027 def _validate_struct_histology(self
, t
):
1028 # all fields are valid
1029 for field_name
, field_type
in t
.fields
.items():
1031 self
._validate
_type
_histology
(field_type
)
1032 except Exception as e
:
1033 raise ConfigError('invalid structure type\'s field "{}"'.format(field_name
), e
)
1035 def _validate_array_histology(self
, t
):
1037 if t
.length
is None:
1038 raise ConfigError('missing array type\'s length')
1040 # element type is set
1041 if t
.element_type
is None:
1042 raise ConfigError('missing array type\'s element type')
1044 # element type is valid
1046 self
._validate
_type
_histology
(t
.element_type
)
1047 except Exception as e
:
1048 raise ConfigError('invalid array type\'s element type', e
)
1050 def _validate_variant_histology(self
, t
):
1053 raise ConfigError('missing variant type\'s tag')
1055 # there's at least one type
1057 raise ConfigError('variant type needs at least one type')
1059 # all types are valid
1060 for type_name
, type_t
in t
.types
.items():
1062 self
._validate
_type
_histology
(type_t
)
1063 except Exception as e
:
1064 raise ConfigError('invalid variant type\'s type "{}"'.format(type_name
), e
)
1066 def _validate_type_histology(self
, t
):
1070 self
._type
_to
_validate
_type
_histology
_func
[type(t
)](t
)
1072 def _validate_entity_type_histology(self
, t
):
1076 # entity cannot be an array
1077 if type(t
) is metadata
.Array
:
1078 raise ConfigError('cannot use an array here')
1080 self
._validate
_type
_histology
(t
)
1082 def _validate_event_types_histology(self
, ev
):
1085 # validate event context type
1087 self
._validate
_entity
_type
_histology
(ev
.context_type
)
1088 except Exception as e
:
1089 raise ConfigError('invalid event context type for event "{}"'.format(ev_name
), e
)
1091 # validate event payload type
1092 if ev
.payload_type
is None:
1093 raise ConfigError('event payload type must exist in event "{}"'.format(ev_name
))
1095 # TODO: also check arrays, sequences, and variants
1096 if type(ev
.payload_type
) is metadata
.Struct
:
1097 if not ev
.payload_type
.fields
:
1098 raise ConfigError('event payload type must have at least one field for event "{}"'.format(ev_name
))
1101 self
._validate
_entity
_type
_histology
(ev
.payload_type
)
1102 except Exception as e
:
1103 raise ConfigError('invalid event payload type for event "{}"'.format(ev_name
), e
)
1105 def _validate_stream_types_histology(self
, stream
):
1106 stream_name
= stream
.name
1108 # validate stream packet context type
1110 self
._validate
_entity
_type
_histology
(stream
.packet_context_type
)
1111 except Exception as e
:
1112 raise ConfigError('invalid stream packet context type for stream "{}"'.format(stream_name
), e
)
1114 # validate stream event header type
1116 self
._validate
_entity
_type
_histology
(stream
.event_header_type
)
1117 except Exception as e
:
1118 raise ConfigError('invalid stream event header type for stream "{}"'.format(stream_name
), e
)
1120 # validate stream event context type
1122 self
._validate
_entity
_type
_histology
(stream
.event_context_type
)
1123 except Exception as e
:
1124 raise ConfigError('invalid stream event context type for stream "{}"'.format(stream_name
), e
)
1127 for ev
in stream
.events
.values():
1129 self
._validate
_event
_types
_histology
(ev
)
1130 except Exception as e
:
1131 raise ConfigError('invalid event in stream "{}"'.format(stream_name
), e
)
1133 def validate(self
, meta
):
1134 # validate trace packet header type
1136 self
._validate
_entity
_type
_histology
(meta
.trace
.packet_header_type
)
1137 except Exception as e
:
1138 raise ConfigError('invalid trace packet header type', e
)
1141 for stream
in meta
.streams
.values():
1142 self
._validate
_stream
_types
_histology
(stream
)
1145 class _YamlConfigParser
:
1146 def __init__(self
, include_dirs
, ignore_include_not_found
, dump_config
):
1147 self
._class
_name
_to
_create
_type
_func
= {
1148 'int': self
._create
_integer
,
1149 'integer': self
._create
_integer
,
1150 'flt': self
._create
_float
,
1151 'float': self
._create
_float
,
1152 'floating-point': self
._create
_float
,
1153 'enum': self
._create
_enum
,
1154 'enumeration': self
._create
_enum
,
1155 'str': self
._create
_string
,
1156 'string': self
._create
_string
,
1157 'struct': self
._create
_struct
,
1158 'structure': self
._create
_struct
,
1159 'array': self
._create
_array
,
1160 'var': self
._create
_variant
,
1161 'variant': self
._create
_variant
,
1163 self
._type
_to
_create
_type
_func
= {
1164 metadata
.Integer
: self
._create
_integer
,
1165 metadata
.FloatingPoint
: self
._create
_float
,
1166 metadata
.Enum
: self
._create
_enum
,
1167 metadata
.String
: self
._create
_string
,
1168 metadata
.Struct
: self
._create
_struct
,
1169 metadata
.Array
: self
._create
_array
,
1170 metadata
.Variant
: self
._create
_variant
,
1172 self
._include
_dirs
= include_dirs
1173 self
._ignore
_include
_not
_found
= ignore_include_not_found
1174 self
._dump
_config
= dump_config
1176 def _set_byte_order(self
, metadata_node
):
1177 if 'trace' not in metadata_node
:
1178 raise ConfigError('missing "trace" property (metadata)')
1180 trace_node
= metadata_node
['trace']
1182 if not _is_assoc_array_prop(trace_node
):
1183 raise ConfigError('"trace" property (metadata) must be an associative array')
1185 if 'byte-order' not in trace_node
:
1186 raise ConfigError('missing "byte-order" property (trace)')
1188 bo_node
= trace_node
['byte-order']
1190 if not _is_str_prop(bo_node
):
1191 raise ConfigError('"byte-order" property of trace object must be a string ("le" or "be")')
1193 self
._bo
= _byte_order_str_to_bo(bo_node
)
1195 if self
._bo
is None:
1196 raise ConfigError('invalid "byte-order" property (trace): must be "le" or "be"')
1198 def _lookup_type_alias(self
, name
):
1199 if name
in self
._tas
:
1200 return copy
.deepcopy(self
._tas
[name
])
1202 def _set_int_clock_prop_mapping(self
, int_obj
, prop_mapping_node
):
1203 unk_prop
= _get_first_unknown_prop(prop_mapping_node
, ['type', 'name', 'property'])
1206 raise ConfigError('unknown property in integer type object\'s clock property mapping: "{}"'.format(unk_prop
))
1208 if 'name' not in prop_mapping_node
:
1209 raise ConfigError('missing "name" property in integer type object\'s clock property mapping')
1211 if 'property' not in prop_mapping_node
:
1212 raise ConfigError('missing "property" property in integer type object\'s clock property mapping')
1214 clock_name
= prop_mapping_node
['name']
1215 prop
= prop_mapping_node
['property']
1217 if not _is_str_prop(clock_name
):
1218 raise ConfigError('"name" property of integer type object\'s clock property mapping must be a string')
1220 if not _is_str_prop(prop
):
1221 raise ConfigError('"property" property of integer type object\'s clock property mapping must be a string')
1223 if clock_name
not in self
._clocks
:
1224 raise ConfigError('invalid clock name "{}" in integer type object\'s clock property mapping'.format(clock_name
))
1227 raise ConfigError('invalid "property" property in integer type object\'s clock property mapping: "{}"'.format(prop
))
1229 mapped_clock
= self
._clocks
[clock_name
]
1230 int_obj
.property_mappings
.append(metadata
.PropertyMapping(mapped_clock
, prop
))
1232 def _get_first_unknown_type_prop(self
, type_node
, known_props
):
1233 kp
= known_props
+ ['inherit', 'class']
1235 if self
._version
>= 201:
1236 kp
.append('$inherit')
1238 return _get_first_unknown_prop(type_node
, kp
)
1240 def _create_integer(self
, obj
, node
):
1242 # create integer object
1243 obj
= metadata
.Integer()
1245 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1252 'property-mappings',
1256 raise ConfigError('unknown integer type object property: "{}"'.format(unk_prop
))
1262 if not _is_int_prop(size
):
1263 raise ConfigError('"size" property of integer type object must be an integer')
1266 raise ConfigError('invalid integer size: {}'.format(size
))
1272 align
= node
['align']
1274 if not _is_int_prop(align
):
1275 raise ConfigError('"align" property of integer type object must be an integer')
1277 if not _is_valid_alignment(align
):
1278 raise ConfigError('invalid alignment: {}'.format(align
))
1283 if 'signed' in node
:
1284 signed
= node
['signed']
1286 if not _is_bool_prop(signed
):
1287 raise ConfigError('"signed" property of integer type object must be a boolean')
1292 if 'byte-order' in node
:
1293 byte_order
= node
['byte-order']
1295 if not _is_str_prop(byte_order
):
1296 raise ConfigError('"byte-order" property of integer type object must be a string ("le" or "be")')
1298 byte_order
= _byte_order_str_to_bo(byte_order
)
1300 if byte_order
is None:
1301 raise ConfigError('invalid "byte-order" property in integer type object')
1303 byte_order
= self
._bo
1305 obj
.byte_order
= byte_order
1311 if not _is_str_prop(base
):
1312 raise ConfigError('"base" property of integer type object must be a string ("bin", "oct", "dec", or "hex")')
1323 raise ConfigError('unknown "base" property value: "{}" ("bin", "oct", "dec", and "hex" are accepted)'.format(base
))
1328 if 'encoding' in node
:
1329 encoding
= node
['encoding']
1331 if not _is_str_prop(encoding
):
1332 raise ConfigError('"encoding" property of integer type object must be a string ("none", "ascii", or "utf-8")')
1334 encoding
= _encoding_str_to_encoding(encoding
)
1336 if encoding
is None:
1337 raise ConfigError('invalid "encoding" property in integer type object')
1339 obj
.encoding
= encoding
1342 if 'property-mappings' in node
:
1343 prop_mappings
= node
['property-mappings']
1345 if not _is_array_prop(prop_mappings
):
1346 raise ConfigError('"property-mappings" property of integer type object must be an array')
1348 if len(prop_mappings
) > 1:
1349 raise ConfigError('length of "property-mappings" array in integer type object must be 1')
1351 del obj
.property_mappings
[:]
1353 for index
, prop_mapping
in enumerate(prop_mappings
):
1354 if not _is_assoc_array_prop(prop_mapping
):
1355 raise ConfigError('elements of "property-mappings" property of integer type object must be associative arrays')
1357 if 'type' not in prop_mapping
:
1358 raise ConfigError('missing "type" property in integer type object\'s "property-mappings" array\'s element #{}'.format(index
))
1360 prop_type
= prop_mapping
['type']
1362 if not _is_str_prop(prop_type
):
1363 raise ConfigError('"type" property of integer type object\'s "property-mappings" array\'s element #{} must be a string'.format(index
))
1365 if prop_type
== 'clock':
1366 self
._set
_int
_clock
_prop
_mapping
(obj
, prop_mapping
)
1368 raise ConfigError('unknown property mapping type "{}" in integer type object\'s "property-mappings" array\'s element #{}'.format(prop_type
, index
))
1372 def _create_float(self
, obj
, node
):
1374 # create floating point number object
1375 obj
= metadata
.FloatingPoint()
1377 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1384 raise ConfigError('unknown floating point number type object property: "{}"'.format(unk_prop
))
1390 if not _is_assoc_array_prop(size
):
1391 raise ConfigError('"size" property of floating point number type object must be an associative array')
1393 unk_prop
= _get_first_unknown_prop(size
, ['exp', 'mant'])
1396 raise ConfigError('unknown floating point number type object\'s "size" property: "{}"'.format(unk_prop
))
1401 if not _is_int_prop(exp
):
1402 raise ConfigError('"exp" property of floating point number type object\'s "size" property must be an integer')
1405 raise ConfigError('invalid floating point number exponent size: {}')
1412 if not _is_int_prop(mant
):
1413 raise ConfigError('"mant" property of floating point number type object\'s "size" property must be an integer')
1416 raise ConfigError('invalid floating point number mantissa size: {}')
1418 obj
.mant_size
= mant
1422 align
= node
['align']
1424 if not _is_int_prop(align
):
1425 raise ConfigError('"align" property of floating point number type object must be an integer')
1427 if not _is_valid_alignment(align
):
1428 raise ConfigError('invalid alignment: {}'.format(align
))
1433 if 'byte-order' in node
:
1434 byte_order
= node
['byte-order']
1436 if not _is_str_prop(byte_order
):
1437 raise ConfigError('"byte-order" property of floating point number type object must be a string ("le" or "be")')
1439 byte_order
= _byte_order_str_to_bo(byte_order
)
1441 if byte_order
is None:
1442 raise ConfigError('invalid "byte-order" property in floating point number type object')
1444 byte_order
= self
._bo
1446 obj
.byte_order
= byte_order
1450 def _create_enum(self
, obj
, node
):
1452 # create enumeration object
1453 obj
= metadata
.Enum()
1455 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1461 raise ConfigError('unknown enumeration type object property: "{}"'.format(unk_prop
))
1464 if 'value-type' in node
:
1466 obj
.value_type
= self
._create
_type
(node
['value-type'])
1467 except Exception as e
:
1468 raise ConfigError('cannot create enumeration type\'s integer type', e
)
1471 if 'members' in node
:
1472 members_node
= node
['members']
1474 if not _is_array_prop(members_node
):
1475 raise ConfigError('"members" property of enumeration type object must be an array')
1479 for index
, m_node
in enumerate(members_node
):
1480 if not _is_str_prop(m_node
) and not _is_assoc_array_prop(m_node
):
1481 raise ConfigError('invalid enumeration member #{}: expecting a string or an associative array'.format(index
))
1483 if _is_str_prop(m_node
):
1488 unk_prop
= _get_first_unknown_prop(m_node
, [
1494 raise ConfigError('unknown enumeration type member object property: "{}"'.format(unk_prop
))
1496 if 'label' not in m_node
:
1497 raise ConfigError('missing "label" property in enumeration member #{}'.format(index
))
1499 label
= m_node
['label']
1501 if not _is_str_prop(label
):
1502 raise ConfigError('"label" property of enumeration member #{} must be a string'.format(index
))
1504 if 'value' not in m_node
:
1505 raise ConfigError('missing "value" property in enumeration member ("{}")'.format(label
))
1507 value
= m_node
['value']
1509 if not _is_int_prop(value
) and not _is_array_prop(value
):
1510 raise ConfigError('invalid enumeration member ("{}"): expecting an integer or an array'.format(label
))
1512 if _is_int_prop(value
):
1514 value
= (value
, value
)
1517 raise ConfigError('invalid enumeration member ("{}"): range must have exactly two items'.format(label
))
1523 raise ConfigError('invalid enumeration member ("{}"): invalid range ({} > {})'.format(label
, mn
, mx
))
1528 obj
.members
[label
] = value
1532 def _create_string(self
, obj
, node
):
1534 # create string object
1535 obj
= metadata
.String()
1537 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1542 raise ConfigError('unknown string type object property: "{}"'.format(unk_prop
))
1545 if 'encoding' in node
:
1546 encoding
= node
['encoding']
1548 if not _is_str_prop(encoding
):
1549 raise ConfigError('"encoding" property of string type object must be a string ("none", "ascii", or "utf-8")')
1551 encoding
= _encoding_str_to_encoding(encoding
)
1553 if encoding
is None:
1554 raise ConfigError('invalid "encoding" property in string type object')
1556 obj
.encoding
= encoding
1560 def _create_struct(self
, obj
, node
):
1562 # create structure object
1563 obj
= metadata
.Struct()
1565 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1571 raise ConfigError('unknown string type object property: "{}"'.format(unk_prop
))
1574 if 'min-align' in node
:
1575 min_align
= node
['min-align']
1577 if not _is_int_prop(min_align
):
1578 raise ConfigError('"min-align" property of structure type object must be an integer')
1580 if not _is_valid_alignment(min_align
):
1581 raise ConfigError('invalid minimum alignment: {}'.format(min_align
))
1583 obj
.min_align
= min_align
1586 if 'fields' in node
:
1587 fields
= node
['fields']
1589 if not _is_assoc_array_prop(fields
):
1590 raise ConfigError('"fields" property of structure type object must be an associative array')
1592 for field_name
, field_node
in fields
.items():
1593 if not is_valid_identifier(field_name
):
1594 raise ConfigError('"{}" is not a valid field name for structure type'.format(field_name
))
1597 obj
.fields
[field_name
] = self
._create
_type
(field_node
)
1598 except Exception as e
:
1599 raise ConfigError('cannot create structure type\'s field "{}"'.format(field_name
), e
)
1603 def _create_array(self
, obj
, node
):
1605 # create array object
1606 obj
= metadata
.Array()
1608 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1614 raise ConfigError('unknown array type object property: "{}"'.format(unk_prop
))
1617 if 'length' in node
:
1618 length
= node
['length']
1620 if not _is_int_prop(length
) and not _is_str_prop(length
):
1621 raise ConfigError('"length" property of array type object must be an integer or a string')
1623 if type(length
) is int and length
< 0:
1624 raise ConfigError('invalid static array length: {}'.format(length
))
1629 if 'element-type' in node
:
1631 obj
.element_type
= self
._create
_type
(node
['element-type'])
1632 except Exception as e
:
1633 raise ConfigError('cannot create array type\'s element type', e
)
1637 def _create_variant(self
, obj
, node
):
1639 # create variant object
1640 obj
= metadata
.Variant()
1642 unk_prop
= self
._get
_first
_unknown
_type
_prop
(node
, [
1648 raise ConfigError('unknown variant type object property: "{}"'.format(unk_prop
))
1654 if not _is_str_prop(tag
):
1655 raise ConfigError('"tag" property of variant type object must be a string')
1657 # do not validate variant tag for the moment; will be done in a
1663 types
= node
['types']
1665 if not _is_assoc_array_prop(types
):
1666 raise ConfigError('"types" property of variant type object must be an associative array')
1668 # do not validate type names for the moment; will be done in a
1670 for type_name
, type_node
in types
.items():
1671 if not is_valid_identifier(type_name
):
1672 raise ConfigError('"{}" is not a valid type name for variant type'.format(type_name
))
1675 obj
.types
[type_name
] = self
._create
_type
(type_node
)
1676 except Exception as e
:
1677 raise ConfigError('cannot create variant type\'s type "{}"'.format(type_name
), e
)
1681 def _create_type(self
, type_node
):
1682 if type(type_node
) is str:
1683 t
= self
._lookup
_type
_alias
(type_node
)
1686 raise ConfigError('unknown type alias "{}"'.format(type_node
))
1690 if not _is_assoc_array_prop(type_node
):
1691 raise ConfigError('type objects must be associative arrays or strings (type alias name)')
1698 if self
._version
>= 200:
1699 if 'inherit' in type_node
:
1700 inherit_prop
= 'inherit'
1701 inherit_node
= type_node
[inherit_prop
]
1703 if self
._version
>= 201:
1704 if '$inherit' in type_node
:
1705 if inherit_node
is not None:
1706 raise ConfigError('cannot specify both "inherit" and "$inherit" properties of type object: prefer "$inherit"')
1708 inherit_prop
= '$inherit'
1709 inherit_node
= type_node
[inherit_prop
]
1711 if inherit_node
is not None and 'class' in type_node
:
1712 raise ConfigError('cannot specify both "{}" and "class" properties in type object'.format(inherit_prop
))
1714 if inherit_node
is not None:
1715 if not _is_str_prop(inherit_node
):
1716 raise ConfigError('"{}" property of type object must be a string'.format(inherit_prop
))
1718 base
= self
._lookup
_type
_alias
(inherit_node
)
1721 raise ConfigError('cannot inherit from type alias "{}": type alias does not exist at this point'.format(inherit_node
))
1723 func
= self
._type
_to
_create
_type
_func
[type(base
)]
1725 if 'class' not in type_node
:
1726 raise ConfigError('type objects which do not inherit must have a "class" property')
1728 class_name
= type_node
['class']
1730 if type(class_name
) is not str:
1731 raise ConfigError('type objects\' "class" property must be a string')
1733 if class_name
not in self
._class
_name
_to
_create
_type
_func
:
1734 raise ConfigError('unknown type class "{}"'.format(class_name
))
1737 func
= self
._class
_name
_to
_create
_type
_func
[class_name
]
1739 return func(base
, type_node
)
1741 def _register_type_aliases(self
, metadata_node
):
1744 if 'type-aliases' not in metadata_node
:
1747 ta_node
= metadata_node
['type-aliases']
1749 if not _is_assoc_array_prop(ta_node
):
1750 raise ConfigError('"type-aliases" property (metadata) must be an associative array')
1752 for ta_name
, ta_type
in ta_node
.items():
1753 if ta_name
in self
._tas
:
1754 raise ConfigError('duplicate type alias "{}"'.format(ta_name
))
1757 t
= self
._create
_type
(ta_type
)
1758 except Exception as e
:
1759 raise ConfigError('cannot create type alias "{}"'.format(ta_name
), e
)
1761 self
._tas
[ta_name
] = t
1763 def _create_clock(self
, node
):
1764 # create clock object
1765 clock
= metadata
.Clock()
1767 if not _is_assoc_array_prop(node
):
1768 raise ConfigError('clock objects must be associative arrays')
1780 if self
._version
>= 201:
1781 known_props
.append('$return-ctype')
1783 unk_prop
= _get_first_unknown_prop(node
, known_props
)
1786 raise ConfigError('unknown clock object property: "{}"'.format(unk_prop
))
1790 uuidp
= node
['uuid']
1792 if not _is_str_prop(uuidp
):
1793 raise ConfigError('"uuid" property of clock object must be a string')
1796 uuidp
= uuid
.UUID(uuidp
)
1798 raise ConfigError('malformed UUID (clock object): "{}"'.format(uuidp
))
1803 if 'description' in node
:
1804 desc
= node
['description']
1806 if not _is_str_prop(desc
):
1807 raise ConfigError('"description" property of clock object must be a string')
1809 clock
.description
= desc
1815 if not _is_int_prop(freq
):
1816 raise ConfigError('"freq" property of clock object must be an integer')
1819 raise ConfigError('invalid clock frequency: {}'.format(freq
))
1824 if 'error-cycles' in node
:
1825 error_cycles
= node
['error-cycles']
1827 if not _is_int_prop(error_cycles
):
1828 raise ConfigError('"error-cycles" property of clock object must be an integer')
1830 if error_cycles
< 0:
1831 raise ConfigError('invalid clock error cycles: {}'.format(error_cycles
))
1833 clock
.error_cycles
= error_cycles
1836 if 'offset' in node
:
1837 offset
= node
['offset']
1839 if not _is_assoc_array_prop(offset
):
1840 raise ConfigError('"offset" property of clock object must be an associative array')
1842 unk_prop
= _get_first_unknown_prop(offset
, ['cycles', 'seconds'])
1845 raise ConfigError('unknown clock object\'s offset property: "{}"'.format(unk_prop
))
1848 if 'cycles' in offset
:
1849 offset_cycles
= offset
['cycles']
1851 if not _is_int_prop(offset_cycles
):
1852 raise ConfigError('"cycles" property of clock object\'s offset property must be an integer')
1854 if offset_cycles
< 0:
1855 raise ConfigError('invalid clock offset cycles: {}'.format(offset_cycles
))
1857 clock
.offset_cycles
= offset_cycles
1860 if 'seconds' in offset
:
1861 offset_seconds
= offset
['seconds']
1863 if not _is_int_prop(offset_seconds
):
1864 raise ConfigError('"seconds" property of clock object\'s offset property must be an integer')
1866 if offset_seconds
< 0:
1867 raise ConfigError('invalid clock offset seconds: {}'.format(offset_seconds
))
1869 clock
.offset_seconds
= offset_seconds
1872 if 'absolute' in node
:
1873 absolute
= node
['absolute']
1875 if not _is_bool_prop(absolute
):
1876 raise ConfigError('"absolute" property of clock object must be a boolean')
1878 clock
.absolute
= absolute
1881 # v2.0: "return-ctype"
1882 # v2.1+: "$return-ctype"
1883 return_ctype_node
= None
1885 if self
._version
>= 200:
1886 if 'return-ctype' in node
:
1887 return_ctype_prop
= 'return-ctype'
1888 return_ctype_node
= node
[return_ctype_prop
]
1890 if self
._version
>= 201:
1891 if '$return-ctype' in node
:
1892 if return_ctype_node
is not None:
1893 raise ConfigError('cannot specify both "return-ctype" and "$return-ctype" properties of clock object: prefer "$return-ctype"')
1895 return_ctype_prop
= '$return-ctype'
1896 return_ctype_node
= node
[return_ctype_prop
]
1898 if return_ctype_node
is not None:
1899 if not _is_str_prop(return_ctype_node
):
1900 raise ConfigError('"{}" property of clock object must be a string'.format(return_ctype_prop
))
1902 clock
.return_ctype
= return_ctype_node
1906 def _register_clocks(self
, metadata_node
):
1907 self
._clocks
= collections
.OrderedDict()
1909 if 'clocks' not in metadata_node
:
1912 clocks_node
= metadata_node
['clocks']
1914 if not _is_assoc_array_prop(clocks_node
):
1915 raise ConfigError('"clocks" property (metadata) must be an associative array')
1917 for clock_name
, clock_node
in clocks_node
.items():
1918 if not is_valid_identifier(clock_name
):
1919 raise ConfigError('invalid clock name: "{}"'.format(clock_name
))
1921 if clock_name
in self
._clocks
:
1922 raise ConfigError('duplicate clock "{}"'.format(clock_name
))
1925 clock
= self
._create
_clock
(clock_node
)
1926 except Exception as e
:
1927 raise ConfigError('cannot create clock "{}"'.format(clock_name
), e
)
1929 clock
.name
= clock_name
1930 self
._clocks
[clock_name
] = clock
1932 def _create_env(self
, metadata_node
):
1933 env
= collections
.OrderedDict()
1935 if 'env' not in metadata_node
:
1938 env_node
= metadata_node
['env']
1940 if not _is_assoc_array_prop(env_node
):
1941 raise ConfigError('"env" property (metadata) must be an associative array')
1943 for env_name
, env_value
in env_node
.items():
1945 raise ConfigError('duplicate environment variable "{}"'.format(env_name
))
1947 if not is_valid_identifier(env_name
):
1948 raise ConfigError('invalid environment variable name: "{}"'.format(env_name
))
1950 if not _is_int_prop(env_value
) and not _is_str_prop(env_value
):
1951 raise ConfigError('invalid environment variable value ("{}"): expecting integer or string'.format(env_name
))
1953 env
[env_name
] = env_value
1957 def _register_log_levels(self
, metadata_node
):
1958 self
._log
_levels
= dict()
1961 # v2.0: "log-levels"
1962 # v2.1+: "$log-levels"
1963 log_levels_node
= None
1965 if self
._version
>= 200:
1966 if 'log-levels' in metadata_node
:
1967 log_levels_prop
= 'log-levels'
1968 log_levels_node
= metadata_node
[log_levels_prop
]
1970 if self
._version
>= 201:
1971 if '$log-levels' in metadata_node
:
1972 if log_levels_node
is not None:
1973 raise ConfigError('cannot specify both "log-levels" and "$log-levels" properties of metadata object: prefer "$log-levels"')
1975 log_levels_prop
= '$log-levels'
1976 log_levels_node
= metadata_node
[log_levels_prop
]
1978 if log_levels_node
is None:
1981 if not _is_assoc_array_prop(log_levels_node
):
1982 raise ConfigError('"{}" property (metadata) must be an associative array'.format(log_levels_prop
))
1984 for ll_name
, ll_value
in log_levels_node
.items():
1985 if ll_name
in self
._log
_levels
:
1986 raise ConfigError('duplicate log level entry "{}"'.format(ll_name
))
1988 if not _is_int_prop(ll_value
):
1989 raise ConfigError('invalid log level entry ("{}"): expecting an integer'.format(ll_name
))
1992 raise ConfigError('invalid log level entry ("{}"): log level value must be positive'.format(ll_name
))
1994 self
._log
_levels
[ll_name
] = ll_value
1996 def _create_trace(self
, metadata_node
):
1997 # create trace object
1998 trace
= metadata
.Trace()
2000 if 'trace' not in metadata_node
:
2001 raise ConfigError('missing "trace" property (metadata)')
2003 trace_node
= metadata_node
['trace']
2005 if not _is_assoc_array_prop(trace_node
):
2006 raise ConfigError('"trace" property (metadata) must be an associative array')
2008 unk_prop
= _get_first_unknown_prop(trace_node
, [
2011 'packet-header-type',
2015 raise ConfigError('unknown trace object property: "{}"'.format(unk_prop
))
2017 # set byte order (already parsed)
2018 trace
.byte_order
= self
._bo
2021 if 'uuid' in trace_node
:
2022 uuidp
= trace_node
['uuid']
2024 if not _is_str_prop(uuidp
):
2025 raise ConfigError('"uuid" property of trace object must be a string')
2028 uuidp
= uuid
.uuid1()
2031 uuidp
= uuid
.UUID(uuidp
)
2033 raise ConfigError('malformed UUID (trace object): "{}"'.format(uuidp
))
2037 # packet header type
2038 if 'packet-header-type' in trace_node
:
2040 ph_type
= self
._create
_type
(trace_node
['packet-header-type'])
2041 except Exception as e
:
2042 raise ConfigError('cannot create packet header type (trace)', e
)
2044 trace
.packet_header_type
= ph_type
2048 def _lookup_log_level(self
, ll
):
2049 if _is_int_prop(ll
):
2051 elif _is_str_prop(ll
) and ll
in self
._log
_levels
:
2052 return self
._log
_levels
[ll
]
2054 def _create_event(self
, event_node
):
2055 event
= metadata
.Event()
2057 if not _is_assoc_array_prop(event_node
):
2058 raise ConfigError('event objects must be associative arrays')
2060 unk_prop
= _get_first_unknown_prop(event_node
, [
2067 raise ConfigError('unknown event object property: "{}"'.format(unk_prop
))
2069 if 'log-level' in event_node
:
2070 ll_node
= event_node
['log-level']
2072 if _is_str_prop(ll_node
):
2073 ll
= self
._lookup
_log
_level
(event_node
['log-level'])
2076 raise ConfigError('cannot find log level "{}"'.format(ll_node
))
2077 elif _is_int_prop(ll_node
):
2079 raise ConfigError('invalid log level value {}: value must be positive'.format(ll_node
))
2083 raise ConfigError('"log-level" property must be either a string or an integer')
2085 event
.log_level
= ll
2087 if 'context-type' in event_node
:
2089 t
= self
._create
_type
(event_node
['context-type'])
2090 except Exception as e
:
2091 raise ConfigError('cannot create event\'s context type object', e
)
2093 event
.context_type
= t
2095 if 'payload-type' not in event_node
:
2096 raise ConfigError('missing "payload-type" property in event object')
2099 t
= self
._create
_type
(event_node
['payload-type'])
2100 except Exception as e
:
2101 raise ConfigError('cannot create event\'s payload type object', e
)
2103 event
.payload_type
= t
2107 def _create_stream(self
, stream_node
):
2108 stream
= metadata
.Stream()
2110 if not _is_assoc_array_prop(stream_node
):
2111 raise ConfigError('stream objects must be associative arrays')
2113 unk_prop
= _get_first_unknown_prop(stream_node
, [
2114 'packet-context-type',
2115 'event-header-type',
2116 'event-context-type',
2121 raise ConfigError('unknown stream object property: "{}"'.format(unk_prop
))
2123 if 'packet-context-type' in stream_node
:
2125 t
= self
._create
_type
(stream_node
['packet-context-type'])
2126 except Exception as e
:
2127 raise ConfigError('cannot create stream\'s packet context type object', e
)
2129 stream
.packet_context_type
= t
2131 if 'event-header-type' in stream_node
:
2133 t
= self
._create
_type
(stream_node
['event-header-type'])
2134 except Exception as e
:
2135 raise ConfigError('cannot create stream\'s event header type object', e
)
2137 stream
.event_header_type
= t
2139 if 'event-context-type' in stream_node
:
2141 t
= self
._create
_type
(stream_node
['event-context-type'])
2142 except Exception as e
:
2143 raise ConfigError('cannot create stream\'s event context type object', e
)
2145 stream
.event_context_type
= t
2147 if 'events' not in stream_node
:
2148 raise ConfigError('missing "events" property in stream object')
2150 events
= stream_node
['events']
2152 if not _is_assoc_array_prop(events
):
2153 raise ConfigError('"events" property of stream object must be an associative array')
2156 raise ConfigError('at least one event is needed within a stream object')
2160 for ev_name
, ev_node
in events
.items():
2162 ev
= self
._create
_event
(ev_node
)
2163 except Exception as e
:
2164 raise ConfigError('cannot create event "{}"'.format(ev_name
), e
)
2168 stream
.events
[ev_name
] = ev
2173 def _create_streams(self
, metadata_node
):
2174 streams
= collections
.OrderedDict()
2176 if 'streams' not in metadata_node
:
2177 raise ConfigError('missing "streams" property (metadata)')
2179 streams_node
= metadata_node
['streams']
2181 if not _is_assoc_array_prop(streams_node
):
2182 raise ConfigError('"streams" property (metadata) must be an associative array')
2184 if not streams_node
:
2185 raise ConfigError('at least one stream is needed (metadata)')
2189 for stream_name
, stream_node
in streams_node
.items():
2191 stream
= self
._create
_stream
(stream_node
)
2192 except Exception as e
:
2193 raise ConfigError('cannot create stream "{}"'.format(stream_name
), e
)
2196 stream
.name
= str(stream_name
)
2197 streams
[stream_name
] = stream
2202 def _create_metadata(self
, root
):
2203 meta
= metadata
.Metadata()
2205 if 'metadata' not in root
:
2206 raise ConfigError('missing "metadata" property (configuration)')
2208 metadata_node
= root
['metadata']
2210 if not _is_assoc_array_prop(metadata_node
):
2211 raise ConfigError('"metadata" property (configuration) must be an associative array')
2222 if self
._version
>= 201:
2223 known_props
.append('$log-levels')
2225 unk_prop
= _get_first_unknown_prop(metadata_node
, known_props
)
2230 if unk_prop
== '$include':
2231 add
= ' (use version 2.1 or greater)'
2233 raise ConfigError('unknown metadata property{}: "{}"'.format(add
, unk_prop
))
2235 self
._set
_byte
_order
(metadata_node
)
2236 self
._register
_clocks
(metadata_node
)
2237 meta
.clocks
= self
._clocks
2238 self
._register
_type
_aliases
(metadata_node
)
2239 meta
.env
= self
._create
_env
(metadata_node
)
2240 meta
.trace
= self
._create
_trace
(metadata_node
)
2241 self
._register
_log
_levels
(metadata_node
)
2242 meta
.streams
= self
._create
_streams
(metadata_node
)
2246 def _get_version(self
, root
):
2247 if 'version' not in root
:
2248 raise ConfigError('missing "version" property (configuration)')
2250 version_node
= root
['version']
2252 if not _is_str_prop(version_node
):
2253 raise ConfigError('"version" property (configuration) must be a string')
2255 version_node
= version_node
.strip()
2257 if version_node
not in ['2.0', '2.1']:
2258 raise ConfigError('unsupported version ({}): versions 2.0 and 2.1 are supported'.format(version_node
))
2260 # convert version string to comparable version integer
2261 parts
= version_node
.split('.')
2262 version
= int(parts
[0]) * 100 + int(parts
[1])
2266 def _get_prefix(self
, root
):
2267 if 'prefix' not in root
:
2270 prefix_node
= root
['prefix']
2272 if not _is_str_prop(prefix_node
):
2273 raise ConfigError('"prefix" property (configuration) must be a string')
2275 if not is_valid_identifier(prefix_node
):
2276 raise ConfigError('"prefix" property (configuration) must be a valid C identifier')
2280 def _get_last_include_file(self
):
2281 if self
._include
_stack
:
2282 return self
._include
_stack
[-1]
2284 return self
._root
_yaml
_path
2286 def _load_include(self
, yaml_path
):
2287 for inc_dir
in self
._include
_dirs
:
2288 # current include dir + file name path
2289 # note: os.path.join() only takes the last arg if it's absolute
2290 inc_path
= os
.path
.join(inc_dir
, yaml_path
)
2292 # real path (symbolic links resolved)
2293 real_path
= os
.path
.realpath(inc_path
)
2295 # normalized path (weird stuff removed!)
2296 norm_path
= os
.path
.normpath(real_path
)
2298 if not os
.path
.isfile(norm_path
):
2299 # file does not exist: skip
2302 if norm_path
in self
._include
_stack
:
2303 base_path
= self
._get
_last
_include
_file
()
2304 raise ConfigError('in "{}": cannot recursively include file "{}"'.format(base_path
, norm_path
))
2306 self
._include
_stack
.append(norm_path
)
2309 return self
._yaml
_ordered
_load
(norm_path
)
2311 if not self
._ignore
_include
_not
_found
:
2312 base_path
= self
._get
_last
_include
_file
()
2313 raise ConfigError('in "{}": cannot include file "{}": file not found in include directories'.format(base_path
, yaml_path
))
2317 def _get_include_paths(self
, include_node
):
2318 if _is_str_prop(include_node
):
2319 return [include_node
]
2320 elif _is_array_prop(include_node
):
2321 for include_path
in include_node
:
2322 if not _is_str_prop(include_path
):
2323 raise ConfigError('invalid include property: expecting array of strings')
2327 raise ConfigError('invalid include property: expecting string or array of strings')
2329 def _update_node(self
, base_node
, overlay_node
):
2330 for olay_key
, olay_value
in overlay_node
.items():
2331 if olay_key
in base_node
:
2332 base_value
= base_node
[olay_key
]
2334 if _is_assoc_array_prop(olay_value
) and _is_assoc_array_prop(base_value
):
2335 # merge dictionaries
2336 self
._update
_node
(base_value
, olay_value
)
2337 elif _is_array_prop(olay_value
) and _is_array_prop(base_value
):
2338 # append extension array items to base items
2339 base_value
+= olay_value
2341 # fall back to replacing
2342 base_node
[olay_key
] = olay_value
2344 base_node
[olay_key
] = olay_value
2346 def _process_node_include(self
, last_overlay_node
, name
,
2347 process_base_include_cb
,
2348 process_children_include_cb
=None):
2349 if not _is_assoc_array_prop(last_overlay_node
):
2350 raise ConfigError('{} objects must be associative arrays'.format(name
))
2352 # process children inclusions first
2353 if process_children_include_cb
:
2354 process_children_include_cb(last_overlay_node
)
2356 if '$include' in last_overlay_node
:
2357 include_node
= last_overlay_node
['$include']
2360 return last_overlay_node
2362 include_paths
= self
._get
_include
_paths
(include_node
)
2363 cur_base_path
= self
._get
_last
_include
_file
()
2366 # keep the include paths and remove the include property
2367 include_paths
= copy
.deepcopy(include_paths
)
2368 del last_overlay_node
['$include']
2370 for include_path
in include_paths
:
2371 # load raw YAML from included file
2372 overlay_node
= self
._load
_include
(include_path
)
2374 if overlay_node
is None:
2375 # cannot find include file, but we're ignoring those
2376 # errors, otherwise _load_include() itself raises
2380 # recursively process includes
2382 overlay_node
= process_base_include_cb(overlay_node
)
2383 except Exception as e
:
2384 raise ConfigError('in "{}"'.format(cur_base_path
), e
)
2386 # pop include stack now that we're done including
2387 del self
._include
_stack
[-1]
2389 # at this point, base_node is fully resolved (does not
2390 # contain any include property)
2391 if base_node
is None:
2392 base_node
= overlay_node
2394 self
._update
_node
(base_node
, overlay_node
)
2396 # finally, we update the latest base node with our last overlay
2398 if base_node
is None:
2399 # nothing was included, which is possible when we're
2400 # ignoring include errors
2401 return last_overlay_node
2403 self
._update
_node
(base_node
, last_overlay_node
)
2407 def _process_event_include(self
, event_node
):
2408 return self
._process
_node
_include
(event_node
, 'event',
2409 self
._process
_event
_include
)
2411 def _process_stream_include(self
, stream_node
):
2412 def process_children_include(stream_node
):
2413 if 'events' in stream_node
:
2414 events_node
= stream_node
['events']
2416 if not _is_assoc_array_prop(events_node
):
2417 raise ConfigError('"events" property must be an associative array')
2419 events_node_keys
= list(events_node
.keys())
2421 for key
in events_node_keys
:
2422 event_node
= events_node
[key
]
2425 events_node
[key
] = self
._process
_event
_include
(event_node
)
2426 except Exception as e
:
2427 raise ConfigError('cannot process includes of event object "{}"'.format(key
), e
)
2429 return self
._process
_node
_include
(stream_node
, 'stream',
2430 self
._process
_stream
_include
,
2431 process_children_include
)
2433 def _process_trace_include(self
, trace_node
):
2434 return self
._process
_node
_include
(trace_node
, 'trace',
2435 self
._process
_trace
_include
)
2437 def _process_clock_include(self
, clock_node
):
2438 return self
._process
_node
_include
(clock_node
, 'clock',
2439 self
._process
_clock
_include
)
2441 def _process_metadata_include(self
, metadata_node
):
2442 def process_children_include(metadata_node
):
2443 if 'trace' in metadata_node
:
2444 metadata_node
['trace'] = self
._process
_trace
_include
(metadata_node
['trace'])
2446 if 'clocks' in metadata_node
:
2447 clocks_node
= metadata_node
['clocks']
2449 if not _is_assoc_array_prop(clocks_node
):
2450 raise ConfigError('"clocks" property (metadata) must be an associative array')
2452 clocks_node_keys
= list(clocks_node
.keys())
2454 for key
in clocks_node_keys
:
2455 clock_node
= clocks_node
[key
]
2458 clocks_node
[key
] = self
._process
_clock
_include
(clock_node
)
2459 except Exception as e
:
2460 raise ConfigError('cannot process includes of clock object "{}"'.format(key
), e
)
2462 if 'streams' in metadata_node
:
2463 streams_node
= metadata_node
['streams']
2465 if not _is_assoc_array_prop(streams_node
):
2466 raise ConfigError('"streams" property (metadata) must be an associative array')
2468 streams_node_keys
= list(streams_node
.keys())
2470 for key
in streams_node_keys
:
2471 stream_node
= streams_node
[key
]
2474 streams_node
[key
] = self
._process
_stream
_include
(stream_node
)
2475 except Exception as e
:
2476 raise ConfigError('cannot process includes of stream object "{}"'.format(key
), e
)
2478 return self
._process
_node
_include
(metadata_node
, 'metadata',
2479 self
._process
_metadata
_include
,
2480 process_children_include
)
2482 def _process_root_includes(self
, root
):
2483 # The following config objects support includes:
2490 # We need to process the event includes first, then the stream
2491 # includes, then the trace includes, and finally the metadata
2494 # In each object, only one of the $include and $include-replace
2495 # special properties is allowed.
2497 # We keep a stack of absolute paths to included files to detect
2499 if 'metadata' in root
:
2500 root
['metadata'] = self
._process
_metadata
_include
(root
['metadata'])
2504 def _yaml_ordered_dump(self
, node
, **kwds
):
2505 class ODumper(yaml
.Dumper
):
2508 def dict_representer(dumper
, node
):
2509 return dumper
.represent_mapping(yaml
.resolver
.BaseResolver
.DEFAULT_MAPPING_TAG
,
2512 ODumper
.add_representer(collections
.OrderedDict
, dict_representer
)
2514 return yaml
.dump(node
, Dumper
=ODumper
, **kwds
)
2516 def _yaml_ordered_load(self
, yaml_path
):
2517 class OLoader(yaml
.Loader
):
2520 def construct_mapping(loader
, node
):
2521 loader
.flatten_mapping(node
)
2523 return collections
.OrderedDict(loader
.construct_pairs(node
))
2525 OLoader
.add_constructor(yaml
.resolver
.BaseResolver
.DEFAULT_MAPPING_TAG
,
2530 with
open(yaml_path
, 'r') as f
:
2531 node
= yaml
.load(f
, OLoader
)
2532 except (OSError, IOError) as e
:
2533 raise ConfigError('cannot open file "{}"'.format(yaml_path
))
2534 except Exception as e
:
2535 raise ConfigError('unknown error while trying to load file "{}"'.format(yaml_path
), e
)
2537 # loaded node must be an associate array
2538 if not _is_assoc_array_prop(node
):
2539 raise ConfigError('root of YAML file "{}" must be an associative array'.format(yaml_path
))
2544 self
._version
= None
2545 self
._include
_stack
= []
2547 def parse(self
, yaml_path
):
2549 self
._root
_yaml
_path
= yaml_path
2552 root
= self
._yaml
_ordered
_load
(yaml_path
)
2553 except Exception as e
:
2554 raise ConfigError('cannot parse YAML file "{}"'.format(yaml_path
), e
)
2556 if not _is_assoc_array_prop(root
):
2557 raise ConfigError('configuration must be an associative array')
2559 unk_prop
= _get_first_unknown_prop(root
, [
2566 raise ConfigError('unknown configuration property: "{}"'.format(unk_prop
))
2568 # get the config version
2569 self
._version
= self
._get
_version
(root
)
2571 # process includes if supported
2572 if self
._version
>= 201:
2573 root
= self
._process
_root
_includes
(root
)
2575 # dump config if required
2576 if self
._dump
_config
:
2577 print(self
._yaml
_ordered
_dump
(root
, indent
=2,
2578 default_flow_style
=False))
2580 # get prefix and metadata
2581 prefix
= self
._get
_prefix
(root
)
2582 meta
= self
._create
_metadata
(root
)
2584 return Config(self
._version
, prefix
, meta
)
2587 def from_yaml_file(path
, include_dirs
, ignore_include_not_found
, dump_config
):
2589 parser
= _YamlConfigParser(include_dirs
, ignore_include_not_found
,
2591 cfg
= parser
.parse(path
)
2594 except Exception as e
:
2595 raise ConfigError('cannot create configuration from YAML file "{}"'.format(path
), e
)