openshmem-rs 1.5.1

Wrappers for the OpenSHMEM API.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# OpenSHMEM-rs 

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

Quick start:

```rust
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/](./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.

```.bash
├── ...
├── 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.

``` {.elisp exports="code"}
(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.