revive/crates/llvm-builder/src/utils.rs

//! The LLVM builder utilities.

use std::fs::File;
use std::path::Path;
use std::path::PathBuf;
use std::process::Command;
use std::process::Stdio;
use std::time::Duration;

use anyhow::Context;
use path_slash::PathBufExt;

/// The LLVM host repository URL.
pub const LLVM_HOST_SOURCE_URL: &str = "https://github.com/llvm/llvm-project";

/// The LLVM host repository tag.
pub const LLVM_HOST_SOURCE_TAG: &str = "llvmorg-18.1.8";

/// The minimum required XCode version.
pub const XCODE_MIN_VERSION: u32 = 11;

/// The XCode version 15.
pub const XCODE_VERSION_15: u32 = 15;

/// The number of download retries if failed.
pub const DOWNLOAD_RETRIES: u16 = 16;

/// The number of parallel download requests.
pub const DOWNLOAD_PARALLEL_REQUESTS: u16 = 1;

/// The download timeout in seconds.
pub const DOWNLOAD_TIMEOUT_SECONDS: u64 = 300;

/// The musl snapshots URL.
pub const MUSL_SNAPSHOTS_URL: &str = "https://git.musl-libc.org/cgit/musl/snapshot";

/// The emscripten SDK git URL.
pub const EMSDK_SOURCE_URL: &str = "https://github.com/emscripten-core/emsdk.git";

/// The emscripten SDK version.
pub const EMSDK_VERSION: &str = "4.0.9";

/// The subprocess runner.
///
/// Checks the status and prints `stderr`.
pub fn command(command: &mut Command, description: &str) -> anyhow::Result<()> {
    log::debug!("executing '{command:?}' ({description})");

    if std::env::var("DRY_RUN").is_ok() {
        log::warn!("Only a dry run; not executing the command.");
        return Ok(());
    }

    let status = command
        .status()
        .map_err(|error| anyhow::anyhow!("{} process: {}", description, error))?;

    if !status.success() {
        log::error!("the command '{command:?}' failed!");
        anyhow::bail!("{} failed", description);
    }

    Ok(())
}

/// Download a file from the URL to the path.
pub fn download(url: &str, path: &str) -> anyhow::Result<()> {
    log::trace!("downloading '{url}' into '{path}'");

    let mut downloader = downloader::Downloader::builder()
        .download_folder(Path::new(path))
        .parallel_requests(DOWNLOAD_PARALLEL_REQUESTS)
        .retries(DOWNLOAD_RETRIES)
        .timeout(Duration::from_secs(DOWNLOAD_TIMEOUT_SECONDS))
        .build()?;
    while let Err(error) = downloader.download(&[downloader::Download::new(url)]) {
        log::error!("MUSL download from `{url}` failed: {error}");
    }
    Ok(())
}

/// Unpack a tarball.
pub fn unpack_tar(filename: PathBuf, path: &str) -> anyhow::Result<()> {
    let tar_gz = File::open(filename)?;
    let tar = flate2::read::GzDecoder::new(tar_gz);
    let mut archive = tar::Archive::new(tar);
    archive.unpack(path)?;
    Ok(())
}

/// The `musl` downloading sequence.
pub fn download_musl(name: &str) -> anyhow::Result<()> {
    log::info!("downloading musl {name}");
    let tar_file_name = format!("{name}.tar.gz");
    let url = format!("{MUSL_SNAPSHOTS_URL}/{tar_file_name}");
    let target_path = crate::llvm_path::DIRECTORY_LLVM_TARGET
        .get()
        .unwrap()
        .to_string_lossy();
    download(url.as_str(), &target_path)?;
    let musl_tarball = crate::LLVMPath::musl_source(tar_file_name.as_str())?;
    unpack_tar(musl_tarball, &target_path)?;
    Ok(())
}

/// Call ninja to build the LLVM.
pub fn ninja(build_dir: &Path) -> anyhow::Result<()> {
    let mut ninja = Command::new("ninja");
    ninja.args(["-C", build_dir.to_string_lossy().as_ref()]);
    if std::env::var("DRY_RUN").is_ok() {
        ninja.arg("-n");
    }
    command(ninja.arg("install"), "Running ninja install")?;
    Ok(())
}

