91 lines
2.7 KiB
Markdown
91 lines
2.7 KiB
Markdown
# Syndicate/rs
|
|
|
|
A Rust implementation of:
|
|
|
|
- the Syndicated Actor model, including assertion-based
|
|
communication, failure-handling, capability-style security,
|
|
dataspace entities, and facets as a structuring principle;
|
|
|
|
- the Syndicate network protocol, including
|
|
|
|
- a high-speed Dataspace indexing structure
|
|
([`skeleton.rs`](syndicate/src/skeleton.rs); see also
|
|
[HOWITWORKS.md](https://git.syndicate-lang.org/syndicate-lang/syndicate-rkt/src/commit/90c4c60699069b496491b81ee63b5a45ffd638cb/syndicate/HOWITWORKS.md)
|
|
from `syndicate-rkt`) and
|
|
|
|
- a standalone Syndicate protocol "broker" service (roughly
|
|
comparable in scope and intent to D-Bus); and
|
|
|
|
- a handful of [example programs](syndicate-server/examples/).
|
|
|
|
|
|
*The Syndicate/rs server running.*
|
|
|
|
## Quickstart
|
|
|
|
From docker or podman:
|
|
|
|
docker run -it --rm leastfixedpoint/syndicate-server /syndicate-server -p 8001
|
|
|
|
Build and run from source:
|
|
|
|
git clone https://git.syndicate-lang.org/syndicate-lang/syndicate-rs
|
|
cd syndicate-rs
|
|
cargo build --release
|
|
./target/release/syndicate-server -p 8001
|
|
|
|
If you have [`mold`](https://github.com/rui314/mold) available (`apt install mold`), you may be
|
|
able to get faster linking by creating `.cargo/config.toml` as follows:
|
|
|
|
[build]
|
|
rustflags = ["-C", "link-arg=-fuse-ld=mold"]
|
|
|
|
Enabling the `jemalloc` feature can get a *substantial* (~20%-50%) improvement in throughput.
|
|
|
|
## Running the examples
|
|
|
|
In one window, start the server with a basic configuration:
|
|
|
|
./target/release/syndicate-server -c dev-scripts/benchmark-config.pr
|
|
|
|
Then, choose one of the examples below.
|
|
|
|
### Producer/Consumer (sending messages)
|
|
|
|
In a second window, run a "consumer" process:
|
|
|
|
./target/release/examples/consumer
|
|
|
|
Finally, in a third window, run a "producer" process:
|
|
|
|
./target/release/examples/producer
|
|
|
|
### State producer/consumer (state replication)
|
|
|
|
Replace `producer` with `state-producer` and `consumer` with
|
|
`state-consumer`, respectively, in the instructions of the previous
|
|
subsection to demonstrate Syndicate *state replication*.
|
|
|
|
### Pingpong example (latency)
|
|
|
|
In a second window, run
|
|
|
|
./target/release/examples/pingpong pong
|
|
|
|
and in a third window, run
|
|
|
|
./target/release/examples/pingpong ping
|
|
|
|
The order is important - the difference between `ping` and `pong` is
|
|
about who kicks off the pingpong session.
|
|
|
|
### Performance note
|
|
|
|
You may find better performance by restricting the server to fewer
|
|
cores than you have available. For example, for me, running
|
|
|
|
taskset -c 0,1 ./target/release/syndicate-server -c dev-scripts/benchmark-config.pr
|
|
|
|
roughly *doubles* throughput for a single producer/consumer pair,
|
|
on my 48-core AMD CPU.
|