# riscv_codegen

**Repository Path**: coolgpu/riscv_codegen

## Basic Information

- **Project Name**: riscv_codegen
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-06-18
- **Last Updated**: 2025-06-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# RISC-V汇编代码生成器

一个用Python实现的RISC-V汇编代码生成器，支持循环、条件判断和各种汇编指令的生成。

## 功能特性

- ✅ **完整的RISC-V指令集支持**：算术、逻辑、内存访问、分支、跳转等指令
- ✅ **智能寄存器管理**：自动分配和释放寄存器，避免冲突
- ✅ **高级控制流**：支持循环、条件判断等高级结构
- ✅ **低级API**：每个API对应一条汇编指令，提供精确控制
- ✅ **向量操作**：内置向量加法等常用操作的高级接口
- ✅ **代码组织**：支持数据段、代码段的分离管理
- ✅ **函数支持**：函数定义、调用约定、栈管理

## 项目结构

```
codegen/
├── riscv_codegen/           # 主要包
│   ├── __init__.py         # 包初始化
│   ├── core.py             # 核心代码生成器
│   ├── instructions.py     # RISC-V指令集定义
│   ├── registers.py        # 寄存器管理
│   └── utils.py            # 工具函数
├── examples/               # 示例程序
│   └── vector_add.py       # 向量加法演示
├── tests/                  # 测试文件
│   └── test_basic.py       # 基础功能测试
├── requirements.txt        # 项目依赖
└── README.md              # 项目说明
```

## 快速开始

### 1. 基本使用

```python
from riscv_codegen import RISCVCodeGenerator

# 创建代码生成器
codegen = RISCVCodeGenerator()

# 定义数据
codegen.define_data_word("numbers", 1, 2, 3, 4, 5)

# 生成代码
codegen.emit_label("_start")

# 使用低级API生成指令
reg1 = codegen.allocate_register('t0')
reg2 = codegen.allocate_register('t1')

codegen.instructions.la(reg1, "numbers")    # 加载地址
codegen.instructions.lw(reg2, 0, reg1)      # 加载数据
codegen.instructions.addi(reg2, reg2, 10)   # 加10
codegen.instructions.sw(reg2, 0, reg1)      # 存储回去

# 程序结束
codegen.instructions.li('a0', 0)
codegen.instructions.li('a7', 93)
codegen.instructions.ecall()

# 输出生成的汇编代码
print(codegen.generate_code())
```

### 2. 使用循环结构

```python
# 创建循环
counter = codegen.allocate_register('t0')
limit = codegen.allocate_register('t1')

codegen.instructions.li(limit, 10)

with codegen.create_loop(counter_reg=counter, limit_reg=limit):
    # 循环体代码
    codegen.instructions.addi(counter, counter, 1)
    # 更多操作...
```

### 3. 使用条件判断

```python
# 条件判断
condition_reg = codegen.allocate_register('t0')
codegen.instructions.li(condition_reg, 5)

with codegen.create_if(condition_reg, 'gt', 'zero'):
    # if块代码
    codegen.instructions.addi(condition_reg, condition_reg, 1)
else:
    # else块代码
    codegen.instructions.li(condition_reg, 0)
```

### 4. 向量加法示例

```python
# 定义向量数据
codegen.define_data_word("vec_a", 1, 2, 3, 4, 5)
codegen.define_data_word("vec_b", 6, 7, 8, 9, 10)
codegen.define_data_space("vec_result", 20)

# 使用高级向量API
with codegen.vector_add("vec_result", "vec_a", "vec_b", 5) as vector_op:
    vector_op.generate_loop()
```

## 支持的指令

### 算术指令
- `add`, `addi` - 加法
- `sub` - 减法  
- `mul`, `div`, `rem` - 乘法、除法、取余

### 逻辑指令
- `and`, `andi` - 与运算
- `or`, `ori` - 或运算
- `xor`, `xori` - 异或运算

### 位移指令
- `sll`, `slli` - 逻辑左移
- `srl`, `srli` - 逻辑右移
- `sra`, `srai` - 算术右移

### 比较指令
- `slt`, `slti` - 小于比较
- `sltu`, `sltiu` - 无符号小于比较

### 内存访问指令
- `lw`, `lh`, `lb` - 加载字、半字、字节
- `lhu`, `lbu` - 加载无符号半字、字节
- `sw`, `sh`, `sb` - 存储字、半字、字节

### 分支指令
- `beq`, `bne` - 相等/不等分支
- `blt`, `bge` - 小于/大于等于分支
- `bltu`, `bgeu` - 无符号比较分支

### 跳转指令
- `jal`, `jalr` - 跳转并链接
- `j`, `jr` - 无条件跳转
- `ret` - 返回

## 运行示例

### 运行向量加法演示

```bash
cd examples
python vector_add.py
```

### 运行测试

```bash
cd tests
python test_basic.py
```

## 生成的代码示例

以下是生成的RISC-V汇编代码示例：

```assembly
.section .data
vector_a:
    .word 1
    .word 2
    .word 3
    .word 4
    .word 5
vector_b:
    .word 6
    .word 7
    .word 8
    .word 9
    .word 10
vector_result:
    .space 20

.section .text
.globl _start

_start:
    # 向量加法演示程序
    la t0, vector_a         # 加载vector_a地址
    la t1, vector_b         # 加载vector_b地址
    la t2, vector_result    # 加载result地址
    li t4, 5               # 设置循环次数
    li t3, 0               # 初始化计数器
loop_start_1:
    slli t5, t3, 2         # 计算偏移量
    add t6, t0, t5         # 计算vector_a[i]地址
    lw a0, 0(t6)           # 加载vector_a[i]
    add t6, t1, t5         # 计算vector_b[i]地址
    lw a1, 0(t6)           # 加载vector_b[i]
    add a0, a0, a1         # 执行加法
    add t6, t2, t5         # 计算result[i]地址
    sw a0, 0(t6)           # 存储结果
    addi t3, t3, 1         # 计数器递增
    blt t3, t4, loop_start_1  # 循环条件判断
loop_end_1:
    li a0, 0               # 设置退出码
    li a7, 93              # exit系统调用
    ecall                  # 系统调用
```

## 高级特性

### 1. 寄存器管理
- 自动分配临时寄存器
- 避免寄存器冲突
- 支持寄存器保存和恢复

### 2. 标签管理
- 自动生成唯一标签
- 循环和条件判断标签
- 函数标签管理

### 3. 栈管理
- 函数序言和结语
- 寄存器保存到栈
- 局部变量分配

### 4. 代码优化
- 常数乘法优化
- 立即数范围检查
- 指令选择优化

## 开发计划

- [ ] 支持更多RISC-V扩展指令集
- [ ] 添加代码优化功能
- [ ] 支持调试信息生成
- [ ] 添加汇编器集成
- [ ] 性能基准测试

## 贡献

欢迎提交Issue和Pull Request！

## 许可证

MIT License