Rust ABI工具库hkalbasi-rustc-ap-rustc_abi使用指南

完整示例代码

下面是一个整合了各种功能的完整示例，展示了如何使用hkalbasi-rustc-ap-rustc_abi库进行全面的ABI分析：

use hkalbasi_rustc_ap_rustc_abi::{
    Abi, CallConvention, Endian, FieldsShape, FnAbi, Layout, LayoutCx, LayoutS,
    TargetDataLayout, Ty, TyKind, Variants,
};

fn main() {
    // 1. 基本类型ABI查询
    let target = TargetDataLayout::default();
    let i32_layout = Layout::scalar(&target, Abi::Int(32, true));
    println!("i32 layout: {:?}", i32_layout);

    // 2. 结构体ABI分析
    let struct_layout = analyze_struct_layout();
    println!("Custom struct layout: {:?}", struct_layout);

    // 3. 跨平台ABI兼容性检查
    check_abi_compatibility();

    // 4. 自定义ABI规则
    custom_abi_rules();

    // 5. 复杂类型布局分析
    analyze_complex_type();
}

fn analyze_struct_layout() -> LayoutS {
    FieldsShape::Arbitrary {
        offsets: vec![0, 4, 8],    // 字段偏移量
        memory_index: vec![0, 1, 2], // 内存索引
    };

    LayoutS {
        variants: Variants::Single { index: 0 }, // 单变体
        fields: FieldsShape::Arbitrary {
            offsets: vec![0, 4, 8],
            memory_index: vec![0, 1, 2],
        },
        abi: Abi::Aggregate { sized: true }, // 聚合类型
        align: 4,  // 对齐字节数
        size: 12,  // 总大小
    }
}

fn check_abi_compatibility() {
    let fn_abi = FnAbi {
        ret: Abi::Scalar(Abi::Int(32, true)), // 返回类型:i32
        args: vec![
            Abi::Scalar(Abi::Int(32, true)),  // 参数1:i32
            Abi::Scalar(Abi::Float(64)),      // 参数2:f64
        ],
        conv: CallConvention::C,  // C调用约定
    };

    println!("Function ABI details:");
    println!("  Return type: {:?}", fn_abi.ret);
    println!("  Arguments: {:?}", fn_abi.args);
    println!("  Calling convention: {:?}", fn_abi.conv);
    println!("  Is C-compatible: {}", fn_abi.is_c_compatible());
}

fn custom_abi_rules() {
    let mut target = TargetDataLayout {
        endian: Endian::Little,  // 小端序
        i1_align: 1,
        i8_align: 1,
        i16_align: 2,
        i32_align: 4,
        i64_align: 8,
        f32_align: 4,
        f64_align: 8,
        pointer_size: 8,
        pointer_align: 8,
        aggregate_align: 8,
        vector_align: vec![],
    };

    // 自定义对齐规则
    target.i32_align = 16; // 强制i32 16字节对齐
    target.f64_align = 4;  // 强制f64 4字节对齐

    let i32_layout = Layout::scalar(&target, Abi::Int(32, true));
    let f64_layout = Layout::scalar(&target, Abi::Float(64));

    println!("Custom aligned i32: {:?}", i32_layout);
    println!("Custom aligned f64: {:?}", f64_layout);
}

fn analyze_complex_type() {
    let target = TargetDataLayout::default();
    let layout_cx = LayoutCx::new(target);

    // 定义一个复杂类型：(i32, [f64; 2], Option<bool>)
    let ty = Ty {
        kind: TyKind::Tuple(vec![
            Ty {
                kind: TyKind::Int(32),
                ..Default::default()
            },
            Ty {
                kind: TyKind::Array(
                    Box::new(Ty {
                        kind: TyKind::Float(64),
                        ..Default::default()
                    }),
                    2,
                ),
                ..Default::default()
            },
            Ty {
                kind: TyKind::Option(Box::new(Ty {
                    kind: TyKind::Bool,
                    ..Default::default()
                })),
                ..Default::default()
            },
        ]),
        ..Default::default()
    };

    match layout_cx.layout_of(ty) {
        Ok(layout) => {
            println!("Complex type layout details:");
            println!("  Size: {}", layout.size);
            println!("  Alignment: {}", layout.align);
            println!("  ABI: {:?}", layout.abi);
            println!("  Fields: {:?}", layout.fields);
        }
        Err(e) => println!("Failed to analyze layout: {:?}", e),
    }
}

示例说明

1. 基本类型ABI查询：展示了如何获取基本类型(如i32)的布局信息
2. 结构体ABI分析：定义了包含3个字段的结构体布局
3. 跨平台ABI检查：验证函数签名是否符合C ABI规范
4. 自定义ABI规则：修改默认对齐规则并查看效果
5. 复杂类型分析：分析包含元组、数组和Option的复杂类型布局

使用建议

1. 在FFI交互前，使用此库验证类型布局是否符合预期
2. 性能优化时，通过分析类型布局找出内存浪费问题
3. 开发跨平台库时，检查不同平台的ABI差异
4. 实现自定义内存分配器时，了解类型的对齐需求

这个完整示例展示了hkalbasi-rustc-ap-rustc_abi库的核心功能，开发者可以根据实际需求调整和扩展这些示例代码。