Skip to content

Commit f5b2047

Browse files
Merge pull request #7 from muditbhargava66/release/v1.4.1
v1.4.1: Apache License, Config Parsing Fixes, Side-Channel Research Documentation
2 parents b190305 + 1c32436 commit f5b2047

34 files changed

Lines changed: 1148 additions & 314 deletions

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,4 +110,4 @@ venv/
110110
.cache/clangd/
111111

112112
# CMake user presets
113-
CMakeUserPresets.json
113+
CMakeUserPresets.json

CHANGELOG.md

Lines changed: 54 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,57 @@ All notable changes to the Cache Simulator project will be documented in this fi
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
## [1.4.1] - 2026-01-09
9+
10+
### Fixed
11+
- **Config Parsing snake_case Support**
12+
- Added `normalizeConfigKey()` function to handle snake_case keys
13+
- Config files with `block_size`, `write_policy` now parse correctly
14+
- Maintains backward compatibility with camelCase keys
15+
16+
- **Config Version Metadata**
17+
- Updated all 8 example config files from `"version": "1.2.0"` to `"version": "1.4.0"`
18+
- Affected: full_features.json, high_performance.json, multiprocessor_4core.json,
19+
multiprocessor_system.json, nru_optimized.json, victim_cache_config.json,
20+
write_intensive.json, write_optimized.json
21+
22+
### Added
23+
- **JSON Schema Validation**
24+
- `recognizedKeys` set for validating config key names
25+
- `logUnrecognizedKey()` function warns on unknown keys with section context
26+
- `findSimilarKey()` suggests correct key names for typos
27+
28+
- **Config Integration Tests**
29+
- New `tests/integration/config_parsing_test.cpp`
30+
- Tests all JSON config files parse successfully
31+
- Verifies snake_case normalization works correctly
32+
33+
- **User-Defined Profiler Regions**
34+
- `ProfilerRegionConfig` struct in `MemoryHierarchyConfig`
35+
- Fields: `startAddress`, `endAddress`, `name`
36+
- `profilerRegions` vector for custom address ranges
37+
38+
### Changed
39+
- **License**: Changed from MIT to Apache License 2.0
40+
- Enhanced error messages now suggest correct key format
41+
- Added `<cstdint>` include to `memory_hierarchy.h` for `uint32_t`
42+
- Removed version numbers from config file name/description fields
43+
44+
### Documentation
45+
- **CITATION.cff**: Added for proper GitHub citation support (APA/BibTeX)
46+
- **Side-Channel Research Guide**: New `docs/features/side-channel-research.md`
47+
- Flush+Reload attack simulation
48+
- Prime+Probe attack modeling
49+
- Spectre-like pattern analysis
50+
- Security research configurations
51+
52+
### Technical Details
53+
- Config key normalization: `block_size``blockSize`
54+
- All 19 tests pass (including new config integration test)
55+
- All 5 example configs tested with real trace files
56+
57+
---
58+
859
## [1.4.0] - 2026-01-08
960

1061
### Added
@@ -219,11 +270,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
219270
- Support for atomic operations and memory barriers
220271
- Comprehensive multi-processor statistics
221272
- **Victim Cache Tests**: Complete unit test suite for victim cache functionality
222-
- **Enhanced Documentation**:
273+
- **Enhanced Documentation**:
223274
- Comprehensive victim cache documentation
224275
- Complete tutorial covering all features
225276
- Usage examples and best practices
226-
- **Comprehensive Utility Scripts**:
277+
- **Comprehensive Utility Scripts**:
227278
- Advanced build script with multiple configuration options
228279
- Comprehensive benchmark runner with parallel execution
229280
- Simulation runner with colorized output and CSV export
@@ -380,4 +431,4 @@ This release marks the first stable version of the Cache Simulator, featuring a
380431
- Visualization tools and GUI
381432
- Power and area modeling
382433

383-
[1.0.0]: https://github.com/muditbhargava66/cache-simulator/releases/tag/v1.0.0
434+
[1.0.0]: https://github.com/muditbhargava66/cache-simulator/releases/tag/v1.0.0

CITATION.cff

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
type: software
4+
title: "Cache Simulator"
5+
abstract: "A high-performance, educational cache simulator for analyzing memory hierarchy behavior with support for multi-level caches, coherence protocols, and advanced prefetching strategies."
6+
authors:
7+
- family-names: "Bhargava"
8+
given-names: "Mudit"
9+
orcid: "https://orcid.org/0000-0003-4503-2260"
10+
repository-code: "https://github.com/muditbhargava66/CacheSimulator"
11+
url: "https://github.com/muditbhargava66/CacheSimulator"
12+
license: Apache-2.0
13+
keywords:
14+
- cache-simulator
15+
- memory-hierarchy
16+
- computer-architecture
17+
- cpu-cache
18+
- cache-coherence
19+
- prefetching
20+
- cpp20
21+
- educational

CMakeLists.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
cmake_minimum_required(VERSION 3.14)
2-
project(CacheSimulator VERSION 1.4.0 LANGUAGES CXX)
2+
project(CacheSimulator VERSION 1.4.1 LANGUAGES CXX)
33

44
# Set C++20 as the required standard (required for designated initializers)
55
set(CMAKE_CXX_STANDARD 20)
@@ -22,15 +22,15 @@ set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
2222
# Common compiler flags
2323
if(CMAKE_CXX_COMPILER_ID MATCHES "GNU|Clang")
2424
add_compile_options(-Wall -Wextra -Wpedantic -Werror=return-type)
25-
25+
2626
# Add debug flags
2727
set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -g3 -O0")
28-
28+
2929
# Add release flags
3030
set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_CXX_FLAGS_RELEASE} -O3")
3131
elseif(MSVC)
3232
add_compile_options(/W4 /permissive- /Zc:__cplusplus)
33-
33+
3434
# Enable exceptions
3535
add_compile_options(/EHsc)
3636
endif()
@@ -190,16 +190,16 @@ if(DOXYGEN_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/docs/Doxyfile.in")
190190
set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/docs)
191191
set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/html/index.html)
192192
set(DOXYGEN_CONFIG_FILE ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
193-
193+
194194
configure_file(${PROJECT_SOURCE_DIR}/docs/Doxyfile.in ${DOXYGEN_CONFIG_FILE} @ONLY)
195-
195+
196196
add_custom_command(OUTPUT ${DOXYGEN_INDEX_FILE}
197197
COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYGEN_CONFIG_FILE}
198198
MAIN_DEPENDENCY ${DOXYGEN_CONFIG_FILE} ${ALL_HEADERS}
199199
COMMENT "Generating API documentation with Doxygen"
200200
VERBATIM
201201
)
202-
202+
203203
add_custom_target(doc DEPENDS ${DOXYGEN_INDEX_FILE})
204204
endif()
205205

@@ -222,4 +222,4 @@ message(STATUS " Build type: ${CMAKE_BUILD_TYPE}")
222222
message(STATUS " C++ Compiler: ${CMAKE_CXX_COMPILER}")
223223
message(STATUS " C++ Standard: C++${CMAKE_CXX_STANDARD}")
224224
message(STATUS " Installation path: ${CMAKE_INSTALL_PREFIX}")
225-
message(STATUS "")
225+
message(STATUS "")

LICENSE

Lines changed: 190 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,190 @@
1-
MIT License
2-
3-
Copyright (c) 2026 Mudit Bhargava
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to the Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2026 Mudit Bhargava
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

0 commit comments

Comments
 (0)