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

Adding Additional External Components For SST 10.1.x

Adding Additional External Components For SST 10.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-Elements 10.1.x distribution. SST-Elements 10.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.

Optional External Components FOR SST-Core

These are optional external components for the SST-Elements. They may provide additional features.

HDF5 1.10.5

OPTIONAL EXTERNAL COMPONENT FOR SST-CORE - Used for HDF Formatting for SST Statistics

General Infomation:

HDF5 is a data model, library, and file format for storing and managing data. It supports an unlimited variety of datatypes, and is designed for flexible and efficient I/O and for high volume and complex data. HDF5 is portable and is extensible, allowing applications to evolve in their use of HDF5. The HDF5 Technology suite includes tools and applications for managing, manipulating, viewing, and analyzing data in the HDF5 format.
For more info see HDF5
SST 10.1.x is tested against version 1.10.5 of HDF5.

Where to find:

HDF5 1.10.5 is downloadable from here

Build Instructions:

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

$ cd $HOME/scratch/src
$ tar xfz hdf5-1.10..5.tar.gz
$ cd hdf5-1.10.5

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

$ export HDF5_HOME=$HOME/local/packages/HDF5

3. Configure the build and installation of HDF5

$ ./configure --prefix=$HDF5_HOME --enable-cxx

4. Build and Install HDF5

$ make
$ make check
$ make install
$ make check-install

5. Configure SST-Core to use HDF5

$ cd <to SST-Core base directory>
$ ./configure <all other SST configure options> --with-hdf5=$HDF5_HOME
$ make install

Zoltan 3.83

OPTIONAL EXTERNAL COMPONENT FOR SST-CORE - Used for SST Partitioning within the SST-Core

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 10.1.x is tested against version 3.83 of Zoltan.

Where to find:

Zoltan 3.83 is downloadable from here

Build Instructions:

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

$ cd $HOME/scratch/src
$ tar xfz zoltan_distrib_v3.83.tar.gz
$ cd Zoltan_v3.83
$ 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-Core to use Zoltan

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

Optional External Components FOR SST-Elements

These are optional external components for the SST-Elements. They may provide additional features for elements or they may be required to allow an element to be built.

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 10.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-Elements to use DRAMSim2

$ cd <to SST-Elements 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-Elements to use DRAMSim2

$ cd <to SST-Elements 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 10.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-Elements to use NVDIMMSim

$ cd <to SST-Elements 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-Elements to use NVDIMMSim

$ cd <to SST-Elements 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 10.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-Elements to use HybridSim

$ cd <to SST-Elements base directory>
$ ./configure <all other SST configure options> --with-dramsim=$DRAMSIM2_HOME --with-nvdimmsim=$NVDIMMSIM_HOME --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-Elements to use HybridSim

$ cd <to SST-Elements base directory>
$ ./configure <all other SST configure options> --with-dramsim=$DRAMSIM2_HOME --with-nvdimmsim=$NVDIMMSIM_HOME --with-hybridsim=$HYBRIDSIM_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 10.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-Elements to use glpk

$ cd <to SST-Elements 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 10.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-Elements to use METIS

$ cd <to SST-Elements base directory>
$ ./configure <all other SST configure options> --with-metis=$METIS_HOME
$ 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 10.1.x is tested against version 2.14-71313 of PinTool.

Where to find:

Intel Pin Downloads
- NOTE: PIN Version 2 on Linux; only gcc 3.4 thru 4.9 versions are supported.
- NOTE: PIN Version 2 not supported on OSX.
- Ensure that version 2.14-71313 is the downloaded version.

Build Instructions:

NOTE: PinTool 2.14-71313 cannot be used on Mac OSX.

- 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 Pin 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-Elements base directory>
$ ./configure <all other SST-Elements configure options> --with-pin=$PIN_HOME
$ make install

Intel Pin Tool 3.13-98189

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 10.1.x is tested against version 3.13-98189 of PinTool.

Where to find:

Intel Pin Downloads
- NOTE: PIN Version 3 on Linux; all compiliers are supported.
- NOTE: PIN Version 3 not supported on OSX for SST-10, future SST versions may support PIN Version 3
- Ensure that version 3.13-98189 is the downloaded version.

Build Instructions:

- 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-3.13-98189-g60a6ef199-gcc-linux.tar.gz

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

$ export PIN_HOME=$HOME/local/packages/pin-3.13-98189-g60a6ef199-gcc-linux
$ export INTEL_PIN_DIRECTORY=$PIN_HOME

