Skip to content

Latest commit

 

History

History

src

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Makefile
Makefile
 
 
Makefile.esdk
Makefile.esdk
 
 
README.md
README.md
 
 
__shmem_clear_lock.c
__shmem_clear_lock.c
 
 
__shmem_lock_ptr.c
__shmem_lock_ptr.c
 
 
__shmem_set_lock.c
__shmem_set_lock.c
 
 
__shmem_test_lock.c
__shmem_test_lock.c
 
 
def_shmem_alltoall_x.h
def_shmem_alltoall_x.h
 
 
def_shmem_alltoalls.h
def_shmem_alltoalls.h
 
 
def_shmem_broadcastx.h
def_shmem_broadcastx.h
 
 
def_shmem_collect_n.h
def_shmem_collect_n.h
 
 
def_shmem_fcollect_n.h
def_shmem_fcollect_n.h
 
 
def_shmem_x_atomic_add.h
def_shmem_x_atomic_add.h
 
 
def_shmem_x_atomic_and.h
def_shmem_x_atomic_and.h
 
 
def_shmem_x_atomic_compare_swap.h
def_shmem_x_atomic_compare_swap.h
 
 
def_shmem_x_atomic_fetch.h
def_shmem_x_atomic_fetch.h
 
 
def_shmem_x_atomic_fetch_add.h
def_shmem_x_atomic_fetch_add.h
 
 
def_shmem_x_atomic_fetch_and.h
def_shmem_x_atomic_fetch_and.h
 
 
def_shmem_x_atomic_fetch_inc.h
def_shmem_x_atomic_fetch_inc.h
 
 
def_shmem_x_atomic_fetch_or.h
def_shmem_x_atomic_fetch_or.h
 
 
def_shmem_x_atomic_fetch_xor.h
def_shmem_x_atomic_fetch_xor.h
 
 
def_shmem_x_atomic_inc.h
def_shmem_x_atomic_inc.h
 
 
def_shmem_x_atomic_or.h
def_shmem_x_atomic_or.h
 
 
def_shmem_x_atomic_set.h
def_shmem_x_atomic_set.h
 
 
def_shmem_x_atomic_swap.h
def_shmem_x_atomic_swap.h
 
 
def_shmem_x_atomic_xor.h
def_shmem_x_atomic_xor.h
 
 
def_shmem_x_get.h
def_shmem_x_get.h
 
 
def_shmem_x_iget.h
def_shmem_x_iget.h
 
 
def_shmem_x_iput.h
def_shmem_x_iput.h
 
 
def_shmem_x_put.h
def_shmem_x_put.h
 
 
def_shmem_x_test.h
def_shmem_x_test.h
 
 
def_shmem_x_to_all.h
def_shmem_x_to_all.h
 
 
def_shmem_x_wait.h
def_shmem_x_wait.h
 
 
def_shmem_x_wait_until.h
def_shmem_x_wait_until.h
 
 
internals.h
internals.h
 
 
shmem.h
shmem.h
 
 
shmem_align.c
shmem_align.c
 
 
shmem_alltoall32.c
shmem_alltoall32.c
 
 
shmem_alltoall64.c
shmem_alltoall64.c
 
 
shmem_alltoalls32.c
shmem_alltoalls32.c
 
 
shmem_alltoalls64.c
shmem_alltoalls64.c
 
 
shmem_barrier.c
shmem_barrier.c
 
 
shmem_barrier_all.c
shmem_barrier_all.c
 
 
shmem_broadcast32.c
shmem_broadcast32.c
 
 
shmem_broadcast64.c
shmem_broadcast64.c
 
 
shmem_calloc.c
shmem_calloc.c
 
 
shmem_clear_lock.c
shmem_clear_lock.c
 
 
shmem_collect32.c
shmem_collect32.c
 
 
shmem_collect64.c
shmem_collect64.c
 
 
shmem_complexd_prod_to_all.c
shmem_complexd_prod_to_all.c
 
 
shmem_complexd_sum_to_all.c
shmem_complexd_sum_to_all.c
 
 
shmem_complexf_prod_to_all.c
shmem_complexf_prod_to_all.c
 
 
shmem_complexf_sum_to_all.c
shmem_complexf_sum_to_all.c
 
 
shmem_ctx_create.c
shmem_ctx_create.c
 
 
shmem_ctx_destroy.c
shmem_ctx_destroy.c
 
 
shmem_ctx_quiet.c
shmem_ctx_quiet.c
 
 
shmem_double_atomic_fetch.c
shmem_double_atomic_fetch.c
 
 
shmem_double_atomic_set.c
shmem_double_atomic_set.c
 
 
shmem_double_atomic_swap.c
shmem_double_atomic_swap.c
 
 
shmem_double_max_to_all.c
shmem_double_max_to_all.c
 
 
shmem_double_min_to_all.c
shmem_double_min_to_all.c
 
 
shmem_double_prod_to_all.c
shmem_double_prod_to_all.c
 
 
shmem_double_sum_to_all.c
shmem_double_sum_to_all.c
 
 
shmem_fcollect32.c
shmem_fcollect32.c
 
 
shmem_fcollect64.c
shmem_fcollect64.c
 
 
shmem_finalize.c
shmem_finalize.c
 
 
shmem_float_atomic_fetch.c
shmem_float_atomic_fetch.c
 
 
shmem_float_atomic_set.c
shmem_float_atomic_set.c
 
 
shmem_float_atomic_swap.c
shmem_float_atomic_swap.c
 
 
shmem_float_max_to_all.c
shmem_float_max_to_all.c
 
 
shmem_float_min_to_all.c
shmem_float_min_to_all.c
 
 
shmem_float_prod_to_all.c
shmem_float_prod_to_all.c
 
 
shmem_float_sum_to_all.c
shmem_float_sum_to_all.c
 
 
shmem_free.c
shmem_free.c
 
 
shmem_get128.c
shmem_get128.c
 
 
shmem_get128_nbi.c
shmem_get128_nbi.c
 
 
shmem_get16.c
shmem_get16.c
 
 
shmem_get16_nbi.c
shmem_get16_nbi.c
 
 
shmem_get32.c
shmem_get32.c
 
 
shmem_get32_nbi.c
shmem_get32_nbi.c
 
 
shmem_get64.c
shmem_get64.c
 
 
shmem_get64_nbi.c
shmem_get64_nbi.c
 
 
shmem_get8.c
shmem_get8.c
 
 
shmem_get8_nbi.c
shmem_get8_nbi.c
 
 
shmem_global_exit.c
shmem_global_exit.c
 
 
shmem_header_only.h
shmem_header_only.h
 
 
shmem_iget128.c
shmem_iget128.c
 
 
shmem_iget16.c
shmem_iget16.c
 
 
shmem_iget32.c
shmem_iget32.c
 
 
shmem_iget64.c
shmem_iget64.c
 
 
shmem_iget8.c
shmem_iget8.c
 
 
shmem_info_get_name.c
shmem_info_get_name.c
 
 
shmem_info_get_version.c
shmem_info_get_version.c
 
 
shmem_init.c
shmem_init.c
 
 
shmem_init_thread.c
shmem_init_thread.c
 
 
shmem_int32_atomic_add.c
shmem_int32_atomic_add.c
 
 
shmem_int32_atomic_and.c
shmem_int32_atomic_and.c
 
 
shmem_int32_atomic_compare_swap.c
shmem_int32_atomic_compare_swap.c
 
 
shmem_int32_atomic_fetch.c
shmem_int32_atomic_fetch.c
 
 
shmem_int32_atomic_fetch_add.c
shmem_int32_atomic_fetch_add.c
 
 

