OpenParable
Skip to content
← Back to skills

Analyze Rust Ffi Crate Surface

Development
analyze-rust-ffi-crate-surface

Analyze Rust Ffi Crate Surface is an Agent Skill for development published in the RediSearch/RediSearch repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Determine which parts of the C codebase use Rust-defined C symbols. Use this when you want to understand which C code files may be impacted by changes to a Rust FFI crate.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/RediSearch/RediSearch/blob/HEAD/.skills/analyze-rust-ffi-crate-surface/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/analyze-rust-ffi-crate-surface, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Analyze Rust FFI Crate Surface

Compile a list of all C-visible symbols defined in a given Rust FFI crate or file (e.g. an extern "C" fn annotated with #[unsafe(no_mangle)] or a type definition). Then determine which parts of the C codebase use these symbols.

Arguments

  • <path>: Path to the Rust crate or file.
  • <path 1> <path 2>: Multiple Rust crates/files.

If the path doesn't start with src/, assume it to be in the src/redisearch_rs/c_entrypoint directory. E.g. numeric_range_tree_ffi becomes src/redisearch_rs/numeric_range_tree_ffi. If the path points to a directory, review the documentation of all Rust files in that directory.

Instructions

  • Read the relevant Rust source files.
  • Compile a list of all the FFI symbols defined they expose (e.g. extern "C" fn annotated with #[unsafe(no_mangle)] or type definitions). You can use the corresponding auto-generated header file in src/redisearch_rs/headers, if it helps.
  • For each symbol, determine which modules in the C codebase use it:
    • For functions, look for calls to the function in the C codebase.
    • For types, check out if they are used as function arguments, field types, or in type casts.

Emit a report that lists, for each symbol, the following information:

  • The symbol name.
  • The module(s) in the C codebase that use it.
  • The type(s) of the symbol (function, type, etc.).
  • If it's only used in C/C++ unit tests (i.e. under `tests/)

Auto-generated header files

Each *_ffi Rust crate has a corresponding auto-generated header file in src/redisearch_rs/headers, generated from rustdoc by the cheadergen CLI (configured in src/redisearch_rs/cheadergen.toml, invoked from src/redisearch_rs/CMakeLists.txt). The auto-generated header file includes all the FFI symbols defined by the Rust crate, no matter the sub-module they are defined in.