Clean up

haochengxia · haochengxia · commit 7b3624fa68ba · 2025-06-26T21:05:40.000-04:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -20,14 +20,10 @@ jobs:
       - name: Configure CMake
         run: cmake -G Ninja -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}}
       - name: Build
-        run: |
-          cores=$(sysctl -n hw.ncpu)
-          ninja -C ${{github.workspace}}/build -j$((cores + 1))
+        run: ninja -C ${{github.workspace}}/build
       - name: Test
         working-directory: ${{github.workspace}}/build
-        run: |
-          cores=$(sysctl -n hw.ncpu)
-          ctest -C ${{env.BUILD_TYPE}} --output-on-failure --parallel $cores
+        run: ctest -C ${{env.BUILD_TYPE}} --output-on-failure --parallel
 
   ubuntu:
     runs-on: ubuntu-latest
@@ -42,15 +38,12 @@ jobs:
                 -DCMAKE_C_FLAGS="-fsanitize=leak" \
                 -DCMAKE_CXX_FLAGS="-fsanitize=leak"
       - name: Build
-        run: |
-          cores=$(nproc)
-          ninja -C ${{github.workspace}}/build -j$((cores + 1))
+        run: ninja -C ${{github.workspace}}/build
       - name: Test with LSan
         working-directory: ${{github.workspace}}/build
         run: |
           export ASAN_OPTIONS="detect_leaks=1:halt_on_error=1:verbosity=1"
-          cores=$(nproc)
-          ctest -C ${{env.BUILD_TYPE}} --output-on-failure --parallel $cores
+          ctest -C ${{env.BUILD_TYPE}} --output-on-failure --parallel
 
   selfhosted:
     runs-on: self-hosted
@@ -59,11 +52,7 @@ jobs:
       - name: Configure CMake
         run: cmake -G Ninja -B ${{github.workspace}}/build -DCMAKE_BUILD_TYPE=${{env.BUILD_TYPE}} -DENABLE_GLCACHE=on -DENABLE_LRB=on
       - name: Build
-        run: |
-          cores=$(nproc)
-          ninja -C ${{github.workspace}}/build -j$((cores + 1))
+        run: ninja -C ${{github.workspace}}/build
       - name: Test
         working-directory: ${{github.workspace}}/build
-        run: |
-          cores=$(nproc)
-          ctest -C ${{env.BUILD_TYPE}} --output-on-failure --parallel $cores
+        run: ctest -C ${{env.BUILD_TYPE}} --output-on-failure --parallel
diff --git a/README.md b/README.md
@@ -118,6 +118,11 @@ Please see [install.md](/doc/install.md) for instructions on how to install the
 ### Build libCacheSim
 cmake recommends **out-of-source build**, so we do it in a new directory:
 ```bash
+# Prerequisites: Install Ninja build system
+# Ubuntu/Debian: sudo apt install ninja-build
+# macOS: brew install ninja
+# CentOS/RHEL: sudo yum install ninja-build
+
 git clone https://github.com/1a1a11a/libCacheSim
 pushd libCacheSim
 mkdir _build && cd _build
diff --git a/doc/install.md b/doc/install.md
@@ -1,16 +1,16 @@
 ## Install dependency
 
-libCacheSim uses [cmake](https://cmake.org/) build system and has a few dependencies:
+libCacheSim uses [cmake](https://cmake.org/) build system with [Ninja](https://ninja-build.org/) generator and has a few dependencies:
 [glib](https://developer.gnome.org/glib/)
 [tcmalloc](https://github.com/google/tcmalloc),
 [zstd](https://github.com/facebook/zstd).
 
 ### Install dependency on Ubuntu
 
-#### Install glib, tcmalloc and cmake
+#### Install glib, tcmalloc, cmake and ninja
 
 ```bash
-sudo apt install libglib2.0-dev libgoogle-perftools-dev cmake
+sudo apt install libglib2.0-dev libgoogle-perftools-dev cmake ninja-build
 ```
 
 #### Install zstd
@@ -22,8 +22,8 @@ wget https://github.com/facebook/zstd/releases/download/v1.5.0/zstd-1.5.0.tar.gz
 tar xvf zstd-1.5.0.tar.gz
 pushd zstd-1.5.0/build/cmake/
 mkdir _build && cd _build/
-cmake .. && make -j
-sudo make install
+cmake -G Ninja .. && ninja
+sudo ninja install
 popd
 ```
 