/// Create an absolute path, appending it to the current working directory.
pub fn absolute_path<P: AsRef<Path>>(path: P) -> anyhow::Result<PathBuf> {
    let mut full_path = std::env::current_dir()?;
    full_path.push(path);
    Ok(full_path)
}

///
/// Converts a Windows path into a Unix path.
///
pub fn path_windows_to_unix<P: AsRef<Path> + PathBufExt>(path: P) -> anyhow::Result<PathBuf> {
    path.to_slash()
        .map(|pathbuf| PathBuf::from(pathbuf.to_string()))
        .ok_or_else(|| anyhow::anyhow!("Windows-to-Unix path conversion error"))
}

/// Checks if the tool exists in the system.
pub fn check_presence(name: &str) -> anyhow::Result<()> {
    which::which(name).with_context(|| format!("Tool `{name}` is missing. Please install"))?;
    Ok(())
}

/// Identify XCode version using `pkgutil`.
pub fn get_xcode_version() -> anyhow::Result<u32> {
    let pkgutil = Command::new("pkgutil")
        .args(["--pkg-info", "com.apple.pkg.CLTools_Executables"])
        .stdout(Stdio::piped())
        .spawn()
        .map_err(|error| anyhow::anyhow!("`pkgutil` process: {}", error))?;
    let grep_version = Command::new("grep")
        .arg("version")
        .stdin(Stdio::from(pkgutil.stdout.expect(
            "Failed to identify XCode version - XCode or CLI tools are not installed",
        )))
        .output()
        .map_err(|error| anyhow::anyhow!("`grep` process: {}", error))?;
    let version_string = String::from_utf8(grep_version.stdout)?;
    let version_regex = regex::Regex::new(r"version: (\d+)\..*")?;
    let captures = version_regex
        .captures(version_string.as_str())
        .ok_or(anyhow::anyhow!(
            "Failed to parse XCode version: {version_string}"
        ))?;
    let xcode_version: u32 = captures
        .get(1)
        .expect("Always has a major version")
        .as_str()
        .parse()
        .map_err(|error| anyhow::anyhow!("Failed to parse XCode version: {error}"))?;
    Ok(xcode_version)
}

/// Install the Emscripten SDK.
pub fn install_emsdk() -> anyhow::Result<()> {
    log::info!("installing emsdk v{EMSDK_VERSION}");

    let emsdk_source_path = PathBuf::from(crate::LLVMPath::DIRECTORY_EMSDK_SOURCE);

    if emsdk_source_path.exists() {
        log::warn!(
            "emsdk source path {emsdk_source_path:?} already exists.
            Skipping the emsdk installation, delete the source path for re-installation"
        );
        return Ok(());
    }

    crate::utils::command(
        Command::new("git")
            .arg("clone")
            .arg(crate::utils::EMSDK_SOURCE_URL)
            .arg(emsdk_source_path.to_string_lossy().as_ref()),
        "Emscripten SDK repository cloning",
    )?;

    crate::utils::command(
        Command::new("git")
            .arg("checkout")
            .arg(format!("tags/{}", crate::utils::EMSDK_VERSION))
            .current_dir(&emsdk_source_path),
        "Emscripten SDK repository version checkout",
    )?;

    crate::utils::command(
        Command::new("./emsdk")
            .arg("install")
            .arg(EMSDK_VERSION)
            .current_dir(&emsdk_source_path),
        "Emscripten SDK installation",
    )?;

    crate::utils::command(
        Command::new("./emsdk")
            .arg("activate")
            .arg(EMSDK_VERSION)
            .current_dir(&emsdk_source_path),
        "Emscripten SDK activation",
    )?;

    log::warn!(
        "run 'source {}emsdk_env.sh' to finish the emsdk installation",
        emsdk_source_path.display()
    );

    Ok(())
}

/// The LLVM target directory default path.
pub fn directory_target_llvm(target_env: crate::target_env::TargetEnv) -> PathBuf {
    crate::llvm_path::DIRECTORY_LLVM_TARGET
        .get_or_init(|| PathBuf::from(format!("./target-llvm/{target_env}/")))
        .clone()
}