sdfgen 0.19.1__cp311-cp311-musllinux_1_2_x86_64.whl → 0.21.0__cp311-cp311-musllinux_1_2_x86_64.whl

sdfgen/module.py

@@ -2,7 +2,7 @@ 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, pointer
+    cast, c_void_p, c_char_p, c_int8, c_uint8, c_uint32, c_uint64, c_bool, POINTER, byref, pointer
 )
 from typing import Optional, List, Tuple
 from enum import IntEnum
@@ -85,14 +85,14 @@ 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.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]
 
 libsdfgen.sdfgen_irq_create.restype = c_void_p
-libsdfgen.sdfgen_irq_create.argtypes = [c_uint32]
+libsdfgen.sdfgen_irq_create.argtypes = [c_uint32, POINTER(c_uint32), POINTER(c_uint8)]
 libsdfgen.sdfgen_irq_destroy.restype = None
 libsdfgen.sdfgen_irq_destroy.argtypes = [c_void_p]
 
@@ -108,7 +108,7 @@ libsdfgen.sdfgen_vm_add_map.restype = None
 libsdfgen.sdfgen_vm_add_map.argtypes = [c_void_p, c_void_p]
 
 libsdfgen.sdfgen_vm_vcpu_create.restype = c_void_p
-libsdfgen.sdfgen_vm_vcpu_create.argtypes = [c_uint8, c_uint16]
+libsdfgen.sdfgen_vm_vcpu_create.argtypes = [c_uint8, POINTER(c_uint8)]
 libsdfgen.sdfgen_vm_vcpu_destroy.restype = None
 libsdfgen.sdfgen_vm_vcpu_destroy.argtypes = [c_void_p]
 
@@ -117,11 +117,11 @@ libsdfgen.sdfgen_pd_create.argtypes = [c_char_p, c_char_p]
 libsdfgen.sdfgen_pd_destroy.restype = None
 libsdfgen.sdfgen_pd_destroy.argtypes = [c_void_p]
 
-libsdfgen.sdfgen_pd_add_child.restype = c_uint8
+libsdfgen.sdfgen_pd_add_child.restype = c_int8
 libsdfgen.sdfgen_pd_add_child.argtypes = [c_void_p, c_void_p, POINTER(c_uint8)]
 libsdfgen.sdfgen_pd_add_map.restype = None
 libsdfgen.sdfgen_pd_add_map.argtypes = [c_void_p, c_void_p]
-libsdfgen.sdfgen_pd_add_irq.restype = c_uint8
+libsdfgen.sdfgen_pd_add_irq.restype = c_int8
 libsdfgen.sdfgen_pd_add_irq.argtypes = [c_void_p, c_void_p]
 
 libsdfgen.sdfgen_sddf_timer.restype = c_void_p
@@ -165,7 +165,7 @@ libsdfgen.sdfgen_sddf_blk_serialise_config.restype = c_bool
 libsdfgen.sdfgen_sddf_blk_serialise_config.argtypes = [c_void_p, c_char_p]
 
 libsdfgen.sdfgen_sddf_serial.restype = c_void_p
-libsdfgen.sdfgen_sddf_serial.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_void_p]
+libsdfgen.sdfgen_sddf_serial.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_void_p, c_bool]
 libsdfgen.sdfgen_sddf_serial_destroy.restype = None
 libsdfgen.sdfgen_sddf_serial_destroy.argtypes = [c_void_p]
 
@@ -274,6 +274,14 @@ 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
 libsdfgen.sdfgen_lionsos_fs_nfs_serialise_config.argtypes = [c_void_p, c_char_p]
+libsdfgen.sdfgen_lionsos_fs_nfs_destroy.restype = None
+libsdfgen.sdfgen_lionsos_fs_nfs_destroy.argtypes = [c_void_p]
+libsdfgen.sdfgen_lionsos_fs_vmfs.restype = c_void_p
+libsdfgen.sdfgen_lionsos_fs_vmfs.argtypes = [c_void_p, c_void_p, c_void_p, c_void_p, c_void_p, c_uint32]
+libsdfgen.sdfgen_lionsos_fs_vmfs_connect.restype = c_bool
+libsdfgen.sdfgen_lionsos_fs_vmfs_connect.argtypes = [c_void_p]
+libsdfgen.sdfgen_lionsos_fs_vmfs_serialise_config.restype = c_bool
+libsdfgen.sdfgen_lionsos_fs_vmfs_serialise_config.argtypes = [c_void_p, c_char_p]
 
 libsdfgen.sdfgen_sddf_lwip.restype = c_void_p
 libsdfgen.sdfgen_sddf_lwip.argtypes = [c_void_p, c_void_p, c_void_p]
