x86sim 0.1.0__tar.gz

x86sim-0.1.0/.clang-format

@@ -0,0 +1,77 @@
+---
+# clang-format configuration for RASPsim
+BasedOnStyle: LLVM
+
+# Basic formatting
+IndentWidth: 2
+TabWidth: 2
+UseTab: Never
+ColumnLimit: 120
+
+# Language
+Language: Cpp
+Standard: c++20
+
+# Braces
+BreakBeforeBraces: Attach
+BraceWrapping:
+  AfterClass: false
+  AfterControlStatement: Never
+  AfterEnum: false
+  AfterFunction: false
+  AfterNamespace: false
+  AfterStruct: false
+  AfterUnion: false
+  BeforeCatch: false
+  BeforeElse: false
+
+# Indentation
+NamespaceIndentation: None
+IndentCaseLabels: false
+IndentPPDirectives: None
+AccessModifierOffset: -2
+
+# Alignment
+AlignAfterOpenBracket: Align
+AlignConsecutiveAssignments: None
+AlignConsecutiveDeclarations: None
+AlignOperands: Align
+AlignTrailingComments: true
+PointerAlignment: Left
+
+# Spacing
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: false
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeParens: ControlStatements
+SpaceInEmptyParentheses: false
+SpacesInAngles: false
+SpacesInCStyleCastParentheses: false
+SpacesInContainerLiterals: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+
+# Line breaks
+AllowShortBlocksOnASingleLine: Empty
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: Inline
+AllowShortIfStatementsOnASingleLine: Never
+AllowShortLoopsOnASingleLine: false
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: false
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: true
+BinPackParameters: true
+BreakBeforeBinaryOperators: None
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializers: BeforeColon
+BreakInheritanceList: BeforeColon
+
+# Includes
+SortIncludes: false
+IncludeBlocks: Preserve
+
+# Other
+KeepEmptyLinesAtTheStartOfBlocks: true
+MaxEmptyLinesToKeep: 2
+ReflowComments: false

x86sim-0.1.0/.githooks/pre-commit

@@ -0,0 +1,40 @@
+#!/usr/bin/env sh
+# Reject commits whose staged C/C++ changes are not clang-format clean.
+#
+# Enable with:   git config core.hooksPath .githooks
+# (run once per clone; `make hooks` does this for you).
+#
+# Set CLANG_FORMAT to override the binary. If clang-format is missing the hook
+# skips silently rather than blocking the commit.
+set -eu
+
+CLANG_FORMAT="${CLANG_FORMAT:-clang-format}"
+if ! command -v "$CLANG_FORMAT" >/dev/null 2>&1; then
+  echo "pre-commit: '$CLANG_FORMAT' not found; skipping clang-format check" >&2
+  exit 0
+fi
+
+# Added/copied/modified staged sources owned by this project.
+files=$(git diff --cached --name-only --diff-filter=ACM -- \
+  'src/*.cpp' 'src/*.cc' 'src/*.c' 'src/*.h' 'src/*.hpp' \
+  'include/*.h' 'include/*.hpp' 'include/*.cpp')
+[ -z "$files" ] && exit 0
+
+fail=0
+for f in $files; do
+  # Compare the *staged* blob against its formatted form, so what gets checked
+  # is exactly what would be committed (not unstaged working-tree edits).
+  staged=$(git show ":$f")
+  formatted=$(printf '%s' "$staged" | "$CLANG_FORMAT" --assume-filename="$f")
+  if [ "$staged" != "$formatted" ]; then
+    echo "pre-commit: needs formatting: $f" >&2
+    fail=1
+  fi
+done
+
+if [ "$fail" -ne 0 ]; then
+  echo "" >&2
+  echo "Fix with 'tools/clang-format.sh fix' (or clang-format -i), then re-stage." >&2
+  exit 1
+fi
+exit 0

x86sim-0.1.0/.github/workflows/bindings.yml

