Compiler Explorer项目：如何为新的指令集添加汇编文档支持

诸余煦

于 2025-06-02 09:03:37 发布

阅读量383

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_00621/article/details/148375323

Compiler Explorer项目：如何为新的指令集添加汇编文档支持

compiler-explorer Run compilers interactively from your web browser and interact with the assembly 项目地址: https://gitcode.com/gh_mirrors/co/compiler-explorer

Compiler Explorer（简称CE）是一个强大的在线工具，允许开发者查看编译器生成的汇编代码。其中一个重要功能是为汇编指令提供即时文档支持，帮助开发者理解生成的汇编代码。本文将详细介绍如何为CE添加对新指令集的汇编文档支持。

功能概述

CE目前已经支持多种指令集的文档功能，包括：

JVM字节码
AMD64架构指令
ARM32架构指令

当用户在汇编代码中悬停或点击指令时，CE会显示该指令的简要说明（工具提示）或详细文档（弹出窗口），并可能提供外部文档链接。

实现步骤详解

第一步：寻找数据源

为指令集添加文档支持的首要任务是找到一个可靠的数据源。理想的数据源应具备以下特点：

全面性：覆盖目标指令集的所有指令
结构化：便于程序化提取信息
权威性：来自官方或公认的权威来源

常见的数据源包括：

处理器厂商的官方文档网站（如ARM开发者网站）
指令集规范文档（如Oracle的JVM规范）
开源项目维护的指令集数据库

第二步：创建数据收集工具

有了数据源后，需要编写一个数据收集工具（通常称为"docenizer"）来自动化处理文档信息。这个工具的核心任务是：

从数据源提取指令信息
将信息转换为CE所需的格式
生成TypeScript文件

生成的.ts文件应包含一个大型switch语句，每个case对应一条指令，返回包含三个字段的对象：

case "MOV":
    return {
        "html": "<div>移动数据指令...</div>",  // 弹出窗口中显示的HTML
        "tooltip": "移动数据",               // 悬停时显示的工具提示
        "url": "https://example.com/mov"    // 完整文档链接
    };

工具开发建议：

使用Node.js或Python等脚本语言
考虑使用HTML解析库（如cheerio、BeautifulSoup）
确保工具易于他人运行和维护

第三步：集成到CE系统

完成数据收集工具后，需要将其输出集成到CE中：

创建文档提供者类：
- 在/lib/asm-docs目录下创建新文件
- 定义一个继承自BaseAssemblyDocumentationProvider的类
- 实现getInstructionInformation方法，调用生成的switch语句

示例代码结构：

import {getAsmOpcode} from './generated/asm-docs-newisa';
import {BaseAssemblyDocumentationProvider} from './base';

export class NewISADocumentationProvider extends BaseAssemblyDocumentationProvider {
  public static get key() {
    return 'newisa';  // 指令集唯一标识
  }
  
  public override getInstructionInformation(instruction: string) {
    return getAsmOpcode(instruction) || null;
  }
}