Riscrithm – 一款用 Go 编写的直观的 RISC-V 汇编器和优化器
摘要
Riscrithm 是一种用于 RISC-V 的高级宏汇编方言,使用 Go 编写,可将可读代码编译为纯 RISC-V 汇编,并支持可选优化。
查看缓存全文
缓存时间: 2026/05/26 00:50
ghetea-patrick/riscrithm 来源:https://github.com/ghetea-patrick/riscrithm
Riscrithm 开发者手册
你好。如果你正在看这份文档,那么你很可能准备深入接触 Riscrithm——一种高级宏汇编方言,可以直接编译为纯 RISC-V 汇编。你可以把它看作一座桥梁,连接着高级语言的可读性与裸机硬件的原始确定性控制。让我们直接深入编译器的工作原理、语法规则以及背后的实现细节。
1. 命令行界面
要编译你的源代码,需要使用 riscrithm CLI 工具。语法很直接:
riscrithm "source_code_file" "assembly_target_file" [-o/--optimize]
- 源代码: 你的 Riscrithm 输入文件。
- 目标文件: 生成的 .s 汇编文件。如果该文件不存在,编译器会即时为你创建。
- 优化: 传入
-o或--optimize以启用优化扫描(更多信息请参见后面的编译器架构部分)。
2. 文件结构与全局声明
每个 Riscrithm 文件必须在最顶部声明其目标段和入口点。这些内容,连同宏定义,是唯一允许完全无缩进地存在于标签块之外的行。
头部与入口点
- header:设置汇编段。例如
header default会翻译为.section .text。 - entrypoint:定义程序从哪里开始。传入
entrypoint main会翻译为.globl main。
header default
entrypoint main
定义(宏)
你可以使用 define 关键字定义文本替换宏。这对于给寄存器起别名或创建单行内联函数非常有用。以下是一些经典的开发者示例:
define foo = x1
define bar = x2
define baz = x3
define horseBattery = x4
define apple = 10
define orange = 20
define clearFoo = foo ^^
每当解析器看到 foo,它就会在处理任何实际逻辑之前将其替换为 x1。
注释
注释使用 # 符号编写。编译器会去掉任何行中 # 之后的内容,因此你可以安全地将注释放在任何位置。
3. 标签、缩进与原始块
Riscrithm 通过缩进进行严格的作用域划分。
标准标签
标签定义你的执行块,必须以冒号结尾。它们不能有任何缩进。相反,标签内的每条指令必须缩进(空格或制表符均可)。如果你让指令保持无缩进,编译器会抛出 SyntaxError。
main:
load foo = apple
move bar = foo
原始汇编标签(!!)
如果你需要绕过 Riscrithm 预处理程序,直接编写原始 RISC-V 汇编,请在标签前添加 !!。编译器会去掉感叹号,但会保持该块内的所有内容完全不变。宏和简写将不会在此处展开。
!!raw_block:
li x1, 10
foo ^^ # 这里完全保持原样!
4. 核心特性与指令
以下是该语言的核心部分。Riscrithm 将可读的语句直接映射为硬件指令。
系统与中断控制
无需记住特权级操作码,使用显式的系统调用即可:
| Riscrithm | RISC-V 汇编 | 描述 |
|---|---|---|
| interrupt.u | uret | 用户模式陷阱返回 |
| interrupt.s | sret | 监督模式陷阱返回 |
| interrupt.m | mret | 机器模式陷阱返回 |
| wait | wfi | 等待中断(低功耗状态) |
| trap | ebreak | 调试器陷阱 |
| halt | ecall | 系统环境调用 / 暂停 |
| … | nop | 空操作(省略号) |
5. 命名约定
我们来谈谈代码风格。为了让你的 Riscrithm 源文件保持可读性和一致性,编译器期望(并强烈鼓励)识别符的命名方式有清晰的区分。以下是命名约定的详细说明:
- 变量与寄存器(camelCase): 你定义的任何变量别名或寄存器宏应以小写字母开头,后续每个单词首字母大写。
- 示例: firstNum、addressRegister、stackOffset
- 标签与代码块(snake_case): 执行目标、循环边界和条件块使用小写单词,以下划线分隔。这样可以使它们在视觉上与指令区分开来。
- 示例: loop_start、on_true、error_handler
- 常量与字面量(SCREAMING_SNAKE_CASE): 硬编码的配置值、静态偏移量或不应改变的全局定义使用全大写字母,以下划线分隔。
- 示例: DEFAULT_HEADER、MAX_BUFFER_SIZE、IMM_VALUE
6. 完整运算符与表达式参考
除了硬件系统陷阱和条件分支符号外,以下是单遍编译器引擎支持的所有修改器、算术表达式和内存操作符的完整表格。
核心表达式与内存操作符
| Riscrithm 语法 | 类别 | 内部展开 / 行为 | 目标 RISC-V 汇编 |
|---|---|---|---|
| load = | 赋值 | 直接立即数赋值 | li reg, imm |
| move = | 赋值 | 寄存器到寄存器复制 | mv reg1, reg2 |
| swap | 值交换 | 三元 XOR 非破坏性交换 | xor reg1, reg1, reg2 xor reg2, reg1, reg2 xor reg1, reg1, reg2 |
| -> stack.[b/w/d] | 栈内存 | 递减指针,存储字节/字/双字 | addi sp, sp, -offset s[b/w/d] reg, 0(sp) |
| <- stack.[b/w/d] | 栈内存 | 加载字节/字/双字,递增指针 | l[b/w/d] reg, 0(sp) addi sp, sp, offset |
| = stack.[b/w/d] | 栈内存 | 从栈顶窥取值 | l[b/w/d] reg, 0(sp) |
| <- heap.[b/w/d] from & | 堆内存 | 基址寄存器内存读取(加载) | l[b/w/d] reg1, 0(reg2) |
| -> heap.[b/w/d] from & | 堆内存 | 基址寄存器内存写入(存储) | s[b/w/d] reg1, 0(reg2) |
数学与位运算操作符
本节涵盖基本数学操作、自修改运算符和复合简写。记住,如果右侧是整数字面量,编译器会自动将常规操作重排为立即数版本(addi、andi 等)。
| Riscrithm 语法 | 运算符类型 | 求值表达式 |
|---|---|---|
| ++ | 自增运算符 | = + 1 |
| – | 自减运算符 | = - 1 |
| ^^ | 自异或运算符 | = ^ (快速寄存器清零) |
| += | 复合赋值标签 | = + |
| -= | 复合赋值标签 | = - |
| *= | 复合赋值标签 | = * |
| /= | 复合赋值标签 | = / |
| %= | 复合赋值标签 | = % |
| <<= | 复合赋值标签 | = << |
| >>= | 复合赋值标签 | = >> |
| = + | 基础算术 | 加法(支持立即数重排) |
| = - | 基础算术 | 减法(支持立即数重排) |
| = & | 基础算术 | 按位与(支持立即数重排) |
| = | | 基础算术 | 按位或(支持立即数重排) |
| = ^ | 基础算术 | 按位异或(支持立即数重排) |
| = << | 基础算术 | 逻辑左移(支持立即数重排) |
| = >> | 基础算术 | 逻辑右移(支持立即数重排) |
| = * | 基础算术 | 硬件乘法(M 扩展) |
| = / | 基础算术 | 硬件除法(M 扩展) |
| = % | 基础算术 | 硬件取余(M 扩展) |
分支与条件
要无条件跳转,使用 @ 符号:
@some_label # 编译为:j some_label
对于条件分支,Riscrithm 使用内联的 if/else 三元风格。编译器会自动将你的逻辑映射为 beq、bne、blt 或 bge,甚至会在需要处理 > 和 <= 时动态交换寄存器。
if foo == bar @true_block else @false_block
if foo > baz @greater_block else @lesser_block
循环(无限循环与条件循环)
Riscrithm 没有专门的 while 或 for 关键字,因为你不需要它们。你使用标签、条件和跳转构建循环,这是老派方式。
无限循环:
infinite_loop:
foo ++
@infinite_loop
条件循环:
load foo = 0
load bar = 10
loop_start:
if foo == bar @loop_end else @loop_body
loop_body:
foo ++
@loop_start
loop_end:
halt
操作与修改器
Riscrithm 支持立即数赋值和复合数学简写。当编译器检测到你正在使用立即整数而不是寄存器时,它会自动添加 i 后缀(例如 addi、xori)。
- 加载/移动:
load foo = 100,move bar = foo - 数学:
foo += 5,bar *= baz,foo <<= 2 - 递增/递减:
foo ++(addi foo, foo, 1),bar --(addi bar, bar, -1)
^^ 简写: 想快速清零寄存器?使用 XOR-自身操作符
^^。foo ^^会翻译为xor foo, foo, foo,立即将寄存器置零。
交换变量
需要在没有临时第三寄存器的情况下交换两个寄存器?swap 命令使用非破坏性的三元 XOR 序列:
foo swap bar
翻译为:
xor foo, foo, bar
xor bar, foo, bar
xor foo, foo, bar
7. 内存操作(栈与堆)
内存交互需要严格的数据宽度扩展:.b(字节/8位)、.w(字/32位)或 .d(双字/64位)。
栈操作
栈命令会自动按正确字节偏移量调整硬件栈指针(sp)。
- 压栈 (->):
foo -> stack.w(sp 减 4,存储字) - 出栈 (<-):
bar <- stack.d(加载双字,sp 加 8) - 窥视 (=):
baz = stack.b(加载字节,不移动 sp)
堆操作
堆操作要求你使用 & 指针语法提供一个基址寄存器。
- 存储 (->):
foo -> heap.w from &bar(将 foo 中的字存储到 bar 所指向的地址) - 加载 (<-):
baz <- heap.b from &foo(从 foo 所指向的地址加载字节到 baz)
8. 复合代码片段示例
以下是一个结合了这些功能的 Riscrithm 连贯块示例:
main:
# 初始化
load foo = 10
load bar = 20
baz ^^
# 数学与内存
foo += 5
foo -> stack.w
bar *= foo
baz <- heap.w from &bar
# 分支
if foo != bar @continue else @fail
continue:
foo swap bar
halt
fail:
trap
9. 编译器架构与优化器(-o / –optimize)
需要澄清一点:Riscrithm 并非臃肿、复杂的多遍优化引擎。它采用极快的两遍系统:
- 第一遍(清洗): 编译器读取源文件,去除所有注释,标准化空白,并验证严格的缩进规则。它使原始文本完全干净。
- 第二遍(解析与优化): 这是奇迹发生的地方——仅用单一遍。它解析指令,替换宏,展开简写,并且——如果激活了
-o标志——在写入汇编之前即时应用优化。
当你使用 -o 或 --optimize 编译时,第二遍会应用轻量级的 AST 扫描,以三种不同方式清理你的代码:
- 死赋值消除: 连续的重复修改或对同一寄存器的冗余 load/move 序列会被丢弃。(例如,连续两次调用
load foo = 128只会生成一条指令。) - 恒等数学消除: 如果目标寄存器与源寄存器相同,那么完全不改变值的数学运算会被直接删除(例如
foo = foo + 0或bar = bar / 1会被删除)。 - 强度缩减(位运算折叠): 乘法和除法计算开销很大。如果优化器检测到你用静态的 2 的幂进行乘法或除法,它会拦截该指令,并将其重写为高效的移位操作。
foo = bar * 2翻译为slli foo, bar, 1(逻辑左移)。baz = foo / 8翻译为srli baz, foo, 3(逻辑右移)。
10. 干净、即用型输出
Riscrithm 最棒的部分之一是生成的汇编文件并非一团乱码。输出的 .s 文件会自动进行漂亮打印。块内的指令整齐缩进,标签紧贴左边距,整体结构完全可读。你可以将生成的汇编直接丢入硬件模拟器、调试器或桌面工作流,无需做任何格式化。
享受无头痛的汇编编写。祝你编码愉快!
11. 路线图:v1.1.0 正在酝酿什么?
说真的,独自构建一门语言就是一个迭代的苦差事。虽然我目前的双遍编译器引擎通过分离符号解析与代码生成承担了繁重的工作,但我已经在幕后积极地折腾,以带来更强大的开发者体验。以下是 v1.1.0 版本我正在准备的内容:
- 正确的模块导入: 现在,将代码拆分到多个文件是个头痛的问题。我正在开发一个专用的导入系统,让你可以原生地将代码库分解为清晰、可复用的模块,而不会破坏构建流水线。
- 更好的错误处理: 我知道当前编译器诊断信息可能……晦涩难懂。下一个小版本将引入精确的行/列跟踪和真正人类可读的错误消息,而不是仅仅让你的终端崩溃。
- 守卫子句与简单 if 语句: 你不应该为了满足解析器而被迫写一个空的 else 块。我正在更新 AST,以原生支持独立的 if 分支,从而实现更简洁的提前返回守卫模式。
贡献与反馈
对语法有想法,还是发现了一个彻底破坏寄存器分配的边界情况 bug?请提交 issue 或 PR。这个项目由开发者构建,为开发者服务——让我们一起让它变得更好。
相似文章
突破 RISC-V 模拟的极限
这篇博客文章探讨了如何通过在非 RISC-V 机器上使用提前重编译器来加速 RISC-V 执行,该重编译器通过尾调用连接基本块,并利用 Clang 的 preserve_none 调用约定,作为 Axiom 的 OpenVM 项目的一部分。
来自未来的 RISC-V 解释器
Rust 编写的 RISC-V 解释器的更新,支持模块化、no_std、编译时执行,并严格符合规范,同时利用了众多 Rust nightly 版本的特性。
RISCBoy 是一款从零开始设计的开源便携游戏机
RISCBoy 是一款开源便携游戏机,采用 RISC-V CPU 和光栅图形流水线,基于 iCE40 FPGA 实现。该项目包含处理器设计、图形硬件、PCB 布局,并且完全开源。
RISC-V 模拟器与从零开始的 Linux 系统
本仓库提供了 RISC-V 模拟器的源代码,以及从零开始构建一个最小 Linux 系统的教程,包括设备模拟和 WebAssembly 支持。
RISC-V:他们本应更清楚
Dmitry.GR 批评了RISC-V的设计,认为它并非对所有用例都最优,尤其是在微控制器领域,因为代码密度和中断延迟的问题。