目标代码定位工具

TODO

本章节将用于介绍正在研究的 RISC-V 架构适配目标代码定位工具 RVPortingTool

关于规则文档的撰写

同一系列规则集以两个大写字母（如 XX）的形式编号，每条规则以 XX-0001 的形式递增编号。每条规则包含 描述、代码示例、修复建议 和 自动化检测技术细节 四部分，其中 代码示例 中，不同项目（或同一项目的不同用法）需要加小标题，格式为 示例：用法简短说明。

每条规则包含三项元数据：

编程语言：规则涉及的编程语言，任意语言表示为 Any，与源代码文件内容无关表示为 None。
默认级别：产生的检查报告中该规则对应问题的默认级别，可选值：Hint，Information，Warning，Error。
TAG：问题对应的标签，应简明扼要。

CC：C/C++ 相关规则

本节中定义了 C/C++ 语言的架构相关代码检查规则。

CC-0001 ARM 架构特有宏

编程语言：C/C++
默认级别：Error
TAG：ARM，宏

描述

C/C++ 程序源代码中使用了 ARM 架构特有宏，这些宏在 RISC-V 架构下需要进行适配调整。

完整的 ARM 架构特有宏列表详见此处

另外，由于宏判断结构的存在，宏的架构相关性具有 传递性，需要同时关注在上述架构特有宏 作为条件 的宏判断结构下定义的 其它自定义宏 的用法。

本条规则是按照字典严格匹配的结果，即匹配到的宏是已知的 ARM 架构特有宏。 CC-0002 疑似 ARM 架构特有宏是对本条规则的补充，用于模糊匹配其它以 __ARM_ 开头的疑似 ARM 架构特有宏。

代码示例

以下形式的 C/C++ 程序代码可被称为“使用了”ARM 架构特有宏。

// 使用 ifdef / ifndef 判断 ARM 架构特有宏是否已定义
#ifdef __arm__
#ifndef __aarch64__
// 使用 if / elif 判断 ARM 架构特有宏是否已定义
#if __arm__
#elif (__arm__ || __aarch64__)
#if defined(__arm__)
#elif defined(__aarch64__) && defined(__ARM_FEATURE_CRYPTO)
// 使用 elifdef / elifndef 判断 ARM 架构特有宏是否已定义 (C++ 23)
#elifdef __arm__
#elifndef __aarch64__

示例：zlib 库中使用 ARM 指令集 CRC32 拓展功能

// =============================================================================
// https://github.com/madler/zlib/blob/04f42ceca40f73e2978b50e93806c2a18c1281fc/crc32.c#L102-L104
// 此处使用两个 ARM 架构特有宏 __aarch64__ 和 __ARM_FEATURE_CRC32 作为条件，定义宏 ARMCRC32
#if defined(__aarch64__) && defined(__ARM_FEATURE_CRC32) && W == 8
#  define ARMCRC32
#endif
// -----------------------------------------------------------------------------
// https://github.com/madler/zlib/blob/04f42ceca40f73e2978b50e93806c2a18c1281fc/crc32.c#L110-L112
// 后续使用定义的宏 ARMCRC32 调整变量数据类型
#if defined(W) && (!defined(ARMCRC32) || defined(DYNAMIC_CRC_TABLE))
    local z_word_t byte_swap OF((z_word_t word));
#endif
// =============================================================================

示例：ZeroTier 中使用 ARM 指令集 CRYPTO 拓展功能

// =============================================================================
// https://github.com/zerotier/ZeroTierOne/blob/9c9d1650d1f97f57addaf4027a8579d308eed6d5/node/Constants.hpp#L141-L144
// 此处使用 ARM 架构特有宏 __ARM_FEATURE_CRYPTO 作为条件，定义宏 ZT_ARCH_ARM_HAS_CRYPTO
#if defined(__ARM_FEATURE_CRYPTO)
// ARM Cryptography Extension
#define ZT_ARCH_ARM_HAS_CRYPTO
#endif
// -----------------------------------------------------------------------------
// https://github.com/zerotier/ZeroTierOne/blob/9c9d1650d1f97f57addaf4027a8579d308eed6d5/node/AES.hpp#L27-L29
// 后续使用定义的宏 ZT_ARCH_ARM_HAS_CRYPTO 作为条件，定义宏 ZT_AES_NEON
#if !defined(ZT_AES_NO_ACCEL) && defined(ZT_ARCH_ARM_HAS_NEON) && defined(ZT_ARCH_ARM_HAS_CRYPTO)
#define ZT_AES_NEON 1
#endif
// -----------------------------------------------------------------------------
// https://github.com/zerotier/ZeroTierOne/blob/9c9d1650d1f97f57addaf4027a8579d308eed6d5/node/AES.hpp#L107-L122
// 后续使用定义的宏 ZT_AES_NEON 作为条件，调用不同架构下的函数实现
ZT_INLINE void encrypt(const void *const in, void *const out) const noexcept
{
// ......
#ifdef ZT_AES_NEON
    if (Utils::ARMCAP.aes) {
        // 可能的话，调用 ARM NEON 版本 encrypt 函数实现
        p_encrypt_armneon_crypto(in, out);
        return;
    }
#endif
    // 回退到软件模拟版本 encrypt 函数实现
    p_encryptSW(reinterpret_cast<const uint8_t *>(in), reinterpret_cast<uint8_t *>(out));
}
// =============================================================================

修复建议

关于原有代码：请确保原有针对 ARM 架构的相关代码已包含在 ARM 架构相关宏判断结构 中，或已通过其它方法确保仅在 ARM 架构下启用，以防止在其它架构下产生编译错误。
关于适配代码：请对应查找目标架构下是否具有相同的拓展特性与功能，在保证上层 API 封装兼容的前提下，结合 目标架构相关宏判断结构 引入适配代码，并确保适配代码仅在目标架构下启用，以防止在原有架构下产生编译错误。

前缀	架构名称	描述
`__builtin_arm_`	ARM
`__builtin_neon_`	ARM
`__builtin_mve_`	ARM
`__builtin_ia32_`	X86
`__builtin_ia64_`	X86
`__builtin_riscv_`	RISC-V