polyplug_abi 0.1.1

ABI type definitions for the polyplug plugin runtime
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

use crate::types::StringView;

/// Context passed to every guest `polyplug_init()` function.
///
/// # OWNERSHIP
/// The `bundle_path` pointer is runtime-owned and valid for the lifetime of the `PluginRuntime`.
/// **Plugin must not store the raw pointer** — copy the string value if persistence is needed.
#[repr(C)]
#[derive(Debug, Clone, Copy)]
pub struct BundleInitContext {
    /// Bundle ID for dependency enforcement during init.
    pub bundle_id: u64,
    /// Absolute canonical path to the directory containing the loaded bundle.
    pub bundle_path: StringView,
}

#[cfg(test)]
mod tests {
    use core::ffi::c_void;
    use core::mem::{align_of, offset_of, size_of};

    use crate::plugin::plugin_context::BundleInitContext;

    #[test]
    #[cfg(target_pointer_width = "64")]
    fn bundle_init_context_layout() {
        // BundleInitContext: u64 (8) + StringView (16) = 24 bytes
        assert_eq!(size_of::<BundleInitContext>(), 24);
        assert_eq!(align_of::<BundleInitContext>(), 8);
        assert_eq!(offset_of!(BundleInitContext, bundle_id), 0);
        assert_eq!(offset_of!(BundleInitContext, bundle_path), 8);
    }

    /// TH-07: Verify BundleInitContext has no bare c_void pointers in public fields.
    /// This is a compile-time verification test.
    #[test]
    fn bundle_init_context_no_bare_c_void() {
        // BundleInitContext has two public fields:
        // - bundle_id: u64 (integer, not c_void)
        // - bundle_path: StringView (typed struct, not c_void)
        //
        // This test verifies the types are NOT c_void by checking their sizes.
        // u64 is 8 bytes, StringView is 16 bytes.
        // If either field were *mut c_void, it would be 8 bytes.
        assert_eq!(size_of::<u64>(), 8);
        assert_eq!(size_of::<crate::types::StringView>(), 16);

        // Verify BundleInitContext is 24 bytes (8 + 16), not 16 bytes (8 + 8)
        // which would indicate bare c_void pointers.
        assert_eq!(size_of::<BundleInitContext>(), 24);

        // Additional compile-time check: c_void is an empty enum,
        // and BundleInitContext fields use concrete types.
        // This assertion verifies c_void exists in scope (for import check)
        // but is NOT used in BundleInitContext public fields.
        let _ = size_of::<c_void>(); // c_void is 0-sized (empty enum)
    }
}