work on system configuration abstractions, host still missing

experiments/simbricks/orchestration/system/base.py

+# Copyright 2024 Max Planck Institute for Software Systems, and
+# National University of Singapore
+#
+# 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 abc import (abstractmethod, ABC)
+import io
+import typing as tp
+import tarfile
+import itertools
+
+class System():
+    """ Defines System configuration of the whole simulation """
+
+    def __init__(self) -> None:
+        self.hosts: tp.List[Component] = []
+
+    def add_component(self, c: Component) -> None:
+        assert c.system == self
+
+
+class Component(ABC):
+    def __init__(self, s: System) -> None:
+        s.system = s
+        s.add_component(self)
+
+    @abstractmethod
+    def interfaces(self) -> tp.List[Interface]:
+        return None
+
+    def channels(self) -> tp.List[Channel]:
+        return [i.channel for i in self.interfaces() if i.is_connected()]
+
+
+class Interface(ABC):
+    def __init__(self, c: Component) -> None:
+        self.component = c
+        self.channel: tp.Optional[Channel] = None
+
+    def is_connected(self) -> bool:
+        return self.channel is not None
+
+    def disconnect(self) -> None:
+        self.channel = None
+
+    def connect(self, c: Channel) -> None:
+        assert self.channel is None
+        self.channel = c
+
+
+class Channel(ABC):
+    def __init__(self, a: Interface, b: Interface) -> None:
+        self.latency = 500
+        self.a: Interface = a
+        self.b: Interface = b
+
+    def interfaces(self) -> tp.List[Interface]:
+        return [self.a, self.b]
+
+    def disconnect(self):
+        # Note AK: this is a bit ugly, this leaves the channel dangling. But
+        # it's not referenced anywhere, so that's fine I guess.
+        self.a.disconnect()
+        self.b.disconnect()
\ No newline at end of file

experiments/simbricks/orchestration/system/eth.py

+# Copyright 2024 Max Planck Institute for Software Systems, and
+# National University of Singapore
+#
+# 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.
+
+import typing as tp
+
+import simbricks.orchestration.system.base as base
+
+
+class EthInterface(base.Interface):
+    def __init__(self, c: base.Component) -> None:
+        super().__init__(c)
+
+    def connect(self, c: base.Channel) -> None:
+        # Note AK: a bit ugly, but I think we can't get around a rt check here
+        if not c is isinstance(c, EthChannel):
+            raise TypeError('EthInterface only connects to EthChannel')
+        super().connect(c)
+
+
+class EthChannel(base.Channel):
+    def __init__(self, a: EthInterface, b: EthInterface) -> None:
+        super().__init__(a, b)
+
+
+class EthSimpleNIC(base.Component):
+    def __init__(self, s: base.System) -> None:
+        super().__init__(s)
+        self.eth_if = EthInterface()
+
+
+class EthSwitch(base.Component):
+    def __init__(self, s: base.System) -> None:
+        super().__init__(s)
+        self.eth_ifs: tp.List[EthInterface] = []
+
+    def if_add(self, i: EthInterface) -> None:
+        self.eth_ifs.append(i)
\ No newline at end of file

experiments/simbricks/orchestration/system/nic.py

+# Copyright 2024 Max Planck Institute for Software Systems, and
+# National University of Singapore
+#
+# 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.
+
+import typing as tp
+
+import simbricks.orchestration.system.base as base
+import simbricks.orchestration.system.pcie as pcie
+import simbricks.orchestration.system.eth as eth
+
+
+class SimplePCIeNIC(pcie.PCIeSimpleDevice, eth.EthSimpleNIC):
+    def __init__(self, s: base.System) -> None:
+        super().__init__(s)
+
+    def interfaces(self) -> tp.List[base.Interface]:
+        return [self.pci_if, self.eth_if]
+
+
+class IntelI40eNIC(SimplePCIeNIC):
+    pass
+
+
+class IntelE1000NIC(SimplePCIeNIC):
+    pass
+
+
+class CorundumNIC(SimplePCIeNIC):
+    pass
\ No newline at end of file

experiments/simbricks/orchestration/system/pcie.py

+# Copyright 2024 Max Planck Institute for Software Systems, and
+# National University of Singapore
+#
+# 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.
+
+import typing as tp
+
+import simbricks.orchestration.system.base as base
+
+
+class PCIeHostInterface(base.Interface):
+    # Note AK: Component here is on purpose. Other simulators than host
+    # simulators can also have PCIeHost interfaces (e.g. a PCIe switch)
+    def __init__(self, c: base.Component) -> None:
+        super().__init__(c)
+
+
+class PCIeDeviceInterface(base.Interface):
+    def __init__(self, c: base.Component) -> None:
+        super().__init__(c)
+
+    def connect(self, c: base.Channel) -> None:
+        # Note AK: a bit ugly, but I think we can't get around a rt check here
+        if not c is isinstance(c, PCIeChannel):
+            raise TypeError('PCIeDeviceInterface only connects to PCIeChannel')
+        super().connect(c)
+
+
+class PCIeChannel(base.Channel):
+    def __init__(self, host: PCIeHostInterface, dev: PCIeDeviceInterface) -> None:
+        super().__init__(host, dev)
+
+    def host_if(self) -> PCIeHostInterface:
+        return self.a
+    
+    def dev_if(self) -> PCIeDeviceInterface:
+        return self.b
+
+
+# Note AK: Can we make this abstract?
+class PCIeSimpleDevice(base.Component):
+    def __init__(self, s: base.System):
+        super().__init__(s)
+        self.pci_if = PCIeDeviceInterface()
+
+    def interfaces(self) -> tp.List[base.Interface]:
+        return [self.pci_if]
\ No newline at end of file