mock cdo_driver to collect all register writes

nod-ai · May 10, 2024 · e68c909 · e68c909
1 parent 27bc574
commit e68c909
Show file tree

Hide file tree

Showing 8 changed files with 228 additions and 22 deletions.
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -55,7 +55,7 @@ jobs:
           
           pushd wheelhouse
           pip install xaiepy -f $PWD
-          pytest ../tests
+          pytest -c ../tests/*.py
           popd
 
       - name: Upload wheels
@@ -104,17 +104,16 @@ jobs:
           pip install -r requirements-dev.txt
           pip wheel . -v -w wheelhouse --no-build-isolation
 
+      - name: Upload wheels
+        uses: actions/upload-artifact@v3
+        with:
+          path: wheelhouse/*.whl
+          name: build_artifact_python_bindings
+
       - name: test
         run: |
           
           pushd wheelhouse
           pip install xaiepy -f $PWD
-          pytest ../tests
+          pytest -c ../tests/*.py
           popd
-
-      - name: Upload wheels
-        if: (success() || failure())
-        uses: actions/upload-artifact@v3
-        with:
-          path: wheelhouse/*.whl
-          name: build_artifact_python_bindings
diff --git a/.github/workflows/wheels.yml b/.github/workflows/wheels.yml
@@ -101,14 +101,15 @@ jobs:
       # done
 
       - name: Upload wheels
+        if: github.event_name != 'pull_request' && github.ref_name == 'main'
         uses: actions/upload-artifact@v3
         with:
           path: wheelhouse/*.whl
           name: build_artifact_python_bindings
 
   upload_bindings_wheels:
 
-    if: github.event_name != 'pull_request'
+    if: github.event_name != 'pull_request' && github.ref_name == 'main'
 
     needs: [build, build-linux-aarch64]
 

diff --git a/examples/core_0_2.elf b/examples/core_0_2.elf
diff --git a/examples/e2e.py b/examples/e2e.py
@@ -27,8 +27,10 @@
     XAie_DmaDesc,
     XAie_StartTransaction,
     XAie_ExportTransactionInstance,
-    XAie_TxnOpcode,
     _XAie_Txn_Submit,
+    get_written_addresses,
+    get_addr_tile,
+    reset_written_addresses,
 )
 
 XAIE_DEV_GEN_AIEML = 2
@@ -41,6 +43,8 @@
 XAIE_TRANSACTION_DISABLE_AUTO_FLUSH = 0b0
 DDR_AIE_ADDR_OFFSET = 0x80000000
 
+reset_written_addresses()
+
 configPtr = XAie_Config(
     XAIE_DEV_GEN_AIEML,
     XAIE_BASE_ADDR,
@@ -108,3 +112,8 @@
 
 txn_inst = XAie_ExportTransactionInstance(devInst)
 _XAie_Txn_Submit(devInst, txn_inst)
+
+
+for addr, data in get_written_addresses().items():
+    c, r, offset = get_addr_tile(addr)
+    print(c, r, f"{offset=:08x}", f"{data=:08x}")
diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1,4 +1,5 @@
-setuptools>=42
+# pep 660 editable wheels
+setuptools>=64
 wheel
 ninja
 cmake>=3.28

diff --git a/setup.py b/setup.py
@@ -6,29 +6,45 @@
 from pathlib import Path
 from pprint import pprint
 
+from pip._internal.network.session import PipSession
+from pip._internal.req import parse_requirements
 from setuptools import Extension, setup
 from setuptools.command.build_ext import build_ext
+from setuptools.command.editable_wheel import editable_wheel
 
 
 class CMakeExtension(Extension):
     def __init__(self, name: str, sourcedir: str = "") -> None:
-        super().__init__(name, sources=[])
+        super().__init__(name, sources=[], optional=True)
         self.sourcedir = os.fspath(Path(sourcedir).resolve())
 
 
 def check_env(build):
     return os.environ.get(build, 0) in {"1", "true", "True", "ON", "YES"}
 
 
+EDITABLE = False
+
+
+class editable_wheel(editable_wheel):
+    def run(self):
+        global EDITABLE
+        EDITABLE = True
+        super().run()
+
+
 class CMakeBuild(build_ext):
     def build_extension(self, ext: CMakeExtension) -> None:
+        HERE = Path(__file__).parent.absolute()
         ext_fullpath = Path.cwd() / self.get_ext_fullpath(ext.name)
         extdir = ext_fullpath.parent.resolve()
         cfg = "Debug" if check_env("DEBUG") else "Release"
 
+        if EDITABLE:
+            extdir = HERE
+
         cmake_generator = os.environ.get("CMAKE_GENERATOR", "Ninja")
 
-        HERE = Path(__file__).parent.absolute()
         # make windows happy
         PYTHON_EXECUTABLE = str(Path(sys.executable))
         CMAKE_MODULE_PATH = str(HERE / "third_party" / "aie-rt" / "fal" / "cmake")
@@ -138,8 +154,13 @@ def build_extension(self, ext: CMakeExtension) -> None:
     author_email="maksim.levental@gmail.com",
     long_description_content_type="text/markdown",
     ext_modules=[CMakeExtension(PACKAGE_NAME, sourcedir=".")],
-    cmdclass={"build_ext": CMakeBuild},
+    cmdclass={"editable_wheel": editable_wheel, "build_ext": CMakeBuild},
     zip_safe=False,
     packages=[PACKAGE_NAME],
     include_package_data=True,
+    install_requires=[
+        str(ir.requirement)
+        for ir in parse_requirements("requirements-dev.txt", session=PipSession())
+    ],
+    python_requires=">=3.8",
 )
diff --git a/tests/test_e2e.py b/tests/test_e2e.py
@@ -30,6 +30,8 @@
     XAie_ExportTransactionInstance,
     XAie_TxnOpcode,
     _XAie_Txn_Submit,
+    get_written_addresses,
+    get_addr_tile,
 )
 
 XAIE_DEV_GEN_AIEML = 2
@@ -113,3 +115,7 @@ def test_transaction():
     txn_inst = XAie_ExportTransactionInstance(devInst)
     if platform.system() != "Windows":
         _XAie_Txn_Submit(devInst, txn_inst)
+
+        for addr, data in get_written_addresses().items():
+            c, r, offset = get_addr_tile(addr)
+            print(c, r, f"{offset=:08x}", f"{data=:08x}")
diff --git a/xaiepy/cdo.py b/xaiepy/cdo.py
@@ -1,6 +1,9 @@
+import logging
 import platform
 import sys
+from collections import OrderedDict
 
+logger = logging.getLogger(__name__)
 
 if platform.system() != "Windows":
     from os import RTLD_GLOBAL, RTLD_NOW
@@ -14,27 +17,193 @@
 else:
     from ._cdo import ffi
 
+# produced from third_party/aie-rt/driver/src/global/xaiemlgbl_params.h
+_CORE_TILE_MAP = {
+    0x00031150: 0x000FFFFF,  # XAIEMLGBL_CORE_MODULE_CORE_LE
+    0x00031170: 0x00001800,  # XAIEMLGBL_CORE_MODULE_CORE_CR
+    0x00032000: 0x00000002,  # XAIEMLGBL_CORE_MODULE_CORE_CONTROL
+    0x00032004: 0x00000002,  # XAIEMLGBL_CORE_MODULE_CORE_STATUS
+    0x000340F0: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_TIMER_TRIG_EVENT_LOW_VALUE
+    0x000340F4: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_TIMER_TRIG_EVENT_HIGH_VALUE
+    0x00034200: 0x00000002,  # XAIEMLGBL_CORE_MODULE_EVENT_STATUS0
+    0x00034500: 0x00000FFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_0_ENABLE
+    0x00034504: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_PC_ENABLE
+    0x00034508: 0x000001FF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_CORE_STALL_ENABLE
+    0x0003450C: 0x00001FFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_CORE_PROGRAM_FLOW_ENABLE
+    0x00034510: 0x01FFFFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_ERRORS0_ENABLE
+    0x00034514: 0x01FFFFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_ERRORS1_ENABLE
+    0x00034518: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_STREAM_SWITCH_ENABLE
+    0x0003451C: 0x0000FFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_BROADCAST_ENABLE
+    0x00034520: 0x0000000F,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_USER_EVENT_ENABLE
+    0x00036030: 0x0000000F,  # XAIEMLGBL_CORE_MODULE_TILE_CONTROL
+    0x0003FF38: 0x00000007,  # XAIEMLGBL_CORE_MODULE_STREAM_SWITCH_ADAPTIVE_CLOCK_GATE_ABORT_PERIOD
+    0x00060000: 0x00000037,  # XAIEMLGBL_CORE_MODULE_MODULE_CLOCK_CONTROL
+    0x000140F0: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_TIMER_TRIG_EVENT_LOW_VALUE
+    0x000140F4: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_TIMER_TRIG_EVENT_HIGH_VALUE
+    0x00014200: 0x00000002,  # XAIEMLGBL_CORE_MODULE_EVENT_STATUS0
+    0x00014500: 0x000003FF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_0_ENABLE
+    0x00014504: 0x00000003,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_WATCHPOINT_ENABLE
+    0x00014508: 0x00FFFFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_DMA_ENABLE
+    0x0001450C: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_LOCK_ENABLE
+    0x00014510: 0x000000FF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_MEMORY_CONFLICT_ENABLE
+    0x00014514: 0x0000FFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_ERROR_ENABLE
+    0x00014518: 0x0000FFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_BROADCAST_ENABLE
+    0x0001451C: 0x0000000F,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_USER_EVENT_ENABLE
+    0x0001F100: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_0
+    0x0001F104: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_1
+    0x0001F108: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_2
+    0x0001F10C: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_3
+    0x0001F110: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_4
+    0x0001F114: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_5
+    0x0001F118: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_6
+    0x0001F11C: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_7
+}
+
+_MEM_TILE_MAP = {
+    0x000940F0: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_TIMER_TRIG_EVENT_LOW_VALUE
+    0x000940F4: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_TIMER_TRIG_EVENT_HIGH_VALUE
+    0x00094200: 0x00000002,  # XAIEMLGBL_CORE_MODULE_EVENT_STATUS0
+    0x00094500: 0x00000FFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_0_ENABLE
+    0x00094504: 0x0000000F,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_WATCHPOINT_ENABLE
+    0x00094508: 0x00FFFFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_DMA_ENABLE
+    0x0009450C: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_LOCK_ENABLE
+    0x00094510: 0xFFFFFFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_STREAM_SWITCH_ENABLE
+    0x00094514: 0x0000FFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_MEMORY_CONFLICT_ENABLE
+    0x00094518: 0x00000FFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_ERROR_ENABLE
+    0x0009451C: 0x0000FFFF,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_BROADCAST_ENABLE
+    0x00094520: 0x00000003,  # XAIEMLGBL_CORE_MODULE_EVENT_GROUP_USER_EVENT_ENABLE
+    0x00096030: 0x0000000F,  # XAIEMLGBL_CORE_MODULE_TILE_CONTROL
+    0x00096048: 0x00000002,  # XAIEMLGBL_CORE_MODULE_MEMORY_CONTROL
+    0x000B0F38: 0x00000007,  # XAIEMLGBL_CORE_MODULE_STREAM_SWITCH_ADAPTIVE_CLOCK_GATE_ABORT_PERIOD
+    0x000C0400: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_0
+    0x000C0404: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_1
+    0x000C0408: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_2
+    0x000C040C: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_3
+    0x000C0410: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_4
+    0x000C0414: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_5
+    0x000C0418: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_6
+    0x000C041C: 0x0000003F,  # XAIEMLGBL_CORE_MODULE_LOCKS_EVENT_SELECTION_7
+    0x000FFF00: 0x00000033,  # XAIEMLGBL_CORE_MODULE_MODULE_CLOCK_CONTROL
+}
+
+_NOC_TILE_MAP = {
+    0x00014100: 0x0000003F,  # XAIEMLGBL_NOC_MODULE_LOCKS_EVENT_SELECTION_0
+    0x00014104: 0x0000003F,  # XAIEMLGBL_NOC_MODULE_LOCKS_EVENT_SELECTION_1
+    0x00014108: 0x0000003F,  # XAIEMLGBL_NOC_MODULE_LOCKS_EVENT_SELECTION_2
+    0x0001410C: 0x0000003F,  # XAIEMLGBL_NOC_MODULE_LOCKS_EVENT_SELECTION_3
+    0x00014110: 0x0000003F,  # XAIEMLGBL_NOC_MODULE_LOCKS_EVENT_SELECTION_4
+    0x00014114: 0x0000003F,  # XAIEMLGBL_NOC_MODULE_LOCKS_EVENT_SELECTION_5
+    0x00033000: 0x000000DB,  # XAIEMLGBL_NOC_MODULE_PL_INTERFACE_UPSIZER_CONFIG
+    0x00033004: 0x000006DB,  # XAIEMLGBL_NOC_MODULE_PL_INTERFACE_DOWNSIZER_CONFIG
+    0x000340F0: 0xFFFFFFFF,  # XAIEMLGBL_NOC_MODULE_TIMER_TRIG_EVENT_LOW_VALUE
+    0x000340F4: 0xFFFFFFFF,  # XAIEMLGBL_NOC_MODULE_TIMER_TRIG_EVENT_HIGH_VALUE
+    0x00034200: 0x00000002,  # XAIEMLGBL_NOC_MODULE_EVENT_STATUS0
+    0x00034500: 0x000003FF,  # XAIEMLGBL_NOC_MODULE_EVENT_GROUP_0_ENABLE
+    0x00034504: 0x00FFFFFF,  # XAIEMLGBL_NOC_MODULE_EVENT_GROUP_DMA_ACTIVITY_ENABLE
+    0x00034508: 0x00FFFFFF,  # XAIEMLGBL_NOC_MODULE_EVENT_GROUP_LOCK_ENABLE
+    0x0003450C: 0x00000FFF,  # XAIEMLGBL_NOC_MODULE_EVENT_GROUP_ERRORS_ENABLE
+    0x00034510: 0xFFFFFFFF,  # XAIEMLGBL_NOC_MODULE_EVENT_GROUP_STREAM_SWITCH_ENABLE
+    0x00034514: 0x0000FFFF,  # XAIEMLGBL_NOC_MODULE_EVENT_GROUP_BROADCAST_A_ENABLE
+    0x00036030: 0x0000000F,  # XAIEMLGBL_NOC_MODULE_TILE_CONTROL
+    0x0003FF38: 0x00000007,  # XAIEMLGBL_NOC_MODULE_STREAM_SWITCH_ADAPTIVE_CLOCK_GATE_ABORT_PERIOD
+    0x000FFF00: 0x0000003B,  # XAIEMLGBL_NOC_MODULE_MODULE_CLOCK_CONTROL_0
+    0x000FFF04: 0x00000001,  # XAIEMLGBL_NOC_MODULE_MODULE_CLOCK_CONTROL_1
+}
+
+_ADDRESS_ALREADY_WRITTEN_TO = None
+
+XAIE_COL_SHIFT = 25
+XAIE_ROW_SHIFT = 20
+
+assert XAIE_COL_SHIFT > XAIE_ROW_SHIFT
+
+
+def is_core_tile(col, row):
+    return row > 1
+
+
+def is_mem_tile(col, row):
+    return row == 1
+
+
+noc_columns = {0, 1, 2, 3}
+
+
+def is_shim_noc_tile(col, row):
+    return row == 0 and col in noc_columns
 
-@ffi.def_extern()
-def cdo_BlockWrite32(Addr, pData, size):
-    print(Addr, pData, size)
+
+def get_tile_addr(c, r):
+    return (c & 0xFF) << XAIE_COL_SHIFT | (r & 0xFF) << XAIE_ROW_SHIFT
+
+
+def get_addr_tile(addr):
+    offset = addr & 0xFFFFF
+    addr >>= XAIE_ROW_SHIFT
+    r = addr & 0xF
+    addr >>= XAIE_COL_SHIFT - XAIE_ROW_SHIFT
+    c = addr & 0xF
+    return c, r, offset
+
+
+def init_value(Addr):
+    c, r, offset = get_addr_tile(Addr)
+    if is_mem_tile(c, r):
+        return _MEM_TILE_MAP.get(offset, 0)
+    elif is_core_tile(c, r):
+        return _CORE_TILE_MAP.get(offset, 0)
+    elif is_shim_noc_tile(c, r):
+        return _NOC_TILE_MAP.get(offset, 0)
+    else:
+        raise RuntimeError("unknown tile")
 
 
 @ffi.def_extern()
 def cdo_Write32(Addr, Data):
-    print(Addr, Data)
+    _ADDRESS_ALREADY_WRITTEN_TO[Addr] = Data
+    logger.debug(f"Write32 {Addr=:08x} {Data=:08x}")
+
+
+def Read32(Addr):
+    if Addr not in _ADDRESS_ALREADY_WRITTEN_TO:
+        _ADDRESS_ALREADY_WRITTEN_TO[Addr] = init_value(Addr)
+    Data = _ADDRESS_ALREADY_WRITTEN_TO[Addr]
+    logger.debug(f"Read32 {Addr=:08x} {Data=:08x}")
+    return Data
+
+
+@ffi.def_extern()
+def cdo_BlockWrite32(Addr, pData, size):
+    logger.debug(f"BlockWrite32 {Addr=:08x} {pData=} {size}")
+    data = ffi.unpack(pData, size)
+    for i, v in enumerate(data):
+        cdo_Write32(Addr + i * 4, v)
 
 
 @ffi.def_extern()
 def cdo_MaskWrite32(Addr, Mask, Data):
-    print(Addr, Mask, Data)
+    RegVal = Read32(Addr)
+    logger.debug(f"MaskWrite32 {Addr=:08x} {Mask=:08x} {RegVal=:08x} {Data=:08x}")
+    RegVal &= ~Mask
+    cdo_Write32(Addr, RegVal | Data)
 
 
 @ffi.def_extern()
 def cdo_MaskPoll(Addr, Mask, Expected_Value, TimeoutInMS):
-    print(Addr, Mask, Expected_Value, TimeoutInMS)
+    logger.debug(f"MaskPoll {Addr=:08x} {Mask=:08x} {Expected_Value=} {TimeoutInMS}")
+    raise NotImplementedError
 
 
 @ffi.def_extern()
 def cdo_BlockSet32(Addr, Data, size):
-    print(Addr, Data, size)
+    logger.debug(f"BlockSet32 {Addr=:08x} {Data=} {size=}")
+    raise NotImplementedError
+
+
+def get_written_addresses():
+    return dict(_ADDRESS_ALREADY_WRITTEN_TO)
+
+
+def reset_written_addresses():
+    global _ADDRESS_ALREADY_WRITTEN_TO
+    _ADDRESS_ALREADY_WRITTEN_TO = OrderedDict()