padlock-cli 0.10.0

// padlock-cli/src/commands/fix.rs
//
// Applies optimal field reordering to source files in-place.

use std::path::{Path, PathBuf};

use padlock_core::findings::{Finding, Report};
use padlock_source::{SourceLanguage, fixgen};

use crate::paths::walk_source_files;

pub fn run(
    paths: &[PathBuf],
    dry_run: bool,
    backup: bool,
    filter: Option<&str>,
) -> anyhow::Result<()> {
    let re = filter
        .map(|p| {
            regex::Regex::new(p).map_err(|_| anyhow::anyhow!("invalid --filter pattern: {p:?}"))
        })
        .transpose()?;

    let source_files = expand_to_source_files(paths)?;

    let mut any_fixable = false;
    for file in &source_files {
        match fix_file(file, dry_run, backup, re.as_ref()) {
            Ok(had_changes) => any_fixable |= had_changes,
            Err(e) => eprintln!("padlock: warning: {}: {e}", file.display()),
        }
    }

    // In --dry-run mode exit 1 when there are pending changes, matching the
    // convention of `git diff --exit-code` and `cargo fmt --check`.
    if dry_run && any_fixable {
        std::process::exit(1);
    }

    Ok(())
}

/// Returns `Ok(true)` when at least one struct needed reordering (whether or not
/// `dry_run` prevented the write), `Ok(false)` when everything was already optimal.
fn fix_file(
    path: &Path,
    dry_run: bool,
    backup: bool,
    re: Option<&regex::Regex>,
) -> anyhow::Result<bool> {
    let lang = padlock_source::detect_language(path).ok_or_else(|| {
        anyhow::anyhow!(
            "fix only works on source files (.c, .cpp, .rs, .go, .zig); got {}",
            path.display()
        )
    })?;

    let arch = padlock_dwarf::reader::detect_arch_from_host();
    let source = std::fs::read_to_string(path)?;
    let output = padlock_source::parse_source(path, arch)?;
    let layouts = output.layouts;
    let report = Report::from_layouts(&layouts);

    // Collect layouts that have a ReorderSuggestion and (optionally) match the filter.
    let mut layouts_to_fix: Vec<&padlock_core::ir::StructLayout> = Vec::new();
    for sr in &report.structs {
        if let Some(re) = re
            && !re.is_match(&sr.struct_name)
        {
            continue;
        }
        let has_reorder = sr
            .findings
            .iter()
            .any(|f| matches!(f, Finding::ReorderSuggestion { .. }));
        if !has_reorder {
            continue;
        }
        if let Some(layout) = layouts.iter().find(|l| l.name == sr.struct_name) {
            layouts_to_fix.push(layout);
        }
    }

    if layouts_to_fix.is_empty() {
        println!(
            "{}: nothing to fix — all structs are already optimally ordered.",
            path.display()
        );
        return Ok(false);
    }

    // Emit an ABI-compatibility warning for fixed-layout types. Reordering their
    // fields changes the binary layout and breaks serialization, FFI, and any
    // pre-compiled code that shares the struct's memory layout.
    let fixed_abi_structs: Vec<&str> = layouts_to_fix
        .iter()
        .filter(|l| !l.is_repr_rust)
        .map(|l| l.name.as_str())
        .collect();
    if !fixed_abi_structs.is_empty() {
        let names = fixed_abi_structs.join(", ");
        eprintln!(
            "padlock: warning: reordering fields in {names} will change the binary layout. \
             If this type is used across FFI, serialized to disk/network, or shared with \
             pre-compiled code, update all call sites before deploying."
        );
    }

    // Show per-struct diff.
    for layout in &layouts_to_fix {
        let old_text =
            match lang {
                SourceLanguage::C | SourceLanguage::Cpp => {
                    fixgen::find_c_struct_span(&source, &layout.name).map(|r| source[r].to_string())
                }
                SourceLanguage::Rust => fixgen::find_rust_struct_span(&source, &layout.name)
                    .map(|r| source[r].to_string()),
                SourceLanguage::Go => fixgen::find_go_struct_span(&source, &layout.name)
                    .map(|r| source[r].to_string()),
                SourceLanguage::Zig => fixgen::find_zig_struct_span(&source, &layout.name)
                    .map(|r| source[r].to_string()),
            };

        let struct_src = old_text.as_deref().unwrap_or("");
        let new_text = match lang {
            SourceLanguage::C | SourceLanguage::Cpp => {
                fixgen::generate_c_fix_from_source(layout, struct_src)
            }
            SourceLanguage::Rust => fixgen::generate_rust_fix_from_source(layout, struct_src),
            SourceLanguage::Go => fixgen::generate_go_fix_from_source(layout, struct_src),
            SourceLanguage::Zig => fixgen::generate_zig_fix_from_source(layout, struct_src),
        };

        let diff_base = old_text.as_deref().unwrap_or(&source);
        let diff = fixgen::unified_diff(diff_base, &new_text, 3);
        println!("=== {} ===", layout.name);
        println!("{diff}");
    }

    if dry_run {
        println!("(dry-run: no files written)");
        return Ok(true);
    }

    if backup {
        let bak = path.with_extension(format!(
            "{}.bak",
            path.extension().unwrap_or_default().to_string_lossy()
        ));
        std::fs::copy(path, &bak)?;
    }

    let fixed_source = match lang {
        SourceLanguage::C | SourceLanguage::Cpp => fixgen::apply_fixes_c(&source, &layouts_to_fix),
        SourceLanguage::Rust => fixgen::apply_fixes_rust(&source, &layouts_to_fix),
        SourceLanguage::Go => fixgen::apply_fixes_go(&source, &layouts_to_fix),
        SourceLanguage::Zig => fixgen::apply_fixes_zig(&source, &layouts_to_fix),
    };

    std::fs::write(path, &fixed_source)?;
    println!(
        "Rewrote {} struct(s) in {}.",
        layouts_to_fix.len(),
        path.display()
    );

    Ok(true)
}

fn expand_to_source_files(paths: &[PathBuf]) -> anyhow::Result<Vec<PathBuf>> {
    let mut files = Vec::new();
    for path in paths {
        if path.is_dir() {
            files.extend(walk_source_files(path));
        } else if padlock_source::detect_language(path).is_some() {
            files.push(path.clone());
        } else {
            anyhow::bail!(
                "fix only works on source files (.c, .cpp, .rs, .go, .zig) or \
                 directories; got {}",
                path.display()
            );
        }
    }
    Ok(files)
}