benchmark timer on custom files

Author: Aditya-Chowdhary

MyCode/benchmark/main.go

@@ -3,17 +3,20 @@ package main
 import (
 	"flag"
 	"fmt"
+	"os"
 	"time"
 
+	"github.com/Aditya-Chowdhary/Monkey-Interpreter/ast"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/compiler"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/evaluator"
+	"github.com/Aditya-Chowdhary/Monkey-Interpreter/file"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/lexer"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/object"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/parser"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/vm"
 )
 
-var engine = flag.String("engine", "vm", "use `vm` or `eval`")
+var engine = flag.String("engine", "", "use `vm` or `eval`. Leave blank to return comparison")
 
 var input = `
 	let fibonacci = fn(x) {
@@ -33,43 +36,65 @@ var input = `
 func main() {
 	flag.Parse()
 
-	var duration time.Duration
-	var result object.Object
+	if flag.Arg(0) != "" {
+		code, err := file.ReadCode(flag.Arg(0))
+		if err != nil {
+			fmt.Println(err)
+			os.Exit(1)
+		}
+		input = code
+	}
 
 	l := lexer.New(input)
 	p := parser.New(l)
 	program := p.ParseProgram()
 
 	if *engine == "vm" {
-		comp := compiler.New()
-		err := comp.Compile(program)
-		if err != nil {
-			fmt.Printf("compiler error: %s", err)
-			return
-		}
+		timeVM(program)
+	} else if *engine == "eval" {
+		timeEval(program)
+	} else {
+		timeEval(program)
+		timeVM(program)
+	}
+}
 
