Reorganized Core Directory (#239)

Added several subdirectories to the `core` directory to created new libraries for each "unit" to make the repo easier to navigate.
riscv-software-src · Dec 17, 2024 · 0a1d7b4 · 0a1d7b4
1 parent e370d4f
commit 0a1d7b4
Show file tree

Hide file tree

Showing 62 changed files with 127 additions and 122 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -66,11 +66,8 @@ include_directories (SYSTEM fsl)
 include_directories (SYSTEM mavis)
 include_directories (SYSTEM stf_lib)
 
-# Mavis, the Core, MSS, the simulator and Fusion
-
+# Mavis
 add_subdirectory (mavis)
-add_subdirectory (core)
-add_subdirectory (mss)
 
 # Tell FSL to use the top mavis submodule, instead of fsl's submodule
 set(FSL_MAVIS_PATH "${CMAKE_CURRENT_SOURCE_DIR}/mavis")
@@ -79,6 +76,10 @@ add_subdirectory (fsl)
 # Add STF library to the build
 add_subdirectory (${STF_LIB_BASE})
 
+# The Core and MSS
+add_subdirectory (core)
+add_subdirectory (mss)
+
 # Add testing, but do not build as part of the 'all' target
 add_subdirectory (test EXCLUDE_FROM_ALL)
 
@@ -87,7 +88,7 @@ add_executable(olympia
   sim/OlympiaSim.cpp
   sim/main.cpp
   )
-target_link_libraries (olympia core mss SPARTA::sparta mavis ${STF_LINK_LIBS})
+target_link_libraries (olympia core mss SPARTA::sparta ${STF_LINK_LIBS})
 if (CMAKE_BUILD_TYPE MATCHES "^[Rr]elease")
   target_compile_options (core    PUBLIC -flto)
   target_compile_options (mss     PUBLIC -flto)

diff --git a/core/CMakeLists.txt b/core/CMakeLists.txt
@@ -1,31 +1,32 @@
 project (core)
 add_library(core
-  FusionDecode.cpp
   Core.cpp
-  SimpleBranchPred.cpp
-  ICache.cpp
-  Fetch.cpp
-  Decode.cpp
-  VectorUopGenerator.cpp
-  Rename.cpp
-  Dispatch.cpp
-  Dispatcher.cpp
-  Execute.cpp
-  ExecutePipe.cpp
-  Inst.cpp
-  InstArchInfo.cpp
-  InstGroup.cpp
-  InstGenerator.cpp
-  IssueQueue.cpp
   ROB.cpp
-  LSU.cpp
   MMU.cpp
-  DCache.cpp
-  MavisUnit.cpp
   Preloader.cpp
   CPU.cpp
   CPUFactory.cpp
   CPUTopology.cpp
 )
+
+add_library(instgen
+  Inst.cpp
+  InstArchInfo.cpp
+  InstGroup.cpp
+  InstGenerator.cpp
+)
+
+target_link_libraries(instgen stf zstd mavis)
+
 get_property(SPARTA_INCLUDE_PROP TARGET SPARTA::sparta PROPERTY INTERFACE_INCLUDE_DIRECTORIES)
 target_include_directories(core SYSTEM PRIVATE ${SPARTA_INCLUDE_PROP})
+
+add_subdirectory(fetch)
+add_subdirectory(decode)
+add_subdirectory(rename)
+add_subdirectory(dispatch)
+add_subdirectory(execute)
+add_subdirectory(vector)
+add_subdirectory(lsu)
+
+target_link_libraries(core fetch decode rename dispatch execute vector lsu instgen)
diff --git a/core/CPUFactories.hpp b/core/CPUFactories.hpp
@@ -5,14 +5,14 @@
 
 #include "sparta/simulation/ResourceFactory.hpp"
 #include "Core.hpp"
-#include "ICache.hpp"
-#include "Fetch.hpp"
-#include "Decode.hpp"
-#include "VectorUopGenerator.hpp"
-#include "Rename.hpp"
-#include "Dispatch.hpp"
-#include "Execute.hpp"
-#include "LSU.hpp"
+#include "fetch/ICache.hpp"
+#include "fetch/Fetch.hpp"
+#include "decode/Decode.hpp"
+#include "vector/VectorUopGenerator.hpp"
+#include "rename/Rename.hpp"
+#include "dispatch/Dispatch.hpp"
+#include "execute/Execute.hpp"
+#include "lsu/LSU.hpp"
 #include "MMU.hpp"
 #include "SimpleTLB.hpp"
 #include "BIU.hpp"
@@ -21,8 +21,8 @@
 #include "ROB.hpp"
 #include "FlushManager.hpp"
 #include "Preloader.hpp"
-#include "MavisUnit.hpp"
-#include "IssueQueue.hpp"
+#include "decode/MavisUnit.hpp"
+#include "execute/IssueQueue.hpp"
 
 namespace olympia{
 

diff --git a/core/Inst.hpp b/core/Inst.hpp
@@ -15,7 +15,7 @@
 
 #include "InstArchInfo.hpp"
 #include "CoreTypes.hpp"
-#include "VectorConfig.hpp"
+#include "vector/VectorConfig.hpp"
 #include "MiscUtils.hpp"
 
 #include <cstdint>

diff --git a/core/InstGenerator.hpp b/core/InstGenerator.hpp
@@ -11,7 +11,7 @@
 #include <memory>
 
 #include "Inst.hpp"
-#include "MavisUnit.hpp"
+#include "decode/MavisUnit.hpp"
 #include "sparta/utils/SpartaAssert.hpp"
 
 #include "stf-inc/stf_inst_reader.hpp"

diff --git a/core/MMU.hpp b/core/MMU.hpp
@@ -79,4 +79,4 @@ namespace olympia {
                 "Number of TLB misses", sparta::Counter::COUNT_NORMAL
         };
     };
-}
+}
diff --git a/core/decode/CMakeLists.txt b/core/decode/CMakeLists.txt
@@ -0,0 +1,6 @@
+add_library(decode
+  FusionDecode.cpp
+  Decode.cpp
+  MavisUnit.cpp
+)
+target_link_libraries(decode instgen)
diff --git a/core/Decode.cpp → core/decode/Decode.cpp b/core/Decode.cpp → core/decode/Decode.cpp
@@ -1,7 +1,7 @@
 // <Decode.cpp> -*- C++ -*-
 
