Function perform_with_valgrind

crates/exec-harness/src/analysis/mod.rs:44–76

Executes the given benchmark commands using a preload based trick to handle valgrind control. This function is only supported on Unix-like platforms, as it relies on the `LD_PRELOAD` environment variable and Unix file permissions for shared libraries. It will not work on non-Unix platforms or with statically linked binaries.

(commands: Vec<BenchmarkCommand>)

/// `LD_PRELOAD` environment variable and Unix file permissions for shared libraries.
/// It will not work on non-Unix platforms or with statically linked binaries.
pub fn perform_with_valgrind(commands: Vec<BenchmarkCommand>) -> Result<()> {
    let preload_lib_path = preload_lib_file::get_preload_lib_path()?;

    for benchmark_cmd in commands {
        // Check if the executable will honor LD_PRELOAD before running
        ld_preload_check::check_ld_preload_compatible(&benchmark_cmd.command[0])?;

        let name_and_uri = uri::generate_name_and_uri(&benchmark_cmd.name, &benchmark_cmd.command);
        name_and_uri.print_executing();

        let mut cmd = Command::new(&benchmark_cmd.command[0]);
        cmd.args(&benchmark_cmd.command[1..]);
        // Use LD_PRELOAD to inject instrumentation into the child process
        cmd.env("LD_PRELOAD", preload_lib_path);
        // Make sure python processes output perf maps. This is usually done by `pytest-codspeed`
        cmd.env("PYTHONPERFSUPPORT", "1");
        cmd.env(constants::URI_ENV, &name_and_uri.uri);

        crate::node::set_node_options(&mut cmd);

        let mut child = cmd.spawn().context("Failed to spawn command")?;

        let status = child.wait().context("Failed to execute command")?;

        bail_if_command_spawned_subprocesses_under_valgrind(child.id())?;

        if !status.success() {
            bail!("Command exited with non-zero status: {status}");
        }
    }

    Ok(())
}

/// Checks if the benchmark process spawned subprocesses under valgrind by looking for <pid>.out
/// files in the profile folder.