sdfgen 0.16.1__cp313-cp313-macosx_14_0_arm64.whl → 0.18.0__cp313-cp313-macosx_14_0_arm64.whl

sdfgen/module.py

@@ -2,11 +2,12 @@ from __future__ import annotations
 import ctypes
 import importlib.util
 from ctypes import (
-    cast, c_void_p, c_char_p, c_uint8, c_uint16, c_uint32, c_uint64, c_bool, POINTER, byref
+    cast, c_void_p, c_char_p, c_uint8, c_uint16, c_uint32, c_uint64, c_bool, POINTER, byref, pointer
 )
 from typing import Optional, List, Tuple
 from enum import IntEnum
 
+
 class SddfStatus(IntEnum):
     OK = 0,
     DUPLICATE_CLIENT = 1,
@@ -14,6 +15,7 @@ class SddfStatus(IntEnum):
     NET_DUPLICATE_COPIER = 100,
     NET_DUPLICATE_MAC_ADDR = 101,
 
+
 # TOOD: double check
 MapPermsType = c_uint32
 
@@ -58,7 +60,15 @@ libsdfgen.sdfgen_render.restype = c_char_p
 libsdfgen.sdfgen_render.argtypes = [c_void_p]
 
 libsdfgen.sdfgen_channel_create.restype = c_void_p
-libsdfgen.sdfgen_channel_create.argtypes = [c_void_p, c_void_p]
+libsdfgen.sdfgen_channel_create.argtypes = [
+    c_void_p,
+    c_void_p,
+    POINTER(c_uint8),
+    POINTER(c_uint8),
+    POINTER(c_bool),
+    POINTER(c_bool),
+    POINTER(c_uint8),
+]
 libsdfgen.sdfgen_channel_destroy.restype = None
 libsdfgen.sdfgen_channel_destroy.argtypes = [c_void_p]
 libsdfgen.sdfgen_channel_get_pd_a_id.restype = c_uint8
@@ -75,6 +85,9 @@ libsdfgen.sdfgen_mr_create.restype = c_void_p
 libsdfgen.sdfgen_mr_create.argtypes = [c_char_p, c_uint64]
 libsdfgen.sdfgen_mr_create_physical.restype = c_void_p
 libsdfgen.sdfgen_mr_create_physical.argtypes = [c_char_p, c_uint64, c_uint64]
+libsdfgen.sdfgen_mr_get_paddr.restype = c_bool;
+libsdfgen.sdfgen_mr_get_paddr.argtypes = [c_void_p, POINTER(c_uint64)]
+
 libsdfgen.sdfgen_mr_destroy.restype = None
 libsdfgen.sdfgen_mr_destroy.argtypes = [c_void_p]
 
@@ -88,6 +101,9 @@ libsdfgen.sdfgen_vm_create.argtypes = [c_char_p, POINTER(c_void_p), c_uint32]
 libsdfgen.sdfgen_vm_destroy.restype = None
 libsdfgen.sdfgen_vm_destroy.argtypes = [c_void_p]
 
+libsdfgen.sdfgen_vm_set_priority.restype = None
+libsdfgen.sdfgen_vm_set_priority.argtypes = [c_void_p, c_uint8]
+
 libsdfgen.sdfgen_vm_add_map.restype = None
 libsdfgen.sdfgen_vm_add_map.argtypes = [c_void_p, c_void_p]
 
@@ -196,15 +212,40 @@ libsdfgen.sdfgen_sddf_gpu_serialise_config.restype = c_bool
 libsdfgen.sdfgen_sddf_gpu_serialise_config.argtypes = [c_void_p, c_char_p]
 
 libsdfgen.sdfgen_vmm.restype = c_void_p
-libsdfgen.sdfgen_vmm.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_uint64, c_bool]
+libsdfgen.sdfgen_vmm.argtypes = [
+    c_void_p,
+    c_void_p,
+    c_void_p,
+    c_void_p,
+    c_uint64,
+    c_bool
+]
 libsdfgen.sdfgen_vmm_add_passthrough_device.restype = c_bool
