use std::collections::HashMap;
use std::path::PathBuf;
use std::process::{Command, Stdio};
use std::time::Instant;
use bv_core::error::{BvError, Result};
use bv_runtime::{
ContainerRuntime, GpuProfile, ImageDigest, ImageMetadata, Mount, OciRef, ProgressReporter,
RunOutcome, RunSpec, RuntimeInfo,
};
use crate::cache::{file_sha256, sif_path_for_digest};
use crate::gpu::nv_args;
use crate::image::pull_as_sif;
use crate::mount::bind_args;
#[derive(Debug, Clone)]
pub struct ApptainerRuntime {
sif_dir: PathBuf,
bin: String,
}
impl ApptainerRuntime {
pub fn new(sif_dir: PathBuf) -> Self {
let bin = if Command::new("apptainer")
.arg("version")
.stdout(Stdio::null())
.stderr(Stdio::null())
.status()
.map(|s| s.success())
.unwrap_or(false)
{
"apptainer"
} else {
"singularity"
};
Self {
sif_dir,
bin: bin.to_string(),
}
}
fn sif_for_digest(&self, digest: &str) -> PathBuf {
sif_path_for_digest(&self.sif_dir, digest)
}
}
impl ContainerRuntime for ApptainerRuntime {
fn name(&self) -> &str {
"apptainer"
}
fn health_check(&self) -> Result<RuntimeInfo> {
let out = Command::new(&self.bin)
.arg("version")
.output()
.map_err(|e| BvError::RuntimeNotAvailable {
runtime: "apptainer".into(),
reason: format!("could not execute `{}`: {e}", self.bin),
})?;
if !out.status.success() {
return Err(BvError::RuntimeNotAvailable {
runtime: "apptainer".into(),
reason: String::from_utf8_lossy(&out.stderr).trim().to_string(),
});
}
let version = String::from_utf8_lossy(&out.stdout).trim().to_string();
let mut extra = HashMap::new();
extra.insert("binary".into(), self.bin.clone());
Ok(RuntimeInfo {
name: self.bin.clone(),
version,
extra,
})
}
fn pull(&self, image: &OciRef, progress: &dyn ProgressReporter) -> Result<ImageDigest> {
let reference = image.to_string();
if let Some(known) = &image.digest {
let canonical = self.sif_for_digest(known);
if canonical.exists() {
progress.finish("");
return Ok(ImageDigest(known.clone()));
}
}
std::fs::create_dir_all(&self.sif_dir)
.map_err(|e| BvError::RuntimeError(format!("failed to create SIF cache dir: {e}")))?;
let staging = self
.sif_dir
.join(format!(".pull-{}.sif", std::process::id()));
progress.update(&format!("Pulling {reference} as SIF"), None, None);
{
let _paused = progress.pause();
pull_as_sif(image, &staging, &self.bin)?;
}
let digest = file_sha256(&staging)
.map_err(|e| BvError::RuntimeError(format!("failed to hash SIF: {e}")))?;
let canonical = self.sif_for_digest(&digest);
if canonical.exists() {
let _ = std::fs::remove_file(&staging);
} else if let Err(e) = std::fs::rename(&staging, &canonical) {
std::fs::copy(&staging, &canonical).map_err(|e2| {
BvError::RuntimeError(format!(
"failed to place SIF in cache (rename: {e}; copy: {e2})"
))
})?;
let _ = std::fs::remove_file(&staging);
}
progress.finish("");
Ok(ImageDigest(digest))
}
fn run(&self, spec: &RunSpec) -> Result<RunOutcome> {
let start = Instant::now();
let reference = spec.image.to_string();
let digest = spec.image.digest.as_deref().ok_or_else(|| {
BvError::RuntimeError(format!(
"apptainer run requires a pinned digest for '{reference}'"
))
})?;
let sif = self.sif_for_digest(digest);
if !sif.exists() {
return Err(BvError::RuntimeError(format!(
"SIF not found for '{}'; run `bv sync` to pull it",
reference
)));
}
let mut cmd = Command::new(&self.bin);
cmd.arg("run");
if let Some(wd) = &spec.working_dir {
cmd.args(["--pwd", &wd.to_string_lossy()]);
}
for arg in bind_args(&spec.mounts) {
cmd.arg(arg);
}
for arg in nv_args(&spec.gpu) {
cmd.arg(arg);
}
for (k, v) in &spec.env {
cmd.arg("--env").arg(format!("{k}={v}"));
}
cmd.arg(sif.to_string_lossy().as_ref());
for arg in &spec.command {
cmd.arg(arg);
}
cmd.stdin(Stdio::inherit())
.stdout(Stdio::inherit())
.stderr(Stdio::inherit());
let status = cmd
.status()
.map_err(|e| BvError::RuntimeError(format!("apptainer run failed: {e}")))?;
Ok(RunOutcome {
exit_code: status.code().unwrap_or(-1),
duration: start.elapsed(),
})
}
fn inspect(&self, digest: &ImageDigest) -> Result<ImageMetadata> {
let sif = self.sif_for_digest(&digest.0);
let size_bytes = if sif.exists() {
std::fs::metadata(&sif).ok().map(|m| m.len())
} else {
None
};
Ok(ImageMetadata {
digest: digest.clone(),
size_bytes,
labels: HashMap::new(),
})
}
fn is_locally_available(&self, _image_ref: &str, digest: &str) -> bool {
self.sif_for_digest(digest).exists()
}
fn gpu_args(&self, profile: &GpuProfile) -> Vec<String> {
nv_args(profile)
}
fn mount_args(&self, mounts: &[Mount]) -> Vec<String> {
bind_args(mounts)
}
}
pub fn is_available() -> bool {
for bin in &["apptainer", "singularity"] {
if Command::new(bin)
.arg("version")
.stdout(Stdio::null())
.stderr(Stdio::null())
.status()
.map(|s| s.success())
.unwrap_or(false)
{
return true;
}
}
false
}