-#include "Decode.hpp"
-#include "VectorUopGenerator.hpp"
+#include "decode/Decode.hpp"
+#include "vector/VectorUopGenerator.hpp"
 #include "fsl_api/FusionTypes.h"
 
 #include "sparta/events/StartupEvent.hpp"

diff --git a/core/Decode.hpp → core/decode/Decode.hpp b/core/Decode.hpp → core/decode/Decode.hpp
@@ -5,7 +5,7 @@
 #include "CoreTypes.hpp"
 #include "FlushManager.hpp"
 #include "InstGroup.hpp"
-#include "MavisUnit.hpp"
+#include "decode/MavisUnit.hpp"
 
 #include "fsl_api/FieldExtractor.h"
 #include "fsl_api/Fusion.h"

diff --git a/core/FusionDecode.cpp → core/decode/FusionDecode.cpp b/core/FusionDecode.cpp → core/decode/FusionDecode.cpp
diff --git a/core/MavisUnit.cpp → core/decode/MavisUnit.cpp b/core/MavisUnit.cpp → core/decode/MavisUnit.cpp
diff --git a/core/MavisUnit.hpp → core/decode/MavisUnit.hpp b/core/MavisUnit.hpp → core/decode/MavisUnit.hpp
diff --git a/core/dispatch/CMakeLists.txt b/core/dispatch/CMakeLists.txt
@@ -0,0 +1,5 @@
+add_library(dispatch
+  Dispatch.cpp
+  Dispatcher.cpp
+)
+target_link_libraries(dispatch instgen)
diff --git a/core/Dispatch.cpp → core/dispatch/Dispatch.cpp b/core/Dispatch.cpp → core/dispatch/Dispatch.cpp
@@ -2,7 +2,7 @@
 
 #include <algorithm>
 #include "CoreUtils.hpp"
-#include "Dispatch.hpp"
+#include "dispatch/Dispatch.hpp"
 #include "sparta/events/StartupEvent.hpp"
 
 namespace olympia

diff --git a/core/Dispatch.hpp → core/dispatch/Dispatch.hpp b/core/Dispatch.hpp → core/dispatch/Dispatch.hpp
@@ -17,7 +17,7 @@
 #include "sparta/statistics/WeightedContextCounter.hpp"
 #include "sparta/simulation/ResourceFactory.hpp"
 
-#include "Dispatcher.hpp"
+#include "dispatch/Dispatcher.hpp"
 #include "CoreTypes.hpp"
 #include "InstGroup.hpp"
 #include "FlushManager.hpp"

diff --git a/core/Dispatcher.cpp → core/dispatch/Dispatcher.cpp b/core/Dispatcher.cpp → core/dispatch/Dispatcher.cpp
@@ -1,6 +1,6 @@
 