@@ -282,6 +290,7 @@ 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.
@@ -293,6 +302,17 @@ def ffi_uint8_ptr(n: Optional[int]):
     return pointer(c_uint8(n))
 
 
+def ffi_uint32_ptr(n: Optional[int]):
+    """
+    Convert an int value to a uint32_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_uint32(n))
+
+
 def ffi_bool_ptr(val: Optional[bool]):
     """
     Convert a bool value to a bool pointer for FFI.
@@ -430,19 +450,23 @@ class SystemDescription:
             """
             c_child_id = byref(c_uint8(child_id)) if child_id else None
 
-            returned_id = libsdfgen.sdfgen_pd_add_child(self._obj, child_pd._obj, c_child_id)
-            if returned_id is None:
-                raise Exception("Could not allocate child PD ID")
+            id = libsdfgen.sdfgen_pd_add_child(self._obj, child_pd._obj, c_child_id)
+            if id < 0:
+                raise Exception(f"failed to add child to PD '{self.name}'")
 
             self._child_pds.append(child_pd)
 
-            return returned_id
+            return id
 
         def add_map(self, map: SystemDescription.Map):
             libsdfgen.sdfgen_pd_add_map(self._obj, map._obj)
 
         def add_irq(self, irq: SystemDescription.Irq) -> int:
-            return libsdfgen.sdfgen_pd_add_irq(self._obj, irq._obj)
+            id = libsdfgen.sdfgen_pd_add_irq(self._obj, irq._obj)
+            if id < 0:
+                raise Exception(f"failed to add IRQ to PD '{self.name}'")
+
+            return id
 
         def set_virtual_machine(self, vm: SystemDescription.VirtualMachine):
             ret = libsdfgen.sdfgen_pd_set_virtual_machine(self._obj, vm._obj)
@@ -462,9 +486,8 @@ class SystemDescription:
         _obj: c_void_p
 
         class Vcpu:
-            def __init__(self, *, id: int, cpu: Optional[int] = 0):
-                # TODO: error checking
-                self._obj = libsdfgen.sdfgen_vm_vcpu_create(id, cpu)
+            def __init__(self, *, id: int, cpu: Optional[int] = None):
+                self._obj = libsdfgen.sdfgen_vm_vcpu_create(id, ffi_uint8_ptr(cpu))
 
         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])
@@ -472,6 +495,8 @@ class SystemDescription:
             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 self._obj is None:
+                raise Exception("failed to create VM")
             if priority is not None:
                 libsdfgen.sdfgen_vm_set_priority(self._obj, priority)
 
@@ -514,6 +539,8 @@ class SystemDescription:
             cached: bool = True,
         ) -> None:
             self._obj = libsdfgen.sdfgen_map_create(mr._obj, vaddr, perms._to_c_bindings(), cached)
+            if self._obj is None:
+                raise Exception("failed to create mapping")
 
     class MemoryRegion:
         _obj: c_void_p
@@ -547,12 +574,19 @@ class SystemDescription:
     class Irq:
         _obj: c_void_p
 
-        # TODO: handle options
+        class Trigger(IntEnum):
+            EDGE = 0,
+            LEVEL = 1,
+
         def __init__(
             self,
             irq: int,
+            trigger: Optional[Trigger] = None,
+            id: Optional[int] = None,
         ):
-            self._obj = libsdfgen.sdfgen_irq_create(irq)
+            self._obj = libsdfgen.sdfgen_irq_create(irq, ffi_uint32_ptr(trigger), ffi_uint8_ptr(id))
+            if self._obj is None:
+                raise Exception("failed to create IRQ")
 
         def __del__(self):
             libsdfgen.sdfgen_irq_destroy(self._obj)
@@ -590,6 +624,8 @@ class SystemDescription:
                 ffi_bool_ptr(notify_b),
                 ffi_uint8_ptr(c_pp),
             )
+            if self._obj is None:
+                raise Exception("failed to create channel")
 
         @property
         def pd_a_id(self) -> int:
@@ -660,7 +696,8 @@ class Sddf:
             driver: SystemDescription.ProtectionDomain,
             virt_tx: SystemDescription.ProtectionDomain,
             *,
-            virt_rx: Optional[SystemDescription.ProtectionDomain] = None
+            virt_rx: Optional[SystemDescription.ProtectionDomain] = None,
+            enable_color: bool = True
         ) -> None:
             if device is None:
                 device_obj = None
@@ -673,8 +710,10 @@ class Sddf:
                 virt_rx_obj = virt_rx._obj
 
             self._obj = libsdfgen.sdfgen_sddf_serial(
-                sdf._obj, device_obj, driver._obj, virt_tx._obj, virt_rx_obj
+                sdf._obj, device_obj, driver._obj, virt_tx._obj, virt_rx_obj, c_bool(enable_color)
             )
+            if self._obj is None:
+                raise Exception("failed to create serial system")
 
         def add_client(self, client: SystemDescription.ProtectionDomain):
             """Add a new client connection to the serial system."""
@@ -760,6 +799,8 @@ class Sddf:
                 device_obj = device._obj
 
             self._obj = libsdfgen.sdfgen_sddf_blk(sdf._obj, device_obj, driver._obj, virt._obj)
+            if self._obj is None:
+                raise Exception("failed to create blk system")
 
         def add_client(self, client: SystemDescription.ProtectionDomain, *, partition: int):
             ret = libsdfgen.sdfgen_sddf_blk_add_client(self._obj, client._obj, partition)
@@ -978,14 +1019,14 @@ class Vmm:
             # 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)
+            assert libsdfgen.sdfgen_vmm_add_passthrough_device_irqs(self._obj, device._obj, c_irqs, irqs_len)
+            assert 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)
+            assert libsdfgen.sdfgen_vmm_add_passthrough_device_regions(self._obj, device._obj, c_regions, regions_len)
+            assert libsdfgen.sdfgen_vmm_add_passthrough_device_irqs(self._obj, device._obj, None, 0)
         else:
             # unreachable case
             raise Exception("internal error")
@@ -1040,8 +1081,15 @@ class LionsOs:
                 blk: Sddf.Blk,
                 partition: int,
             ):
+                if partition < 0:
+                    raise Exception(
+                        f"block partition cannot be negative, given partition '{partition}'"
+                    )
+
                 assert isinstance(blk, Sddf.Blk)
                 self._obj = libsdfgen.sdfgen_lionsos_fs_fat(sdf._obj, fs._obj, client._obj, blk._obj, partition)
+                if self._obj is None:
+                    raise Exception("failed to create FAT file system")
 
             def connect(self) -> bool:
                 return libsdfgen.sdfgen_lionsos_fs_fat_connect(self._obj)
@@ -1076,7 +1124,6 @@ class LionsOs:
                 if mac_addr is not None:
                     c_mac_addr = c_char_p(mac_addr.encode("utf-8"))
 
-                # TODO: error checking on export path and server args
                 c_server = c_char_p(server.encode("utf-8"))
                 c_export_path = c_char_p(export_path.encode("utf-8"))
 
@@ -1093,9 +1140,53 @@ class LionsOs:
                     c_export_path
                 )
 
+            def __del__(self):
+                libsdfgen.sdfgen_lionsos_fs_nfs_destroy(self._obj)
+
             def connect(self) -> bool:
                 return libsdfgen.sdfgen_lionsos_fs_nfs_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_lionsos_fs_nfs_serialise_config(self._obj, c_output_dir)
+
+        class VmFs:
+            _obj: c_void_p
+
+            def __init__(
+                self,
+                sdf: SystemDescription,
+                fs_vm_sys: Vmm,
+                client: SystemDescription.ProtectionDomain,
+                blk: Sddf.Blk,
+                virtio_device: DeviceTree.Node,
+                partition: int,
+            ):
+                if partition < 0:
+                    raise Exception(
+                        f"block partition cannot be negative, given partition '{partition}'"
+                    )
+
+                assert isinstance(sdf, SystemDescription)
+                assert isinstance(fs_vm_sys, Vmm)
+                assert isinstance(client, SystemDescription.ProtectionDomain)
+                assert isinstance(blk, Sddf.Blk)
+                assert isinstance(virtio_device, DeviceTree.Node)
+
+                self._obj = libsdfgen.sdfgen_lionsos_fs_vmfs(
+                    sdf._obj,
+                    fs_vm_sys._obj,
+                    client._obj,
+                    blk._obj,
+                    virtio_device._obj,
+                    partition
+                )
+                if self._obj is None:
+                    raise Exception("failed to create VmFs file system")
+
+            def connect(self) -> bool:
+                return libsdfgen.sdfgen_lionsos_fs_vmfs_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_lionsos_fs_vmfs_serialise_config(self._obj, c_output_dir)

{sdfgen-0.19.1.dist-info → sdfgen-0.21.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sdfgen
-Version: 0.19.1
+Version: 0.21.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

sdfgen-0.21.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+libcsdfgen.so,sha256=wvECax4EomvN4SaX1Ft-4mo7NY8zl00CcFCGWNdnkMc,5405072
+libcsdfgen.so.0.21.0,sha256=wvECax4EomvN4SaX1Ft-4mo7NY8zl00CcFCGWNdnkMc,5405072
+csdfgen.cpython-311-x86_64-linux-musl.so,sha256=wvECax4EomvN4SaX1Ft-4mo7NY8zl00CcFCGWNdnkMc,5405072
+libcsdfgen.so.0,sha256=wvECax4EomvN4SaX1Ft-4mo7NY8zl00CcFCGWNdnkMc,5405072
+sdfgen-0.21.0.dist-info/WHEEL,sha256=-1lvUTC7ROIbUsEGXToEoCN9w6fPmW3brF2b0tYIqSQ,112
+sdfgen-0.21.0.dist-info/RECORD,,
+sdfgen-0.21.0.dist-info/top_level.txt,sha256=M3gUW9vTMij10peQKgv1Qs0jZkdsk_PG0REFxuv6jNY,15
+sdfgen-0.21.0.dist-info/METADATA,sha256=moRdWJtrjWC96q2cStIYoASv130Bh-DBMNIExPqfioQ,4563
+sdfgen/module.py,sha256=xV75IHPGivRXij-DriZFiUTrtWs5hpRUhryMdmQ99C8,44021
+sdfgen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sdfgen/__init__.py,sha256=_d7GGV8GhadIAEYP8uiJlez0yKtXnHMHdRkRzVMKS3c,143

sdfgen-0.19.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-libcsdfgen.so,sha256=Oifg46dv7xcbHS9Ohqt_r0u6aM2j5CHOUkbQkdWpW2Q,4214168
-libcsdfgen.so.0.19.1,sha256=Oifg46dv7xcbHS9Ohqt_r0u6aM2j5CHOUkbQkdWpW2Q,4214168
-libcsdfgen.so.0,sha256=Oifg46dv7xcbHS9Ohqt_r0u6aM2j5CHOUkbQkdWpW2Q,4214168
-csdfgen.cpython-311-x86_64-linux-musl.so,sha256=Oifg46dv7xcbHS9Ohqt_r0u6aM2j5CHOUkbQkdWpW2Q,4214168
-sdfgen/__init__.py,sha256=_d7GGV8GhadIAEYP8uiJlez0yKtXnHMHdRkRzVMKS3c,143
-sdfgen/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sdfgen/module.py,sha256=lDfOUdrj6Sw-Aw8dxjtNLrsxYa8K1ZNzyuR0rifcVqQ,40387
-sdfgen-0.19.1.dist-info/WHEEL,sha256=-1lvUTC7ROIbUsEGXToEoCN9w6fPmW3brF2b0tYIqSQ,112
-sdfgen-0.19.1.dist-info/METADATA,sha256=2e3AqvxM4B4F5nPaP7UfayMjQrRIg874DA_N2JwBB3g,4563
-sdfgen-0.19.1.dist-info/top_level.txt,sha256=M3gUW9vTMij10peQKgv1Qs0jZkdsk_PG0REFxuv6jNY,15
-sdfgen-0.19.1.dist-info/RECORD,,