README.md

DC Circuit Switch

Overview

This repo holds benchmark tools for MPI/RDMA, using Mellanox ConnectX-5 NICs. The repo is organized as follows:

• src: includes all source code:
  • microbenchmark: includes micro-benchmark code for RDMA and MPI
• script: includes script wrappers to run programs
• build: default CMake output directory (it's git-ignored)
• docs: includes documentation

On-going Development

MPI transport is currently being developed, which is on feature/mpi_transport branch.

Run Instructions

General

This project is CMake-based, so cmake is required to build it.

I tested all programs on Ubuntu 18.04 machines, with Mallenox OFED v4.4.

To get started, go to script directory and run build.sh -f (subsequent builds can omit the -f flags, see below). This will generate outputs in build directory, following CMake output format.

• build.sh runs cmake and make for you. Here are the flags:
  • -f: removes everything under build folder and re-generate cmake output. This is needed for the first time.
  • -d: sets cmake build type to DEBUG. Must be used with -f.
  • -c: runs make clean before make.
• MPI is required to build MPI code:
  • setup-hpcx.sh loads the MPI library.
  • OpenMPI is used by default, and is included with OFED v4.4 (installed at /usr/mpi/gcc/openmpi-3.1.1rc1).
  • HPC-X can also be used by changing the flag in the script, but the default OpenMPI is recommended.
• Configuration files:
  • config files under script and sub-directories set up environment variables.
  • hosts.config is a plaintext list of hostnames, used for launching parallel ssh and MPI commands.
• Miscellaneous files:
  • install-tools.sh includes the packages needed.
  • setup-host.sh includes end host setup script for HPC environment.

Micro-benchmark

There are a few scripts to run the program, run the standard Mellanox perftest tool, run the program over parallel ssh, and to plot the result.

• ib_all_length.sh runs perftest latency and bandwidth benchmark programs.
• run_all_length.sh runs RDMA latency/bandwidth benchmark programs.
• mpi-launch.sh launches MPI latency/bandwidth benchmark programs.
• pssh_launch.sh launches a command over parallel-ssh.
• pssh_node.sh is the default command to run on target machines when invoking pssh_launch.sh.
• process_result.py plots both RDMA (Mellanox perftest tool) and MPI (my tool) logs, and supports latency and throughput.