The entries are used to synchronize the state of services instances and the Publish/-Subscribe handling.
This page hosts a formal specification of AUTOSAR SOME/IP Service Discovery Entries using Kaitai Struct. This specification can be automatically translated into a variety of programming languages to get a parsing library.
All parsing code for Python generated by Kaitai Struct depends on the Python runtime library. You have to install it before you can parse data.
The Python runtime library can be installed from PyPI:
python3 -m pip install kaitaistruct
Parse a local file and get structure in memory:
data = SomeIpSdEntries.from_file("path/to/local/file.bin")
Or parse structure from a bytes:
from kaitaistruct import KaitaiStream, BytesIO
raw = b"\x00\x01\x02..."
data = SomeIpSdEntries(KaitaiStream(BytesIO(raw)))
After that, one can get various attributes from the structure by invoking getter methods like:
data.entries # => get entries
# This is a generated file! Please edit source .ksy file and use kaitai-struct-compiler to rebuild
import kaitaistruct
from kaitaistruct import KaitaiStruct, KaitaiStream, BytesIO
from enum import Enum
if getattr(kaitaistruct, 'API_VERSION', (0, 9)) < (0, 9):
raise Exception("Incompatible Kaitai Struct Python API: 0.9 or later is required, but you have %s" % (kaitaistruct.__version__))
class SomeIpSdEntries(KaitaiStruct):
"""The entries are used to synchronize the state of services instances and the
Publish/-Subscribe handling.
.. seealso::
section 4.1.2.3 Entry Format - https://www.autosar.org/fileadmin/standards/foundation/19-11/AUTOSAR_PRS_SOMEIPServiceDiscoveryProtocol.pdf
-
"""
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.entries = []
i = 0
while not self._io.is_eof():
self.entries.append(SomeIpSdEntries.SdEntry(self._io, self, self._root))
i += 1
class SdEntry(KaitaiStruct):
class EntryTypes(Enum):
find = 0
offer = 1
subscribe = 6
subscribe_ack = 7
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.header = SomeIpSdEntries.SdEntry.SdEntryHeader(self._io, self, self._root)
_on = self.header.type
if _on == SomeIpSdEntries.SdEntry.EntryTypes.find:
self.content = SomeIpSdEntries.SdEntry.SdServiceEntry(self._io, self, self._root)
elif _on == SomeIpSdEntries.SdEntry.EntryTypes.offer:
self.content = SomeIpSdEntries.SdEntry.SdServiceEntry(self._io, self, self._root)
elif _on == SomeIpSdEntries.SdEntry.EntryTypes.subscribe:
self.content = SomeIpSdEntries.SdEntry.SdEventgroupEntry(self._io, self, self._root)
elif _on == SomeIpSdEntries.SdEntry.EntryTypes.subscribe_ack:
self.content = SomeIpSdEntries.SdEntry.SdEventgroupEntry(self._io, self, self._root)
class SdEntryHeader(KaitaiStruct):
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.type = KaitaiStream.resolve_enum(SomeIpSdEntries.SdEntry.EntryTypes, self._io.read_u1())
self.index_first_options = self._io.read_u1()
self.index_second_options = self._io.read_u1()
self.number_first_options = self._io.read_bits_int_be(4)
self.number_second_options = self._io.read_bits_int_be(4)
self._io.align_to_byte()
self.service_id = self._io.read_u2be()
self.instance_id = self._io.read_u2be()
self.major_version = self._io.read_u1()
self.ttl = self._io.read_bits_int_be(24)
class SdServiceEntry(KaitaiStruct):
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.minor_version = self._io.read_u4be()
class SdEventgroupEntry(KaitaiStruct):
def __init__(self, _io, _parent=None, _root=None):
self._io = _io
self._parent = _parent
self._root = _root if _root else self
self._read()
def _read(self):
self.reserved = self._io.read_u1()
self.initial_data_requested = self._io.read_bits_int_be(1) != 0
self.reserved2 = self._io.read_bits_int_be(3)
self.counter = self._io.read_bits_int_be(4)
self._io.align_to_byte()
self.event_group_id = self._io.read_u2be()