bt2: add bt2._OutputPort.create_notification_iterator()

[babeltrace.git] / bindings / python / bt2 / bt2 / notification.py

# The MIT License (MIT)
#
# Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
#
# 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
import bt2.clock_class_priority_map
import bt2.packet
import bt2.stream
import bt2.event
import copy
import bt2


def _create_from_ptr(ptr):
    notif_type = native_bt.notification_get_type(ptr)
    cls = None

    if notif_type not in _NOTIF_TYPE_TO_CLS:
        raise bt2.Error('unknown notification type: {}'.format(notif_type))

    return _NOTIF_TYPE_TO_CLS[notif_type]._create_from_ptr(ptr)


def _notif_types_from_notif_classes(notification_types):
    if notification_types is None:
        notif_types = None
    else:
        for notif_cls in notification_types:
            if notif_cls not in _NOTIF_TYPE_TO_CLS.values():
                raise ValueError("'{}' is not a notification class".format(notif_cls))

        notif_types = [notif_cls._TYPE for notif_cls in notification_types]

    return notif_types


class _Notification(object._Object):
    pass


class _CopyableNotification(_Notification):
    def __copy__(self):
        return self._copy(lambda obj: obj)

    def __deepcopy__(self, memo):
        cpy = self._copy(copy.deepcopy)
        memo[id(self)] = cpy
        return cpy


class EventNotification(_CopyableNotification):
    _TYPE = native_bt.NOTIFICATION_TYPE_EVENT

    def __init__(self, event, cc_prio_map=None):
        utils._check_type(event, bt2.event._Event)

        if cc_prio_map is not None:
            utils._check_type(cc_prio_map, bt2.clock_class_priority_map.ClockClassPriorityMap)
            cc_prio_map_ptr = cc_prio_map._ptr
        else:
            cc_prio_map_ptr = None

        ptr = native_bt.notification_event_create(event._ptr, cc_prio_map_ptr)

        if ptr is None:
            raise bt2.CreationError('cannot create event notification object')

        super().__init__(ptr)

    @property
    def event(self):
        event_ptr = native_bt.notification_event_get_event(self._ptr)
        assert(event_ptr)
        return bt2.event._create_from_ptr(event_ptr)

    @property
    def clock_class_priority_map(self):
        cc_prio_map_ptr = native_bt.notification_event_get_clock_class_priority_map(self._ptr)
        assert(cc_prio_map_ptr)
        return bt2.clock_class_priority_map.ClockClassPriorityMap._create_from_ptr(cc_prio_map_ptr)

    def __eq__(self, other):
        if type(other) is not type(self):
            return False

        if self.addr == other.addr:
            return True

        self_props = (
            self.event,
            self.clock_class_priority_map,
        )
        other_props = (
            other.event,
            other.clock_class_priority_map,
        )
        return self_props == other_props

    def _copy(self, copy_func):
        # We can always use references here because those properties are
        # frozen anyway if they are part of a notification. Since the
        # user cannot modify them after copying the notification, it's
        # useless to copy/deep-copy them.
        return EventNotification(self.event, self.clock_class_priority_map)


class PacketBeginningNotification(_CopyableNotification):
    _TYPE = native_bt.NOTIFICATION_TYPE_PACKET_BEGIN

    def __init__(self, packet):
        utils._check_type(packet, bt2.packet._Packet)
        ptr = native_bt.notification_packet_begin_create(packet._ptr)

        if ptr is None:
            raise bt2.CreationError('cannot create packet beginning notification object')

        super().__init__(ptr)

    @property
    def packet(self):
        packet_ptr = native_bt.notification_packet_begin_get_packet(self._ptr)
        assert(packet_ptr)
        return bt2.packet._Packet._create_from_ptr(packet_ptr)

    def __eq__(self, other):
        if type(other) is not type(self):
            return False

        if self.addr == other.addr:
            return True

        return self.packet == other.packet

    def _copy(self, copy_func):
        # We can always use references here because those properties are
        # frozen anyway if they are part of a notification. Since the
        # user cannot modify them after copying the notification, it's
        # useless to copy/deep-copy them.
        return PacketBeginningNotification(self.packet)


class PacketEndNotification(_CopyableNotification):
    _TYPE = native_bt.NOTIFICATION_TYPE_PACKET_END

    def __init__(self, packet):
        utils._check_type(packet, bt2.packet._Packet)
        ptr = native_bt.notification_packet_end_create(packet._ptr)

        if ptr is None:
            raise bt2.CreationError('cannot create packet end notification object')

        super().__init__(ptr)

    @property
    def packet(self):
        packet_ptr = native_bt.notification_packet_end_get_packet(self._ptr)
        assert(packet_ptr)
        return bt2.packet._Packet._create_from_ptr(packet_ptr)

    def __eq__(self, other):
        if type(other) is not type(self):
            return False

        if self.addr == other.addr:
            return True

        return self.packet == other.packet

    def _copy(self, copy_func):
        # We can always use references here because those properties are
        # frozen anyway if they are part of a notification. Since the
        # user cannot modify them after copying the notification, it's
        # useless to copy/deep-copy them.
        return PacketEndNotification(self.packet)


