starpu-sys 3.1.0

Low-level bindings to the StarPU runtime
Documentation 
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
84

use bindgen::EnumVariation;
use std::{env, path::PathBuf, sync::OnceLock};

fn main() {
    // Find the library using pkg-config
    let library = find_starpu();

    // Generate the Rust bindings
    let bindings = generate_bindings(&library);

    // Write the bindings to the $OUT_DIR/bindings.rs file.
    let out_path = PathBuf::from(env::var("OUT_DIR").unwrap());
    bindings
        .write_to_file(out_path.join("bindings.rs"))
        .expect("Couldn't write bindings!");
}

/// Use pkg-config to locate and use a certain StarPU release
fn find_starpu() -> pkg_config::Library {
    let lib = pkg_config::Config::new()
        .probe("libstarpu")
        .expect("Could not find a suitable version of StarPU");

    // As it turns-out, pkg-config does not correctly set up the RPATHs for the
    // transitive dependencies of StarPU. Fix that.
    if target_family().split(',').any(|family| family == "unix") {
        for link_path in &lib.link_paths {
            println!(
                "cargo:rustc-link-arg=-Wl,-rpath,{}",
                link_path
                    .to_str()
                    .expect("Link path is not an UTF-8 string")
            );
        }
    }

    // Forward pkg-config output for futher consumption
    lib
}

/// Generate StarPU bindings using bindgen
fn generate_bindings(library: &pkg_config::Library) -> bindgen::Bindings {
    bindgen::Builder::default()
        .allowlist_file(".*/starpu/.*")
        .allowlist_recursively(false)
        .allowlist_type(".*va_list.*|drand48_data")
        .array_pointers_in_arguments(true)
        .blocklist_var("STARPU_TASK_INIT")
        .clang_args(
            library
                .include_paths
                .iter()
                .flat_map(|include_path| {
                    ["-isystem".to_string(), include_path.display().to_string()]
                })
                .chain(std::iter::once(
                    "-fretain-comments-from-system-headers".to_string(),
                ))
                .collect::<Vec<_>>(),
        )
        .default_enum_style(EnumVariation::Consts)
        .derive_copy(true)
        .derive_debug(true)
        .derive_default(true)
        .generate_cstr(true)
        .header("wrapper.h")
        .impl_debug(true)
        .parse_callbacks(Box::new(bindgen::CargoCallbacks::new()))
        .prepend_enum_name(false)
        .generate()
        .expect("Unable to generate StarPU bindings")
}

/// Cross-compilation friendly alternative to `cfg!(target_family)`
fn target_family() -> &'static str {
    static TARGET_FAMILY: OnceLock<Box<str>> = OnceLock::new();
    TARGET_FAMILY
        .get_or_init(|| {
            std::env::var("CARGO_CFG_TARGET_FAMILY")
                .expect("Cargo should tell us what the target family is")
                .into_boxed_str()
        })
        .as_ref()
}