Commit | Line | Data |
---|---|---|
0bee8ea9 SM |
1 | # The MIT License (MIT) |
2 | # | |
3 | # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com> | |
4 | # Copyright (c) 2018 Francis Deslauriers <francis.deslauriers@efficios.com> | |
5 | # Copyright (c) 2019 Simon Marchi <simon.marchi@efficios.com> | |
6 | # | |
7 | # Permission is hereby granted, free of charge, to any person obtaining a copy | |
8 | # of this software and associated documentation files (the "Software"), to deal | |
9 | # in the Software without restriction, including without limitation the rights | |
10 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | # copies of the Software, and to permit persons to whom the Software is | |
12 | # furnished to do so, subject to the following conditions: | |
13 | # | |
14 | # The above copyright notice and this permission notice shall be included in | |
15 | # all copies or substantial portions of the Software. | |
16 | # | |
17 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
20 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | |
23 | # THE SOFTWARE. | |
24 | ||
78668ecd | 25 | __all__ = ['_TraceClass'] |
0bee8ea9 SM |
26 | |
27 | import bt2 | |
28 | from bt2 import native_bt, utils, object | |
c946c9de PP |
29 | from bt2 import stream_class as bt2_stream_class |
30 | from bt2 import field_class as bt2_field_class | |
31 | from bt2 import trace as bt2_trace | |
32 | from bt2 import trace_class as bt2_trace_class | |
0bee8ea9 SM |
33 | import collections.abc |
34 | import functools | |
35 | ||
36 | ||
0bee8ea9 | 37 | def _trace_class_destruction_listener_from_native(user_listener, trace_class_ptr): |
c946c9de | 38 | trace_class = bt2_trace_class._TraceClass._create_from_ptr_and_get_ref( |
61d96b89 FD |
39 | trace_class_ptr |
40 | ) | |
0bee8ea9 SM |
41 | user_listener(trace_class) |
42 | ||
43 | ||
78668ecd | 44 | class _TraceClass(object._SharedObject, collections.abc.Mapping): |
0bee8ea9 SM |
45 | _get_ref = staticmethod(native_bt.trace_class_get_ref) |
46 | _put_ref = staticmethod(native_bt.trace_class_put_ref) | |
47 | ||
f377a958 SM |
48 | # Instantiate a trace of this class. |
49 | ||
cd03c43c | 50 | def __call__(self, name=None, uuid=None, env=None): |
f377a958 SM |
51 | trace_ptr = native_bt.trace_create(self._ptr) |
52 | ||
53 | if trace_ptr is None: | |
614743a5 | 54 | raise bt2._MemoryError('cannot create trace class object') |
f377a958 | 55 | |
c946c9de | 56 | trace = bt2_trace._Trace._create_from_ptr(trace_ptr) |
f377a958 SM |
57 | |
58 | if name is not None: | |
59 | trace._name = name | |
60 | ||
cd03c43c PP |
61 | if uuid is not None: |
62 | trace._uuid = uuid | |
63 | ||
64 | if env is not None: | |
65 | for key, value in env.items(): | |
66 | trace.env[key] = value | |
67 | ||
f377a958 SM |
68 | return trace |
69 | ||
0bee8ea9 SM |
70 | # Number of stream classes in this trace class. |
71 | ||
72 | def __len__(self): | |
73 | count = native_bt.trace_class_get_stream_class_count(self._ptr) | |
74 | assert count >= 0 | |
75 | return count | |
76 | ||
77 | # Get a stream class by stream id. | |
78 | ||
79 | def __getitem__(self, key): | |
80 | utils._check_uint64(key) | |
81 | ||
82 | sc_ptr = native_bt.trace_class_borrow_stream_class_by_id_const(self._ptr, key) | |
83 | if sc_ptr is None: | |
84 | raise KeyError(key) | |
85 | ||
c946c9de | 86 | return bt2_stream_class._StreamClass._create_from_ptr_and_get_ref(sc_ptr) |
0bee8ea9 SM |
87 | |
88 | def __iter__(self): | |
89 | for idx in range(len(self)): | |
61d96b89 FD |
90 | sc_ptr = native_bt.trace_class_borrow_stream_class_by_index_const( |
91 | self._ptr, idx | |
92 | ) | |
0bee8ea9 SM |
93 | assert sc_ptr is not None |
94 | ||
95 | id = native_bt.stream_class_get_id(sc_ptr) | |
96 | assert id >= 0 | |
97 | ||
98 | yield id | |
99 | ||
61d96b89 FD |
100 | def create_stream_class( |
101 | self, | |
102 | id=None, | |
103 | name=None, | |
104 | packet_context_field_class=None, | |
105 | event_common_context_field_class=None, | |
106 | default_clock_class=None, | |
107 | assigns_automatic_event_class_id=True, | |
108 | assigns_automatic_stream_id=True, | |
109 | supports_packets=False, | |
110 | packets_have_beginning_default_clock_snapshot=False, | |
111 | packets_have_end_default_clock_snapshot=False, | |
112 | supports_discarded_events=False, | |
113 | discarded_events_have_default_clock_snapshots=False, | |
114 | supports_discarded_packets=False, | |
115 | discarded_packets_have_default_clock_snapshots=False, | |
116 | ): | |
0bee8ea9 SM |
117 | |
118 | if self.assigns_automatic_stream_class_id: | |
119 | if id is not None: | |
61d96b89 FD |
120 | raise ValueError( |
121 | 'id provided, but trace class assigns automatic stream class ids' | |
122 | ) | |
0bee8ea9 SM |
123 | |
124 | sc_ptr = native_bt.stream_class_create(self._ptr) | |
125 | else: | |
126 | if id is None: | |
61d96b89 FD |
127 | raise ValueError( |
128 | 'id not provided, but trace class does not assign automatic stream class ids' | |
129 | ) | |
0bee8ea9 SM |
130 | |
131 | utils._check_uint64(id) | |
132 | sc_ptr = native_bt.stream_class_create_with_id(self._ptr, id) | |
133 | ||
c946c9de | 134 | sc = bt2_stream_class._StreamClass._create_from_ptr(sc_ptr) |
f377a958 | 135 | |
060aee52 SM |
136 | if name is not None: |
137 | sc._name = name | |
138 | ||
060aee52 SM |
139 | if event_common_context_field_class is not None: |
140 | sc._event_common_context_field_class = event_common_context_field_class | |
141 | ||
142 | if default_clock_class is not None: | |
143 | sc._default_clock_class = default_clock_class | |
144 | ||
37a93d41 PP |
145 | # call after `sc._default_clock_class` because, if |
146 | # `packets_have_beginning_default_clock_snapshot` or | |
147 | # `packets_have_end_default_clock_snapshot` is true, then this | |
148 | # stream class needs a default clock class already. | |
61d96b89 FD |
149 | sc._set_supports_packets( |
150 | supports_packets, | |
151 | packets_have_beginning_default_clock_snapshot, | |
152 | packets_have_end_default_clock_snapshot, | |
153 | ) | |
37a93d41 PP |
154 | |
155 | # call after sc._set_supports_packets() because, if | |
156 | # `packet_context_field_class` is not `None`, then this stream | |
157 | # class needs to support packets already. | |
158 | if packet_context_field_class is not None: | |
159 | sc._packet_context_field_class = packet_context_field_class | |
160 | ||
060aee52 | 161 | sc._assigns_automatic_event_class_id = assigns_automatic_event_class_id |
f377a958 | 162 | sc._assigns_automatic_stream_id = assigns_automatic_stream_id |
61d96b89 FD |
163 | sc._set_supports_discarded_events( |
164 | supports_discarded_events, discarded_events_have_default_clock_snapshots | |
165 | ) | |
166 | sc._set_supports_discarded_packets( | |
167 | supports_discarded_packets, discarded_packets_have_default_clock_snapshots | |
168 | ) | |
f377a958 | 169 | return sc |
0bee8ea9 SM |
170 | |
171 | @property | |
172 | def assigns_automatic_stream_class_id(self): | |
173 | return native_bt.trace_class_assigns_automatic_stream_class_id(self._ptr) | |
174 | ||
175 | def _assigns_automatic_stream_class_id(self, auto_id): | |
176 | utils._check_bool(auto_id) | |
61d96b89 FD |
177 | return native_bt.trace_class_set_assigns_automatic_stream_class_id( |
178 | self._ptr, auto_id | |
179 | ) | |
0bee8ea9 | 180 | |
61d96b89 FD |
181 | _assigns_automatic_stream_class_id = property( |
182 | fset=_assigns_automatic_stream_class_id | |
183 | ) | |
0bee8ea9 | 184 | |
060aee52 SM |
185 | # Field class creation methods. |
186 | ||
187 | def _check_create_status(self, ptr, type_name): | |
188 | if ptr is None: | |
614743a5 | 189 | raise bt2._MemoryError('cannot create {} field class'.format(type_name)) |
060aee52 | 190 | |
61d96b89 FD |
191 | def _create_integer_field_class( |
192 | self, create_func, py_cls, type_name, field_value_range, preferred_display_base | |
193 | ): | |
a728f6c3 SM |
194 | field_class_ptr = create_func(self._ptr) |
195 | self._check_create_status(field_class_ptr, type_name) | |
196 | ||
197 | field_class = py_cls._create_from_ptr(field_class_ptr) | |
198 | ||
c8820b76 SM |
199 | if field_value_range is not None: |
200 | field_class._field_value_range = field_value_range | |
a728f6c3 | 201 | |
c8820b76 SM |
202 | if preferred_display_base is not None: |
203 | field_class._preferred_display_base = preferred_display_base | |
a728f6c3 SM |
204 | |
205 | return field_class | |
206 | ||
61d96b89 FD |
207 | def create_signed_integer_field_class( |
208 | self, field_value_range=None, preferred_display_base=None | |
209 | ): | |
210 | return self._create_integer_field_class( | |
60bbfc7c | 211 | native_bt.field_class_integer_signed_create, |
c946c9de | 212 | bt2_field_class._SignedIntegerFieldClass, |
61d96b89 FD |
213 | 'signed integer', |
214 | field_value_range, | |
215 | preferred_display_base, | |
216 | ) | |
217 | ||
218 | def create_unsigned_integer_field_class( | |
219 | self, field_value_range=None, preferred_display_base=None | |
220 | ): | |
221 | return self._create_integer_field_class( | |
60bbfc7c | 222 | native_bt.field_class_integer_unsigned_create, |
c946c9de | 223 | bt2_field_class._UnsignedIntegerFieldClass, |
61d96b89 FD |
224 | 'unsigned integer', |
225 | field_value_range, | |
226 | preferred_display_base, | |
227 | ) | |
228 | ||
229 | def create_signed_enumeration_field_class( | |
230 | self, field_value_range=None, preferred_display_base=None | |
231 | ): | |
232 | return self._create_integer_field_class( | |
60bbfc7c | 233 | native_bt.field_class_enumeration_signed_create, |
c946c9de | 234 | bt2_field_class._SignedEnumerationFieldClass, |
61d96b89 FD |
235 | 'signed enumeration', |
236 | field_value_range, | |
237 | preferred_display_base, | |
238 | ) | |
239 | ||
240 | def create_unsigned_enumeration_field_class( | |
241 | self, field_value_range=None, preferred_display_base=None | |
242 | ): | |
243 | return self._create_integer_field_class( | |
60bbfc7c | 244 | native_bt.field_class_enumeration_unsigned_create, |
c946c9de | 245 | bt2_field_class._UnsignedEnumerationFieldClass, |
61d96b89 FD |
246 | 'unsigned enumeration', |
247 | field_value_range, | |
248 | preferred_display_base, | |
249 | ) | |
27d97a3f SM |
250 | |
251 | def create_real_field_class(self, is_single_precision=False): | |
252 | field_class_ptr = native_bt.field_class_real_create(self._ptr) | |
253 | self._check_create_status(field_class_ptr, 'real') | |
254 | ||
c946c9de | 255 | field_class = bt2_field_class._RealFieldClass._create_from_ptr(field_class_ptr) |
27d97a3f | 256 | |
c8820b76 | 257 | field_class._is_single_precision = is_single_precision |
27d97a3f SM |
258 | |
259 | return field_class | |
260 | ||
060aee52 SM |
261 | def create_structure_field_class(self): |
262 | field_class_ptr = native_bt.field_class_structure_create(self._ptr) | |
263 | self._check_create_status(field_class_ptr, 'structure') | |
264 | ||
c946c9de | 265 | return bt2_field_class._StructureFieldClass._create_from_ptr(field_class_ptr) |
060aee52 SM |
266 | |
267 | def create_string_field_class(self): | |
268 | field_class_ptr = native_bt.field_class_string_create(self._ptr) | |
269 | self._check_create_status(field_class_ptr, 'string') | |
270 | ||
c946c9de | 271 | return bt2_field_class._StringFieldClass._create_from_ptr(field_class_ptr) |
c8820b76 SM |
272 | |
273 | def create_static_array_field_class(self, elem_fc, length): | |
c946c9de | 274 | utils._check_type(elem_fc, bt2_field_class._FieldClass) |
c8820b76 | 275 | utils._check_uint64(length) |
60bbfc7c | 276 | ptr = native_bt.field_class_array_static_create(self._ptr, elem_fc._ptr, length) |
c8820b76 SM |
277 | self._check_create_status(ptr, 'static array') |
278 | ||
c946c9de | 279 | return bt2_field_class._StaticArrayFieldClass._create_from_ptr_and_get_ref(ptr) |
c8820b76 SM |
280 | |
281 | def create_dynamic_array_field_class(self, elem_fc, length_fc=None): | |
c946c9de | 282 | utils._check_type(elem_fc, bt2_field_class._FieldClass) |
93d7d5d1 | 283 | length_fc_ptr = None |
c8820b76 SM |
284 | |
285 | if length_fc is not None: | |
c946c9de | 286 | utils._check_type(length_fc, bt2_field_class._UnsignedIntegerFieldClass) |
93d7d5d1 | 287 | length_fc_ptr = length_fc._ptr |
c8820b76 | 288 | |
60bbfc7c | 289 | ptr = native_bt.field_class_array_dynamic_create( |
61d96b89 FD |
290 | self._ptr, elem_fc._ptr, length_fc_ptr |
291 | ) | |
93d7d5d1 | 292 | self._check_create_status(ptr, 'dynamic array') |
c946c9de | 293 | return bt2_field_class._DynamicArrayFieldClass._create_from_ptr(ptr) |
c8820b76 SM |
294 | |
295 | def create_variant_field_class(self, selector_fc=None): | |
02b61fe0 | 296 | selector_fc_ptr = None |
c8820b76 SM |
297 | |
298 | if selector_fc is not None: | |
c946c9de | 299 | utils._check_type(selector_fc, bt2_field_class._IntegerFieldClass) |
02b61fe0 | 300 | selector_fc_ptr = selector_fc._ptr |
c8820b76 | 301 | |
02b61fe0 PP |
302 | ptr = native_bt.field_class_variant_create(self._ptr, selector_fc_ptr) |
303 | self._check_create_status(ptr, 'variant') | |
c946c9de | 304 | return bt2_field_class._create_field_class_from_ptr_and_get_ref(ptr) |
060aee52 | 305 | |
0bee8ea9 SM |
306 | # Add a listener to be called when the trace class is destroyed. |
307 | ||
308 | def add_destruction_listener(self, listener): | |
309 | ||
310 | if not callable(listener): | |
311 | raise TypeError("'listener' parameter is not callable") | |
312 | ||
fb25b9e3 | 313 | fn = native_bt.bt2_trace_class_add_destruction_listener |
61d96b89 FD |
314 | listener_from_native = functools.partial( |
315 | _trace_class_destruction_listener_from_native, listener | |
316 | ) | |
0bee8ea9 | 317 | |
48e95b3d SM |
318 | status, listener_id = fn(self._ptr, listener_from_native) |
319 | utils._handle_func_status( | |
320 | status, 'cannot add destruction listener to trace class object' | |
321 | ) | |
0bee8ea9 | 322 | |
c946c9de | 323 | return utils._ListenerHandle(listener_id, self) |