configuration_base_classes.py

#!/usr/bin/python

# Automotive configuration file scripts
# Copyright (C) 2015-2023  Dr. Lars Voelker
# Copyright (C) 2018-2019  Dr. Lars Voelker, BMW AG
# Copyright (C) 2020-2023  Dr. Lars Voelker, Technica Engineering GmbH

# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
# 
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

import ipaddress
import macaddress


def bits_to_bytes(bits):
    if bits % 8 == 0:
        return bits // 8
    else:
        return (bits // 8) + 1


def is_mcast(addr):
    if is_ip_mcast(addr):
        return True

    if is_mac_mcast(addr):
        return True

    return False


def addr_to_key(addr):
    if addr is None:
        return "None"

    if is_ip(addr):
        return ip_to_key(addr)

    if is_mac(addr):
        return mac_to_key(addr)

    print(f"Warning: addr_to_key was called with {addr} and this seems to be no IP or MAC Address!")
    return "None"

def is_mac(mac):
    if mac is None:
        return False

    try:
        tmp = macaddress.EUI48(mac)
    except ValueError:
        return False

    return True


def is_mac_mcast(mac):
    try:
        tmp = macaddress.EUI48(mac)
    except ValueError:
        return False

    return (tmp.__bytes__()[0] & 0x01) == 0x01


def mac_to_key(mac):
    if mac is None:
        return f"None"

    try:
        tmp = macaddress.EUI48(mac)
    except ValueError:
        return False

    return f"mac-{str(tmp)}"


def is_ip(ip):
    if ip is None:
        return False

    try:
        ip = ipaddress.ip_address(ip)
    except ValueError:
        return False

    return True


def is_ip_mcast(ip):
    try:
        ip = ipaddress.ip_address(ip)
    except ValueError:
        return False

    return ip.is_multicast

def ip_to_key(ip):
    if ip is None:
        return f"None"

    try:
        tmp = ipaddress.ip_address(ip)
    except ValueError:
        return f"None"

    key = f"ipvx-{ip}"

    if tmp.version == 4:
        key = f"ipv4-{tmp.packed[0]:03}.{tmp.packed[1]:03}.{tmp.packed[2]:03}.{tmp.packed[3]:03}"
    elif tmp.version == 6:
        key = f"ipv6-{tmp.exploded}"
    return key


def mcast_addr_to_mac_mcast(addr):
    if is_mac_mcast(addr):
        return addr

    if is_ip_mcast(addr):
        tmp = ipaddress.ip_address(addr)
        return f"01:00:5e:{(tmp.packed[1] & 127):02x}:{tmp.packed[2]:02x}:{tmp.packed[3]:02x}"

    return ""


class BaseConfigurationFactory(object):
    def create_vlan(self, name, vlanid, prio):
        return BaseVLAN(name, vlanid, prio)

    def create_multicast_path(self, switchport_tx, vlan_tx, src_addr, switchport_rx, vlan_rx, mcast_addr, comment):
        return BaseMulticastPath(switchport_tx, vlan_tx, src_addr, switchport_rx, vlan_rx, mcast_addr, comment)

    def create_switch(self, name, ecu, ports):
        return BaseSwitch(name, ecu, ports)

    def create_switch_port(self, portid, ctrl, port, default_vlan, vlans):
        return BaseSwitchPort(portid, ctrl, port, default_vlan, vlans)

    def create_ethernet_bus(self, name, connected_ctrls, switch_ports):
        return BaseEthernetBus(name, connected_ctrls, switch_ports)

    def create_ecu(self, name, controllers):
        return BaseECU(name, controllers)

    def create_controller(self, name, interfaces):
        return BaseController(name, interfaces)

    def create_interface(self, name, vlanid, ips, sockets):
        return BaseInterface(name, vlanid, ips, sockets)

    def create_socket(self, name, ip, proto, portnumber,
                      serviceinstances, serviceinstanceclients, eventhandlers, evengroupreceivers
                      ):
        return BaseSocket(name, ip, proto, portnumber,
                          serviceinstances, serviceinstanceclients, eventhandlers, evengroupreceivers
                          )

    def create_someip_service_instance(self, service, instanceid, protover):
        return SOMEIPBaseServiceInstance(service, instanceid, protover)

    def create_someip_service_instance_client(self, service, instanceid, protover, server):
        return SOMEIPBaseServiceInstanceClient(service, instanceid, protover, server)

    def create_someip_service_eventgroup_sender(self, serviceinstance, eventgroupid):
        return SOMEIPBaseServiceEventgroupSender(serviceinstance, eventgroupid)

    def create_someip_service_eventgroup_receiver(self, serviceinstance, eventgroupid, sender):
        return SOMEIPBaseServiceEventgroupReceiver(serviceinstance, eventgroupid, sender)

    def create_someip_service(self, name, serviceid, majorver, minorver, methods, events, fields, eventgroups):
        return SOMEIPBaseService(name, serviceid, majorver, minorver, methods, events, fields, eventgroups)

    def create_someip_service_method(self, name, methodid, calltype, relia, inparams, outparams,
                                     reqdebounce=-1, reqmaxretention=-1, resmaxretention=-1, tlv=False):
        return SOMEIPBaseServiceMethod(name, methodid, calltype, relia, inparams, outparams,
                                       reqdebounce, reqmaxretention, resmaxretention, tlv)

    def create_someip_service_event(self, name, methodid, relia, params,
                                    debounce=-1, maxretention=-1, tlv=False):
        return SOMEIPBaseServiceEvent(name, methodid, relia, params,
                                      debounce, maxretention, tlv)

    def create_someip_service_field(self, name, getterid, setterid, notifierid,
                                    getterreli, setterreli, notifierreli, params,
                                    getter_debouncereq, getter_retentionreq, getter_retentionres,
                                    setter_debouncereq, setter_retentionreq, setter_retentionres,
                                    notifier_debounce, notifier_retention, tlv=False):
        ret = SOMEIPBaseServiceField(self, name, getterid, setterid, notifierid,
                                     getterreli, setterreli, notifierreli, params,
                                     getter_debouncereq, getter_retentionreq, getter_retentionres,
                                     setter_debouncereq, setter_retentionreq, setter_retentionres,
                                     notifier_debounce, notifier_retention, tlv)
        return ret

    def create_someip_service_eventgroup(self, name, eid, eventids, fieldids):
        return SOMEIPBaseServiceEventgroup(name, eid, eventids, fieldids)

    def create_someip_parameter(self, position, name, desc, mandatory, datatype, signal):
        return SOMEIPBaseParameter(position, name, desc, mandatory, datatype, signal)

    def create_someip_parameter_basetype(self, name, datatype, bigendian, bitlength_basetype, bitlength_encoded_type):
        return SOMEIPBaseParameterBasetype(name, datatype, bigendian, bitlength_basetype, bitlength_encoded_type)

    def create_someip_parameter_string(self, name, chartype, bigendian, lowerlimit, upperlimit, termination,
                                       length_of_length, pad_to):
        return SOMEIPBaseParameterString(name, chartype, bigendian, lowerlimit, upperlimit, termination,
                                         length_of_length, pad_to)

    def create_someip_parameter_array(self, name, dims, child):
        return SOMEIPBaseParameterArray(name, dims, child)

    def create_someip_parameter_array_dim(self, dim, lowerlimit, upperlimit, length_of_length, pad_to):
        return SOMEIPBaseParameterArrayDim(dim, lowerlimit, upperlimit, length_of_length, pad_to)

    def create_someip_parameter_struct(self, name, length_of_length, pad_to, members, tlv=False):
        return SOMEIPBaseParameterStruct(name, length_of_length, pad_to, members, tlv)

    def create_someip_parameter_struct_member(self, position, name, mandatory, child, signal):
        return SOMEIPBaseParameterStructMember(position, name, mandatory, child, signal)

    def create_someip_parameter_typedef(self, name, name2, child):
        return SOMEIPBaseParameterTypedef(name, name2, child)

    def create_someip_parameter_enumeration(self, name, items, child):
        return SOMEIPBaseParameterEnumeration(name, items, child)

    def create_someip_parameter_enumeration_item(self, value, name, desc):
        return SOMEIPBaseParameterEnumerationItem(value, name, desc)

    def create_someip_parameter_union(self, name, length_of_length, length_of_type, pad_to, members):
        return SOMEIPBaseParameterUnion(name, length_of_length, length_of_type, pad_to, members)

    def create_someip_parameter_union_member(self, index, name, mandatory, child):
        return SOMEIPBaseParameterUnionMember(index, name, mandatory, child)

    def create_legacy_signal(self, id, name, compu_scale, compu_consts):
        return SOMEIPBaseLegacySignal(id, name, compu_scale, compu_consts)

    def create_pdu_route(self, sender_socket, receiving_socket, pdu_name, pdu_id):
        if sender_socket.is_multicast():
            print(f"ERROR: Multicast Sockets cannot be used for sending!"
                  f" {sender_socket.ip()} -> {receiving_socket.ip()}: {pdu_name} 0x{pdu_id:08x}")
            return False
        return True

    def parsing_done(self):
        pass

class BaseItem(object):
    def legacy(self):
        return False


class BaseVLAN(BaseItem):
    def __init__(self, vlan_name, vlan_id, priority):
        self.__vlan_name__ = vlan_name
        self.__vlan_id__ = vlan_id
        self.__priority__ = priority

    def name(self):
        return self.__vlan_name__

    def vlanid(self):
        return self.__vlan_id__

    def priority(self):
        return self.__priority__


class BaseMulticastPath(BaseItem):
    def __init__(self, switchport_tx, vlanid_tx, source_addr, switchport_rx, vlanid_rx, multicast_addr, comment):
        if vlanid_tx != vlanid_rx:
            print(f"Currently only Multicast Path with same VLAN supported Addr:{multicast_addr} vlan_tx:{vlanid_tx} "
                  f"vlan_rx:{vlanid_rx}!")
            return None

        self.__vlanid__ = vlanid_tx
        self.__tx_addr__ = source_addr
        self.__mc_addr__ = multicast_addr
        self.__swport_tx__ = switchport_tx
        self.__swport_rx__ = switchport_rx
        self.__comment__ = comment

    def vlanid(self):
        return self.__vlanid__

    def source_addr(self):
        return self.__tx_addr__

    def mc_addr(self):
        return self.__mc_addr__

    def switchport_tx(self):
        return self.__swport_tx__

    def switchport_tx_name(self):
        if self.__swport_tx__ is None:
            return None
        else:
            return self.__swport_tx__.portid()

    def switchport_rx(self):
        return self.__swport_rx__

    def switchport_rx_name(self):
        if self.__swport_rx__ is None:
            return None
        else:
            return self.__swport_rx__.portid()

    def comment(self):
        return self.__comment__

    def __append_to_comment__(self, txt):
        self.__comment__ += txt


class BaseSwitchPort(BaseItem):
    # TODO: we need to add ethernet_bus to init!?
    def __init__(self, portid, ctrl, port, default_vlan, vlans):
        assert(ctrl is None or port is None)

        self.__portid__ = portid
        self.__ctrl__ = ctrl
        self.__port__ = port
        self.__eth_bus__ = None
        self.__default_vlan__ = default_vlan
        self.__vlans__ = vlans
        self.__switch__ = None

    def __repr__(self):
        switch_name = "<unknown>"
        if self.__switch__ is not None:
            switch_name = self.__switch__.name()

        return f"{switch_name}.{self.__portid__}"

    def portid_full(self, gen_name=False):
        portid = self.portid(gen_name=gen_name)
        if self.switch() is not None:
            if self.switch().ecu() is not None:
                return f"{self.switch().ecu().name()}.{self.switch().name()}.{portid}"
            return f".{self.switch().name()}.{portid}"
        else:
            return f"..{portid}"

    def portid(self, gen_name=False):
        if gen_name:
            return self.portid_generated()

        return self.__portid__

    def portid_generated(self):
        if self.__port__ is not None:
            return f"couplingPort_ConnectTo_{self.__port__.switch().name()}"
        if self.__ctrl__ is not None:
            return f"couplingPort_ConnectTo_{self.__ctrl__.name()}"
        if self.__eth_bus__ is not None:
            return f"couplingPort_ConnectTo_{self.__eth_bus__.name()}"

        return self.__portid__

    def set_parent_switch(self, switch):
        self.__switch__ = switch

    def switch(self):
        return self.__switch__

    def set_connected_port(self, peer_port):
        assert (peer_port is not None)
        assert (self.__port__ is None)

        if self.__ctrl__ is not None or self.__eth_bus__ is not None != 0:
            print(f"WARNING: SwitchPort {self.__portid__} adds port but was connected before! Overwritting!")

        self.__port__ = peer_port

    def connected_to_port(self):
        return self.__port__

    def set_ethernet_bus(self, eth_bus):
        assert(eth_bus is not None)
        assert(self.__eth_bus__ is None)

        if self.__ctrl__ is not None or self.__eth_bus__ is not None:
            print(f"WARNING: SwitchPort {self.__portid__} adds eth bus but was connected before! Overwritting!")

        self.__eth_bus__ = eth_bus

    def connected_to_eth_bus(self):
        return self.__eth_bus__

    def set_connected_ctrl(self, peer_ctrl):
        assert (peer_ctrl is not None)
        assert (self.__ctrl__ is None)

        if self.__port__ is not None or self.__eth_bus__ is not None:
            print(f"WARNING: SwitchPort {self.__portid__} adds ctrl to port but was connected before! Overwritting!")

        self.__ctrl__ = peer_ctrl
        peer_ctrl.set_switch_port(self)

    def connected_to_ecu_ctrl(self):
        return self.__ctrl__

    def vlans(self):
        vlans = []

        for vlan in self.__vlans__:
            if vlan.vlanid() is None:
                vlans += [0]
            else:
                vlans += [int(vlan.vlanid())]

        return sorted(vlans)

    def vlans_as_strings(self):
        ret = []

        for vlan in self.vlans():
            if vlan == 0:
                ret += ["untagged"]
            else:
                ret += [f"0x{vlan:x}"]

        return ret


class BaseSwitch(BaseItem):
    def __init__(self, name, ecu, ports):
        self.__name__ = name
        self.__ports__ = ports
        self.__ecu__ = ecu

        if ecu is not None:
            ecu.add_switch(self)

        for port in ports:
            port.set_parent_switch(self)

    def name(self):
        return self.__name__

    def ecu(self):
        return self.__ecu__

    def ports(self):
        return self.__ports__

    def key(self):
        if self.__ecu__ is None:
            return f"None.{self.name()}"

        return f"{self.ecu().name()}.{self.name()}"

class BaseEthernetBus(BaseItem):
    def __init__(self, name, connected_ctrls, switch_ports):
        self.__name__ = name
        self.__ctrls__ = connected_ctrls
        self.__ports__ = switch_ports

        # connect the controllers to us!
        for ctrl in connected_ctrls:
            ctrl.set_eth_bus(self)

    def name(self):
        return self.__name__

    def connected_controllers(self):
        return self.__ctrls__

    def switch_ports(self):
        return self.__ports__


class BaseECU(BaseItem):
    def __init__(self, name, controllers):
        self.__name__ = name
        self.__controllers__ = controllers
        self.__switches__ = []

        for c in controllers:
            c.set_ecu(self)

    def name(self):
        return self.__name__

    def controllers(self):
        return self.__controllers__

    def add_switch(self, switch):
        self.__switches__.append(switch)

    def switches(self):
        return self.__switches__


class BaseController(BaseItem):
    def __init__(self, name, interfaces):
        self.__name__ = name
        self.__interfaces__ = interfaces
        self.__ecu__ = None
        self.__peer_port__ = None
        self.__eth_bus__ = None

        for i in interfaces:
            i.set_controller(self)

    def name(self):
        return self.__name__

    def interfaces(self):
        return self.__interfaces__

    def vlans(self):
        ret = []
        vlans = []

        for interface in self.__interfaces__:
            if interface.vlanid() is None:
                vlans += [0]
            else:
                vlans += [int(interface.vlanid())]

        return sorted(vlans)

    def set_ecu(self, ecu):
        self.__ecu__ = ecu

    def ecu(self):
        return self.__ecu__

    def set_switch_port(self, peer_port):
        assert(self.__peer_port__ is None)
        assert(self.__eth_bus__ is None)
        self.__peer_port__ = peer_port

    def get_switch_port(self):
        return self.__peer_port__

    def set_eth_bus(self, eth_buf):
        assert(self.__peer_port__ is None)
        assert(self.__eth_bus__ is None)
        self.__eth_bus__ = eth_buf

    def get_eth_bus(self):
        return self.__eth_bus__

class BaseInterface(BaseItem):
    def __init__(self, vlanname, vlanid, ips, sockets):
        self.__vlanname__ = vlanname
        self.__sockets__ = sockets
        self.__ips__ = ips

        self.__controller__ = None

        if vlanid is None:
            self.__vlanid__ = 0
        else:
            self.__vlanid__ = int(vlanid)

        for s in sockets:
            s.set_interface(self)

    def vlanname(self):
        return self.__vlanname__

    def vlanid(self):
        return self.__vlanid__

    def ips(self):
        return self.__ips__

    def ips_without_socket(self):
        tmp = []
        for socket in self.__sockets__:
            tmp.append(socket.ip())

        ret = []
        for ip in self.__ips__:
            if ip not in tmp:
                ret.append(ip)

        return ret

    def sockets(self):
        return self.__sockets__

    def set_controller(self, controller):
        self.__controller__ = controller

    def controller(self):
        return self.__controller__


class BaseSocket(BaseItem):
    def __init__(self, name, ip, proto, portnumber, serviceinstances, serviceinstanceclients, eventhandlers,
                 eventgroupreceivers):
        self.__name__ = name
        self.__ip__ = ip

        try:
            self.__ipaddress__ = ipaddress.ip_address(ip)
        except ValueError:
            self.__ipaddress__ = None

        self.__proto__ = proto
        self.__portnumber__ = int(portnumber)
        self.__instances__ = serviceinstances
        self.__instanceclients__ = serviceinstanceclients
        self.__ehs__ = eventhandlers
        self.__cegs__ = eventgroupreceivers
        self.__interface__ = None

        if serviceinstances is not None:
            for i in serviceinstances:
                i.setsocket(self)

        if serviceinstanceclients is not None:
            for i in serviceinstanceclients:
                i.setsocket(self)

        if eventhandlers is not None:
            for i in eventhandlers:
                i.setsocket(self)

        if eventgroupreceivers is not None:
            for i in eventgroupreceivers:
                i.setsocket(self)

    # TODO: XXX REMOVE AGAIN?
    def __eq__(self, other):
        if not isinstance(other, BaseSocket):
            # don't attempt to compare against unrelated types
            return NotImplemented

        self_if = None if self.__interface__ is None else self.__interface__.controller().name()
        othr_if = None if other.__interface__ is None else other.__interface__.controller().name()

        return self.__name__ == other.__name__ and self.__ip__ == other.__ip__ \
               and self.__ipaddress__ == other.__ipaddress__ and self.__proto__ == other.__proto__ \
               and  self.__portnumber__ == other.__portnumber__ and self_if != othr_if

    def name(self):
        return self.__name__

    def ip(self):
        return self.__ip__

    def is_ipv4(self):
        return type(self.__ipaddress__) == ipaddress.IPv4Address

    def is_ipv6(self):
        return type(self.__ipaddress__) == ipaddress.IPv6Address

    def is_multicast(self):
        return self.__ipaddress__ is not None and self.__ipaddress__.is_multicast

    def proto(self):
        return self.__proto__

    def portnumber(self):
        return self.__portnumber__

    def instances(self):
        return self.__instances__

    def serviceinstanceclients(self):
        return self.__instanceclients__

    def eventhandlers(self):
        return self.__ehs__

    def eventgroupreceivers(self):
        return self.__cegs__

    def set_interface(self, interface):
        self.__interface__ = interface

    def interface(self):
        return self.__interface__


class SOMEIPBaseServiceInstance(BaseItem):
    def __init__(self, service, instanceid, protover):
        self.__service__ = service
        self.__instanceid__ = int(instanceid)
        self.__protover__ = int(protover)
        self.__socket__ = None

        self.__clients__ = []
        self.__eventgroup_sender__ = []
        self.__eventgroup_receiver__ = []

        service.add_instance(self)

    def service(self):
        return self.__service__

    def instanceid(self):
        return self.__instanceid__

    def protover(self):
        return self.__protover__

    def serviceinstanceclients(self):
        return self.__clients__

    def addclient(self, client):
        if client not in self.__clients__:
            self.__clients__.append(client)

    def eventgroupsender(self):
        return self.__eventgroup_sender__

    def addeventgroupsender(self, eh):
        if eh not in self.__eventgroup_sender__:
            self.__eventgroup_sender__.append(eh)

    def eventgroupreceiver(self):
        return self.__eventgroup_receiver__

    def addeventgroupreceiver(self, ceg):
        if ceg not in self.__eventgroup_receiver__:
            self.__eventgroup_receiver__.append(ceg)

    def setsocket(self, socket):
        self.__socket__ = socket

    def socket(self):
        return self.__socket__


class SOMEIPBaseServiceInstanceClient(BaseItem):
    def __init__(self, service, instanceid, protover, instance):
        self.__service__ = service
        self.__instanceid__ = int(instanceid)
        self.__protover__ = int(protover)
        self.__instance__ = instance
        self.__socket__ = None

        if instance is not None:
            instance.addclient(self)

    def service(self):
        return self.__service__

    def instanceid(self):
        return self.__instanceid__

    def protover(self):
        return self.__protover__

    def instance(self):
        return self.__instance__

    def setsocket(self, socket):
        self.__socket__ = socket

    def socket(self):
        return self.__socket__


class SOMEIPBaseServiceEventgroupSender(BaseItem):
    def __init__(self, serviceinstance, eventgroupid):
        self.__si__ = serviceinstance
        self.__eventgroupid__ = int(eventgroupid)
        self.__eventgroupreceivers__ = []
        self.__socket__ = None

    def serviceinstance(self):
        return self.__si__

    def eventgroupid(self):
        return self.__eventgroupid__

    def eventgroupreceivers(self):
        return self.__eventgroupreceivers__

    def addreceiver(self, receiver):
        if receiver not in self.__eventgroupreceivers__:
            self.__eventgroupreceivers__.append(receiver)

    def setsocket(self, socket):
        self.__socket__ = socket

    def socket(self):
        return self.__socket__


class SOMEIPBaseServiceEventgroupReceiver(BaseItem):
    def __init__(self, serviceinstance, eventgroupid, sender):
        self.__si__ = serviceinstance
        self.__eventgroupid__ = int(eventgroupid)
        self.__sender__ = sender
        self.__socket__ = None

        if sender is not None:
            sender.addreceiver(self)

    def serviceinstance(self):
        return self.__si__

    def eventgroupid(self):
        return self.__eventgroupid__

    def sender(self):
        return self.__sender__

    def setsocket(self, socket):
        self.__socket__ = socket

    def socket(self):
        return self.__socket__


class SOMEIPBaseService(BaseItem):
    def __init__(self, name, serviceid, majorver, minorver, methods, events, fields, eventgroups):
        self.__name__ = name
        self.__serviceid__ = int(serviceid)
        self.__major__ = int(majorver)
        self.__minor__ = int(minorver)

        self.__methods__ = methods
        self.__events__ = events
        self.__fields__ = fields
        self.__eventgroups__ = eventgroups

        self.__instances__ = []

    def serviceid(self):
        return self.__serviceid__

    def majorversion(self):
        return self.__major__

    def minorversion(self):
        return self.__minor__

    def versionstring(self):
        return "%d.%d" % (self.__major__, self.__minor__)

    def name(self):
        return self.__name__

    def methods(self):
        return self.__methods__

    def method(self, mid):
        if mid in self.__methods__:
            return self.__methods__[mid]
        return None

    def events(self):
        return self.__events__

    def event(self, eid):
        if eid in self.__events__:
            return self.__events__[eid]
        return None

    def fields(self):
        return self.__fields__

    def field(self, fid):
        if fid in self.__fields__:
            return self.__fields__[fid]
        return None

    def eventgroups(self):
        return self.__eventgroups__

    def eventgroup(self, egid):
        if egid in self.__eventgroups__:
            return self.__eventgroups__[id]
        return None

    def add_instance(self, serviceinstance):
        self.__instances__.append(serviceinstance)

    def remove_instance(self, serviceinstance):
        self.__instances__.remove(serviceinstance)

    def instances(self):
        return self.__instances__


class SOMEIPBaseServiceMethod(BaseItem):
    def __init__(self, name, methodid, calltype, relia, inparams, outparams, reqdebounce=-1, reqmaxretention=-1,
                 resmaxretention=-1, tlv=False):
        self.__name__ = name
        self.__methodid__ = methodid
        self.__calltype__ = calltype
        self.__reliable__ = relia

        self.__inparams__ = inparams
        self.__outparams__ = outparams

        self.__reqdebouncetime__ = reqdebounce
        self.__reqretentiontime___ = reqmaxretention
        self.__resretentiontime___ = resmaxretention
        self.__tlv__ = tlv

    def methodid(self):
        return self.__methodid__

    def name(self):
        return self.__name__

    def calltype(self):
        return self.__calltype__

    def reliable(self):
        return self.__reliable__

    def inparams(self):
        return self.__inparams__

    def outparams(self):
        return self.__outparams__

    def size_min_in(self):
        ret = 0
        for p in self.__inparams__:
            ret += p.size_min_bits()
        return bits_to_bytes(ret)

    def size_max_in(self):
        ret = 0
        for p in self.__inparams__:
            ret += p.size_max_bits()
        return bits_to_bytes(ret)

    def size_min_out(self):
        ret = 0
        for p in self.__outparams__:
            ret += p.size_min_bits()
        return bits_to_bytes(ret)

    def size_max_out(self):
        ret = 0
        for p in self.__outparams__:
            ret += p.size_max_bits()
        return bits_to_bytes(ret)

    def debounce_time_req(self):
        return self.__reqdebouncetime__

    def max_buffer_retention_time_req(self):
        return self.__reqretentiontime___

    def max_buffer_retention_time_res(self):
        return self.__resretentiontime___

    def legacy(self):
        for p in self.__inparams__:
            if p.legacy():
                return True
        for p in self.__outparams__:
            if p.legacy():
                return True
        return False

    def tlv(self):
        return self.__tlv__


class SOMEIPBaseServiceEvent(BaseItem):
    def __init__(self, name, methodid, relia, params, debouncetimerange=-1, maxbufferretentiontime=-1, tlv=False):
        self.__name__ = name
        self.__methodid__ = methodid
        self.__reliable__ = relia
        self.__params__ = params
        self.__debouncetime__ = debouncetimerange
        self.__retentiontime___ = maxbufferretentiontime
        self.__tlv__ = tlv

    def methodid(self):
        return self.__methodid__

    def name(self):
        return self.__name__

    def reliable(self):
        return self.__reliable__

    def params(self):
        return self.__params__

    @staticmethod
    def size_min_in():
        return 0

    @staticmethod
    def size_max_in():
        return 0

    def size_min_out(self):
        ret = 0
        for p in self.__params__:
            ret += p.size_min_bits()
        return bits_to_bytes(ret)

    def size_max_out(self):
        ret = 0
        for p in self.__params__:
            ret += p.size_max_bits()
        return bits_to_bytes(ret)

    def debounce_time(self):
        return self.__debouncetime__

    def max_buffer_retention_time(self):
        return self.__retentiontime___

    def legacy(self):
        for p in self.__params__:
            if p.legacy():
                return True
        return False

    def tlv(self):
        return self.__tlv__


class SOMEIPBaseServiceField(BaseItem):
    def __init__(self, config_factory, name, getterid, setterid, notifierid, getterreli, setterreli, notifierreli,
                 params,
                 getter_reqdebounce=-1, getter_reqmaxretention=-1, getter_resmaxretention=-1,
                 setter_reqdebounce=-1, setter_reqmaxretention=-1, setter_resmaxretention=-1,
                 notifier_debounce=-1, notifier_maxretention=-1,
                 tlv=False):
        self.__name__ = name

        self.__getter__ = None
        self.__setter__ = None
        self.__notifier__ = None
        self.__params__ = params

        self.__minimum_id__ = None

        self.__tlv__ = tlv

        if getterid is not None:
            self.__getter__ = config_factory.create_someip_service_method(
                name + "-Getter", getterid, "REQUEST_RESPONSE", getterreli, [], params,
                getter_reqdebounce, getter_reqmaxretention, getter_resmaxretention
            )

        if setterid is not None:
            self.__setter__ = config_factory.create_someip_service_method(
                name + "-Setter", setterid, "REQUEST_RESPONSE", setterreli, params, params,
                setter_reqdebounce, setter_reqmaxretention, setter_resmaxretention
            )

        if notifierid is not None:
            self.__notifier__ = config_factory.create_someip_service_event(
                name + "-Notifier", notifierid, notifierreli, params,
                notifier_debounce, notifier_maxretention
            )

        # find smallest ID after stripping None
        tmp = sorted([getterid, setterid, notifierid], key=lambda x: (x is None, x))
        if tmp[0] is None:
            print(f"ERROR: Field ({name}) without Getter/Setter/Notifier!")
            return

        self.__minimum_id__ = tmp[0]

        if self.__minimum_id__ == -1:
            self.__minimum_id__ = None

    def name(self):
        return self.__name__

    def params(self):
        return self.__params__

    def getter(self):
        return self.__getter__

    def setter(self):
        return self.__setter__

    def notifier(self):
        return self.__notifier__

    def min_id(self):
        return self.__minimum_id__

    def notifierid(self):
        if self.__notifier__ is None:
            return None
        return self.__notifier__.methodid()

    def id(self):
        if self.notifierid() is not None:
            return self.notifierid()
        return self.min_id()

    def size_min_in(self):
        ret = 0
        for p in self.__params__:
            ret += p.size_min_bits()
        return bits_to_bytes(ret)

    def size_max_in(self):
        ret = 0
        for p in self.__params__:
            ret += p.size_max_bits()
        return bits_to_bytes(ret)

    def size_min_out(self):
        ret = 0
        for p in self.__params__:
            ret += p.size_min_bits()
        return bits_to_bytes(ret)

    def size_max_out(self):
        ret = 0
        for p in self.__params__:
            ret += p.size_max_bits()
        return bits_to_bytes(ret)

    def legacy(self):
        if self.__params__ is None:
            return False

        for p in self.__params__:
            if p.legacy():
                return True

        return False

    def tlv(self):
        return self.__tlv__


class SOMEIPBaseServiceEventgroup(BaseItem):
    def __init__(self, name, egid, eventids, fieldids):
        self.__name__ = name
        self.__id__ = int(egid)
        self.__eventids__ = eventids
        self.__fieldids__ = fieldids

    def name(self):
        return self.__name__

    def id(self):
        return self.__id__

    def eventids(self):
        return self.__eventids__

    def fieldids(self):
        return self.__fieldids__


class SOMEIPBaseParameter(BaseItem):
    def __init__(self, position, name, desc, mandatory, datatype, signal):
        self.__position__ = int(position)
        self.__name__ = name
        self.__desc__ = desc
        self.__mandatory__ = mandatory
        self.__datatype__ = datatype
        self.__signal__ = signal

    def position(self):
        return self.__position__

    def name(self):
        return self.__name__

    def desc(self):
        return self.__desc__

    def mandatory(self):
        return self.__mandatory__

    def datatype(self):
        return self.__datatype__

    def signal(self):
        return self.__signal__

    def size_min_bits(self):
        return self.__datatype__.size_min_bits()

    def size_max_bits(self):
        return self.__datatype__.size_max_bits()

    def legacy(self):
        if self.__signal__ is not None:
            return True
        if self.__datatype__ is None:
            return False
        return self.__datatype__.legacy()


class SOMEIPBaseParameterBasetype(BaseItem):
    def __init__(self, name, datatype, bigendian, bitlength_basetype, bitlength_encoded_type):
        self.__name__ = name
        self.__datatype__ = datatype
        self.__bigendian__ = bigendian
        self.__bitlength_basetype__ = int(bitlength_basetype)
        self.__bitlength_encoded_type__ = int(bitlength_encoded_type)

    def name(self):
        return self.__name__

    def datatype(self):
        return self.__datatype__

    def bigendian(self):
        return self.__bigendian__

    def bitlength_basetype(self):
        return self.__bitlength_basetype__

    def bitlength_encoded_type(self):
        return self.__bitlength_encoded_type__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.datatype() == other.datatype() and
                self.bigendian() == other.bigendian() and
                self.bitlength_basetype() == other.bitlength_basetype() and
                self.bitlength_encoded_type() == other.bitlength_encoded_type()
        )

    def size_min_bits(self):
        return self.__bitlength_encoded_type__

    def size_max_bits(self):
        return self.__bitlength_encoded_type__