-#include "Dispatcher.hpp"
-#include "Dispatch.hpp"
+#include "dispatch/Dispatcher.hpp"
+#include "dispatch/Dispatch.hpp"
 
 namespace olympia
 {

diff --git a/core/Dispatcher.hpp → core/dispatch/Dispatcher.hpp b/core/Dispatcher.hpp → core/dispatch/Dispatcher.hpp
diff --git a/core/execute/CMakeLists.txt b/core/execute/CMakeLists.txt
@@ -0,0 +1,5 @@
+add_library(execute
+  Execute.cpp
+  ExecutePipe.cpp
+  IssueQueue.cpp
+)
diff --git a/core/Execute.cpp → core/execute/Execute.cpp b/core/Execute.cpp → core/execute/Execute.cpp
@@ -1,7 +1,7 @@
 // <Execute.cpp> -*- C++ -*-
-#include "Execute.hpp"
+#include "execute/Execute.hpp"
 #include "CoreUtils.hpp"
-#include "IssueQueue.hpp"
+#include "execute/IssueQueue.hpp"
 #include "sparta/utils/SpartaAssert.hpp"
 
 namespace olympia

diff --git a/core/Execute.hpp → core/execute/Execute.hpp b/core/Execute.hpp → core/execute/Execute.hpp
@@ -6,8 +6,8 @@
 #include "sparta/simulation/ResourceFactory.hpp"
 
 #include "Inst.hpp"
-#include "ExecutePipe.hpp"
-#include "IssueQueue.hpp"
+#include "execute/ExecutePipe.hpp"
+#include "execute/IssueQueue.hpp"
 
 namespace olympia
 {

diff --git a/core/ExecutePipe.cpp → core/execute/ExecutePipe.cpp b/core/ExecutePipe.cpp → core/execute/ExecutePipe.cpp
@@ -1,6 +1,6 @@
 // <ExecutePipePipe.cpp> -*- C++ -*-
 
-#include "ExecutePipe.hpp"
+#include "execute/ExecutePipe.hpp"
 #include "CoreUtils.hpp"
 #include "sparta/utils/LogUtils.hpp"
 #include "sparta/utils/SpartaAssert.hpp"

diff --git a/core/ExecutePipe.hpp → core/execute/ExecutePipe.hpp b/core/ExecutePipe.hpp → core/execute/ExecutePipe.hpp
diff --git a/core/IssueQueue.cpp → core/execute/IssueQueue.cpp b/core/IssueQueue.cpp → core/execute/IssueQueue.cpp
@@ -1,6 +1,6 @@
 // <IssueQueue.cpp> -*- C++ -*-
 
-#include "IssueQueue.hpp"
+#include "execute/IssueQueue.hpp"
 #include "CoreUtils.hpp"
 
 namespace olympia

diff --git a/core/IssueQueue.hpp → core/execute/IssueQueue.hpp b/core/IssueQueue.hpp → core/execute/IssueQueue.hpp
@@ -19,7 +19,7 @@
 #include "sparta/resources/PriorityQueue.hpp"
 
 #include "CoreTypes.hpp"
-#include "ExecutePipe.hpp"
+#include "execute/ExecutePipe.hpp"
 #include "FlushManager.hpp"
 #include "Inst.hpp"
 

diff --git a/core/BranchPredIF.hpp → core/fetch/BranchPredIF.hpp b/core/BranchPredIF.hpp → core/fetch/BranchPredIF.hpp
diff --git a/core/fetch/CMakeLists.txt b/core/fetch/CMakeLists.txt
@@ -0,0 +1,6 @@
+add_library(fetch
+  Fetch.cpp
+  ICache.cpp
+  SimpleBranchPred.cpp
+)
+target_link_libraries(fetch instgen)
diff --git a/core/Fetch.cpp → core/fetch/Fetch.cpp b/core/Fetch.cpp → core/fetch/Fetch.cpp
@@ -6,9 +6,9 @@
 //!
 
 #include <algorithm>
-#include "Fetch.hpp"
+#include "fetch/Fetch.hpp"
 #include "InstGenerator.hpp"
-#include "MavisUnit.hpp"
+#include "decode/MavisUnit.hpp"
 #include "OlympiaAllocators.hpp"
 
 #include "sparta/utils/MathUtils.hpp"

diff --git a/core/Fetch.hpp → core/fetch/Fetch.hpp b/core/Fetch.hpp → core/fetch/Fetch.hpp
diff --git a/core/ICache.cpp → core/fetch/ICache.cpp b/core/ICache.cpp → core/fetch/ICache.cpp
diff --git a/core/ICache.hpp → core/fetch/ICache.hpp b/core/ICache.hpp → core/fetch/ICache.hpp
diff --git a/core/SimpleBranchPred.cpp → core/fetch/SimpleBranchPred.cpp b/core/SimpleBranchPred.cpp → core/fetch/SimpleBranchPred.cpp
diff --git a/core/SimpleBranchPred.hpp → core/fetch/SimpleBranchPred.hpp b/core/SimpleBranchPred.hpp → core/fetch/SimpleBranchPred.hpp
diff --git a/core/lsu/CMakeLists.txt b/core/lsu/CMakeLists.txt
@@ -0,0 +1,4 @@
+add_library(lsu
+  DCache.cpp
+  LSU.cpp
+)
diff --git a/core/DCache.cpp → core/lsu/DCache.cpp b/core/DCache.cpp → core/lsu/DCache.cpp
diff --git a/core/DCache.hpp → core/lsu/DCache.hpp b/core/DCache.hpp → core/lsu/DCache.hpp
diff --git a/core/LSU.cpp → core/lsu/LSU.cpp b/core/LSU.cpp → core/lsu/LSU.cpp
diff --git a/core/LSU.hpp → core/lsu/LSU.hpp b/core/LSU.hpp → core/lsu/LSU.hpp
diff --git a/core/rename/CMakeLists.txt b/core/rename/CMakeLists.txt
@@ -0,0 +1,4 @@
+add_library(rename
+    Rename.cpp
+)
+target_link_libraries(rename instgen)
diff --git a/core/Rename.cpp → core/rename/Rename.cpp b/core/Rename.cpp → core/rename/Rename.cpp
@@ -7,7 +7,7 @@
 
 #include <algorithm>
 #include "CoreUtils.hpp"
-#include "Rename.hpp"
+#include "rename/Rename.hpp"
 #include "sparta/events/StartupEvent.hpp"
 #include "sparta/app/FeatureConfiguration.hpp"
 #include "sparta/report/DatabaseInterface.hpp"

diff --git a/core/Rename.hpp → core/rename/Rename.hpp b/core/Rename.hpp → core/rename/Rename.hpp
diff --git a/core/vector/CMakeLists.txt b/core/vector/CMakeLists.txt
@@ -0,0 +1,3 @@
+add_library(vector
+  VectorUopGenerator.cpp
+)
diff --git a/core/VectorConfig.hpp → core/vector/VectorConfig.hpp b/core/VectorConfig.hpp → core/vector/VectorConfig.hpp
diff --git a/core/VectorUopGenerator.cpp → core/vector/VectorUopGenerator.cpp b/core/VectorUopGenerator.cpp → core/vector/VectorUopGenerator.cpp
@@ -1,4 +1,4 @@
-#include "VectorUopGenerator.hpp"
+#include "vector/VectorUopGenerator.hpp"
 #include "Inst.hpp"
 #include "InstArchInfo.hpp"
 #include "mavis/Mavis.h"

diff --git a/core/VectorUopGenerator.hpp → core/vector/VectorUopGenerator.hpp b/core/VectorUopGenerator.hpp → core/vector/VectorUopGenerator.hpp
@@ -8,7 +8,7 @@
 
 #include "Inst.hpp"
 #include "FlushManager.hpp"
-#include "MavisUnit.hpp"
+#include "decode/MavisUnit.hpp"
 
 #include <optional>
 

diff --git a/mavis b/mavis
diff --git a/mss/L2Cache.hpp b/mss/L2Cache.hpp
@@ -26,7 +26,7 @@
 #include "MemoryAccessInfo.hpp"
 
 #include "CacheFuncModel.hpp"
-#include "LSU.hpp"
+#include "lsu/LSU.hpp"
 
 namespace olympia_mss
 {

diff --git a/test/core/branch_pred/BranchPred_test.cpp b/test/core/branch_pred/BranchPred_test.cpp
@@ -1,4 +1,4 @@
-#include "SimpleBranchPred.hpp"
+#include "fetch/SimpleBranchPred.hpp"
 #include "sparta/utils/SpartaTester.hpp"
 
 TEST_INIT

diff --git a/test/core/common/SourceUnit.hpp b/test/core/common/SourceUnit.hpp
@@ -2,7 +2,7 @@
 #pragma once
 
 #include "core/InstGenerator.hpp"
-#include "core/MavisUnit.hpp"
+#include "core/decode/MavisUnit.hpp"
 #include "core/InstGroup.hpp"
 
 #include "mavis/ExtractorDirectInfo.h"

diff --git a/test/core/dcache/Dcache_test.cpp b/test/core/dcache/Dcache_test.cpp
@@ -1,5 +1,5 @@
 
-#include "DCache.hpp"
+#include "core/lsu/DCache.hpp"
 #include <sparta/app/SimulationConfiguration.hpp>
 #include <sparta/app/CommandLineSimulator.hpp>
 #include "sparta/utils/SpartaTester.hpp"

diff --git a/test/core/dcache/NextLvlSourceSinkUnit.hpp b/test/core/dcache/NextLvlSourceSinkUnit.hpp
@@ -5,7 +5,7 @@
 #include "sparta/simulation/TreeNode.hpp"
 #include "sparta/utils/LogUtils.hpp"
 #include "core/MemoryAccessInfo.hpp"
-#include "core/MavisUnit.hpp"
+#include "core/decode/MavisUnit.hpp"
 
 namespace dcache_test
 {
@@ -50,4 +50,4 @@ namespace dcache_test
         std::string purpose_;
         sparta::Clock::Cycle sink_latency_;
     };
-} // namespace dcache_test
+} // namespace dcache_test
diff --git a/test/core/dispatch/Dispatch_test.cpp b/test/core/dispatch/Dispatch_test.cpp
@@ -1,35 +1,5 @@
 
-#include "CPUFactory.hpp"
-#include "CoreUtils.hpp"
-#include "Dispatch.hpp"
-#include "MavisUnit.hpp"
-#include "OlympiaAllocators.hpp"
-#include "OlympiaSim.hpp"
-#include "Rename.hpp"
-
-#include "test/core/common/SinkUnit.hpp"
-#include "test/core/common/SourceUnit.hpp"
-#include "test/core/dispatch/Dispatch_test.hpp"
-#include "test/core/dispatch/ExecutePipeSinkUnit.hpp"
-#include "test/core/rename/ROBSinkUnit.hpp"
-
-#include "sparta/app/CommandLineSimulator.hpp"
-#include "sparta/app/Simulation.hpp"
-#include "sparta/events/UniqueEvent.hpp"
-#include "sparta/kernel/Scheduler.hpp"
-#include "sparta/report/Report.hpp"
-#include "sparta/resources/Buffer.hpp"
-#include "sparta/simulation/ClockManager.hpp"
-#include "sparta/sparta.hpp"
-#include "sparta/statistics/StatisticSet.hpp"
-#include "sparta/utils/SpartaSharedPointer.hpp"
-#include "sparta/utils/SpartaTester.hpp"
-
-#include <cinttypes>
-#include <initializer_list>
-#include <memory>
-#include <sstream>
-#include <vector>
+#include "Dispatch_test.hpp"
 
 TEST_INIT
-Original file line number
+Diff line change
@@ Expand Up / @@ -79,4 +79,4 @@ namespace olympia { @@
                     "Number of TLB misses", sparta::Counter::COUNT_NORMAL
             };
         };
