Naming Conventions in FFI

In this lesson, you will learn how to bypass Rust's name mangling to ensure your functions remain discoverable by foreign C-compatible linkers.

The Problem: Rust's Identity Crisis

By default, the Rust compiler transforms your function names into complex, unique symbols containing metadata like crate versions and generic parameters. This process, known as name mangling, is essential for Rust’s type system, but it is an absolute nightmare for C-based tools. When you attempt to call a Rust function from C, the linker will look for a symbol like my_function, but Rust has exported something that looks like _ZN7my_crate10my_function17h8923a...E.

Controlling Symbols with Attributes

To ensure compatibility, we must force the compiler to treat our functions as C-compatible symbols. We achieve this using two specific attributes: #[no_mangle] and extern "C".

#[no_mangle]
pub extern "C" fn calculate_checksum(data: *const u8, len: usize) -> u32 {
    // Logic here
    0 
}

Why Both Are Required

1. extern "C": This specifies the Application Binary Interface (ABI). It tells the compiler to use the C calling convention (how arguments are passed in registers or on the stack) rather than the Rust-internal ABI, which may change between compiler versions.
2. #[no_mangle]: This instructs the compiler to disable the transformation of your function name. It forces the symbol in the resulting object file to match your source code string exactly (e.g., calculate_checksum).

Best Practices for Stability

When exposing APIs for FFI, treat your mangling-exempt functions as a stable interface. Because #[no_mangle] creates global symbols in the final binary, two functions with the same name across different modules will trigger a linker error. Always use clear, descriptive prefixes—such as the library name—to avoid namespace collisions in the global symbol table of your shared library.

Key Takeaway: Use #[no_mangle] in combination with extern "C" to disable Rust’s internal identifier transformation and guarantee your symbols match the expected external C linkage.