go.vm 项目教程

go.vm 项目教程

go.vm A simple virtual machine - compiler & interpreter - written in golang 项目地址: https://gitcode.com/gh_mirrors/go/go.vm

1. 项目目录结构及介绍

go.vm 项目的目录结构如下：

go.vm/
├── cmd/
│   ├── compile/
│   ├── dump/
│   ├── execute/
│   ├── run/
│   └── version/
├── cpu/
│   ├── cpu.go
│   ├── register.go
│   ├── stack.go
│   └── traps.go
├── examples/
│   ├── hello.in
│   ├── peek-strlen.in
│   └── trap-stdin.in
├── lexer/
│   └── lexer.go
├── opcode/
│   └── opcode.go
├── token/
│   └── token.go
├── .gitignore
├── LICENSE
├── README.md
├── go.mod
├── go.sum
└── main.go

目录介绍

• cmd/: 包含项目的命令行工具，如编译器 (compile)、执行器 (execute)、运行器 (run) 和版本查看器 (version)。
• cpu/: 包含虚拟机的核心实现文件，如 CPU 模拟器 (cpu.go)、寄存器实现 (register.go)、堆栈实现 (stack.go) 和陷阱处理 (traps.go)。
• examples/: 包含一些示例程序，如 hello.in、peek-strlen.in 和 trap-stdin.in。
• lexer/: 包含词法分析器的实现 (lexer.go)。
• opcode/: 包含操作码的定义 (opcode.go)。
• token/: 包含词法分析器使用的 token 定义 (token.go)。
• .gitignore: Git 忽略文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• go.mod: Go 模块文件。
• go.sum: Go 模块依赖的校验和文件。
• main.go: 项目的主入口文件。

2. 项目启动文件介绍

项目的启动文件是 main.go。该文件是整个项目的入口点，负责初始化和启动虚拟机。

main.go 文件内容概述

package main

import (
    "fmt"
    "os"
    "github.com/skx/go.vm/cmd"
)

func main() {
    if len(os.Args) < 2 {
        fmt.Println("Usage: go.vm <command> [arguments]")
        os.Exit(1)
    }

    command := os.Args[1]
    args := os.Args[2:]

    switch command {
    case "compile":
        cmd.Compile(args)
    case "execute":
        cmd.Execute(args)
    case "run":
        cmd.Run(args)
    case "version":
        cmd.Version(args)
    default:
        fmt.Println("Unknown command:", command)
        os.Exit(1)
    }
}

启动流程

1. 命令行参数解析: main.go 首先检查命令行参数，确定用户输入的命令。
2. 命令分发: 根据用户输入的命令，调用相应的子命令处理函数，如 cmd.Compile、cmd.Execute、cmd.Run 或 cmd.Version。

3. 项目配置文件介绍

go.vm 项目没有传统的配置文件，其配置主要通过命令行参数和代码中的硬编码实现。

命令行参数

• compile: 编译指定的输入文件。
• execute: 执行指定的字节码文件。
• run: 编译并直接执行指定的输入文件。
• version: 显示当前版本信息。

示例

# 编译输入文件
go.vm compile examples/hello.in

# 执行字节码文件
go.vm execute examples/hello.raw

# 编译并直接执行输入文件
go.vm run examples/hello.in

# 查看版本信息
go.vm version

通过这些命令行参数，用户可以灵活地使用 go.vm 项目进行编译和执行操作。

go.vm A simple virtual machine - compiler & interpreter - written in golang 项目地址: https://gitcode.com/gh_mirrors/go/go.vm