class SOMEIPBaseParameterString(BaseItem):
    def __init__(self, name, chartype, bigendian, lowerlimit, upperlimit, termination, length_of_length, pad_to):
        self.__name__ = name
        self.__chartype__ = chartype
        self.__bigendian__ = bigendian
        self.__lowerlimit__ = int(lowerlimit)
        self.__upperlimit__ = int(upperlimit)
        self.__termination__ = termination

        if length_of_length is None or length_of_length == -1:
            if lowerlimit == upperlimit:
                self.__lengthOfLength__ = 0
            else:
                self.__lengthOfLength__ = 32  # SOME/IP default
        else:
            self.__lengthOfLength__ = int(length_of_length)

        self.__padTo__ = int(pad_to)

    def name(self):
        return self.__name__

    def chartype(self):
        return self.__chartype__

    def bigendian(self):
        return self.__bigendian__

    def lowerlimit(self):
        return self.__lowerlimit__

    def upperlimit(self):
        return self.__upperlimit__

    def termination(self):
        return self.__termination__

    def length_of_length(self):
        return self.__lengthOfLength__

    def pad_to(self):
        return self.__padTo__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.chartype() == other.chartype() and
                self.bigendian() == other.bigendian() and
                self.lowerlimit() == other.lowerlimit() and
                self.upperlimit() == other.upperlimit() and
                self.termination() == other.termination() and
                self.length_of_length() == other.length_of_length() and
                self.pad_to() == other.pad_to()
        )

    def size_min_bits(self):
        # TODO: double check, if this is based on bytes or chars
        return self.__lengthOfLength__ + 8 * self.__lowerlimit__

    def size_max_bits(self):
        # TODO: double check, if this is based on bytes or chars
        return self.__lengthOfLength__ + 8 * self.__upperlimit__


