Home » SSTDocumentation » Adding Additional External Components For SST 5.1.x

Adding Additional External Components For SST 5.1.x

Adding Additional External Components For SST 5.1.x

Overview

These instructions are intended to walk the user through a detailed set of steps to build and install the optional external components used by SST. It is intended for users with intermediate knowledge in the operation of Unix/Linux/OSX environments.

NOTE: The following instructions assume the user has completed the basic build steps for SST outlined in Detailed Build and Installation Instructions for SST.

The SST Release Notes identify what operating systems, compiler and external component combinations have been tested and proven to work with SST.

NOTE: Using combinations other than what is identified in the Release Notes may cause build failures and/or unexpected results.

A detailed list of elements provided with the SST distribution are available at SST Element Summary and SST Element Release Matrix.

If you encounter difficulties, go to the SST Support page.

NOTE: Building SST and its External Components can sometimes be cumbersome and error prone due to the sheer number of combinations of operating systems, compiler versions and external required components. It is STRONGLY recommended that users closely follow these instructions.

General Build and Install Information

Refer to Detailed SST Build and Install Instructions for more information on system requirements, special instructions, example directories and additional tasks for users.

Optional External Components Installation

SST allows for a number of optional external packages which can be tricky to build. Some notes and hints are included here.

Carefully following the instructions provided below should minimize any problems that may arise.

Note: Some the external packages may require files from the SST 5.1.x distribution. SST 5.1.x should have already been downloaded and extracted before compiling and installing these dependent external packages. See Detailed Build and Installation Instructions for SST for more information.

DRAMSim2 2.2.2

OPTIONAL EXTERNAL COMPONENT

General Infomation:

DRAMsim is a hardware-validated, cycle-accurate, C based simulator for DRAM devices such as DDR3. The device parameters are configurable. Please refer to DRAMSim2 for more details.
DRAMSim2 is a support component for HybridSim.
SST 5.1.x is tested against version 2.2.2 of DRAMSim2.

Where to find:

DRAMSim2 2.2.2 is downloadable from here
- Note: If the link is clicked for a browser download, the file may need to be renamed from DRAMSim2-2.2.2.tar.gz to v2.2.2.tar.gz for the following instructions.

Build Instructions:

- Instructions specific to Linux Operating Systems.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive v2.2.2.tar.gz

$ cd $HOME/scratch/src
$ tar xfz v2.2.2.tar.gz
$ mv DRAMSim2-2.2.2 DRAMSim2
$ cd DRAMSim2

2. Set the home directory environment variable of the DRAMSim2 installation.

$ export DRAMSIM2_HOME=$HOME/local/packages/DRAMSim2

3. Build the DRAMSim2 library

$ make libdramsim.so

4. Install DRAMSim2 library

$ cp -r . $DRAMSIM2_HOME

5. Configure SST to use DRAMSim2

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-dramsim=$DRAMSIM2_HOME
$ make install

- Instructions specific to Mac OSX Operating Systems.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive v2.2.2.tar.gz

$ cd $HOME/scratch/src
$ tar xfz v2.2.2.tar.gz
$ mv DRAMSim2-2.2.2 DRAMSim2
$ cd DRAMSim2

2. Set the home directory environment variable of the DRAMSim2 installation.

$ export DRAMSIM2_HOME=$HOME/local/packages/DRAMSim2

3. Build the DRAMSim2 library

$ make libdramsim.dylib

4. Install DRAMSim2 library

$ cp -r . $DRAMSIM2_HOME

5. Configure SST to use DRAMSim2

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-dramsim=$DRAMSIM2_HOME
$ make install

NVDIMMSim 2.0.0

OPTIONAL EXTERNAL COMPONENT

General Infomation:

NVDIMMSim is a cycle-accurate non-volatile memory simulator for devices such as NAND flash. Please refer to NVDIMMSim for more information.
NVDIMMSim is a support component for HybridSim.
SST 5.1.x is tested against version 2.0.0 of NVDIMMSim.

Where to find:

NVDIMMSim 2.0.0 is downloadable from here
- Note: If the file is downloaded using wget, you may need to be rename the downloaded file v2.0.0 to NVDIMMSim-2.0.0.tar.gz for the following instructions

Build Instructions:

- Instructions specific to Linux Operating Systems.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive NVDIMMSim-2.0.0.tar.gz

$ cd $HOME/scratch/src
$ tar xfz NVDIMMSim-2.0.0.tar.gz
$ mv NVDIMMSim-2.0.0 NVDIMMSim
$ cd NVDIMMSim/src

