如何在配置阶段检测Rust库中特定函数是否可用？

要检测libc或nix这类跨平台crate是否提供mmap64、posix_fallocate这类平台相关函数，确实需要通过build.rs在编译配置阶段做检测，核心思路是尝试编译一段引用目标函数的极简代码，根据编译结果生成自定义编译配置项，具体步骤如下：

1. 编写build.rs实现检测逻辑 #

在项目根目录创建build.rs文件，通过调用rustc编译临时代码片段来验证函数是否存在：

use std::env;
use std::fs::File;
use std::io::Write;
use std::path::Path;
use std::process::Command;

// 检测指定libc函数是否存在，存在则生成对应编译cfg
fn check_libc_function(func_name: &str, cfg_flag: &str) {
    let out_dir = env::var_os("OUT_DIR").unwrap();
    let test_file = Path::new(&out_dir).join("test_func.rs");
    
    // 生成引用目标函数的测试代码
    let test_code = format!(
        r#"
extern crate libc;
fn main() {{
    // 仅引用函数，无需调用
    let _ = libc::{};
}}
"#,
        func_name
    );
    
    // 写入临时测试文件
    File::create(&test_file)
        .unwrap()
        .write_all(test_code.as_bytes())
        .unwrap();
    
    // 调用rustc编译测试代码
    let compile_status = Command::new(env::var_os("RUSTC").unwrap())
        // 指定libc crate的路径，由cargo自动注入DEP_LIBC_PATH环境变量
        .arg("--extern")
        .arg(format!(
            "libc={}",
            env::var_os("DEP_LIBC_PATH")
                .unwrap()
                .to_str()
                .unwrap()
        ))
        .arg(&test_file)
        .status()
        .unwrap();
    
    // 编译成功则向cargo传递自定义cfg标识
    if compile_status.success() {
        println!("cargo:rustc-cfg={}", cfg_flag);
    }
}

fn main() {
    // 检测mmap64和posix_fallocate函数
    check_libc_function("mmap64", "has_mmap64");
    check_libc_function("posix_fallocate", "has_posix_fallocate");
}

如果要检测nix crate的函数，只需修改测试代码的引用逻辑，比如检测nix::sys::mman::mmap64：

// 检测nix crate函数的示例
fn check_nix_function(func_name: &str, cfg_flag: &str) {
    let out_dir = env::var_os("OUT_DIR").unwrap();
    let test_file = Path::new(&out_dir).join("test_nix_func.rs");
    
    let test_code = format!(
        r#"
extern crate nix;
use nix::sys::mman;
fn main() {{
    let _ = mman::{};
}}
"#,
        func_name
    );
    
    File::create(&test_file)
        .unwrap()
        .write_all(test_code.as_bytes())
        .unwrap();
    
    let compile_status = Command::new(env::var_os("RUSTC").unwrap())
        .arg("--extern")
        .arg(format!(
            "nix={}",
            env::var_os("DEP_NIX_PATH")
                .unwrap()
                .to_str()
                .unwrap()
        ))
        .arg(&test_file)
        .status()
        .unwrap();
    
    if compile_status.success() {
        println!("cargo:rustc-cfg={}", cfg_flag);
    }
}

2. 配置Cargo.toml #

确保build阶段能依赖目标crate，在Cargo.toml中添加：

[dependencies]
libc = "0.2"
# 如果检测nix的话加上
# nix = "0.27"

[build-dependencies]
libc = "0.2"
# nix = "0.27"

3. 在业务代码中使用自定义cfg #

编译阶段生成的自定义配置项可以通过#[cfg()]来判断，从而选择性使用目标函数：

// 根据编译cfg导入对应函数
#[cfg(has_mmap64)]
use libc::mmap64;
#[cfg(has_posix_fallocate)]
use libc::posix_fallocate;

fn main() {
    #[cfg(has_mmap64)]
    {
        // 仅在mmap64存在的平台执行相关逻辑
        println!("mmap64 is available");
        // let addr = unsafe { mmap64(...) };
    }

    #[cfg(has_posix_fallocate)]
    {
        println!("posix_fallocate is available");
        // let result = unsafe { posix_fallocate(...) };
    }
}

原理说明 #

这种方法利用了rustc的编译检查机制：如果目标函数在当前平台下未被crate导出，编译测试代码时会抛出“未找到函数”的错误，我们通过捕获编译状态来判断函数是否存在，进而生成对应的编译配置标记，让业务代码可以根据平台特性做条件编译。

内容的提问来源于stack exchange，提问作者lvella