Heimdall

Author: Zixuan Wang <zxwang42@gmail.com>

The initial public release of Heimdall

Co-authored-by: Suyash Mahar <smahar@ucsd.edu>
Co-authored-by: Luyi Li <lul014@ucsd.edu>
Co-authored-by: Jangseon Park <jap036@ucsd.com>
Co-authored-by: Jinpyo Kim <jik066@ucsd.edu>
Co-authored-by: Theodore Michailidis <tmichail@ucsd.edu>
Co-authored-by: Yue Pan <yup014@ucsd.edu>
Co-authored-by: Mingyao Shen <myshen@ucsd.edu>
Signed-off-by: Zixuan Wang <zxwang42@gmail.com>
Signed-off-by: Suyash Mahar <smahar@ucsd.edu>
Signed-off-by: Luyi Li <lul014@ucsd.edu>
Signed-off-by: Jangseon Park <jap036@ucsd.com>
Signed-off-by: Jinpyo Kim <jik066@ucsd.edu>
Signed-off-by: Theodore Michailidis <tmichail@ucsd.edu>
Signed-off-by: Yue Pan <yup014@ucsd.edu>
Signed-off-by: Mingyao Shen <myshen@ucsd.edu>

Author: 8 people

.gitattributes

@@ -0,0 +1 @@
+benchmark/llm_bench/datasets/wiki.test.raw filter=lfs diff=lfs merge=lfs -text

.github/actions/setup-heimdall/action.yml

@@ -0,0 +1,28 @@
+name: "Set up Heimdall dependencies"
+author: "@zxwang42"
+description: "Set up GitHub workflow dependencies for https://github.com/awesome-cxl/heimdall/"
+branding:
+  icon: "truck"
+  color: "gray-dark"
+inputs:
+  python-version:
+    description: "The version of Python to install"
+    required: false
+    default: "3.12"
+runs:
+  using: "composite"
+  steps:
+    - name: Install uv
+      uses: astral-sh/setup-uv@v5
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Set up env file for basic performance build
+      run: cp benchmark/basic_performance/env_files/machine_template.env benchmark/basic_performance/env_files/$(hostname).env
+      shell: bash
+
+    - name: Install packages
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y cmake libnuma-dev
+      shell: bash

.github/workflows/build.yaml

@@ -0,0 +1,62 @@
+name: Build and run short tests
+on: push
+jobs:
+  build:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.12"] # Maybe also some other versions like 3.13
+        os: [ubuntu-latest] # Maybe also macos-latest, windows-latest
+    runs-on: ${{ matrix.os }}
+    env:
+      USER_PASSWORD: "does_not_matter" # GitHub action should run `sudo` without password
+      HEIMDALL_HOSTNAME: "github-workflow" # Match the name under `benchmark/basic_performance/env_files/{hostname}.env`
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Set up dependencies
+        uses: ./.github/actions/setup-heimdall
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: "Build basic performance bandwidth tests"
+        run: uv run heimdall bench build basic bw
+
+      - name: "Install deps of lockfree data structures benchmark"
+        run: uv run heimdall bench install lockfree all
+
+      - name: "Build lockfree data structures benchmark tests"
+        run: uv run heimdall bench build lockfree all
+
+  build-standalone:
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"] # Maybe also some other versions like 3.13
+        os: [ubuntu-latest] # Maybe also macos-latest, windows-latest
+    runs-on: ${{ matrix.os }}
+    env:
+      USER_PASSWORD: "does_not_matter" # GitHub action should run `sudo` without password
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: "recursive"
+
+      - name: Set up dependencies
+        uses: ./.github/actions/setup-heimdall
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Build standalone heimdall binary
+        run: make standalone
+        shell: bash
+
+      - name: "Build basic performance bandwidth tests"
+        run: ./dist/heimdall bench build basic bw

.gitignore

@@ -0,0 +1,261 @@
+/build/
+/dist/
+./heimdall
+
+### C ###
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+### C++ ###
+# Prerequisites
+
+# Compiled Object files
+*.slo
+
+# Precompiled Headers
+
+# Compiled Dynamic libraries
+
+# Fortran module files
+*.mod
+*.smod
+
+# Compiled Static libraries
+*.lai
+
+# Executables
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+
+# Distribution / packaging
+.Python
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+myvenv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# Extern git
+
+# Profiling Result
+results/
+
+# evironment
+self.env
+
+# temp files
+temp.yaml
+
+# vscode config files
+.vscode

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "extern/yaml-cpp"]
+	path = extern/yaml-cpp
+	url = https://github.com/jbeder/yaml-cpp.git