Rename the vm package to runtime.

`runtime` is a better name for the collection of the virtual machine execution
engine, the bytecode compiler, and the program loader.

.gitattributes

@@ -1,7 +1,7 @@
-internal/vm/compiler/parser/parser.go -diff -merge
-internal/vm/compiler/parser/parser.go linguist-generated=true
-internal/vm/compiler/parser/y.output -diff -merge
-internal/vm/compiler/parser/y.output linguist-generated=true
+internal/runtime/compiler/parser/parser.go -diff -merge
+internal/runtime/compiler/parser/parser.go linguist-generated=true
+internal/runtime/compiler/parser/y.output -diff -merge
+internal/runtime/compiler/parser/y.output linguist-generated=true
 logo.png binary
 internal/mtail/logo.ico binary
 .gitattributes export-ignore

.github/workflows/oss-fuzz.yml

@@ -3,7 +3,7 @@ on:
   pull_request:
     paths:
       - '**.go'
-      - 'internal/vm/compiler/parser/parser.y'
+      - 'internal/runtime/compiler/parser/parser.y'
       - 'Makefile'
       - 'Dockerfile'
 jobs:

.gitignore

@@ -24,9 +24,9 @@ workdir/*
 /mtail
 /mdot
 /mgen
-/internal/vm/fuzzer.a
-/internal/vm/fuzzer
-/internal/vm/fuzzit
+/internal/runtime/fuzzer.a
+/internal/runtime/fuzzer
+/internal/runtime/fuzzit
 /vm-fuzzer.dict
 /vendor
 /vm-fuzzer

Makefile

@@ -46,13 +46,13 @@ GOFILES=$(shell find . -name '*.go' -a ! -name '*_test.go')
 
 GOTESTFILES=$(shell find . -name '*_test.go')
 
-GOGENFILES=internal/vm/compiler/parser/parser.go\
+GOGENFILES=internal/runtime/compiler/parser/parser.go\
 	internal/mtail/logo.ico.go
 
 
 CLEANFILES+=\
-	internal/vm/compiler/parser/parser.go\
-	internal/vm/compiler/parser/y.output\
+	internal/runtime/compiler/parser/parser.go\
+	internal/runtime/compiler/parser/y.output\
 	internal/mtail/logo.ico.go\
 	internal/mtail/logo.ico\
 
@@ -127,7 +127,7 @@ $(TARGETS): %: cmd/%/main.go $(DEPDIR)/%.d | print-version .dep-stamp
 	$(MAKEDEPEND)
 	go build -gcflags "$(GO_GCFLAGS)" -ldflags "$(GO_LDFLAGS)" -o $@ $<
 
-internal/vm/compiler/parser/parser.go: internal/vm/compiler/parser/parser.y | $(GOYACC)
+internal/runtime/compiler/parser/parser.go: internal/runtime/compiler/parser/parser.y | $(GOYACC)
 	go generate -x ./$(@D)
 
 internal/mtail/logo.ico: logo.png
@@ -222,13 +222,13 @@ LIB_FUZZING_ENGINE ?=
 OUT ?= .
 
 $(OUT)/vm-fuzzer: $(GOFILES) | $(GOFUZZBUILD)
-	go114-fuzz-build -o fuzzer.a ./internal/vm
+	go114-fuzz-build -o fuzzer.a ./internal/runtime
 	$(CXX) $(CXXFLAGS) $(LIB_FUZZING_ENGINE) fuzzer.a -lpthread -o $(OUT)/vm-fuzzer
 
 $(OUT)/vm-fuzzer.dict: mgen
 	./mgen --dictionary | sort > $@
 
-$(OUT)/vm-fuzzer_seed_corpus.zip: $(wildcard examples/*.mtail) $(wildcard internal/vm/fuzz/*.mtail)
+$(OUT)/vm-fuzzer_seed_corpus.zip: $(wildcard examples/*.mtail) $(wildcard internal/runtime/fuzz/*.mtail)
 	zip -j $@ $^
 
 FUZZER_FLAGS=-rss_limit_mb=4096 -timeout=60s

cmd/mdot/main.go

@@ -29,9 +29,9 @@ import (
 
 	"github.com/golang/glog"
 	"github.com/google/mtail/internal/mtail"
-	"github.com/google/mtail/internal/vm/compiler/ast"
-	"github.com/google/mtail/internal/vm/compiler/checker"
-	"github.com/google/mtail/internal/vm/compiler/parser"
+	"github.com/google/mtail/internal/runtime/compiler/ast"
+	"github.com/google/mtail/internal/runtime/compiler/checker"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
 )
 
 var (

cmd/mfmt/main.go

@@ -13,8 +13,8 @@ import (
 	"os"
 
 	"github.com/golang/glog"
-	"github.com/google/mtail/internal/vm/compiler/checker"
-	"github.com/google/mtail/internal/vm/compiler/parser"
+	"github.com/google/mtail/internal/runtime/compiler/checker"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
 )
 
 var (

cmd/mgen/main.go

@@ -11,7 +11,7 @@ import (
 	"math/big"
 	mrand "math/rand"
 
-	"github.com/google/mtail/internal/vm/compiler/parser"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
 )
 
 var (

docs/debugging.md

@@ -13,7 +13,7 @@ go test -run TestParserRoundTrip/decrement_counter --logtostderr --mtailDebug=3
 
 ## Improving parser syntax error messages
 
-You can use this to improve error messages in the `%error` section of [`parser.y`](../internal/vm/compiler/parser/parser.y), if you compare the "error recovery pops" messages with the state machine in the generated [`y.output`](../internal/vm/compiler/parser/y.output).
+You can use this to improve error messages in the `%error` section of [`parser.y`](../internal/runtime/compiler/parser/parser.y), if you compare the "error recovery pops" messages with the state machine in the generated [`y.output`](../internal/runtime/compiler/parser/y.output).
 
 
 ```
@@ -97,9 +97,9 @@ so it's easier to read -- it'll be bigger cos of the whitespace and the minimise
 
 The formatted mtail program should help make it obvious what's happening and let you manually attempt to rename or remove parts of the program yourself -- perhaps a whole variable declaration and usage doesn't need to exist, but the minimiser will take a long time to figure that out.
 
-Once we have the smallest program we can add it to the crash corpus in [`internal/vm/fuzz/`](../internal/vm/fuzz/) and running `make fuzz` should run and fail on it straight away.
+Once we have the smallest program we can add it to the crash corpus in [`internal/runtime/fuzz/`](../internal/runtime/fuzz/) and running `make fuzz` should run and fail on it straight away.
 
-Or, variants of the program can be added to the various `*Invalid` tests in parts of the `vm` module, e.g. [`parser_test.go`](../internal/vm/compiler/parser/parser_test.go) or [`checker_test.go`](../internal/vm/compiler/checker/checker_test.go) depending on where in the compiler the defect is occuring.
+Or, variants of the program can be added to the various `*Invalid` tests in parts of the `vm` module, e.g. [`parser_test.go`](../internal/runtime/compiler/parser/parser_test.go) or [`checker_test.go`](../internal/runtime/compiler/checker/checker_test.go) depending on where in the compiler the defect is occuring.
 
 If the crash is in `vm.go` then we can dump the program to see what AST and types, and bytecode it generates.
 

docs/reading-y-output.md

@@ -4,7 +4,7 @@ A Yacc parser is a state machine that responds to an input stream of tokens, and
 1. **shift**, which pushes a new state on the stack
 2. **reduce**, which pops a state off the stack and sets the lookahead token
 
-[`y.output`](../internal/vm/compiler/parser/y.output) is a semi-human, semi-machine readable description of the parser state machine.  `mtail` automatically generates this during the build process with the go:generate directive in [`driver.go`](../internal/vm/compiler/parser/driver.go)
+[`y.output`](../internal/runtime/compiler/parser/y.output) is a semi-human, semi-machine readable description of the parser state machine.  `mtail` automatically generates this during the build process with the go:generate directive in [`driver.go`](../internal/runtime/compiler/parser/driver.go)
 
 ```y.output
 state 0
@@ -61,7 +61,7 @@ state 48
 
 In state 48 we have recognised an `AND`, and then reduction of rule 26 says we put a `logical_op` at the front of the token stream and pop the stack (back to state 14).
 
-The last couple of actions for state 14 say we can expect a `LCURLY` (token name for `{`, see [`lexer.go`](../internal/vm/compiler/parser/lexer.go)) and then move to state 47.  Or anything else (`.`) and we're now in an error state.
+The last couple of actions for state 14 say we can expect a `LCURLY` (token name for `{`, see [`lexer.go`](../internal/runtime/compiler/parser/lexer.go)) and then move to state 47.  Or anything else (`.`) and we're now in an error state.
 
 
 Run a parser test with debugging flags enabled, and we can see how the parser and lexer see the input:

internal/mtail/mtail.go

@@ -16,8 +16,8 @@ import (
 	"github.com/google/mtail/internal/exporter"
 	"github.com/google/mtail/internal/logline"
 	"github.com/google/mtail/internal/metrics"
+	vm "github.com/google/mtail/internal/runtime"
 	"github.com/google/mtail/internal/tailer"
-	"github.com/google/mtail/internal/vm"
 	"github.com/google/mtail/internal/waker"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
@@ -246,7 +246,7 @@ func New(ctx context.Context, store *metrics.Store, options ...Option) (*Server,
 		"log_rotations_total": prometheus.NewDesc("log_rotations_total", "number of log rotation events per log file", []string{"logfile"}, nil),
 		"log_truncates_total": prometheus.NewDesc("log_truncates_total", "number of log truncation events log file", []string{"logfile"}, nil),
 		"log_lines_total":     prometheus.NewDesc("log_lines_total", "number of lines read per log file", []string{"logfile"}, nil),
-		// internal/vm/loader.go
+		// internal/runtime/loader.go
 		"lines_total":               prometheus.NewDesc("lines_total", "number of lines received by the program loader", nil, nil),
 		"prog_loads_total":          prometheus.NewDesc("prog_loads_total", "number of program load events by program source filename", []string{"prog"}, nil),
 		"prog_load_errors_total":    prometheus.NewDesc("prog_load_errors_total", "number of errors encountered when loading per program source filename", []string{"prog"}, nil),

internal/vm/code/instr_test.go → internal/runtime/code/instr_test.go

@@ -7,7 +7,7 @@ import (
 	"testing"
 
 	"github.com/google/mtail/internal/testutil"
-	"github.com/google/mtail/internal/vm/code"
+	"github.com/google/mtail/internal/runtime/code"
 )
 
 func TestInstrString(t *testing.T) {

internal/vm/compiler/ast/ast.go → internal/runtime/compiler/ast/ast.go

@@ -8,9 +8,9 @@ import (
 	"time"
 
 	"github.com/google/mtail/internal/metrics"
-	"github.com/google/mtail/internal/vm/compiler/position"
-	"github.com/google/mtail/internal/vm/compiler/symbol"
-	"github.com/google/mtail/internal/vm/compiler/types"
+	"github.com/google/mtail/internal/runtime/compiler/position"
+	"github.com/google/mtail/internal/runtime/compiler/symbol"
+	"github.com/google/mtail/internal/runtime/compiler/types"
 )
 
 type Node interface {

internal/vm/compiler/ast/walk_test.go → internal/runtime/compiler/ast/walk_test.go

@@ -6,11 +6,11 @@ package ast_test
 import (
 	"testing"
 
+	"github.com/google/mtail/internal/runtime/compiler/ast"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
+	"github.com/google/mtail/internal/runtime/compiler/position"
+	"github.com/google/mtail/internal/runtime/compiler/types"
 	"github.com/google/mtail/internal/testutil"
-	"github.com/google/mtail/internal/vm/compiler/ast"
-	"github.com/google/mtail/internal/vm/compiler/parser"
-	"github.com/google/mtail/internal/vm/compiler/position"
-	"github.com/google/mtail/internal/vm/compiler/types"
 )
 
 type testNode struct {

internal/vm/compiler/checker/checker.go → internal/runtime/compiler/checker/checker.go

@@ -10,11 +10,11 @@ import (
 
 	"github.com/golang/glog"
 	"github.com/google/mtail/internal/metrics"
-	"github.com/google/mtail/internal/vm/compiler/ast"
-	"github.com/google/mtail/internal/vm/compiler/errors"
-	"github.com/google/mtail/internal/vm/compiler/parser"
-	"github.com/google/mtail/internal/vm/compiler/symbol"
-	"github.com/google/mtail/internal/vm/compiler/types"
+	"github.com/google/mtail/internal/runtime/compiler/ast"
+	"github.com/google/mtail/internal/runtime/compiler/errors"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
+	"github.com/google/mtail/internal/runtime/compiler/symbol"
+	"github.com/google/mtail/internal/runtime/compiler/types"
 )
 
 const (

internal/vm/compiler/checker/checker_test.go → internal/runtime/compiler/checker/checker_test.go

@@ -9,12 +9,12 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp/cmpopts"
+	"github.com/google/mtail/internal/runtime/compiler/ast"
+	"github.com/google/mtail/internal/runtime/compiler/checker"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
+	"github.com/google/mtail/internal/runtime/compiler/symbol"
+	"github.com/google/mtail/internal/runtime/compiler/types"
 	"github.com/google/mtail/internal/testutil"
-	"github.com/google/mtail/internal/vm/compiler/ast"
-	"github.com/google/mtail/internal/vm/compiler/checker"
-	"github.com/google/mtail/internal/vm/compiler/parser"
-	"github.com/google/mtail/internal/vm/compiler/symbol"
-	"github.com/google/mtail/internal/vm/compiler/types"
 )
 
 var checkerTestDebug = flag.Bool("checker_test_debug", false, "Turn on to log AST in tests")

internal/vm/compiler/codegen/codegen.go → internal/runtime/compiler/codegen/codegen.go

@@ -12,13 +12,13 @@ import (
 	"github.com/golang/glog"
 	"github.com/google/mtail/internal/metrics"
 	"github.com/google/mtail/internal/metrics/datum"
-	"github.com/google/mtail/internal/vm/code"
-	"github.com/google/mtail/internal/vm/compiler/ast"
-	"github.com/google/mtail/internal/vm/compiler/errors"
-	"github.com/google/mtail/internal/vm/compiler/parser"
-	"github.com/google/mtail/internal/vm/compiler/position"
-	"github.com/google/mtail/internal/vm/compiler/symbol"
-	"github.com/google/mtail/internal/vm/compiler/types"
+	"github.com/google/mtail/internal/runtime/code"
+	"github.com/google/mtail/internal/runtime/compiler/ast"
+	"github.com/google/mtail/internal/runtime/compiler/errors"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
+	"github.com/google/mtail/internal/runtime/compiler/position"
+	"github.com/google/mtail/internal/runtime/compiler/symbol"
+	"github.com/google/mtail/internal/runtime/compiler/types"
 )
 
 // codegen represents a code generator.

internal/vm/compiler/codegen/codegen_test.go → internal/runtime/compiler/codegen/codegen_test.go

@@ -9,12 +9,12 @@ import (
 	"testing"
 	"time"
 
+	"github.com/google/mtail/internal/runtime/code"
+	"github.com/google/mtail/internal/runtime/compiler/ast"
+	"github.com/google/mtail/internal/runtime/compiler/checker"
+	"github.com/google/mtail/internal/runtime/compiler/codegen"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
 	"github.com/google/mtail/internal/testutil"
-	"github.com/google/mtail/internal/vm/code"
-	"github.com/google/mtail/internal/vm/compiler/ast"
-	"github.com/google/mtail/internal/vm/compiler/checker"
-	"github.com/google/mtail/internal/vm/compiler/codegen"
-	"github.com/google/mtail/internal/vm/compiler/parser"
 )
 
 var codegenTestDebug = flag.Bool("codegen_test_debug", false, "Log ASTs and debugging information ")

internal/vm/compiler/compiler.go → internal/runtime/compiler/compiler.go

@@ -8,10 +8,10 @@ import (
 	"path/filepath"
 
 	"github.com/golang/glog"
-	"github.com/google/mtail/internal/vm/code"
-	"github.com/google/mtail/internal/vm/compiler/checker"
-	"github.com/google/mtail/internal/vm/compiler/codegen"
-	"github.com/google/mtail/internal/vm/compiler/parser"
+	"github.com/google/mtail/internal/runtime/code"
+	"github.com/google/mtail/internal/runtime/compiler/checker"
+	"github.com/google/mtail/internal/runtime/compiler/codegen"
+	"github.com/google/mtail/internal/runtime/compiler/parser"
 )
 
 // Compile compiles a program from the input into bytecode and data stored in an Object, or a list

internal/vm/compiler/compiler_test.go → internal/runtime/compiler/compiler_test.go

@@ -7,7 +7,7 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/google/mtail/internal/vm/compiler"
+	"github.com/google/mtail/internal/runtime/compiler"
 )
 
 func TestCompileParserError(t *testing.T) {

internal/vm/compiler/errors/errors.go → internal/runtime/compiler/errors/errors.go

@@ -7,7 +7,7 @@ import (
 	"fmt"
 	"strings"
 
-	"github.com/google/mtail/internal/vm/compiler/position"
+	"github.com/google/mtail/internal/runtime/compiler/position"
 	"github.com/pkg/errors"
 )
 

internal/vm/compiler/errors/errors_test.go → internal/runtime/compiler/errors/errors_test.go

@@ -6,7 +6,7 @@ package errors_test
 import (
 	"testing"
 
-	"github.com/google/mtail/internal/vm/compiler/errors"
+	"github.com/google/mtail/internal/runtime/compiler/errors"
 )
 
 func TestNilErrorPosition(t *testing.T) {

internal/vm/compiler/parser/driver.go → internal/runtime/compiler/parser/driver.go

@@ -24,9 +24,9 @@ import (
 	"time"
 
 	"github.com/golang/glog"
-	"github.com/google/mtail/internal/vm/compiler/ast"
-	"github.com/google/mtail/internal/vm/compiler/errors"
-	"github.com/google/mtail/internal/vm/compiler/position"
+	"github.com/google/mtail/internal/runtime/compiler/ast"
+	"github.com/google/mtail/internal/runtime/compiler/errors"
+	"github.com/google/mtail/internal/runtime/compiler/position"
 )
 
 // Parse reads the program named name from the input, and if successful returns

internal/vm/compiler/parser/lexer.go → internal/runtime/compiler/parser/lexer.go

@@ -12,7 +12,7 @@ import (
 	"unicode"
 
 	"github.com/golang/glog"
-	"github.com/google/mtail/internal/vm/compiler/position"
+	"github.com/google/mtail/internal/runtime/compiler/position"
 )
 
 // List of keywords.  Keep this list sorted!

internal/vm/compiler/parser/lexer_test.go → internal/runtime/compiler/parser/lexer_test.go

@@ -7,8 +7,8 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/google/mtail/internal/runtime/compiler/position"
 	"github.com/google/mtail/internal/testutil"
-	"github.com/google/mtail/internal/vm/compiler/position"
 )
 
 type lexerTest struct {

internal/vm/compiler/parser/parser.y → internal/runtime/compiler/parser/parser.y

@@ -8,8 +8,8 @@ import (
     "time"
 
     "github.com/google/mtail/internal/metrics"
-    "github.com/google/mtail/internal/vm/compiler/ast"
-    "github.com/google/mtail/internal/vm/compiler/position"
+    "github.com/google/mtail/internal/runtime/compiler/ast"
+    "github.com/google/mtail/internal/runtime/compiler/position"
     "github.com/golang/glog"
 )
 

internal/vm/compiler/parser/parser_test.go → internal/runtime/compiler/parser/parser_test.go

@@ -8,9 +8,9 @@ import (
 	"strings"
 	"testing"
 
+	"github.com/google/mtail/internal/runtime/compiler/ast"
+	"github.com/google/mtail/internal/runtime/compiler/position"
 	"github.com/google/mtail/internal/testutil"
-	"github.com/google/mtail/internal/vm/compiler/ast"
-	"github.com/google/mtail/internal/vm/compiler/position"
 )
 
 var parserTestDebug = flag.Bool("parser_test_debug", false, "Turn on parser debug output if set.")