From f037c0948b95c45279f6547456c3552a3fb55b90 Mon Sep 17 00:00:00 2001 From: Lukas Steiner Date: Fri, 3 Jul 2020 14:48:18 +0200 Subject: [PATCH] Adds disclaimer to readme. --- README.md | 29 ++++++++++++++++++++++------- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f5166905..e7eb395c 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ $ cmake ../DRAMSys/library/ $ make ``` -To build DRAMSys on Windows 10 we recommend to use the *Windows Subsystem for Linux (WSL)*. +To build DRAMSys on Windows 10 we recommend to use the **Windows Subsystem for Linux (WSL)**. ### Executing DRAMSys @@ -49,7 +49,7 @@ $ cd simulator $ ./DRAMSys ``` -The default base config file is `ddr3-example.json` and located in `DRAMSys/library/resources/simulations`, the default resource folder for all nested config files is `DRAMSys/library/resources`. +The default base config file is *ddr3-example.json* and located in *DRAMSys/library/resources/simulations*, the default resource folder for all nested config files is *DRAMSys/library/resources*. To run DRAMSys with a specific base config file: @@ -192,7 +192,7 @@ The content of [ddr3.json](DRAMSys/library/resources/configs/simulator/ddr3.json - *WindowSize* (unsigned int) - Size of the window in clock cycles used to evaluate average bandwidth and average power consumption - *ThermalSimulation* (boolean) - - true: enables thermal simulation + - true: enables thermal simulation ([more information](#dramsys-with-thermal-simulation)) - false: static temperature during simulation - *SimulationProgressBar* (boolean) - true: enables the simulation progress bar @@ -419,7 +419,7 @@ Open the file makefile.def and set some variables. SLU_MAIN = $(HOME)/SuperLU_$(SLU_VERSION) YACC = bison-2.4.1 SYSTEMC_ARCH = linux64 -SYSTEMC_MAIN = $(HOME)/systemc-2.3.3 +SYSTEMC_MAIN = $(HOME)/systemc-2.3.x ``` Compile 3D-ICE with SystemC TLM-2.0 support: @@ -428,15 +428,20 @@ Compile 3D-ICE with SystemC TLM-2.0 support: $ make SYSTEMC_WRAPPER=y ``` -Export the environment variable *LIBTHREED_ICE_HOME*: +Export the environment variable `LIBTHREED_ICE_HOME`: ```bash -export LIBTHREED_ICE_HOME=${HOME}/3d-ice-latest/3d-ice-2.2.6 +$ export LIBTHREED_ICE_HOME=${HOME}/3d-ice-latest/3d-ice-2.2.6 ``` #### Running DRAMSys with Thermal Simulation -In order to run DRAMSys with thermal simulation you have to rerun CMake and rebuild the project. +In order to run DRAMSys with thermal simulation you have to rerun CMake and rebuild the project. The example input trace file can be generated with a Perl script: + + ```bash +$ cd DRAMSys/DRAMSys/library/resources/traces +$ ./generateErrorTest.pl > test_error.stl + ``` Before starting DRAMSys it is necessary to run the 3D-ICE server passing to it two arguments: a suitable configuration file and a socket port number. And then wait until the server is ready to receive requests. @@ -460,6 +465,16 @@ $ ./DRAMSys ../../DRAMSys/library/resources/simulations/wideio-thermal.json Further information about the usage of DRAMSys with gem5 can be found [here](DRAMSys/gem5/README.md). +## Trace Analyzer + +If you want to use the database recording feature and the Trace Analyzer tool for result analysis please contact [Matthias Jung](matthias.jung@iese.fraunhofer.de). + +## Disclaimer + +This is the public read-only mirror of an internal DRAMSys repository. Pull requests will not be merged but the changes might be added internally and published with a future commit. The repositories are synchronized from time to time. + +The user DOES NOT get ANY WARRANTIES when using this tool. This software is released under the BSD 3-Clause License. By using this software, the user implicitly agrees to the licensing terms. + ## References [1] TLM Modelling of 3D Stacked Wide I/O DRAM Subsystems, A Virtual Platform for Memory Controller Design Space Exploration