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
25 import bt2
.notification_iterator
27 import collections
.abc
28 from collections
import namedtuple
32 # a pair of source component and _SourceComponentSpec
33 _SourceComponentAndSpec
= namedtuple('_SourceComponentAndSpec',
37 class SourceComponentSpec
:
38 def __init__(self
, plugin_name
, component_class_name
, params
=None):
39 utils
._check
_str
(plugin_name
)
40 utils
._check
_str
(component_class_name
)
41 self
._plugin
_name
= plugin_name
42 self
._component
_class
_name
= component_class_name
44 if type(params
) is str:
45 self
._params
= bt2
.create_value({'path': params
})
47 self
._params
= bt2
.create_value(params
)
50 def plugin_name(self
):
51 return self
._plugin
_name
54 def component_class_name(self
):
55 return self
._component
_class
_name
62 # datetime.datetime or integral to nanoseconds
67 if isinstance(obj
, numbers
.Real
):
68 # consider that it's already in seconds
70 elif isinstance(obj
, datetime
.datetime
):
74 raise TypeError('"{}" is not an integral number or a datetime.datetime object'.format(obj
))
79 class TraceCollectionNotificationIterator(bt2
.notification_iterator
._NotificationIterator
):
80 def __init__(self
, source_component_specs
, notification_types
=None,
81 stream_intersection_mode
=False, begin
=None,
83 utils
._check
_bool
(stream_intersection_mode
)
84 self
._stream
_intersection
_mode
= stream_intersection_mode
85 self
._begin
_ns
= _get_ns(begin
)
86 self
._end
_ns
= _get_ns(end
)
87 self
._notification
_types
= notification_types
88 self
._src
_comp
_specs
= source_component_specs
90 self
._connect
_ports
= False
92 # set of _SourceComponentAndSpec
93 self
._src
_comps
_and
_specs
= []
95 self
._validate
_source
_component
_specs
()
98 def _validate_source_component_specs(self
):
99 for source_comp_spec
in self
._src
_comp
_specs
:
100 if type(source_comp_spec
) is not SourceComponentSpec
:
101 raise TypeError('"{}" object is not a SourceComponentSpec'.format(type(source_comp_spec
)))
104 return next(self
._notif
_iter
)
106 def _create_stream_intersection_trimmer(self
, port
):
107 # find the original parameters specified by the user to create
108 # this port's component to get the `path` parameter
109 for src_comp_and_spec
in self
._src
_comps
_and
_specs
:
110 if port
.component
== src_comp_and_spec
.comp
:
111 params
= src_comp_and_spec
.spec
.params
115 path
= params
['path']
117 raise bt2
.Error('all source components must be created with a "path" parameter in stream intersection mode')
119 params
= {'path': str(path
)}
121 # query the port's component for the `trace-info` object which
122 # contains the stream intersection range for each exposed
124 query_exec
= bt2
.QueryExecutor()
125 trace_info_res
= query_exec
.query(port
.component
.component_class
,
126 'trace-info', params
)
130 # find the trace info for this port's trace by name's prefix
132 for trace_info
in trace_info_res
:
133 if port
.name
.startswith(str(trace_info
['path'])):
134 range_ns
= trace_info
['intersection-range-ns']
135 begin
= range_ns
['begin']
136 end
= range_ns
['end']
141 if begin
is None or end
is None:
142 raise bt2
.Error('cannot find stream intersection range for port "{}"'.format(port
.name
))
144 name
= 'trimmer-{}-{}'.format(port
.component
.name
, port
.name
)
145 return self
._create
_trimmer
(begin
, end
, name
)
147 def _create_muxer(self
):
148 plugin
= bt2
.find_plugin('utils')
151 raise bt2
.Error('cannot find "utils" plugin (needed for the muxer)')
153 if 'muxer' not in plugin
.filter_component_classes
:
154 raise bt2
.Error('cannot find "muxer" filter component class in "utils" plugin')
156 comp_cls
= plugin
.filter_component_classes
['muxer']
157 return self
._graph
.add_component(comp_cls
, 'muxer')
159 def _create_trimmer(self
, begin
, end
, name
):
160 plugin
= bt2
.find_plugin('utils')
163 raise bt2
.Error('cannot find "utils" plugin (needed for the trimmer)')
165 if 'trimmer' not in plugin
.filter_component_classes
:
166 raise bt2
.Error('cannot find "trimmer" filter component class in "utils" plugin')
170 if begin
is not None:
171 params
['begin'] = begin
176 comp_cls
= plugin
.filter_component_classes
['trimmer']
177 return self
._graph
.add_component(comp_cls
, name
, params
)
179 def _get_unique_src_comp_name(self
, comp_spec
):
180 name
= '{}-{}'.format(comp_spec
.plugin_name
,
181 comp_spec
.component_class_name
)
183 if name
in [comp_and_spec
.comp
.name
for comp_and_spec
in self
._src
_comps
_and
_specs
]:
184 name
+= '-{}'.format(self
._next
_suffix
)
185 self
._next
_suffix
+= 1
189 def _create_src_comp(self
, comp_spec
):
190 plugin
= bt2
.find_plugin(comp_spec
.plugin_name
)
193 raise bt2
.Error('no such plugin: {}'.format(comp_spec
.plugin_name
))
195 if comp_spec
.component_class_name
not in plugin
.source_component_classes
:
196 raise bt2
.Error('no such source component class in "{}" plugin: {}'.format(comp_spec
.plugin_name
,
197 comp_spec
.component_class_name
))
199 comp_cls
= plugin
.source_component_classes
[comp_spec
.component_class_name
]
200 name
= self
._get
_unique
_src
_comp
_name
(comp_spec
)
201 comp
= self
._graph
.add_component(comp_cls
, name
, comp_spec
.params
)
204 def _get_free_muxer_input_port(self
):
205 for port
in self
._muxer
_comp
.input_ports
.values():
206 if not port
.is_connected
:
209 def _connect_src_comp_port(self
, port
):
210 # if this trace collection iterator is in stream intersection
211 # mode, we need this connection:
213 # port -> trimmer -> muxer
218 if self
._stream
_intersection
_mode
:
219 trimmer_comp
= self
._create
_stream
_intersection
_trimmer
(port
)
220 self
._graph
.connect_ports(port
, trimmer_comp
.input_ports
['in'])
221 port_to_muxer
= trimmer_comp
.output_ports
['out']
225 self
._graph
.connect_ports(port_to_muxer
, self
._get
_free
_muxer
_input
_port
())
227 def _graph_port_added(self
, port
):
228 if not self
._connect
_ports
:
231 if type(port
) is bt2
._InputPort
:
234 if port
.component
not in [comp
.comp
for comp
in self
._src
_comps
_and
_specs
]:
235 # do not care about non-source components (muxer, trimmer, etc.)
238 self
._connect
_src
_comp
_port
(port
)
240 def _build_graph(self
):
241 self
._graph
= bt2
.Graph()
242 self
._graph
.add_listener(bt2
.GraphListenerType
.PORT_ADDED
,
243 self
._graph
_port
_added
)
244 self
._muxer
_comp
= self
._create
_muxer
()
246 if self
._begin
_ns
is not None or self
._end
_ns
is not None:
247 trimmer_comp
= self
._create
_trimmer
(self
._begin
_ns
,
248 self
._end
_ns
, 'trimmer')
249 self
._graph
.connect_ports(self
._muxer
_comp
.output_ports
['out'],
250 trimmer_comp
.input_ports
['in'])
251 notif_iter_port
= trimmer_comp
.output_ports
['out']
253 notif_iter_port
= self
._muxer
_comp
.output_ports
['out']
255 # Here we create the components, self._graph_port_added() is
256 # called when they add ports, but the callback returns early
257 # because self._connect_ports is False. This is because the
258 # self._graph_port_added() could not find the associated source
259 # component specification in self._src_comps_and_specs because
260 # it does not exist yet (it needs the created component to
262 for comp_spec
in self
._src
_comp
_specs
:
263 comp
= self
._create
_src
_comp
(comp_spec
)
264 self
._src
_comps
_and
_specs
.append(_SourceComponentAndSpec(comp
, comp_spec
))
266 # Now we connect the ports which exist at this point. We allow
267 # self._graph_port_added() to automatically connect _new_ ports.
268 self
._connect
_ports
= True
270 for comp_and_spec
in self
._src
_comps
_and
_specs
:
271 # Keep a separate list because comp_and_spec.output_ports
272 # could change during the connection of one of its ports.
273 # Any new port is handled by self._graph_port_added().
274 out_ports
= [port
for port
in comp_and_spec
.comp
.output_ports
.values()]
276 for out_port
in out_ports
:
277 if not out_port
.component
or out_port
.is_connected
:
280 self
._connect
_src
_comp
_port
(out_port
)
282 # create this trace collection iterator's notification iterator
283 self
._notif
_iter
= notif_iter_port
.create_notification_iterator(self
._notification
_types
)
This page took 0.036484 seconds and 5 git commands to generate.