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
26 import bt2
.message_iterator
28 from collections
import namedtuple
32 # a pair of component and ComponentSpec
33 _ComponentAndSpec
= namedtuple('_ComponentAndSpec', ['comp', 'spec'])
42 logging_level
=bt2
.logging
.LoggingLevel
.NONE
,
44 utils
._check
_str
(plugin_name
)
45 utils
._check
_str
(class_name
)
46 utils
._check
_log
_level
(logging_level
)
47 self
._plugin
_name
= plugin_name
48 self
._class
_name
= class_name
49 self
._logging
_level
= logging_level
51 if type(params
) is str:
52 self
._params
= bt2
.create_value({'inputs': [params
]})
54 self
._params
= bt2
.create_value(params
)
57 def plugin_name(self
):
58 return self
._plugin
_name
62 return self
._class
_name
65 def logging_level(self
):
66 return self
._logging
_level
73 # datetime.datetime or integral to nanoseconds
78 if isinstance(obj
, numbers
.Real
):
79 # consider that it's already in seconds
81 elif isinstance(obj
, datetime
.datetime
):
86 '"{}" is not an integral number or a datetime.datetime object'.format(obj
)
97 class TraceCollectionMessageIterator(bt2
.message_iterator
._MessageIterator
):
100 source_component_specs
,
101 filter_component_specs
=None,
102 stream_intersection_mode
=False,
106 utils
._check
_bool
(stream_intersection_mode
)
107 self
._stream
_intersection
_mode
= stream_intersection_mode
108 self
._begin
_ns
= _get_ns(begin
)
109 self
._end
_ns
= _get_ns(end
)
111 if type(source_component_specs
) is ComponentSpec
:
112 source_component_specs
= [source_component_specs
]
114 if type(filter_component_specs
) is ComponentSpec
:
115 filter_component_specs
= [filter_component_specs
]
116 elif filter_component_specs
is None:
117 filter_component_specs
= []
119 self
._src
_comp
_specs
= source_component_specs
120 self
._flt
_comp
_specs
= filter_component_specs
121 self
._next
_suffix
= 1
122 self
._connect
_ports
= False
124 # lists of _ComponentAndSpec
125 self
._src
_comps
_and
_specs
= []
126 self
._flt
_comps
_and
_specs
= []
128 self
._validate
_component
_specs
(source_component_specs
)
129 self
._validate
_component
_specs
(filter_component_specs
)
132 def _validate_component_specs(self
, comp_specs
):
133 for comp_spec
in comp_specs
:
134 if type(comp_spec
) is not ComponentSpec
:
136 '"{}" object is not a ComponentSpec'.format(type(comp_spec
))
140 return next(self
._msg
_iter
)
142 def _create_stream_intersection_trimmer(self
, component
, port
):
143 # find the original parameters specified by the user to create
144 # this port's component to get the `inputs` parameter
145 for src_comp_and_spec
in self
._src
_comps
_and
_specs
:
146 if component
== src_comp_and_spec
.comp
:
150 inputs
= src_comp_and_spec
.spec
.params
['inputs']
151 except Exception as e
:
153 'all source components must be created with an "inputs" parameter in stream intersection mode'
156 params
= {'inputs': inputs
}
158 # query the port's component for the `trace-info` object which
159 # contains the stream intersection range for each exposed
161 query_exec
= bt2
.QueryExecutor()
162 trace_info_res
= query_exec
.query(
163 src_comp_and_spec
.comp
.cls
, 'trace-info', params
168 # find the trace info for this port's trace
170 for trace_info
in trace_info_res
:
171 for stream
in trace_info
['streams']:
172 if stream
['port-name'] == port
.name
:
173 range_ns
= trace_info
['intersection-range-ns']
174 begin
= range_ns
['begin']
175 end
= range_ns
['end']
180 if begin
is None or end
is None:
182 'cannot find stream intersection range for port "{}"'.format(port
.name
)
185 name
= 'trimmer-{}-{}'.format(src_comp_and_spec
.comp
.name
, port
.name
)
186 return self
._create
_trimmer
(begin
, end
, name
)
188 def _create_muxer(self
):
189 plugin
= bt2
.find_plugin('utils')
192 raise RuntimeError('cannot find "utils" plugin (needed for the muxer)')
194 if 'muxer' not in plugin
.filter_component_classes
:
196 'cannot find "muxer" filter component class in "utils" plugin'
199 comp_cls
= plugin
.filter_component_classes
['muxer']
200 return self
._graph
.add_component(comp_cls
, 'muxer')
202 def _create_trimmer(self
, begin_ns
, end_ns
, name
):
203 plugin
= bt2
.find_plugin('utils')
206 raise RuntimeError('cannot find "utils" plugin (needed for the trimmer)')
208 if 'trimmer' not in plugin
.filter_component_classes
:
210 'cannot find "trimmer" filter component class in "utils" plugin'
215 def ns_to_string(ns
):
216 s_part
= ns
// 1000000000
217 ns_part
= ns
% 1000000000
218 return '{}.{:09d}'.format(s_part
, ns_part
)
220 if begin_ns
is not None:
221 params
['begin'] = ns_to_string(begin_ns
)
223 if end_ns
is not None:
224 params
['end'] = ns_to_string(end_ns
)
226 comp_cls
= plugin
.filter_component_classes
['trimmer']
227 return self
._graph
.add_component(comp_cls
, name
, params
)
229 def _get_unique_comp_name(self
, comp_spec
):
230 name
= '{}-{}'.format(comp_spec
.plugin_name
, comp_spec
.class_name
)
231 comps_and_specs
= itertools
.chain(
232 self
._src
_comps
_and
_specs
, self
._flt
_comps
_and
_specs
235 if name
in [comp_and_spec
.comp
.name
for comp_and_spec
in comps_and_specs
]:
236 name
+= '-{}'.format(self
._next
_suffix
)
237 self
._next
_suffix
+= 1
241 def _create_comp(self
, comp_spec
, comp_cls_type
):
242 plugin
= bt2
.find_plugin(comp_spec
.plugin_name
)
245 raise ValueError('no such plugin: {}'.format(comp_spec
.plugin_name
))
247 if comp_cls_type
== _CompClsType
.SOURCE
:
248 comp_classes
= plugin
.source_component_classes
250 comp_classes
= plugin
.filter_component_classes
252 if comp_spec
.class_name
not in comp_classes
:
253 cc_type
= 'source' if comp_cls_type
== _CompClsType
.SOURCE
else 'filter'
255 'no such {} component class in "{}" plugin: {}'.format(
256 cc_type
, comp_spec
.plugin_name
, comp_spec
.class_name
260 comp_cls
= comp_classes
[comp_spec
.class_name
]
261 name
= self
._get
_unique
_comp
_name
(comp_spec
)
262 comp
= self
._graph
.add_component(
263 comp_cls
, name
, comp_spec
.params
, comp_spec
.logging_level
267 def _get_free_muxer_input_port(self
):
268 for port
in self
._muxer
_comp
.input_ports
.values():
269 if not port
.is_connected
:
272 def _connect_src_comp_port(self
, component
, port
):
273 # if this trace collection iterator is in stream intersection
274 # mode, we need this connection:
276 # port -> trimmer -> muxer
281 if self
._stream
_intersection
_mode
:
282 trimmer_comp
= self
._create
_stream
_intersection
_trimmer
(component
, port
)
283 self
._graph
.connect_ports(port
, trimmer_comp
.input_ports
['in'])
284 port_to_muxer
= trimmer_comp
.output_ports
['out']
288 self
._graph
.connect_ports(port_to_muxer
, self
._get
_free
_muxer
_input
_port
())
290 def _graph_port_added(self
, component
, port
):
291 if not self
._connect
_ports
:
294 if type(port
) is bt2
.port
._InputPort
:
297 if component
not in [comp
.comp
for comp
in self
._src
_comps
_and
_specs
]:
298 # do not care about non-source components (muxer, trimmer, etc.)
301 self
._connect
_src
_comp
_port
(component
, port
)
303 def _build_graph(self
):
304 self
._graph
= bt2
.Graph()
305 self
._graph
.add_port_added_listener(self
._graph
_port
_added
)
306 self
._muxer
_comp
= self
._create
_muxer
()
308 if self
._begin
_ns
is not None or self
._end
_ns
is not None:
309 trimmer_comp
= self
._create
_trimmer
(self
._begin
_ns
, self
._end
_ns
, 'trimmer')
310 self
._graph
.connect_ports(
311 self
._muxer
_comp
.output_ports
['out'], trimmer_comp
.input_ports
['in']
313 msg_iter_port
= trimmer_comp
.output_ports
['out']
315 msg_iter_port
= self
._muxer
_comp
.output_ports
['out']
317 # create extra filter components (chained)
318 for comp_spec
in self
._flt
_comp
_specs
:
319 comp
= self
._create
_comp
(comp_spec
, _CompClsType
.FILTER
)
320 self
._flt
_comps
_and
_specs
.append(_ComponentAndSpec(comp
, comp_spec
))
322 # connect the extra filter chain
323 for comp_and_spec
in self
._flt
_comps
_and
_specs
:
324 in_port
= list(comp_and_spec
.comp
.input_ports
.values())[0]
325 out_port
= list(comp_and_spec
.comp
.output_ports
.values())[0]
326 self
._graph
.connect_ports(msg_iter_port
, in_port
)
327 msg_iter_port
= out_port
329 # Here we create the components, self._graph_port_added() is
330 # called when they add ports, but the callback returns early
331 # because self._connect_ports is False. This is because the
332 # self._graph_port_added() could not find the associated source
333 # component specification in self._src_comps_and_specs because
334 # it does not exist yet (it needs the created component to
336 for comp_spec
in self
._src
_comp
_specs
:
337 comp
= self
._create
_comp
(comp_spec
, _CompClsType
.SOURCE
)
338 self
._src
_comps
_and
_specs
.append(_ComponentAndSpec(comp
, comp_spec
))
340 # Now we connect the ports which exist at this point. We allow
341 # self._graph_port_added() to automatically connect _new_ ports.
342 self
._connect
_ports
= True
344 for comp_and_spec
in self
._src
_comps
_and
_specs
:
345 # Keep a separate list because comp_and_spec.output_ports
346 # could change during the connection of one of its ports.
347 # Any new port is handled by self._graph_port_added().
348 out_ports
= [port
for port
in comp_and_spec
.comp
.output_ports
.values()]
350 for out_port
in out_ports
:
351 if out_port
.is_connected
:
354 self
._connect
_src
_comp
_port
(comp_and_spec
.comp
, out_port
)
356 # create this trace collection iterator's message iterator
357 self
._msg
_iter
= self
._graph
.create_output_port_message_iterator(msg_iter_port
)
This page took 0.036952 seconds and 4 git commands to generate.