2. Set the home directory environment variable of the NVDIMMSim installation.

$ export NVDIMMSIM_HOME=$HOME/local/packages/NVDIMMSim

3. Build the NVDIMMSim library

$ make libnvdsim.so

4. Install NVDIMMSIM library

$ cp -r . $NVDIMMSIM_HOME

5. Configure SST to use NVDIMMSim

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-nvdimmsim=$NVDIMMSIM_HOME
$ make install

- Instructions specific to Mac OSX Operating Systems.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive NVDIMMSim-2.0.0.tar.gz

$ cd $HOME/scratch/src
$ tar xfz NVDIMMSim-2.0.0.tar.gz
$ mv NVDIMMSim-2.0.0 NVDIMMSim
$ cd NVDIMMSim/src

2. Set the home directory environment variable of the NVDIMMSim installation.

$ export NVDIMMSIM_HOME=$HOME/local/packages/NVDIMMSim

3. Build the NVDIMMSim library

$ make libnvdsim.dylib

4. Install NVDIMMSIM library

$ cp -r . $NVDIMMSIM_HOME

5. Configure SST to use NVDIMMSim

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-nvdimmsim=$NVDIMMSIM_HOME
$ make install

HybridSim 2.0.1

OPTIONAL EXTERNAL COMPONENT - Requires NVDimmSim and DRAMSim2

General Infomation:

HybridSim provides cycle-accurate simulation of a non-volatile memory system augmented with a DRAM based cache. It uses DRAMSim2 for the DRAM model and NVDIMMSim for the non-volatile memory model. Pleaser refer to HybridSim for more information.
SST 5.1.x is tested against version 2.0.1 of HybridSim.

Where to find:

HybridSim 2.0.1 is downloadable from here
- If the file is downloaded using wget, you may need to be rename the downloaded file ‘v2.0.1’ to HybridSim-2.0.1.tar.gz for the following instructions.

Build Instructions:

Note:
- NVDIMMSim 2.0.0 and DRAMSim2-2.2.2 are prerequisites for HybridSim. Refer to the instructions above.
- It is very important that HybridSim, NVDIMMSim, and DRAMSim2, are in the same parent folder ($HOME/scratch/src) and are named as shown.

- Instructions specific to Linux Operating Systems.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive HybridSim-2.0.1.tar.gz

$ cd $HOME/scratch/src
$ tar xfz HybridSim-2.0.1.tar.gz
$ mv HybridSim-2.0.1 HybridSim
$ cd HybridSim

2. Set the home directory environment variable of the HybridSim installation.

$ export HYBRIDSIM_HOME=$HOME/local/packages/HybridSim

3. Build the HybridSim library

$ make libhybridsim.so

4. Install HybridSim library

$ cp -r . $HYBRIDSIM_HOME

5. Configure SST to use HybridSim

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-hybridsim=$HYBRIDSIM_HOME
$ make install

- Instructions specific to Mac OSX Operating Systems.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive HybridSim-2.0.1.tar.gz

$ cd $HOME/scratch/src
$ tar xfz HybridSim-2.0.1.tar.gz
$ mv HybridSim-2.0.1 HybridSim
$ cd HybridSim

2. Set the home directory environment variable of the HybridSim installation.

$ export HYBRIDSIM_HOME=$HOME/local/packages/HybridSim

3. Build the HybridSim library

$ make libhybridsim.dylib

4. Install HybridSim library

$ cp -r . $HYBRIDSIM_HOME

5. Configure SST to use HybridSim

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-hybridsim=$HYBRIDSIM_HOME
$ make install

QSim 0.2.1

OPTIONAL EXTERNAL COMPONENT - LINUX ONLY

General Infomation:

QSim is a project which aims, as part of the Manifold simulation effort at Georgia Tech, to create a thread safe multicore emulation library based on the QEMU emulator. QSim provides instruction-level control of the emulated environment and detailed information about the executing instruction stream. X86 Linux guests are supported with hundreds of emulated hardware contexts, each of which can run in an independent host thread. Applications of QSim include trace-gathering, multithreaded software development, and its primary target: microarchitecture simulation.
QSim project information is available from QSim
SST 5.1.x is tested against version 0.2.1 of QSim.
**NOTE: QSim does not build on MacOS X. See SST [ticket:14 Issue 14] **

Where to find:

The SST-compatible Qsim source code can be obtained here.
QSim requires QEMU (tested with qemu-0.12.3).

Build Instructions:

Note: QSim 0.2.1 requires a patch (provided with SST 5.1.x).