class SOMEIPBaseParameterArray(BaseItem):
    def __init__(self, name, dims, child):
        self.__name__ = name
        self.__dims__ = dims
        self.__child__ = child

    def name(self):
        return self.__name__

    def dims(self):
        return self.__dims__

    def child(self):
        return self.__child__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return self.name() == other.name() and self.dims() == other.dims() and self.child() == other.child()

    def size_min_bits(self):
        ret = self.__child__.size_min_bits()

        # todo: is this the right order?
        for dim in self.__dims__.values():
            ret = dim.calc_size_min_bits(ret)

        return ret

    def size_max_bits(self):
        ret = self.__child__.size_min_bits()

        # todo: is this the right order?
        for dim in self.__dims__.values():
            ret = dim.calc_size_max_bits(ret)

        return ret


class SOMEIPBaseParameterArrayDim(BaseItem):
    def __init__(self, dim, lowerlimit, upperlimit, length_of_length, pad_to):
        self.__dim__ = int(dim)
        self.__lowerlimit__ = int(lowerlimit)
        self.__upperlimit__ = int(upperlimit)
        if length_of_length is None or length_of_length == -1:
            if lowerlimit == upperlimit:
                self.__lengthOfLength__ = 0
            else:
                self.__lengthOfLength__ = 32  # SOME/IP default
        else:
            self.__lengthOfLength__ = int(length_of_length)

        self.__padTo__ = int(pad_to)

    def dim(self):
        return self.__dim__

    def lowerlimit(self):
        return self.__lowerlimit__

    def upperlimit(self):
        return self.__upperlimit__

    def length_of_length(self):
        return self.__lengthOfLength__

    def pad_to(self):
        return self.__padTo__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.dim() == other.dim() and
                self.lowerlimit() == other.lowerlimit() and
                self.upperlimit() == other.upperlimit() and
                self.length_of_length() == other.length_of_length() and
                self.pad_to() == other.pad_to()
        )

    def calc_size_min_bits(self, inner_length):
        ret = self.__lowerlimit__ * inner_length
        # XXX - padTo completly untested since export dont have BIT-ALIGNMENT set (its counted in bits)
        if self.__padTo__ > 0:
            ret += ret % self.__padTo__

        return self.__lengthOfLength__ + ret

    def calc_size_max_bits(self, inner_length):
        ret = self.__upperlimit__ * inner_length
        # XXX - padTo completly untested since export dont have BIT-ALIGNMENT set (its counted in bits)
        if self.__padTo__ > 0:
            ret += ret % self.__padTo__

        return self.__lengthOfLength__ + ret