-libsdfgen.sdfgen_vmm_add_passthrough_device.argtypes = [c_void_p, c_char_p, c_void_p, POINTER(c_uint8), c_uint8]
+libsdfgen.sdfgen_vmm_add_passthrough_device.argtypes = [
+    c_void_p,
+    c_void_p,
+]
+libsdfgen.sdfgen_vmm_add_passthrough_device_regions.restype = c_bool
+libsdfgen.sdfgen_vmm_add_passthrough_device_regions.argtypes = [
+    c_void_p,
+    c_void_p,
+    POINTER(c_uint8),
+    c_uint8,
+]
+libsdfgen.sdfgen_vmm_add_passthrough_device_irqs.argtypes = [
+    c_void_p,
+    c_void_p,
+    POINTER(c_uint8),
+    c_uint8,
+]
 libsdfgen.sdfgen_vmm_add_passthrough_irq.restype = c_bool
 libsdfgen.sdfgen_vmm_add_passthrough_irq.argtypes = [c_void_p, c_void_p]
 libsdfgen.sdfgen_vmm_add_virtio_mmio_console.restype = c_bool
 libsdfgen.sdfgen_vmm_add_virtio_mmio_console.argtypes = [c_void_p, c_void_p, c_void_p]
 libsdfgen.sdfgen_vmm_add_virtio_mmio_blk.restype = c_bool
 libsdfgen.sdfgen_vmm_add_virtio_mmio_blk.argtypes = [c_void_p, c_void_p, c_void_p, c_uint32]
+libsdfgen.sdfgen_vmm_add_virtio_mmio_net.restype = c_bool
+libsdfgen.sdfgen_vmm_add_virtio_mmio_net.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_char_p]
 libsdfgen.sdfgen_vmm_connect.restype = c_bool
 libsdfgen.sdfgen_vmm_connect.argtypes = [c_void_p]
 libsdfgen.sdfgen_vmm_serialise_config.restype = c_bool
@@ -217,7 +258,18 @@ libsdfgen.sdfgen_lionsos_fs_fat_connect.argtypes = [c_void_p]
 libsdfgen.sdfgen_lionsos_fs_fat_serialise_config.restype = c_bool
 libsdfgen.sdfgen_lionsos_fs_fat_serialise_config.argtypes = [c_void_p, c_char_p]
 libsdfgen.sdfgen_lionsos_fs_nfs.restype = c_void_p
-libsdfgen.sdfgen_lionsos_fs_nfs.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_void_p, c_char_p, c_void_p, c_void_p, c_char_p, c_char_p]
+libsdfgen.sdfgen_lionsos_fs_nfs.argtypes = [
+    c_void_p,
+    c_void_p,
+    c_void_p,
+    c_void_p,
+    c_void_p,
+    c_char_p,
+    c_void_p,
+    c_void_p,
+    c_char_p,
+    c_char_p
+]
 libsdfgen.sdfgen_lionsos_fs_nfs_connect.restype = c_bool
 libsdfgen.sdfgen_lionsos_fs_nfs_connect.argtypes = [c_void_p]
 libsdfgen.sdfgen_lionsos_fs_nfs_serialise_config.restype = c_bool
@@ -230,6 +282,28 @@ libsdfgen.sdfgen_sddf_lwip_connect.argtypes = [c_void_p]
 libsdfgen.sdfgen_sddf_lwip_serialise_config.restype = c_bool
 libsdfgen.sdfgen_sddf_lwip_serialise_config.argtypes = [c_void_p, c_char_p]
 
