Files
regorus/tests/rvm/vm/suites/constructed_collections.yaml
Anand Krishnamoorthi 49bd3c22f3 feat!: add Rego Virtual Machine (RVM) implementation (#495)
* feat!: add Rego Virtual Machine (RVM) implementation

This commit introduces a register-based virtual machine for executing Rego
policies with bytecode-style instructions. Unlike the existing tree-walking
interpreter, the RVM compiles policies into instruction sequences that operate
on virtual registers, offering better performance and optimization potential.

Core Components:

Instruction Set Architecture:
- Define instruction types for data operations, control flow, and builtins
- Implement instruction parameter encoding and display formatting
- Add instruction parser with comprehensive test coverage

Virtual Machine Engine:
- Register-based execution model with program counter management
- Loop execution supporting iterators, comprehensions, and quantifiers
- Function call handling with argument evaluation and context management
- Rule evaluation with default value resolution and virtual data support
- Arithmetic and comparison operation implementations

Program Representation:
- Program listing builder with instruction sequencing
- Rule tree construction for organizing policy rules
- Binary and JSON serialization for compiled programs
- Recompilation support for program modification

Testing Infrastructure:
- Extensive YAML test suites covering all VM features
- Rust unit tests for VM execution and instruction parsing
- Test suites for loops, comprehensions, builtins, and control flow

BREAKING CHANGE: Introduces new VM execution path alongside interpreter

Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com>

* docs: add detailed RVM architecture references

Introduce architecture.md explaining program artifacts, serialization, and runtime subsystems.
Document the full opcode catalog in instruction-set.md, including operands, parameter tables, and outcomes.
Walk through execution flow, stacks, and operational guidance in vm-runtime.md, tying the runtime to the new architecture docs.

Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com>

---------

Signed-off-by: Anand Krishnamoorthi <anakrish@microsoft.com>
2025-11-14 11:43:19 -06:00

81 lines
2.2 KiB
YAML

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# Constructed Collections Test Suite
# Validates ArrayCreate and SetCreate behavior including undefined handling.
cases:
- note: array_create_basic
description: ArrayCreate assembles elements from registers
literals:
- 1
- 2
instruction_params:
array_create_params:
- dest: 3
elements: [0, 1, 2]
instructions:
- "Load { dest: 0, literal_idx: 0 }"
- "Load { dest: 1, literal_idx: 1 }"
- "Add { dest: 2, left: 0, right: 1 }"
- "ArrayCreate { params_index: 0 }"
- "Return { value: 3 }"
want_result:
- 1
- 2
- 3
- note: array_create_with_undefined
description: ArrayCreate returns undefined if any source is undefined
literals:
- 1
- {}
- "missing"
instruction_params:
array_create_params:
- dest: 2
elements: [0, 1]
instructions:
- "Load { dest: 0, literal_idx: 0 }"
- "Load { dest: 3, literal_idx: 1 }"
- "Load { dest: 4, literal_idx: 2 }"
- "Index { dest: 1, container: 3, key: 4 }"
- "ArrayCreate { params_index: 0 }"
- "Return { value: 2 }"
want_result: "#undefined"
- note: set_create_basic
description: SetCreate deduplicates values and collects registers
literals:
- 1
- 2
instruction_params:
set_create_params:
- dest: 3
elements: [0, 1, 2]
instructions:
- "Load { dest: 0, literal_idx: 0 }"
- "Load { dest: 1, literal_idx: 1 }"
- "Load { dest: 2, literal_idx: 0 }"
- "SetCreate { params_index: 0 }"
- "Return { value: 3 }"
want_result:
set!: [1, 2]
- note: set_create_with_undefined
description: SetCreate returns undefined if any source register is undefined
literals:
- {}
- "missing"
instruction_params:
set_create_params:
- dest: 3
elements: [0]
instructions:
- "Load { dest: 1, literal_idx: 0 }"
- "Load { dest: 2, literal_idx: 1 }"
- "Index { dest: 0, container: 1, key: 2 }"
- "SetCreate { params_index: 0 }"
- "Return { value: 3 }"
want_result: "#undefined"