-    }
+    }
+1 −1		.github/CODEOWNERS
+2 −13		CMakeLists.txt
+22 −13		README.md
+ −		doc/MavisDTableTraversalExample.png
+7 −0		impl/ExtractorRegistry.cpp
+553 −159		impl/forms/ExtractorDerived.h
+77 −77		impl/forms/ExtractorForms.h
+1 −1		json.hpp
+1 −1		json/isa_rv32c.json
+1 −0		json/isa_rv32zawrs.json
+38 −0		json/isa_rv32zclsd.json
+1 −0		json/isa_rv32zihintpause.json
+22 −0		json/isa_rv32zilsd.json
+18 −0		json/isa_rv64zawrs.json
+14 −0		json/isa_rv64zihintpause.json
+10 −2		mavis/Extractor.h
+70 −0		mavis/FormStub.h
+18 −2		mavis/InstMetaData.h
+11 −38		test/CMakeLists.txt
+29 −0		test/basic/CMakeLists.txt
+12 −1		test/basic/Inst.h
+2,232 −4,610		test/basic/golden.out
+0 −0		test/basic/isa_pseudo.json
+0 −0		test/basic/isa_tagged.json
+170 −72		test/basic/main.cpp
+0 −0		test/basic/rv64.tset
+0 −0		test/basic/rv64_base.json
+0 −0		test/basic/rv64_bf16.tset
+0 −0		test/basic/rv64_bits.tset
+0 −0		test/basic/rv64h.tset
+1 −1		test/basic/uArchInfo.h
+0 −0		test/basic/uArchInfoExceptions.hpp
+0 −0		test/basic/uarch_core.json
+0 −0		test/basic/uarch_pseudo.json
+0 −0		test/basic/uarch_rv32g.json
+0 −0		test/basic/uarch_rv64g.json
+29 −0		test/directed/CMakeLists.txt
+233 −0		test/directed/main.cpp