rex/nofi
1
0
Fork 0
mirror of https://github.com/ct-clmsn/nofi/ synced 2026-01-15 04:41:43 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
36 commits 1 branch 0 tags 56 KiB
Find a file
Exact
ctaylor 28fc1d6cf9 :Merge branch 'main' of https://github.com/ct-clmsn/nofi into main
2022-03-10 02:11:15 +00:00
nofi improved argument semantics for put and get 2022-02-27 22:08:25 -05:00
tests initial import 2022-02-27 01:14:53 +00:00
.gitignore initial import 2022-02-27 01:14:53 +00:00
LICENSE initial import 2022-02-27 01:14:53 +00:00
makefile initial import 2022-02-27 01:14:53 +00:00
nofi.nim initial import 2022-02-27 01:14:53 +00:00
nofi.nimble updated license 2022-03-10 02:11:04 +00:00
nofi.spdx initial import 2022-02-27 01:14:53 +00:00
README.md updated readme 2022-02-27 22:16:12 -05:00

README.md

nofi - Nim OpenFabrics Interface

Nofi wraps the existing rofi interface implemented by Pacific Northwest National Laboratory (PNNL). Nofi provides the Nim programming language support for RDMA distributed communication (put and get), fundamental operations for PGAS applications.

This library extends rofi by providing a sequence type that wraps memory registered with the underlying rofi RDMA communicaton library. The sequence type only supports values that are of SomeNumber types. The sequence type provides element-access, slice, iterator, and partitioning support.

Additional functionality is provided to handle asynchronous put and get operations using Nim's defer statements, combining templates with try statements, and futures.

Nim applications using nofi require static compilation and linking!

Install

Download and install rofi

./configure --prefix=<PATH_TO_INSTALL_DIR>
make && make install
export LD_LIBRARY_PATH=<PATH_TO_INSTALL_DIR>/lib:$LD_LIBRARY_PATH

Modify makefile to point LIBDIR and INCDIR to the path set in <PATH_TO_INSTALL_DIR>. Use the makefile to see if your setup compiles.

make

Use the nimble tool to install nofi

nimble install nofi

Generate documentation from source

nimble doc nofi

Important Developer Notes

Nofi demonstrates the versitility of the rofi library and it's value as a lightweight technology for extending RDMA support via libfabric to languages that have a FFI (foreign function interface) compatible with C.

Users need to review the rofi documentation prior to using this library in order to understand rofi's feature set and potential limitations.

This library requires static compilation of an end user's Nim program. Please review the makefile to learn how to enable static compilation and linking with the Nim compiler.

Users must initialize and terminate all programs using nofi_init and nofi_finit. Not taking this step will result in undefined behavior.

Users are strongly encouraged to utilize Nim blocks and scoping rules to managing memory that has been registered with nofi. Users can review 'tests/test_sharray.nim' for an example of memory management using Nim blocks and scopes.

Examples

The directory 'tests/' provides several examples regarding how to interact with this library.

Licenses

  • nofi is Boost Version 1.0 (2022-)
  • rofi is BSD License (2020)

Date

24 February 2022

Author

Christopher Taylor

Special Thanks to the ROFI authors

Many Thanks

  • The Nim community and user/developer forum

Dependencies

rofi Dependencies