aquavm/README.md

77 lines
2.4 KiB
Markdown
Raw Normal View History

2020-09-30 22:24:30 +03:00
# Aquamarine
2020-11-05 15:01:27 +03:00
<p width="100%">
<img alt="aquamarine scheme" align="right" src="images/aquamarine.png" width="550"/>
</p>
Aquamarine is a distributed choreography platform, controlled by AIR language
<br/><br/><br/><br/><br/><br/>
## Aquamarine Intermediate Representation
### AIR: What is it?
- S-expression-based low-level language
- Controls Fluence network and its peers
- Inspired by WAT (WebAssembly Text Format)
- Meant to be a compile target
- Development meant to happen in a higher-level language
- Syntax is in flux, will change
Scripts written in AIR look like this:
<img alt="fold example" src="images/fold_example.png" width="100%"/>
1. Gather chat members by calling chat.members
2. Iterate through elements in members array, m = element
3. Each m is an object, represented as array; [0] is the first field
4. `(next m)` triggers next iteration
### AIR: Instructions
#### call: execution
<img alt="call structure" src="images/call_data.png" width="670"/>
- `call` commands the execution
- takes network `location`, `service id`, `function name`, `list of function arguments`, and an `output name`
- moves execution to a peer, specified by `location`
- peer must have the specified WASM `service` running
- the `service` must have specified `function` available to be called
- `argument list` is given to the `function`
- result of the `function` is saved and available under `output name`
- example call could be thought of as `data.result = dht.put(key, value)`
#### seq: sequential
<img alt="seq structure" src="images/seq.png" width="586"/>
- `seq` takes two instructions
- executes them sequentially
#### par: parallel
<img alt="par structure" src="images/par.png" width="536"/>
- `par` takes two instructions
- executes them in parallel
#### fold: iteration
<img alt="fold structre" src="images/fold.png" width="536"/>
- `fold` takes an array, a variable and an instruction
- iterates through the array, assigning each element to the variable
- on each iteration instruction is executed
- instruction can read the variable
- `next` triggers next iteration
#### xor: branching & error handling
<img alt="xor structure" src="images/xor.png" width="577"/>
- `xor` takes two instructions
- iff first instruction fails, second one is executed
#### null
<img alt="null structure" src="images/null.png" width="577"/>
- `null` takes no arguments
- does nothing, useful for code generation