10b555f18f6953bf0ee59370dda106c8ca26a194
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'])
37 def __init__(self
, plugin_name
, class_name
, params
=None):
38 utils
._check
_str
(plugin_name
)
39 utils
._check
_str
(class_name
)
40 self
._plugin
_name
= plugin_name
41 self
._class
_name
= class_name
43 if type(params
) is str:
44 self
._params
= bt2
.create_value({'paths': [params
]})
46 self
._params
= bt2
.create_value(params
)
49 def plugin_name(self
):
50 return self
._plugin
_name
54 return self
._class
_name
61 # datetime.datetime or integral to nanoseconds
66 if isinstance(obj
, numbers
.Real
):
67 # consider that it's already in seconds
69 elif isinstance(obj
, datetime
.datetime
):
73 raise TypeError('"{}" is not an integral number or a datetime.datetime object'.format(obj
))
83 class TraceCollectionMessageIterator(bt2
.message_iterator
._MessageIterator
):
84 def __init__(self
, source_component_specs
, filter_component_specs
=None,
85 stream_intersection_mode
=False, begin
=None, end
=None):
86 utils
._check
_bool
(stream_intersection_mode
)
87 self
._stream
_intersection
_mode
= stream_intersection_mode
88 self
._begin
_ns
= _get_ns(begin
)
89 self
._end
_ns
= _get_ns(end
)
91 if type(source_component_specs
) is ComponentSpec
:
92 source_component_specs
= [source_component_specs
]
94 if type(filter_component_specs
) is ComponentSpec
:
95 filter_component_specs
= [filter_component_specs
]
96 elif filter_component_specs
is None:
97 filter_component_specs
= []
99 self
._src
_comp
_specs
= source_component_specs
100 self
._flt
_comp
_specs
= filter_component_specs
101 self
._next
_suffix
= 1
102 self
._connect
_ports
= False
104 # lists of _ComponentAndSpec
105 self
._src
_comps
_and
_specs
= []
106 self
._flt
_comps
_and
_specs
= []
108 self
._validate
_component
_specs
(source_component_specs
)
109 self
._validate
_component
_specs
(filter_component_specs
)
112 def _validate_component_specs(self
, comp_specs
):
113 for comp_spec
in comp_specs
:
114 if type(comp_spec
) is not ComponentSpec
:
115 raise TypeError('"{}" object is not a ComponentSpec'.format(type(comp_spec
)))
118 return next(self
._msg
_iter
)
120 def _create_stream_intersection_trimmer(self
, component
, port
):
121 # find the original parameters specified by the user to create
122 # this port's component to get the `path` parameter
123 for src_comp_and_spec
in self
._src
_comps
_and
_specs
:
124 if component
== src_comp_and_spec
.comp
:
128 paths
= src_comp_and_spec
.spec
.params
['paths']
129 except Exception as e
:
130 raise bt2
.Error('all source components must be created with a "paths" parameter in stream intersection mode') from e
132 params
= {'paths': paths
}
134 # query the port's component for the `trace-info` object which
135 # contains the stream intersection range for each exposed
137 query_exec
= bt2
.QueryExecutor()
138 trace_info_res
= query_exec
.query(src_comp_and_spec
.comp
.cls
,
139 'trace-info', params
)
143 # find the trace info for this port's trace
145 for trace_info
in trace_info_res
:
146 for stream
in trace_info
['streams']:
147 if stream
['port-name'] == port
.name
:
148 range_ns
= trace_info
['intersection-range-ns']
149 begin
= range_ns
['begin']
150 end
= range_ns
['end']
155 if begin
is None or end
is None:
156 raise bt2
.Error('cannot find stream intersection range for port "{}"'.format(port
.name
))
158 name
= 'trimmer-{}-{}'.format(src_comp_and_spec
.comp
.name
, port
.name
)
159 return self
._create
_trimmer
(begin
, end
, name
)
161 def _create_muxer(self
):
162 plugin
= bt2
.find_plugin('utils')
165 raise bt2
.Error('cannot find "utils" plugin (needed for the muxer)')
167 if 'muxer' not in plugin
.filter_component_classes
:
168 raise bt2
.Error('cannot find "muxer" filter component class in "utils" plugin')
170 comp_cls
= plugin
.filter_component_classes
['muxer']
171 return self
._graph
.add_component(comp_cls
, 'muxer')
173 def _create_trimmer(self
, begin_ns
, end_ns
, name
):
174 plugin
= bt2
.find_plugin('utils')
177 raise bt2
.Error('cannot find "utils" plugin (needed for the trimmer)')
179 if 'trimmer' not in plugin
.filter_component_classes
:
180 raise bt2
.Error('cannot find "trimmer" filter component class in "utils" plugin')
184 def ns_to_string(ns
):
185 s_part
= ns
// 1000000000
186 ns_part
= ns
% 1000000000
187 return '{}.{:09d}'.format(s_part
, ns_part
)
189 if begin_ns
is not None:
190 params
['begin'] = ns_to_string(begin_ns
)
192 if end_ns
is not None:
193 params
['end'] = ns_to_string(end_ns
)
195 comp_cls
= plugin
.filter_component_classes
['trimmer']
196 return self
._graph
.add_component(comp_cls
, name
, params
)
198 def _get_unique_comp_name(self
, comp_spec
):
199 name
= '{}-{}'.format(comp_spec
.plugin_name
,
200 comp_spec
.class_name
)
201 comps_and_specs
= itertools
.chain(self
._src
_comps
_and
_specs
,
202 self
._flt
_comps
_and
_specs
)
204 if name
in [comp_and_spec
.comp
.name
for comp_and_spec
in comps_and_specs
]:
205 name
+= '-{}'.format(self
._next
_suffix
)
206 self
._next
_suffix
+= 1
210 def _create_comp(self
, comp_spec
, comp_cls_type
):
211 plugin
= bt2
.find_plugin(comp_spec
.plugin_name
)
214 raise bt2
.Error('no such plugin: {}'.format(comp_spec
.plugin_name
))
216 if comp_cls_type
== _CompClsType
.SOURCE
:
217 comp_classes
= plugin
.source_component_classes
219 comp_classes
= plugin
.filter_component_classes
221 if comp_spec
.class_name
not in comp_classes
:
222 cc_type
= 'source' if comp_cls_type
== _CompClsType
.SOURCE
else 'filter'
223 raise bt2
.Error('no such {} component class in "{}" plugin: {}'.format(cc_type
,
224 comp_spec
.plugin_name
,
225 comp_spec
.class_name
))
227 comp_cls
= comp_classes
[comp_spec
.class_name
]
228 name
= self
._get
_unique
_comp
_name
(comp_spec
)
229 comp
= self
._graph
.add_component(comp_cls
, name
, comp_spec
.params
)
232 def _get_free_muxer_input_port(self
):
233 for port
in self
._muxer
_comp
.input_ports
.values():
234 if not port
.is_connected
:
237 def _connect_src_comp_port(self
, component
, port
):
238 # if this trace collection iterator is in stream intersection
239 # mode, we need this connection:
241 # port -> trimmer -> muxer
246 if self
._stream
_intersection
_mode
:
247 trimmer_comp
= self
._create
_stream
_intersection
_trimmer
(component
, port
)
248 self
._graph
.connect_ports(port
, trimmer_comp
.input_ports
['in'])
249 port_to_muxer
= trimmer_comp
.output_ports
['out']
253 self
._graph
.connect_ports(port_to_muxer
, self
._get
_free
_muxer
_input
_port
())
255 def _graph_port_added(self
, component
, port
):
256 if not self
._connect
_ports
:
259 if type(port
) is bt2
.port
._InputPort
:
262 if component
not in [comp
.comp
for comp
in self
._src
_comps
_and
_specs
]:
263 # do not care about non-source components (muxer, trimmer, etc.)
266 self
._connect
_src
_comp
_port
(component
, port
)
268 def _build_graph(self
):
269 self
._graph
= bt2
.Graph()
270 self
._graph
.add_port_added_listener(self
._graph
_port
_added
)
271 self
._muxer
_comp
= self
._create
_muxer
()
273 if self
._begin
_ns
is not None or self
._end
_ns
is not None:
274 trimmer_comp
= self
._create
_trimmer
(self
._begin
_ns
,
275 self
._end
_ns
, 'trimmer')
276 self
._graph
.connect_ports(self
._muxer
_comp
.output_ports
['out'],
277 trimmer_comp
.input_ports
['in'])
278 msg_iter_port
= trimmer_comp
.output_ports
['out']
280 msg_iter_port
= self
._muxer
_comp
.output_ports
['out']
282 # create extra filter components (chained)
283 for comp_spec
in self
._flt
_comp
_specs
:
284 comp
= self
._create
_comp
(comp_spec
, _CompClsType
.FILTER
)
285 self
._flt
_comps
_and
_specs
.append(_ComponentAndSpec(comp
, comp_spec
))
287 # connect the extra filter chain
288 for comp_and_spec
in self
._flt
_comps
_and
_specs
:
289 in_port
= list(comp_and_spec
.comp
.input_ports
.values())[0]
290 out_port
= list(comp_and_spec
.comp
.output_ports
.values())[0]
291 self
._graph
.connect_ports(msg_iter_port
, in_port
)
292 msg_iter_port
= out_port
294 # Here we create the components, self._graph_port_added() is
295 # called when they add ports, but the callback returns early
296 # because self._connect_ports is False. This is because the
297 # self._graph_port_added() could not find the associated source
298 # component specification in self._src_comps_and_specs because
299 # it does not exist yet (it needs the created component to
301 for comp_spec
in self
._src
_comp
_specs
:
302 comp
= self
._create
_comp
(comp_spec
, _CompClsType
.SOURCE
)
303 self
._src
_comps
_and
_specs
.append(_ComponentAndSpec(comp
, comp_spec
))
305 # Now we connect the ports which exist at this point. We allow
306 # self._graph_port_added() to automatically connect _new_ ports.
307 self
._connect
_ports
= True
309 for comp_and_spec
in self
._src
_comps
_and
_specs
:
310 # Keep a separate list because comp_and_spec.output_ports
311 # could change during the connection of one of its ports.
312 # Any new port is handled by self._graph_port_added().
313 out_ports
= [port
for port
in comp_and_spec
.comp
.output_ports
.values()]
315 for out_port
in out_ports
:
316 if out_port
.is_connected
:
319 self
._connect
_src
_comp
_port
(comp_and_spec
.comp
, out_port
)
321 # create this trace collection iterator's message iterator
322 self
._msg
_iter
= self
._graph
.create_output_port_message_iterator(msg_iter_port
)
This page took 0.051195 seconds and 4 git commands to generate.