Disassembler for inspecting compiled Risor code (deepnoodle-ai#202)

Author: myzie

.circleci/config.yml

@@ -28,7 +28,7 @@ jobs:
           name: Run tests
           command: |
             mkdir -p /tmp/test-reports
-            gotestsum --junitfile /tmp/test-reports/unit-tests.xml -- -coverprofile=coverage.out -covermode=atomic ./...
+            gotestsum --junitfile /tmp/test-reports/unit-tests.xml -- -coverprofile=coverage.out -covermode=atomic ./... ./cmd/risor/...
       - codecov/upload
       - store_test_results:
           path: /tmp/test-reports

.codecov.yml

@@ -5,13 +5,13 @@ coverage:
     project:
       default:
         target: auto
-        threshold: 1%
+        threshold: 3%
         if_ci_failed: error
         only_pulls: true
     patch:
       default:
         target: auto
-        threshold: 1% # Allowed drop in coverage for the patch
+        threshold: 3% # Allowed drop in coverage for the patch
         if_ci_failed: error
         only_pulls: true
 ignore:

README.md

@@ -152,10 +152,7 @@ result, err := risor.Eval(ctx, "len(ex.Message)", risor.WithGlobal("ex", example
 
 ## Dependencies and Build Options
 
-Risor is designed to have zero external dependencies in its core libraries.
-Although, strictly speaking, the core does have one external dependency on
-`github.com/stretchr/testify` for unit tests only.
-
+Risor is designed to have minimal external dependencies in its core libraries.
 You can choose to opt into various add-on modules if they are of value in your
 application. The modules are present in this same Git repository, but must be
 installed with `go get` as separate dependencies:

cmd/risor/dis.go

@@ -0,0 +1,81 @@
+package main
+
+import (
+	"context"
+	"fmt"
+	"os"
+
+	"github.com/risor-io/risor"
+	"github.com/risor-io/risor/compiler"
+	"github.com/risor-io/risor/dis"
+	"github.com/risor-io/risor/parser"
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+const disExample = `  risor dis -c "a := 1 + 2"
+
+  risor dis ./path/to/script.risor
+
+  risor dis ./path/to/script.risor --func myfunc`
+
+var disCmd = &cobra.Command{
+	Use:     "dis",
+	Short:   "Disassemble Risor code",
+	Example: disExample,
+	Args:    cobra.MaximumNArgs(1),
+	Run: func(cmd *cobra.Command, args []string) {
+		ctx := context.Background()
+		processGlobalFlags()
+		opts := getRisorOptions()
+		code, err := getRisorCode(cmd, args)
+		if err != nil {
+			fatal(err)
+		}
+
+		// Parse then compile the input code
+		ast, err := parser.Parse(ctx, code)
+		if err != nil {
+			fatal(err)
+		}
+		cfg := risor.NewConfig(opts...)
+		compiledCode, err := compiler.Compile(ast, cfg.CompilerOpts()...)
+		if err != nil {
+			fatal(err)
+		}
+		targetCode := compiledCode
+
+		// If a function name was provided, disassemble its code only
+		if funcName := viper.GetString("func"); funcName != "" {
+			var fn *compiler.Function
+			for i := 0; i < compiledCode.ConstantsCount(); i++ {
+				obj, ok := compiledCode.Constant(i).(*compiler.Function)
+				if !ok {
+					continue
+				}
+				if obj.Name() == funcName {
+					fn = obj
+					break
+				}
+			}
+			if fn == nil {
+				fatal(fmt.Sprintf("function %q not found", funcName))
+			}
+			targetCode = fn.Code()
+		}
+
+		// Disassemble and print the instructions
+		instructions, err := dis.Disassemble(targetCode)
+		if err != nil {
+			fmt.Println(err)
+			os.Exit(1)
+		}
+		dis.Print(instructions, os.Stdout)
+	},
+}
+
+func init() {
+	rootCmd.AddCommand(disCmd)
+	disCmd.Flags().String("func", "", "Function name")
+	viper.BindPFlag("func", disCmd.Flags().Lookup("func"))
+}

cmd/risor/dis_test.go

@@ -0,0 +1,36 @@
+package main
+
+import (
+	"bytes"
+	"os"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestDisassembly(t *testing.T) {
+	// Capture stdout
+	old := os.Stdout
+	r, w, _ := os.Pipe()
+	os.Stdout = w
+	defer func() { os.Stdout = old }()
+
+	disCmd.Run(disCmd, []string{"fixtures/ex1.risor"})
+
+	w.Close()
+
+	var buf bytes.Buffer
+	_, _ = buf.ReadFrom(r)
+	capturedOutput := buf.String()
+	expected := `
++--------+------------+----------+------+
+| OFFSET |   OPCODE   | OPERANDS | INFO |
++--------+------------+----------+------+
+|      0 | LOAD_CONST |        0 | 3    |
+|      2 | LOAD_CONST |        1 | 4    |
+|      4 | BINARY_OP  |        1 | +    |
++--------+------------+----------+------+
+`
+	require.Equal(t, strings.TrimPrefix(expected, "\n"), capturedOutput)
+}

cmd/risor/fixtures/ex1.risor

@@ -0,0 +1,2 @@
+
+3 + 4

cmd/risor/go.mod

@@ -22,7 +22,7 @@ require (
 	atomicgo.dev/keyboard v0.2.9
 	github.com/aws/aws-sdk-go-v2/config v1.18.39
 	github.com/aws/aws-sdk-go-v2/service/s3 v1.38.5
-	github.com/fatih/color v1.15.0
+	github.com/fatih/color v1.16.0
 	github.com/hokaccha/go-prettyjson v0.0.0-20211117102719-0474bc63780f
 	github.com/mattn/go-isatty v0.0.20
 	github.com/mitchellh/go-homedir v1.1.0
@@ -41,6 +41,7 @@ require (
 	github.com/risor-io/risor/os/s3fs v1.1.1
 	github.com/spf13/cobra v1.7.0
 	github.com/spf13/viper v1.16.0
+	github.com/stretchr/testify v1.8.4
 )
 
 require (
@@ -139,15 +140,19 @@ require (
 	github.com/magiconair/properties v1.8.7 // indirect
 	github.com/mailru/easyjson v0.7.6 // indirect
 	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-runewidth v0.0.13 // indirect
 	github.com/microsoft/go-mssqldb v1.6.0 // indirect
 	github.com/mitchellh/copystructure v1.0.0 // indirect
 	github.com/mitchellh/mapstructure v1.5.0 // indirect
 	github.com/mitchellh/reflectwalk v1.0.0 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/olekukonko/tablewriter v0.0.5 // indirect
 	github.com/pelletier/go-toml/v2 v2.1.0 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	github.com/rivo/uniseg v0.2.0 // indirect
 	github.com/russross/blackfriday/v2 v2.1.0 // indirect
 	github.com/ryanuber/go-glob v1.0.0 // indirect
 	github.com/shopspring/decimal v1.2.0 // indirect

cmd/risor/go.sum

@@ -215,8 +215,7 @@ github.com/evanphx/json-patch v4.12.0+incompatible h1:4onqiflcdA9EOZ4RxV643DvftH
 github.com/evanphx/json-patch v4.12.0+incompatible/go.mod h1:50XU6AFN0ol/bzJsmQLiYLvXMP4fmwYFNcr97nuDLSk=
 github.com/evanphx/json-patch/v5 v5.6.0 h1:b91NhWfaz02IuVxO9faSllyAtNXHMPkC5J8sJCLunww=
 github.com/evanphx/json-patch/v5 v5.6.0/go.mod h1:G79N1coSVB93tBe7j6PhzjmR3/2VvlbKOFpnXhI9Bw4=
-github.com/fatih/color v1.15.0 h1:kOqh6YHBtK8aywxGerMG2Eq3H6Qgoqeo13Bk2Mv/nBs=
-github.com/fatih/color v1.15.0/go.mod h1:0h5ZqXfHYED7Bhv2ZJamyIOUej9KtShiJESRwBDUSsw=
+github.com/fatih/color v1.16.0 h1:zmkK9Ngbjj+K0yRhTVONQh1p/HknKYSlNT+vZCzyokM=
 github.com/frankban/quicktest v1.14.4 h1:g2rn0vABPOOXmZUj+vbmUp0lPoXEMuhTpIluN0XL9UY=
 github.com/frankban/quicktest v1.14.4/go.mod h1:4ptaffx2x8+WTWXmUCuVU6aPUX1/Mz7zb5vbUoiM6w0=
 github.com/fsnotify/fsnotify v1.4.7/go.mod h1:jwhsz4b93w/PPRr/qN1Yymfu8t87LnFCMoQvtojpjFo=
@@ -404,6 +403,7 @@ github.com/mattn/go-colorable v0.1.13/go.mod h1:7S9/ev0klgBDR4GtXTXX8a3vIGJpMovk
 github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
 github.com/mattn/go-isatty v0.0.20/go.mod h1:W+V8PltTTMOvKvAeJH7IuucS94S2C6jfK/D7dTCTo3Y=
+github.com/mattn/go-runewidth v0.0.9/go.mod h1:H031xJmbD/WCDINGzjvQ9THkh0rPKHF+m2gUSrubnMI=
 github.com/mattn/go-runewidth v0.0.13 h1:lTGmDsbAYt5DmK6OnoV7EuIF1wEIFAcxld6ypU4OSgU=
 github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w=
 github.com/matttproud/golang_protobuf_extensions v1.0.2 h1:hAHbPm5IJGijwng3PWk09JkG9WeqChjprR5s9bBZ+OM=
@@ -427,6 +427,8 @@ github.com/modern-go/reflect2 v1.0.2/go.mod h1:yWuevngMOJpCy52FWWMvUC8ws7m/LJsjY
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 h1:C3w9PqII01/Oq1c1nUAm88MOHcQC9l5mIlSMApZMrHA=
 github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822/go.mod h1:+n7T8mK8HuQTcFwEeznm/DIxMOiR9yIdICNftLE1DvQ=
 github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
+github.com/olekukonko/tablewriter v0.0.5 h1:P2Ga83D34wi1o9J6Wh1mRuqd4mF/x/lgBS7N7AbDhec=
+github.com/olekukonko/tablewriter v0.0.5/go.mod h1:hPp6KlRPjbx+hW8ykQs1w3UBbZlj6HuIJcUGPhkA7kY=
 github.com/onsi/ginkgo/v2 v2.6.0 h1:9t9b9vRUbFq3C4qKFCGkVuq/fIHji802N1nrtkh1mNc=
 github.com/onsi/ginkgo/v2 v2.6.0/go.mod h1:63DOGlLAH8+REH8jUGdL3YpCpu7JODesutUjdENfUAc=
 github.com/onsi/gomega v1.24.1 h1:KORJXNNTzJXzu4ScJWssJfJMnJ+2QJqhoQSRwNlze9E=

cmd/risor/main.go

@@ -1,62 +1,13 @@
 package main
 
-import (
-	"encoding/json"
-	"fmt"
-	"os"
-	"strings"
-
-	"github.com/spf13/cobra"
-)
-
 var (
 	version = "dev"
 	commit  = "unknown"
 	date    = "unknown"
 )
 
 func main() {
-	cmdServe := &cobra.Command{
-		Use:   "serve",
-		Short: "Run the Risor API server",
-		Long:  ``,
-		Run: func(cmd *cobra.Command, args []string) {
-			fmt.Println("Server")
-		},
-	}
-
-	cmdVersion := &cobra.Command{
-		Use:   "version",
-		Short: "Print the version of Risor",
-		Long:  ``,
-		Run: func(cmd *cobra.Command, args []string) {
-			outFmt := cmd.Flag("output").Value.String()
-			if strings.ToLower(outFmt) == "json" {
-				info, err := json.MarshalIndent(map[string]interface{}{
-					"version": version,
-					"commit":  commit,
-					"date":    date,
-				}, "", "  ")
-				if err != nil {
-					fmt.Println(err)
-					os.Exit(1)
-				}
-				fmt.Println(string(info))
-			} else {
-				fmt.Println(version)
-			}
-		},
-	}
-
-	cmdVersion.Flags().StringP("output", "o", "", "Set the output format")
-	cmdVersion.RegisterFlagCompletionFunc("output",
-		cobra.FixedCompletions(outputFormatsCompletion, cobra.ShellCompDirectiveNoFileComp))
-
-	rootCmd.AddCommand(cmdServe)
-	rootCmd.AddCommand(cmdVersion)
-
 	if err := rootCmd.Execute(); err != nil {
-		fmt.Println(err)
-		os.Exit(1)
+		fatal(err)
 	}
 }