README.md

Notes on Memory Management

Within the context of the Epiphany architecture, shmem_malloc(), shmem_free(), shmem_realloc(), and shmem_align() shouldnot be used. Instead, the lower-levelshmemx_sbrk(), and shmemx_brk()` should be used to acquire and release memory resources. The operations should also be symmetric for each processing element.

If you must use the malloc/free/realloc/align routines, you must adhere to the following rules:

  1. shmem_free() must be called in the reverse order of allocation
  2. shmem_realloc() can only be used on the last (re)allocated pointer
  3. shmem_align() alignment must be a power of 2 greater than 8 (default is 8)

Failure to follow these rules will result in undefined behavior.

Extensions

As mentioned above, shmemx_sbrk() and shmemx_brk() should be used for memory management.

Compile-time options include:

Option Description
SHMEM_HEAP_START # minimum local address of SHMEM heap
SHMEM_USE_UNSAFE use performance features at your own peril
SHMEM_USE_WAND_BARRIER hardware accelerated shmem_barrier_all()
SHMEM_USE_IPI_GET shmem_*_get() use inter-processor interrupts
SHMEM_USE_HEADER_ONLY feature avoids linking with -lshmem; enables \
higher performance, smaller program footprint

Building

This directory contains all of the OpenSHMEM routines and other supplemental routines. Separate files for each routine are required to reduce the total binary size when compiling with the library. You may install the shmem.h header and libshmem.a library wherever you like but shmem.h must be expanded first or take all include all code. The test codes within the ../test directory will use the relative path to the header and library during compilation.

Choose the makefile for the SDK you'll be developing. The default with make targets the COPRTHR-2 SDK. Alternatively, you can build and install for the native eSDK with:

make -f Makefile.esdk
sudo make -f Makefile.esdk install

The install expands shmem.h to include all code with the compile-time options you selected.

Then test and benchmark the code in the test directory. This is optional and presently works only with the COPRTHR-2 SDK. You make use make run or make check

You may also run the example codes. The directory name prefixes of c_ and e_ are for use with the COPRTHR-2 SDK and eSDK, respectively.