-		machine := vm.New(comp.Bytecode())
+func timeVM(program *ast.Program) {
+	comp := compiler.New()
+	err := comp.Compile(program)
+	if err != nil {
+		fmt.Printf("compiler error: %s", err)
+		return
+	}
 
-		start := time.Now()
+	machine := vm.New(comp.Bytecode())
 
-		err = machine.Run()
-		if err != nil {
-			fmt.Printf("vm error: %s", err)
-			return
-		}
+	start := time.Now()
 
-		duration = time.Since(start)
-		result = machine.LastPoppedStackElem()
-	} else if *engine == "eval" {
-		env := object.NewEnvironment()
-		start := time.Now()
-		result = evaluator.Eval(program, env)
-		duration = time.Since(start)
+	err = machine.Run()
+	if err != nil {
+		fmt.Printf("vm error: %s", err)
+		return
 	}
 
-	fmt.Printf(
-		"engine=%s, result=%s, duration=%s\n",
-		*engine,
+	duration := time.Since(start)
+	result := machine.LastPoppedStackElem()
+
+	printResult("vm", result, duration)
+}
+
+func timeEval(program *ast.Program) {
+	env := object.NewEnvironment()
+	start := time.Now()
+	result := evaluator.Eval(program, env)
+	duration := time.Since(start)
+
+	printResult("eval", result, duration)
+}
+
+func printResult(engine string, result object.Object, duration time.Duration) {
+	fmt.Printf("--> engine=%s, result=%s, duration=%s\n",
+		engine,
 		result.Inspect(),
 		duration)
 }

MyCode/build/benchmark.exe

@@ -3,13 +3,25 @@ package file
 import (
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/compiler"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/lexer"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/parser"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/vm"
 )
 
+func ReadCode(filepath string) (string, error) {
+	fileContent, err := os.ReadFile(filepath)
+	if err != nil {
+		return "", fmt.Errorf("error: Invalid file name")
+	}
+	if !strings.HasSuffix(filepath, ".mky") {
+		return "", fmt.Errorf("error: Invalid file name")
+	}
+	return string(fileContent), nil
+}
+
 func RunCode(fileCode string) {
 	l := lexer.New(fileCode)
 	p := parser.New(l)

MyCode/build/monkey.exe

@@ -3,35 +3,24 @@ package main
 import (
 	"fmt"
 	"os"
-	"os/user"
-	"strings"
 
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/file"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/repl"
 )
 
 func main() {
 	if len(os.Args) == 1 {
-		user, err := user.Current()
-		if err != nil {
-			panic(err)
-		}
-		fmt.Printf("Hello %s! This is the Monkey Programming Language!\n", user.Username)
-		fmt.Printf("Feel free to type in commands!\n")
 		repl.Start(os.Stdin, os.Stdout)
 	} else if len(os.Args) == 2 {
 		fileName := os.Args[1]
 
-		fileContent, err := os.ReadFile(fileName)
+		fileContent, err := file.ReadCode(fileName)
 		if err != nil {
-			fmt.Println("Error: Invalid file name")
+			fmt.Println(err)
 			os.Exit(1)
 		}
-		if !strings.HasSuffix(fileName, ".mky") {
-			fmt.Println("Error: Invalid file name")
-			os.Exit(1)
-		}
-		file.RunCode(string(fileContent))
+		file.RunCode(fileContent)
+
 	} else {
 		fmt.Println("Error: Too many arguments!")
 		fmt.Println(`Usage: "./monkey [file-path]"`)

MyCode/file/file.go

@@ -4,6 +4,7 @@ import (
 	"bufio"
 	"fmt"
 	"io"
+	"os/user"
 
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/compiler"
 	"github.com/Aditya-Chowdhary/Monkey-Interpreter/lexer"
@@ -15,6 +16,13 @@ import (
 const PROMPT = ">> "
 
 func Start(in io.Reader, out io.Writer) {
+	user, err := user.Current()
+	if err != nil {
+		panic(err)
+	}
+	fmt.Printf("Hello %s! This is the Monkey Programming Language!\n", user.Username)
+	fmt.Printf("Feel free to type in commands!\n")
+
 	scanner := bufio.NewScanner(in)
 
 	constants := []object.Object{}

MyCode/main.go

@@ -12,15 +12,38 @@ This is a project to write an interpreter and a compiler for a made up language
 3. To run the REPL, run the command `./build/monkey`.
 4. Alternatively, create a file with extension `.mky` and run the command `./build/monkey [file]` to compile and run the file
 
+### Windows
+
+1. Clone the repository
+2. Run the command `cd .\MyCode\` to change directories.
+3. To run the REPL, run the command `.\build\monkey`.
+4. Alternatively, create a file with extension `.mky` and run the command `.\build\monkey [file]` to compile and run the file
+
 A pre-written file `test.mky` is also present in the repository
 
+
 # Running benchmarks
 
 ### Linux
 1. Clone the repository
 2. Run the command `cd MyCode/` to change directories.
-3. To run using compiler and vm, run the command `./build/fibonacci -engine=vm`
-4. To run using interpreter, run the command `./build/fibonacci -engine=eval`
+3. Run command `.\build\benchmark -engine=vm|eval|[blank] [file-path]`
+   1. To run using compiler and vm, `-engine = vm`
+   2. To run using interpreter, `-engine = eval`
+   3. To perform comparison between the two, ignore the `-engine` flag
+   4. To perform benchmark testing on a custom file, include the file-path of the file. (Extension = `.mky`)
+   5. Do not specify the file path before the `-engine` flag
+
 
-- Currently the benchmark is based on a pre-written fibonacci recursion program.
+### Windows
+1. Clone the repository
+2. Run the command `cd .\MyCode\` to change directories.
+3. Run command `.\build\benchmark -engine=vm|eval|[blank] [file-path]`
+   1. To run using compiler and vm, `-engine = vm`
+   2. To run using interpreter, `-engine = eval`
+   3. To perform comparison between the two, ignore the `-engine` flag
+   4. To perform benchmark testing on a custom file, include the file-path of the file. (Extension = `.mky`)
+   5. Do not specify the file path before the `-engine` flag
+
+- The default benchmark is based on a pre-written fibonacci recursion program.
 - The fibonacci number can be changed by going into `./benchmark/main.go Ln 30`, and editing the number in the function call.