Prepare for PyPI

Author: haochengxia

.gitignore

@@ -20,3 +20,5 @@ sftp-config.json
 # Clangd cache
 *.cache/
 .lint-logs/
+# Python wheels
+*.whl

libCacheSim-python/CMakeLists.txt

@@ -1,7 +1,12 @@
 cmake_minimum_required(VERSION 3.15...3.27)
 
 # Include exported variables from cache
-set(PARENT_BUILD_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../build")
+if(DEFINED LIBCB_BUILD_DIR)
+    set(PARENT_BUILD_DIR "${LIBCB_BUILD_DIR}")
+    message(STATUS "Using provided LIBCB_BUILD_DIR: ${LIBCB_BUILD_DIR}")
+else()
+    set(PARENT_BUILD_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../build")
+endif()
 set(EXPORT_FILE "${PARENT_BUILD_DIR}/export_vars.cmake")
 
 if(EXISTS "${EXPORT_FILE}")
@@ -48,10 +53,10 @@ include_directories(${GLib_CONFIG_INCLUDE_DIR})
 include_directories(${XGBOOST_INCLUDE_DIR})
 include_directories(${LIGHTGBM_PATH})
 include_directories(${ZSTD_INCLUDE_DIR})
-include_directories(${CMAKE_CURRENT_SOURCE_DIR}/../libCacheSim/bin)
+include_directories(${MAIN_PROJECT_SOURCE_DIR}/libCacheSim/bin)
 
 # Find the main libCacheSim library
-set(MAIN_PROJECT_BUILD_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../build")
+set(MAIN_PROJECT_BUILD_DIR "${PARENT_BUILD_DIR}")
 set(MAIN_PROJECT_LIB_PATH "${MAIN_PROJECT_BUILD_DIR}/liblibCacheSim.a")
 
 if(EXISTS "${MAIN_PROJECT_LIB_PATH}")
@@ -61,7 +66,7 @@ if(EXISTS "${MAIN_PROJECT_LIB_PATH}")
     add_library(libCacheSim_main STATIC IMPORTED)
     set_target_properties(libCacheSim_main PROPERTIES
         IMPORTED_LOCATION "${MAIN_PROJECT_LIB_PATH}"
-        INTERFACE_INCLUDE_DIRECTORIES "${CMAKE_CURRENT_SOURCE_DIR}/../libCacheSim/include;${CMAKE_CURRENT_SOURCE_DIR}/../libCacheSim/utils/include;${CMAKE_CURRENT_SOURCE_DIR}/../libCacheSim"
+        INTERFACE_INCLUDE_DIRECTORIES "${MAIN_PROJECT_SOURCE_DIR}/libCacheSim/include;${MAIN_PROJECT_SOURCE_DIR}/libCacheSim/utils/include;${MAIN_PROJECT_SOURCE_DIR}/libCacheSim"
     )
 
     # Link dependencies that the main library needs
@@ -74,7 +79,7 @@ endif()
 
 python_add_library(_libcachesim MODULE
     src/pylibcachesim.cpp
-    ${CMAKE_CURRENT_SOURCE_DIR}/../libCacheSim/bin/cli_reader_utils.c
+    ${MAIN_PROJECT_SOURCE_DIR}/libCacheSim/bin/cli_reader_utils.c
     WITH_SOABI
 )
 

libCacheSim-python/MAINFEST.in

@@ -3,6 +3,11 @@
 set(EXPORT_FILE "${CMAKE_BINARY_DIR}/export_vars.cmake")
 file(WRITE "${EXPORT_FILE}" "")
 
+get_filename_component(MAIN_PROJECT_SOURCE_DIR ${CMAKE_SOURCE_DIR} ABSOLUTE)
+file(WRITE ${CMAKE_BINARY_DIR}/export_vars.cmake "set(MAIN_PROJECT_SOURCE_DIR \"${MAIN_PROJECT_SOURCE_DIR}\")\n")
+file(APPEND ${CMAKE_BINARY_DIR}/export_vars.cmake "set(dependency_libs \"${dependency_libs}\")\n")
+file(APPEND ${CMAKE_BINARY_DIR}/export_vars.cmake "set(LIBCACHESIM_VERSION \"${LIBCACHESIM_VERSION}\")\n")
+
 # ==============================================================================
 # Export project metadata
 # ==============================================================================

libCacheSim-python/export/CMakeLists.txt

@@ -16,8 +16,6 @@ test = ["pytest"]
 
 [tool.scikit-build]
 wheel.expand-macos-universal-tags = true
-minimum-version = "build-system.requires"
-cmake.args = ["-G", "Ninja"]
 
 [tool.pytest.ini_options]
 minversion = "8.0"
@@ -32,12 +30,23 @@ testpaths = ["tests"]
 
 
 [tool.cibuildwheel]
-build-frontend = "build[uv]"
-test-command = "pytest {project}/tests"
-test-extras = ["test"]
+build-frontend = "build"
+manylinux-x86_64-image = "quay.io/pypa/manylinux_2_34_x86_64"
+# Only build for x86_64 architectures
+build = "*-manylinux_x86_64"
+# Install build dependencies using dnf. This runs once per container.
+before-all = "dnf install -y ninja-build cmake libzstd-devel glib2-devel"
+# We add 'rm -rf build' to ensure a clean build inside the container.
+# The C++ core is built first, then the wheel build will use it.
+# Use absolute paths to avoid issues with the working directory.
+before-build = "rm -rf /project/build && cmake -S /project -B /project/build -G Ninja && cmake --build /project/build"
+# Set the environment variable for the wheel build step.
+environment = { LCS_BUILD_DIR = "/project/build" }
+# test-requires = "pytest"
+# test-command = "pytest {project}/tests"
 
-[tool.cibuildwheel.pyodide]
-build-frontend = {name = "build", args = ["--exports", "whole_archive"]}
+# [tool.cibuildwheel.pyodide]
+# build-frontend = {name = "build", args = ["--exports", "whole_archive"]}
 
 [tool.ruff.lint]
 extend-select = [
@@ -70,4 +79,4 @@ ignore = [
 isort.required-imports = ["from __future__ import annotations"]
 
 [tool.ruff.lint.per-file-ignores]
-"tests/**" = ["T20"]
+"tests/**" = ["T20"]

libCacheSim-python/pyproject.toml

@@ -53,7 +53,7 @@ int minimalIncrementCBF_init(struct minimalIncrementCBF *CBF, int entries,
     CBF->counter_num = CBF->hashes * 2;
   }
 
-  CBF->bf = (unsigned int *)calloc(sizeof(unsigned int), CBF->counter_num);
+  CBF->bf = (unsigned int *)calloc(CBF->counter_num, sizeof(unsigned int));
   // TODO: check whether unsigned int is enough for the size of each counter
 
   if (CBF->bf == NULL) {

libCacheSim/dataStructure/minimalIncrementCBF.c

@@ -22,7 +22,7 @@
 #elif HEAP_ALLOCATOR == HEAP_ALLOCATOR_MALLOC
 #include <stdlib.h>
 #define my_malloc(type) (type *)malloc(sizeof(type))
-#define my_malloc_n(type, n) (type *)calloc(sizeof(type), n)
+#define my_malloc_n(type, n) (type *)calloc(n, sizeof(type))
 #define my_free(size, addr) free(addr)
 
 #elif HEAP_ALLOCATOR == HEAP_ALLOCATOR_ALIGNED_MALLOC

libCacheSim/include/libCacheSim/mem.h

@@ -0,0 +1 @@
+python3 -m cibuildwheel --platform linux libCacheSim-python