3. Copy the Pin directory to the SST elements directory

$ cp -r pin-3.13-98189-g60a6ef199-gcc-linux $PIN_HOME

4. Configure SST to use PinTool

$ cd <to SST-Elements base directory>
$ ./configure <all other SST-Elements 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-3.13-98189-g60a6ef199-clang-mac.tar.gz

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

$ export PIN_HOME=$HOME/local/packages/pin-3.13-98189-g60a6ef199-clang-mac
$ export INTEL_PIN_DIRECTORY=$PIN_HOME

3. Copy the Pin directory to the SST elements directory

$ cp -r pin-3.11-98189-g60a6ef199-clang-mac $PIN_HOME

4. Configure SST-Elements to use PinTool

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

Goblin HMCSim

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

General Infomation:

The Goblin HMC-Sim is a Hybrid Memory Cube Functional Simulation Environment.
For more information see Goblin HMCSim
SST 10.1.x is tested against version SST-8.0.0-release of Goblin HMCSim.

Where to find:

Goblin HMCSim is available here

Build Instructions:

1. Assuming that the zipfile has been downloaded to $HOME/scratch/src, unzip gc64-hmcsim-sst-8.0.0-release.zip

$ cd $HOME/scratch/src
$ unzip gc64-hmcsim-sst-8.0.0-release.zip
$ cd gc64-hmcsim-sst-8.0.0-release

2. Set the home directory environment variable of the Goblin HMCSim installation.

$ export GOBLINHMCSIM_HOME=$HOME/local/packages/GoblinHMCSim

3. Build Goblin HMCSim

$ make

4. Install Goblin HMCSim library

$ ln -s `pwd` $GOBLINHMCSIM_HOME

5. Configure SST-Elements to use Goblin HMCSim

$ cd <to SST-Elements base directory>
$ ./configure <all other SST configure options> --with-goblin-hmcsim=$GOBLINHMCSIM_HOME
$ make install

HBM Dramsim2

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

General Infomation:

HBM Simulator based on DRAMSim2; a small source-code change with HBM configuration.
For more information see HBM Dramsim2
SST 10.1.x is tested against version hbm-1.0.0-release HBM Dramsim2

Where to find:

HBM Dramsim2 is available here

Build Instructions:

1. HBM Dramsim2 must be cloned using Git, and a specific Tag must be used.

$ cd $HOME/scratch/src
$ git clone https://github.com/tactcomplabs/HBM.git
$ cd HBM
$ git checkout hbm-1.0.0-release

2. Set the home directory environment variable of the HBM Dramsim2 installation.

$ export HBMDRAMSIM2_HOME=$HOME/local/packages/HBMDramsim2

3. Build HBM Dramsim2

$ make

4. Install HBM Dramsim2 library

$ ln -s `pwd` $HBMDRAMSIM2_HOME

5. Configure SST-Elements to use HBM Dramsim2

$ cd <to SST-Elements base directory>
$ ./configure <all other SST configure options> --with-hbmdramsim==$HBMDRAMSIM2_HOME
$ make install

Ramulator

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

General Infomation:

Ramulator is a fast and cycle-accurate DRAM simulator that supports a wide array of commercial, as well as academic, DRAM standards.
For more information see Ramulator
SST 10.1.x is tested against Ramulator SHA .

Where to find:

Ramulator is available here.
Required patches for ramulator are available here
- 2 Patches for SHA: 7d2e723 are required.

Build Instructions:

1. Ramulator must be cloned using Git, and a specific SHA must be used.

$ cd $HOME/scratch/src
$ git clone https://github.com/CMU-SAFARI/ramulator.git
$ cd ramulator
$ git checkout 7d2e72306c6079768e11a1867eb67b60cee34a1c

2. Apply patches to the Ramulator source.

$ patch -p1 -i ramulator_sha_7d2e723_gcc48Patch.patch
$ patch -p1 -i ramulator_sha_7d2e723_libPatch.patch

3. Set the home directory environment variable of the Ramulator installation.

$ export RAMULATOR_HOME=$HOME/local/packages/ramulator

4. Build Ramulator

- Instructions specific to Linux Operating Systems.

$ make CXX=g++ libramulator.so

- Instructions specific to Mac OSX Operating Systems.

$ make libramulator.a

5. Install Ramulator library

$ ln -s `pwd` $RAMULATOR_HOME

6. Configure SST-Elements to use Ramulator

$ cd <to SST-Elements base directory>
$ ./configure <all other SST configure options> --with-ramulator=$RAMULATOR_HOME
$ make install