Awesome

schemeken

A Distributed Resilient Scheme Interpreter

Roots

Schemeken is the marriage of:

Ken, a platform for fault-Tolerant distributed computing.
Slip, a Scheme interpreter developed by Prof. Theo D'Hondt. It is a lean interpreter written in C to teach students the basics of language interpreters and virtual machines in a course on Programming Language Engineering.

Getting Started

Schemeken can be compiled using GNU Make and a C compiler:

$ git clone https://github.com/tvcutsem/schemeken.git
$ cd schemeken
$ make

If all goes well, a binary called schemeken will be generated. You need to supply an IP:port combination for the Ken subsystem to work, which will drop you into a functional REPL:

$ ./schemeken 127.0.0.1:6789
...
35515:Ken/ken.c:982: handler process main loop starting
Initializing...

>>>

You can define new variables and functions in this REPL and they will be persisted across runs. Let's try that now:

>>> (define (fac n) (if (< n 2) 1 (* n (fac (- n 1)))))
<procedure fac>
>>> (fac 5)
120

If you now kill this interpreter using Ctrl-C and start it again: (make sure to give the same IP/port combination!)

$ ./schemeken 127.0.0.1:6789
...
35534:Ken/ken.c:968: recovering from turn 2
...
<hit enter>

Restoring state ...
Welcome back!

>>> (fac 5)
120

Ken makes sure that all heap state is persisted across crashes. In addition, all code evaluated in a single read-eval-print loop session (or in response to an incoming remote message) is treated as an atomic transaction: either all side-effects are persisted, or none are. If the interpreter crashes in the middle of evaluating an expression, it will be restored with the last consistent state before crashing. For example:

>>> (define x 42)
42
>>>(define (loop-forever) (loop-forever))
<procedure loop-forever>
>>> (begin (set! x 0) (loop-forever))
<Kill the interpreter using Ctrl-C while evaluating the infinite loop>

Now restart and check the value of x:

$ ./schemeken 127.0.0.1:6789
...
35534:Ken/ken.c:968: recovering from turn 6
...
<hit enter>

Restoring state ...
Welcome back!

>>> x
42

For a more elaborate tutorial on Schemeken's features, check out the take-a-number tutorial.

Language features

As Schemeken is built on the SLIP interpreter, it supports a minimal subset of Scheme. Most notable is lack of support for hygienic macros and file I/O procedures. See Slip/SlipNative.c:30 for a list of supported primitives.

Schemeken adds the following primitives to make use of Ken's messaging system:

(ken-id): returns the current Ken ID.
```
>>> (ken-id)
<ken-id 127.0.0.1:6789>
```
Ken IDs are first class values: you can store them or pass them around like any other value. You can embed Ken IDs into your Schemeken program by typing #k followed by an IP address/port, for example #k127.0.0.1:6789. There is a shorthand for local Ken IDs: #kXXXX is the same as #k127.0.0.1:XXXX.
(ken-send <ken-id> <expr>): Sends a value as a message to the given Ken process. Messages are serialized as their printed representation and deserialized as if read by the (read) primitive. This means valid messages currently include numbers, booleans, symbols, strings, characters, vectors and lists, but not procedures or continuations.
```
>>> (ken-send (ken-id) "Hello, world")
>>>
Received message from 127.0.0.1:6789:
Hello, world
Message end.
```
(set! ken-receive-handler (lambda (id msg) <expr>)): the global variable ken-receive-handler points to a procedure that processes incoming messages. The procedure takes as first argument the ken-id of the sender and as second argument the deserialized message. <expr> is evaluated as a separate "turn", and thus thanks to Ken as an "ACID" transaction. The default receive handler just displays the id and msg on the console.

Future and related work

In coming versions we plan to layer a more elaborate messaging system on top of the Ken primitives, such as asynchronous messages with promises (non-blocking futures).
SchemeKen inspired the work on v8ken, a distributed, resilient JavaScript engine.

Team

Schemeken was developed at the Software Languages Lab, Vrije Universiteit Brussel.

Questions? Contact us!

Schemeken is based on SLIP, a Scheme interpreter written by Prof. Theo D'Hondt.