+def ffi_uint8_ptr(n: Optional[int]):
+    """
+    Convert an int value to a uint8_t pointer for FFI.
+    If 'n' is None then we return None (which acts as a null pointer)
+    """
+    if n is None:
+        return None
+
+    return pointer(c_uint8(n))
+
+
+def ffi_bool_ptr(val: Optional[bool]):
+    """
+    Convert a bool value to a bool pointer for FFI.
+    If 'val' is None then we return None (which acts as a null pointer)
+    """
+    if val is None:
+        return None
+
+    return pointer(c_bool(val))
+
+
 class DeviceTree:
     """
     This class exists to allow other layers to be generic to boards or architectures
@@ -367,7 +441,7 @@ class SystemDescription:
         def add_map(self, map: SystemDescription.Map):
             libsdfgen.sdfgen_pd_add_map(self._obj, map._obj)
 
-        def add_irq(self, map: SystemDescription.Irq) -> int:
+        def add_irq(self, irq: SystemDescription.Irq) -> int:
             return libsdfgen.sdfgen_pd_add_irq(self._obj, irq._obj)
 
         def set_virtual_machine(self, vm: SystemDescription.VirtualMachine):
@@ -381,8 +455,8 @@ class SystemDescription:
         def __repr__(self) -> str:
             return f"ProtectionDomain({self.name})"
 
-    # TODO: __del__ is more complicated for virtual machine since it may be owned by a protection domain
-    # meaning it would result in a double free
+    # TODO: __del__ is more complicated for virtual machine since it may be owned
+    # by a protection domain meaning it would result in a double free
     class VirtualMachine:
         _name: str
         _obj: c_void_p
@@ -392,12 +466,14 @@ class SystemDescription:
                 # TODO: error checking
                 self._obj = libsdfgen.sdfgen_vm_vcpu_create(id, cpu)
 
-        def __init__(self, name: str, vcpus: List[Vcpu]):
+        def __init__(self, name: str, vcpus: List[Vcpu], priority: Optional[int] = None):
             vcpus_tuple: Tuple[c_void_p] = tuple([vcpu._obj for vcpu in vcpus])
             c_vcpus = (c_void_p * len(vcpus))(*vcpus_tuple)
             c_name = c_char_p(name.encode("utf-8"))
             self._name = name
             self._obj = libsdfgen.sdfgen_vm_create(c_name, cast(c_vcpus, POINTER(c_void_p)), len(vcpus))
+            if priority is not None:
+                libsdfgen.sdfgen_vm_set_priority(self._obj, priority)
 
         @property
         def name(self) -> str:
@@ -456,6 +532,15 @@ class SystemDescription:
             else:
                 self._obj = libsdfgen.sdfgen_mr_create(c_name, size)
 
+        @property
+        def paddr(self):
+            paddr = c_uint64(0)
+            has_paddr = libsdfgen.sdfgen_mr_get_paddr(self._obj, pointer(paddr))
+            if has_paddr:
+                return paddr
+            else:
+                return None
+
         def __del__(self):
             libsdfgen.sdfgen_mr_destroy(self._obj)
 
@@ -475,18 +560,36 @@ class SystemDescription:
     class Channel:
         _obj: c_void_p
 
-        # TODO: handle options
         def __init__(
             self,
             a: SystemDescription.ProtectionDomain,
             b: SystemDescription.ProtectionDomain,
             *,
-            pp_a=False,
-            pp_b=False,
-            notify_a=True,
-            notify_b=True
+            a_id: Optional[int] = None,
+            b_id: Optional[int] = None,
+            pp_a: Optional[bool] = None,
+            pp_b: Optional[bool] = None,
+            notify_a: Optional[bool] = None,
+            notify_b: Optional[bool] = None,
         ) -> None:
-            self._obj = libsdfgen.sdfgen_channel_create(a._obj, b._obj)
+            c_pp = None
+            if pp_a is not None:
+                c_pp = 0
+            elif pp_b is not None:
+                c_pp = 1
+
+            if pp_a is not None and pp_b is not None:
+                raise Exception("attempting to create channel with PP on both ends")
+
+            self._obj = libsdfgen.sdfgen_channel_create(
+                a._obj,
+                b._obj,
+                ffi_uint8_ptr(a_id),
+                ffi_uint8_ptr(b_id),
+                ffi_bool_ptr(notify_a),
+                ffi_bool_ptr(notify_b),
+                ffi_uint8_ptr(c_pp),
+            )
 
         @property
         def pd_a_id(self) -> int:
@@ -713,7 +816,9 @@ class Sddf:
             :param mac_addr: must be unique to the Network system.
             """
             if mac_addr is not None and len(mac_addr) != 17:
