
  This file is provided under a dual BSD/GPLv2 license.  When using or
  redistributing this file, you may do so under either license.

  GPL LICENSE SUMMARY

  Copyright(c) 2018 Intel Corporation.

  This program is free software; you can redistribute it and/or modify
  it under the terms of version 2 of the GNU General Public License as
  published by the Free Software Foundation.

  This program is distributed in the hope that it will be useful, but
  WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  General Public License for more details.

  Contact Information:
  Intel Corporation, www.intel.com

  BSD LICENSE

  Copyright(c) 2018 Intel Corporation.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions
  are met:

    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in
      the documentation and/or other materials provided with the
      distribution.
    * Neither the name of Intel Corporation nor the names of its
      contributors may be used to endorse or promote products derived
      from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

  Copyright (c) 2018 Intel Corporation. All rights reserved.

================================================================================

INTRODUCTION
============
This directory contains psm2-level bandwidth and latency benchmarks.
These benchmarks do not rely on MPI or any other non-psm2 protocols to setup or
run. Latency, uni-directional bandwidth and bi-directional bandwidth benchmarks
are provided.

COMPILATION
===========
Please install the libpsm2-devel package before attempting to build as the
benchmarks depend on the libpsm2-devel package.

Running 'make' on the command line will produce the following binaries:
1. latency
This is a uni-directional latency benchmark.
2. bw-mrate
This is a uni-directional bandwidth benchmark.
3. bi-bw-mrate
This is a bi-directional bandwidth benchmark.

USAGE REQUIREMENTS
==================
Two nodes are utilized to run these benchmarks.
One node acts as a server and the other will be a client.
The only runtime requirement is libpsm2.

RUNNING THE BENCHMARKS
======================
All three benchmarks have the same runtime arguments.

Example for latency:
Server:
./latency

Client:
./latency server_hostname

BENCHMARK ARGUMENTS:
====================
usage: ./latency [server] [-m size] [-M size] [-f --flush] [-h --help]
options:
server, server node to connect to, this node will be the client
-m, starting message size in bytes (default 1)
-M, ending message size in bytes (default 4194304)
-f/--flush, flush L3 cache before benchmark
--mqstats, show psm2 mq counters
-h/--help, show this help message


SAMPLE OUTPUT
=============

-bash-4.2$ ./latency
# PSM2 Ping Pong Latency Test
# Message Size(B)      Latency(us)
1                         xxx.yy
2                         xxx.yy
4                         xxx.yy
8                         xxx.yy
16                        xxx.yy
32                        xxx.yy
64                        xxx.yy
128                       xxx.yy
256                       xxx.yy
512                       xxx.yy
1024                      xxx.yy
2048                      xxx.yy
4096                      xxx.yy
8192                      xxx.yy
16384                     xxx.yy
32768                     xxx.yy
65536                     xxx.yy
131072                    xxx.yy
262144                    xxx.yy
524288                    xxx.yy
1048576                   xxx.yy
2097152                   xxx.yy
4194304                   xxx.yy
-bash-4.2$ ./bi-bw-mrate
# PSM2 Bi-directional Bandwidth, Message Rate Test
# Message Size(B)  Bandwidth(MB/s)  Message Rate(Mmps)
1                       xxxxx.yy                x.yy
2                       xxxxx.yy                x.yy
4                       xxxxx.yy                x.yy
8                       xxxxx.yy                x.yy
16                      xxxxx.yy                x.yy
32                      xxxxx.yy                x.yy
64                      xxxxx.yy                x.yy
128                     xxxxx.yy                x.yy
256                     xxxxx.yy                x.yy
512                     xxxxx.yy                x.yy
1024                    xxxxx.yy                x.yy
2048                    xxxxx.yy                x.yy
4096                    xxxxx.yy                x.yy
8192                    xxxxx.yy                x.yy
16384                   xxxxx.yy                x.yy
32768                   xxxxx.yy                x.yy
65536                   xxxxx.yy                x.yy
131072                  xxxxx.yy                x.yy
262144                  xxxxx.yy                x.yy
524288                  xxxxx.yy                x.yy
1048576                 xxxxx.yy                x.yy
2097152                 xxxxx.yy                x.yy
4194304                 xxxxx.yy                x.yy
-bash-4.2$ ./bw-mrate
# PSM2 Uni-directional Bandwidth, Message Rate Test
# Message Size(B)  Bandwidth(MB/s)  Message Rate(Mmps)
1                       xxxxx.yy                x.yy
2                       xxxxx.yy                x.yy
4                       xxxxx.yy                x.yy
8                       xxxxx.yy                x.yy
16                      xxxxx.yy                x.yy
32                      xxxxx.yy                x.yy
64                      xxxxx.yy                x.yy
128                     xxxxx.yy                x.yy
256                     xxxxx.yy                x.yy
512                     xxxxx.yy                x.yy
1024                    xxxxx.yy                x.yy
2048                    xxxxx.yy                x.yy
4096                    xxxxx.yy                x.yy
8192                    xxxxx.yy                x.yy
16384                   xxxxx.yy                x.yy
32768                   xxxxx.yy                x.yy
65536                   xxxxx.yy                x.yy
131072                  xxxxx.yy                x.yy
262144                  xxxxx.yy                x.yy
524288                  xxxxx.yy                x.yy
1048576                 xxxxx.yy                x.yy
2097152                 xxxxx.yy                x.yy
4194304                 xxxxx.yy                x.yy
