From c893fe1663b97ba4e8590bebd6adc2cc45f96b6f Mon Sep 17 00:00:00 2001 From: Derek Christ Date: Fri, 5 Jul 2024 15:03:43 +0200 Subject: [PATCH] Update README to feature the full version of Trace Analyzer --- CMakeLists.txt | 5 +---- CMakePresets.json | 1 - README.md | 15 ++++++++++++--- 3 files changed, 13 insertions(+), 8 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 3c701082..3887b382 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -97,7 +97,6 @@ option(DRAMSYS_BUILD_BENCHMARKS "Build DRAMSys benchmarks" OFF) option(DRAMSYS_BUILD_CLI "Build DRAMSys Command Line Tool" ON) option(DRAMSYS_BUILD_TRACE_ANALYZER "Build DRAMSys Trace Analyzer" OFF) option(DRAMSYS_WITH_DRAMPOWER "Build with DRAMPower support enabled." OFF) -option(DRAMSYS_ENABLE_EXTENSIONS "Enable proprietary DRAMSys extensions." OFF) option(DRAMSYS_USE_EXTERNAL_SYSTEMC "Use an external SystemC installation." OFF) ############################################### @@ -189,9 +188,7 @@ if(DRAMSYS_BUILD_TRACE_ANALYZER) add_subdirectory(src/traceAnalyzer) endif() -if(DRAMSYS_ENABLE_EXTENSIONS) - dramsys_enable_extensions() -endif() +dramsys_enable_extensions() ############################################### ### Test Directory ### diff --git a/CMakePresets.json b/CMakePresets.json index 565ab0b9..cc271d79 100644 --- a/CMakePresets.json +++ b/CMakePresets.json @@ -22,7 +22,6 @@ "inherits": "cmake-pedantic", "cacheVariables": { "DRAMSYS_BUILD_TESTS": "ON", - "DRAMSYS_ENABLE_EXTENSIONS": "ON", "DRAMSYS_WITH_DRAMPOWER": "ON" } }, diff --git a/README.md b/README.md index 50680e7d..a05be4fc 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ If you decide to use DRAMSys in your research please cite the paper [2] or [3]. ## Included Features - **Standalone** simulator with trace players and traffic generators or **TLM-2.0-compliant library** +- **Trace Analyzer** for visual and metric-based result analysis - Coupling to **gem5** supported - Cycle-accurate **DDR3/4**, **LPDDR4**, **Wide I/O 1/2**, **GDDR5/5X/6** and **HBM1/2** modelling - Bit-granular address mapping with optional XOR connections [7] @@ -31,7 +32,7 @@ If you decide to use DRAMSys in your research please cite the paper [2] or [3]. ## Additional Features - Cycle-accurate **DDR5**, **LPDDR5** and **HBM3** modelling -- **Trace Analyzer** for visual and metric-based result analysis +- Extended analysis features for the **Trace Analyzer** - **Free academic** or **commercial** licenses available (please contact [Matthias Jung](mailto:matthias.jung@iese.fraunhofer.de) for more information) ## Video @@ -48,7 +49,15 @@ All requests, responses and DRAM commands can be recorded in an SQLite trace dat The Trace Analyzer's main window is shown below. -If you are interested in the Trace Analyzer, if you need support with the setup of DRAMSys in a virtual platform of your company, or if you require custom modifications of the simulator please contact [Matthias Jung](mailto:matthias.jung@iese.fraunhofer.de). +A basic version of Trace Analyzer is included in the open source release of DRAMSys. +However, the full version of the Trace Analyzer includes many additional analysis features: +- Detailed transaction-level latency analysis +- Power, bandwidth, and buffer utilization analysis over simulation time intervals +- Timing dependency analysis at the DRAM command level +- Calculation of numerous predefined and user-defined metrics +- VCD export of generated trace + +If you are interested in the full version of Trace Analyzer, if you need support with the setup of DRAMSys in a virtual platform of your company, or if you require custom modifications of the simulator please contact [Matthias Jung](mailto:matthias.jung@iese.fraunhofer.de). ![Trace Analyzer Main Window](docs/images/traceanalyzer.png) @@ -58,7 +67,7 @@ To use DRAMSys, first clone the repository. ### Dependencies -DRAMSys requires a **C++17** compiler. The build process is based on **CMake** (minimum version **3.24**). Furthermore, the simulator is based on **SystemC**. SystemC is included with FetchContent and will be build automatically with the project. If you want to use a preinstalled SystemC version, export the environment variable `SYSTEMC_HOME` (SystemC installation directory) and set the CMake option `DRAMSYS_USE_EXTERNAL_SYSTEMC`. Also make sure that the SystemC library was built with the same C++ version. +DRAMSys requires a **C++17** compiler. The build process is based on **CMake** (minimum version **3.24**). Furthermore, the simulator is based on **SystemC**. SystemC is included with FetchContent and will be build automatically with the project. If you want to use a preinstalled SystemC version, export the environment variable `SYSTEMC_HOME` (SystemC installation directory) and enable the `DRAMSYS_USE_EXTERNAL_SYSTEMC` CMake option. Also make sure that the SystemC library was built with the same C++ version. ### Building DRAMSys