- Instructions specific to Linux Operating Systems.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive 0.2.1.tar.gz

$ cd $HOME/scratch/src
$ tar xfz 0.2.1.tar.gz
$ cd qsim-0.2.1

2. Set the home directory environment variable of the QSim installation.

$ export QSIM_HOME=$HOME/local/packages/QSim

3. Apply a patch to QSim 0.2.1 - (Fixes a file open problem with Ubuntu)

$ patch -i <SST 5.1.x Source Root>/deps/patches/qsim-0.2.1-fileOpenCheck.patch

4. Obtain the qemu-0.12.3.tar.gz file. (The getqemu.sh script will attempt to download it from the Internet if a local copy cannot be found.)

$ ./getqemu.sh
$ pushd qemu-0.12.3
$ make
$ popd
$ export QSIM_PREFIX=$QSIM_HOME
$ make install

5. Configure SST to use QSim

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-qsim=$QSIM_HOME
$ make install

GLPK 4.54

OPTIONAL EXTERNAL COMPONENT - Used by Scheduler Element for optional enhanced features

General Infomation:

The GLPK (GNU Linear Programming Kit) package is intended for solving large-scale linear programming (LP), mixed integer programming (MIP), and other related problems. It is a set of routines written in ANSI C and organized in the form of a callable library.
For more information see GLPK
SST 5.1.x is tested against version 4.54 of GLPK.

Where to find:

GLPK 4.54 is downloadable here

Build Instructions:

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive glpk-4.54.tar.gz

$ cd $HOME/scratch/src
$ tar xfz glpk-4.54.tar.gz
$ cd glpk-4.54

2. Set the home directory environment variable of the GLPK installation.

$ export GLPK_HOME=$HOME/local/packages/GLPK

3. Configure the build and installation of glpk

$ ./configure --prefix=$GLPK_HOME

4. Build and install glpk

$ make all install

5. Configure SST to use glpk

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-glpk=$GLPK_HOME
$ make install

METIS 5.1

OPTIONAL EXTERNAL COMPONENT - Used by Scheduler Element for optional enhanced features

General Infomation:

METIS is a set of serial programs for partitioning graphs, partitioning finite element meshes, and producing fill reducing orderings for sparse matrices. The algorithms implemented in METIS are based on the multilevel recursive-bisection, multilevel k-way, and multi-constraint partitioning schemes
For more information see Metis
SST 5.1.x is tested against version 5.1 of METIS.

Where to find:

METIS 5.1 is downloadable here

Build Instructions:

NOTE: METIS 5.1 requires CMake to properly build. CMake can be obtained from CMake or installed via linux distro or MacPorts

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive metis-5.1.0.tar.gz

$ cd $HOME/scratch/src
$ tar xfz metis-5.1.0.tar.gz
$ cd metis-5.1.0

2. Set the home directory environment variable of the METIS installation.

$ export METIS_HOME=$HOME/local/packages/METIS

3. Edit the METIS Make file located at $HOME/scratch/src/metis-5.1.0/Makefile as follows:

Insert at line 55.

# enable GKRAND support
CONFIG_FLAGS += -DGKRAND=ON

4. Edit the METIS include file located at $HOME/scratch/src/metis-5.1.0/include/metis.h as follows:

change line 33 (IDXTYPEWIDTH from 32 to 64)

#define IDXTYPEWIDTH 64

change line 43 (REALTYPEWIDTH from 32 to 64)

#define REALTYPEWIDTH 64

5. Configure, Build and install METIS

$ make config prefix=$METIS_HOME
$ make
$ make install

6. Configure SST to use METIS

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-metis=$METIS_HOME
$ make install

Zoltan 3.8

OPTIONAL EXTERNAL COMPONENT - Used for SST Partitioning

General Infomation:

The Zoltan library is a collection of data management services for parallel, unstructured, adaptive, and dynamic applications. It simplifies the load-balancing, data movement, unstructured communication, and memory usage difficulties that arise in dynamic applications such as adaptive finite-element methods, particle methods, and crash simulations. Zoltan’s data-structure neutral design also lets a wide range of applications use it without imposing restrictions on application data structures. Its object-based interface provides a simple and inexpensive way for application developers to use the library and researchers to make new capabilities available under a common interface.
For more info see Zoltan
SST 5.1.x is tested against version 3.8 of Zoltan.

Where to find:

Zoltan 3.8 is downloadable from here

Build Instructions:

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive zoltan_distrib_v3.8.tar.gz