-                raise Exception(f"invalid MAC address length for client '{client.name}', {mac_addr}")
+                raise Exception(
+                    f"invalid MAC address length for client '{client.name}', {mac_addr}"
+                )
 
             c_mac_addr = c_char_p(0)
             if mac_addr is not None:
@@ -818,45 +923,74 @@ class Sddf:
 
         def __del__(self):
             libsdfgen.sdfgen_sddf_gpu_destroy(self._obj)
-    
+
     class Lwip:
         _obj: c_void_p
 
         def __init__(
             self,
             sdf: SystemDescription,
-            net: Net,
-            pd: ProtectionDomain
+            net: Sddf.Net,
+            pd: SystemDescription.ProtectionDomain
         ) -> None:
             self._obj = libsdfgen.sdfgen_sddf_lwip(sdf._obj, net._obj, pd._obj)
-        
+
         def connect(self) -> bool:
             return libsdfgen.sdfgen_sddf_lwip_connect(self._obj)
-        
+
         def serialise_config(self, output_dir: str) -> bool:
             c_output_dir = c_char_p(output_dir.encode("utf-8"))
             return libsdfgen.sdfgen_sddf_lwip_serialise_config(self._obj, c_output_dir)
 
+
 class Vmm:
     _obj: c_void_p
 
     def __init__(
         self,
         sdf: SystemDescription,
-        vmm: ProtectionDomain,
-        vm: VirtualMachine,
+        vmm: SystemDescription.ProtectionDomain,
+        vm: SystemDescription.VirtualMachine,
         dtb: DeviceTree,
         *,
-        one_to_one_ram: bool=False,
+        one_to_one_ram: bool = False,
     ):
         self._obj = libsdfgen.sdfgen_vmm(sdf._obj, vmm._obj, vm._obj, dtb._obj, dtb.size, one_to_one_ram)
 
-    def add_passthrough_device(self, name: str, device: DeviceTree.Node, *, irqs: List[int]=[]):
-        c_name = c_char_p(name.encode("utf-8"))
-        c_irqs = (c_uint8 * len(irqs))(*irqs)
-        return libsdfgen.sdfgen_vmm_add_passthrough_device(self._obj, c_name, device._obj, cast(c_irqs, POINTER(c_uint8)), len(irqs))
-
-    def add_passthrough_irq(self, irq: Irq):
+    def add_passthrough_device(
+        self,
+        device: DeviceTree.Node,
+        *,
+        regions: Optional[List[int]] = None,
+        irqs: Optional[List[int]] = None
+    ):
+        """
+        Add pass-through access to a particular device based on its DTB node.
+        :param regions: list of indices into the 'reg' field of the device to be mapped in. If None
+                        then every region passed through.
+        :param irqs: list of indices into the 'interrupts' field of the device to be created. If None
+                        then every IRQ is passed through.
+        """
+        if regions is None and irqs is None:
+            # If the user passed None, that means we need to map everything in
+            return libsdfgen.sdfgen_vmm_add_passthrough_device(self._obj, device._obj)
+        elif irqs is not None:
+            # Pass through specific IRQs, all regions
+            c_irqs = cast((c_uint8 * len(irqs))(*irqs), POINTER(c_uint8))
+            irqs_len = len(irqs)
+            ret = libsdfgen.sdfgen_vmm_add_passthrough_device_irqs(self._obj, device._obj, c_irqs, irqs_len)
+            ret = libsdfgen.sdfgen_vmm_add_passthrough_device_regions(self._obj, device._obj, None, 0)
+        elif regions is not None:
+            # Pass through specific regions, all IRQs
+            c_regions = cast((c_uint8 * len(regions))(*regions), POINTER(c_uint8))
+            regions_len = len(regions)
+            ret = libsdfgen.sdfgen_vmm_add_passthrough_device_regions(self._obj, device._obj, c_regions, regions_len)
+            ret = libsdfgen.sdfgen_vmm_add_passthrough_device_irqs(self._obj, device._obj, None, 0)
+        else:
+            # unreachable case
+            raise Exception("internal error")
+
+    def add_passthrough_irq(self, irq: SystemDescription.Irq):
         return libsdfgen.sdfgen_vmm_add_passthrough_irq(self._obj, irq._obj)
 
     def add_virtio_mmio_console(self, device: DeviceTree.Node, serial: Sddf.Serial):
