| 1 | # The MIT License (MIT) |
| 2 | # |
| 3 | # Copyright (c) 2016-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, stream, utils |
| 24 | import uuid as uuidp |
| 25 | import bt2.event |
| 26 | import bt2.field |
| 27 | import abc |
| 28 | import bt2 |
| 29 | |
| 30 | |
| 31 | class CtfWriterClock(bt2.object._SharedObject): |
| 32 | def __init__(self, name, description=None, frequency=None, precision=None, |
| 33 | offset=None, is_absolute=None, uuid=None): |
| 34 | utils._check_str(name) |
| 35 | ptr = native_bt.ctf_clock_create(name) |
| 36 | |
| 37 | if ptr is None: |
| 38 | raise bt2.CreationError('cannot create CTF writer clock object') |
| 39 | |
| 40 | super().__init__(ptr) |
| 41 | |
| 42 | if description is not None: |
| 43 | self.description = description |
| 44 | |
| 45 | if frequency is not None: |
| 46 | self.frequency = frequency |
| 47 | |
| 48 | if precision is not None: |
| 49 | self.precision = precision |
| 50 | |
| 51 | if offset is not None: |
| 52 | self.offset = offset |
| 53 | |
| 54 | if is_absolute is not None: |
| 55 | self.is_absolute = is_absolute |
| 56 | |
| 57 | if uuid is not None: |
| 58 | self.uuid = uuid |
| 59 | |
| 60 | def __eq__(self, other): |
| 61 | if type(self) is not type(other): |
| 62 | # not comparing apples to apples |
| 63 | return False |
| 64 | |
| 65 | if self.addr == other.addr: |
| 66 | return True |
| 67 | |
| 68 | self_props = ( |
| 69 | self.name, |
| 70 | self.description, |
| 71 | self.frequency, |
| 72 | self.precision, |
| 73 | self.offset, |
| 74 | self.is_absolute, |
| 75 | self.uuid |
| 76 | ) |
| 77 | other_props = ( |
| 78 | other.name, |
| 79 | other.description, |
| 80 | other.frequency, |
| 81 | other.precision, |
| 82 | other.offset, |
| 83 | other.is_absolute, |
| 84 | other.uuid |
| 85 | ) |
| 86 | return self_props == other_props |
| 87 | |
| 88 | def __copy__(self): |
| 89 | return CtfWriterClock(name=self.name, description=self.description, |
| 90 | frequency=self.frequency, |
| 91 | precision=self.precision, offset=self.offset, |
| 92 | is_absolute=self.is_absolute, uuid=self.uuid) |
| 93 | |
| 94 | def __deepcopy__(self, memo): |
| 95 | cpy = self.__copy__() |
| 96 | memo[id(self)] = cpy |
| 97 | return cpy |
| 98 | |
| 99 | @property |
| 100 | def name(self): |
| 101 | name = native_bt.ctf_clock_get_name(self._ptr) |
| 102 | assert(name is not None) |
| 103 | return name |
| 104 | |
| 105 | @property |
| 106 | def description(self): |
| 107 | description = native_bt.ctf_clock_get_description(self._ptr) |
| 108 | return description |
| 109 | |
| 110 | @description.setter |
| 111 | def description(self, description): |
| 112 | utils._check_str(description) |
| 113 | ret = native_bt.ctf_clock_set_description(self._ptr, description) |
| 114 | utils._handle_ret(ret, "cannot set CTF writer clock object's description") |
| 115 | |
| 116 | @property |
| 117 | def frequency(self): |
| 118 | frequency = native_bt.ctf_clock_get_frequency(self._ptr) |
| 119 | assert(frequency >= 1) |
| 120 | return frequency |
| 121 | |
| 122 | @frequency.setter |
| 123 | def frequency(self, frequency): |
| 124 | utils._check_uint64(frequency) |
| 125 | ret = native_bt.ctf_clock_set_frequency(self._ptr, frequency) |
| 126 | utils._handle_ret(ret, "cannot set CTF writer clock object's frequency") |
| 127 | |
| 128 | @property |
| 129 | def precision(self): |
| 130 | precision = native_bt.ctf_clock_get_precision(self._ptr) |
| 131 | assert(precision >= 0) |
| 132 | return precision |
| 133 | |
| 134 | @precision.setter |
| 135 | def precision(self, precision): |
| 136 | utils._check_uint64(precision) |
| 137 | ret = native_bt.ctf_clock_set_precision(self._ptr, precision) |
| 138 | utils._handle_ret(ret, "cannot set CTF writer clock object's precision") |
| 139 | |
| 140 | @property |
| 141 | def offset(self): |
| 142 | ret, offset_s = native_bt.ctf_clock_get_offset_s(self._ptr) |
| 143 | assert(ret == 0) |
| 144 | ret, offset_cycles = native_bt.ctf_clock_get_offset(self._ptr) |
| 145 | assert(ret == 0) |
| 146 | return bt2.ClockClassOffset(offset_s, offset_cycles) |
| 147 | |
| 148 | @offset.setter |
| 149 | def offset(self, offset): |
| 150 | utils._check_type(offset, bt2.ClockClassOffset) |
| 151 | ret = native_bt.ctf_clock_set_offset_s(self._ptr, offset.seconds) |
| 152 | utils._handle_ret(ret, "cannot set CTF writer clock object's offset (seconds)") |
| 153 | ret = native_bt.ctf_clock_set_offset(self._ptr, offset.cycles) |
| 154 | utils._handle_ret(ret, "cannot set CTF writer clock object's offset (cycles)") |
| 155 | |
| 156 | @property |
| 157 | def is_absolute(self): |
| 158 | is_absolute = native_bt.ctf_clock_get_is_absolute(self._ptr) |
| 159 | assert(is_absolute >= 0) |
| 160 | return is_absolute > 0 |
| 161 | |
| 162 | @is_absolute.setter |
| 163 | def is_absolute(self, is_absolute): |
| 164 | utils._check_bool(is_absolute) |
| 165 | ret = native_bt.ctf_clock_set_is_absolute(self._ptr, int(is_absolute)) |
| 166 | utils._handle_ret(ret, "cannot set CTF writer clock object's absoluteness") |
| 167 | |
| 168 | @property |
| 169 | def uuid(self): |
| 170 | uuid_bytes = native_bt.ctf_clock_get_uuid(self._ptr) |
| 171 | assert(uuid_bytes is not None) |
| 172 | return uuidp.UUID(bytes=uuid_bytes) |
| 173 | |
| 174 | @uuid.setter |
| 175 | def uuid(self, uuid): |
| 176 | utils._check_type(uuid, uuidp.UUID) |
| 177 | ret = native_bt.ctf_clock_set_uuid(self._ptr, uuid.bytes) |
| 178 | utils._handle_ret(ret, "cannot set CTF writer clock object's UUID") |
| 179 | |
| 180 | def _time(self, time): |
| 181 | utils._check_int64(time) |
| 182 | ret = native_bt.ctf_clock_set_time(self._ptr, time) |
| 183 | |
| 184 | time = property(fset=_time) |
| 185 | |
| 186 | |
| 187 | class _CtfWriterStream(stream._StreamBase): |
| 188 | @property |
| 189 | def discarded_events_count(self): |
| 190 | ret, count = native_bt.stream_get_discarded_events_count(self._ptr) |
| 191 | utils._handle_ret(ret, "cannot get CTF writer stream object's discarded events count") |
| 192 | return count |
| 193 | |
| 194 | def append_discarded_events(self, count): |
| 195 | utils._check_uint64(count) |
| 196 | native_bt.stream_append_discarded_events(self._ptr, count) |
| 197 | |
| 198 | def append_event(self, event): |
| 199 | utils._check_type(event, bt2.event._Event) |
| 200 | ret = native_bt.stream_append_event(self._ptr, event._ptr) |
| 201 | utils._handle_ret(ret, 'cannot append event object to CTF writer stream object') |
| 202 | |
| 203 | def flush(self): |
| 204 | ret = native_bt.stream_flush(self._ptr) |
| 205 | utils._handle_ret(ret, 'cannot flush CTF writer stream object') |
| 206 | |
| 207 | @property |
| 208 | def packet_header_field(self): |
| 209 | field_ptr = native_bt.stream_get_packet_header(self._ptr) |
| 210 | |
| 211 | if field_ptr is None: |
| 212 | return |
| 213 | |
| 214 | return bt2.field._create_from_ptr(field_ptr) |
| 215 | |
| 216 | @packet_header_field.setter |
| 217 | def packet_header_field(self, packet_header_field): |
| 218 | packet_header_field_ptr = None |
| 219 | |
| 220 | if packet_header_field is not None: |
| 221 | utils._check_type(packet_header_field, bt2.field._Field) |
| 222 | packet_header_field_ptr = packet_header_field._ptr |
| 223 | |
| 224 | ret = native_bt.stream_set_packet_header(self._ptr, |
| 225 | packet_header_field_ptr) |
| 226 | utils._handle_ret(ret, "cannot set CTF writer stream object's packet header field") |
| 227 | |
| 228 | @property |
| 229 | def packet_context_field(self): |
| 230 | field_ptr = native_bt.stream_get_packet_context(self._ptr) |
| 231 | |
| 232 | if field_ptr is None: |
| 233 | return |
| 234 | |
| 235 | return bt2.field._create_from_ptr(field_ptr) |
| 236 | |
| 237 | @packet_context_field.setter |
| 238 | def packet_context_field(self, packet_context_field): |
| 239 | packet_context_field_ptr = None |
| 240 | |
| 241 | if packet_context_field is not None: |
| 242 | utils._check_type(packet_context_field, bt2.field._Field) |
| 243 | packet_context_field_ptr = packet_context_field._ptr |
| 244 | |
| 245 | ret = native_bt.stream_set_packet_context(self._ptr, |
| 246 | packet_context_field_ptr) |
| 247 | utils._handle_ret(ret, "cannot set CTF writer stream object's packet context field") |
| 248 | |
| 249 | def __eq__(self, other): |
| 250 | if type(other) is not type(self): |
| 251 | return False |
| 252 | |
| 253 | if self.addr == other.addr: |
| 254 | return True |
| 255 | |
| 256 | if not _StreamBase.__eq__(self, other): |
| 257 | return False |
| 258 | |
| 259 | self_props = ( |
| 260 | self.discarded_events_count, |
| 261 | self.packet_header_field, |
| 262 | self.packet_context_field, |
| 263 | ) |
| 264 | other_props = ( |
| 265 | other.discarded_events_count, |
| 266 | other.packet_header_field, |
| 267 | other.packet_context_field, |
| 268 | ) |
| 269 | return self_props == other_props |
| 270 | |
| 271 | def _copy(self, copy_func): |
| 272 | cpy = self.stream_class(self.name) |
| 273 | cpy.append_discarded_events(self.discarded_events_count) |
| 274 | cpy.packet_header_field = copy_func(self.packet_header_field) |
| 275 | cpy.packet_context_field = copy_func(self.packet_context_field) |
| 276 | return cpy |
| 277 | |
| 278 | def __copy__(self): |
| 279 | return self._copy(copy.copy) |
| 280 | |
| 281 | def __deepcopy__(self, memo): |
| 282 | cpy = self._copy(copy.deepcopy) |
| 283 | memo[id(self)] = cpy |
| 284 | return cpy |
| 285 | |
| 286 | |
| 287 | class CtfWriter(bt2.object._SharedObject): |
| 288 | def __init__(self, path): |
| 289 | utils._check_str(path) |
| 290 | ptr = native_bt.ctf_writer_create(path) |
| 291 | |
| 292 | if ptr is None: |
| 293 | raise bt2.CreationError('cannot create CTF writer object') |
| 294 | |
| 295 | super().__init__(ptr) |
| 296 | |
| 297 | @property |
| 298 | def trace(self): |
| 299 | trace_ptr = native_bt.ctf_writer_get_trace(self._ptr) |
| 300 | assert(trace_ptr) |
| 301 | return bt2.Trace._create_from_ptr(trace_ptr) |
| 302 | |
| 303 | @property |
| 304 | def metadata_string(self): |
| 305 | metadata_string = native_bt.ctf_writer_get_metadata_string(self._ptr) |
| 306 | assert(metadata_string is not None) |
| 307 | return metadata_string |
| 308 | |
| 309 | def flush_metadata(self): |
| 310 | native_bt.ctf_writer_flush_metadata(self._ptr) |
| 311 | |
| 312 | def add_clock(self, clock): |
| 313 | utils._check_type(clock, CtfWriterClock) |
| 314 | ret = native_bt.ctf_writer_add_clock(self._ptr, clock._ptr) |
| 315 | utils._handle_ret(ret, 'cannot add CTF writer clock object to CTF writer object') |