cargo-memlense

Static analysis tool for memkit — detect memory issues before runtime.

Version: 0.1.0-alpha.1

Overview

cargo-memlense analyzes your Rust source code for patterns that compile but violate memkit best practices. Catch memory issues at build time, not at runtime.

Installation

cargo install cargo-memlense

Usage

# Check current directory for memkit issues
cargo memlense check

# Check specific file
cargo memlense check src/game.rs

# Check with specific rules or categories
cargo memlense check --rules ML103,ML601
cargo memlense check --rules ML6  # All async safety checks

# Explain a diagnostic code
cargo memlense explain ML602

# List all diagnostic codes
cargo memlense list

Diagnostic Categories

ML1xx: Frame Lifecycle Errors

ML2xx: Threading & Transfer Errors

ML3xx: GPU Memory Errors

ML4xx: Performance Warnings

ML5xx: Best Practice Hints

ML6xx: Async Safety

ML7xx: Architecture & Intent

Example: ML103 (Frame Escapes)

// BAD: Frame allocation used after frame ends
let ptr = alloc.frame_alloc::<u32>();
alloc.end_frame();
*ptr = 42; // ML103: use after frame end

// GOOD: Use allocation before frame ends
let ptr = alloc.frame_alloc::<u32>();
*ptr = 42;
alloc.end_frame();

Example: ML602 (Frame Across Await)

// BAD: Frame allocation held across await
let data = alloc.frame_box(value);
some_async_fn().await; // ML602: allocation invalid here
println!("{:?}", data);

// GOOD: Use memkit-async or heap
use memkit_async::MkAsyncFrameAlloc;
let data = async_alloc.alloc::<Data>().await;
some_async_fn().await;
println!("{:?}", data); // Safe!

License

This project is licensed under the Mozilla Public License 2.0 - see the LICENSE.md file for details.