class StreamBeginningNotification(_CopyableNotification):
    _TYPE = native_bt.NOTIFICATION_TYPE_STREAM_BEGIN

    def __init__(self, stream):
        utils._check_type(stream, bt2.stream._Stream)
        ptr = native_bt.notification_stream_begin_create(stream._ptr)

        if ptr is None:
            raise bt2.CreationError('cannot create stream beginning notification object')

        super().__init__(ptr)

    @property
    def stream(self):
        stream_ptr = native_bt.notification_stream_begin_get_stream(self._ptr)
        assert(stream_ptr)
        return bt2.stream._create_from_ptr(stream_ptr)

    def __eq__(self, other):
        if type(other) is not type(self):
            return False

        if self.addr == other.addr:
            return True

        return self.stream == other.stream

    def _copy(self, copy_func):
        # We can always use references here because those properties are
        # frozen anyway if they are part of a notification. Since the
        # user cannot modify them after copying the notification, it's
        # useless to copy/deep-copy them.
        return StreamBeginningNotification(self.stream)


class StreamEndNotification(_CopyableNotification):
    _TYPE = native_bt.NOTIFICATION_TYPE_STREAM_END

    def __init__(self, stream):
        utils._check_type(stream, bt2.stream._Stream)
        ptr = native_bt.notification_stream_end_create(stream._ptr)

        if ptr is None:
            raise bt2.CreationError('cannot create stream end notification object')

        super().__init__(ptr)

    @property
    def stream(self):
        stream_ptr = native_bt.notification_stream_end_get_stream(self._ptr)
        assert(stream_ptr)
        return bt2.stream._create_from_ptr(stream_ptr)

    def __eq__(self, other):
        if type(other) is not type(self):
            return False

        if self.addr == other.addr:
            return True

        return self.stream == other.stream

    def _copy(self, copy_func):
        # We can always use references here because those properties are
        # frozen anyway if they are part of a notification. Since the
        # user cannot modify them after copying the notification, it's
        # useless to copy/deep-copy them.
        return StreamEndNotification(self.stream)


class InactivityNotification(_CopyableNotification):
    _TYPE = native_bt.NOTIFICATION_TYPE_INACTIVITY

    def __init__(self, cc_prio_map=None):
        if cc_prio_map is not None:
            utils._check_type(cc_prio_map, bt2.clock_class_priority_map.ClockClassPriorityMap)
            cc_prio_map_ptr = cc_prio_map._ptr
        else:
            cc_prio_map_ptr = None

        ptr = native_bt.notification_inactivity_create(cc_prio_map_ptr)

        if ptr is None:
            raise bt2.CreationError('cannot create inactivity notification object')

        super().__init__(ptr)

    @property
    def clock_class_priority_map(self):
        cc_prio_map_ptr = native_bt.notification_inactivity_get_clock_class_priority_map(self._ptr)
        assert(cc_prio_map_ptr)
        return bt2.clock_class_priority_map.ClockClassPriorityMap._create_from_ptr(cc_prio_map_ptr)

    def clock_value(self, clock_class):
        utils._check_type(clock_class, bt2.ClockClass)
        clock_value_ptr = native_bt.notification_inactivity_get_clock_value(self._ptr,
                                                                            clock_class._ptr)

        if clock_value_ptr is None:
            return

        clock_value = bt2.clock_class._create_clock_value_from_ptr(clock_value_ptr)
        return clock_value

    def add_clock_value(self, clock_value):
        utils._check_type(clock_value, bt2.clock_class._ClockValue)
        ret = native_bt.notification_inactivity_set_clock_value(self._ptr,
                                                                clock_value._ptr)
        utils._handle_ret(ret, "cannot set inactivity notification object's clock value")

    def _get_clock_values(self):
        clock_values = {}

        for clock_class in self.clock_class_priority_map:
            clock_value = self.clock_value(clock_class)

            if clock_value is None:
                continue

            clock_values[clock_class] = clock_value

        return clock_values

    def __eq__(self, other):
        if type(other) is not type(self):
            return False

        if self.addr == other.addr:
            return True

        self_props = (
            self.clock_class_priority_map,
            self._get_clock_values(),
        )
        other_props = (
            other.clock_class_priority_map,
            other._get_clock_values(),
        )
        return self_props == other_props

    def __copy__(self):
        cpy = InactivityNotification(self.clock_class_priority_map)

        for clock_class in self.clock_class_priority_map:
            clock_value = self.clock_value(clock_class)

            if clock_value is None:
                continue

            cpy.add_clock_value(clock_value)

        return cpy

    def __deepcopy__(self, memo):
        cc_prio_map_cpy = copy.deepcopy(self.clock_class_priority_map)
        cpy = InactivityNotification(cc_prio_map_cpy)

        # copy clock values
        for orig_clock_class in self.clock_class_priority_map:
            orig_clock_value = self.clock_value(orig_clock_class)

            if orig_clock_value is None:
                continue

            # find equivalent, copied clock class in CC priority map copy
            for cpy_clock_class in cc_prio_map_cpy:
                if cpy_clock_class == orig_clock_class:
                    break

            # create copy of clock value from copied clock class
            clock_value_cpy = cpy_clock_class(orig_clock_value.cycles)

            # set copied clock value in notification copy
            cpy.add_clock_value(clock_value_cpy)

        memo[id(self)] = cpy
        return cpy