class SOMEIPBaseParameterStruct(BaseItem):
    def __init__(self, name, length_of_length, pad_to, members, tlv=False):
        self.__name__ = name
        self.__members__ = members
        self.__tlv__ = tlv

        if length_of_length is None or length_of_length == -1:
            self.__lengthOfLength__ = 0
        else:
            self.__lengthOfLength__ = int(length_of_length)

        self.__padTo__ = int(pad_to)

    def name(self):
        return self.__name__

    def members(self):
        return self.__members__

    def length_of_length(self):
        return self.__lengthOfLength__

    def pad_to(self):
        return self.__padTo__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.members() == other.members() and
                self.length_of_length() == other.length_of_length() and
                self.pad_to() == other.pad_to() and
                self.tlv() == other.tlv()
        )

    def size_min_bits(self):
        ret = self.__lengthOfLength__
        for m in self.__members__.values():
            ret += m.child().size_min_bits()
        return ret

    def size_max_bits(self):
        ret = self.__lengthOfLength__
        for m in self.__members__.values():
            ret += m.child().size_max_bits()
        return ret

    def legacy(self):
        for m in self.__members__.values():
            if m.legacy():
                return True
        return False

    def tlv(self):
        return self.__tlv__


class SOMEIPBaseParameterStructMember(BaseItem):
    def __init__(self, position, name, mandatory, child, signal):
        self.__name__ = name
        self.__position__ = int(position)
        self.__mandatory__ = mandatory
        self.__child__ = child
        self.__signal__ = signal

    def name(self):
        return self.__name__

    def position(self):
        return self.__position__

    def mandatory(self):
        return self.__mandatory__

    def child(self):
        return self.__child__

    def signal(self):
        return self.__signal__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.position() == other.position() and
                self.mandatory() == other.mandatory() and
                self.child() == other.child() and
                self.signal() == self.signal()
        )

    def legacy(self):
        if self.__signal__ is not None:
            return True
        return False


