Crate crabgrind 

crabgrind

Valgrind Client Request interface for Rust

Summary

crabgrind is a small library that enables Rust programs to tap into Valgrind’s tools and environment.

It exposes full set of Valgrind’s client requests in Rust, manages the structure, type conversions and enforces static typing where possible.

Usage

Minimum Supported Rust Version: 1.71

First, add crabgrind as a dependency in Cargo.toml

[dependencies]
crabgrind = "0.4"

or

cargo add crabgrind

Note: This crate is no_std + alloc with alloc feature, no_std otherwise

Build Configuration

The crate needs access to a local Valgrind installation(or at least its headers) in order to read C macro definitions, constants, and supported requests.

The build script (build.rs) attempts to locate headers in this order:

1. Environment Variable: If VALGRIND_INCLUDE is set, it’s value is added to the search paths.
2. pkg-config: The system is queried via pkg-config.
3. Compiler defaults: No additional include paths are provided, and the compiler’s default include paths are used.

If headers cannot be located, the crate will still compile without errors, however any request will panic at runtime.

Example

Use some of the Client Requests:

assert!(
    crabgrind::valgrind::running_mode().is_valgrind(),
    ":~$ valgrind {}", std::env::current_exe().unwrap().display()
);

crabgrind::println!("Hey, Valgrind!");

And run under Valgrind

:~$ cargo build
:~$ valgrind ./target/debug/app

Features

• valgrind (default) Enables execution of requests, C-shim compilation and bindings generation.

• alloc Enables the println! and println_stacktrace! macros. Disabled by default. The target environment must provide a global allocator.

With default-features = false, all requests turn into no-op stubs and are optimized out by the compiler. No build dependencies are pulled in.

[dependencies]
crabgrind = { version = "0.4", default-features = false }

[build-dependencies]
crabgrind = "0.4"

More Examples

• Valgrind: Deterministic regression testing(e.g. CI or unit tests)
• Callgrind: Profiling specific code blocks in isolation
• Callgrind: Clearing setup costs to isolate some operation
• Memcheck: Checking for memory leaks at runtime(e.g. CI or unit tests)
• Memcheck: Enforcing bounds in a custom allocator
• Memcheck: Checking for memory ‘definedness’ feat. MaybeUninit
• Memcheck: Convenient slice-based API
• DHAT: Tracking data volumes
• DRD: Tracking races in a custom shared memory
• DRD: Tracing memory accesses over some memory

Implementation

Valgrind’s client request mechanism is a C implementation detail, exposed strictly via C macros. Since Rust does not support C preprocessor, these macros cannot be used directly.

crabgrind wraps the foundational VALGRIND_DO_CLIENT_REQUEST_EXPR macro via FFI binding. All higher-level client requests are implemented in Rust on top of this binding.

The overhead per request, compared to using C macros directly is strictly the cost of a single function call.

The implementation itself is not tied to a particular Valgrind version. However, the Valgrind version available at compile time determines which requests are supported by the resulting binary

Runtime Behavior

Requests are bound to the Valgrind version available at compile time. If a request is not supported by that version, it compiles successfully but panics when executed, regardless of which Valgrind version is used at runtime.

If your application is running without Valgrind, these requests execute as harmless machine code. They will not panic or segfault, and overhead is probably undetectable except in a tight loops.

License

crabgrind is distributed under MIT license.

Valgrind itself is a GPL3, however valgrind/*.h headers are distributed under a BSD-style license, so we can use them without worrying about license conflicts.

Modules

cachegrind

Cachegrind Client Requests

callgrind

Callgrind Client Requests

dhat

DHAT Client Requests

drd

DRD Client Requests

helgrind

Helgrind Client Requests

memcheck

Memcheck Client Requests

valgrind

Valgrind Client Requests

Macros

print_stacktracealloc

Printing of formatted text to the Valgrind output channel with a stack trace

printlnalloc

Printing of formatted text to the Valgrind output channel

Structs

ScopeGuard

Generic scoped RAII guard for client requests

Constants

VALGRIND_AVAILABLE

Whether Valgrind headers were available at compile time

VALGRIND_VERSION

Valgrind version this crate was compiled against.

Functions

vg_print

Printing to the Valgrind output channel

vg_print_stacktrace

Printing to the Valgrind output channel with a stack trace attached