tap-driver.sh: flush stdout after each test result
[babeltrace.git] / bindings / python / bt2 / bt2 / message.py
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 import bt2.clock_snapshot
25 import bt2.packet
26 import bt2.stream
27 import bt2.event
28 import bt2
29
30
31 def _create_from_ptr(ptr):
32 msg_type = native_bt.message_get_type(ptr)
33
34 if msg_type not in _MESSAGE_TYPE_TO_CLS:
35 raise bt2.Error('unknown message type: {}'.format(msg_type))
36
37 return _MESSAGE_TYPE_TO_CLS[msg_type]._create_from_ptr(ptr)
38
39
40 class _Message(object._SharedObject):
41 _get_ref = staticmethod(native_bt.message_get_ref)
42 _put_ref = staticmethod(native_bt.message_put_ref)
43
44 @staticmethod
45 def _check_has_default_clock_class(clock_class):
46 if clock_class is None:
47 raise bt2.NonexistentClockSnapshot('cannot get default clock snapshot: stream class has no default clock class')
48
49
50 class _MessageWithDefaultClockSnapshot:
51 def _get_default_clock_snapshot(self, borrow_clock_snapshot_ptr):
52 snapshot_ptr = borrow_clock_snapshot_ptr(self._ptr)
53
54 return bt2.clock_snapshot._ClockSnapshot._create_from_ptr_and_get_ref(
55 snapshot_ptr, self._ptr, self._get_ref, self._put_ref)
56
57
58 class _EventMessage(_Message, _MessageWithDefaultClockSnapshot):
59 _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_event_borrow_default_clock_snapshot_const)
60
61 @property
62 def default_clock_snapshot(self):
63 self._check_has_default_clock_class(self.event.packet.stream.cls.default_clock_class)
64 return self._get_default_clock_snapshot(self._borrow_default_clock_snapshot_ptr)
65
66 @property
67 def event(self):
68 event_ptr = native_bt.message_event_borrow_event(self._ptr)
69 assert event_ptr is not None
70 return bt2.event._Event._create_from_ptr_and_get_ref(
71 event_ptr, self._ptr, self._get_ref, self._put_ref)
72
73
74 class _PacketMessage(_Message, _MessageWithDefaultClockSnapshot):
75 @property
76 def default_clock_snapshot(self):
77 self._check_has_default_clock_class(self.packet.stream.cls.default_clock_class)
78 return self._get_default_clock_snapshot(self._borrow_default_clock_snapshot_ptr)
79
80 @property
81 def packet(self):
82 packet_ptr = self._borrow_packet_ptr(self._ptr)
83 assert packet_ptr is not None
84 return bt2.packet._Packet._create_from_ptr_and_get_ref(packet_ptr)
85
86
87 class _PacketBeginningMessage(_PacketMessage):
88 _borrow_packet_ptr = staticmethod(native_bt.message_packet_beginning_borrow_packet)
89 _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_packet_beginning_borrow_default_clock_snapshot_const)
90
91
92 class _PacketEndMessage(_PacketMessage):
93 _borrow_packet_ptr = staticmethod(native_bt.message_packet_end_borrow_packet)
94 _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_packet_end_borrow_default_clock_snapshot_const)
95
96
97 class _StreamMessage(_Message):
98 @property
99 def stream(self):
100 stream_ptr = self._borrow_stream_ptr(self._ptr)
101 assert stream_ptr
102 return bt2.stream._Stream._create_from_ptr_and_get_ref(stream_ptr)
103
104
105 class _StreamBeginningMessage(_StreamMessage):
106 _borrow_stream_ptr = staticmethod(native_bt.message_stream_beginning_borrow_stream)
107
108
109 class _StreamEndMessage(_StreamMessage):
110 _borrow_stream_ptr = staticmethod(native_bt.message_stream_end_borrow_stream)
111
112
113 class _StreamActivityMessage(_Message):
114 @property
115 def default_clock_snapshot(self):
116 self._check_has_default_clock_class(self.stream.cls.default_clock_class)
117 status, snapshot_ptr = self._borrow_default_clock_snapshot_ptr(self._ptr)
118
119 if status == native_bt.MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_KNOWN:
120 snapshot_type = bt2.clock_snapshot._ClockSnapshot
121 elif status == native_bt.MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_UNKNOWN:
122 snapshot_type = bt2.clock_snapshot._UnknownClockSnapshot
123 elif status == native_bt.MESSAGE_STREAM_ACTIVITY_CLOCK_SNAPSHOT_STATE_INFINITE:
124 snapshot_type = bt2.clock_snapshot._InfiniteClockSnapshot
125 else:
126 raise bt2.Error('cannot borrow default clock snapshot from message')
127
128 assert snapshot_ptr is not None
129
130 return snapshot_type._create_from_ptr_and_get_ref(
131 snapshot_ptr, self._ptr, self._get_ref, self._put_ref)
132
133 def _default_clock_snapshot(self, value):
134 self._set_default_clock_snapshot_ptr(self._ptr, value)
135
136 _default_clock_snapshot = property(fset=_default_clock_snapshot)
137
138 @property
139 def stream(self):
140 stream_ptr = self._borrow_stream_ptr(self._ptr)
141 assert stream_ptr
142 return bt2.stream._Stream._create_from_ptr_and_get_ref(stream_ptr)
143
144
145 class _StreamActivityBeginningMessage(_StreamActivityMessage):
146 _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_stream_activity_beginning_borrow_default_clock_snapshot_const)
147 _set_default_clock_snapshot_ptr = staticmethod(native_bt.message_stream_activity_beginning_set_default_clock_snapshot)
148 _borrow_stream_ptr = staticmethod(native_bt.message_stream_activity_beginning_borrow_stream)
149
150
151 class _StreamActivityEndMessage(_StreamActivityMessage):
152 _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_stream_activity_end_borrow_default_clock_snapshot_const)
153 _set_default_clock_snapshot_ptr = staticmethod(native_bt.message_stream_activity_end_set_default_clock_snapshot)
154 _borrow_stream_ptr = staticmethod(native_bt.message_stream_activity_end_borrow_stream)
155
156
157 class _MessageIteratorInactivityMessage(_Message, _MessageWithDefaultClockSnapshot):
158 _borrow_default_clock_snapshot_ptr = staticmethod(native_bt.message_message_iterator_inactivity_borrow_default_clock_snapshot_const)
159
160 @property
161 def default_clock_snapshot(self):
162 # This kind of message always has a default clock class: no
163 # need to call self._check_has_default_clock_class() here.
164 return self._get_default_clock_snapshot(self._borrow_default_clock_snapshot_ptr)
165
166
167 class _DiscardedMessage(_Message, _MessageWithDefaultClockSnapshot):
168 @property
169 def stream(self):
170 stream_ptr = self._borrow_stream_ptr(self._ptr)
171 assert stream_ptr
172 return bt2.stream._Stream._create_from_ptr_and_get_ref(stream_ptr)
173
174 @property
175 def count(self):
176 avail, count = self._get_count(self._ptr)
177 if avail is native_bt.PROPERTY_AVAILABILITY_AVAILABLE:
178 return count
179
180 def _set_count(self, count):
181 utils._check_uint64(count)
182 self._set_count(self._ptr, count)
183
184 _count = property(fset=_set_count)
185
186 def _check_has_default_clock_snapshots(self):
187 if not self._has_default_clock_snapshots:
188 raise bt2.NonexistentClockSnapshot('cannot get default clock snapshot: such a message has no clock snapshots for this stream class')
189
190 @property
191 def beginning_default_clock_snapshot(self):
192 self._check_has_default_clock_snapshots()
193 return self._get_default_clock_snapshot(self._borrow_beginning_clock_snapshot_ptr)
194
195 @property
196 def end_default_clock_snapshot(self):
197 self._check_has_default_clock_snapshots()
198 return self._get_default_clock_snapshot(self._borrow_end_clock_snapshot_ptr)
199
200
201 class _DiscardedEventsMessage(_DiscardedMessage):
202 _borrow_stream_ptr = staticmethod(native_bt.message_discarded_events_borrow_stream_const)
203 _get_count = staticmethod(native_bt.message_discarded_events_get_count)
204 _set_count = staticmethod(native_bt.message_discarded_events_set_count)
205 _borrow_beginning_clock_snapshot_ptr = staticmethod(native_bt.message_discarded_events_borrow_beginning_default_clock_snapshot_const)
206 _borrow_end_clock_snapshot_ptr = staticmethod(native_bt.message_discarded_events_borrow_end_default_clock_snapshot_const)
207
208 @property
209 def _has_default_clock_snapshots(self):
210 return self.stream.cls.discarded_events_have_default_clock_snapshots
211
212
213 class _DiscardedPacketsMessage(_DiscardedMessage):
214 _borrow_stream_ptr = staticmethod(native_bt.message_discarded_packets_borrow_stream_const)
215 _get_count = staticmethod(native_bt.message_discarded_packets_get_count)
216 _set_count = staticmethod(native_bt.message_discarded_packets_set_count)
217 _borrow_beginning_clock_snapshot_ptr = staticmethod(native_bt.message_discarded_packets_borrow_beginning_default_clock_snapshot_const)
218 _borrow_end_clock_snapshot_ptr = staticmethod(native_bt.message_discarded_packets_borrow_end_default_clock_snapshot_const)
219
220 @property
221 def _has_default_clock_snapshots(self):
222 return self.stream.cls.discarded_packets_have_default_clock_snapshots
223
224
225 _MESSAGE_TYPE_TO_CLS = {
226 native_bt.MESSAGE_TYPE_EVENT: _EventMessage,
227 native_bt.MESSAGE_TYPE_MESSAGE_ITERATOR_INACTIVITY: _MessageIteratorInactivityMessage,
228 native_bt.MESSAGE_TYPE_STREAM_BEGINNING: _StreamBeginningMessage,
229 native_bt.MESSAGE_TYPE_STREAM_END: _StreamEndMessage,
230 native_bt.MESSAGE_TYPE_PACKET_BEGINNING: _PacketBeginningMessage,
231 native_bt.MESSAGE_TYPE_PACKET_END: _PacketEndMessage,
232 native_bt.MESSAGE_TYPE_STREAM_ACTIVITY_BEGINNING: _StreamActivityBeginningMessage,
233 native_bt.MESSAGE_TYPE_STREAM_ACTIVITY_END: _StreamActivityEndMessage,
234 native_bt.MESSAGE_TYPE_DISCARDED_EVENTS: _DiscardedEventsMessage,
235 native_bt.MESSAGE_TYPE_DISCARDED_PACKETS: _DiscardedPacketsMessage,
236 }
This page took 0.034592 seconds and 4 git commands to generate.