feat: v1.2.2 - Cross-platform Fixes and Windows Support (#4)

v1.2.2 - Cross-platform fixes, Windows support, bug fixes for replacement policy parsing and trace inline comments

Author: muditbhargava66

.gitignore

@@ -93,4 +93,21 @@ test_*.trace
 *_test_trace.txt
 perf_test_trace.txt
 
-TODO.md
+# Development files
+TODO.md
+
+# PDF files (avoid committing email attachments, etc.)
+*.pdf
+
+# Python artifacts (if using Python tools)
+__pycache__/
+*.py[cod]
+.env
+venv/
+
+# Additional IDE files
+.clangd/
+.cache/clangd/
+
+# CMake user presets
+CMakeUserPresets.json

CHANGELOG.md

@@ -5,6 +5,46 @@ All notable changes to the Cache Simulator project will be documented in this fi
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.2.2] - 2026-01-06
+
+### Added
+- **Windows Platform Documentation**: Comprehensive guide for building and running on Windows
+  - Build instructions for GCC, MSVC, and Clang
+  - Known issues and solutions
+  - Troubleshooting guide
+- **Windows PowerShell Scripts**: Cross-platform build and benchmark scripts
+  - `build.ps1`: Simple build script for Windows
+  - `scripts/build_all.ps1`: Comprehensive build with options (Debug, Clean, Tests)
+  - `scripts/run_benchmarks.ps1`: Benchmark runner for Windows
+
+### Fixed
+- **Cross-Platform Header Includes**: Added missing standard library headers for strict compiler compliance
+  - `cache.h`: Added `#include <array>` for `std::array` usage
+  - `logger.h`: Added `#include <array>` for `LogLevelNames`
+  - `trace_utils.h`: Added `#include <functional>` for `std::function`
+  - `interconnect.h`: Added `#include <cmath>`, `<cstdint>`, `<memory>`, `<optional>`
+- **Windows Test Compatibility**: Fixed file locking issues in test files
+  - `visualization_test.cpp`: Used RAII scope blocks to ensure `ifstream` is closed before `filesystem::remove()`
+  - `cache_performance_test.cpp`: Used RAII scope blocks to ensure `TraceParser` releases file handle before cleanup
+  - All 13 tests now pass on Windows
+- **JSON Replacement Policy Parsing**: Fixed bug where JSON config files only recognized LRU and NRU policies
+  - Added support for FIFO, Random, and PLRU replacement policies in the JSON parser
+  - Both L1 and L2 cache configurations now correctly parse all replacement policy options
+- **INI Replacement Policy Parsing**: Added missing replacement policy support to INI config parser
+  - Both `replacement_policy` and `replacementPolicy` keys are now recognized
+- **Profiler Region Naming**: Fixed confusing region names that implied L1/L2 cache mapping
+  - Renamed to "Low/High Address Region" with explanatory comments
+  - Added documentation that regions are for pattern analysis, not cache behavior
+- **Trace Parser Inline Comments**: Fixed parser to handle inline comments (e.g., `r 0x1000 # comment`)
+  - Previously, text after `#` on the same line was incorrectly parsed as a processor ID
+  - Now properly strips inline comments before parsing
+- **C++20 Standard**: Updated CMakeLists.txt to require C++20 for designated initializer support
+
+### Technical Details
+- Designated initializers (`.field = value`) in multiprocessor code require C++20
+- The fixes ensure compatibility across Windows (GCC/MSVC), macOS (Clang/GCC), and Linux (GCC/Clang)
+- No functional changes - only build and compatibility improvements
+
 ## [1.2.1] - 2025-09-02
 
 ### Fixed

CMakeLists.txt

@@ -1,8 +1,8 @@
 cmake_minimum_required(VERSION 3.14)
-project(CacheSimulator VERSION 1.2.1 LANGUAGES CXX)
+project(CacheSimulator VERSION 1.2.2 LANGUAGES CXX)
 
-# Set C++17 as the required standard
-set(CMAKE_CXX_STANDARD 17)
+# Set C++20 as the required standard (required for designated initializers)
+set(CMAKE_CXX_STANDARD 20)
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 

README.md

@@ -2,8 +2,8 @@
 
 # 🚀 Cache Simulator
 
