From b52cabf21ad5d3b87a0652d7369fdc3171b934f3 Mon Sep 17 00:00:00 2001 From: Lukas Steiner Date: Wed, 1 Jul 2020 15:41:20 +0200 Subject: [PATCH 1/8] Readme updates, separate gem5 readme. --- DRAMSys/gem5/README.md | 681 ++++++ DRAMSys/library/CMakeLists.txt | 4 +- DRAMSys/library/src/controller/Controller.cpp | 2 +- .../src/controller/respqueue/RespQueueIF.h | 1 + README.md | 1824 ++--------------- 5 files changed, 871 insertions(+), 1641 deletions(-) create mode 100644 DRAMSys/gem5/README.md diff --git a/DRAMSys/gem5/README.md b/DRAMSys/gem5/README.md new file mode 100644 index 00000000..d4966a95 --- /dev/null +++ b/DRAMSys/gem5/README.md @@ -0,0 +1,681 @@ +## DRAMSys with gem5 + +Install gem5 by following the instructions on the [gem5 wiki](http://gem5.org/Documentation#Getting_Started). +Optionally, use the scripts from [gem5.TnT] to install gem5, build it, get some benchmark programs and learn more about gem5. + +In order to understand the SystemC coupling with gem5 it is recommended to +read the documentation in the gem5 repository *util/tlm/README* and [12]. + +The main steps for building gem5 and libgem5 follow: + +```bash +scons build/ARM/gem5.opt +``` + +```bash +scons --with-cxx-config --without-python --without-tcmalloc build/ARM/libgem5_opt.so +``` + +For MacOS: + +```bash +scons --with-cxx-config --without-python --without-tcmalloc build/ARM/libgem5_opt.dylib +``` + +In order to use gem5 with DRAMSys set the **GEM5** environment variable to the +path to gem5, for example in the *QtCreator under Projects > Build +& Run > Build Environment*: + +``` +GEM5=/path/to/gem5/ +``` + +Example: + +``` +GEM5=$HOME/gem5_tnt/gem5 +``` + +Optionally, export environment variables in your **~/.bashrc** file or +equivalent and open a new terminal: + +```bash +# In this example gem5 is located at $HOME/gem5_tnt/gem5. +export GEM5=$HOME/gem5_tnt/gem5 + +# Add the folder containing libgem5_opt.so to the list where libraries should +# be searched for. +export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${GEM5}/build/ARM +``` + +The project file [DRAMSys.pro](DRAMSys/DRAMSys.pro) checks whether the +environment variable **GEM5** is defined or not and configures automatically +the corresponding build target **gem5** for QtCreator. + +In order to run gem5 with DRAMSys it is mandatory to run gem5 first without +DRAMSys and generate a configuration file **config.ini** which will be the +value of the second parameter passed to DRAMSys_gem5. + +### DRAMSys with gem5 traffic generator + +In the following we will run a simple example with a gem5 traffic generator: + +``` +Base System Architecture: ++-------------+ +------+ ^ +| System Port | | TGEN | | ++-------+-----+ +--+---+ | + | | | gem5 World + | +----+ | + | | | ++-------v------v-------+ | +| Membus | v ++---------------+------+ External Port (see sc_slave_port.*) + | ^ + +----v----+ | TLM World + | DRAMSys | | (see sc_target.*) + +---------+ v + +``` + +As mentioned before we first need to create a config.ini +that represents the gem5 configuration. We do so by starting gem5 with the +desired python configuration script. + +```bash +cd gem5/utils/tlm/ +../../build/ARM/gem5.opt conf/tlm_slave.py +``` + +**Ignore the message below.** +``` +"fatal: Can't find port handler type 'tlm_slave'" +``` + +The configuration file config.ini will be stored in the **m5out** directory. +Copy this configuration file to the building directory of DRAMSys where the +executable **DRAMSys_gem5** is located: + +``` +dram.sys/build-DRAMSys-Desktop_Qt_5_7_0_clang_64bit-Debug/gem5 +``` + +Also the traffic generatior configuration file (conf/tgen.cfg) must be stored +in a conf directory of this building directory. + +Then the simulation can be started with: + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json config.ini 1 +``` + +Let the simulation run for some seconds and then stop it with **CTRL-C**. +Observe the output of the simulation in the trace analyzer. The trace database +can be found inside the gem5 directory in the building directory. + +### Gem5 SE mode and DRAMSys + +All essential files for some functional examples are provided. + +Execute a hello world application: + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/configs/hello.ini 1 +``` + +A **Hello world!** message should be printed to the standard output. + +Execute applications: + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/Oscar/config.ini 1 +``` + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/Bubblesort/config.ini 1 +``` + +Wait some minutes for the application to finish. + +The hello application binary was copied from gem5 repository. + +Other applications were obtained with [gem5.TnT]. + +Command template for generating **.ini** configuration files follows: + +```bash +build/ARM/gem5.opt configs/example/se.py \ + -c --mem-size=512MB --mem-channels=1 \ + --caches --l2cache --mem-type=SimpleMemory \ + --cpu-type=TimingSimpleCPU --num-cpu=1 \ + --tlm-memory=transactor +``` + +An overview of the architcture being simulated is presented below: + +![arch](DRAMSys/docs/images/gem5_se_mode_arch.png) + +**Note**: this is a gem5 generated file, therefore DRAMSys is omitted. DRAMSys is +direct connected as external tlm slave. + +**Note**: workaround in se.py required: + +```python +... +if options.tlm_memory: + system.physmem = SimpleMemory() +MemConfig.config_mem(options, system) +... +``` + +A convenience script to execute several applications automatically +[**run.sh**](DRAMSys/gem5/gem5_se/run.sh) is provided . Take a look and learn +from it. + +### [PARSEC] FS Mode + +Full system simulation files for ARM available in [DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB](DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB). + +Choose the benchmark in [parsec_arm_minor_2c_8GB.rcS](DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB/parsec_arm_minor_2c_8GB.rcS). + +Edit the paths in [config.ini](DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB/config.ini). + +All files required to build DRAMSys_gem5 and execute the simulation (gem5 +library, benchmarks, disk image, etc.) can be obtained with [gem5.TnT]. + +Start a simulation. Example: + +```bash +dram.sys/build/gem5$ ./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/rgrsim-gem5-fs.json ../../DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB/config.ini 1 +``` + +Optionally, open another terminal or tab and connect to gem5. + +```bash +$ telnet localhost 3456 +``` + +Note: the port may vary, gem5 prints it during initialization. Example: + +``` +system.terminal: Listening for connections on port 3456 +``` + +### [PARSEC] SE Mode + + +Binaries and gem5 SE configuration files for ARM available in [DRAMSys/gem5/gem5_se/parsec-arm](DRAMSys/gem5/gem5_se/parsec-arm). + +Use [gem5.TnT] to download parsec. Example: + +Go to your **gem5.TnT** folder. Then go to **arch/arm** folder. Execute the +script *build-parsec-serial.sh*. + +```bash +gem5.TnT/arch/arm$ ./build-parsec-serial.sh +``` + +Extract inputs files. Example: + +```bash +cd $HOME/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs +tar -xf input_simdev.tar +tar -xf input_test.tar +tar -xf input_simmedium.tar +tar -xf input_simsmall.tar +tar -xf input_native.tar +tar -xf input_simlarge.tar + +cd $HOME/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs +tar -xf input_simdev.tar +tar -xf input_test.tar +tar -xf input_native.tar +tar -xf input_simlarge.tar +tar -xf input_simmedium.tar +tar -xf input_simsmall.tar + +cd $HOME/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs +tar -xf input_simdev.tar +tar -xf input_test.tar +tar -xf input_native.tar +tar -xf input_simlarge.tar +tar -xf input_simmedium.tar +tar -xf input_simsmall.tar +``` + +Open [DRAMSys/gem5/gem5_se/parsec-arm/config.ini](DRAMSys/gem5/gem5_se/parsec-arm/config.ini) + +Edit **cmd=**. + +Edit **executable=**. + +Examples (**Replace USER. Use the correct path in your computer.**): + +``` +-- canneal -- + +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 5 100 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/10.nets 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 100 300 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/100.nets 2 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 10000 2000 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/100000.nets 32 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 15000 2000 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/200000.nets 64 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 15000 2000 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/400000.nets 128 + +executable=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal + +-- streamcluster -- + +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 2 5 1 10 10 5 none output.txt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 3 10 3 16 16 10 none output.txt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 10 20 32 4096 4096 1000 none output.txt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 10 20 64 8192 8192 1000 none output.txt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 10 20 128 16384 16384 1000 none output.txt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 10 20 128 1000000 200000 5000 none output.txt 1 + +executable=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster + +-- swaptions -- + +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 1 -sm 5 -nt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 3 -sm 50 -nt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 16 -sm 5000 -nt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 32 -sm 10000 -nt 1 +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 64 -sm 20000 -nt 1 + +executable=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions + +-- fluidanimate -- + +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_5K.fluid out.fluid +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 3 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_15K.fluid out.fluid +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 5 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_35K.fluid out.fluid +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 5 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_100K.fluid out.fluid +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 5 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_300K.fluid out.fluid + +executable=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate + +-- blackscholes -- + +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_4.txt prices.txt +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_16.txt prices.txt +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_4K.txt prices.txt +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_16K.txt prices.txt +cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_64K.txt prices.txt + +executable=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes + +``` + +Start a simulation. Example: + +```bash +dram.sys/build/gem5$ ./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/rgrsim-gem5-se.json ../../DRAMSys/gem5/gem5_se/parsec-arm/config.ini 1 +``` + +### Boot Linux with gem5 and DRAMSys + +The procedure is very similar to the traffic generator example above. + +First we have to generate the config.ini file by starting gem5 with the following configuration: + +```bash +build/ARM/gem5.opt configs/example/fs.py \ + --tlm-memory=transactor --cpu-type=TimingSimpleCPU --num-cpu=1 \ + --mem-type=SimpleMemory --mem-size=512MB --mem-channels=1 --caches \ + --l2cache --machine-type=VExpress_EMM \ + --dtb-filename=vexpress.aarch32.ll_20131205.0-gem5.1cpu.dtb \ + --kernel=vmlinux.aarch32.ll_20131205.0-gem5 \ + --disk-image=linux-aarch32-ael.img +``` + +The config.ini should be copied again to the DRAMSys_gem5 build folder. + +The simconfig should be changed in order to support storage and address offsets: + +``` json +{ + "simconfig": { + "CheckTLM2Protocol": false, + "DatabaseRecording": true, + "Debug": false, + "ECCControllerMode": "Disabled", + "EnableWindowing": false, + "ErrorCSVFile": "", + "ErrorChipSeed": 42, + "NumberOfDevicesOnDIMM": 8, + "NumberOfMemChannels": 1, + "PowerAnalysis": false, + "SimulationName": "ddr3", + "SimulationProgressBar": true, + "ThermalSimulation": false, + "WindowSize": 1000, + + "StoreMode": "Store", + "AddressOffset": 2147483648, + "UseMalloc": true + } +} +``` + +Then start DRAMSys_gem5 with the following command: + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json config.ini 1 +``` + +For further sophisticated address mappings or scenarios checkout the file DRAMSys/gem5/main.cpp + +#### Boot Linux with gem5 and DRAMSys Example + +**All essential files for a functional example are provided.** + +Unzip the disk image: + +```bash +tar -xaf DRAMSys/gem5/boot_linux/linux-aarch32-ael.img.tar.gz -C DRAMSys/gem5/boot_linux/ +``` + +Execute the example: + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-boot-linux.json ../../DRAMSys/gem5/configs/boot_linux.ini 1 +``` + +Open a new terminal and connect to gem5: + +```bash +telnet localhost 3456 +``` + +Wait some minutes for the Linux boot process to complete then login. Username is +**root** no password required. + + +### DRAMSys with gem5 Elastic Traces + +For understanding elastic traces and their generation, study the [gem5 +wiki](http://gem5.org/TraceCPU) and the paper [13]. +Some predefined configs are stored [here](DRAMSys/gem5/configs) and the related +python files are stored [here](DRAMSys/gem5/examples). + +This is an example for running an elastic trace: + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json ../../DRAMSys/gem5/configs/singleElasticTraceReplay.ini 1 +``` + +An overview of the architcture being simulated is presented below: + +![arch](DRAMSys/docs/images/singleElasticTraceReplay.png) + +Note that the address offset is usually zero for elastic traces. + +Another example with L2 cache: + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json ../../DRAMSys/gem5/configs/singleElasticTraceReplayWithL2.ini 1 +``` + +If two elastic traces should be used run the simulation with the following example: + +``` +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json ../../DRAMSys/gem5/configs/dualElasticTraceReplay.ini 2 +``` + +An overview of the architcture being simulated is presented below: + +![arch](DRAMSys/docs/images/dualElasticTraceReplay.png) + +For more spophisticated setups, even with l2 caches the proper ini file should be created. +If you need help please contact Matthias Jung. + +### DRAMSys + GEM5 Log Collector Scripts + +Users can profit of running multiple **DRAMSys + gem5** simulations +automatically with [gem5ilva.sh] for **gem5 syscall emulation (SE) mode** and +[gem5ilva_fs.sh] for **gem5 full system (FS) mode**. + +Normally you will have to push your changes before running the scripts. This +approach makes it easier to track back what exactly was tested by the scripts. + +The scripts provide variables that tell **git** where to get the source +code from (repository URL), user name to be used (your git account), +**branch** to checkout (your working branch), etc. They are: + +```bash +# Git info. +git_user="$USER" +git_branch="master" +git_url="git.eit.uni-kl.de:ems/astdm/dram.sys.git" +git_url_https="git.eit.uni-kl.de/ems/astdm/dram.sys.git" +``` + +The default values of the variables presented above assume that your git +account uses the same name as your user name in your PC. If that is not the +case, replace the value of the **git_user** variable with your git account +name. Similarly, replace the value of the variable **git_branch** with your +working branch name. There (in your working branch) you can push your changes +and/or new files before executing the scripts. + +Open the script in QtCreator or another text editor of your choice and set the +variables with values that fit your needs. + +Nevertheless, for some cases, you may want to have gem5 essential files out of +the main repository (usually because they are too big to be added to the +repository). + +For those cases uncomment and properly set the variable +**external_inifile_path** in [gem5ilva_fs.sh]. + +This allows you to use a gem5 **config.ini** file external to the repository. +Note, however, that in this case it is up to you to keep track of your +simulation setup. + +**Hint:** +[gem5.TnT] provides convenience scripts +to create gem5 disk images with benchmarking programs embedded. + + +### Coverage Check + +Coverage check is enabled by default and can be disabled with an environment +variable. + +```bash +export COVERAGE=true +``` + +### DRAMSys + GEM5 x86 + +Make sure you have built **gem5/build/X86/libgem5_opt.so**. If you build with +[gem5.TnT] you can check if the library exists as follows. + +```bash +$ ls $HOME/gem5_tnt/gem5/build/X86/libgem5_opt.so +``` + +Change your ~/.bashrc. + +```bash +# In this example gem5 is located at $HOME/gem5_tnt/gem5. +export GEM5=$HOME/gem5_tnt/gem5 + +# Add the folder containing libgem5_opt.so to the list where libraries should +# be searched for. +#export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${GEM5}/build/ARM +export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${GEM5}/build/X86 +``` + +After that close QtCreator and all terminals. + +Open a new terminal. + +Change the architecture in [DRAMSys/gem5/gem5.pro](DRAMSys/gem5/gem5.pro). + +``` +gem5_arch = 'X86' +``` + +Delete the file **DRAMSys/DRAMSys.pro.user** from the repository. + +```bash +$ rm DRAMSys/DRAMSys.pro.user +``` + +Open a new QtCreator. + +Build DRAMSys as usual. + +After building, go the the folder where *DRAMSys_gem5* is located. + +Test with a hello world application for X86. + +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/hello-x86/config.ini 1 +``` + +A **Hello world!** message should be printed to the standard output. + +### [MiBench] + +Applications for x86 and configuration files available in [DRAMSys/gem5/gem5_se/MiBench](DRAMSys/gem5/gem5_se/MiBench). + +Examples: + +**Automotive Applications** + +**Basicmath** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/basicmath/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/basicmath/large/config.ini 1 +``` + +**Bitcount** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/bitcount/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/bitcount/large/config.ini 1 +``` + +**Qsort** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/qsort/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/qsort/large/config.ini 1 +``` + +**Susan** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/small/corners/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/large/corners/config.ini 1 + +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/small/edges/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/large/edges/config.ini 1 + +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/small/smoothing/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/large/smoothing/config.ini 1 +``` + +**Network Applications** + +**Dijkstra** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/network/dijkstra/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/network/dijkstra/large/config.ini 1 +``` + +**Patricia** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/network/patricia/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/network/patricia/large/config.ini 1 +``` + +**Security Applications** + +**Blowfish Encode** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/blowfish/encode/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/blowfish/encode/large/config.ini 1 +``` + +**Blowfish Decode** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/blowfish/decode/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/blowfish/decode/large/config.ini 1 +``` + +**SHA** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/sha/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/sha/large/config.ini 1 +``` + +**Telecom Applications** + +**CRC32** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/crc32/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/crc32/large/config.ini 1 +``` + +**FFT** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/fft/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/fft/large/config.ini 1 +``` + +**FFT-INV** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/fft-inv/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/fft-inv/large/config.ini 1 +``` + +**GSM Encode** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/gsm/encode/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/gsm/encode/large/config.ini 1 +``` + +**GSM Decode** +```bash +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/gsm/decode/small/config.ini 1 +./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/gsm/decode/large/config.ini 1 +``` + +Check the folder [DRAMSys/gem5/gem5_se/MiBench](DRAMSys/gem5/gem5_se/MiBench) for all applications and configuration files. + +### More AARCH64 Apps + +Full system simulation files for ARM available in [DRAMSys/gem5/gem5_fs/arm64](DRAMSys/gem5/gem5_fs/arm64). + +You can edit [arm64.rcS](DRAMSys/gem5/gem5_fs/arm64/arm64.rcS) to start an application and call *m5 exit* when it finishes. + +Edit the paths in [config.ini](DRAMSys/gem5/gem5_fs/arm64/config.ini). + +All files required to build DRAMSys_gem5 and execute the simulation (gem5 +library, benchmarks, disk image, etc.) can be obtained with [gem5.TnT]. + +Start a simulation. Example: + +```bash +dram.sys/build/gem5$ ./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/rgrsim-gem5-fs.json ../../DRAMSys/gem5/gem5_fs/arm64/config.ini 1 +``` + +Optionally, open another terminal or tab and connect to gem5. + +```bash +$ telnet localhost 3456 +``` + +Note: the port may vary, gem5 prints it during initialization. Example: + +``` +system.terminal: Listening for connections on port 3456 +``` + +[gem5.TnT]: https://github.com/tukl-msd/gem5.TnT +[gem5ilva.sh]: DRAMSys/library/resources/scripts/DRAMSylva/gem5ilva.sh +[gem5ilva_fs.sh]: DRAMSys/library/resources/scripts/DRAMSylva/gem5ilva_fs.sh +[Elwetritsch]: https://elwe.rhrk.uni-kl.de/ +[DRAMSylva.sh]: DRAMSys/library/resources/scripts/DRAMSylva/DRAMSylva.sh +[DRAMSylva folder]: DRAMSys/library/resources/scripts/DRAMSylva +[configs_json]: DRAMSys/library/resources/scripts/DRAMSylva/configs_json +[MiBench]: http://vhosts.eecs.umich.edu/mibench/ +[PARSEC]: http://parsec.cs.princeton.edu/ \ No newline at end of file diff --git a/DRAMSys/library/CMakeLists.txt b/DRAMSys/library/CMakeLists.txt index a84e0f29..733c7f6e 100644 --- a/DRAMSys/library/CMakeLists.txt +++ b/DRAMSys/library/CMakeLists.txt @@ -288,8 +288,8 @@ add_library(DRAMSysLibrary resources/traces/chstone-adpcm_32.stl ) -if(DEFINED ENV{LIBTHREED_ICE_HOME} AND DEFINED ENV{LIBSUPERLU_HOME}) - message("-- 3D-ICE and SuperLU available") +if(DEFINED ENV{LIBTHREED_ICE_HOME}) + message("-- Thermal simulation available") add_definitions(-DTHERMALSIM) target_include_directories(DRAMSysLibrary PRIVATE $ENV{LIBTHREED_ICE_HOME}/include/ diff --git a/DRAMSys/library/src/controller/Controller.cpp b/DRAMSys/library/src/controller/Controller.cpp index 137aa3db..79c68d25 100644 --- a/DRAMSys/library/src/controller/Controller.cpp +++ b/DRAMSys/library/src/controller/Controller.cpp @@ -341,7 +341,7 @@ tlm_sync_enum Controller::nb_transport_fw(tlm_generic_payload &trans, timeToAcquire = sc_time_stamp() + notificationDelay; beginReqEvent.notify(notificationDelay); } - else if (phase = END_RESP) + else if (phase == END_RESP) { timeToRelease = sc_time_stamp() + notificationDelay; endRespEvent.notify(notificationDelay); diff --git a/DRAMSys/library/src/controller/respqueue/RespQueueIF.h b/DRAMSys/library/src/controller/respqueue/RespQueueIF.h index 078ddb93..e4848b09 100644 --- a/DRAMSys/library/src/controller/respqueue/RespQueueIF.h +++ b/DRAMSys/library/src/controller/respqueue/RespQueueIF.h @@ -44,6 +44,7 @@ public: virtual void insertPayload(tlm::tlm_generic_payload *, sc_time) = 0; virtual tlm::tlm_generic_payload *nextPayload() = 0; virtual sc_time getTriggerTime() const = 0; + virtual ~RespQueueIF() {} }; #endif // RESPQUEUEIF_H diff --git a/README.md b/README.md index 44bad0a1..a820de3c 100644 --- a/README.md +++ b/README.md @@ -1,186 +1,74 @@ -DRAMSys 4.0 +DRAMSys4.0 =========== -**DRAMSys** [1] is a flexible DRAM subsystem design space exploration -framework that consists of models reflecting the DRAM functionality, power -consumption, temperature behaviour and retention time errors. +**DRAMSys4.0** is a flexible DRAM subsystem design space exploration framework that consists of models reflecting the DRAM functionality, power consumption, temperature behavior and retention time errors. + +Pipeline Status: [![pipeline status](https://git.eit.uni-kl.de/ems/astdm/dram.sys/badges/master/pipeline.svg)](https://git.eit.uni-kl.de/ems/astdm/dram.sys/commits/master) -Pipeline Status: [![pipeline status](https://git.eit.uni-kl.de/ems/astdm/dram.sys/badges/master/pipeline.svg)](https://git.eit.uni-kl.de/ems/astdm/dram.sys/commits/master) [![Coverage report](https://git.eit.uni-kl.de/ems/astdm/dram.sys/badges/master/coverage.svg?job=coverage)](https://git.eit.uni-kl.de/ems/astdm/dram.sys/commits/master) + ## Basic Setup -Start using DRAMSys by cloning the current stable master branch: - -```bash -$ git clone --recursive https://git.eit.uni-kl.de/ems/astdm/dram.sys.git -``` - -The *--recursive* flag tells git to initialize all submodules within the -repository, namely **DRAMPower** [2], **SystemC** and **tinyxml**. - -Now you can implement, test, commit and push features into a **branch**. - -When you consider your work stable enough to be merged into the master branch -it is time to open a **merge request** using the web interface. - -Your changes will be reviewed and might be integrated into the master branch. - -After cloning go to the project directory. - -```bash -$ cd dram.sys -``` +Start using DRAMSys by cloning the repository. +Use the *--recursive* flag to initialize all submodules within the repository, namely **DRAMPower** [2], **SystemC** and **nlohmann json**. ### Dependencies -Make sure you have properly installed all the required libraries and -tools in your system. +DRAMSys is based on the SystemC library. SystemC is included as a submodule and will be build automatically with the DRAMSys project. If you want to use an external SystemC version you have to export the environment variables *SYSTEMC_HOME* (SystemC root directory), *SYSTEMC_TARGET_ARCH* (e.g. linux64) and add the path of the library to *LD_LIBRARY_PATH*. -- **General dependencies** +### Building DRAMSys +DRAMSys uses CMake for the build process, the minimum required version is **CMake 3.10**. -You may want to have a look on the convenience scripts that are located in the -[utils](./utils) folder. +To build the standalone simulator for running memory trace files, create a build folder in the project root directory, then run CMake and make: ```bash -$ cd utils -$ ls -``` - -You can use [utils/install_deb.sh](./utils/install_deb.sh) in order to install -dependencies. Type your password if required. - -```bash -$ ./install_deb.sh -``` - -### Coding Style - -Please read the [coding-style document](coding-style.md) before starting to -code. - -A script is provided to apply the coding style. -```bash -$ cd util -$ ./make_pretty.sh -``` - -### Buiding with QTCreator -Execute the *QTCreator*. - -```bash -$ qtcreator & -``` - -Use the menu bar and open the DRAMSys project. - -**File -> Open Project -> dram.sys/DRAMSys/CMakeLists.txt** - -When you open the project for the first time a configuration window pops-up. -Then click in **Configure Project** and after that **Build** the project. - -To speedup the building process one can use the additional **make** option -**-j[jobs]**. The command line below returns the number of CPUs on a Debian -Linux to be passed to make as the number of jobs that can run simultaneously to -improve the building time. - -```bash -$ cat /proc/cpuinfo | grep processor | wc -l -``` - -In the left bar go to **Projects -> Build & Run -> Build Steps -> Make**. -Click in **Details** then **Make arguments** and add **-j** followed by the -number you got. - -In case you face a problem related to the **Qt version** double check the **Qt -version** configuration shown in the image below. - -![Qt Creator Configuration](DRAMSys/docs/images/QtCreatorConfig.png) - -### Building without QTCreator - -In case you prefer a command line interface to the QTCreator GUI you can also -use **cmake** to generate a Makefile and then compile the project. - -```bash -$ cd dram.sys +$ cd DRAMSys $ mkdir build $ cd build $ cmake ../DRAMSys/ -$ make -j4 +$ make ``` -The compilation generates executable binary files **DRAMSys** and -**TraceAnalyzer** that can be found inside sub-directories. +If you plan to integrate DRAMSys into your own SystemC/TLM project you can build the DRAMSys library only: -From the build directory use the commands below to execute DRAMSys. +```bash +$ cd DRAMSys +$ mkdir build +$ cd build +$ cmake ../DRAMSys/library/ +$ make +``` + +To build DRAMSys on Windows 10 we recommend to use the *Windows Subsystem for Linux (WSL)*. + +### Executing DRAMSys + +From the build directory use the commands below to execute the DRAMSys standalone. ```bash $ cd simulator $ ./DRAMSys ``` -To run DRAMSys with a specific config: +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: + ```bash $ ./DRAMSys ../../DRAMSys/library/resources/simulations/ddr3-example.json ``` -To run DRAMSys with a specific config and a resource folder somewhere else to the standard: +To run DRAMSys with a specific base config file and a resource folder somewhere else to the standard: + ```bash $ ./DRAMSys ../../DRAMSys/tests/example_ddr3/simulations/ddr3-example.json ../../DRAMSys/tests/example_ddr3/ ``` -From the build directory use the commands below to execute the Trace Analyzer. - -```bash -$ cd traceAnalyzer -$ export QT_QPA_PLATFORMTHEME=qgnomeplatform -$ ./TraceAnalyzer -``` - -### Building on MacOS (Formerly OSX) -- Install XCode as a Compiler (or any other via Homebrew) -- Install the required python3 over homebrew: - -```bash -$ brew install python3 -``` - -- Install the QtCreator using offical setup file from [link](https://www.qt.io/download-open-source/#section-2) - -**Note:** You have later setup PATH for Qt5 and its tool if you install QtCreator manually, e.g: - -```bash -# Setting PATH for Qt5 and its tools -PATH="/Users//Qt5.7.0/5.7/clang_64/bin:${PATH}" -export PATH -``` - -- Install the QWT manually to /opt/qwt, then do: - -```bash -$ cd /Library/Frameworks -$ sudo ln -s /opt/qwt-6.1.2/lib/qwt.framework/ . -``` - -You compile DRAMSys also with QtCreator or CMAKE as described in the Linux -section. - -### Building on Windows 10 - -- DRAMSys can also run on Windows 10 with the *Windows Subsystem for Linux* (WSL) feature. You can install a linux distribution like Debian over the windows app store. - We refer to the following example [website](https://docs.microsoft.com/en-us/windows/wsl/install-win10). - Then DRAMSys can be installed as described above for Linux. - -- Native Windows 10 Implementation is currently under investigation - ### DRAMSys Configuration -The **DRAMSys** executable supports one argument which is a JSON file that -contains certain arguments and the path of other configuration files for the -desired simulation. If no argument is passed through the command line a default -configuration file will be loaded. +The DRAMSys executable supports one argument which is a JSON file that contains certain arguments and the path of other configuration files for the desired simulation. -The JSON code below shows a typic configuration: +The JSON code below shows an example configuration: ```json { @@ -191,185 +79,169 @@ The JSON code below shows a typic configuration: "memspec": "MICRON_1Gb_DDR3-1600_8bit_G.json", "addressmapping": "am_ddr3_8x1Gbx8_dimm_p1KB_brc.json", "mcconfig":"fifoStrict.json", - "tracesetup": [{ + "tracesetup": [ + { "clkMhz": 300, - "name": "ddr3_example.stl"}, - { + "name": "ddr3_example.stl" + }, + { "clkMhz": 400, - "name": "ddr3_example.stl"} - ] + "name": "ddr3_example.stl" + } + ] } } ``` Fields Description - "simulationid": Simulation file identifier - "simconfig": Configuration file for the DRAMSys Simulator - "thermalconfig": Temperature Simulator Configuration File - "memspec": Memory Device Specification File - "addressmapping": Addressmapping Configuration of the Memory Controller File. - "mcconfig": Memory Controller Configuration File. - "tracesetup": The trace setup is only used in standalone mode. - In library mode e.g. in Platform Architect the trace setup is ignored. - Each device should be addes as a json object inside the "tracesetup" array. -Each **tracesetup** device configuration consists of two parameters - clkMhz -(operation frequency for this device) - and a **trace file**. - -Some configuration fields reference other JSON files which contain more -specialized chunks of the configuration like memory specification, address -mapping and memory configurations +- "simulationid": Simulation file identifier -The JSON configuration files are parsed by the program and the configuration -details extracted are assigned to the correspondent attributes of the internal -configuration structure. +- "simconfig": Configuration file for the DRAMSys Simulator + +- "thermalconfig": Temperature Simulator Configuration File + +- "memspec": Memory Device Specification File + +- "addressmapping": Addressmapping Configuration of the Memory Controller File. + +- "mcconfig": Memory Controller Configuration File. + +- "tracesetup": The trace setup is only used in standalone mode. In library mode the trace setup is ignored. + + Each device should be added as a json object inside the "tracesetup" array. + +Each **trace setup** device configuration consists of two parameters, **clkMhz** (operation frequency of the **trace player**) and a trace file **name**. Most configuration fields reference other JSON files which contain more specialized chunks of the configuration like a memory specification, an address mapping and a memory controller configuration. -#### Trace files +#### Trace Files -A **trace file** is a pre-recorded file containing memory transactions. Each -memory transaction has a timestamp that tells the simulator when it shall -happen, a transaction type (read or write) and a memory address given in -hexadecimal. +A **trace file** is a prerecorded file containing memory transactions. Each memory transaction has a time stamp that tells the simulator when it shall happen, a transaction type (*read* or *write*) and a hexadecimal memory address. -There are two different kinds of trace files. They differ in their timing behaviour and are distingushed by their file extension. +There are two different kinds of trace files. They differ in their timing behavior and are distinguished by their file extension. ##### STL Trace (.stl) -The timestamp corresponds to the time the request is to be issued and it is -given in cycles of the bus master device. Example: the device is a FPGA with -frequency 200 MHz (clock period of 5 ns). If the timestamp is 10 it means that -the request is to be issued when time is 50 ns. +The times tamp corresponds to the time the request is to be issued and it is given in cycles of the bus master device. Example: the device is an FPGA with a frequency of 200 MHz (clock period of 5 ns). If the time stamp is 10 it means that the request is to be issued when time is 50 ns. Here is an example syntax: ``` # Comment lines begin with # -# [clock-cyle]: [write|read] [hex-address] +# [clock-cyle]: [write|read] [hex-address] [hex-data (optional)] 31: read 0x400140 33: read 0x400160 -56: write 0x7fff8000 +56: write 0x7fff8000 0x123456789abcdef 81: read 0x400180 ``` ##### Relative STL Traces (.rstl) -The timestamp corresponds to the time the request is to be issued relative to the end of the transaction before or the beginning of the trace. This results in a simulation in which the **trace player** is able to react to possible delays due to DRAM bottlenecks. +The time stamp corresponds to the time the request is to be issued relative to the end of the transaction before or the beginning of the trace. This results in a simulation in which the trace player is able to react to possible delays due to DRAM bottlenecks. Here is an example syntax: ``` # Comment lines begin with # -# [clock-cyle]: [write|read] [hex-address] +# [clock-cyle]: [write|read] [hex-address] [hex-data (optional)] 31: read 0x400140 2: read 0x400160 -23: write 0x7fff8000 +23: write 0x7fff8000 0x123456789abcdef 25: read 0x400180 ``` -#### Trace player +#### Trace Player -A **trace player** is **equivalent** to a bus master **device** -(processor, FPGA, etc.). It reads an input trace file and translates each line into -a new memory request. By adding a new device element into the trace setup section -one can specify a new trace player, its operating frequency and the trace file -for that trace player. +A **trace player** is **equivalent** to a bus master **device** (processor, FPGA, etc.). It reads an input trace file and translates each line into a new memory request. By adding a new device element into the trace setup section one can specify a new trace player, its operating frequency and the trace file for that trace player. #### Configuration File Sections -The main configuration file is divided into self-contained sections. Each of -these sections refers to sub-configuration files. +The main configuration file is divided into self-contained sections. Each of these sections refers to sub-configuration files. Below, the sub-configurations are listed and explained. -- **Simulator Configuration** +##### Simulator Configuration - The content of [ddr3.json](DRAMSys/library/resources/configs/simulator/ddr3.json) is presented below as an example. +The content of [ddr3.json](DRAMSys/library/resources/configs/simulator/ddr3.json) is presented below as an example. ```json { "simconfig": { - "AddressOffset": 0, - "CheckTLM2Protocol": false, - "DatabaseRecording": true, + "SimulationName": "ddr3", "Debug": false, - "ECCControllerMode": "Disabled", + "DatabaseRecording": true, + "PowerAnalysis": false, "EnableWindowing": false, + "WindowSize": 1000, + "ThermalSimulation": false, + "SimulationProgressBar": true, + "CheckTLM2Protocol": false, + "ECCControllerMode": "Disabled", + "UseMalloc": false, + "AddressOffset": 0, "ErrorCSVFile": "", "ErrorChipSeed": 42, - "NumberOfDevicesOnDIMM": 8, - "NumberOfMemChannels": 1, - "PowerAnalysis": false, - "SimulationName": "ddr3", - "SimulationProgressBar": true, - "StoreMode": "NoStorage", - "ThermalSimulation": false, - "UseMalloc": false, - "WindowSize": 1000 + "StoreMode": "NoStorage" } } ``` - *SimulationName* (boolean) - - - Give the name of the simulation for distingushing from other simulations. + - Give the name of the simulation for distinguishing from other simulations. - *Debug* (boolean) - - true: enables debug output on console + - true: enables debug output on console (only supported by a debug build) - false: disables debug output - *DatabaseRecording* (boolean) - - true: enables trace file recording for the trace analyser tool - - false: disables trace file recording + - true: enables output database recording for the Trace Analyzer tool + - false: disables output database recording - *PowerAnalysis* (boolean) - - true: enables live power analysis with the DRAMPower tool + - true: enables live power analysis with DRAMPower - false: disables power analysis - *EnableWindowing* (boolean) - true: enables temporal windowing - false: disables temporal windowing - - *WindowSize* (unisgned int) - + - *WindowSize* (unsigned int) - Size of the window in clock cycles used to evaluate average bandwidth and average power consumption - - *NumberOfMemChannels* (unsigned int) - - - Number of memory channels - - *ControllerCoreRefDisable* (boolean) - - true: disables refreshes - - false: normal operation (refreshes enabled) - - *ControllerCoreRGR* (boolean) - - true: enable row granular refresh - - false: normal operation - *ThermalSimulation* (boolean) - true: enables thermal simulation - false: static temperature during simulation - *SimulationProgressBar* (boolean) - true: enables the simulation progress bar - false: disables the simulation progress bar - - *NumberOfDevicesOnDIMM* (unsigned int) - - - Number of devices on dual inline memory module - *CheckTLM2Protocol* (boolean) - true: enables the TLM-2.0 Protocol Checking - false: disables the TLM-2.0 Protocol Checking - *ECCControllerMode* (string) - - "Disabled": No ECC Controller is used + - "Disabled": No ECC controller is used - "Hamming": Enables an ECC Controller with classic SECDED implementation using Hamming Code - *UseMalloc* (boolean) - false: model storage using mmap() (DEFAULT) - true: allocate memory for modeling storage using malloc() +- *AddressOffset* (unsigned int) + - Address offset of the DRAM subsystem (required for the gem5 coupling). +- *ErrorChipSeed* (unsigned int) + - Seed to initialize the random error generator. + - *ErrorCSVFile* (string) + - CSV file with error injection information. + - *StoreMode* (string) + - "NoStorage": no storage + - "Store": store data without error model + - "ErrorModel": store data with error model [6] -- **Temperature Simulator Configuration** +##### Temperature Simulator Configuration - The content of [config.json](DRAMSys/library/resources/configs/thermalsim/config.json) is presented below as an example. +The content of [config.json](DRAMSys/library/resources/configs/thermalsim/config.json) is presented below as an example. ```json { "thermalsimconfig": { "TemperatureScale": "Celsius", "StaticTemperatureDefaultValue": 89, - "ThermalSimPeriod":100, - "ThermalSimUnit":"us", + "ThermalSimPeriod": 100, + "ThermalSimUnit": "us", "PowerInfoFile": "powerInfo.json", "IceServerIp": "127.0.0.1", "IceServerPort": 11880, - "SimPeriodAdjustFactor" : 10, + "SimPeriodAdjustFactor": 10, "NPowStableCyclesToIncreasePeriod": 5, "GenerateTemperatureMap": true, "GeneratePowerMap": true @@ -398,10 +270,10 @@ Below, the sub-configurations are listed and explained. - File containing power related information: devices identifiers, initial power values and power thresholds. - *IceServerIp* (string) - - 3D-Ice server IP address + - 3D-ICE server IP address - *IceServerPort* (unsigned int) - - 3D-Ice server port + - 3D-ICE server port - *SimPeriodAdjustFactor* (unsigned int) - When substantial changes in power occur (i.e., changes that exceed the thresholds), then the simulation period will be divided by this number causing the thermal simulation to be executed more often. @@ -415,74 +287,49 @@ Below, the sub-configurations are listed and explained. - true: generate power map files during thermal simulation - false: do not generate power map files during thermal simulation -- **Memory Specification** - A file with memory specifications. This information comes from datasheets and - measurements, and usually does not change. +##### Memory Specification - The fields inside "mempowerspec" can be written directly as a **double** type. "memoryId" and "memoryType" are **string**. The others are **unsigned int** as it can be checked in the files at . +A file with memory specifications. Timings and currents come from data sheets and measurements, and usually do not change. +The fields inside "mempowerspec" can be written directly as a **double** type. "memoryId" and "memoryType" are **string**. The others are **unsigned int**. -- **Address Mapping** +##### Address Mapping - Currently the CONGEN format is supported. It provides bit-wise granularity. It also provides the possibility of XOR address bits in order to map page misses to different banks and reduce latencies. - There is an optional field called **SOLUTION**. If added it will look for the solution with the field "ID" equals to 0. - Example with "SOLUTION" field at: - Example without "SOLUTION" field at: +DRAMSys uses the **ConGen** [TODO congen source] format for address mappings. It provides bit-wise granularity. It also provides the possibility to XOR address bits in order to map page misses to different banks and reduce latencies. +Used fields: -- **ConGen XML file format** - - This file format is generated by ConGen. - - The format delivers more information than needed for an address mapping. - Optional data (unused): - - - "NAME": Name of the trace file which was used by ConGen -- "COSTS": Number of row misses which this configuration produces while playing the trace. - - - "CONFIG": Gives you information about the ConGen configuration - - Used data: - - - "SOLUTION": (OBS.:Different solutions should be added as json objects inside the "SOLUTION" array) - - "ID": Unique identifier for this solution. It is used to specify a certain solution. - - "XOR": Defines an xor connection of a bank and row bit - - "BYTE_BIT": Address bits that are connected to the byte bits in ascending order - - "COLUMN_BIT": Address bits that are connected to the column bits in ascending order - - "ROW_BIT": Address bits that are connected to the row bits in ascending order - - "BANK_BIT": Address bits that are connected to the bank bits in ascending order - - "BANKGROUP_BIT": Address bits that are connected to the bankgroup bits in ascending order - - "RANK_BIT": Address bits that are connected to the rank bits in ascending order - - "CHANNEL_BIT": Address bits that are connected to the channel bits in ascending order +- "XOR": Defines an XOR connection of a "FIRST" and a "SECOND" bit +- "BYTE_BIT": Address bits that are connected to the byte bits in ascending order +- "COLUMN_BIT": Address bits that are connected to the column bits in ascending order +- "ROW_BIT": Address bits that are connected to the row bits in ascending order +- "BANK_BIT": Address bits that are connected to the bank bits in ascending order +- "BANKGROUP_BIT": Address bits that are connected to the bank group bits in ascending order +- "RANK_BIT": Address bits that are connected to the rank bits in ascending order +- "CHANNEL_BIT": Address bits that are connected to the channel bits in ascending order ```json { "CONGEN": { - "SOLUTION": [ + "XOR": [ { - "ID": 0, - "XOR": [ - { - "FIRST": 13, - "SECOND": 16 - } - ], - "BYTE_BIT": [0,1,2], - "COLUMN_BIT": [3,4,5,6,7,8,9,10,11,12], - "BANK_BIT": [13,14,15], - "ROW_BIT": [16,17,18,19,20,21,22,23,24,25,26,27,28,29] + "FIRST": 13, + "SECOND": 16 } - ] - } + ], + "BYTE_BIT": [0,1,2], + "COLUMN_BIT": [3,4,5,6,7,8,9,10,11,12], + "BANK_BIT": [13,14,15], + "ROW_BIT": [16,17,18,19,20,21,22,23,24,25,26,27,28,29] + } } ``` +##### Memory Controller Configuration -- **Memory Controller Configuration** - - An example follows. +An example follows. ```json { @@ -502,504 +349,49 @@ Below, the sub-configurations are listed and explained. } ``` - - *BankwiseLogic* (boolean) - - true: perform bankwise-refresh [3] and bankwise-powerdown [4] - - false: do not perform bankwise operations - - *OpenPagePolicy* (boolean) - - true: use open page precharge policy - - false: do not use open page precharge policy - - *MaxNrOfTransactions* (unsigned int) - - Maximum number of transactions. + - *PagePolicy* (string) + - "Open" + - "OpenAdaptive" + - "Closed" + - "ClosedAdaptive" - *Scheduler* (string) - "Fifo": first in, first out - - "FifoStrict": out-of-order treatment of queue elements not allowed - - "FrFcfs": first ready first-come-first-served - - "FrFcfsRp": first ready first-come-first-served read priority - - "FrFcfsGrp": first ready first-come-first-served grouper - - "Grp": grouper - - "SMS": will be removed - - *Capsize* (unsigned int) - - Capacitor cell size. - - *PowerDownMode* (enum EPowerDownMode) - - "NoPowerDown": no power down mode (active idle) + - "FrFcfs": first-ready - first-come, first-served + - "FrFcfsGrp": first-ready - first-come, first-served with grouping of read and write requests + - RequestBufferSize (unsigned int) + - buffer size of the scheduler + - *CmdMux* (string) + - "Oldest": oldest payload has the highest priority + - "Strict": read and write commands are issued in the same order as their corresponding requests arrived at the channel controller (can only be combined with "Fifo" scheduler) + - *RespQueue* (string) + - "Strict": outgoing responses are not reordered + - "Reorder": outgoing responses are reordered + - *RefreshPolicy* (string) + - "NoRefresh": refresh disabled + - "Rankwise": all-bank refresh commands, issued per rank + - "Bankwise": per-bank refresh commands (only supported by LPDDR4, Wide I/O 2, GDDR5/5X/6, HBM2) + - *RefreshMode* (unsigned int) [TODO: move refresh mode to memspec] + - special refresh modes of DDR4, 1 ≙ x1, 2 ≙ x2, 4 ≙ x4 + - *RefreshMaxPostponed* + - maximum number of refresh commands that can be postponed (usually 8, with per-bank refresh the number is automatically multiplied by the number of banks) + - *RefreshMaxPulledin* + - maximum number of refresh commands that can be pulled in (usually 8, with per-bank refresh the number is automatically multiplied by the number of banks) + - *PowerDownPolicy* (string) + - "NoPowerDown": power down disabled - "Staggered": staggered power down policy [5] - - "TimeoutPDN": precharge idle - - "TimeoutSREF": self refresh - - *ReadWriteGrouping* (boolean) - - true: enable read writing grouping - - false: disable read writing grouping - - *ReorderBuffer* (boolean) - - true: use reordering buffer - - false: do not use reordering buffer - - *ErrorChipSeed* (unsigned int) - - Seed to initialize the random error generator. - - *ErrorCSVFile* (string) - - CSV file with error injection information. - - *StoreMode* (enum StorageMode) - - "NoStorage": no storage - - "Store": store data without error model - - "ErrorModel": store data with error model [6] - - *ControllerCoreRefDisable* (boolean) - - true: disables refreshes - - false: normal operation (refreshes enabled) - - ControllerCoreRefMode (unsigned int) - - Refresh mode. 1: 1X, 2: 2X, 4: 4X. Refresh period is tREFI, tREFI/2, - tREFI/4, respectively. Number of rows per refresh is affected. Maximum - values for pull-in and postpone are affected. There are different values - of tRFC for each mode that come from memory specifications. - - *ControllerCoreRefForceMaxPostponeBurst* (boolean) - - true: always postpone, resulting in a ControllerCoreRefMaxPostponed burst - - false: normal operation - - *ControllerCoreRefEnablePostpone* (boolean) - - true: enables the postpone refresh feature - - false: normal operation - - *ControllerCoreRefEnablePullIn* (boolean) - - true: enables the pull-in refresh feature - - false: normal operation - - *ControllerCoreRefMaxPostponed* (unsigned int) - - Max AR commands to be postponed. Refresh mode affects this config. - - *ControllerCoreRefMaxPulledIn* (unsigned int) - - Max AR commands to be pulled-in. Refresh mode affects this config. - - *ControllerCoreRGR* (boolean) - - true: enables row granular refresh feature (RGR) - - false: normal operation - - *ControllerCoreRefNumARCmdsIntREFI* (unsigned int) - - Number of AR commands to to be issued in a refresh period tREFI in 1X - mode - - *ControllerCoreRGRRowInc* (unsigned int) - - Row increment for each AR command (selective refresh) - - *ControllerCoreRGRB0* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB1* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB2* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB3* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB4* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB5* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB6* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB7* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB8* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB9* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB10* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB11* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB12* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB13* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB14* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRB15* (boolean) - - true: RGR this bank - - false: skip this bank - - *ControllerCoreRGRtRASBInClkCycles* (unsigned int) - - Timing can be changed to explore optimum row granular refresh (ORGR) - - *ControllerCoreRGRtRRDB_LInClkCycles* (unsigned int) - - Timing can be changed to explore optimum row granular refresh (ORGR) - - *ControllerCoreRGRtRRDB_SInClkCycles* (unsigned int) - - Timing can be changed to explore optimum row granular refresh (ORGR) - - *ControllerCoreRGRtRPBInClkCycles* (unsigned int) - - Timing can be changed to explore optimum row granular refresh (ORGR) - - *ControllerCoreRGRtRCBInClkCycles* (unsigned int) - - Timing can be changed to explore optimum row granular refresh (ORGR) - - *ControllerCoreRGRtFAWBInClkCycles* (unsigned int) - - Timing can be changed to explore optimum row granular refresh (ORGR) +- PowerDownTimeout (unsigned int) + - currently unused - -**Refresh modes** - -The default refresh mode is fixed 1X mode where refresh commands should be -issued with the normal rate, i.e., tREFI. The duration of each refresh command -is the normal refresh cycle time tRFC. In 2X mode Refresh commands are issued -to the DRAM at the double frequency (tREFI/2). In 4X mode Refresh commands are -issued to the DRAM at the quadruple frequency (tREFI/4). There are different -values of tRFC for each mode that come from memory specifications. - -The number of refresh commands in a tREFI is multiplied by two in 2X mode and -by four in 4X mode. The maximum number of refresh commands that can be -postponed or pulled-in is affected in the same manner. The number of rows per -refresh command is divided by two and by four in 2X and 4X mode respectively. - -The nomenclature tREFIx is used to denote the refresh interval which value -changes accordingly to the operation mode, e.g., in 2X mode tREFIx corresponds -to tREFI/2. Similarly tRFCx denotes the refresh cycle time which value changes -accordingly to the operation mode. Nevertheless, the values of tRFCx must be -obtained from memory specifications, estimated, measured, etc. - -**Flexible Refresh** - -The feature can be used together with regular refresh, bankwise refresh and -also with row granular refresh (RGR) non-bankwise and bankwise. Combinations -with all refresh modes are possible. - -**Pull-In Refresh** - -A pull-in starts when a refresh is triggered (in a multiple of tREFIx) and -there are no pending requests in the memory controller's buffer. This can be -done in order to prepare for possible accesses that might happen in the -future. When a burst of REF commands is initiated a REF command is issued (due -to the current tREFIx) followed by one or more REF commands separated in time -by tRFCx. The burst is interrupted if requests arrive, meaning that the -maximum additional delay for a request (considering the worst case scenario in -which a request arrives at the same time a REF is issued) is a refresh cycle -time (tRFCx). - -The advantage of pulling-in refreshes is that they will not be issued in the -near future, i.e., in their actual times multiples of tREFIx, allowing for -more efficient accesses to the memory. - -**Postpone Refresh** - -Similarly, the decision to postpone a refresh is done if by the time of a -refresh due (multiple of tREFIx) there are pending requests on the memory -controller's buffer. Buffered requests may generate row-hits, so postponing -refreshes may be beneficial for it avoids breaking row-hit sequences what -reduces the number of commands (e.g., ACT, PRE) to carry out the memory -accesses and improves the overall system preformance because accesses that are -row-hits consume less time. After postponing refreshes, if there are no -pending requests in the next refresh interval (tREFIx) a burst is issued for -the same number of REF commands postponed plus the actual refresh for that -tREFIx. When the maximum number of postponed refreshes is reached a burst is -issued in the next tREFIx despite the state of the memory controller's buffer -(empty or not). A burst of postponed refreshes cannot be interrupted. - -**The Flexible Refresh FSM** - -![Flexible](DRAMSys/docs/images/flexreffsm.png) - - -- **Trace Setups** - - *clkMhz* (unsigned int) - - Speed of the trace player - - *trace file* - - A pre-recorded file containing memory transactions to be executed by a - trace player. - -Some attributes are self-explanatory while others require some previous -knowhow of memory technologies. - -Resources of the simulator are available inside of the **resources** directory -and its sub-directories. - -```bash -$ cd DRAMSys/library/resources -``` - -A description of the content each directory follows. - -- **resources** - - **configs**: JSON files that specify details of the simulation. - - amconfigs: address mapping configs. - - mcconfigs: memory controller configs. - - memspecs: memory specification files (technology dependent). - - simulator: simulator configs. - - **scripts**: useful tools. - - **simulations**: main configuration files. - - **traces**: pre-recorded trace files that may be used as stimuli in simulations. - - -### Log Collector Script - -Users can profit of running multiple simulations automatically with -[DRAMSylva.sh]. - -Every time you run the script you get a new folder with the name containing -the execution time: dram.sys\_YYYY\_MM\_DD-HH.MM.SS. - -Example on how to run the script: - -```bash -$ cd DRAMSys/library/resources/scripts/DRAMSylva -$ bash DRAMSylva.sh -``` - -To see the generated plots and CSV files: - -```bash -$ nautilus dram.sys_YYYY_MM_DD-HH.MM.SS/build/simulator -``` - -In that folder you will find plots as PDF files and CSV files with the output -data used to generate the plots. The CSV files are: - -- **out.csv** (energy, average power, bandwidth, etc.) - -- **metrics.csv** (DRAMSys metrics like average response latency, memory - utilization and many others) - -Use the command below to find all generated CSV files: - -```bash -$ ls -l dram.sys_YYYY_MM_DD-HH.MM.SS/build/simulator/*.csv -``` - -The generated CSV files can be open in a spreadsheet program for further -manipulation. - -Set the variable **create_comparison_plots** to **yes** in order to get plots -for quick comparison from the CSV files generated. - -```bash -create_comparison_plots="yes" -``` - -Additionally, the database files (\*.tdb) generated will be available and can -be open with the traceAnalyzer tool for debugging, plot generation, etc. - -Set the variable **create_analyzer_plots** to **yes** in order to get plots -generated from the trace databases (the same plots generated by the trace -analyzer tool). **Note**: enabling this option may incur extra time for -database manipulation and plot generation. Depending on the size and amount of -database files it may take long to finish. - -```bash -create_analyzer_plots="yes" -``` - -A DRAMSys simulation is defined by the main configuration file passed to the -simulator. The main configuration file includes other files which contain -specifc configs. -You can change what is going to be simulated by the script by editing it. -There is a list of main configuration files on the top of the script: - -```bash -sim_files=" -ddr3-example.json -ddr3-single-device.json -wideio-example.json -" -``` - -Simulation files are expected to be available (already commited and pushed to -be available after cloning) in the [simulation folder](DRAMSys/library/resources/simulations). - -Set the variable **use_trace_list** to **yes** in order to use all traces in -the **trace list** with all simulation files. Each pair generates a new simulation -with the original trace specified in the simulation file replaced by a trace -from the list. Otherwise it runs a simulation per simulation file using the -trace specified in the simulation file. Files are expected to be available -(already commited and pushed to be available after cloning) in the -[traces folder](DRAMSys/library/resources/traces). - -```bash -use_trace_list="yes" -``` - -```bash -trace_list=" -chstone-bf_32.stl -chstone-jpeg_32.stl -chstone-adpcm_32.stl -mediabench-unepic_32.stl -" -``` - -The script runs one instance of DRAMSys for each of the files in the list. -**The multiple instances run in parallel**. - -If some traces in trace_list are compressed in a tar.gz and require -decompression before execution the option **tgz_traces** can be set to -**yes**. The tarball is specified by the variable **tgz_file** and it is -expected to be available (already commited and pushed to be available after -cloning) in the [trace folder](DRAMSys/library/resources/traces). -[DRAMSylva.sh] will uncompress the tarball extracting the traces before using -them. - -```bash -tgz_traces="yes" -tgz_file="rgr_traces_flauer_ddr4_8b.tar.gz" -``` - -Set the variable **use_json_cfg** to **yes** in order to override sim_files -with new simulation files generated from a JSON description. Otherwise the -simulation files are the ones specified by sim_files. Files are expected to be -available (already commited and pushed to be available after cloning) in -[configs_json]. - -```bash -use_json_cfg="yes" -``` - -All the essential simuation files are auto generated accordingly to each of -the JSON descriptions provided in **json_cfg_list**. Several examples of JSON -configuration files are provided in [configs_json]. - -+ Insert the desired simulation data in one or multiple JSON files following - any of the examples provided, e.g., - [**configs.json**](DRAMSys/library/resources/scripts/DRAMSylva/configs_json/configs.json). - Multiple arrays are allowed and encouraged. Each array corresponds to a full - simulation setup. - -+ Add your JSON files to **json_cfg_list** in [DRAMSylva.sh]. - -```bash -json_cfg_list=" -ref.json -ref_bw.json -" -``` - -+ Commit and push your changes. - -+ Run **[DRAMSylva.sh]** as previously described. All generated files will be - inside the output folder, so it will be possible to keep a perfect track of - all simulations. - -For more information check the documentation inside [DRAMSylva folder]. - -### Trace Generator Script - -The [trace_gen](DRAMSys/library/resources/scripts/trace_gen.py) script for -generating input traces for simple tests is provided. - -Example on how to run the script: - -```bash -$ cd DRAMSys/library/resources/scripts -$ ./trace_gen.py > trace.stl -``` - -Now change your configuration file to use the new generated trace file and run -your simulation. - -The script can be easily changed and provides a way to quickly generate -accesses to all channels, all bank groups, all banks, all rows and all columns -of a memory. - -**Be aware that a trace which covers all rows and all columns may be huge -(several gigabytes) depending on your memory.** - -The defaul values in the script serve as an example. They consider the address -mapping that follows. - -``` -DDR3-SDRAM DIMM Characteristics: -Byte Offset (Y): 8 [0:2] (8-byte-wide memory module, i.e., 64-bit-wide data bus) -> 3 bit -Cols (C): 1K [3:12] (A0 - A9) -> 10 bit -Rows (R): 128K [13:29] (A0 - A16) -> 17 bit -Bank (B): 8 [30:32] (BA0 - BA2) -> 3 bit - -3 3 3 | 2 2 2 2 2 2 2 2 2 2 1 1 1 1 1 1 1 | 1 1 1 -2 1 0 | 9 8 7 6 5 4 3 2 1 0 9 8 7 6 5 4 3 | 2 1 0 9 8 7 6 5 4 3 | 2 1 0 -B B B | R R R R R R R R R R R R R R R R R | C C C C C C C C C C | Y Y Y -``` - -The parameters for the address mapping just described are presented below. - -``` -# Channel information. -num_ch = 1 # Number of channels -ch_shift = 34 # Shift to reach the frist bit reserved for channels in the address -ch_mask = 0x1 # Mask for all channel bits in the address - -# Bank group information. -num_bank_groups = 1 # Number of bank groups -bgroup_shift = 33 # Shift to reach the frist bit reserved for bank groups in the address -bgroup_mask = 0x1 # Mask for all bits in the address related to bank groups - -# Bank information -num_banks = 8 # Number of banks -bank_shift = 30 # Shift to reach the frist bit reserved for banks in the address -bank_mask = 0x7 # Mask for all bank bits in the address - -# Row information -num_rows = 128 * 1024 # Number of rows -row_shift = 13 # Shift to reach the frist bit reserved for rows in the address -row_mask = 0x1ffff # Mask for all row bits in the address - -# Column information -num_col = 1 * 1024 # Number of columns -col_shift = 3 # Shift to reach the frist bit reserved for columns in the address -col_mask = 0x3ff # Mask for all column bits in the address - -# Burst length -burst_len = 8 -``` - -Open the script with a text editor and change some parameters to fit your -needs. - -#### DRAMsys Diagrams - -- **TLM Approximately Timed (AT)** - - The figure below shows a cheat sheet with the possibilities that the TLM AT protocol - offers. The annotated references [X,Y] are placed into the source code for a better - orientation. - - ![TLM AT Cheat Sheet](DRAMSys/docs/images/tlmATCheatSheet.png) - - -- **Payload Extension information** - - GenerationExtension is added in TracePlayer and DramExtension is added in Arbiter. - - DramExtension indicates the decoded address (channel, bank, colums, row) and - the socket id (thread) of a payload. It is added in the Arbiter and is sent - to the Controller. - ![Payload Extension information](DRAMSys/docs/images/PayloadExtension.png) - -- **Transaction object with Memory Manager** - - The TracePlayer allocates the memory for the transaction object by calling allocatePayload method. - - The acquire method is called before passing the transaction object in TracePlayer, Arbiter and Controller. - - The release method is called after each component is done with the transaction object. After the final call of release method, the free method of the memory manager is called to free the transaction object. - - ![Payload Memory Manager](DRAMSys/docs/images/PayloadMemoryManager.png) - -- **Architecture of the backend TLM model** - - The below figure shows our custom TLM protocol between the Controller and the Dram. A new transaction enters the Controller with the BEGIN_REQ phase is stored in frontendPEQ. The callback function of the frontendPEQ is called and send the payload to the Scheduler. - - The Scheduler checks the address of payload and the current state to determine proper command (Active, Precharge, Read or Write). Then the ControllerCore sends the payload with the corresponding phase (BEGIN_ACT, BEGIN_PRE, BEGIN_RD or BEGIN_WR) to the Dram by calling nb_transport_fw method. - - The Dram receives the transaction then send back to the Controller by calling nb_transport_bw with appropriate END phase (END_ACT, END_PRE, END_RD or END_WR). - - ![Architecture backend TLM](DRAMSys/docs/images/TransactionPhase.png) - -### DRAMSys Thermal Simulation +### DRAMSys with Thermal Simulation The thermal simulation is performed by a **3D-ICE** [8] server accessed through the network. Therefore users interested in thermal simulation during their DRAMSys simulations need to make sure they have a 3D-ICE server up and -running before starting. For more information about 3D-ICE visit the [official website](http://esl.epfl.ch/3D-ICE). +running before starting. For more information about 3D-ICE visit the [official website](https://www.epfl.ch/labs/esl/open-source-software-projects/3d-ice/). -#### Installing the lastest 3D-ICE version +#### Installing 3D-ICE -[Download](https://www.epfl.ch/labs/esl/open-source-software-projects/3d-ice/3d-ice-download/) the lastest version. Make sure you got version 2.2.6 or greater: - -```bash -$ wget https://www.epfl.ch/labs/esl/wp-content/uploads/2018/12/3d-ice-latest.zip -$ unzip 3d-ice-latest.zip -``` - -Install [SuperLU](http://crd-legacy.lbl.gov/~xiaoye/SuperLU/superlu_5.2.1.tar.gz) dependencies: +Install SuperLU dependencies: ```bash $ sudo apt-get install build-essential git bison flex libblas-dev @@ -1014,8 +406,7 @@ $ cd SuperLU_4.3/ $ cp MAKE_INC/make.linux make.inc ``` -Make sure the SuperLUroot variable in ./make.inc is properly set. For example, -if you downloaded it to your home folder set as follows. +Make sure the *SuperLUroot* variable in *make.inc* is properly set. For example, if you downloaded it to your home folder set as follows: ```bash SuperLUroot = $(HOME)/SuperLU_4.3 @@ -1038,889 +429,56 @@ $ make $ sudo make install ``` -Go to the 3d-ice directory: +[Download](https://www.epfl.ch/labs/esl/open-source-software-projects/3d-ice/3d-ice-download/) the lastest version of 3D-ICE. Make sure you got version 2.2.6 or greater. + +Unzip the archive and go to the 3D-ICE directory: ```bash -$ cd 3d-ice-2.2.6 +$ unzip 3d-ice-latest.zip +$ cd 3d-ice-latest/3d-ice-2.2.6 ``` -Open the file makefile.def and set some variables. Set the correct path to the -SuperLU library you just compiled. +Open the file makefile.def and set some variables. ```bash SLU_MAIN = $(HOME)/SuperLU_$(SLU_VERSION) -``` - -Set the YACC variable to bison-2.4.1: - -```bash YACC = bison-2.4.1 -``` - -Set the following variables with proper values. - -```bash SYSTEMC_ARCH = linux64 -SYSTEMC_MAIN = $(HOME)/systemc-2.3.1a +SYSTEMC_MAIN = $(HOME)/systemc-2.3.3 ``` Compile 3D-ICE with SystemC TLM-2.0 support: ```bash -$ make clean $ make SYSTEMC_WRAPPER=y ``` -Users interested in thermal simulation can also add some extra environment -variables: +Export the environment variable *LIBTHREED_ICE_HOME*: ```bash -# Necessary for thermal simulation -export LIBTHREED_ICE_HOME= -export LIBSUPERLU_HOME= +export LIBTHREED_ICE_HOME=${HOME}/3d-ice-latest/3d-ice-2.2.6 ``` #### Running DRAMSys with Thermal Simulation -Before starting make sure you have a **clean repository** without any previous -automatic generated Makefiles. One way to ensure this is by running the -command below inside your DRAMSys repository, but keep in mind that -**untracked files and directories will be removed** from the repository. +In order to run DRAMSys with thermal simulation you have to rerun CMake and rebuild the project. + +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. ```bash -$ git clean -fdx -``` - -This feature can be enabled via an environment variable. - -```bash -$ export THERMALSIM=true -$ qtcreator & -``` - -or - -```bash -$ mkdir build -$ cd build -$ export THERMALSIM=true -$ qmake ../DRAMSys/DRAMSys.pro -$ make -``` - -Before starting DRAMSys it is necessary to run the 3D-ICE server passing to it -two arguments: a suitable configuration file and an Internet socket port -number. And then wait until the server is ready to receive requests. - -```bash -$ 3D-ICE-Server +$ cd DRAMSys/DRAMSys/library/resources/configs/thermalsim +$ ~/3d-ice-latest/3d-ice-2.2.6/bin/3D-ICE-Server stack.stk 11880 Preparing stk data ... done ! Preparing thermal data ... done ! Creating socket ... done ! -Waiting for client ... done ! +Waiting for client ... ``` -The IP address and the port number related to the server shall be informed in -DRAMSys' configuration to subsequent use by DRAMSys to access the thermal -simulation server. - -#### Usage Example with Thermal Simulation - -Generate the input trace file for DRAMSys. +In another terminal or terminal tab start DRAMSys with the special thermal simulation config: ```bash -$ cd DRAMSys/tests/error/ -$ ./generateErrorTest.pl > test_error.stl -``` - -Start the 3D-ICE server providing the stack file and the port number. - -```bash -$ cd DRAMSys/library/resources/configs/thermalsim -$ 3D-ICE-Server stack.stk 11880 -``` - -In another terminal or terminal tab start DRAMSys. Here the program's output -is redirected to a file. - -```bash -$ cd build/simulator/ -$ ./DRAMSys > output -``` - -## DRAMSys with gem5 - -Install gem5 by following the instructions on the [gem5 wiki](http://gem5.org/Documentation#Getting_Started). -Optionally, use the scripts from [gem5.TnT] to install gem5, build it, get some benchmark programs and learn more about gem5. - -In order to understand the SystemC coupling with gem5 it is recommended to -read the documentation in the gem5 repository *util/tlm/README* and [12]. - -The main steps for building gem5 and libgem5 follow: - -```bash -scons build/ARM/gem5.opt -``` - -```bash -scons --with-cxx-config --without-python --without-tcmalloc build/ARM/libgem5_opt.so -``` - -For MacOS: - -```bash -scons --with-cxx-config --without-python --without-tcmalloc build/ARM/libgem5_opt.dylib -``` - -In order to use gem5 with DRAMSys set the **GEM5** environment variable to the -path to gem5, for example in the *QtCreator under Projects > Build -& Run > Build Environment*: - -``` -GEM5=/path/to/gem5/ -``` - -Example: - -``` -GEM5=$HOME/gem5_tnt/gem5 -``` - -Optionally, export environment variables in your **~/.bashrc** file or -equivalent and open a new terminal: - -```bash -# In this example gem5 is located at $HOME/gem5_tnt/gem5. -export GEM5=$HOME/gem5_tnt/gem5 - -# Add the folder containing libgem5_opt.so to the list where libraries should -# be searched for. -export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${GEM5}/build/ARM -``` - -The project file [DRAMSys.pro](DRAMSys/DRAMSys.pro) checks whether the -environment variable **GEM5** is defined or not and configures automatically -the corresponding build target **gem5** for QtCreator. - -In order to run gem5 with DRAMSys it is mandatory to run gem5 first without -DRAMSys and generate a configuration file **config.ini** which will be the -value of the second parameter passed to DRAMSys_gem5. - -### DRAMSys with gem5 traffic generator - -In the following we will run a simple example with a gem5 traffic generator: - -``` -Base System Architecture: -+-------------+ +------+ ^ -| System Port | | TGEN | | -+-------+-----+ +--+---+ | - | | | gem5 World - | +----+ | - | | | -+-------v------v-------+ | -| Membus | v -+---------------+------+ External Port (see sc_slave_port.*) - | ^ - +----v----+ | TLM World - | DRAMSys | | (see sc_target.*) - +---------+ v - -``` - -As mentioned before we first need to create a config.ini -that represents the gem5 configuration. We do so by starting gem5 with the -desired python configuration script. - -```bash -cd gem5/utils/tlm/ -../../build/ARM/gem5.opt conf/tlm_slave.py -``` - -**Ignore the message below.** -``` -"fatal: Can't find port handler type 'tlm_slave'" -``` - -The configuration file config.ini will be stored in the **m5out** directory. -Copy this configuration file to the building directory of DRAMSys where the -executable **DRAMSys_gem5** is located: - -``` -dram.sys/build-DRAMSys-Desktop_Qt_5_7_0_clang_64bit-Debug/gem5 -``` - -Also the traffic generatior configuration file (conf/tgen.cfg) must be stored -in a conf directory of this building directory. - -Then the simulation can be started with: - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json config.ini 1 -``` - -Let the simulation run for some seconds and then stop it with **CTRL-C**. -Observe the output of the simulation in the trace analyzer. The trace database -can be found inside the gem5 directory in the building directory. - -### Gem5 SE mode and DRAMSys - -All essential files for some functional examples are provided. - -Execute a hello world application: - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/configs/hello.ini 1 -``` - -A **Hello world!** message should be printed to the standard output. - -Execute applications: - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/Oscar/config.ini 1 -``` - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/Bubblesort/config.ini 1 -``` - -Wait some minutes for the application to finish. - -The hello application binary was copied from gem5 repository. - -Other applications were obtained with [gem5.TnT]. - -Command template for generating **.ini** configuration files follows: - -```bash -build/ARM/gem5.opt configs/example/se.py \ - -c --mem-size=512MB --mem-channels=1 \ - --caches --l2cache --mem-type=SimpleMemory \ - --cpu-type=TimingSimpleCPU --num-cpu=1 \ - --tlm-memory=transactor -``` - -An overview of the architcture being simulated is presented below: - -![arch](DRAMSys/docs/images/gem5_se_mode_arch.png) - -**Note**: this is a gem5 generated file, therefore DRAMSys is omitted. DRAMSys is -direct connected as external tlm slave. - -**Note**: workaround in se.py required: - -```python -... -if options.tlm_memory: - system.physmem = SimpleMemory() -MemConfig.config_mem(options, system) -... -``` - -A convenience script to execute several applications automatically -[**run.sh**](DRAMSys/gem5/gem5_se/run.sh) is provided . Take a look and learn -from it. - -### [PARSEC] FS Mode - -Full system simulation files for ARM available in [DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB](DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB). - -Choose the benchmark in [parsec_arm_minor_2c_8GB.rcS](DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB/parsec_arm_minor_2c_8GB.rcS). - -Edit the paths in [config.ini](DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB/config.ini). - -All files required to build DRAMSys_gem5 and execute the simulation (gem5 -library, benchmarks, disk image, etc.) can be obtained with [gem5.TnT]. - -Start a simulation. Example: - -```bash -dram.sys/build/gem5$ ./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/rgrsim-gem5-fs.json ../../DRAMSys/gem5/gem5_fs/parsec_arm_minor_2c_8GB/config.ini 1 -``` - -Optionally, open another terminal or tab and connect to gem5. - -```bash -$ telnet localhost 3456 -``` - -Note: the port may vary, gem5 prints it during initialization. Example: - -``` -system.terminal: Listening for connections on port 3456 -``` - -### [PARSEC] SE Mode - - -Binaries and gem5 SE configuration files for ARM available in [DRAMSys/gem5/gem5_se/parsec-arm](DRAMSys/gem5/gem5_se/parsec-arm). - -Use [gem5.TnT] to download parsec. Example: - -Go to your **gem5.TnT** folder. Then go to **arch/arm** folder. Execute the -script *build-parsec-serial.sh*. - -```bash -gem5.TnT/arch/arm$ ./build-parsec-serial.sh -``` - -Extract inputs files. Example: - -```bash -cd $HOME/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs -tar -xf input_simdev.tar -tar -xf input_test.tar -tar -xf input_simmedium.tar -tar -xf input_simsmall.tar -tar -xf input_native.tar -tar -xf input_simlarge.tar - -cd $HOME/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs -tar -xf input_simdev.tar -tar -xf input_test.tar -tar -xf input_native.tar -tar -xf input_simlarge.tar -tar -xf input_simmedium.tar -tar -xf input_simsmall.tar - -cd $HOME/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs -tar -xf input_simdev.tar -tar -xf input_test.tar -tar -xf input_native.tar -tar -xf input_simlarge.tar -tar -xf input_simmedium.tar -tar -xf input_simsmall.tar -``` - -Open [DRAMSys/gem5/gem5_se/parsec-arm/config.ini](DRAMSys/gem5/gem5_se/parsec-arm/config.ini) - -Edit **cmd=**. - -Edit **executable=**. - -Examples (**Replace USER. Use the correct path in your computer.**): - -``` --- canneal -- - -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 5 100 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/10.nets 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 100 300 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/100.nets 2 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 10000 2000 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/100000.nets 32 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 15000 2000 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/200000.nets 64 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal 1 15000 2000 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/kernels/canneal/inputs/400000.nets 128 - -executable=../../DRAMSys/gem5/gem5_se/parsec-arm/canneal/canneal - --- streamcluster -- - -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 2 5 1 10 10 5 none output.txt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 3 10 3 16 16 10 none output.txt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 10 20 32 4096 4096 1000 none output.txt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 10 20 64 8192 8192 1000 none output.txt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 10 20 128 16384 16384 1000 none output.txt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster 10 20 128 1000000 200000 5000 none output.txt 1 - -executable=../../DRAMSys/gem5/gem5_se/parsec-arm/streamcluster/streamcluster - --- swaptions -- - -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 1 -sm 5 -nt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 3 -sm 50 -nt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 16 -sm 5000 -nt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 32 -sm 10000 -nt 1 -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions -ns 64 -sm 20000 -nt 1 - -executable=../../DRAMSys/gem5/gem5_se/parsec-arm/swaptions/swaptions - --- fluidanimate -- - -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_5K.fluid out.fluid -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 3 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_15K.fluid out.fluid -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 5 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_35K.fluid out.fluid -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 5 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_100K.fluid out.fluid -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate 1 5 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/fluidanimate/inputs/in_300K.fluid out.fluid - -executable=../../DRAMSys/gem5/gem5_se/parsec-arm/fluidanimate/fluidanimate - --- blackscholes -- - -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_4.txt prices.txt -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_16.txt prices.txt -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_4K.txt prices.txt -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_16K.txt prices.txt -cmd=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes 1 /home/USER/gem5_tnt/benchmarks/parsec-3.0/pkgs/apps/blackscholes/inputs/in_64K.txt prices.txt - -executable=../../DRAMSys/gem5/gem5_se/parsec-arm/blackscholes/blackscholes - -``` - -Start a simulation. Example: - -```bash -dram.sys/build/gem5$ ./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/rgrsim-gem5-se.json ../../DRAMSys/gem5/gem5_se/parsec-arm/config.ini 1 -``` - -### Boot Linux with gem5 and DRAMSys - -The procedure is very similar to the traffic generator example above. - -First we have to generate the config.ini file by starting gem5 with the following configuration: - -```bash -build/ARM/gem5.opt configs/example/fs.py \ - --tlm-memory=transactor --cpu-type=TimingSimpleCPU --num-cpu=1 \ - --mem-type=SimpleMemory --mem-size=512MB --mem-channels=1 --caches \ - --l2cache --machine-type=VExpress_EMM \ - --dtb-filename=vexpress.aarch32.ll_20131205.0-gem5.1cpu.dtb \ - --kernel=vmlinux.aarch32.ll_20131205.0-gem5 \ - --disk-image=linux-aarch32-ael.img -``` - -The config.ini should be copied again to the DRAMSys_gem5 build folder. - -The simconfig should be changed in order to support storage and address offsets: - -``` json -{ - "simconfig": { - "CheckTLM2Protocol": false, - "DatabaseRecording": true, - "Debug": false, - "ECCControllerMode": "Disabled", - "EnableWindowing": false, - "ErrorCSVFile": "", - "ErrorChipSeed": 42, - "NumberOfDevicesOnDIMM": 8, - "NumberOfMemChannels": 1, - "PowerAnalysis": false, - "SimulationName": "ddr3", - "SimulationProgressBar": true, - "ThermalSimulation": false, - "WindowSize": 1000, - - "StoreMode": "Store", - "AddressOffset": 2147483648, - "UseMalloc": true - } -} -``` - -Then start DRAMSys_gem5 with the following command: - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json config.ini 1 -``` - -For further sophisticated address mappings or scenarios checkout the file DRAMSys/gem5/main.cpp - -#### Boot Linux with gem5 and DRAMSys Example - -**All essential files for a functional example are provided.** - -Unzip the disk image: - -```bash -tar -xaf DRAMSys/gem5/boot_linux/linux-aarch32-ael.img.tar.gz -C DRAMSys/gem5/boot_linux/ -``` - -Execute the example: - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-boot-linux.json ../../DRAMSys/gem5/configs/boot_linux.ini 1 -``` - -Open a new terminal and connect to gem5: - -```bash -telnet localhost 3456 -``` - -Wait some minutes for the Linux boot process to complete then login. Username is -**root** no password required. - - -### DRAMSys with gem5 Elastic Traces - -For understanding elastic traces and their generation, study the [gem5 -wiki](http://gem5.org/TraceCPU) and the paper [13]. -Some predefined configs are stored [here](DRAMSys/gem5/configs) and the related -python files are stored [here](DRAMSys/gem5/examples). - -This is an example for running an elastic trace: - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json ../../DRAMSys/gem5/configs/singleElasticTraceReplay.ini 1 -``` - -An overview of the architcture being simulated is presented below: - -![arch](DRAMSys/docs/images/singleElasticTraceReplay.png) - -Note that the address offset is usually zero for elastic traces. - -Another example with L2 cache: - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json ../../DRAMSys/gem5/configs/singleElasticTraceReplayWithL2.ini 1 -``` - -If two elastic traces should be used run the simulation with the following example: - -``` -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-example.json ../../DRAMSys/gem5/configs/dualElasticTraceReplay.ini 2 -``` - -An overview of the architcture being simulated is presented below: - -![arch](DRAMSys/docs/images/dualElasticTraceReplay.png) - -For more spophisticated setups, even with l2 caches the proper ini file should be created. -If you need help please contact Matthias Jung. - -### DRAMSys + GEM5 Log Collector Scripts - -Users can profit of running multiple **DRAMSys + gem5** simulations -automatically with [gem5ilva.sh] for **gem5 syscall emulation (SE) mode** and -[gem5ilva_fs.sh] for **gem5 full system (FS) mode**. - -Normally you will have to push your changes before running the scripts. This -approach makes it easier to track back what exactly was tested by the scripts. - -The scripts provide variables that tell **git** where to get the source -code from (repository URL), user name to be used (your git account), -**branch** to checkout (your working branch), etc. They are: - -```bash -# Git info. -git_user="$USER" -git_branch="master" -git_url="git.eit.uni-kl.de:ems/astdm/dram.sys.git" -git_url_https="git.eit.uni-kl.de/ems/astdm/dram.sys.git" -``` - -The default values of the variables presented above assume that your git -account uses the same name as your user name in your PC. If that is not the -case, replace the value of the **git_user** variable with your git account -name. Similarly, replace the value of the variable **git_branch** with your -working branch name. There (in your working branch) you can push your changes -and/or new files before executing the scripts. - -Open the script in QtCreator or another text editor of your choice and set the -variables with values that fit your needs. - -Nevertheless, for some cases, you may want to have gem5 essential files out of -the main repository (usually because they are too big to be added to the -repository). - -For those cases uncomment and properly set the variable -**external_inifile_path** in [gem5ilva_fs.sh]. - -This allows you to use a gem5 **config.ini** file external to the repository. -Note, however, that in this case it is up to you to keep track of your -simulation setup. - -**Hint:** -[gem5.TnT] provides convenience scripts -to create gem5 disk images with benchmarking programs embedded. - -### Notes for [Elwetritsch] Users - -Firstly, take a look at [High Performance Computing at the TU Kaiserslautern](https://elwe.rhrk.uni-kl.de/). - -After that, please give yourself a change to learn a bit about [Batch Usage at -RHRK TU Kaiserslautern](https://elwe.rhrk.uni-kl.de/elwetritsch/batch.shtml). -This will probably save you some time later on. - -When using DRAMSys + gem5 on the [Elwetritsch] gem5 can be installed with -convenience scripts provided by [gem5.TnT]. - -[gem5.TnT] also provides convenience scripts -to create gem5 disk images with benchmarking programs embedded. The creation -of disk images for gem5 requires superuser privilege. A solution is to copy -(e.g., using scp or mounting a folder, etc.) the locally created disk images -to [Elwetritsch]. Since there is no compilation involved, copying disk images -created in one machine to another machine should not incur in incompatibility -problems. - -On [gem5.TnT] repository open a [gem5.TnT] config file. - -```bash -$ vim common/defaults.in -``` - -Note the variable **ROOTDIR**. Its default value is *ROOTDIR=$HOME/gem5_tnt*. -That means that [gem5.TnT] will download to *$HOME/gem5_tnt*. - -Currently the space one can use in its Elwetrich *$HOME* folder is limited to -a few tens of GiB. Nevertheless, a directory **/scratch/$USER** is provided -with less space restrictions. - -One can create a symlink pointing to **/scratch/$USER/gem5_tnt**. - -```bash -$ cd $SCRATCH -$ mkdir gem5_tnt -$ cd -$ ln -s /scratch/$USER/gem5_tnt -``` - -On [gem5.TnT] repository use the commands below to get files and build gem5: - -```bash -$ ./get_essential_fs.sh -$ ./get_benchmarks.sh -$ ./get_extra_fs.sh -$ ./build_gem5.sh -``` - -To get DRAMSys installed follow the traditional setup instructions described -in this document. - -For building DRAMSys one can profit from using [DRAMSylva.sh] which loads the -modules that are necessary for building DRAMSys on [Elwetritsch]. - -Regarding dependencies for building DRAMSys and DRAMSys + gem5, the scripts -provided inside the [DRAMSylva folder], when running on [Elwetritsch], will -load the required modules automatically. - -As usual, one may export environment variables from his/her **~/.bashrc** file -on Elwetritch. Some segments extracted from a functional ~/.bashrc file are -presented below to be used as reference. Note that you may have to adapt it, -for example, changing paths to point to the place you installed some of the -libraries. - -```bash -# User specific aliases and functions -# SystemC home -export SYSTEMC_HOME=$HOME/systemc-2.3.1a -# SystemC target architecture -export SYSTEMC_TARGET_ARCH=linux64 - -# Qwt lib -export LIBQWT_HOME=$HOME/qwt-6.1/lib -export LIBQWT_HEADERS=$HOME/qwt-6.1/src -export LD_LIBRARY_PATH=${LD_LIBRARY_PATH:+${LD_LIBRARY_PATH}:}$LIBQWT_HOME - -# Python lib -export LIBPYTHON_VERSION="3.6m" -export PYTHON_HOME=/usr/lib64 -export PYTHON_HEADERS=/usr/include/python3.6m - -# Gem5 + DRAMsys -export GEM5=$HOME/gem5_tnt/gem5 - -# Gem5 SystemC TLM-2.0 coupling (see also: $HOME/gem5_tnt/gem5/util/tlm/README) -export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${GEM5}/build/ARM -export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${SYSTEMC_HOME}/lib-$SYSTEMC_TARGET_ARCH -export PKG_CONFIG_PATH=${PKG_CONFIG_PATH}:${SYSTEMC_HOME}/lib-$SYSTEMC_TARGET_ARCH/pkgconfig - -# M5_PATH for gem5 -export M5_PATH=$HOME/gem5_tnt/full_system/arm/aarch-system-20180409 - -# Do not close my terminal when inactive after a timeout -unset TMOUT -``` - -[SLURM](https://slurm.schedmd.com/overview.html) **job scripts** are available -inside the [DRAMSylva folder]. They can be used directly without changes or as -examples on how to start jobs using nodes of the [Elwetritsch] cluster. Of -course, one can create his/her own job scripts. - - -### Coverage Check - -Coverage check is enabled by default and can be disabled with an environment -variable. - -```bash -export DRAMSYS_DISABLE_COVERAGE_CHECK=1 -``` - -### DRAMSys + GEM5 x86 - -Make sure you have built **gem5/build/X86/libgem5_opt.so**. If you build with -[gem5.TnT] you can check if the library exists as follows. - -```bash -$ ls $HOME/gem5_tnt/gem5/build/X86/libgem5_opt.so -``` - -Change your ~/.bashrc. - -```bash -# In this example gem5 is located at $HOME/gem5_tnt/gem5. -export GEM5=$HOME/gem5_tnt/gem5 - -# Add the folder containing libgem5_opt.so to the list where libraries should -# be searched for. -#export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${GEM5}/build/ARM -export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:${GEM5}/build/X86 -``` - -After that close QtCreator and all terminals. - -Open a new terminal. - -Change the architecture in [DRAMSys/gem5/gem5.pro](DRAMSys/gem5/gem5.pro). - -``` -gem5_arch = 'X86' -``` - -Delete the file **DRAMSys/DRAMSys.pro.user** from the repository. - -```bash -$ rm DRAMSys/DRAMSys.pro.user -``` - -Open a new QtCreator. - -Build DRAMSys as usual. - -After building, go the the folder where *DRAMSys_gem5* is located. - -Test with a hello world application for X86. - -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/hello-x86/config.ini 1 -``` - -A **Hello world!** message should be printed to the standard output. - -### [MiBench] - -Applications for x86 and configuration files available in [DRAMSys/gem5/gem5_se/MiBench](DRAMSys/gem5/gem5_se/MiBench). - -Examples: - -**Automotive Applications** - -**Basicmath** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/basicmath/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/basicmath/large/config.ini 1 -``` - -**Bitcount** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/bitcount/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/bitcount/large/config.ini 1 -``` - -**Qsort** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/qsort/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/qsort/large/config.ini 1 -``` - -**Susan** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/small/corners/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/large/corners/config.ini 1 - -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/small/edges/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/large/edges/config.ini 1 - -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/small/smoothing/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/automotive/susan/large/smoothing/config.ini 1 -``` - -**Network Applications** - -**Dijkstra** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/network/dijkstra/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/network/dijkstra/large/config.ini 1 -``` - -**Patricia** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/network/patricia/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/network/patricia/large/config.ini 1 -``` - -**Security Applications** - -**Blowfish Encode** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/blowfish/encode/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/blowfish/encode/large/config.ini 1 -``` - -**Blowfish Decode** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/blowfish/decode/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/blowfish/decode/large/config.ini 1 -``` - -**SHA** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/sha/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/security/sha/large/config.ini 1 -``` - -**Telecom Applications** - -**CRC32** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/crc32/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/crc32/large/config.ini 1 -``` - -**FFT** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/fft/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/fft/large/config.ini 1 -``` - -**FFT-INV** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/fft-inv/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/fft-inv/large/config.ini 1 -``` - -**GSM Encode** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/gsm/encode/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/gsm/encode/large/config.ini 1 -``` - -**GSM Decode** -```bash -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/gsm/decode/small/config.ini 1 -./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/ddr3-gem5-se.json ../../DRAMSys/gem5/gem5_se/MiBench/telecomm/gsm/decode/large/config.ini 1 -``` - -Check the folder [DRAMSys/gem5/gem5_se/MiBench](DRAMSys/gem5/gem5_se/MiBench) for all applications and configuration files. - -### More AARCH64 Apps - -Full system simulation files for ARM available in [DRAMSys/gem5/gem5_fs/arm64](DRAMSys/gem5/gem5_fs/arm64). - -You can edit [arm64.rcS](DRAMSys/gem5/gem5_fs/arm64/arm64.rcS) to start an application and call *m5 exit* when it finishes. - -Edit the paths in [config.ini](DRAMSys/gem5/gem5_fs/arm64/config.ini). - -All files required to build DRAMSys_gem5 and execute the simulation (gem5 -library, benchmarks, disk image, etc.) can be obtained with [gem5.TnT]. - -Start a simulation. Example: - -```bash -dram.sys/build/gem5$ ./DRAMSys_gem5 ../../DRAMSys/library/resources/simulations/rgrsim-gem5-fs.json ../../DRAMSys/gem5/gem5_fs/arm64/config.ini 1 -``` - -Optionally, open another terminal or tab and connect to gem5. - -```bash -$ telnet localhost 3456 -``` - -Note: the port may vary, gem5 prints it during initialization. Example: - -``` -system.terminal: Listening for connections on port 3456 +$ cd DRAMSys/build/simulator/ +$ ./DRAMSys ../../DRAMSys/library/resources/simulations/wideio-thermal.json ``` ## References @@ -1971,14 +529,4 @@ Conference on Embedded Computer Systems Architectures Modeling and Simulation [13] Exploring System Performance using Elastic Traces: Fast, Accurate and Portable Radhika Jagtap, Stephan Diestelhorst, Andreas Hansson, Matthias Jung and Norbert Wehn, IEEE International Conference on Embedded Computer Systems -Architectures Modeling and Simulation (SAMOS), 2016, Samos Island, Greece. - -[gem5.TnT]: https://github.com/tukl-msd/gem5.TnT -[gem5ilva.sh]: DRAMSys/library/resources/scripts/DRAMSylva/gem5ilva.sh -[gem5ilva_fs.sh]: DRAMSys/library/resources/scripts/DRAMSylva/gem5ilva_fs.sh -[Elwetritsch]: https://elwe.rhrk.uni-kl.de/ -[DRAMSylva.sh]: DRAMSys/library/resources/scripts/DRAMSylva/DRAMSylva.sh -[DRAMSylva folder]: DRAMSys/library/resources/scripts/DRAMSylva -[configs_json]: DRAMSys/library/resources/scripts/DRAMSylva/configs_json -[MiBench]: http://vhosts.eecs.umich.edu/mibench/ -[PARSEC]: http://parsec.cs.princeton.edu/ +Architectures Modeling and Simulation (SAMOS), 2016, Samos Island, Greece. \ No newline at end of file From 3d3c9c2799f2598e8bf8690b96cca416ef0765d2 Mon Sep 17 00:00:00 2001 From: Lukas Steiner Date: Wed, 1 Jul 2020 16:11:52 +0200 Subject: [PATCH 2/8] Update resources. --- DRAMSys/gem5/README.md | 14 +++++++++-- README.md | 56 ++++++++++-------------------------------- 2 files changed, 25 insertions(+), 45 deletions(-) diff --git a/DRAMSys/gem5/README.md b/DRAMSys/gem5/README.md index d4966a95..31cff150 100644 --- a/DRAMSys/gem5/README.md +++ b/DRAMSys/gem5/README.md @@ -4,7 +4,7 @@ Install gem5 by following the instructions on the [gem5 wiki](http://gem5.org/Do Optionally, use the scripts from [gem5.TnT] to install gem5, build it, get some benchmark programs and learn more about gem5. In order to understand the SystemC coupling with gem5 it is recommended to -read the documentation in the gem5 repository *util/tlm/README* and [12]. +read the documentation in the gem5 repository *util/tlm/README* and [1]. The main steps for building gem5 and libgem5 follow: @@ -393,7 +393,7 @@ Wait some minutes for the Linux boot process to complete then login. Username is ### DRAMSys with gem5 Elastic Traces For understanding elastic traces and their generation, study the [gem5 -wiki](http://gem5.org/TraceCPU) and the paper [13]. +wiki](http://gem5.org/TraceCPU) and the paper [2]. Some predefined configs are stored [here](DRAMSys/gem5/configs) and the related python files are stored [here](DRAMSys/gem5/examples). @@ -670,6 +670,16 @@ Note: the port may vary, gem5 prints it during initialization. Example: system.terminal: Listening for connections on port 3456 ``` +[1] System Simulation with gem5 and SystemC: The Keystone for Full +Interoperability C. Menard, M. Jung, J. Castrillon, N. Wehn. IEEE International +Conference on Embedded Computer Systems Architectures Modeling and Simulation +(SAMOS), July, 2017, Samos Island, Greece. + +[2] Exploring System Performance using Elastic Traces: Fast, Accurate and +Portable Radhika Jagtap, Stephan Diestelhorst, Andreas Hansson, Matthias Jung +and Norbert Wehn, IEEE International Conference on Embedded Computer Systems +Architectures Modeling and Simulation (SAMOS), 2016, Samos Island, Greece. + [gem5.TnT]: https://github.com/tukl-msd/gem5.TnT [gem5ilva.sh]: DRAMSys/library/resources/scripts/DRAMSylva/gem5ilva.sh [gem5ilva_fs.sh]: DRAMSys/library/resources/scripts/DRAMSylva/gem5ilva_fs.sh diff --git a/README.md b/README.md index a820de3c..b82d0749 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@ DRAMSys4.0 =========== -**DRAMSys4.0** is a flexible DRAM subsystem design space exploration framework that consists of models reflecting the DRAM functionality, power consumption, temperature behavior and retention time errors. +**DRAMSys4.0** [1] [2] [3] is a flexible DRAM subsystem design space exploration framework that consists of models reflecting the DRAM functionality, power consumption, temperature behavior and retention time errors. Pipeline Status: [![pipeline status](https://git.eit.uni-kl.de/ems/astdm/dram.sys/badges/master/pipeline.svg)](https://git.eit.uni-kl.de/ems/astdm/dram.sys/commits/master) - [![Coverage report](https://git.eit.uni-kl.de/ems/astdm/dram.sys/badges/master/coverage.svg?job=coverage)](https://git.eit.uni-kl.de/ems/astdm/dram.sys/commits/master) ## Basic Setup Start using DRAMSys by cloning the repository. -Use the *--recursive* flag to initialize all submodules within the repository, namely **DRAMPower** [2], **SystemC** and **nlohmann json**. +Use the *--recursive* flag to initialize all submodules within the repository, namely **DRAMPower** [4], **SystemC** and **nlohmann json**. ### Dependencies -DRAMSys is based on the SystemC library. SystemC is included as a submodule and will be build automatically with the DRAMSys project. If you want to use an external SystemC version you have to export the environment variables *SYSTEMC_HOME* (SystemC root directory), *SYSTEMC_TARGET_ARCH* (e.g. linux64) and add the path of the library to *LD_LIBRARY_PATH*. +DRAMSys is based on the SystemC library. SystemC is included as a submodule and will be build automatically with the DRAMSys project. If you want to use an external SystemC version you have to export the environment variables `SYSTEMC_HOME` (SystemC root directory), `SYSTEMC_TARGET_ARCH` (e.g. linux64) and add the path of the library to `LD_LIBRARY_PATH`. ### Building DRAMSys DRAMSys uses CMake for the build process, the minimum required version is **CMake 3.10**. @@ -486,47 +485,18 @@ $ ./DRAMSys ../../DRAMSys/library/resources/simulations/wideio-thermal.json [1] TLM Modelling of 3D Stacked Wide I/O DRAM Subsystems, A Virtual Platform for Memory Controller Design Space Exploration M. Jung, C. Weis, N. Wehn, K. Chandrasekar. International Conference on High-Performance and Embedded Architectures and Compilers 2013 (HiPEAC), Workshop on: Rapid Simulation and Performance Evaluation: Methods and Tools (RAPIDO), January, 2013, Berlin. -[2] DRAMPower: Open-source DRAM Power & Energy Estimation Tool -Karthik Chandrasekar, Christian Weis, Yonghui Li, Sven Goossens, Matthias Jung, Omar Naji, Benny Akesson, Norbert Wehn, and Kees Goossens +[2] DRAMSys: A flexible DRAM Subsystem Design Space Exploration Framework +M. Jung, C. Weis, N. Wehn. IPSJ Transactions on System LSI Design Methodology (T-SLDM), October, 2015. + +[3] DRAMSys4.0: A Fast and Cycle-Accurate SystemC/TLM-Based DRAM Simulator +L. Steiner, M. Jung, F. S. Prado, K. Bykov, N. Wehn. International Conference on Embedded Computer Systems: Architectures, Modeling, and Simulation (SAMOS), July, 2020, Samos Island, Greece. + +[4] DRAMPower: Open-source DRAM Power & Energy Estimation Tool +K. Chandrasekar, C. Weis, Y. Li, S. Goossens, M. Jung, O. Naji, B. Akesson, N. Wehn, K. Goossens URL: http://www.drampower.info -[3] Energy Optimization in 3D MPSoCs with Wide-I/O DRAM -M. Sadri, M. Jung, C. Weis, N. Wehn, L. Benini. Conference Design, Automation and Test in Europe (DATE), March, 2014, Dresden, Germany. - -[4] DRAMSys: A flexible DRAM Subsystem Design Space Exploration Framework -M. Jung, C. Weis, N. Wehn. Accepted for publication, IPSJ Transactions on System LSI Design Methodology (T-SLDM), October, 2015. - [5] Optimized Active and Power-Down Mode Refresh Control in 3D-DRAMs -M. Jung, M. Sadri, C. Weis, N. Wehn, L. Benini., VLSI-SoC, October, 2014, Playa del Carmen, Mexico. +M. Jung, M. Sadri, C. Weis, N. Wehn, L. Benini. VLSI-SoC, October, 2014, Playa del Carmen, Mexico. [6] Retention Time Measurements and Modelling of Bit Error Rates of WIDE-I/O DRAM in MPSoCs -C. Weis, M. Jung, P. Ehses, C. Santos, P. Vivet, S. Goossens, M. Koedam, N. Wehn. Accepted for publication, IEEE Conference Design, Automation and Test in Europe (DATE), March, 2015, Grenoble, France - -[7] http://www.uni-kl.de/3d-dram/publications/ - -[8] A Sridhar, A Vincenzi, D Atienza, T Brunschwiler, 3D-ICE: a compact -thermal model for early-stage design of liquid-cooled ICs, IEEE Transactions -on Computers (TC 2013, accepted for publication). - -[9] A Sridhar, A Vincenzi, M Ruggiero, T Brunschwiler, D Atienza, 3D-ICE: Fast -compact transient thermal modeling for 3D-ICs with inter-tier liquid cooling, -Proceedings of the 2010 International Conference on Computer-Aided Design -(ICCAD 2010), San Jose, CA, USA, November 7-11 2010. - -[10] A Sridhar, A Vincenzi, M Ruggiero, T Brunschwiler, D Atienza, Compact -transient thermal model for 3D ICs with liquid cooling via enhanced heat -transfer cavity geometries, Proceedings of the 16th International Workshop on -Thermal Investigations of ICs and Systems (THERMINIC'10), Barcelona, Spain, -6-8 October, 2010. - -[11] http://esl.epfl.ch/3D-ICE - -[12] System Simulation with gem5 and SystemC: The Keystone for Full -Interoperability C. Menard, M. Jung, J. Castrillon, N. Wehn. IEEE International -Conference on Embedded Computer Systems Architectures Modeling and Simulation -(SAMOS), July, 2017, Samos Island, Greece. - -[13] Exploring System Performance using Elastic Traces: Fast, Accurate and -Portable Radhika Jagtap, Stephan Diestelhorst, Andreas Hansson, Matthias Jung -and Norbert Wehn, IEEE International Conference on Embedded Computer Systems -Architectures Modeling and Simulation (SAMOS), 2016, Samos Island, Greece. \ No newline at end of file +C. Weis, M. Jung, P. Ehses, C. Santos, P. Vivet, S. Goossens, M. Koedam, N. Wehn. IEEE Conference Design, Automation and Test in Europe (DATE), March, 2015, Grenoble, France From 92c32fdf15ed16212d0c379080cd297f96bc8a30 Mon Sep 17 00:00:00 2001 From: Lukas Steiner Date: Wed, 1 Jul 2020 16:31:01 +0200 Subject: [PATCH 3/8] Removed old images of readme. --- DRAMSys/docs/doxyCfg.cfg | 1228 ----- DRAMSys/docs/images/PayloadExtension.svg | 2449 --------- DRAMSys/docs/images/PayloadMemoryManager.svg | 4866 ----------------- DRAMSys/docs/images/TransactionPhase.svg | 2038 ------- DRAMSys/docs/images/am_sample1.svg | 1809 ------ DRAMSys/docs/images/am_sample2.svg | 1868 ------- DRAMSys/docs/images/am_wideio_brc.svg | 1734 ------ DRAMSys/docs/images/am_wideio_rbc.svg | 1748 ------ .../images/gem5_se_mode_arch.svg | 0 README.md | 52 +- 10 files changed, 26 insertions(+), 17766 deletions(-) delete mode 100644 DRAMSys/docs/doxyCfg.cfg delete mode 100644 DRAMSys/docs/images/PayloadExtension.svg delete mode 100644 DRAMSys/docs/images/PayloadMemoryManager.svg delete mode 100644 DRAMSys/docs/images/TransactionPhase.svg delete mode 100644 DRAMSys/docs/images/am_sample1.svg delete mode 100644 DRAMSys/docs/images/am_sample2.svg delete mode 100644 DRAMSys/docs/images/am_wideio_brc.svg delete mode 100644 DRAMSys/docs/images/am_wideio_rbc.svg rename DRAMSys/{docs => gem5}/images/gem5_se_mode_arch.svg (100%) diff --git a/DRAMSys/docs/doxyCfg.cfg b/DRAMSys/docs/doxyCfg.cfg deleted file mode 100644 index ea4940db..00000000 --- a/DRAMSys/docs/doxyCfg.cfg +++ /dev/null @@ -1,1228 +0,0 @@ -# Doxyfile 1.4.4 - -# This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project -# -# All text after a hash (#) is considered a comment and will be ignored -# The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- - -# The PROJECT_NAME tag is a single word (or a sequence of words surrounded -# by quotes) that should identify the project. - -PROJECT_NAME = DRAMSys - -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. - -PROJECT_NUMBER = - -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. - -OUTPUT_DIRECTORY = doxygen - -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. - -CREATE_SUBDIRS = NO - -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, -# Dutch, Finnish, French, German, Greek, Hungarian, Italian, Japanese, -# Japanese-en (Japanese with English messages), Korean, Korean-en, Norwegian, -# Polish, Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, -# Swedish, and Ukrainian. - -OUTPUT_LANGUAGE = English - -# This tag can be used to specify the encoding used in the generated output. -# The encoding is not always determined by the language that is chosen, -# but also whether or not the output is meant for Windows or non-Windows users. -# In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES -# forces the Windows encoding (this is the default for the Windows binary), -# whereas setting the tag to NO uses a Unix-style encoding (the default for -# all platforms other than Windows). - -USE_WINDOWS_ENCODING = NO - -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. - -BRIEF_MEMBER_DESC = YES - -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the -# brief descriptions will be completely suppressed. - -REPEAT_BRIEF = YES - -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" - -ABBREVIATE_BRIEF = - -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief -# description. - -ALWAYS_DETAILED_SEC = NO - -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment -# operators of the base classes will not be shown. - -INLINE_INHERITED_MEMB = NO - -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. - -FULL_PATH_NAMES = YES - -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. - -STRIP_FROM_PATH = - -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. - -STRIP_FROM_INC_PATH = - -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful is your file systems -# doesn't support long names like on DOS, Mac, or CD-ROM. - -SHORT_NAMES = NO - -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like the Qt-style comments (thus requiring an -# explicit @brief command for a brief description. - -JAVADOC_AUTOBRIEF = YES - -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. - -MULTILINE_CPP_IS_BRIEF = NO - -# If the DETAILS_AT_TOP tag is set to YES then Doxygen -# will output the detailed description near the top, like JavaDoc. -# If set to NO, the detailed description appears after the member -# documentation. - -DETAILS_AT_TOP = NO - -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. - -INHERIT_DOCS = YES - -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default -# all members of a group must be documented explicitly. - -DISTRIBUTE_GROUP_DOC = NO - -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. - -SEPARATE_MEMBER_PAGES = NO - -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. - -TAB_SIZE = 4 - -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. - -ALIASES = - -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. - -OPTIMIZE_OUTPUT_FOR_C = NO - -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources -# only. Doxygen will then generate output that is more tailored for Java. -# For instance, namespaces will be presented as packages, qualified scopes -# will look different, etc. - -OPTIMIZE_OUTPUT_JAVA = NO - -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. - -SUBGROUPING = YES - -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- - -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES - -EXTRACT_ALL = YES - -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. - -EXTRACT_PRIVATE = YES - -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. - -EXTRACT_STATIC = YES - -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. - -EXTRACT_LOCAL_CLASSES = YES - -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. - -EXTRACT_LOCAL_METHODS = NO - -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_MEMBERS = NO - -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. - -HIDE_UNDOC_CLASSES = NO - -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. - -HIDE_FRIEND_COMPOUNDS = NO - -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. - -HIDE_IN_BODY_DOCS = NO - -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. - -INTERNAL_DOCS = NO - -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. - -CASE_SENSE_NAMES = YES - -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. - -HIDE_SCOPE_NAMES = NO - -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. - -SHOW_INCLUDE_FILES = YES - -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. - -INLINE_INFO = YES - -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. - -SORT_MEMBER_DOCS = YES - -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. - -SORT_BRIEF_DOCS = NO - -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. - -SORT_BY_SCOPE_NAME = NO - -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. - -GENERATE_TODOLIST = YES - -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. - -GENERATE_TESTLIST = YES - -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. - -GENERATE_BUGLIST = YES - -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. - -GENERATE_DEPRECATEDLIST= YES - -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. - -ENABLED_SECTIONS = - -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or define consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and defines in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. - -MAX_INITIALIZER_LINES = 30 - -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the -# list will mention the files that were used to generate the documentation. - -SHOW_USED_FILES = YES - -# If the sources in your project are distributed over multiple directories -# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy -# in the documentation. The default is YES. - -SHOW_DIRECTORIES = YES - -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from the -# version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the progam writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- - -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. - -QUIET = NO - -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. - -WARNINGS = YES - -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. - -WARN_IF_UNDOCUMENTED = YES - -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. - -WARN_IF_DOC_ERROR = YES - -# This WARN_NO_PARAMDOC option can be abled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. - -WARN_NO_PARAMDOC = NO - -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) - -WARN_FORMAT = "$file:$line: $text" - -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. - -WARN_LOGFILE = - -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- - -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. - -INPUT = ../ - -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx -# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm - -FILE_PATTERNS = - -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. - -RECURSIVE = YES - -# The EXCLUDE tag can be used to specify files and/or directories that should -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. - -EXCLUDE = - -# The EXCLUDE_SYMLINKS tag can be used select whether or not files or -# directories that are symbolic links (a Unix filesystem feature) are excluded -# from the input. - -EXCLUDE_SYMLINKS = NO - -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* - -EXCLUDE_PATTERNS = - -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). - -EXAMPLE_PATH = - -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. - -EXAMPLE_PATTERNS = - -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. - -EXAMPLE_RECURSIVE = NO - -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). - -IMAGE_PATH = - -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. - -INPUT_FILTER = - -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER -# is applied to all files. - -FILTER_PATTERNS = - -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). - -FILTER_SOURCE_FILES = NO - -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- - -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. - -SOURCE_BROWSER = NO - -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. - -INLINE_SOURCES = NO - -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C and C++ comments will always remain visible. - -STRIP_CODE_COMMENTS = YES - -# If the REFERENCED_BY_RELATION tag is set to YES (the default) -# then for each documented function all documented -# functions referencing it will be listed. - -REFERENCED_BY_RELATION = YES - -# If the REFERENCES_RELATION tag is set to YES (the default) -# then for each documented function all documented entities -# called/used by that function will be listed. - -REFERENCES_RELATION = YES - -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. - -USE_HTAGS = NO - -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. - -VERBATIM_HEADERS = YES - -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- - -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. - -ALPHABETICAL_INDEX = YES - -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) - -COLS_IN_ALPHA_INDEX = 5 - -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. - -IGNORE_PREFIX = - -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- - -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. - -GENERATE_HTML = YES - -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. - -HTML_OUTPUT = html - -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. - -HTML_FILE_EXTENSION = .html - -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If the tag is left blank doxygen -# will generate a default style sheet. Note that doxygen will try to copy -# the style sheet file to the HTML output directory, so don't put your own -# stylesheet in the HTML output directory as well, or it will be erased! - -HTML_STYLESHEET = - -# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, -# files or namespaces will be aligned in HTML using tables. If set to -# NO a bullet list will be used. - -HTML_ALIGN_MEMBERS = YES - -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compressed HTML help file (.chm) -# of the generated HTML documentation. - -GENERATE_HTMLHELP = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be -# written to the html output directory. - -CHM_FILE = - -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. - -HHC_LOCATION = - -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). - -GENERATE_CHI = NO - -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. - -BINARY_TOC = NO - -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. - -TOC_EXPAND = NO - -# The DISABLE_INDEX tag can be used to turn on/off the condensed index at -# top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. - -DISABLE_INDEX = NO - -# This tag can be used to set the number of enum values (range [1..20]) -# that doxygen will group on one line in the generated HTML documentation. - -ENUM_VALUES_PER_LINE = 4 - -# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be -# generated containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, -# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are -# probably better off using the HTML help feature. - -GENERATE_TREEVIEW = NO - -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. - -TREEVIEW_WIDTH = 250 - -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- - -# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will -# generate Latex output. - -GENERATE_LATEX = NO - -# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `latex' will be used as the default path. - -LATEX_OUTPUT = latex - -# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be -# invoked. If left blank `latex' will be used as the default command name. - -LATEX_CMD_NAME = latex - -# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to -# generate index for LaTeX. If left blank `makeindex' will be used as the -# default command name. - -MAKEINDEX_CMD_NAME = makeindex - -# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact -# LaTeX documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_LATEX = NO - -# The PAPER_TYPE tag can be used to set the paper type that is used -# by the printer. Possible values are: a4, a4wide, letter, legal and -# executive. If left blank a4wide will be used. - -PAPER_TYPE = a4wide - -# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX -# packages that should be included in the LaTeX output. - -EXTRA_PACKAGES = - -# The LATEX_HEADER tag can be used to specify a personal LaTeX header for -# the generated latex document. The header should contain everything until -# the first chapter. If it is left blank doxygen will generate a -# standard header. Notice: only use this tag if you know what you are doing! - -LATEX_HEADER = - -# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated -# is prepared for conversion to pdf (using ps2pdf). The pdf file will -# contain links (just like the HTML output) instead of page references -# This makes the output suitable for online browsing using a pdf viewer. - -PDF_HYPERLINKS = NO - -# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of -# plain latex in the generated Makefile. Set this option to YES to get a -# higher quality PDF documentation. - -USE_PDFLATEX = NO - -# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. -# command to the generated LaTeX files. This will instruct LaTeX to keep -# running if errors occur, instead of asking the user for help. -# This option is also used when generating formulas in HTML. - -LATEX_BATCHMODE = NO - -# If LATEX_HIDE_INDICES is set to YES then doxygen will not -# include the index chapters (such as File Index, Compound Index, etc.) -# in the output. - -LATEX_HIDE_INDICES = NO - -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- - -# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output -# The RTF output is optimized for Word 97 and may not look very pretty with -# other RTF readers or editors. - -GENERATE_RTF = NO - -# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `rtf' will be used as the default path. - -RTF_OUTPUT = rtf - -# If the COMPACT_RTF tag is set to YES Doxygen generates more compact -# RTF documents. This may be useful for small projects and may help to -# save some trees in general. - -COMPACT_RTF = NO - -# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated -# will contain hyperlink fields. The RTF file will -# contain links (just like the HTML output) instead of page references. -# This makes the output suitable for online browsing using WORD or other -# programs which support those fields. -# Note: wordpad (write) and others do not support links. - -RTF_HYPERLINKS = NO - -# Load stylesheet definitions from file. Syntax is similar to doxygen's -# config file, i.e. a series of assignments. You only have to provide -# replacements, missing definitions are set to their default value. - -RTF_STYLESHEET_FILE = - -# Set optional variables used in the generation of an rtf document. -# Syntax is similar to doxygen's config file. - -RTF_EXTENSIONS_FILE = - -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- - -# If the GENERATE_MAN tag is set to YES (the default) Doxygen will -# generate man pages - -GENERATE_MAN = NO - -# The MAN_OUTPUT tag is used to specify where the man pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `man' will be used as the default path. - -MAN_OUTPUT = man - -# The MAN_EXTENSION tag determines the extension that is added to -# the generated man pages (default is the subroutine's section .3) - -MAN_EXTENSION = .3 - -# If the MAN_LINKS tag is set to YES and Doxygen generates man output, -# then it will generate one additional man file for each entity -# documented in the real man page(s). These additional files -# only source the real man page, but without them the man command -# would be unable to find the correct page. The default is NO. - -MAN_LINKS = NO - -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- - -# If the GENERATE_XML tag is set to YES Doxygen will -# generate an XML file that captures the structure of -# the code including all documentation. - -GENERATE_XML = NO - -# The XML_OUTPUT tag is used to specify where the XML pages will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `xml' will be used as the default path. - -XML_OUTPUT = xml - -# The XML_SCHEMA tag can be used to specify an XML schema, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_SCHEMA = - -# The XML_DTD tag can be used to specify an XML DTD, -# which can be used by a validating XML parser to check the -# syntax of the XML files. - -XML_DTD = - -# If the XML_PROGRAMLISTING tag is set to YES Doxygen will -# dump the program listings (including syntax highlighting -# and cross-referencing information) to the XML output. Note that -# enabling this will significantly increase the size of the XML output. - -XML_PROGRAMLISTING = YES - -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- - -# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will -# generate an AutoGen Definitions (see autogen.sf.net) file -# that captures the structure of the code including all -# documentation. Note that this feature is still experimental -# and incomplete at the moment. - -GENERATE_AUTOGEN_DEF = NO - -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- - -# If the GENERATE_PERLMOD tag is set to YES Doxygen will -# generate a Perl module file that captures the structure of -# the code including all documentation. Note that this -# feature is still experimental and incomplete at the -# moment. - -GENERATE_PERLMOD = NO - -# If the PERLMOD_LATEX tag is set to YES Doxygen will generate -# the necessary Makefile rules, Perl scripts and LaTeX code to be able -# to generate PDF and DVI output from the Perl module output. - -PERLMOD_LATEX = NO - -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be -# nicely formatted so it can be parsed by a human reader. This is useful -# if you want to understand what is going on. On the other hand, if this -# tag is set to NO the size of the Perl module output will be much smaller -# and Perl will parse it just the same. - -PERLMOD_PRETTY = YES - -# The names of the make variables in the generated doxyrules.make file -# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. -# This is useful so different doxyrules.make files included by the same -# Makefile don't overwrite each other's variables. - -PERLMOD_MAKEVAR_PREFIX = - -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- - -# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will -# evaluate all C-preprocessor directives found in the sources and include -# files. - -ENABLE_PREPROCESSING = YES - -# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro -# names in the source code. If set to NO (the default) only conditional -# compilation will be performed. Macro expansion can be done in a controlled -# way by setting EXPAND_ONLY_PREDEF to YES. - -MACRO_EXPANSION = NO - -# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES -# then the macro expansion is limited to the macros specified with the -# PREDEFINED and EXPAND_AS_PREDEFINED tags. - -EXPAND_ONLY_PREDEF = NO - -# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files -# in the INCLUDE_PATH (see below) will be search if a #include is found. - -SEARCH_INCLUDES = YES - -# The INCLUDE_PATH tag can be used to specify one or more directories that -# contain include files that are not input files but should be processed by -# the preprocessor. - -INCLUDE_PATH = - -# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard -# patterns (like *.h and *.hpp) to filter out the header-files in the -# directories. If left blank, the patterns specified with FILE_PATTERNS will -# be used. - -INCLUDE_FILE_PATTERNS = - -# The PREDEFINED tag can be used to specify one or more macro names that -# are defined before the preprocessor is started (similar to the -D option of -# gcc). The argument of the tag is a list of macros of the form: name -# or name=definition (no spaces). If the definition and the = are -# omitted =1 is assumed. To prevent a macro definition from being -# undefined via #undef or recursively expanded use the := operator -# instead of the = operator. - -PREDEFINED = - -# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then -# this tag can be used to specify a list of macro names that should be expanded. -# The macro definition that is found in the sources will be used. -# Use the PREDEFINED tag if you want to use a different macro definition. - -EXPAND_AS_DEFINED = - -# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then -# doxygen's preprocessor will remove all function-like macros that are alone -# on a line, have an all uppercase name, and do not end with a semicolon. Such -# function macros are typically used for boiler-plate code, and will confuse -# the parser if not removed. - -SKIP_FUNCTION_MACROS = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- - -# The TAGFILES option can be used to specify one or more tagfiles. -# Optionally an initial location of the external documentation -# can be added for each tagfile. The format of a tag file without -# this location is as follows: -# TAGFILES = file1 file2 ... -# Adding location for the tag files is done as follows: -# TAGFILES = file1=loc1 "file2 = loc2" ... -# where "loc1" and "loc2" can be relative or absolute paths or -# URLs. If a location is present for each tag, the installdox tool -# does not have to be run to correct the links. -# Note that each tag file must have a unique name -# (where the name does NOT include the path) -# If a tag file is not located in the directory in which doxygen -# is run, you must also specify the path to the tagfile here. - -TAGFILES = - -# When a file name is specified after GENERATE_TAGFILE, doxygen will create -# a tag file that is based on the input files it reads. - -GENERATE_TAGFILE = - -# If the ALLEXTERNALS tag is set to YES all external classes will be listed -# in the class index. If set to NO only the inherited external classes -# will be listed. - -ALLEXTERNALS = NO - -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed -# in the modules index. If set to NO, only the current project's groups will -# be listed. - -EXTERNAL_GROUPS = YES - -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of `which perl'). - -PERL_PATH = /usr/bin/perl - -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- - -# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will -# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base -# or super classes. Setting the tag to NO turns the diagrams off. Note that -# this option is superseded by the HAVE_DOT option below. This is only a -# fallback. It is recommended to install and use dot, since it yields more -# powerful graphs. - -CLASS_DIAGRAMS = YES - -# If set to YES, the inheritance and collaboration graphs will hide -# inheritance and usage relations if the target is undocumented -# or is not a class. - -HIDE_UNDOC_RELATIONS = YES - -# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is -# available from the path. This tool is part of Graphviz, a graph visualization -# toolkit from AT&T and Lucent Bell Labs. The other options in this section -# have no effect if this option is set to NO (the default) - -HAVE_DOT = NO - -# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect inheritance relations. Setting this tag to YES will force the -# the CLASS_DIAGRAMS tag to NO. - -CLASS_GRAPH = YES - -# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for each documented class showing the direct and -# indirect implementation dependencies (inheritance, containment, and -# class references variables) of the class with other documented classes. - -COLLABORATION_GRAPH = YES - -# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen -# will generate a graph for groups, showing the direct groups dependencies - -GROUP_GRAPHS = YES - -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and -# collaboration diagrams in a style similar to the OMG's Unified Modeling -# Language. - -UML_LOOK = NO - -# If set to YES, the inheritance and collaboration graphs will show the -# relations between templates and their instances. - -TEMPLATE_RELATIONS = NO - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT -# tags are set to YES then doxygen will generate a graph for each documented -# file showing the direct and indirect include dependencies of the file with -# other documented files. - -INCLUDE_GRAPH = YES - -# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and -# HAVE_DOT tags are set to YES then doxygen will generate a graph for each -# documented header file showing the documented files that directly or -# indirectly include this file. - -INCLUDED_BY_GRAPH = YES - -# If the CALL_GRAPH and HAVE_DOT tags are set to YES then doxygen will -# generate a call dependency graph for every global function or class method. -# Note that enabling this option will significantly increase the time of a run. -# So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. - -CALL_GRAPH = NO - -# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen -# will graphical hierarchy of all classes instead of a textual one. - -GRAPHICAL_HIERARCHY = YES - -# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES -# then doxygen will show the dependencies a directory has on other directories -# in a graphical way. The dependency relations are determined by the #include -# relations between the files in the directories. - -DIRECTORY_GRAPH = YES - -# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. Possible values are png, jpg, or gif -# If left blank png will be used. - -DOT_IMAGE_FORMAT = png - -# The tag DOT_PATH can be used to specify the path where the dot tool can be -# found. If left blank, it is assumed the dot tool can be found in the path. - -DOT_PATH = - -# The DOTFILE_DIRS tag can be used to specify one or more directories that -# contain dot files that are included in the documentation (see the -# \dotfile command). - -DOTFILE_DIRS = - -# The MAX_DOT_GRAPH_WIDTH tag can be used to set the maximum allowed width -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very -# large images. - -MAX_DOT_GRAPH_WIDTH = 1024 - -# The MAX_DOT_GRAPH_HEIGHT tag can be used to set the maximum allows height -# (in pixels) of the graphs generated by dot. If a graph becomes larger than -# this value, doxygen will try to truncate the graph, so that it fits within -# the specified constraint. Beware that most browsers cannot cope with very -# large images. - -MAX_DOT_GRAPH_HEIGHT = 1024 - -# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the -# graphs generated by dot. A depth value of 3 means that only nodes reachable -# from the root by following a path via at most 3 edges will be shown. Nodes -# that lay further from the root node will be omitted. Note that setting this -# option to 1 or 2 may greatly reduce the computation time needed for large -# code bases. Also note that a graph may be further truncated if the graph's -# image dimensions are not sufficient to fit the graph (see MAX_DOT_GRAPH_WIDTH -# and MAX_DOT_GRAPH_HEIGHT). If 0 is used for the depth value (the default), -# the graph is not depth-constrained. - -MAX_DOT_GRAPH_DEPTH = 0 - -# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent -# background. This is disabled by default, which results in a white background. -# Warning: Depending on the platform used, enabling this option may lead to -# badly anti-aliased labels on the edges of a graph (i.e. they become hard to -# read). - -DOT_TRANSPARENT = NO - -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output -# files in one run (i.e. multiple -o and -T options on the command line). This -# makes dot run faster, but since only newer versions of dot (>1.8.10) -# support this, this feature is disabled by default. - -DOT_MULTI_TARGETS = NO - -# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will -# generate a legend page explaining the meaning of the various boxes and -# arrows in the dot generated graphs. - -GENERATE_LEGEND = YES - -# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will -# remove the intermediate dot files that are used to generate -# the various graphs. - -DOT_CLEANUP = YES - -#--------------------------------------------------------------------------- -# Configuration::additions related to the search engine -#--------------------------------------------------------------------------- - -# The SEARCHENGINE tag specifies whether or not a search engine should be -# used. If set to NO the values of all tags below this one will be ignored. - -SEARCHENGINE = NO diff --git a/DRAMSys/docs/images/PayloadExtension.svg b/DRAMSys/docs/images/PayloadExtension.svg deleted file mode 100644 index fd0cb966..00000000 --- a/DRAMSys/docs/images/PayloadExtension.svg +++ /dev/null @@ -1,2449 +0,0 @@ - - - -Trace -file n -Trace -file -1 -Trace Player -1 -Trace Player n -Arbiter -Controller -Scheduler -ControllerCore -Controller -Scheduler -ControllerCore -DRAM -DRAM -GenerationExtension -sc -_ -time -( -timeOfGeneration -) -Generic Payload -Command -Address -Data pointer -Data length -Byte enable pointer -Byte enable length -Streaming width -DMI hint -Response status -Generic Payload -Command -Address -Data pointer -Data length -Byte enable pointer -Byte enable length -Streaming width -DMI hint -Response status -GenerationExtension -sc -_ -time -( -timeOfGeneration -) -DramExtension -Thread -Chanel -Bank -BankGroup -Row -Column -Burstlength -Generic Payload -Command -Address -Data pointer -Data length -Byte enable pointer -Byte enable length -Streaming width -DMI hint -Response status -GenerationExtension -sc -_ -time -( -timeOfGeneration -) -DramExtension -Thread -Chanel -Bank -BankGroup -Row -Column -Burstlength -Generic Payload -Command -Address -Data pointer -Data length -Byte enable pointer -Byte enable length -Streaming width -DMI hint -Response status -GenerationExtension -sc -_ -time -( -timeOfGeneration -) -DramExtension -Thread -Chanel -Bank -BankGroup -Row -Column -Burstlength - \ No newline at end of file diff --git a/DRAMSys/docs/images/PayloadMemoryManager.svg b/DRAMSys/docs/images/PayloadMemoryManager.svg deleted file mode 100644 index fc237c0c..00000000 --- a/DRAMSys/docs/images/PayloadMemoryManager.svg +++ /dev/null @@ -1,4866 +0,0 @@ - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - SystemC - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - SystemC - - - - - - - - - - - - - - - - - - - - - - - - - - - SystemC - - - - - - - - - interrupt - jjjjjjjjjjjjjj - - - - - - - - - - - - - - - - - - - - - - - SystemC - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - SystemC - - - - - - - - - - - - - - - -