@@ -0,0 +1,92 @@
+name: Build Python Package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  release:
+    types: [ published ]
+
+jobs:
+  sdist:
+    name: Build source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0   # GitRevision.cmake stamps the build from git
+
+      - uses: actions/setup-python@v6
+        with:
+          python-version: '3.x'
+
+      - name: Build sdist
+        run: |
+          python -m pip install --upgrade build
+          python -m build --sdist
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist-sdist
+          path: dist/*.tar.gz
+
+  wheels:
+    name: Build manylinux wheels
+    runs-on: ubuntu-latest
+    # A wheel-build hiccup (e.g. toolchain availability in the manylinux image)
+    # must never block publishing the sdist, which always installs from source.
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Build wheels
+        uses: pypa/cibuildwheel@v4.1.0
+        env:
+          # x86sim needs C++26 (std::expected). The default manylinux compiler
+          # is too old, so install a recent GCC toolset and point the build at
+          # it. Bump the toolset version if cxx_std_26 is rejected.
+          CIBW_BUILD: "cp310-* cp311-* cp312-* cp313-*"
+          CIBW_SKIP: "*-musllinux*"
+          CIBW_ARCHS_LINUX: "x86_64"
+          CIBW_MANYLINUX_X86_64_IMAGE: "manylinux_2_28"
+          CIBW_BEFORE_ALL_LINUX: "dnf install -y gcc-toolset-14-gcc-c++ || dnf install -y gcc-toolset-13-gcc-c++"
+          # CXXFLAGS silences -Winvalid-offsetof: several simulator structs use
+          # C-style layout idioms on non-standard-layout types, so offsetof is
+          # only conditionally-supported and the gcc-toolset warns at every site.
+          CIBW_ENVIRONMENT_LINUX: >-
+            PATH=/opt/rh/gcc-toolset-14/root/usr/bin:/opt/rh/gcc-toolset-13/root/usr/bin:$PATH
+            CXXFLAGS=-Wno-invalid-offsetof
+          CIBW_TEST_REQUIRES: "pyelftools"
+          CIBW_TEST_COMMAND: "python -c \"import x86sim; x86sim.Machine()\""
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist-wheels
+          path: wheelhouse/*.whl
+
+  publish-to-pypi:
+    name: Publish 🐍 distribution 📦 to PyPI
+    needs: [ sdist, wheels ]
+    # Only publish on a GitHub Release; pushes to main would collide on the
+    # already-uploaded version.
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/x86sim
+    permissions:
+      id-token: write   # required for PyPI Trusted Publishing (OIDC)
+
+    steps:
+      - name: Download all distributions
+        uses: actions/download-artifact@v8
+        with:
+          pattern: dist-*
+          merge-multiple: true
+          path: dist/
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

x86sim-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,26 @@
+name: Build Documentation
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: self-hosted
+
+    steps:
+      - uses: actions/checkout@v5
+     
+      -  name: Build Docs
+         run: make -C Documentation
+
+
+      - name: Upload PTLsimManual
+        uses: actions/upload-artifact@v7
+        with:
+          name: PTLsimManual.pdf
+          path: Documentation/PTLsimManual.pdf
+
+    

x86sim-0.1.0/.github/workflows/executable.yml

@@ -0,0 +1,39 @@
+name: Build Executable
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    # ubuntu-latest ships GCC 13, which does not accept -std=c++26. Install a
+    # C++26-capable toolchain (and Ninja, the default generator) and point the
+    # build at it.
+    env:
+      CC: gcc-14
+      CXX: g++-14
+      # Several simulator structs intentionally use C-style layout idioms on
+      # non-standard-layout types, so __builtin_offsetof (offsetof_/baseof) is
+      # only conditionally-supported and GCC warns at every site. Silence that
+      # category for the CI build only; CMake folds CXXFLAGS into the cache on
+      # the first (always fresh here) configure.
+      CXXFLAGS: -Wno-invalid-offsetof
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install toolchain
+        run: sudo apt-get update && sudo apt-get install -y g++-14 ninja-build cmake
+
+      - name: Build raspsim Executable
+        run: make -j$(nproc) raspsim
+
+      - name: Upload raspsim Executable
+        uses: actions/upload-artifact@v7
+        with:
+          name: raspsim
+          path: raspsim

x86sim-0.1.0/.github/workflows/tests.yml

@@ -0,0 +1,86 @@
+name: Tests
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+# These runs are long. Cancel superseded runs on the same ref so the
+# self-hosted runners are not tied up by stale commits.
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  # ---------------------------------------------------------------------------
+  # Gate 0: style. Cheap, so it fails fast before any runner time is spent
+  # building or simulating.
+  # ---------------------------------------------------------------------------
+  format:
+    name: clang-format
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v5
+      - name: Check formatting
+        run: tools/clang-format.sh check
+
+  # ---------------------------------------------------------------------------
+  # Gate 1: quick smoke per core (extraquick suite). Individual jobs so each
+  # core reports separately and can land on its own runner.
+  # ---------------------------------------------------------------------------
+  quick-seq:
+    name: Quick (seq)
+    needs: format
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v5
+      - name: Configure
+        run: cmake --preset release -DCMAKE_CXX_FLAGS=-Wno-invalid-offsetof -DSQLITE_TEST_SUITE=extraquick -DSQLITE_TEST_CORES=seq
+      - name: Build
+        run: cmake --build --preset release --target x86sim-linux
+      - name: Test (seq, extraquick)
+        run: ctest --test-dir build/release -L seq --output-on-failure -j "$(nproc)"
+
+  quick-ooo:
+    name: Quick (ooo)
+    needs: format
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v5
+      - name: Configure
+        run: cmake --preset release -DCMAKE_CXX_FLAGS=-Wno-invalid-offsetof -DSQLITE_TEST_SUITE=extraquick -DSQLITE_TEST_CORES=ooo
+      - name: Build
+        run: cmake --build --preset release --target x86sim-linux
+      - name: Test (ooo, extraquick)
+        run: ctest --test-dir build/release -L ooo --output-on-failure -j "$(nproc)"
+
+  # ---------------------------------------------------------------------------
+  # Gate 2: full suite per core. Only runs if BOTH quick jobs passed, so we
+  # never spend the (very long) full run on a build that fails the smoke test.
+  # ---------------------------------------------------------------------------
+  full-seq:
+    name: Full (seq)
+    needs: [quick-seq, quick-ooo]
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v5
+      - name: Configure
+        run: cmake --preset release -DCMAKE_CXX_FLAGS=-Wno-invalid-offsetof -DSQLITE_TEST_SUITE=all -DSQLITE_TEST_CORES=seq
+      - name: Build
+        run: cmake --build --preset release --target x86sim-linux
+      - name: Test (seq, full)
+        run: ctest --test-dir build/release -L seq --output-on-failure -j "$(nproc)"
+
+  full-ooo:
+    name: Full (ooo)
+    needs: [quick-seq, quick-ooo]
+    runs-on: self-hosted
+    steps:
+      - uses: actions/checkout@v5
+      - name: Configure
+        run: cmake --preset release -DCMAKE_CXX_FLAGS=-Wno-invalid-offsetof -DSQLITE_TEST_SUITE=all -DSQLITE_TEST_CORES=ooo
+      - name: Build
+        run: cmake --build --preset release --target x86sim-linux
+      - name: Test (ooo, full)
+        run: ctest --test-dir build/release -L ooo --output-on-failure -j "$(nproc)"

x86sim-0.1.0/.gitignore

@@ -0,0 +1,34 @@
+.depend
+cpuid
+ptlsim.log*
+dstbuild.temp.cpp
+ptlsim
+ptlsim.dst
+ptlstats
+./raspsim
+test.dat
+dumpcode.dat
+*.o
+venv
+__pycache__
+*.so
+*.pyi
+*.egg-info
+/dist
+/build-wheel
+.cache/
+.DS_Store
+
+CMakeFiles
+CMakeCache.txt
+cmake_install.cmake
+*.ninja*
+/raspsim
+build/
+compile_commands.json
+Makefile
+makefile
+
+# Built example guests (assembled from the .S sources)
+examples/linux-x86_64/echo
+examples/linux-x86_64/hello_syscalls

x86sim-0.1.0/CMakeLists.txt

@@ -0,0 +1,143 @@
+cmake_minimum_required(VERSION 3.25)
+
+project(x86sim
+  DESCRIPTION "Cycle-accurate x86-64 virtual CPU core and command-line simulators"
+  LANGUAGES CXX
+)
+
+option(X86SIM_BUILD_DEFAULTS "Build the Linux syscall/cpuid support library" ON)
+option(X86SIM_BUILD_RASPSIM  "Build the raspsim command-line simulator"      ON)
+option(X86SIM_BUILD_LINUX    "Build the x86sim-linux command-line simulator" ON)
+option(X86SIM_BUILD_TESTS    "Build the CTest suite (SQLite through x86sim-linux)" ON)
+option(X86SIM_BUILD_PYTHON   "Build the pybind11 Python extension module"   OFF)
+
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+include(GNUInstallDirs)
+include(GitRevision)
+
+# Build-time provenance, stamped into the core library and the simulators.
+cmake_host_system_information(RESULT buildhost QUERY FQDN)
+set(build_info BUILDHOST=${buildhost} GIT_REVISION=${GIT_REVISION})
+
+set(install_targets)
+
+# --- x86sim: portable virtual CPU core (always built) ---------------------
+file(GLOB vcore_sources CONFIGURE_DEPENDS src/x86sim/*.cpp)
+add_library(x86sim)
+add_library(x86sim::x86sim ALIAS x86sim)
+target_sources(x86sim
+  PRIVATE
+    ${vcore_sources}
+  PUBLIC
+    FILE_SET HEADERS
+    BASE_DIRS include
+    FILES
+      include/x86sim/logging.hpp
+      include/x86sim/registerfile.hpp
+      include/x86sim/x86sim.hpp
+)
+target_include_directories(x86sim PRIVATE src/x86sim)
+target_compile_definitions(x86sim PRIVATE ${build_info})
+target_compile_features(x86sim PUBLIC cxx_std_26)
+# The Python module links this static archive into a shared object, so it must
+# be position-independent. Scoped to the wheel build to keep the executables
+# non-PIC.
+set_target_properties(x86sim PROPERTIES POSITION_INDEPENDENT_CODE ${X86SIM_BUILD_PYTHON})
+list(APPEND install_targets x86sim)
+
+# --- x86sim_defaults: Linux syscall + cpuid support library ---------------
+if(X86SIM_BUILD_DEFAULTS)
+  add_library(x86sim_defaults)
+  add_library(x86sim::defaults ALIAS x86sim_defaults)
+  set_target_properties(x86sim_defaults PROPERTIES EXPORT_NAME defaults)
+  target_sources(x86sim_defaults
+    PRIVATE
+      src/x86sim-support/cpuid.cpp
+      src/x86sim-support/syscall-linux.cpp
+    PUBLIC
+      FILE_SET HEADERS
+      BASE_DIRS include
+      FILES
+        include/x86sim-support/cpuid.hpp
+        include/x86sim-support/syscall-linux.hpp
+  )
+  target_link_libraries(x86sim_defaults PUBLIC x86sim::x86sim)
+  target_include_directories(x86sim_defaults PRIVATE src/x86sim)
+  set_target_properties(x86sim_defaults PROPERTIES POSITION_INDEPENDENT_CODE ${X86SIM_BUILD_PYTHON})
+  list(APPEND install_targets x86sim_defaults)
+endif()
+
+# --- x86sim_posix: host-POSIX Linux syscall handlers ----------------------
+# File/socket/host-time handlers split out of x86sim_defaults so the defaults
+# library stays fully portable (no host headers). Only the native x86sim-linux
+# tool links it; raspsim and the Python wheel keep linking x86sim::defaults.
+if(X86SIM_BUILD_LINUX)
+  add_library(x86sim_posix)
+  add_library(x86sim::posix ALIAS x86sim_posix)
+  set_target_properties(x86sim_posix PROPERTIES EXPORT_NAME posix)
+  target_sources(x86sim_posix
+    PRIVATE
+      src/x86sim-support/syscall-linux-posix.cpp
+    PUBLIC
+      FILE_SET HEADERS
+      BASE_DIRS include
+      FILES
+        include/x86sim-support/syscall-linux-posix.hpp
+  )
+  target_link_libraries(x86sim_posix PUBLIC x86sim::defaults)
+  target_include_directories(x86sim_posix PRIVATE src/x86sim)
+  list(APPEND install_targets x86sim_posix)
+endif()
+
+# --- raspsim: command-line simulator --------------------------------------
+if(X86SIM_BUILD_RASPSIM)
+  add_executable(raspsim
+    src/raspsim/config.cpp
+    src/raspsim/raspsim.cpp
+  )
+  target_link_libraries(raspsim PRIVATE x86sim::defaults)
+  target_include_directories(raspsim PRIVATE src/x86sim)
+  list(APPEND install_targets raspsim)
+endif()
+
+# --- x86sim-linux: command-line simulator ---------------------------------
+if(X86SIM_BUILD_LINUX)
+  add_executable(x86sim-linux
+    src/x86sim-linux/x86sim-linux.cpp
+  )
+  target_link_libraries(x86sim-linux PRIVATE x86sim::posix)
+  list(APPEND install_targets x86sim-linux)
+endif()
+
+# --- install / export -----------------------------------------------------
+install(TARGETS ${install_targets}
+  EXPORT x86simTargets
+  FILE_SET HEADERS
+)
+install(EXPORT x86simTargets
+  NAMESPACE x86sim::
+  DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/x86sim"
+)
+
+# --- python bindings ------------------------------------------------------
+# The extension links the portable support library (x86sim::defaults) for the
+# cpuid defaults and the portable Linux heap (brk/mmap) + ABI helpers. It never
+# links x86sim::posix, so the wheel stays buildable off-Linux. Driven by
+# pyproject.toml, which points scikit-build-core at this file, forces
+# X86SIM_BUILD_DEFAULTS=ON, and disables the Linux tools. (The wasm binding is a
+# separate target.)
+if(X86SIM_BUILD_PYTHON)
+  find_package(pybind11 CONFIG REQUIRED)
+  pybind11_add_module(bindings MODULE
+    src/bindings/binding.cpp
+  )
+  target_link_libraries(bindings PRIVATE x86sim::defaults)
+  target_include_directories(bindings PRIVATE include)
+  install(TARGETS bindings LIBRARY DESTINATION x86sim)
+endif()
+
+# --- tests ----------------------------------------------------------------
+if(X86SIM_BUILD_TESTS)
+  enable_testing()
+  add_subdirectory(tests/sqlite3)
+endif()

x86sim-0.1.0/CMakePresets.json

@@ -0,0 +1,66 @@
+{
+  "version": 6,
+  "cmakeMinimumRequired": { "major": 3, "minor": 25, "patch": 0 },
+  "configurePresets": [
+    {
+      "name": "base",
+      "hidden": true,
+      "binaryDir": "${sourceDir}/build/${presetName}",
+      "cacheVariables": {
+        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
+        "CMAKE_CXX_STANDARD": "26",
+        "CMAKE_CXX_STANDARD_REQUIRED": "ON",
+        "CMAKE_CXX_EXTENSIONS": "OFF"
+      }
+    },
+    {
+      "name": "debug",
+      "inherits": "base",
+      "displayName": "Debug",
+      "cacheVariables": { "CMAKE_BUILD_TYPE": "Debug" }
+    },
+    {
+      "name": "release",
+      "inherits": "base",
+      "displayName": "Release",
+      "cacheVariables": { "CMAKE_BUILD_TYPE": "Release" }
+    },
+    {
+      "name": "relwithdeb",
+      "inherits": "base",
+      "displayName": "RelWithDebInfo",
+      "cacheVariables": { "CMAKE_BUILD_TYPE": "RelWithDebInfo" }
+    },
+    {
+      "name": "tsan",
+      "inherits": "base",
+      "displayName": "ThreadSanitizer",
+      "cacheVariables": {
+        "CMAKE_BUILD_TYPE": "RelWithDebInfo",
+        "CMAKE_CXX_FLAGS": "-fsanitize=thread -g -O1 -fno-omit-frame-pointer",
+        "CMAKE_EXE_LINKER_FLAGS": "-fsanitize=thread"
+      }
+    }
+  ],
+  "buildPresets": [
+    { "name": "debug", "configurePreset": "debug" },
+    { "name": "release", "configurePreset": "release" },
+    { "name": "relwithdeb", "configurePreset": "relwithdeb" },
+    { "name": "tsan", "configurePreset": "tsan" }
+  ],
+  "testPresets": [
+    {
+      "name": "debug",
+      "configurePreset": "debug",
+      "output": { "outputOnFailure": true }
+    },
+    {
+      "name": "tsan",
+      "configurePreset": "tsan",
+      "output": { "outputOnFailure": true },
+      "environment": {
+        "TSAN_OPTIONS": "halt_on_error=1"
+      }
+    }
+  ]
+}