code2graph 0.0.0-beta.3

Purpose-neutral code-graph extraction: source files → symbols, references, and cross-file edges. Tree-sitter based, no storage opinion.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
// SPDX-License-Identifier: Apache-2.0

//! [`FfiBridgeResolver`] — see the [`ffi_bridge`](super) module docs for the
//! design rationale (honest cross-language linking via FFI exports).

use std::collections::HashMap;

use crate::graph::types::{
    CodeGraph, Confidence, Edge, FfiAbi, FileFacts, Provenance, RefRole, Symbol,
};
use crate::symbol::SymbolId;

use crate::resolve::Resolver;
use crate::resolve::enclosing_symbol_index;

/// A cross-language FFI export plus the ABI it is exposed under (so the resolver
/// can bridge it only to call sites in a language that consumes that ABI).
struct ExportRec {
    symbol: SymbolId,
    abi: FfiAbi,
}

/// Links cross-language call sites to deterministic FFI exports
/// ([`Provenance::FfiBridge`]).
#[derive(Debug, Default, Clone, Copy)]
pub struct FfiBridgeResolver;

impl Resolver for FfiBridgeResolver {
    fn resolve(&self, files: &[FileFacts]) -> CodeGraph {
        // export name → exports declared under it, each tagged with its language.
        let mut symbols: Vec<Symbol> = Vec::new();
        let mut exports: HashMap<&str, Vec<ExportRec>> = HashMap::new();
        for f in files {
            symbols.extend(f.symbols.iter().cloned());
            for e in &f.ffi_exports {
                exports
                    .entry(e.export_name.as_str())
                    .or_default()
                    .push(ExportRec {
                        symbol: e.symbol.clone(),
                        abi: e.abi,
                    });
            }
        }
        if exports.is_empty() {
            return CodeGraph {
                symbols,
                edges: Vec::new(),
            };
        }

        // Per-file symbol index for caller attribution (span containment).
        let mut by_file: HashMap<&str, Vec<usize>> = HashMap::new();
        for (i, s) in symbols.iter().enumerate() {
            by_file.entry(s.file.as_str()).or_default().push(i);
        }

        let mut edges: Vec<Edge> = Vec::new();
        for f in files {
            let file_syms = by_file.get(f.file.as_str());
            for r in &f.references {
                // An FFI bridge is a *call* across the boundary.
                if r.role != RefRole::Call {
                    continue;
                }
                let Some(targets) = exports.get(r.name.as_str()) else {
                    continue;
                };
                // An FFI crossing: this call's language consumes the export's ABI
                // (which excludes same-language use — a definition's own language
                // is never in its ABI's consumer set).
                let cross: Vec<&ExportRec> = targets
                    .iter()
                    .filter(|e| crate::ffi::consumers(e.abi).contains(&f.lang.as_str()))
                    .collect();
                if cross.is_empty() {
                    continue;
                }
                let Some(from_idx) =
                    file_syms.and_then(|idxs| enclosing_symbol_index(&symbols, idxs, r.occ.byte))
                else {
                    continue; // call site not inside any extracted symbol
                };
                // Honest confidence: unique export → Scoped, otherwise NameOnly.
                let confidence = if cross.len() == 1 {
                    Confidence::Scoped
                } else {
                    Confidence::NameOnly
                };
                for e in cross {
                    edges.push(Edge {
                        from: symbols[from_idx].id.clone(),
                        to: e.symbol.clone(),
                        role: RefRole::Call,
                        confidence,
                        provenance: Provenance::FfiBridge,
                        occ: r.occ.clone(),
                    });
                }
            }
        }

        CodeGraph { symbols, edges }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::extract::{
        CExtractor, Extractor, JavaExtractor, JavaScriptExtractor, PythonExtractor, RustExtractor,
    };

    /// Rust `#[no_mangle]` export, called from C → one FfiBridge edge.
    #[test]
    fn bridges_rust_no_mangle_export_to_c_call() {
        let rust = RustExtractor
            .extract(
                "#[no_mangle]\npub extern \"C\" fn create_user() -> u32 { 0 }",
                "src/ffi.rs",
            )
            .unwrap();
        // Sanity: the export fact was recorded.
        assert_eq!(rust.ffi_exports.len(), 1, "expected one FFI export");
        assert_eq!(rust.ffi_exports[0].export_name, "create_user");

        let c = CExtractor
            .extract("void use_it(void) { create_user(); }", "src/app.c")
            .unwrap();

        let graph = FfiBridgeResolver.resolve(&[rust, c]);
        assert_eq!(graph.edges.len(), 1, "expected one FFI bridge edge");
        let e = &graph.edges[0];
        assert_eq!(e.provenance, Provenance::FfiBridge);
        assert_eq!(e.confidence, Confidence::Scoped);
        assert_eq!(e.role, RefRole::Call);
        assert!(
            e.from.to_scip_string().ends_with("use_it()."),
            "from was: {}",
            e.from.to_scip_string()
        );
        assert!(
            e.to.to_scip_string().ends_with("ffi/create_user()."),
            "to was: {}",
            e.to.to_scip_string()
        );
        assert_eq!(e.occ.file, "src/app.c");
    }

    /// `#[export_name = "..."]` overrides the bridged name.
    #[test]
    fn export_name_attribute_overrides_symbol_name() {
        let rust = RustExtractor
            .extract(
                "#[export_name = \"c_alloc\"]\npub extern \"C\" fn rust_alloc() -> u32 { 0 }",
                "src/ffi.rs",
            )
            .unwrap();
        assert_eq!(rust.ffi_exports[0].export_name, "c_alloc");

        // C calls the exported name, not the Rust name.
        let c = CExtractor
            .extract("void m(void) { c_alloc(); }", "src/app.c")
            .unwrap();
        let graph = FfiBridgeResolver.resolve(&[rust, c]);
        assert_eq!(graph.edges.len(), 1);
        assert!(
            graph.edges[0]
                .to
                .to_scip_string()
                .ends_with("rust_alloc().")
        );
    }

    /// A same-language call to the exported name is NOT an FFI crossing.
    #[test]
    fn same_language_call_is_not_bridged() {
        let lib = RustExtractor
            .extract(
                "#[no_mangle]\npub extern \"C\" fn create_user() -> u32 { 0 }",
                "src/ffi.rs",
            )
            .unwrap();
        let caller = RustExtractor
            .extract("pub fn run() { create_user(); }", "src/main.rs")
            .unwrap();
        let graph = FfiBridgeResolver.resolve(&[lib, caller]);
        assert!(
            graph.edges.is_empty(),
            "same-language use must not bridge, got {:?}",
            graph.edges.len()
        );
    }

    /// A plain `extern "C"` function with no stable-export attribute is not an export.
    #[test]
    fn extern_c_without_no_mangle_is_not_an_export() {
        let rust = RustExtractor
            .extract("pub extern \"C\" fn helper() -> u32 { 0 }", "src/ffi.rs")
            .unwrap();
        assert!(
            rust.ffi_exports.is_empty(),
            "extern \"C\" alone is mangled — not a stable export"
        );
    }

    /// Rust PyO3 `#[pyfunction]` export, called from Python → one FfiBridge edge.
    #[test]
    fn bridges_rust_pyfunction_export_to_python_call() {
        let rust = RustExtractor
            .extract(
                "#[pyfunction]\npub fn tokenize() -> u32 { 0 }",
                "src/ext.rs",
            )
            .unwrap();
        assert_eq!(rust.ffi_exports.len(), 1, "expected one FFI export");
        assert_eq!(rust.ffi_exports[0].abi, FfiAbi::Python);
        assert_eq!(rust.ffi_exports[0].export_name, "tokenize");

        let py = PythonExtractor
            .extract("def run():\n    tokenize()", "app.py")
            .unwrap();

        let graph = FfiBridgeResolver.resolve(&[rust, py]);
        assert_eq!(graph.edges.len(), 1, "expected one FFI bridge edge");
        let e = &graph.edges[0];
        assert_eq!(e.provenance, Provenance::FfiBridge);
        assert!(
            e.to.to_scip_string().ends_with("ext/tokenize()."),
            "to was: {}",
            e.to.to_scip_string()
        );
        assert_eq!(e.occ.file, "app.py");
    }

    /// `#[pyo3(name = "…")]` overrides the Python-side name.
    #[test]
    fn pyo3_name_attribute_overrides_export_name() {
        let rust = RustExtractor
            .extract(
                "#[pyfunction]\n#[pyo3(name = \"tok\")]\npub fn tokenize() -> u32 { 0 }",
                "src/ext.rs",
            )
            .unwrap();
        assert_eq!(rust.ffi_exports[0].export_name, "tok");

        let py = PythonExtractor
            .extract("def run():\n    tok()", "app.py")
            .unwrap();
        let graph = FfiBridgeResolver.resolve(&[rust, py]);
        assert_eq!(graph.edges.len(), 1);
        assert!(
            graph.edges[0]
                .to
                .to_scip_string()
                .ends_with("ext/tokenize().")
        );
    }

    /// Rust `#[wasm_bindgen]` export, called from JavaScript → one FfiBridge edge.
    #[test]
    fn bridges_rust_wasm_bindgen_export_to_js_call() {
        let rust = RustExtractor
            .extract("#[wasm_bindgen]\npub fn greet() -> u32 { 0 }", "src/lib.rs")
            .unwrap();
        assert_eq!(rust.ffi_exports.len(), 1, "expected one FFI export");
        assert_eq!(rust.ffi_exports[0].abi, FfiAbi::Wasm);
        assert_eq!(rust.ffi_exports[0].export_name, "greet");

        let js = JavaScriptExtractor
            .extract("function run() { greet(); }", "app.js")
            .unwrap();
        let graph = FfiBridgeResolver.resolve(&[rust, js]);
        assert_eq!(graph.edges.len(), 1, "expected one FFI bridge edge");
        let e = &graph.edges[0];
        assert_eq!(e.provenance, Provenance::FfiBridge);
        assert!(
            e.to.to_scip_string().ends_with("greet()."),
            "to was: {}",
            e.to.to_scip_string()
        );
        assert_eq!(e.occ.file, "app.js");
    }

    /// Rust `#[napi]` export, called from JavaScript → one FfiBridge edge.
    #[test]
    fn bridges_rust_napi_export_to_js_call() {
        let rust = RustExtractor
            .extract("#[napi]\npub fn compute() -> u32 { 0 }", "src/lib.rs")
            .unwrap();
        assert_eq!(rust.ffi_exports.len(), 1, "expected one FFI export");
        assert_eq!(rust.ffi_exports[0].abi, FfiAbi::NodeApi);
        assert_eq!(rust.ffi_exports[0].export_name, "compute");

        let js = JavaScriptExtractor
            .extract("function run() { compute(); }", "app.js")
            .unwrap();
        let graph = FfiBridgeResolver.resolve(&[rust, js]);
        assert_eq!(graph.edges.len(), 1, "expected one FFI bridge edge");
        assert_eq!(graph.edges[0].provenance, Provenance::FfiBridge);
        assert!(
            graph.edges[0].to.to_scip_string().ends_with("compute()."),
            "to was: {}",
            graph.edges[0].to.to_scip_string()
        );
    }

    /// JNI: a Java `native` method bridges to its Rust `Java_*` implementation
    /// via the mangled name, tagged with the JNI ABI.
    #[test]
    fn bridges_java_native_method_to_rust_jni_impl() {
        let java = JavaExtractor
            .extract(
                "package com.example;\npublic class Foo {\n    public native int compute(int x);\n}\n",
                "Foo.java",
            )
            .unwrap();
        let rust = RustExtractor
            .extract(
                "#[no_mangle]\npub extern \"C\" fn Java_com_example_Foo_compute() -> u32 { 0 }",
                "src/jni.rs",
            )
            .unwrap();
        assert_eq!(rust.ffi_exports.len(), 1, "expected one FFI export");
        assert_eq!(
            rust.ffi_exports[0].abi,
            FfiAbi::Jni,
            "Java_-prefixed export must be classified JNI, not C"
        );
        assert_eq!(
            rust.ffi_exports[0].export_name,
            "Java_com_example_Foo_compute"
        );

        let graph = FfiBridgeResolver.resolve(&[java, rust]);
        let bridges: Vec<_> = graph
            .edges
            .iter()
            .filter(|e| e.provenance == Provenance::FfiBridge)
            .collect();
        assert_eq!(bridges.len(), 1, "expected one JNI bridge edge");
        assert!(
            bridges[0]
                .to
                .to_scip_string()
                .contains("Java_com_example_Foo_compute"),
            "bridge target was {}",
            bridges[0].to.to_scip_string()
        );
    }

    /// JNI: a Java `native` method bridges to a C implementation too (the common
    /// NDK case), via the `Java_*` export the C extractor emits.
    #[test]
    fn bridges_java_native_method_to_c_jni_impl() {
        let java = JavaExtractor
            .extract(
                "package com.example;\npublic class Foo {\n    public native int compute(int x);\n}\n",
                "Foo.java",
            )
            .unwrap();
        let c = CExtractor
            .extract(
                "int Java_com_example_Foo_compute(void* env, void* obj, int x) { return x; }",
                "jni.c",
            )
            .unwrap();
        assert_eq!(c.ffi_exports.len(), 1, "C must export the Java_ function");
        assert_eq!(c.ffi_exports[0].abi, FfiAbi::Jni);

        let graph = FfiBridgeResolver.resolve(&[java, c]);
        let bridges: Vec<_> = graph
            .edges
            .iter()
            .filter(|e| e.provenance == Provenance::FfiBridge)
            .collect();
        assert_eq!(
            bridges.len(),
            1,
            "expected one JNI bridge edge to the C impl"
        );
    }

    /// ABI isolation: a C call must NOT bridge to a Python-only (PyO3) export of
    /// the same name, nor a Python call to a C-only export.
    #[test]
    fn abi_consumers_are_isolated() {
        let py_export = RustExtractor
            .extract("#[pyfunction]\npub fn shared() -> u32 { 0 }", "src/ext.rs")
            .unwrap();
        let c = CExtractor
            .extract("void run(void) { shared(); }", "app.c")
            .unwrap();
        assert!(
            FfiBridgeResolver.resolve(&[py_export, c]).edges.is_empty(),
            "C cannot consume a Python-only export"
        );

        let c_export = RustExtractor
            .extract(
                "#[no_mangle]\npub extern \"C\" fn shared() -> u32 { 0 }",
                "src/ffi.rs",
            )
            .unwrap();
        let py = PythonExtractor
            .extract("def run():\n    shared()", "app.py")
            .unwrap();
        assert!(
            FfiBridgeResolver.resolve(&[c_export, py]).edges.is_empty(),
            "Python cannot consume a C-only export"
        );
    }
}