-![Version](https://img.shields.io/badge/version-1.2.1-blue)
-![C++17](https://img.shields.io/badge/C%2B%2B-17-orange)
+![Version](https://img.shields.io/badge/version-1.2.2-blue)
+![C++20](https://img.shields.io/badge/C%2B%2B-20-orange)
 ![License](https://img.shields.io/badge/license-MIT-green)
 ![Build Status](https://img.shields.io/badge/build-passing-brightgreen)
 ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)
@@ -21,15 +21,21 @@
 
 </div>
 
-## ✨ What's New in v1.2.0
+## ✨ What's New in v1.2.2
+
+- **🪟 Windows Support**: Full cross-platform compatibility with PowerShell build scripts
+- **🐛 Bug Fixes**: Fixed replacement policy parsing for JSON/INI configs (FIFO, Random, PLRU now work)
+- **💬 Inline Comments**: Trace files now support comments at end of lines (`r 0x1000 # comment`)
+- **📄 Enhanced Docs**: Comprehensive Windows platform guide
+
+### Previous: v1.2.0 Highlights
 
 - **🔄 NRU Replacement Policy**: Efficient Not Recently Used implementation with reference bit tracking
 - **💾 Victim Cache**: Reduces conflict misses by up to 25% with configurable fully-associative cache
 - **📝 Advanced Write Policies**: No-write-allocate and write combining buffer support
 - **⚡ Parallel Processing**: Multi-threaded simulation with up to 4x speedup on 8-core systems
 - **🖥️ Multi-Processor Support**: Complete MESI coherence protocol with directory-based tracking
 - **📊 Statistical Visualization**: Built-in ASCII charts including line graphs, pie charts, and heatmaps
-- **🔧 Enhanced Tools**: Cache analyzer and performance comparison utilities
 
 ## 🎯 Key Features
 
@@ -63,12 +69,13 @@
 ## 🚀 Quick Start
 
 ### Prerequisites
-- C++17 compatible compiler (GCC 7+, Clang 5+, MSVC 19.14+)
+- C++20 compatible compiler (GCC 10+, Clang 10+, MSVC 2019+)
 - CMake 3.14+ or GNU Make
 - Optional: Python 3.6+ for visualization scripts
 
 ### Installation
 
+#### Linux / macOS (Bash)
 ```bash
 # Clone the repository
 git clone https://github.com/muditbhargava66/CacheSimulator.git
@@ -79,10 +86,30 @@ mkdir build && cd build
 cmake -DCMAKE_BUILD_TYPE=Release ..
 cmake --build . -j$(nproc)
 
-# Or build with Make
-make -j$(nproc)
+# Or use the build script
+./build.sh
+```
+
+#### Windows (PowerShell)
+```powershell
+# Clone the repository
+git clone https://github.com/muditbhargava66/CacheSimulator.git
+cd CacheSimulator
+
+# Use the PowerShell build script
+.\build.ps1
+
+# Or build manually
+mkdir build; cd build
+cmake -DCMAKE_BUILD_TYPE=Release ..
+cmake --build . --parallel
+
+# Run tests
+ctest --output-on-failure
 ```
 
+> **📖 See [docs/WINDOWS.md](docs/WINDOWS.md) for detailed Windows instructions.**
+
 ### Basic Usage
 
 ```bash
@@ -297,7 +324,7 @@ If you use this simulator in your research, please cite:
 @software{CacheSimulator2025,
   author = {Mudit Bhargava},
   title = {Cache Simulator: A C++17 Cache and Memory Hierarchy Simulator},
-  version = {1.2.1},
+  version = {1.2.2},
   year = {2025},
   url = {https://github.com/muditbhargava66/CacheSimulator}
 }
@@ -332,7 +359,7 @@ This simulator is ideal for:
 📫 **Contact**: [@muditbhargava66](https://github.com/muditbhargava66)
 🐛 **Report Issues**: [Issue Tracker](https://github.com/muditbhargava66/CacheSimulator/issues)
 
-© 2025 Mudit Bhargava. [MIT License](LICENSE)  
+© 2026 Mudit Bhargava. [MIT License](LICENSE)  
 <!-- Copyright symbol using HTML entity for better compatibility -->
 
 </div>

build.ps1

@@ -0,0 +1,54 @@
+# Build script for Cache Simulator on Windows
+# PowerShell equivalent of build.sh
+
+$ErrorActionPreference = "Stop"
+
+# Get number of CPU cores
+$NUM_CORES = [Environment]::ProcessorCount
+if ($NUM_CORES -eq 0) { $NUM_CORES = 4 }
+
+Write-Host "Building Cache Simulator v1.2.2" -ForegroundColor Cyan
+Write-Host "Detected $NUM_CORES CPU cores" -ForegroundColor Gray
+
+# Create build directory if it doesn't exist
+if (-not (Test-Path "build")) {
+    New-Item -ItemType Directory -Path "build" | Out-Null
+}
+
+Set-Location build
+
+# Configure with CMake
+Write-Host "`nConfiguring with CMake..." -ForegroundColor Yellow
+cmake -DCMAKE_BUILD_TYPE=Release ..
+
+if ($LASTEXITCODE -ne 0) {
+    Write-Host "CMake configuration failed!" -ForegroundColor Red
+    Set-Location ..
+    exit 1
+}
+
+# Build
+Write-Host "`nBuilding with $NUM_CORES parallel jobs..." -ForegroundColor Yellow
+cmake --build . --parallel $NUM_CORES
+
+if ($LASTEXITCODE -eq 0) {
+    Write-Host "`nBuild successful!" -ForegroundColor Green
+    Write-Host ""
+    Write-Host "To run tests:" -ForegroundColor Cyan
+    Write-Host "  ctest --output-on-failure"
+    Write-Host ""
+    Write-Host "To run the simulator:" -ForegroundColor Cyan
+    Write-Host "  .\bin\cachesim.exe <trace_file>"
+    Write-Host "  .\bin\cachesim.exe --config <config_file> <trace_file>"
+    Write-Host ""
+    Write-Host "Available tools:" -ForegroundColor Cyan
+    Write-Host "  .\bin\tools\cache_analyzer.exe"
+    Write-Host "  .\bin\tools\trace_generator.exe"
+}
+else {
+    Write-Host "Build failed!" -ForegroundColor Red
+    Set-Location ..
+    exit 1
+}
+
+Set-Location ..

build.sh

@@ -11,7 +11,7 @@ else
     NUM_CORES=$(nproc 2>/dev/null || echo 4)
 fi
 
-echo "Building Cache Simulator v1.1.0"
+echo "Building Cache Simulator v1.2.2"
 echo "Detected $NUM_CORES CPU cores"
 
 # Create build directory if it doesn't exist