$ cd $HOME/scratch/src
$ tar xfz zoltan_distrib_v3.8.tar.gz
$ cd Zoltan_v3.8
$ mkdir build
$ cd build

2. Set the home directory environment variable of the Zoltan installation.

$ export ZOLTAN_HOME=$HOME/local/packages/Zoltan

3. Configure the build and installation of Zoltan

$ CC=`which mpicc` CXX=`which mpicxx` ../configure --with-cflags="-fPIC" --with-cxxflags="-fPIC" --prefix=$ZOLTAN_HOME

4. Build and Install Zoltan

$ make everything
$ make install  

5. Configure SST to use Zoltan

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-zoltan=$ZOLTAN_HOME
$ make install

MacSim 2.2.0

OPTIONAL EXTERNAL COMPONENT

General Infomation:

MacSim is a heterogeneous architecture simulator, which is trace-driven and cycle-level. It thoroughly models architectural behaviors, including detailed pipeline stages, multi-threading, and memory systems. Currently, MacSim support x86 and NVIDIA PTX instruction set architectures (ISA). MacSim is capable of simulating a variety of architectures, such as Intel’s Sandy Bridge and NVIDIA’s Fermi. It can simulate homogeneous ISA multicore simulations as well as heterogeneous ISA multicore simulations.
More information can be found at MacSim
SST 5.1.x is tested against version 2.2.0 of MacSim.

Where to find:

MacSim 2.2.0 is downloadable from here

Build Instructions:

NOTE: MacSim is built as an element of SST and is compiled when SST is built

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive macsim-2.2.0.tar.gz

$ cd $HOME/scratch/src
$ tar xfz macsim-2.2.0.tar.gz 

2. Copy the macsim directory to the SST elements directory

$ cp -r macsim <SST 5.1.x Source Root>/sst/elements/macsimComponent

3. Build SST (with MacSim)

$ cd <to SST base directory>
$ ./autogen.sh
$ ./configure <user SST configure options>
$ make install  

Intel Pin Tool 2.14-71313

OPTIONAL EXTERNAL COMPONENT - Required for Ariel Element

General Infomation:

Pin is a dynamic binary instrumentation framework for the IA-32 and x86-64 instruction-set architectures that enables the creation of dynamic program analysis tools. Some tools built with Pin are Intel Parallel Inspector, Intel Parallel Amplifier and Intel Parallel Advisor. The tools created using Pin, called Pintools, can be used to perform program analysis on user space applications in Linux and Windows. As a dynamic binary instrumentation tool, instrumentation is performed at run time on the compiled binary files. Thus, it requires no recompiling of source code and can support instrumenting programs that dynamically generate code.
For more information see Intel Pin
SST 5.1.x is tested against version 2.14-71313 of PinTool.

Where to find:

Intel Pin Downloads
- NOTE: Only the Mac OSX with Clang 5 (or greater), and Linux with gcc 3.4 (or greater) versions are supported.
- Ensure that version 71313 is the downloaded version.

Build Instructions:

NOTE: PinTool cannot be used on Mac OSX with the MacPorts gcc compiler.

- Instructions specific to Linux Operating Systems.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive pin

$ cd $HOME/scratch/src
$ tar xfz pin-2.14-71313-gcc.4.4.7-linux.tar.gz

2. Set the home directory environment variable of the PinTool installation.

$ export PIN_HOME=$HOME/local/packages/pin-2.14-71313-gcc.4.4.7-linux
$ export INTEL_PIN_DIRECTORY=$PIN_HOME

3. Copy the macsim directory to the SST elements directory

$ cp -r pin-2.14-71313-gcc.4.4.7-linux $PIN_HOME

4. Configure SST to use PinTool

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-pin=$PIN_HOME
$ make install

- Instructions specific to Mac OSX Operating Systems using Clang.

1. Assuming that the tarfile has been downloaded to $HOME/scratch/src, unarchive pin

$ cd $HOME/scratch/src
$ tar xfz pin-2.14-71313-clang.5.1-mac.tar.gz

2. Set the home directory environment variable of the PinTool installation.

$ export PIN_HOME=$HOME/local/packages/pin-2.14-71313-clang.5.1-mac
$ export INTEL_PIN_DIRECTORY=$PIN_HOME

3. Copy the macsim directory to the SST elements directory

$ cp -r pin-2.14-71313-clang.5.1-mac $PIN_HOME

4. Configure SST to use PinTool

$ cd <to SST base directory>
$ ./configure <all other SST configure options> --with-pin=$PIN_HOME
$ make install