marsupial-sys 0.2.0

//! NOTE: This build does *not* use the upstream makefile system. Instead, it
//! executes the C compiler directly, via the `cc` crate. That avoids taking
//! build dependencies on make and xsltproc, which would be problematic on
//! Windows. However, it does mean that we'll need to be careful to track build
//! changes when we re-vendor upstream code.

use bindgen::callbacks::ParseCallbacks;
use std::{env, path::PathBuf};

#[derive(Debug)]
struct ParseDoxygen;

impl ParseCallbacks for ParseDoxygen {
    fn process_comment(&self, comment: &str) -> Option<String> {
        Some(doxygen_rs::transform(comment))
    }
}

enum TargetImplementation {
    Optimized64,
    // Note that Optimized64NoAsm uses the same bindings as Optimized64.
    Optimized64NoAsm,
    Plain64,
    Inplace32BI,
    Armv8Asha3,
}

fn main() {
    let target_arch = env::var("CARGO_CFG_TARGET_ARCH").unwrap();
    let target_os = env::var("CARGO_CFG_TARGET_OS").unwrap();
    let target_pointer_width =
        env::var("CARGO_CFG_TARGET_POINTER_WIDTH").unwrap();
    let target_env = env::var("CARGO_CFG_TARGET_ENV").unwrap(); // e.g. "msvc" on Windows
    let target_is_little_endian =
        match env::var("CARGO_CFG_TARGET_ENDIAN").unwrap().as_str() {
            "little" => true,
            "big" => false,
            e => panic!("unexpected endianness: {}", e),
        };
    let target_has_armv8_sha3 = env::var("CARGO_CFG_TARGET_FEATURE")
        .unwrap_or("".to_string())
        .as_str()
        .split(',')
        .any(|f| f == "sha3");

    let target_implementation = if target_arch == "x86_64" {
        if target_os != "windows" {
            TargetImplementation::Optimized64
        } else {
            // The current assembly implementation doesn't include a Windows
            // assembler syntax version.
            TargetImplementation::Optimized64NoAsm
        }
    } else if target_arch == "aarch64" && target_has_armv8_sha3 {
        TargetImplementation::Armv8Asha3
    } else if target_pointer_width == "64" {
        TargetImplementation::Plain64
    } else if target_pointer_width == "32" {
        TargetImplementation::Inplace32BI
    } else {
        panic!("unsupported target pointer width: {}", target_pointer_width);
    };

    let bindings = bindgen::Builder::default()
        .header("src/XKCP-K12/lib/KangarooTwelve.h")
        .clang_args([
            format!(
                "-Isrc/XKCP-K12/lib/{}",
                match target_implementation {
                    TargetImplementation::Optimized64
                    | TargetImplementation::Optimized64NoAsm => "Optimized64",
                    TargetImplementation::Plain64 => "Plain64",
                    TargetImplementation::Inplace32BI => "Inplace32BI",
                    TargetImplementation::Armv8Asha3 => "ARMv8Asha3",
                }
            ),
            format!("-m{target_pointer_width}"),
        ])
        .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
        .parse_callbacks(Box::new(ParseDoxygen))
        .generate()
        .expect("Unable to generate C bindings");

    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
    bindings
        .write_to_file(out_path.join("bindings.rs"))
        .expect("Unable to write the C bindings to a file");

    // Configure the base_build, which might be used for multiple different
    // compilation steps below.
    let mut base_build = cc::Build::new();
    base_build.include("src/XKCP-K12/lib");
    // disable debug assertions
    base_build.define("NDEBUG", "1");
    // brg_endian.h tries to detect the target endianness, but it fails on e.g.
    // mips. Cargo knows better, so we explicitly set the preprocessor
    // variables that brg_endian.h looks for.
    if target_is_little_endian {
        base_build.define("LITTLE_ENDIAN", "1");
    } else {
        base_build.define("BIG_ENDIAN", "1");
    }
    match &target_implementation {
        TargetImplementation::Optimized64
        | TargetImplementation::Optimized64NoAsm => {
            // These two targets share headers.
            base_build.include("src/XKCP-K12/lib/Optimized64");
        }
        TargetImplementation::Plain64 => {
            base_build.include("src/XKCP-K12/lib/Plain64");
        }
        TargetImplementation::Inplace32BI => {
            base_build.include("src/XKCP-K12/lib/Inplace32BI");
        }
        TargetImplementation::Armv8Asha3 => {
            base_build.include("src/XKCP-K12/lib/ARMv8Asha3");
        }
    }
    if let TargetImplementation::Optimized64NoAsm = &target_implementation {
        // Since Optimized64 and Optimized64NoAsm use the same header file,
        // KeccakP-1600-runtimeDispatch.c relies on this preprocessor var to
        // distinguish them.
        base_build.define("KeccakP1600_noAssembly", "1");
    }
    let base_build = base_build; // immutable from here on

    let mut portable_build = base_build.clone();
    portable_build.file("src/XKCP-K12/lib/KangarooTwelve.c");
    // The different targets add additional portable files.

    match &target_implementation {
        TargetImplementation::Optimized64
        | TargetImplementation::Optimized64NoAsm => {
            portable_build
                .file("src/XKCP-K12/lib/Optimized64/KeccakP-1600-opt64.c");
            portable_build.file(
                "src/XKCP-K12/lib/Optimized64/KeccakP-1600-runtimeDispatch.c",
            );

            let mut ssse3_build = base_build.clone();
            if target_env != "msvc" {
                ssse3_build.flag("-mssse3");
            }
            ssse3_build.file(
                "src/XKCP-K12/lib/Optimized64/KeccakP-1600-timesN-SSSE3.c",
            );
            ssse3_build.compile("k12_ssse3");

            let mut avx2_build = base_build.clone();
            if target_env == "msvc" {
                avx2_build.flag("/arch:AVX2");
            } else {
                avx2_build.flag("-mavx2");
            }
            avx2_build.file(
                "src/XKCP-K12/lib/Optimized64/KeccakP-1600-timesN-AVX2.c",
            );
            avx2_build.compile("k12_avx2");

            let mut avx512_build = base_build.clone();
            if target_env == "msvc" {
                avx2_build.flag("/arch:AVX512");
            } else {
                avx512_build.flag("-mavx512f");
                avx512_build.flag("-mavx512vl");
            }
            avx512_build.file(
                "src/XKCP-K12/lib/Optimized64/KeccakP-1600-timesN-AVX512.c",
            );
            // For the non-asm build we add another file below.

            if let TargetImplementation::Optimized64 = &target_implementation
            {
                let mut asm_build = base_build.clone();
                asm_build
                    .file("src/XKCP-K12/lib/Optimized64/KeccakP-1600-AVX2.s");
                asm_build.file(
                    "src/XKCP-K12/lib/Optimized64/KeccakP-1600-AVX512.s",
                );
                if target_os == "macos" {
                    // see https://github.com/XKCP/K12/blob/b4f434574c501b1088468180feeeaab6117341e4/support/Build/ToTargetMakefile.xsl#L178
                    asm_build.flag("-xassembler-with-cpp");
                    asm_build.flag("-Wa,-defsym,macOS=1");
                }
                asm_build.compile("k12_asm");
            } else {
                avx512_build.file("src/XKCP-K12/lib/Optimized64/KeccakP-1600-AVX512-plainC.c");
            }

            avx512_build.compile("k12_avx512");
        }
        TargetImplementation::Plain64 => {
            portable_build
                .file("src/XKCP-K12/lib/Optimized64/KeccakP-1600-opt64.c");
            portable_build
                .file("src/XKCP-K12/lib/Plain64/KeccakP-1600-plain64.c");
        }
        TargetImplementation::Inplace32BI => {
            portable_build.file(
                "src/XKCP-K12/lib/Inplace32BI/KeccakP-1600-inplace32BI.c",
            );
        }
        TargetImplementation::Armv8Asha3 => {
            let mut sha3_build = base_build.clone();
            sha3_build.flag("-march=armv8.4-a+sha3");
            sha3_build
                .file("src/XKCP-K12/lib/ARMv8Asha3/KeccakP-1600-opt64.c");
            sha3_build.compile("k12_sha3");

            let mut asm_build = base_build.clone();
            asm_build.flag("-march=armv8.4-a+sha3");
            if target_os == "macos" {
                // i'm unable to test if this actually makes this work, i lack a
                // macOS device to test this on
                asm_build.flag("-xassembler-with-cpp");
                asm_build.flag("-Wa,-defsym,macOS=1");
            }
            asm_build.file(
                "src/XKCP-K12/lib/ARMv8Asha3/KeccakP-1600-ARMv8Asha3.S",
            );
            asm_build.compile("k12_asm");
        }
    }

    portable_build.compile("k12");
}