Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Sandia-OpenSHMEM/SOS

Sandia OpenSHMEM is an implementation of the OpenSHMEM specification over multiple Networking APIs, including Portals 4, the Open Fabric Interface (OFI), and UCX. Please click on the Wiki tab for help with building and using SOS.
https://github.com/Sandia-OpenSHMEM/SOS

hpc middleware openshmem parallel-computing pgas

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/Sandia-OpenSHMEM/SOS
Owner: Sandia-OpenSHMEM
License: other
Created: 2015-09-15T15:34:37.000Z (about 9 years ago)
Default Branch: main
Last Pushed: 2024-06-26T20:10:16.000Z (3 months ago)
Last Synced: 2024-06-27T00:27:16.725Z (3 months ago)
Topics: hpc, middleware, openshmem, parallel-computing, pgas
Language: C
Homepage:
Size: 5.33 MB
Stars: 58
Watchers: 23
Forks: 52
Open Issues: 108
Metadata Files:
- Readme: README
- Changelog: NEWS
- License: LICENSE

Awesome Lists containing this project

README

Sandia OpenSHMEM
----------------

* About

Sandia OpenSHMEM is an implementation of the OpenSHMEM specification over
Portals 4.0, the Open Fabrics Interface (OFI), and XPMEM.

Please refer to the "tests-sos" repository (https://github.com/openshmem-org/tests-sos)
to download only the unit tests and the performance test suite that are
included with Sandia OpenSHMEM.

* Building

The Sandia OpenSHMEM implementation utilizes the GNU Autoconf/Automake/Libtool
tools to generate a configure script. If the `configure` file is not present
(e.g. after downloading the repository for the first time), generate it
by running:

$ ./autogen.sh

Once the configure file exists, run:

$ ./configure
$ make
$ make check
$ make install

The "make check" step is not strictly necessary, but is a good idea. Make
check utilizes the TEST_RUNNER and NPROCS make variables, which can be used to
override defaults, e.g. "make check NPROCS=4" or "make check
TEST_RUNNER='mpiexec -n 2 -ppn 1 -hosts compute1,compute2'".

Sandia OpenSHMEM must be configured to use either the Portals 4 or OFI network
transport, but not both. It can optionally be configured to use XPMEM or CMA
to optimize communication between PEs within the same shared memory domain.

Options to configure include:

--prefix= Install implementation in , default: /usr/local
--with-portals4= Find the Portals 4 library in
--with-ofi= Find the libfabric library in
--with-xpmem= Find the XPMEM library in
--with-cma Use cross-memory attach for on-node communication
--with-pmi=DIR Location of PMI installation. Configure will
automatically look for the PMI runtime provided by
the Portals 4 reference implementation
--enable-pmi-simple Include support for interfacing with a PMI 1.0
launcher. The launcher must be provided by a
separate package, such as MPICH, Hydra, or SLURM.
--enable-error-checking Enable error checking in SHMEM calls. This will
increase the overhead of communication operations.
--enable-hard-polling When using only the network transport, the
implementation will use counting events to
block the implementation when waiting for
local memory changes. On some implementations,
enabling hard polling may increase target side
message rate.
--enable-remote-virtual-addressing
Enable optimizations assuming the symmetric heap is
always symmetric with regards to virtual address.
This may cause applications to abort during
shmem_init() if such a symmetric heap can not be
created, but will reduce the instruction count for
some operations. This optimization also requires
that the Portals 4 implementation support
BIND_INACCESSIBLE on LEs. This optimization will
reduce the overhead of communication calls.
--disable-fortran Disable the Fortran bindings. This may be useful
if the machine has a Fortran compiler which does
not support ISO_C_BINDING.
--enable-nonblocking-fence
By default, shmem_fence() is equivalent to
shmem_quiet(), which can be a lengthy
operation. Enabling this feature results in
the ordering point being moved from the
shmem_fence() to the next put-like call,
which can help improve overlap in some
cases.
--enable-total-data-ordering=
If a network supports total data ordering
(that is, ordering guarantees to two
different addresses on the same target
node), this option can remove the
shmem_quiet() from shmem_fence() calls when
sending short messages. The option does,
however, force ordering requirements on the
network, so experimentation may be necessary
to determine the best configuration. Yes
means always assume total data ordering is
available and abort a job if that's not the
case. No means never use total data
ordering optimizations. Check will result
in slightly higher overhead than "yes", but
will provide a fallback if the network
doesn't provide total data ordering.

There are many other options to configure to influence performance and
behavior. See 'configure --help' for documentation on available
options.

* SHMEM Runtime Support

Environment variables:

SHMEM_VERSION: if defined, print SHMEM version during start_pes().

SHMEM_INFO: if defined, print (stdout) SHMEM environment variables.

SHMEM_SYMMETRIC_SIZE (default: 64 MiB)
The allocated size of the symmetric heap which shmalloc() and shfree()
operates on. The size value can be scaled with a suffix of
'K' for kilobytes (B * 1024),
'M' for Megabytes (KiB * 1024)
'G' for Gigabytes (MiB * 1024)

SHMEM_BOUNCE_SIZE (default: 2 KiB)
The maximum size of a bounce buffer for put messages.
Messages greater than the immediate send value for the
underlying network but greater than this threshold will be
copied into a bounce buffer and then sent.

SHMEM_MAX_BOUNCE_BUFFERS (default: 128)
The maximum number of bounce buffers that can be created per context.

SHMEM_COLL_CROSSOVER (default: 4)
For num_pes < SHMEM_COLL_CROSSOVER, collective algorithms are
serial instead of tree based.

SHMEM_COLL_SIZE_CROSSOVER (default: 16kiB)
For size < SHMEM_COLL_SIZE_CROSSOVER, collective algorithms are
optimized for latency, rather than bandwidth.

SHMEM_COLL_RADIX (default: 4)
Controls the width of the n-ary tree for collectives, such that each
node will fanout-send to a max of approximately SHMEM_COLL_RADIX

SHMEM_SYMMETRIC_HEAP_USE_MALLOC (default: 0)
If set to a non-zero integer, will use malloc() instead of
mmap() to allocate the symmetric heap. This option may result in
incorrect behavior when remote virtual addressing is enabled.

SHMEM_BARRIER_ALGORITHM (default: auto)
Algorithm to use for barriers. Default is to auto-select (which
may result in different algorithms being used for different
PE sets). Options are: auto, linear, tree, dissem.

SHMEM_BCAST_ALGORITHM (default: auto)
Algorithm to use for broadcasts. Default is to auto-select (which
may result in different algorithms being used for different
PE sets). Options are: auto, linear, tree.

SHMEM_REDUCE_ALGORITHM (default: auto)
Algorithm to use for reductions. Default is to auto-select (which
may result in different algorithms being used for different
PE sets). Options are: auto, linear, tree, recdbl, ring.

SHMEM_COLLECT_ALGORITHM (default: auto)
Algorithm to use for allgathers. Default is to auto-select (which
may result in different algorithms being used for different
PE sets). Options are: auto, linear.

SHMEM_FCOLLECT_ALGORITHM (default: auto)
Algorithm to use for allgathers with fixed contribution amounts.
Default is to auto-select (which may result in different
algorithms being used for different PE sets).
Options are: auto, linear, ring, recdbl. Note that recursive
doubling (recdbl) will fall back to ring if the PE set is not a
power of two in size.

SHMEM_BARRIERS_FLUSH (default: off)
If defined, standard output (stdout) and error (stderr) streams
will be flushed at the beginning of each barrier operation.

SHMEM_CMA_PUT_MAX (default: 8192)
'--with-cma', shmem put lengths <= CMA_PUT_MAX use process_vm_writev();
otherwise use Portals4 transport put.

SHMEM_CMA_GET_MAX (default: 16384)
'--with-cma', shmem get lengths <= CMA_GET_MAX use process_vm_readv();
otherwise use Portals4 transport get.

SHMEM_SYMMETRIC_HEAP_USE_HUGE_PAGES (default: off)
If defined, large pages will be used to back the symmetric heap. This
feature is only available on Linux.

SHMEM_SYMMETRIC_HEAP_PAGE_SIZE (default: 2MB)
Used to specify a large page size when using large pages to back the
symmetric heap. Ignored if SHMEM_SYMMETRIC_HEAP_USE_HUGE_PAGES is not
set. Refer to SHMEM_SYMMETRIC_SIZE for input syntax.

SHMEM_DISABLE_ASLR_CHECK (default: on)
Disable runtime checks for address space layout randomization (ASLR).

OFI Transport Environment variables:

SHMEM_OFI_PROVIDER (default: auto)
The name of the provider that should be used by the OFI transport.
Shell-style wildcards, including * and ?, are allowed. The fi_info
utility included with libfabric can be used for assistance with
identifying the desired provider.

SHMEM_OFI_FABRIC (default: auto)
The name of the fabric that should be used by the OFI transport.
Shell-style wildcards, including * and ?, are allowed. The fi_info
utility included with libfabric can be used for assistance with
identifying the desired fabric.

SHMEM_OFI_DOMAIN (default: auto)
The name of the fabric domain that should be used by the OFI transport.
Shell-style wildcards, including * and ?, are allowed. The fi_info
utility included with libfabric can be used for assistance with
identifying the desired fabric domain.

SHMEM_OFI_ATOMIC_CHECKS_WARN (default: off)
If defined, OFI will not abort if fabric provider doesn't support every
data type x op combination, instead it will print a warning.

SHMEM_OFI_TX_POLL_LIMIT (default: 0)
Sets the maximum number of iterations for the transmit polling loop
(for put/quiet operations). Setting this to -1 enables continuous
completion polling (i.e. there is no polling limit). The default
behavior is to call fi_cntr_wait without polling.

SHMEM_OFI_RX_POLL_LIMIT (default: 0)
Sets the maximum number of iterations for the receive polling loop (for
get/wait operations). Setting this to -1 enables continuous completion
polling (i.e. there is no polling limit). The default behavior is to
call fi_cntr_wait without polling.

SHMEM_OFI_STX_MAX (default: 1)
Sets the maximum number of sharable transmit contexts (STXs) per PE.
STXs are the underlying transmit resources that are allocated to
OpenSHMEM contexts and they are allocated using the algorithm specified
by the SHMEM_OFI_STX_ALLOCATOR parameter.

SHMEM_OFI_STX_ALLOCATOR (default: round-robin)
Algorithm for allocating STX resources to OpenSHMEM contexts. In
particular, the algorithm determines how resources are shared by
contexts once all STXs have been allocated. Options are: round-robin,
random.

SHMEM_OFI_STX_THRESHOLD (default: 1)
Number of contexts that must be allocated to all shared STXs before
another shared STX can be allocated. This threshold can be increased
to reduce the number of shared STXs and increase the number of STXs
available for private use (i.e., with contexts that enable the
SHMEM_CTX_PRIVATE option).

SHMEM_OFI_STX_DISABLE_PRIVATE (default: off)
Disable STX privatization. Enabling this may improve load balance
across transmit resources, especially in scenarios where the number of
contexts exceeds the number of STXs.

SHMEM_OFI_STX_AUTO (default: off)
Automatically determine an appropriate value for the number of STXs per
compute node, and evenly partition them across PEs on the same node. A
compute node is determined by its unique hostname, and the number of
STXs available on a compute node is provided by the libfabric library.

SHMEM_OFI_DISABLE_MULTIRAIL (default: off)
Disable multirail functionality. Enabling this will restrict all
communications to occur over a single NIC per system.

Team Environment variables:

SHMEM_TEAMS_MAX (default: 10)
Sets the maximum number of available teams per PE, including the
predefined teams. The maximum supported value is 64. The value must
be the same across all PEs in SHMEM_TEAM_WORLD.

SHMEM_TEAM_SHARED_ONLY_SELF (default: off)
If defined, the predefined team, SHMEM_TEAM_SHARED, will only include
the self PE.

Debugging Environment variables:

SHMEM_DEBUG (default: off)
If defined enables debugging messages from OpenSHMEM runtime.

SHMEM_TRAP_ON_ABORT (default: off)
If defined, generate a trap when aborting an OpenSHMEM program. This
can be used to interface with a debugger or generate core files.

SHMEM_BACKTRACE (default: )
Can be used to choose the backtracing mechanism. Default value is NULL
for which no backtrace information is provided upon failure. User can set
this with any one of these available options: execinfo, gdb, auto.