@@ -865,8 +999,24 @@ class Vmm:
     def add_virtio_mmio_blk(self, device: DeviceTree.Node, blk: Sddf.Blk, *, partition: int):
         return libsdfgen.sdfgen_vmm_add_virtio_mmio_blk(self._obj, device._obj, blk._obj, partition)
 
-    # def add_virtio_net(self, device: DeviceTree.Node, net: Sddf.Net, *, copier: ProtectionDomain=None):
-        # return libsdfgen.sdfgen_vmm_add_virtio_blk(self._obj, device._obj, net._obj, partition)
+    def add_virtio_mmio_net(
+        self,
+        device: DeviceTree.Node,
+        net: Sddf.Net,
+        copier: SystemDescription.ProtectionDomain,
+        *,
+        mac_addr: Optional[str] = None
+    ):
+        if mac_addr is not None and len(mac_addr) != 17:
+            raise Exception(
+                f"invalid MAC address length for '{mac_addr}'"
+            )
+
+        c_mac_addr = c_char_p(0)
+        if mac_addr is not None:
+            c_mac_addr = c_char_p(mac_addr.encode("utf-8"))
+
+        return libsdfgen.sdfgen_vmm_add_virtio_mmio_net(self._obj, device._obj, net._obj, copier._obj, c_mac_addr)
 
     def connect(self) -> bool:
         return libsdfgen.sdfgen_vmm_connect(self._obj)
@@ -918,7 +1068,9 @@ class LionsOs:
                 export_path: str,
             ):
                 if mac_addr is not None and len(mac_addr) != 17:
-                    raise Exception(f"invalid MAC address length for client '{client.name}', {mac_addr}")
+                    raise Exception(
+                        f"invalid MAC address length for client '{client.name}', {mac_addr}"
+                    )
 
                 c_mac_addr = c_char_p(0)
                 if mac_addr is not None:
@@ -928,7 +1080,18 @@ class LionsOs:
                 c_server = c_char_p(server.encode("utf-8"))
                 c_export_path = c_char_p(export_path.encode("utf-8"))
 
-                self._obj = libsdfgen.sdfgen_lionsos_fs_nfs(sdf._obj, fs._obj, client._obj, net._obj, net_copier._obj, c_mac_addr, serial._obj, timer._obj, c_server, c_export_path)
+                self._obj = libsdfgen.sdfgen_lionsos_fs_nfs(
+                    sdf._obj,
+                    fs._obj,
+                    client._obj,
+                    net._obj,
+                    net_copier._obj,
+                    c_mac_addr,
+                    serial._obj,
+                    timer._obj,
+                    c_server,
+                    c_export_path
+                )
 
             def connect(self) -> bool:
                 return libsdfgen.sdfgen_lionsos_fs_nfs_connect(self._obj)

