storage-bindings 0.4.4

Rust bindings for Storage, the Decentralized Durability Engine
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

use std::env;
use std::fs;
use std::path::{Path, PathBuf};

/// Post-processes the generated bindings file to fix clippy warnings
fn post_process_bindings(bindings_file: &Path) {
    let content = fs::read_to_string(bindings_file).expect("Failed to read bindings file");

    // Fix empty line after outer attribute
    // Replace "#[allow(non_snake_case)]\n\n" with "#[allow(non_snake_case)]\n"
    let fixed_content =
        content.replace("#[allow(non_snake_case)]\n\n", "#[allow(non_snake_case)]\n");

    fs::write(bindings_file, fixed_content).expect("Failed to write fixed bindings");
}

/// Generates Rust FFI bindings from the prebuilt header file
pub fn generate_bindings(lib_dir: &Path) {
    println!("  [BINDINGS] Starting generate_bindings");
    println!("  [BINDINGS] Library directory: {}", lib_dir.display());

    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
    println!("  [BINDINGS] Output directory: {}", out_path.display());

    // The header file is at the root of the extracted directory
    let libstorage_header_path = lib_dir.join("libstorage.h");
    println!(
        "  [BINDINGS] Header file path: {}",
        libstorage_header_path.display()
    );

    if !libstorage_header_path.exists() {
        println!("  [BINDINGS] ✗ Header file does not exist!");
        panic!(
            "libstorage.h not found in prebuilt package at '{}'. \
             This should not happen - please report this issue.",
            libstorage_header_path.display()
        );
    }
    println!("  [BINDINGS] ✓ Header file exists");

    println!("  [BINDINGS] Configuring bindgen builder...");
    let builder = bindgen::Builder::default()
        .header(libstorage_header_path.to_str().expect("Invalid path"))
        .default_enum_style(bindgen::EnumVariation::Rust {
            non_exhaustive: false,
        })
        .generate_block(true)
        .layout_tests(false)
        .allowlist_function("storage_.*")
        .allowlist_type("storage_.*")
        .allowlist_var("storage_.*")
        .allowlist_var("RET_.*")
        .raw_line("#[allow(non_camel_case_types)]")
        .raw_line("#[allow(non_snake_case)]")
        .clang_arg("-D__STDC_VERSION__=201112L")
        .clang_arg("-D__bool_true_false_are_defined=1")
        .clang_arg("-includestdbool.h");
    println!("  [BINDINGS] ✓ Bindgen builder configured");

    println!("  [BINDINGS] Generating bindings...");
    let bindings = builder.generate().expect("Unable to generate bindings");
    println!("  [BINDINGS] ✓ Bindings generated successfully");

    let bindings_file = out_path.join("bindings.rs");
    println!(
        "  [BINDINGS] Writing bindings to: {}",
        bindings_file.display()
    );
    bindings
        .write_to_file(&bindings_file)
        .expect("Couldn't write bindings!");
    println!("  [BINDINGS] ✓ Bindings written successfully");

    post_process_bindings(&bindings_file);
    println!("  [BINDINGS] ✓ Bindings post-processed successfully");

    println!(
        "cargo:rerun-if-changed={}",
        libstorage_header_path.display()
    );
    println!("  [BINDINGS] ✓ generate_bindings completed successfully");
}