class _DiscardedElementsNotification(_Notification):
    def __eq__(self, other):
        if type(other) is not type(self):
            return False

        if self.addr == other.addr:
            return True

        self_props = (
            self.count,
            self.stream,
            self.beginning_clock_value,
            self.end_clock_value,
        )
        other_props = (
            other.count,
            other.stream,
            other.beginning_clock_value,
            other.end_clock_value,
        )
        return self_props == other_props


class _DiscardedPacketsNotification(_DiscardedElementsNotification):
    _TYPE = native_bt.NOTIFICATION_TYPE_DISCARDED_PACKETS

    @property
    def count(self):
        count = native_bt.notification_discarded_packets_get_count(self._ptr)
        assert(count >= 0)
        return count

    @property
    def stream(self):
        stream_ptr = native_bt.notification_discarded_packets_get_stream(self._ptr)
        assert(stream_ptr)
        return bt2.stream._create_from_ptr(stream_ptr)

    @property
    def beginning_clock_value(self):
        clock_value_ptr = native_bt.notification_discarded_packets_get_begin_clock_value(self._ptr)

        if clock_value_ptr is None:
            return

        clock_value = bt2.clock_class._create_clock_value_from_ptr(clock_value_ptr)
        return clock_value

    @property
    def end_clock_value(self):
        clock_value_ptr = native_bt.notification_discarded_packets_get_end_clock_value(self._ptr)

        if clock_value_ptr is None:
            return

        clock_value = bt2.clock_class._create_clock_value_from_ptr(clock_value_ptr)
        return clock_value


class _DiscardedEventsNotification(_DiscardedElementsNotification):
    _TYPE = native_bt.NOTIFICATION_TYPE_DISCARDED_EVENTS

    @property
    def count(self):
        count = native_bt.notification_discarded_events_get_count(self._ptr)
        assert(count >= 0)
        return count

    @property
    def stream(self):
        stream_ptr = native_bt.notification_discarded_events_get_stream(self._ptr)
        assert(stream_ptr)
        return bt2.stream._create_from_ptr(stream_ptr)

    @property
    def beginning_clock_value(self):
        clock_value_ptr = native_bt.notification_discarded_events_get_begin_clock_value(self._ptr)

        if clock_value_ptr is None:
            return

        clock_value = bt2.clock_class._create_clock_value_from_ptr(clock_value_ptr)
        return clock_value

    @property
    def end_clock_value(self):
        clock_value_ptr = native_bt.notification_discarded_events_get_end_clock_value(self._ptr)

        if clock_value_ptr is None:
            return

        clock_value = bt2.clock_class._create_clock_value_from_ptr(clock_value_ptr)
        return clock_value


_NOTIF_TYPE_TO_CLS = {
    native_bt.NOTIFICATION_TYPE_EVENT: EventNotification,
    native_bt.NOTIFICATION_TYPE_PACKET_BEGIN: PacketBeginningNotification,
    native_bt.NOTIFICATION_TYPE_PACKET_END: PacketEndNotification,
    native_bt.NOTIFICATION_TYPE_STREAM_BEGIN: StreamBeginningNotification,
    native_bt.NOTIFICATION_TYPE_STREAM_END: StreamEndNotification,
    native_bt.NOTIFICATION_TYPE_INACTIVITY: InactivityNotification,
    native_bt.NOTIFICATION_TYPE_DISCARDED_PACKETS: _DiscardedPacketsNotification,
    native_bt.NOTIFICATION_TYPE_DISCARDED_EVENTS: _DiscardedEventsNotification,
}