alef 0.26.6

Opinionated polyglot binding generator for Rust libraries
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! Same-named function entry re-gating for the Rustler NIF emitter.
//!
//! Rustler discovers NIFs from `#[rustler::nif]`-annotated functions: every annotated function
//! that survives `cfg` evaluation is registered. When a crate exposes the same public function
//! under disjoint `cfg` gates plus an *ungated* fallback, the Rustler emitter would emit one
//! `#[rustler::nif]` definition per surface entry. If more than one of them compiles for a given
//! feature set, Rustler's `on_load` aborts the whole module with
//! `{:error, {:bad_lib, 'Duplicate NIF entry for ...'}}`.
//!
//! The canonical trigger is an inline fallback module paired with cfg-gated real modules:
//!
//! ```ignore
//! #[cfg(feature = "ner")]
//! pub mod ner;                                  // real module: known_models under ner-onnx pair
//!
//! #[cfg(not(feature = "ner"))]
//! pub mod ner { pub fn known_models() { .. } }  // inline stub fallback
//! ```
//!
//! `known_models` is extracted three times: `#[cfg(feature = "ner-onnx")]`,
//! `#[cfg(not(feature = "ner-onnx"))]`, and the inline-stub entry. The extractor does not compose
//! the enclosing `#[cfg(not(feature = "ner"))]` module gate onto the inline-stub function, so its
//! surface entry is *unconditional* — and the emitted NIF compiles alongside whichever
//! `ner-onnx` arm is active, producing the duplicate registration.
//!
//! Unlike the FFI dedup (`backends::ffi::gen_bindings::functions::cfg_dedup`), the Rustler arms
//! have distinct bodies (real impl vs. stub), so they must each survive as their own
//! `#[rustler::nif]` definition. Collapsing them into one entry would drop the cfg-specific bodies.
//! Instead, `regate_ungated_same_name_functions` keeps every gated arm and re-gates each ungated
//! entry to `not(any(<all gated cfgs in the group>))`, so the fallback NIF compiles only when no
//! gated arm does. For the `ner` case the gated arms are exhaustive, so the fallback is gated out
//! entirely — exactly the desired result (no ungated duplicate). All other backends and the e2e
//! validator continue to see the untouched multi-entry surface.

use crate::core::ir::FunctionDef;
use ahash::AHashMap;

/// Returns a `Vec<FunctionDef>` in which any *ungated* entry sharing its `name` with at least one
/// *gated* entry is re-gated to `not(any(<gated cfgs>))`.
///
/// Functions whose `name` is unique, groups with no ungated member, and groups whose members are
/// all ungated pass through unchanged. The relative order of the input is preserved; only the
/// `cfg` field of ungated entries in mixed groups is rewritten.
pub(in crate::backends::rustler::gen_bindings) fn regate_ungated_same_name_functions(
    functions: &[FunctionDef],
) -> Vec<FunctionDef> {
    let groups = collect_function_groups(functions);

    // For each name, the OR-merge of the distinct cfgs of its *gated* members.
    let mut gated_cfg_by_name: AHashMap<&str, Option<String>> = AHashMap::new();
    for (name, indices) in &groups {
        if !is_mixed_gated_group(indices, functions) {
            continue;
        }
        let gated = merge_gated_cfgs(indices.iter().map(|&i| functions[i].cfg.as_deref()));
        gated_cfg_by_name.insert(name.as_str(), gated);
    }

    if gated_cfg_by_name.is_empty() {
        return functions.to_vec();
    }

    functions
        .iter()
        .cloned()
        .map(|mut function| {
            if function.cfg.is_none() {
                if let Some(Some(gated)) = gated_cfg_by_name.get(function.name.as_str()) {
                    function.cfg = Some(format!("not({gated})"));
                }
            }
            function
        })
        .collect()
}

fn collect_function_groups(functions: &[FunctionDef]) -> AHashMap<String, Vec<usize>> {
    let mut name_to_indices: AHashMap<String, Vec<usize>> = AHashMap::new();
    for (idx, func) in functions.iter().enumerate() {
        name_to_indices.entry(func.name.clone()).or_default().push(idx);
    }
    name_to_indices
}

/// A group is "mixed-gated" when it has at least one ungated (`cfg = None`) member and at least
/// one gated (`cfg = Some`) member. Only mixed groups carry the duplicate-NIF hazard.
fn is_mixed_gated_group(indices: &[usize], functions: &[FunctionDef]) -> bool {
    if indices.len() <= 1 {
        return false;
    }
    let has_ungated = indices.iter().any(|&i| functions[i].cfg.is_none());
    let has_gated = indices.iter().any(|&i| functions[i].cfg.is_some());
    has_ungated && has_gated
}

/// OR-merge the distinct cfg predicates of the *gated* members of a group.
///
/// Returns `None` when no member is gated (caller guards against this via `is_mixed_gated_group`).
/// A single distinct gated cfg is returned verbatim; multiple are wrapped in `any(...)`.
fn merge_gated_cfgs<'a>(cfgs: impl Iterator<Item = Option<&'a str>>) -> Option<String> {
    let mut distinct: Vec<&str> = Vec::new();
    for cfg in cfgs.flatten() {
        if !distinct.contains(&cfg) {
            distinct.push(cfg);
        }
    }
    match distinct.len() {
        0 => None,
        1 => Some(distinct[0].to_string()),
        _ => Some(format!("any({})", distinct.join(", "))),
    }
}

#[cfg(test)]
mod tests;