class SOMEIPBaseParameterTypedef(BaseItem):
    def __init__(self, name, name2, child):
        self.__name__ = name
        self.__name2__ = name2
        self.__child__ = child

    def name(self):
        return self.__name__

    def name2(self):
        return self.__name2__

    def child(self):
        return self.__child__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.name2() == other.name2() and
                self.child() == other.child()
        )

    def size_min_bits(self):
        return self.__child__.size_min_bits()

    def size_max_bits(self):
        return self.__child__.size_max_bits()


class SOMEIPBaseParameterEnumeration(BaseItem):
    def __init__(self, name, items, child):
        self.__name__ = name
        self.__items__ = items
        self.__child__ = child

    def name(self):
        return self.__name__

    def items(self):
        return self.__items__

    def child(self):
        return self.__child__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.items() == other.items() and
                self.child() == other.child()
        )

    def size_min_bits(self):
        return self.__child__.size_min_bits()

    def size_max_bits(self):
        return self.__child__.size_max_bits()


class SOMEIPBaseParameterEnumerationItem(BaseItem):
    def __init__(self, value, name, desc):
        self.__name__ = name
        self.__desc__ = desc
        self.__value__ = int(value)

    def name(self):
        return self.__name__

    def desc(self):
        return self.__desc__

    def value(self):
        return self.__value__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.desc() == other.desc() and
                self.value() == other.value()
        )


