1 # The MIT License (MIT)
3 # Copyright (c) 2017 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 bt2
import utils
, native_bt
26 from bt2
import message_iterator
as bt2_message_iterator
27 from bt2
import logging
as bt2_logging
28 from bt2
import port
as bt2_port
29 from bt2
import component
as bt2_component
30 from bt2
import value
as bt2_value
31 from bt2
import plugin
as bt2_plugin
33 from collections
import namedtuple
37 # a pair of component and ComponentSpec
38 _ComponentAndSpec
= namedtuple('_ComponentAndSpec', ['comp', 'spec'])
41 class _BaseComponentSpec
:
42 # Base for any component spec that can be passed to
43 # TraceCollectionMessageIterator.
44 def __init__(self
, params
, obj
, logging_level
):
45 if logging_level
is not None:
46 utils
._check
_log
_level
(logging_level
)
48 self
._params
= bt2
.create_value(params
)
50 self
._logging
_level
= logging_level
61 def logging_level(self
):
62 return self
._logging
_level
65 class ComponentSpec(_BaseComponentSpec
):
66 # A component spec with a specific component class.
72 logging_level
=bt2
.LoggingLevel
.NONE
,
74 if type(params
) is str:
75 params
= {'inputs': [params
]}
77 super().__init
__(params
, obj
, logging_level
)
79 is_cc_object
= isinstance(
80 component_class
, (bt2
._SourceComponentClass
, bt2
._FilterComponentClass
)
82 is_user_cc_type
= isinstance(
83 component_class
, bt2_component
._UserComponentType
85 component_class
, (bt2
._UserSourceComponent
, bt2
._UserFilterComponent
)
88 if not is_cc_object
and not is_user_cc_type
:
90 "'{}' is not a source or filter component class".format(
91 component_class
.__class
__.__name
__
95 self
._component
_class
= component_class
98 def component_class(self
):
99 return self
._component
_class
102 def from_named_plugin_and_component_class(
105 component_class_name
,
108 logging_level
=bt2
.LoggingLevel
.NONE
,
110 plugin
= bt2
.find_plugin(plugin_name
)
113 raise ValueError('no such plugin: {}'.format(plugin_name
))
115 if component_class_name
in plugin
.source_component_classes
:
116 comp_class
= plugin
.source_component_classes
[component_class_name
]
117 elif component_class_name
in plugin
.filter_component_classes
:
118 comp_class
= plugin
.filter_component_classes
[component_class_name
]
121 'source or filter component class `{}` not found in plugin `{}`'.format(
122 component_class_name
, plugin_name
126 return cls(comp_class
, params
, obj
, logging_level
)
129 class AutoSourceComponentSpec(_BaseComponentSpec
):
130 # A component spec that does automatic source discovery.
133 def __init__(self
, input, params
=None, obj
=_no_obj
, logging_level
=None):
134 super().__init
__(params
, obj
, logging_level
)
142 def _auto_discover_source_component_specs(auto_source_comp_specs
, plugin_set
):
143 # Transform a list of `AutoSourceComponentSpec` in a list of `ComponentSpec`
144 # using the automatic source discovery mechanism.
145 inputs
= bt2
.ArrayValue([spec
.input for spec
in auto_source_comp_specs
])
147 if plugin_set
is None:
148 plugin_set
= bt2
.find_plugins()
150 utils
._check
_type
(plugin_set
, bt2_plugin
._PluginSet
)
152 res_ptr
= native_bt
.bt2_auto_discover_source_components(
153 inputs
._ptr
, plugin_set
._ptr
157 raise bt2
._MemoryError('cannot auto discover source components')
159 res
= bt2_value
._create
_from
_ptr
(res_ptr
)
161 assert type(res
) == bt2
.MapValue
162 assert 'status' in res
164 status
= res
['status']
165 utils
._handle
_func
_status
(status
, 'cannot auto-discover source components')
168 comp_specs_raw
= res
['results']
169 assert type(comp_specs_raw
) == bt2
.ArrayValue
171 used_input_indices
= set()
173 for comp_spec_raw
in comp_specs_raw
:
174 assert type(comp_spec_raw
) == bt2
.ArrayValue
175 assert len(comp_spec_raw
) == 4
177 plugin_name
= comp_spec_raw
[0]
178 assert type(plugin_name
) == bt2
.StringValue
179 plugin_name
= str(plugin_name
)
181 class_name
= comp_spec_raw
[1]
182 assert type(class_name
) == bt2
.StringValue
183 class_name
= str(class_name
)
185 comp_inputs
= comp_spec_raw
[2]
186 assert type(comp_inputs
) == bt2
.ArrayValue
188 comp_orig_indices
= comp_spec_raw
[3]
189 assert type(comp_orig_indices
)
191 params
= bt2
.MapValue()
192 logging_level
= bt2
.LoggingLevel
.NONE
195 # Compute `params` for this component by piling up params given to all
196 # AutoSourceComponentSpec objects that contributed in the instantiation
199 # The effective log level for a component is the last one specified
200 # across the AutoSourceComponentSpec that contributed in its
202 for idx
in comp_orig_indices
:
203 orig_spec
= auto_source_comp_specs
[idx
]
205 if orig_spec
.params
is not None:
206 params
.update(orig_spec
.params
)
208 if orig_spec
.logging_level
is not None:
209 logging_level
= orig_spec
.logging_level
211 if orig_spec
.obj
is not AutoSourceComponentSpec
._no
_obj
:
214 used_input_indices
.add(int(idx
))
216 params
['inputs'] = comp_inputs
219 ComponentSpec
.from_named_plugin_and_component_class(
224 logging_level
=logging_level
,
228 if len(used_input_indices
) != len(inputs
):
229 unused_input_indices
= set(range(len(inputs
))) - used_input_indices
230 unused_input_indices
= sorted(unused_input_indices
)
231 unused_inputs
= [str(inputs
[x
]) for x
in unused_input_indices
]
234 'Some auto source component specs did not produce any component: '
235 + ', '.join(unused_inputs
)
237 raise RuntimeError(msg
)
242 # datetime.datetime or integral to nanoseconds
247 if isinstance(obj
, numbers
.Real
):
248 # consider that it's already in seconds
250 elif isinstance(obj
, datetime
.datetime
):
255 '"{}" is not an integral number or a datetime.datetime object'.format(obj
)
261 class _TraceCollectionMessageIteratorProxySink(bt2_component
._UserSinkComponent
):
262 def __init__(self
, params
, msg_list
):
263 assert type(msg_list
) is list
264 self
._msg
_list
= msg_list
265 self
._add
_input
_port
('in')
267 def _user_graph_is_configured(self
):
268 self
._msg
_iter
= self
._create
_input
_port
_message
_iterator
(
269 self
._input
_ports
['in']
272 def _user_consume(self
):
273 assert self
._msg
_list
[0] is None
274 self
._msg
_list
[0] = next(self
._msg
_iter
)
277 class TraceCollectionMessageIterator(bt2_message_iterator
._MessageIterator
):
280 source_component_specs
,
281 filter_component_specs
=None,
282 stream_intersection_mode
=False,
287 utils
._check
_bool
(stream_intersection_mode
)
288 self
._stream
_intersection
_mode
= stream_intersection_mode
289 self
._begin
_ns
= _get_ns(begin
)
290 self
._end
_ns
= _get_ns(end
)
291 self
._msg
_list
= [None]
293 # If a single item is provided, convert to a list.
294 if type(source_component_specs
) in (
296 AutoSourceComponentSpec
,
299 source_component_specs
= [source_component_specs
]
301 # Convert any string to an AutoSourceComponentSpec.
302 def str_to_auto(item
):
303 if type(item
) is str:
304 item
= AutoSourceComponentSpec(item
)
308 source_component_specs
= [str_to_auto(s
) for s
in source_component_specs
]
310 if type(filter_component_specs
) is ComponentSpec
:
311 filter_component_specs
= [filter_component_specs
]
312 elif filter_component_specs
is None:
313 filter_component_specs
= []
315 self
._validate
_source
_component
_specs
(source_component_specs
)
316 self
._validate
_filter
_component
_specs
(filter_component_specs
)
318 # Pass any `ComponentSpec` instance as-is.
319 self
._src
_comp
_specs
= [
320 spec
for spec
in source_component_specs
if type(spec
) is ComponentSpec
323 # Convert any `AutoSourceComponentSpec` in concrete `ComponentSpec` instances.
324 auto_src_comp_specs
= [
326 for spec
in source_component_specs
327 if type(spec
) is AutoSourceComponentSpec
329 self
._src
_comp
_specs
+= _auto_discover_source_component_specs(
330 auto_src_comp_specs
, plugin_set
333 self
._flt
_comp
_specs
= filter_component_specs
334 self
._next
_suffix
= 1
335 self
._connect
_ports
= False
337 # lists of _ComponentAndSpec
338 self
._src
_comps
_and
_specs
= []
339 self
._flt
_comps
_and
_specs
= []
343 def _validate_source_component_specs(self
, comp_specs
):
344 for comp_spec
in comp_specs
:
346 type(comp_spec
) is not ComponentSpec
347 and type(comp_spec
) is not AutoSourceComponentSpec
350 '"{}" object is not a ComponentSpec or AutoSourceComponentSpec'.format(
355 def _validate_filter_component_specs(self
, comp_specs
):
356 for comp_spec
in comp_specs
:
357 if type(comp_spec
) is not ComponentSpec
:
359 '"{}" object is not a ComponentSpec'.format(type(comp_spec
))
363 assert self
._msg
_list
[0] is None
364 self
._graph
.run_once()
365 msg
= self
._msg
_list
[0]
366 assert msg
is not None
367 self
._msg
_list
[0] = None
370 def _create_stream_intersection_trimmer(self
, component
, port
):
371 # find the original parameters specified by the user to create
372 # this port's component to get the `inputs` parameter
373 for src_comp_and_spec
in self
._src
_comps
_and
_specs
:
374 if component
== src_comp_and_spec
.comp
:
378 inputs
= src_comp_and_spec
.spec
.params
['inputs']
379 except Exception as e
:
381 'all source components must be created with an "inputs" parameter in stream intersection mode'
384 params
= {'inputs': inputs
}
386 # query the port's component for the `babeltrace.trace-info`
387 # object which contains the stream intersection range for each
389 query_exec
= bt2
.QueryExecutor(
390 src_comp_and_spec
.comp
.cls
, 'babeltrace.trace-info', params
392 trace_info_res
= query_exec
.query()
396 # find the trace info for this port's trace
398 for trace_info
in trace_info_res
:
399 for stream
in trace_info
['streams']:
400 if stream
['port-name'] == port
.name
:
401 range_ns
= trace_info
['intersection-range-ns']
402 begin
= range_ns
['begin']
403 end
= range_ns
['end']
408 if begin
is None or end
is None:
410 'cannot find stream intersection range for port "{}"'.format(port
.name
)
413 name
= 'trimmer-{}-{}'.format(src_comp_and_spec
.comp
.name
, port
.name
)
414 return self
._create
_trimmer
(begin
, end
, name
)
416 def _create_muxer(self
):
417 plugin
= bt2
.find_plugin('utils')
420 raise RuntimeError('cannot find "utils" plugin (needed for the muxer)')
422 if 'muxer' not in plugin
.filter_component_classes
:
424 'cannot find "muxer" filter component class in "utils" plugin'
427 comp_cls
= plugin
.filter_component_classes
['muxer']
428 return self
._graph
.add_component(comp_cls
, 'muxer')
430 def _create_trimmer(self
, begin_ns
, end_ns
, name
):
431 plugin
= bt2
.find_plugin('utils')
434 raise RuntimeError('cannot find "utils" plugin (needed for the trimmer)')
436 if 'trimmer' not in plugin
.filter_component_classes
:
438 'cannot find "trimmer" filter component class in "utils" plugin'
443 def ns_to_string(ns
):
444 s_part
= ns
// 1000000000
445 ns_part
= ns
% 1000000000
446 return '{}.{:09d}'.format(s_part
, ns_part
)
448 if begin_ns
is not None:
449 params
['begin'] = ns_to_string(begin_ns
)
451 if end_ns
is not None:
452 params
['end'] = ns_to_string(end_ns
)
454 comp_cls
= plugin
.filter_component_classes
['trimmer']
455 return self
._graph
.add_component(comp_cls
, name
, params
)
457 def _get_unique_comp_name(self
, comp_cls
):
459 comps_and_specs
= itertools
.chain(
460 self
._src
_comps
_and
_specs
, self
._flt
_comps
_and
_specs
463 if name
in [comp_and_spec
.comp
.name
for comp_and_spec
in comps_and_specs
]:
464 name
+= '-{}'.format(self
._next
_suffix
)
465 self
._next
_suffix
+= 1
469 def _create_comp(self
, comp_spec
):
470 comp_cls
= comp_spec
.component_class
471 name
= self
._get
_unique
_comp
_name
(comp_cls
)
472 comp
= self
._graph
.add_component(
473 comp_cls
, name
, comp_spec
.params
, comp_spec
.obj
, comp_spec
.logging_level
477 def _get_free_muxer_input_port(self
):
478 for port
in self
._muxer
_comp
.input_ports
.values():
479 if not port
.is_connected
:
482 def _connect_src_comp_port(self
, component
, port
):
483 # if this trace collection iterator is in stream intersection
484 # mode, we need this connection:
486 # port -> trimmer -> muxer
491 if self
._stream
_intersection
_mode
:
492 trimmer_comp
= self
._create
_stream
_intersection
_trimmer
(component
, port
)
493 self
._graph
.connect_ports(port
, trimmer_comp
.input_ports
['in'])
494 port_to_muxer
= trimmer_comp
.output_ports
['out']
498 self
._graph
.connect_ports(port_to_muxer
, self
._get
_free
_muxer
_input
_port
())
500 def _graph_port_added(self
, component
, port
):
501 if not self
._connect
_ports
:
504 if type(port
) is bt2_port
._InputPort
:
507 if component
not in [comp
.comp
for comp
in self
._src
_comps
_and
_specs
]:
508 # do not care about non-source components (muxer, trimmer, etc.)
511 self
._connect
_src
_comp
_port
(component
, port
)
513 def _get_greatest_operative_mip_version(self
):
514 def append_comp_specs_descriptors(descriptors
, comp_specs
):
515 for comp_spec
in comp_specs
:
517 bt2
.ComponentDescriptor(
518 comp_spec
.component_class
, comp_spec
.params
, comp_spec
.obj
523 append_comp_specs_descriptors(descriptors
, self
._src
_comp
_specs
)
524 append_comp_specs_descriptors(descriptors
, self
._flt
_comp
_specs
)
526 if self
._stream
_intersection
_mode
:
527 # we also need at least one `flt.utils.trimmer` component
528 comp_spec
= ComponentSpec
.from_named_plugin_and_component_class(
531 append_comp_specs_descriptors(descriptors
, [comp_spec
])
533 mip_version
= bt2
.get_greatest_operative_mip_version(descriptors
)
535 if mip_version
is None:
536 msg
= 'failed to find an operative message interchange protocol version (components are not interoperable)'
537 raise RuntimeError(msg
)
541 def _build_graph(self
):
542 self
._graph
= bt2
.Graph(self
._get
_greatest
_operative
_mip
_version
())
543 self
._graph
.add_port_added_listener(self
._graph
_port
_added
)
544 self
._muxer
_comp
= self
._create
_muxer
()
546 if self
._begin
_ns
is not None or self
._end
_ns
is not None:
547 trimmer_comp
= self
._create
_trimmer
(self
._begin
_ns
, self
._end
_ns
, 'trimmer')
548 self
._graph
.connect_ports(
549 self
._muxer
_comp
.output_ports
['out'], trimmer_comp
.input_ports
['in']
551 last_flt_out_port
= trimmer_comp
.output_ports
['out']
553 last_flt_out_port
= self
._muxer
_comp
.output_ports
['out']
555 # create extra filter components (chained)
556 for comp_spec
in self
._flt
_comp
_specs
:
557 comp
= self
._create
_comp
(comp_spec
)
558 self
._flt
_comps
_and
_specs
.append(_ComponentAndSpec(comp
, comp_spec
))
560 # connect the extra filter chain
561 for comp_and_spec
in self
._flt
_comps
_and
_specs
:
562 in_port
= list(comp_and_spec
.comp
.input_ports
.values())[0]
563 out_port
= list(comp_and_spec
.comp
.output_ports
.values())[0]
564 self
._graph
.connect_ports(last_flt_out_port
, in_port
)
565 last_flt_out_port
= out_port
567 # Here we create the components, self._graph_port_added() is
568 # called when they add ports, but the callback returns early
569 # because self._connect_ports is False. This is because the
570 # self._graph_port_added() could not find the associated source
571 # component specification in self._src_comps_and_specs because
572 # it does not exist yet (it needs the created component to
574 for comp_spec
in self
._src
_comp
_specs
:
575 comp
= self
._create
_comp
(comp_spec
)
576 self
._src
_comps
_and
_specs
.append(_ComponentAndSpec(comp
, comp_spec
))
578 # Now we connect the ports which exist at this point. We allow
579 # self._graph_port_added() to automatically connect _new_ ports.
580 self
._connect
_ports
= True
582 for comp_and_spec
in self
._src
_comps
_and
_specs
:
583 # Keep a separate list because comp_and_spec.output_ports
584 # could change during the connection of one of its ports.
585 # Any new port is handled by self._graph_port_added().
586 out_ports
= [port
for port
in comp_and_spec
.comp
.output_ports
.values()]
588 for out_port
in out_ports
:
589 if out_port
.is_connected
:
592 self
._connect
_src
_comp
_port
(comp_and_spec
.comp
, out_port
)
594 # Add the proxy sink, passing our message list to share consumed
595 # messages with this trace collection message iterator.
596 sink
= self
._graph
.add_component(
597 _TraceCollectionMessageIteratorProxySink
, 'proxy-sink', obj
=self
._msg
_list
599 sink_in_port
= sink
.input_ports
['in']
601 # connect last filter to proxy sink
602 self
._graph
.connect_ports(last_flt_out_port
, sink_in_port
)