Files
regorus/tests/rvm/vm/suites/comparison_operations.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

112 lines
4.6 KiB
YAML

# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# Comparison Operations Test Suite
# Tests comparison instructions: Eq, Ne, Lt, Le, Gt, Ge
# These instructions compare values and produce boolean results
cases:
- note: comparison_eq
description: Test Eq instruction
example_rego: "5 == 5" # Equality comparison
literals:
- 5
- 5
instructions:
- "Load { dest: 0, literal_idx: 0 }" # Load literal 5 into register 0
- "Load { dest: 1, literal_idx: 1 }" # Load literal 5 into register 1
- "Eq { dest: 2, left: 0, right: 1 }" # Compare register 0 == register 1, store result in register 2
- "Return { value: 2 }" # Return boolean result from register 2
want_result: true
- note: comparison_eq_false
description: Test Eq instruction with false result
example_rego: "5 == 3" # Equality comparison (false case)
literals:
- 5
- 3
instructions:
- "Load { dest: 0, literal_idx: 0 }" # Load literal 5 into register 0
- "Load { dest: 1, literal_idx: 1 }" # Load literal 3 into register 1
- "Eq { dest: 2, left: 0, right: 1 }" # Compare register 0 == register 1, store result in register 2
- "Return { value: 2 }" # Return boolean result from register 2
want_result: false
- note: comparison_ne
description: Test Ne instruction
example_rego: "5 != 3" # Inequality comparison
literals:
- 5
- 3
instructions:
- "Load { dest: 0, literal_idx: 0 }" # Load literal 5 into register 0
- "Load { dest: 1, literal_idx: 1 }" # Load literal 3 into register 1
- "Ne { dest: 2, left: 0, right: 1 }" # Compare register 0 != register 1, store result in register 2
- "Return { value: 2 }" # Return boolean result from register 2
want_result: true
- note: comparison_lt
description: Test Lt instruction
example_rego: "3 < 5" # Less than comparison
literals:
- 3
- 5
instructions:
- "Load { dest: 0, literal_idx: 0 }" # Load literal 3 into register 0
- "Load { dest: 1, literal_idx: 1 }" # Load literal 5 into register 1
- "Lt { dest: 2, left: 0, right: 1 }" # Compare register 0 < register 1, store result in register 2
- "Return { value: 2 }" # Return boolean result from register 2
want_result: true
- note: comparison_le
description: Test Le instruction (less than or equal)
example_rego: "5 <= 10" # Less than or equal comparison
literals:
- 5
- 10
instructions:
- "Load { dest: 0, literal_idx: 0 }" # Load literal 5 into register 0
- "Load { dest: 1, literal_idx: 1 }" # Load literal 10 into register 1
- "Le { dest: 2, left: 0, right: 1 }" # Compare register 0 <= register 1, store result in register 2
- "Return { value: 2 }" # Return boolean result from register 2
want_result: true
- note: comparison_ge
description: Test Ge instruction (greater than or equal)
example_rego: "10 >= 5" # Greater than or equal comparison
literals:
- 10
- 5
instructions:
- "Load { dest: 0, literal_idx: 0 }" # Load literal 10 into register 0
- "Load { dest: 1, literal_idx: 1 }" # Load literal 5 into register 1
- "Ge { dest: 2, left: 0, right: 1 }" # Compare register 0 >= register 1, store result in register 2
- "Return { value: 2 }" # Return boolean result from register 2
want_result: true
- note: comparison_gt
description: Test Gt instruction
example_rego: "7 > 3" # Greater than comparison
literals:
- 7
- 3
instructions:
- "Load { dest: 0, literal_idx: 0 }" # Load literal 7 into register 0
- "Load { dest: 1, literal_idx: 1 }" # Load literal 3 into register 1
- "Gt { dest: 2, left: 0, right: 1 }" # Compare register 0 > register 1, store result in register 2
- "Return { value: 2 }" # Return boolean result from register 2
want_result: true
- note: comparison_ge_equal
description: Test Ge instruction with equal values
example_rego: "5 >= 5" # Greater than or equal comparison (equal case)
literals:
- 5
- 5
instructions:
- "Load { dest: 0, literal_idx: 0 }" # Load literal 5 into register 0
- "Load { dest: 1, literal_idx: 1 }" # Load literal 5 into register 1
- "Ge { dest: 2, left: 0, right: 1 }" # Compare register 0 >= register 1, store result in register 2
- "Return { value: 2 }" # Return boolean result from register 2
want_result: true