X-Git-Url: http://git.efficios.com/?p=babeltrace.git;a=blobdiff_plain;f=src%2Fbindings%2Fpython%2Fbt2%2Fbt2%2Fstream_class.py;h=ab418e98fa4f98e6f574924f14be3910f5ee54e1;hp=c543523c49700a10beaa5d29a3de6ad0493c3f49;hb=0235b0db7de5bcacdb3650c92461f2ce5eb2143d;hpb=57081273d1191fc79edc101af619fab96b72460d diff --git a/src/bindings/python/bt2/bt2/stream_class.py b/src/bindings/python/bt2/bt2/stream_class.py index c543523c..ab418e98 100644 --- a/src/bindings/python/bt2/bt2/stream_class.py +++ b/src/bindings/python/bt2/bt2/stream_class.py @@ -1,45 +1,58 @@ -# The MIT License (MIT) +# SPDX-License-Identifier: MIT # # Copyright (c) 2017 Philippe Proulx -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. from bt2 import native_bt, object, utils from bt2 import field_class as bt2_field_class from bt2 import event_class as bt2_event_class -from bt2 import trace_class as bt2_trace_class from bt2 import clock_class as bt2_clock_class +from bt2 import value as bt2_value import collections.abc -class _StreamClass(object._SharedObject, collections.abc.Mapping): +def _bt2_trace_class(): + from bt2 import trace_class as bt2_trace_class + + return bt2_trace_class + + +class _StreamClassConst(object._SharedObject, collections.abc.Mapping): _get_ref = staticmethod(native_bt.stream_class_get_ref) _put_ref = staticmethod(native_bt.stream_class_put_ref) + _borrow_event_class_ptr_by_id = staticmethod( + native_bt.stream_class_borrow_event_class_by_id_const + ) + _borrow_event_class_ptr_by_index = staticmethod( + native_bt.stream_class_borrow_event_class_by_index_const + ) + _borrow_trace_class_ptr = staticmethod( + native_bt.stream_class_borrow_trace_class_const + ) + _borrow_packet_context_field_class_ptr = staticmethod( + native_bt.stream_class_borrow_packet_context_field_class_const + ) + _borrow_event_common_context_field_class_ptr = staticmethod( + native_bt.stream_class_borrow_event_common_context_field_class_const + ) + _borrow_default_clock_class_ptr = staticmethod( + native_bt.stream_class_borrow_default_clock_class_const + ) + _borrow_user_attributes_ptr = staticmethod( + native_bt.stream_class_borrow_user_attributes_const + ) + + _event_class_cls = property(lambda _: bt2_event_class._EventClassConst) + _trace_class_cls = property(lambda _: _bt2_trace_class()._TraceClassConst) + _clock_class_cls = property(lambda _: bt2_clock_class._ClockClassConst) def __getitem__(self, key): utils._check_int64(key) - ec_ptr = native_bt.stream_class_borrow_event_class_by_id(self._ptr, key) + ec_ptr = self._borrow_event_class_ptr_by_id(self._ptr, key) if ec_ptr is None: raise KeyError(key) - return bt2_event_class._EventClass._create_from_ptr_and_get_ref(ec_ptr) + return self._event_class_cls._create_from_ptr_and_get_ref(ec_ptr) def __len__(self): count = native_bt.stream_class_get_event_class_count(self._ptr) @@ -48,9 +61,7 @@ class _StreamClass(object._SharedObject, collections.abc.Mapping): def __iter__(self): for idx in range(len(self)): - ec_ptr = native_bt.stream_class_borrow_event_class_by_index_const( - self._ptr, idx - ) + ec_ptr = self._borrow_event_class_ptr_by_index(self._ptr, idx) assert ec_ptr is not None id = native_bt.event_class_get_id(ec_ptr) @@ -58,15 +69,148 @@ class _StreamClass(object._SharedObject, collections.abc.Mapping): yield id + @property + def trace_class(self): + tc_ptr = self._borrow_trace_class_ptr(self._ptr) + + if tc_ptr is not None: + return self._trace_class_cls._create_from_ptr_and_get_ref(tc_ptr) + + @property + def user_attributes(self): + ptr = self._borrow_user_attributes_ptr(self._ptr) + assert ptr is not None + return bt2_value._create_from_ptr_and_get_ref(ptr) + + @property + def name(self): + return native_bt.stream_class_get_name(self._ptr) + + @property + def assigns_automatic_event_class_id(self): + return native_bt.stream_class_assigns_automatic_event_class_id(self._ptr) + + @property + def assigns_automatic_stream_id(self): + return native_bt.stream_class_assigns_automatic_stream_id(self._ptr) + + @property + def supports_packets(self): + return native_bt.stream_class_supports_packets(self._ptr) + + @property + def packets_have_beginning_default_clock_snapshot(self): + return native_bt.stream_class_packets_have_beginning_default_clock_snapshot( + self._ptr + ) + + @property + def packets_have_end_default_clock_snapshot(self): + return native_bt.stream_class_packets_have_end_default_clock_snapshot(self._ptr) + + @property + def supports_discarded_events(self): + return native_bt.stream_class_supports_discarded_events(self._ptr) + + @property + def discarded_events_have_default_clock_snapshots(self): + return native_bt.stream_class_discarded_events_have_default_clock_snapshots( + self._ptr + ) + + @property + def supports_discarded_packets(self): + return native_bt.stream_class_supports_discarded_packets(self._ptr) + + @property + def discarded_packets_have_default_clock_snapshots(self): + return native_bt.stream_class_discarded_packets_have_default_clock_snapshots( + self._ptr + ) + + @property + def id(self): + id = native_bt.stream_class_get_id(self._ptr) + + if id < 0: + return + + return id + + @property + def packet_context_field_class(self): + fc_ptr = self._borrow_packet_context_field_class_ptr(self._ptr) + + if fc_ptr is None: + return + + return bt2_field_class._create_field_class_from_ptr_and_get_ref(fc_ptr) + + @property + def event_common_context_field_class(self): + fc_ptr = self._borrow_event_common_context_field_class_ptr(self._ptr) + + if fc_ptr is None: + return + + return bt2_field_class._create_field_class_from_ptr_and_get_ref(fc_ptr) + + @property + def default_clock_class(self): + cc_ptr = self._borrow_default_clock_class_ptr(self._ptr) + if cc_ptr is None: + return + + return self._clock_class_cls._create_from_ptr_and_get_ref(cc_ptr) + + +class _StreamClass(_StreamClassConst): + _get_ref = staticmethod(native_bt.stream_class_get_ref) + _put_ref = staticmethod(native_bt.stream_class_put_ref) + _borrow_event_class_ptr_by_id = staticmethod( + native_bt.stream_class_borrow_event_class_by_id + ) + _borrow_event_class_ptr_by_index = staticmethod( + native_bt.stream_class_borrow_event_class_by_index + ) + _borrow_trace_class_ptr = staticmethod(native_bt.stream_class_borrow_trace_class) + _borrow_packet_context_field_class_ptr = staticmethod( + native_bt.stream_class_borrow_packet_context_field_class + ) + _borrow_event_common_context_field_class_ptr = staticmethod( + native_bt.stream_class_borrow_event_common_context_field_class + ) + _borrow_default_clock_class_ptr = staticmethod( + native_bt.stream_class_borrow_default_clock_class + ) + _borrow_user_attributes_ptr = staticmethod( + native_bt.stream_class_borrow_user_attributes + ) + + _event_class_cls = property(lambda s: bt2_event_class._EventClass) + _trace_class_cls = property(lambda s: _bt2_trace_class()._TraceClass) + _clock_class_cls = property(lambda s: bt2_clock_class._ClockClass) + def create_event_class( self, id=None, name=None, + user_attributes=None, log_level=None, emf_uri=None, specific_context_field_class=None, payload_field_class=None, ): + # Validate parameters before we create the object. + bt2_event_class._EventClass._validate_create_params( + name, + user_attributes, + log_level, + emf_uri, + specific_context_field_class, + payload_field_class, + ) + if self.assigns_automatic_event_class_id: if id is not None: raise ValueError( @@ -88,6 +232,9 @@ class _StreamClass(object._SharedObject, collections.abc.Mapping): if name is not None: event_class._name = name + if user_attributes is not None: + event_class._user_attributes = user_attributes + if log_level is not None: event_class._log_level = log_level @@ -102,209 +249,165 @@ class _StreamClass(object._SharedObject, collections.abc.Mapping): return event_class - @property - def trace_class(self): - tc_ptr = native_bt.stream_class_borrow_trace_class_const(self._ptr) + def _user_attributes(self, user_attributes): + value = bt2_value.create_value(user_attributes) + native_bt.stream_class_set_user_attributes(self._ptr, value._ptr) - if tc_ptr is not None: - return bt2_trace_class._TraceClass._create_from_ptr_and_get_ref(tc_ptr) - - @property - def name(self): - return native_bt.stream_class_get_name(self._ptr) + _user_attributes = property(fset=_user_attributes) def _name(self, name): - utils._check_str(name) status = native_bt.stream_class_set_name(self._ptr, name) utils._handle_func_status(status, "cannot set stream class object's name") _name = property(fset=_name) - @property - def assigns_automatic_event_class_id(self): - return native_bt.stream_class_assigns_automatic_event_class_id(self._ptr) - def _assigns_automatic_event_class_id(self, auto_id): - utils._check_bool(auto_id) - return native_bt.stream_class_set_assigns_automatic_event_class_id( - self._ptr, auto_id - ) + native_bt.stream_class_set_assigns_automatic_event_class_id(self._ptr, auto_id) _assigns_automatic_event_class_id = property(fset=_assigns_automatic_event_class_id) - @property - def assigns_automatic_stream_id(self): - return native_bt.stream_class_assigns_automatic_stream_id(self._ptr) - def _assigns_automatic_stream_id(self, auto_id): - utils._check_bool(auto_id) - return native_bt.stream_class_set_assigns_automatic_stream_id( - self._ptr, auto_id - ) + native_bt.stream_class_set_assigns_automatic_stream_id(self._ptr, auto_id) _assigns_automatic_stream_id = property(fset=_assigns_automatic_stream_id) - @property - def supports_packets(self): - return native_bt.stream_class_supports_packets(self._ptr) - - @property - def packets_have_beginning_default_clock_snapshot(self): - return native_bt.stream_class_packets_have_beginning_default_clock_snapshot( - self._ptr - ) - - @property - def packets_have_end_default_clock_snapshot(self): - return native_bt.stream_class_packets_have_end_default_clock_snapshot(self._ptr) - def _set_supports_packets(self, supports, with_begin_cs=False, with_end_cs=False): - utils._check_bool(supports) - utils._check_bool(with_begin_cs) - utils._check_bool(with_end_cs) - - if not supports and (with_begin_cs or with_end_cs): - raise ValueError( - 'cannot not support packets, but have default clock snapshots' - ) - - if not supports and self.packet_context_field_class is not None: - raise ValueError('stream class already has a packet context field class') - native_bt.stream_class_set_supports_packets( self._ptr, supports, with_begin_cs, with_end_cs ) - @property - def supports_discarded_events(self): - return native_bt.stream_class_supports_discarded_events(self._ptr) - def _set_supports_discarded_events(self, supports, with_cs=False): - utils._check_bool(supports) - utils._check_bool(with_cs) - - if not supports and with_cs: - raise ValueError( - 'cannot not support discarded events, but have default clock snapshots' - ) - native_bt.stream_class_set_supports_discarded_events( self._ptr, supports, with_cs ) - @property - def discarded_events_have_default_clock_snapshots(self): - return native_bt.stream_class_discarded_events_have_default_clock_snapshots( - self._ptr - ) - - @property - def supports_discarded_packets(self): - return native_bt.stream_class_supports_discarded_packets(self._ptr) + _supports_discarded_events = property(fset=_set_supports_discarded_events) def _set_supports_discarded_packets(self, supports, with_cs): - utils._check_bool(supports) - utils._check_bool(with_cs) - - if supports and not self.supports_packets: - raise ValueError( - 'cannot support discarded packets, but not support packets' - ) - - if not supports and with_cs: - raise ValueError( - 'cannot not support discarded packets, but have default clock snapshots' - ) - native_bt.stream_class_set_supports_discarded_packets( self._ptr, supports, with_cs ) - @property - def discarded_packets_have_default_clock_snapshots(self): - return native_bt.stream_class_discarded_packets_have_default_clock_snapshots( - self._ptr + _supports_discarded_packets = property(fset=_set_supports_discarded_packets) + + def _packet_context_field_class(self, packet_context_field_class): + status = native_bt.stream_class_set_packet_context_field_class( + self._ptr, packet_context_field_class._ptr + ) + utils._handle_func_status( + status, "cannot set stream class' packet context field class" ) - @property - def id(self): - id = native_bt.stream_class_get_id(self._ptr) + _packet_context_field_class = property(fset=_packet_context_field_class) - if id < 0: - return + def _event_common_context_field_class(self, event_common_context_field_class): + set_context_fn = native_bt.stream_class_set_event_common_context_field_class + status = set_context_fn(self._ptr, event_common_context_field_class._ptr) + utils._handle_func_status( + status, "cannot set stream class' event context field type" + ) - return id + _event_common_context_field_class = property(fset=_event_common_context_field_class) - @id.setter - def id(self, id): - utils._check_int64(id) - status = native_bt.stream_class_set_id(self._ptr, id) - utils._handle_func_status(status, "cannot set stream class object's ID") + def _default_clock_class(self, clock_class): + native_bt.stream_class_set_default_clock_class(self._ptr, clock_class._ptr) - @property - def packet_context_field_class(self): - fc_ptr = native_bt.stream_class_borrow_packet_context_field_class_const( - self._ptr - ) + _default_clock_class = property(fset=_default_clock_class) - if fc_ptr is None: - return + @classmethod + def _validate_create_params( + cls, + name, + user_attributes, + packet_context_field_class, + event_common_context_field_class, + default_clock_class, + assigns_automatic_event_class_id, + assigns_automatic_stream_id, + supports_packets, + packets_have_beginning_default_clock_snapshot, + packets_have_end_default_clock_snapshot, + supports_discarded_events, + discarded_events_have_default_clock_snapshots, + supports_discarded_packets, + discarded_packets_have_default_clock_snapshots, + ): + # Name + if name is not None: + utils._check_str(name) - return bt2_field_class._create_field_class_from_ptr_and_get_ref(fc_ptr) + # User attributes + if user_attributes is not None: + value = bt2_value.create_value(user_attributes) + utils._check_type(value, bt2_value.MapValue) - def _packet_context_field_class(self, packet_context_field_class): + # Packet context field class if packet_context_field_class is not None: + if not supports_packets: + raise ValueError( + 'cannot have a packet context field class without supporting packets' + ) + utils._check_type( packet_context_field_class, bt2_field_class._StructureFieldClass ) - if not self.supports_packets: - raise ValueError('stream class does not support packets') - - status = native_bt.stream_class_set_packet_context_field_class( - self._ptr, packet_context_field_class._ptr - ) - utils._handle_func_status( - status, "cannot set stream class' packet context field class" + # Event common context field class + if event_common_context_field_class is not None: + utils._check_type( + event_common_context_field_class, bt2_field_class._StructureFieldClass ) - _packet_context_field_class = property(fset=_packet_context_field_class) + # Default clock class + if default_clock_class is not None: + utils._check_type(default_clock_class, bt2_clock_class._ClockClass) - @property - def event_common_context_field_class(self): - fc_ptr = native_bt.stream_class_borrow_event_common_context_field_class_const( - self._ptr - ) + # Assigns automatic event class id + utils._check_bool(assigns_automatic_event_class_id) - if fc_ptr is None: - return - - return bt2_field_class._create_field_class_from_ptr_and_get_ref(fc_ptr) + # Assigns automatic stream id + utils._check_bool(assigns_automatic_stream_id) - def _event_common_context_field_class(self, event_common_context_field_class): - if event_common_context_field_class is not None: - utils._check_type( - event_common_context_field_class, bt2_field_class._StructureFieldClass - ) + # Packets + utils._check_bool(supports_packets) + utils._check_bool(packets_have_beginning_default_clock_snapshot) + utils._check_bool(packets_have_end_default_clock_snapshot) - set_context_fn = native_bt.stream_class_set_event_common_context_field_class - status = set_context_fn(self._ptr, event_common_context_field_class._ptr) - utils._handle_func_status( - status, "cannot set stream class' event context field type" - ) + if not supports_packets: + if packets_have_beginning_default_clock_snapshot: + raise ValueError( + 'cannot not support packets, but have packet beginning default clock snapshot' + ) + if packets_have_end_default_clock_snapshot: + raise ValueError( + 'cannot not support packets, but have packet end default clock snapshots' + ) - _event_common_context_field_class = property(fset=_event_common_context_field_class) + # Discarded events + utils._check_bool(supports_discarded_events) + utils._check_bool(discarded_events_have_default_clock_snapshots) - @property - def default_clock_class(self): - cc_ptr = native_bt.stream_class_borrow_default_clock_class(self._ptr) - if cc_ptr is None: - return + if ( + not supports_discarded_events + and discarded_events_have_default_clock_snapshots + ): + raise ValueError( + 'cannot not support discarded events, but have default clock snapshots for discarded event messages' + ) - return bt2_clock_class._ClockClass._create_from_ptr_and_get_ref(cc_ptr) + # Discarded packets + utils._check_bool(supports_discarded_packets) + utils._check_bool(discarded_packets_have_default_clock_snapshots) - def _default_clock_class(self, clock_class): - utils._check_type(clock_class, bt2_clock_class._ClockClass) - native_bt.stream_class_set_default_clock_class(self._ptr, clock_class._ptr) + if supports_discarded_packets and not supports_packets: + raise ValueError( + 'cannot support discarded packets, but not support packets' + ) - _default_clock_class = property(fset=_default_clock_class) + if ( + not supports_discarded_packets + and discarded_packets_have_default_clock_snapshots + ): + raise ValueError( + 'cannot not support discarded packets, but have default clock snapshots for discarded packet messages' + )