class SOMEIPBaseParameterUnion(BaseItem):
    def __init__(self, name, length_of_length, length_of_type, pad_to, members):
        self.__name__ = name
        self.__members__ = members

        if length_of_length is None or length_of_length == -1:
            self.__lengthOfLength__ = 32  # SOME/IP default
        else:
            self.__lengthOfLength__ = int(length_of_length)

        if length_of_type is None or length_of_type == -1:
            self.__lengthOfType__ = 32  # SOME/IP default
        else:
            self.__lengthOfType__ = int(length_of_type)

        self.__padTo__ = int(pad_to)

    def name(self):
        return self.__name__

    def members(self):
        return self.__members__

    def length_of_length(self):
        return self.__lengthOfLength__

    def length_of_type(self):
        return self.__lengthOfType__

    def pad_to(self):
        return self.__padTo__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.members() == other.members() and
                self.length_of_length() == other.length_of_length() and
                self.length_of_length() == other.length_of_length() and
                self.pad_to() == other.pad_to()
        )

    def size_min_bits(self):
        ret = -1

        for m in self.__members__.values():
            if ret == -1:
                ret = m.child().size_min_bits()
            else:
                if ret >= m.child().size_min_bits():
                    ret = m.child().size_min_bits()
            if self.__padTo__ > 0:
                ret += ret % self.pad_to()
        return self.__lengthOfLength__ + ret

    def size_max_bits(self):
        ret = -1

        for m in self.__members__.values():
            if ret == -1:
                ret = m.child().size_max_bits()
            else:
                if ret < m.child().size_max_bits():
                    ret = m.child().size_max_bits()
            if self.__padTo__ > 0:
                ret += ret % self.pad_to()
        return self.__lengthOfLength__ + ret


class SOMEIPBaseParameterUnionMember(BaseItem):
    def __init__(self, index, name, mandatory, child):
        self.__name__ = name
        self.__index__ = int(index)
        self.__mandatory__ = mandatory
        self.__child__ = child

    def name(self):
        return self.__name__

    def index(self):
        return self.__index__

    def mandatory(self):
        return self.__mandatory__

    def child(self):
        return self.__child__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.name() == other.name() and
                self.index() == other.index() and
                self.mandatory() == other.mandatory() and
                self.child() == other.child()
        )


class SOMEIPBaseLegacySignal(BaseItem):
    def __init__(self, id, name, compu_scale, compu_const):
        self.__id__ = id
        self.__name__ = name
        self.__compu_scale__ = compu_scale
        self.__compu_consts__ = compu_const

    def id(self):
        return self.__id__

    def name(self):
        return self.__name__

    def compu_scale(self):
        return self.__compu_scale__

    def compu_consts(self):
        return self.__compu_consts__

    def __eq__(self, other):
        if not isinstance(other, self.__class__):
            return False

        return (
                self.id() == self.id() and
                self.name() == other.name() and
                self.compu_scale() == other.compu_scale() and
                self.compu_consts() == other.compu_consts()
        )