{sdfgen-0.16.1.dist-info → sdfgen-0.18.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: sdfgen
-Version: 0.16.1
+Version: 0.18.0
 Summary: Automating the creation of Microkit System Description Files (SDF)
 Home-page: https://github.com/au-ts/microkit_sdf_gen
 Description-Content-Type: text/markdown
@@ -24,11 +24,13 @@ Microkit-based systems.
 
 The sdfgen tooling (name temporary) contains libraries for programmatically
 creating:
+
 * Microkit System Description Files (SDF)
 * systems using the seL4 Device Driver Framework (sDDF)
 * systems using LionsOS
 
 It has first-class support for use in the following languages:
+
 * C
 * Python
 * Zig
@@ -47,7 +49,7 @@ Pre-built archives of the C library are available in each
 
 ### Dependencies
 
-* Zig (`0.14.0-dev.2079+ba2d00663` or higher)
+* Zig (`0.14.0-dev.3050+d72f3d353` or higher)
   * See https://ziglang.org/download/, until 0.14.0 is released we rely on a
     master version of Zig. Once 0.14.0 is released (most likely Feb'25) we can
     pin to that release.

sdfgen-0.18.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+csdfgen.cpython-313-darwin.so,sha256=51jeaoQJZIMspeWLzFOeVz8k5Mrw9Bt9N6Ps-8vjSH8,759816
+libcsdfgen.0.18.0.dylib,sha256=51jeaoQJZIMspeWLzFOeVz8k5Mrw9Bt9N6Ps-8vjSH8,759816
+libcsdfgen.0.dylib,sha256=51jeaoQJZIMspeWLzFOeVz8k5Mrw9Bt9N6Ps-8vjSH8,759816
+libcsdfgen.dylib,sha256=51jeaoQJZIMspeWLzFOeVz8k5Mrw9Bt9N6Ps-8vjSH8,759816
+sdfgen/__init__.py,sha256=_d7GGV8GhadIAEYP8uiJlez0yKtXnHMHdRkRzVMKS3c,143
+sdfgen/module.py,sha256=lDfOUdrj6Sw-Aw8dxjtNLrsxYa8K1ZNzyuR0rifcVqQ,40387
+sdfgen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdfgen-0.18.0.dist-info/METADATA,sha256=-tM82ZmR6CcgqMTq0QyMw5-1QxbNjfDgB_eVRnA81c0,4654
+sdfgen-0.18.0.dist-info/WHEEL,sha256=wajf2RmtLcyDhlr_PKgNyLmxD2pJHORwHzFCayrprrU,109
+sdfgen-0.18.0.dist-info/top_level.txt,sha256=M3gUW9vTMij10peQKgv1Qs0jZkdsk_PG0REFxuv6jNY,15
+sdfgen-0.18.0.dist-info/RECORD,,

sdfgen-0.16.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-csdfgen.cpython-313-darwin.so,sha256=WKrWhuKyBHKdBBn-q9ytwmPTf51UZno99-dcOy5fSDw,730824
-libcsdfgen.0.16.1.dylib,sha256=WKrWhuKyBHKdBBn-q9ytwmPTf51UZno99-dcOy5fSDw,730824
-libcsdfgen.0.dylib,sha256=WKrWhuKyBHKdBBn-q9ytwmPTf51UZno99-dcOy5fSDw,730824
-libcsdfgen.dylib,sha256=WKrWhuKyBHKdBBn-q9ytwmPTf51UZno99-dcOy5fSDw,730824
-sdfgen/__init__.py,sha256=_d7GGV8GhadIAEYP8uiJlez0yKtXnHMHdRkRzVMKS3c,143
-sdfgen/module.py,sha256=cIv7e3k3RUn4JY9oLzK2VJowjp29dwp9bevvOiwnOu4,35769
-sdfgen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sdfgen-0.16.1.dist-info/METADATA,sha256=8dDOff9zrETLBN9nMKnXf4fYVtUZQ04YQ4l0lNMxWoI,4652
-sdfgen-0.16.1.dist-info/WHEEL,sha256=wajf2RmtLcyDhlr_PKgNyLmxD2pJHORwHzFCayrprrU,109
-sdfgen-0.16.1.dist-info/top_level.txt,sha256=M3gUW9vTMij10peQKgv1Qs0jZkdsk_PG0REFxuv6jNY,15
-sdfgen-0.16.1.dist-info/RECORD,,