docs.rs failed to build openshmem-rs-1.5.1
Please check the build logs for more information.
See Builds for ideas on how to fix a failed build, or Metadata for how to configure docs.rs builds.
If you believe this is docs.rs' fault, open an issue.

Visit the last successful build: openshmem-rs-1.5.3-1

OpenSHMEM-rs

Rust bindings for the OpenSHMEM 1.5 (and soon 1.6) communication API.

Quick start:

let ctx = ShmemCtx::init()?;
let my_pe = ctx.my_pe().raw();
let npes = ctx.n_pes();
println!("Hello from PE {my_pe}!");

Examples

See ./examples/ for example programs.

Building

This library depends on openshmem-sys{.txt}. Building the sys crate requires the environment variable SHMEM_INSTALL_DIR{.txt} to point to a directory containing your OpenSHMEM installation. Your SHMEM_INSTALL_DIR{.txt} should contain a lib/{.txt} and a include/{.txt}. For example, this is the output of tree{.txt} on the SHMEM_INSTALL_DIR{.txt} for Sandia OpenSHMEM.

├── ...
├── include/
│   ├── mpp/
│   ├── shmem-def.h
│   ├── shmem.fh
│   ├── shmem.h
│   ├── shmemx-def.h
│   ├── shmemx.fh
│   └── shmemx.h
├── lib/
│   ├── libsma.0.dylib
│   ├── libsma.a
│   └── ...
└── ...

We currently test with Sandia OpenSHMEM as the underlying OpenSHMEM implementation.

Developing

If you want rust-analyzer to function correctly, you'll need to pass SHMEM_INSTALL_DIR{.txt} to rust-analyzer.

[TODO] VSCode

Emacs (lsp-mode)

Add this to your configuration.

(setq lsp-rust-analyzer-cargo-extra-env ["SHMEM_INSTALL_DIR", "~/my-shmem-install-dir"])

Prior Work

Rebecca Hassett and Tony Curtis at Stony Brook University created the RustySHMEM project, which this library draws heavy inspiration from.