| 1 | # The MIT License (MIT) |
| 2 | # |
| 3 | # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com> |
| 4 | # |
| 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: |
| 11 | # |
| 12 | # The above copyright notice and this permission notice shall be included in |
| 13 | # all copies or substantial portions of the Software. |
| 14 | # |
| 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 |
| 21 | # THE SOFTWARE. |
| 22 | |
| 23 | from bt2 import native_bt, object, utils |
| 24 | from bt2 import message as bt2_message |
| 25 | import collections.abc |
| 26 | from bt2 import stream as bt2_stream |
| 27 | from bt2 import event_class as bt2_event_class |
| 28 | from bt2 import packet as bt2_packet |
| 29 | from bt2 import port as bt2_port |
| 30 | from bt2 import clock_class as bt2_clock_class |
| 31 | import bt2 |
| 32 | |
| 33 | |
| 34 | class _MessageIterator(collections.abc.Iterator): |
| 35 | def __next__(self): |
| 36 | raise NotImplementedError |
| 37 | |
| 38 | |
| 39 | class _GenericMessageIterator(object._SharedObject, _MessageIterator): |
| 40 | def __init__(self, ptr): |
| 41 | self._current_msgs = [] |
| 42 | self._at = 0 |
| 43 | super().__init__(ptr) |
| 44 | |
| 45 | def __next__(self): |
| 46 | if len(self._current_msgs) == self._at: |
| 47 | status, msgs = self._get_msg_range(self._ptr) |
| 48 | utils._handle_func_status( |
| 49 | status, 'unexpected error: cannot advance the message iterator' |
| 50 | ) |
| 51 | self._current_msgs = msgs |
| 52 | self._at = 0 |
| 53 | |
| 54 | msg_ptr = self._current_msgs[self._at] |
| 55 | self._at += 1 |
| 56 | |
| 57 | return bt2_message._create_from_ptr(msg_ptr) |
| 58 | |
| 59 | @property |
| 60 | def can_seek_beginning(self): |
| 61 | res = self._can_seek_beginning(self._ptr) |
| 62 | return res != 0 |
| 63 | |
| 64 | def seek_beginning(self): |
| 65 | # Forget about buffered messages, they won't be valid after seeking.. |
| 66 | self._current_msgs.clear() |
| 67 | self._at = 0 |
| 68 | |
| 69 | status = self._seek_beginning(self._ptr) |
| 70 | utils._handle_func_status(status, 'cannot seek message iterator beginning') |
| 71 | |
| 72 | |
| 73 | # This is created when a component wants to iterate on one of its input ports. |
| 74 | class _UserComponentInputPortMessageIterator(_GenericMessageIterator): |
| 75 | _get_msg_range = staticmethod(native_bt.bt2_self_component_port_input_get_msg_range) |
| 76 | _get_ref = staticmethod( |
| 77 | native_bt.self_component_port_input_message_iterator_get_ref |
| 78 | ) |
| 79 | _put_ref = staticmethod( |
| 80 | native_bt.self_component_port_input_message_iterator_put_ref |
| 81 | ) |
| 82 | _can_seek_beginning = staticmethod( |
| 83 | native_bt.self_component_port_input_message_iterator_can_seek_beginning |
| 84 | ) |
| 85 | _seek_beginning = staticmethod( |
| 86 | native_bt.self_component_port_input_message_iterator_seek_beginning |
| 87 | ) |
| 88 | |
| 89 | |
| 90 | # This is extended by the user to implement component classes in Python. It |
| 91 | # is created for a given output port when an input port message iterator is |
| 92 | # created on the input port on the other side of the connection. It is also |
| 93 | # created when an output port message iterator is created on this output port. |
| 94 | # |
| 95 | # Its purpose is to feed the messages that should go out through this output |
| 96 | # port. |
| 97 | class _UserMessageIterator(_MessageIterator): |
| 98 | def __new__(cls, ptr): |
| 99 | # User iterator objects are always created by the native side, |
| 100 | # that is, never instantiated directly by Python code. |
| 101 | # |
| 102 | # The native code calls this, then manually calls |
| 103 | # self.__init__() without the `ptr` argument. The user has |
| 104 | # access to self.component during this call, thanks to this |
| 105 | # self._bt_ptr argument being set. |
| 106 | # |
| 107 | # self._bt_ptr is NOT owned by this object here, so there's nothing |
| 108 | # to do in __del__(). |
| 109 | self = super().__new__(cls) |
| 110 | self._bt_ptr = ptr |
| 111 | return self |
| 112 | |
| 113 | def _bt_init_from_native(self, self_output_port_ptr): |
| 114 | self_output_port = bt2_port._create_self_from_ptr_and_get_ref( |
| 115 | self_output_port_ptr, native_bt.PORT_TYPE_OUTPUT |
| 116 | ) |
| 117 | self.__init__(self_output_port) |
| 118 | |
| 119 | def __init__(self, output_port): |
| 120 | pass |
| 121 | |
| 122 | @property |
| 123 | def _component(self): |
| 124 | return native_bt.bt2_get_user_component_from_user_msg_iter(self._bt_ptr) |
| 125 | |
| 126 | @property |
| 127 | def addr(self): |
| 128 | return int(self._bt_ptr) |
| 129 | |
| 130 | @property |
| 131 | def _is_interrupted(self): |
| 132 | return bool(native_bt.self_message_iterator_is_interrupted(self._bt_ptr)) |
| 133 | |
| 134 | def _user_finalize(self): |
| 135 | pass |
| 136 | |
| 137 | def __next__(self): |
| 138 | raise bt2.Stop |
| 139 | |
| 140 | def _bt_next_from_native(self): |
| 141 | # this can raise anything: it's catched by the native part |
| 142 | try: |
| 143 | msg = next(self) |
| 144 | except StopIteration: |
| 145 | raise bt2.Stop |
| 146 | except: |
| 147 | raise |
| 148 | |
| 149 | utils._check_type(msg, bt2_message._Message) |
| 150 | |
| 151 | # The reference we return will be given to the message array. |
| 152 | # However, the `msg` Python object may stay alive, if the user has kept |
| 153 | # a reference to it. Acquire a new reference to account for that. |
| 154 | msg._get_ref(msg._ptr) |
| 155 | return int(msg._ptr) |
| 156 | |
| 157 | @property |
| 158 | def _bt_can_seek_beginning_from_native(self): |
| 159 | # Here, we mimic the behavior of the C API: |
| 160 | # |
| 161 | # - If the iterator has a _user_can_seek_beginning attribute, |
| 162 | # read it and use that result. |
| 163 | # - Otherwise, the presence or absence of a `_seek_beginning` |
| 164 | # method indicates whether the iterator can seek beginning. |
| 165 | if hasattr(self, '_user_can_seek_beginning'): |
| 166 | can_seek_beginning = self._user_can_seek_beginning |
| 167 | utils._check_bool(can_seek_beginning) |
| 168 | return can_seek_beginning |
| 169 | else: |
| 170 | return hasattr(self, '_user_seek_beginning') |
| 171 | |
| 172 | def _bt_seek_beginning_from_native(self): |
| 173 | self._user_seek_beginning() |
| 174 | |
| 175 | def _create_input_port_message_iterator(self, input_port): |
| 176 | utils._check_type(input_port, bt2_port._UserComponentInputPort) |
| 177 | |
| 178 | msg_iter_ptr = native_bt.self_component_port_input_message_iterator_create_from_message_iterator( |
| 179 | self._bt_ptr, input_port._ptr |
| 180 | ) |
| 181 | |
| 182 | if msg_iter_ptr is None: |
| 183 | raise bt2._MemoryError('cannot create message iterator object') |
| 184 | |
| 185 | return _UserComponentInputPortMessageIterator(msg_iter_ptr) |
| 186 | |
| 187 | def _create_event_message( |
| 188 | self, event_class, parent=None, default_clock_snapshot=None |
| 189 | ): |
| 190 | utils._check_type(event_class, bt2_event_class._EventClass) |
| 191 | |
| 192 | if event_class.stream_class.supports_packets: |
| 193 | utils._check_type(parent, bt2_packet._Packet) |
| 194 | else: |
| 195 | utils._check_type(parent, bt2_stream._Stream) |
| 196 | |
| 197 | if default_clock_snapshot is not None: |
| 198 | if event_class.stream_class.default_clock_class is None: |
| 199 | raise ValueError( |
| 200 | 'event messages in this stream must not have a default clock snapshot' |
| 201 | ) |
| 202 | |
| 203 | utils._check_uint64(default_clock_snapshot) |
| 204 | |
| 205 | if event_class.stream_class.supports_packets: |
| 206 | ptr = native_bt.message_event_create_with_packet_and_default_clock_snapshot( |
| 207 | self._bt_ptr, event_class._ptr, parent._ptr, default_clock_snapshot |
| 208 | ) |
| 209 | else: |
| 210 | ptr = native_bt.message_event_create_with_default_clock_snapshot( |
| 211 | self._bt_ptr, event_class._ptr, parent._ptr, default_clock_snapshot |
| 212 | ) |
| 213 | else: |
| 214 | if event_class.stream_class.default_clock_class is not None: |
| 215 | raise ValueError( |
| 216 | 'event messages in this stream must have a default clock snapshot' |
| 217 | ) |
| 218 | |
| 219 | if event_class.stream_class.supports_packets: |
| 220 | ptr = native_bt.message_event_create_with_packet( |
| 221 | self._bt_ptr, event_class._ptr, parent._ptr |
| 222 | ) |
| 223 | else: |
| 224 | ptr = native_bt.message_event_create( |
| 225 | self._bt_ptr, event_class._ptr, parent._ptr |
| 226 | ) |
| 227 | |
| 228 | if ptr is None: |
| 229 | raise bt2._MemoryError('cannot create event message object') |
| 230 | |
| 231 | return bt2_message._EventMessage(ptr) |
| 232 | |
| 233 | def _create_message_iterator_inactivity_message(self, clock_class, clock_snapshot): |
| 234 | utils._check_type(clock_class, bt2_clock_class._ClockClass) |
| 235 | ptr = native_bt.message_message_iterator_inactivity_create( |
| 236 | self._bt_ptr, clock_class._ptr, clock_snapshot |
| 237 | ) |
| 238 | |
| 239 | if ptr is None: |
| 240 | raise bt2._MemoryError('cannot create inactivity message object') |
| 241 | |
| 242 | return bt2_message._MessageIteratorInactivityMessage(ptr) |
| 243 | |
| 244 | def _create_stream_beginning_message(self, stream, default_clock_snapshot=None): |
| 245 | utils._check_type(stream, bt2_stream._Stream) |
| 246 | |
| 247 | ptr = native_bt.message_stream_beginning_create(self._bt_ptr, stream._ptr) |
| 248 | if ptr is None: |
| 249 | raise bt2._MemoryError('cannot create stream beginning message object') |
| 250 | |
| 251 | msg = bt2_message._StreamBeginningMessage(ptr) |
| 252 | |
| 253 | if default_clock_snapshot is not None: |
| 254 | msg._default_clock_snapshot = default_clock_snapshot |
| 255 | |
| 256 | return msg |
| 257 | |
| 258 | def _create_stream_end_message(self, stream, default_clock_snapshot=None): |
| 259 | utils._check_type(stream, bt2_stream._Stream) |
| 260 | |
| 261 | ptr = native_bt.message_stream_end_create(self._bt_ptr, stream._ptr) |
| 262 | if ptr is None: |
| 263 | raise bt2._MemoryError('cannot create stream end message object') |
| 264 | |
| 265 | msg = bt2_message._StreamEndMessage(ptr) |
| 266 | |
| 267 | if default_clock_snapshot is not None: |
| 268 | msg._default_clock_snapshot = default_clock_snapshot |
| 269 | |
| 270 | return msg |
| 271 | |
| 272 | def _create_packet_beginning_message(self, packet, default_clock_snapshot=None): |
| 273 | utils._check_type(packet, bt2_packet._Packet) |
| 274 | |
| 275 | if packet.stream.cls.packets_have_beginning_default_clock_snapshot: |
| 276 | if default_clock_snapshot is None: |
| 277 | raise ValueError( |
| 278 | "packet beginning messages in this stream must have a default clock snapshot" |
| 279 | ) |
| 280 | |
| 281 | utils._check_uint64(default_clock_snapshot) |
| 282 | ptr = native_bt.message_packet_beginning_create_with_default_clock_snapshot( |
| 283 | self._bt_ptr, packet._ptr, default_clock_snapshot |
| 284 | ) |
| 285 | else: |
| 286 | if default_clock_snapshot is not None: |
| 287 | raise ValueError( |
| 288 | "packet beginning messages in this stream must not have a default clock snapshot" |
| 289 | ) |
| 290 | |
| 291 | ptr = native_bt.message_packet_beginning_create(self._bt_ptr, packet._ptr) |
| 292 | |
| 293 | if ptr is None: |
| 294 | raise bt2._MemoryError('cannot create packet beginning message object') |
| 295 | |
| 296 | return bt2_message._PacketBeginningMessage(ptr) |
| 297 | |
| 298 | def _create_packet_end_message(self, packet, default_clock_snapshot=None): |
| 299 | utils._check_type(packet, bt2_packet._Packet) |
| 300 | |
| 301 | if packet.stream.cls.packets_have_end_default_clock_snapshot: |
| 302 | if default_clock_snapshot is None: |
| 303 | raise ValueError( |
| 304 | "packet end messages in this stream must have a default clock snapshot" |
| 305 | ) |
| 306 | |
| 307 | utils._check_uint64(default_clock_snapshot) |
| 308 | ptr = native_bt.message_packet_end_create_with_default_clock_snapshot( |
| 309 | self._bt_ptr, packet._ptr, default_clock_snapshot |
| 310 | ) |
| 311 | else: |
| 312 | if default_clock_snapshot is not None: |
| 313 | raise ValueError( |
| 314 | "packet end messages in this stream must not have a default clock snapshot" |
| 315 | ) |
| 316 | |
| 317 | ptr = native_bt.message_packet_end_create(self._bt_ptr, packet._ptr) |
| 318 | |
| 319 | if ptr is None: |
| 320 | raise bt2._MemoryError('cannot create packet end message object') |
| 321 | |
| 322 | return bt2_message._PacketEndMessage(ptr) |
| 323 | |
| 324 | def _create_discarded_events_message( |
| 325 | self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None |
| 326 | ): |
| 327 | utils._check_type(stream, bt2_stream._Stream) |
| 328 | |
| 329 | if not stream.cls.supports_discarded_events: |
| 330 | raise ValueError('stream class does not support discarded events') |
| 331 | |
| 332 | if stream.cls.discarded_events_have_default_clock_snapshots: |
| 333 | if beg_clock_snapshot is None or end_clock_snapshot is None: |
| 334 | raise ValueError( |
| 335 | 'discarded events have default clock snapshots for this stream class' |
| 336 | ) |
| 337 | |
| 338 | utils._check_uint64(beg_clock_snapshot) |
| 339 | utils._check_uint64(end_clock_snapshot) |
| 340 | ptr = native_bt.message_discarded_events_create_with_default_clock_snapshots( |
| 341 | self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot |
| 342 | ) |
| 343 | else: |
| 344 | if beg_clock_snapshot is not None or end_clock_snapshot is not None: |
| 345 | raise ValueError( |
| 346 | 'discarded events have no default clock snapshots for this stream class' |
| 347 | ) |
| 348 | |
| 349 | ptr = native_bt.message_discarded_events_create(self._bt_ptr, stream._ptr) |
| 350 | |
| 351 | if ptr is None: |
| 352 | raise bt2._MemoryError('cannot discarded events message object') |
| 353 | |
| 354 | msg = bt2_message._DiscardedEventsMessage(ptr) |
| 355 | |
| 356 | if count is not None: |
| 357 | msg._count = count |
| 358 | |
| 359 | return msg |
| 360 | |
| 361 | def _create_discarded_packets_message( |
| 362 | self, stream, count=None, beg_clock_snapshot=None, end_clock_snapshot=None |
| 363 | ): |
| 364 | utils._check_type(stream, bt2_stream._Stream) |
| 365 | |
| 366 | if not stream.cls.supports_discarded_packets: |
| 367 | raise ValueError('stream class does not support discarded packets') |
| 368 | |
| 369 | if stream.cls.discarded_packets_have_default_clock_snapshots: |
| 370 | if beg_clock_snapshot is None or end_clock_snapshot is None: |
| 371 | raise ValueError( |
| 372 | 'discarded packets have default clock snapshots for this stream class' |
| 373 | ) |
| 374 | |
| 375 | utils._check_uint64(beg_clock_snapshot) |
| 376 | utils._check_uint64(end_clock_snapshot) |
| 377 | ptr = native_bt.message_discarded_packets_create_with_default_clock_snapshots( |
| 378 | self._bt_ptr, stream._ptr, beg_clock_snapshot, end_clock_snapshot |
| 379 | ) |
| 380 | else: |
| 381 | if beg_clock_snapshot is not None or end_clock_snapshot is not None: |
| 382 | raise ValueError( |
| 383 | 'discarded packets have no default clock snapshots for this stream class' |
| 384 | ) |
| 385 | |
| 386 | ptr = native_bt.message_discarded_packets_create(self._bt_ptr, stream._ptr) |
| 387 | |
| 388 | if ptr is None: |
| 389 | raise bt2._MemoryError('cannot discarded packets message object') |
| 390 | |
| 391 | msg = bt2_message._DiscardedPacketsMessage(ptr) |
| 392 | |
| 393 | if count is not None: |
| 394 | msg._count = count |
| 395 | |
| 396 | return msg |