@@ -33,8 +33,8 @@ popd
 git clone --recursive https://github.com/dmlc/xgboost
 pushd xgboost
 mkdir _build && cd _build
-cmake .. && make -j
-sudo make install
+cmake -G Ninja .. && ninja
+sudo ninja install
 popd
 ```
 
@@ -44,8 +44,8 @@ popd
 git clone --recursive https://github.com/microsoft/LightGBM
 pushd LightGBM
 mkdir _build && cd _build
-cmake .. && make -j
-sudo make install
+cmake -G Ninja .. && ninja
+sudo ninja install
 popd
 ```
 
@@ -57,7 +57,7 @@ using [homebrew](https://brew.sh/) as an example. While the first line is necess
 - /usr/local/include/glib-2.0/glib/gtypes.h:34:10: fatal error: 'glibconfig.h' file not found
 
 ```bash
-brew install cmake glib google-perftools
+brew install cmake ninja glib google-perftools
 brew install argp-standalone
 brew install pkg-config
 ```
diff --git a/doc/memory_usage_profiling.md b/doc/memory_usage_profiling.md
@@ -1,7 +1,7 @@
 # Profiling Memory Usage in CacheSim with Massif
 
 ## 1. Introduction
-This guide explains how to analyze memory usage in the `cachesim` project using Valgrind's **massif** tool and identifies critical memory overhead areas as potential optimization targets. The workflow consists of the following steps:  
+This guide explains how to analyze memory usage in the `cachesim` project using Valgrind's **massif** tool and identifies critical memory overhead areas as potential optimization targets. The workflow consists of the following steps:
 
 - Heap memory profiling
 - Identifying memory hotspots
@@ -15,8 +15,8 @@ This guide explains how to analyze memory usage in the `cachesim` project using
 ```sh
 # Compile with debug symbols
 mkdir _build && cd _build
-cmake .. -DCMAKE_BUILD_TYPE=Debug
-make -j
+cmake -G Ninja .. -DCMAKE_BUILD_TYPE=Debug
+ninja
 ```
 
 2. Run `massif` for a specific algorithm (e.g., S3-FIFO):
@@ -38,7 +38,7 @@ The generated report primarily includes a bar chart of memory usage (with instru
 
 ```sh
     MB
-519.4^                                        :                               
+519.4^                                        :
      |#:::::::::::::@::::::::::::::::@::@@::::::::::::::::::::::::@::@::@::@::
      |#::: :: :: :::@: ::::: : ::: ::@::@ ::: :: : : ::::::: :::::@::@::@::@::
      |#::: :: :: :::@: ::::: : ::: ::@::@ ::: :: : : ::::::: :::::@::@::@::@::
@@ -76,22 +76,22 @@ The generated report primarily includes a bar chart of memory usage (with instru
 |   | | ->24.74% (134,217,728B) 0x40880A: create_cache (cache_init.h:132)
 |   | |   ->24.74% (134,217,728B) 0x40970B: parse_cmd (cli_parser.c:343)
 |   | |     ->24.74% (134,217,728B) 0x406FFD: main (main.c:18)
-|   | |       
+|   | |
 |   | ->24.74% (134,217,728B) 0x4238C0: S3FIFO_init (S3FIFO.c:118)
 |   | | ->24.74% (134,217,728B) 0x40880A: create_cache (cache_init.h:132)
 |   | |   ->24.74% (134,217,728B) 0x40970B: parse_cmd (cli_parser.c:343)
 |   | |     ->24.74% (134,217,728B) 0x406FFD: main (main.c:18)
-|   | |       
+|   | |
 |   | ->24.74% (134,217,728B) 0x423921: S3FIFO_init (S3FIFO.c:125)
 |   |   ->24.74% (134,217,728B) 0x40880A: create_cache (cache_init.h:132)
 |   |     ->24.74% (134,217,728B) 0x40970B: parse_cmd (cli_parser.c:343)
 |   |       ->24.74% (134,217,728B) 0x406FFD: main (main.c:18)
-|   |         
+|   |
 |   ->24.74% (134,217,728B) 0x4236BB: S3FIFO_init (S3FIFO.c:81)
 |     ->24.74% (134,217,728B) 0x40880A: create_cache (cache_init.h:132)
 |       ->24.74% (134,217,728B) 0x40970B: parse_cmd (cli_parser.c:343)
 |         ->24.74% (134,217,728B) 0x406FFD: main (main.c:18)
-|           
+|
 ->00.84% (4,541,568B) in 1+ places, all below ms_print's threshold (01.00%)
 ```
 
@@ -105,7 +105,7 @@ The above report indicates that the memory usage of S3-FIFO remains nearly const
 
 ### 3.1. Memory Usage of Various Algorithms
 
-We conducted tests using the `wiki_2019t` workload (available at [CMU's dataset repository](https://ftp.pdl.cmu.edu/pub/datasets/twemcacheWorkload/cacheDatasets/wiki/)) to evaluate the memory usage of various algorithms with a cache size of 1GB. 
+We conducted tests using the `wiki_2019t` workload (available at [CMU's dataset repository](https://ftp.pdl.cmu.edu/pub/datasets/twemcacheWorkload/cacheDatasets/wiki/)) to evaluate the memory usage of various algorithms with a cache size of 1GB.
 
 
 | Algorithm   | Peak Memory Usage (MB) | Observations                                                                 |
diff --git a/dockerfile b/dockerfile
@@ -21,7 +21,7 @@ RUN bash ./scripts/install_libcachesim.sh
 
 
 WORKDIR /libCacheSim/_build/
-# RUN cmake -DSUPPORT_ZSTD_TRACE=on .. && make -j && sudo make install
+# RUN cmake -G Ninja -DSUPPORT_ZSTD_TRACE=on .. && ninja && sudo ninja install
 
 
 WORKDIR /libCacheSim/_build/bin/
@@ -40,9 +40,9 @@ WORKDIR /libCacheSim/_build/bin/
 # sudo docker run -v /local/data/path:/data -it 1a1a11a/libcachesim:latest bash
 
 # docker install instructions can be found at https://docs.docker.com/engine/install/
-# for ubuntu: 
-# 
-# sudo apt-get update && sudo apt-get install -yqq ca-certificates curl gnupg; 
+# for ubuntu:
+#
+# sudo apt-get update && sudo apt-get install -yqq ca-certificates curl gnupg;
 # sudo install -m 0755 -d /etc/apt/keyrings && \
 # curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /etc/apt/keyrings/docker.gpg && \
 # sudo chmod a+r /etc/apt/keyrings/docker.gpg
@@ -51,5 +51,3 @@ WORKDIR /libCacheSim/_build/bin/
 #   "$(. /etc/os-release && echo "$VERSION_CODENAME")" stable" | \
 #   sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
 # sudo apt update && sudo apt-get install -yqq docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
-
-
diff --git a/example/cacheCluster/README.md b/example/cacheCluster/README.md
@@ -5,6 +5,10 @@ This illustrate how to build a cache cluster using consistent hashing.
 Please install libCacheSim first.
 Then you can run the following in this directory
 ```bash
+# Prerequisites: Install Ninja build system if not already available
+# Ubuntu/Debian: sudo apt install ninja-build
+# macOS: brew install ninja
+
 mkdir _build;
 cd _build;
 cmake -G Ninja ..;
diff --git a/example/cacheHierarchy/README.md b/example/cacheHierarchy/README.md
@@ -9,6 +9,10 @@ It outputs the L2 miss ratio curve.
 
 ## Build
 ```bash
+# Prerequisites: Install Ninja build system if not already available
+# Ubuntu/Debian: sudo apt install ninja-build
+# macOS: brew install ninja
+
 mkdir _build/;
 cd _build/;
 cmake -G Ninja ../;
diff --git a/example/cacheSimulator/README.md b/example/cacheSimulator/README.md
@@ -19,6 +19,10 @@ See [main.c](main.c) for a complete example.
 
 ### Build
 ```bash
+# Prerequisites: Install Ninja build system if not already available
+# Ubuntu/Debian: sudo apt install ninja-build
+# macOS: brew install ninja
+
 mkdir _build;
 cd _build;
 cmake -G Ninja ..;
diff --git a/example/cacheSimulatorConcurrent/README.md b/example/cacheSimulatorConcurrent/README.md
@@ -10,6 +10,10 @@ This example also shows how to use a csv reader to read a csv trace.
 
 ### Build
 ```bash
+# Prerequisites: Install Ninja build system if not already available
+# Ubuntu/Debian: sudo apt install ninja-build
+# macOS: brew install ninja
+
 mkdir _build;
 cd _build;
 cmake -G Ninja ..;
diff --git a/example/plugin_v2/README.md b/example/plugin_v2/README.md
@@ -13,6 +13,10 @@ This example demonstrates how to create a plugin for libCacheSim using the v2 ho
 To compile the plugin into a shared library:
 
 ```bash
+# Prerequisites: Install Ninja build system if not already available
+# Ubuntu/Debian: sudo apt install ninja-build
+# macOS: brew install ninja
+
 mkdir build
 cd build
 cmake -G Ninja ..
diff --git a/libCacheSim-node/README.md b/libCacheSim-node/README.md
@@ -189,9 +189,9 @@ If you see binary loading errors:
 
 If source compilation fails:
 
-1. Install required system dependencies
+1. Install required system dependencies (including ninja-build)
 2. Ensure CMake 3.10+ is available
-3. Check that libCacheSim builds successfully: `cd .. && mkdir _build && cd _build && cmake .. && make`
+3. Check that libCacheSim builds successfully: `cd .. && mkdir _build && cd _build && cmake -G Ninja .. && ninja`
 
 ## Contributing
 
@@ -217,4 +217,4 @@ If you use libCacheSim in your research, please cite:
   year={2023},
   url={https://github.com/1a1a11a/libCacheSim}
 }
-``` 
+```
diff --git a/scripts/install_dependency.sh b/scripts/install_dependency.sh
@@ -158,7 +158,6 @@ install_cmake() {
 # Install XGBoost
 install_xgboost() {
 	log_info "Installing XGBoost..."
-	local cores=$(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || echo 2)
 	pushd /tmp/ >/dev/null
 	if [[ ! -d "xgboost" ]]; then
 		git clone --recursive https://github.com/dmlc/xgboost
@@ -167,7 +166,7 @@ install_xgboost() {
 	mkdir -p build
 	pushd build >/dev/null
 	cmake -G Ninja ..
-	ninja -j$((cores + 1))
+	ninja
 	sudo ninja install
 	popd >/dev/null
 	popd >/dev/null
@@ -177,7 +176,6 @@ install_xgboost() {
 # Install LightGBM
 install_lightgbm() {
 	log_info "Installing LightGBM..."
-	local cores=$(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || echo 2)
 	pushd /tmp/ >/dev/null
 	if [[ ! -d "LightGBM" ]]; then
 		git clone --recursive https://github.com/microsoft/LightGBM
@@ -186,7 +184,7 @@ install_lightgbm() {
 	mkdir -p build
 	pushd build >/dev/null
 	cmake -G Ninja ..
-	ninja -j$((cores + 1))
+	ninja
 	sudo ninja install
 	popd >/dev/null
 	popd >/dev/null
@@ -196,7 +194,6 @@ install_lightgbm() {
 # Install Zstd
 install_zstd() {
 	log_info "Installing Zstd..."
-	local cores=$(nproc 2>/dev/null || sysctl -n hw.ncpu 2>/dev/null || echo 2)
 	pushd /tmp/ >/dev/null
 	local zstd_version="1.5.0"
 	if [[ ! -f "zstd-${zstd_version}.tar.gz" ]]; then
@@ -207,7 +204,7 @@ install_zstd() {
 	mkdir -p _build
 	pushd _build >/dev/null
 	cmake -G Ninja ..
-	ninja -j$((cores + 1))
+	ninja
 	sudo ninja install
 	popd >/dev/null
 	popd >/dev/null
diff --git a/scripts/setup_hooks.sh b/scripts/setup_hooks.sh
@@ -278,7 +278,7 @@ fi
 # cd "$TEMP_BUILD_DIR"
 
 # COMPILE_LOG="$LOG_DIR/compile.log"
-# if make -j$MAX_JOBS > "$COMPILE_LOG" 2>&1; then
+# if ninja > "$COMPILE_LOG" 2>&1; then
 #     echo -e "${GREEN}Compilation successful!${NC}"
 # else
 #     echo -e "${RED}Compilation failed. Please fix the warnings before committing.${NC}"
