festive: A Constrained Size Output Virtual Machine

An attempt at defining a small VM to handle menu interaction for size-constrained clients and servers.

Original motivation was to create a simple templating renderer for USSD clients, combined with an agnostic data-retrieval reference that may conceal any level of complexity.

Opcodes

The VM defines the following opcode symbols:

• CATCH <symbol> <signal> - Jump to symbol if signal is set (see signals below).
• CROAK <signal> - Clear state and restart execution from top if signal is set (see signals below).
• LOAD <symbol> <size> - Execute the code symbol symbol and cache the data, constrained to the given size. Can be exposed with MAP within scope,
• RELOAD <symbol> - Execute a code symbol already loaded by LOAD and cache the data, constrained to the previously given size for the same symbol.
• MAP <symbol> - Expose a code symbol previously loaded by LOAD to the rendering client. Roughly corresponds to the global directive in Python.
• MOVE <symbol> - Create a new execution frame, invalidating all previous MAP calls. More detailed: After a MOVE call, a BACK call will return to the same execution frame, with the same symbols available, but all MAP calls will have to be repeated.
• HALT - Stop execution. The remaining bytecode (typically, the routing code for the node) is returned to the invoking function.
• INCMP <arg> <symbol> - Compare registered input to arg and and move to symbol node on match. Any consecutive matches will be ignored until HALT is called.

External code

LOAD is used to execute code symbols in the host environment. It is loaded with a size constraint, and returned data violating this constraint should generate an error.

Any symbol successfully loaded with LOAD will be associated with the call stack frame it is loaded. The symbol will be available in the same frame and frames below it. Once the frame goes out of scope (e.g. BACK is called in that frame) the symbols should be freed as soon as possible. At this point they are not available to the abandoned scope.

Loaded symbols are not automatically exposed to the rendering client. To expose symbols ot the rendering client the MAP opcode must be used.

The associated content of loaded symbols may be refreshed using the RELOAD opcode. RELOAD only works within the same constraints as MAP. However, updated content must be available even if a MAP precedes a RELOAD within the same frame.

External symbol optimizations

Only LOAD and RELOAD should trigger external code side-effects.

In an effort to prevent leaks from unnecessary external code executions, the following constraints are assumed:

• An explicit MAP must exist in the scope of any LOAD.
• All symbols declared in MAP must be used for all template renderings of a specific node.

Any code compiler or checked should generate an error on any orphaned LOAD or MAP symbols as described above.

Signals

Signal may be set when executing of external code symbols, and may be used as a simple exception mechanism.

The signal flag arguments should only set a single flag to be tested. If more than one flag is set, the first flag matched will be used as the trigger.

First 8 flags are reserved and used for internal VM operations.

Rendering

The fixed-size output is generated using a templating language, and a combination of one or more max size properties, and an optional sink property that will attempt to consume all remaining capacity of the rendered template.

For example, in this example

• maxOutputSize is 256 bytes long.
• template is 120 bytes long.
• param one has max size 10 but uses 5.
• param two has max size 20 but uses 12.
• param three is a sink.

The renderer may use up to 256 - 120 - 5 - 12 = 119 bytes from the sink when rendering the output.

Multipage support

Multipage outputs, like listings, are handled using the sink output constraints:

• first calculate what the rendered display size is when all symbol results that are not sinks are resolved.
• split and cache the list data within its semantic context, given the sink limitation after rendering.
• provide a next and previous menu item to browse the prepared pagination of the list data.

Languages support

Language for rendering is determined at the top-level state.

Lookups dependent on language are prefixed by either ISO 639-1 or ISO 639-3 language codes, followed by :.

Default language means records returned without prefix if no language is set. Default language should be settable at the top-level.

Node names must be defined using 7-bit ASCII.

Virtual machine interface layout

This is the version 0 of the VM. That translates to highly experimental.

Currently the following rules apply for encoding in version 0:

• A code instruction is a big-endian 2-byte value. See vm/opcodes.go for valid opcode values.
• symbol value is encoded as one byte of string length, after which the byte-value of the string follows.
• size value is encoded as one byte of numeric length, after which the big-endian byte-value of the integer follows.
• signal value is encoded as one byte of byte length, after which a byte-array representing the defined signal follows.

Reference implementation

This repository provides a golang reference implementation for the festive concept.

In this reference implementation some constraints apply

Structure

TODO: state will be separated into cache and session.

• vm: Defines instructions, and applies transformations according to the instructions.
• state: Holds the code cache, contents cache aswell as error tates from code execution.
• resource: Retrieves data and bytecode from external symbols, and retrieves and renders templates.
• engine: Outermost interface. Orchestrates execution of bytecode against input.

Template rendering

Template rendering is done using the text/template faciilty in the golang standard library.

It expects all replacement symbols to be available at time of rendering, and has no tolerance for missing ones.

Bytecode examples

(Minimal, WIP)

0008 03666f6f 03626172     # INCMP "foo" "bar" - move to node "bar" if input is "FOO"
0001 0461696565 01 01      # CATCH "aiee" 1 1  - move to node "aiee" (and immediately halt) if input match flag (1) is not set (1)
0003 04616263 020104       # LOAD "abc" 260    - execute code symbol "abc" with a result size limit of 260 (2 byte BE integer, 0x0104)
0003 04646566 00           # LOAD "def" 0      - execute code symbol "abc" with no size limit (sink)
0005 04616263              # MAP "abc"         - make "abc" available for renderer
0007                       # HALT              - stop execution (require new input to continue)
0006 03313233              # MOVE "123"        - move to node "123" (regardless of input)
0007                       # HALT              - stop execution

Development tools

Located in the dev/ directory.

Test data generation

go run ./dev/testdata/ <directory>

Outputs bytecodes and templates for test data scenarios used in engine unit tests.

Interactive runner

go run ./dev [-d <data_directory>] [--root <root_symbol>]

Creates a new interactive session using engine.DefaultEngine, starting execution at symbol root_symbol

data_directory points to a directory where templates and bytecode is to be found (in the same format as generated by dev/testdata).

If data_directory is not set, current directory will be used.

if root_symbol is not set, the symbol root will be used.

Assembler

TBD

An assmebly language will be defined to generate the routing and execution bytecodes for each menu node.