use std::{
fs,
path::{Path, PathBuf},
};
use ostool::build::config::Cargo;
use serde::{Deserialize, Serialize};
use crate::{
arceos::build::ArceosBuildInfo,
axvisor::board,
context::{ResolvedAxvisorRequest, arch_for_target_checked},
};
pub type AxvisorBuildInfo = crate::arceos::build::ArceosBuildInfo;
pub use crate::arceos::build::LogLevel;
pub const AXVISOR_PACKAGE: &str = "axvisor";
#[derive(Debug, Clone, Deserialize, Serialize, PartialEq, Default)]
pub struct AxvisorBoardConfig {
#[serde(flatten, default)]
pub(crate) arceos: ArceosBuildInfo,
#[serde(default)]
pub vm_configs: Vec<PathBuf>,
}
#[derive(Debug, Clone, PartialEq)]
struct LoadedAxvisorBuildConfig {
build_info: AxvisorBuildInfo,
target: String,
}
#[derive(Debug, Clone, Deserialize, PartialEq)]
pub(crate) struct AxvisorBoardFile {
pub(crate) target: String,
#[serde(flatten)]
pub(crate) config: AxvisorBoardConfig,
}
impl AxvisorBoardFile {
pub(crate) fn into_board_config(self) -> AxvisorBoardConfig {
self.config
}
fn into_loaded(self) -> LoadedAxvisorBuildConfig {
let Self { target, config } = self;
config.into_loaded(target)
}
}
impl AxvisorBuildInfo {
pub fn default_axvisor_for_target(target: &str) -> Self {
let mut build_info = Self::default_for_target(target);
build_info.features.clear();
build_info
}
}
impl AxvisorBoardConfig {
fn into_loaded(self, target: String) -> LoadedAxvisorBuildConfig {
LoadedAxvisorBuildConfig {
build_info: self.arceos,
target,
}
}
}
pub(crate) fn load_board_file(path: &Path) -> anyhow::Result<AxvisorBoardFile> {
let content = fs::read_to_string(path).map_err(|e| {
anyhow!(
"failed to read Axvisor board config {}: {e}",
path.display()
)
})?;
toml::from_str(&content).map_err(|e| {
anyhow!(
"failed to parse Axvisor board config {}: {e}",
path.display()
)
})
}
pub(crate) fn resolve_build_info_path(
axvisor_dir: &Path,
target: &str,
explicit_path: Option<PathBuf>,
) -> anyhow::Result<PathBuf> {
if let Some(path) = explicit_path {
return Ok(path);
}
let _ = arch_for_target_checked(target)?;
Ok(crate::arceos::build::resolve_build_info_path_in_dir(
axvisor_dir,
target,
))
}
pub(crate) fn load_cargo_config(request: &ResolvedAxvisorRequest) -> anyhow::Result<Cargo> {
to_cargo_config(load_build_config(request)?, request)
}
fn to_cargo_config(
mut config: LoadedAxvisorBuildConfig,
request: &ResolvedAxvisorRequest,
) -> anyhow::Result<Cargo> {
config.target = request.target.clone();
let mut cargo = config.build_info.into_prepared_base_cargo_config(
&request.package,
&config.target,
request.plat_dyn,
)?;
patch_axvisor_cargo_config(&mut cargo, request)?;
Ok(cargo)
}
fn patch_axvisor_cargo_config(
cargo: &mut Cargo,
request: &ResolvedAxvisorRequest,
) -> anyhow::Result<()> {
cargo.package = request.package.clone();
cargo.target = request.target.clone();
ensure_axvisor_bin_arg(&mut cargo.args);
cargo
.env
.insert("AX_ARCH".to_string(), request.arch.clone());
cargo
.env
.insert("AX_TARGET".to_string(), request.target.clone());
if !request.vmconfigs.is_empty() {
let joined = std::env::join_paths(&request.vmconfigs)
.map_err(|e| anyhow!("failed to join vmconfig paths: {e}"))?;
cargo.env.insert(
"AXVISOR_VM_CONFIGS".to_string(),
joined.to_string_lossy().into_owned(),
);
}
normalize_axvisor_platform_features(&mut cargo.features);
cargo.features.sort();
cargo.features.dedup();
Ok(())
}
fn ensure_axvisor_bin_arg(args: &mut Vec<String>) {
if args.iter().any(|arg| arg == "--bin") {
return;
}
args.push("--bin".to_string());
args.push(AXVISOR_PACKAGE.to_string());
}
fn normalize_axvisor_platform_features(features: &mut Vec<String>) {
let has_axstd_defplat = features.iter().any(|feature| feature == "ax-std/defplat");
let has_axstd_myplat = features.iter().any(|feature| feature == "ax-std/myplat");
if has_axstd_defplat && !has_axstd_myplat {
for feature in features.iter_mut() {
if feature == "ax-std/defplat" {
*feature = "ax-std/myplat".to_string();
}
}
} else {
features.retain(|feature| feature != "ax-std/defplat");
}
}
pub(crate) fn load_target_from_build_config(path: &Path) -> anyhow::Result<Option<String>> {
let content = fs::read_to_string(path).map_err(|e| {
anyhow!(
"failed to read Axvisor build config {}: {e}",
path.display()
)
})?;
if let Ok(board_file) = toml::from_str::<AxvisorBoardFile>(&content) {
return Ok(Some(board_file.target));
}
if toml::from_str::<AxvisorBuildInfo>(&content).is_ok() {
return Ok(None);
}
Err(anyhow!("invalid Axvisor build config {}", path.display()))
}
fn load_build_config(request: &ResolvedAxvisorRequest) -> anyhow::Result<LoadedAxvisorBuildConfig> {
println!("Using build config: {}", request.build_info_path.display());
if !request.build_info_path.exists() {
if let Some(parent) = request.build_info_path.parent() {
fs::create_dir_all(parent)?;
}
if let Some(default_board) =
board::default_board_for_target(&request.axvisor_dir, &request.target)?
{
fs::copy(&default_board.path, &request.build_info_path).map_err(|e| {
anyhow!(
"failed to copy default board config {} to {}: {e}",
default_board.path.display(),
request.build_info_path.display()
)
})?;
return Ok(default_board
.config
.into_loaded(default_board.target.clone()));
}
let default_build_info = AxvisorBuildInfo::default_axvisor_for_target(&request.target);
fs::write(
&request.build_info_path,
toml::to_string_pretty(&default_build_info)?,
)?;
return Ok(LoadedAxvisorBuildConfig {
build_info: default_build_info,
target: request.target.clone(),
});
}
let content = fs::read_to_string(&request.build_info_path).map_err(|e| {
anyhow!(
"failed to read Axvisor build config {}: {e}",
request.build_info_path.display()
)
})?;
if let Ok(board_config) = toml::from_str::<AxvisorBoardFile>(&content) {
return Ok(board_config.into_loaded());
}
if request.build_info_path.exists() {
return toml::from_str::<AxvisorBuildInfo>(&content)
.map(|build_info| LoadedAxvisorBuildConfig {
build_info,
target: request.target.clone(),
})
.map_err(|e| {
anyhow!(
"failed to parse build info {}: {e}",
request.build_info_path.display()
)
});
}
Err(anyhow!(
"failed to parse build info {}",
request.build_info_path.display()
))
}
#[cfg(test)]
mod tests {
use std::{fs, path::Path};
use tempfile::tempdir;
use super::*;
fn write_board(axvisor_dir: &Path, name: &str, body: &str) -> PathBuf {
let path = axvisor_dir
.join("configs/board")
.join(format!("{name}.toml"));
fs::create_dir_all(path.parent().unwrap()).unwrap();
fs::write(&path, body).unwrap();
path
}
fn request(path: PathBuf, arch: &str, target: &str) -> ResolvedAxvisorRequest {
ResolvedAxvisorRequest {
package: AXVISOR_PACKAGE.to_string(),
axvisor_dir: path
.parent()
.map(Path::to_path_buf)
.unwrap_or_else(|| PathBuf::from("os/axvisor")),
arch: arch.to_string(),
target: target.to_string(),
plat_dyn: None,
debug: false,
build_info_path: path,
qemu_config: None,
uboot_config: None,
vmconfigs: vec![],
}
}
#[test]
fn resolve_build_info_path_uses_default_axvisor_location() {
let root = tempdir().unwrap();
let path = resolve_build_info_path(
&root.path().join("os/axvisor"),
"aarch64-unknown-none-softfloat",
None,
)
.unwrap();
assert_eq!(
path,
root.path()
.join("os/axvisor/.build-aarch64-unknown-none-softfloat.toml")
);
}
#[test]
fn resolve_build_info_path_prefers_explicit_path() {
let root = tempdir().unwrap();
let explicit = root.path().join("custom/build.toml");
let path = resolve_build_info_path(
&root.path().join("os/axvisor"),
"x86_64-unknown-none",
Some(explicit.clone()),
)
.unwrap();
assert_eq!(path, explicit);
}
#[test]
fn resolve_build_info_path_prefers_existing_bare_name() {
let root = tempdir().unwrap();
let axvisor_dir = root.path().join("os/axvisor");
fs::create_dir_all(&axvisor_dir).unwrap();
let bare = axvisor_dir.join("build-aarch64-unknown-none-softfloat.toml");
let dotted = axvisor_dir.join(".build-aarch64-unknown-none-softfloat.toml");
fs::write(&bare, "").unwrap();
fs::write(&dotted, "").unwrap();
let path =
resolve_build_info_path(&axvisor_dir, "aarch64-unknown-none-softfloat", None).unwrap();
assert_eq!(path, bare);
}
#[test]
fn load_cargo_config_writes_default_template_when_missing() {
let root = tempdir().unwrap();
let path = root
.path()
.join("os/axvisor/.build-aarch64-unknown-none-softfloat.toml");
fs::create_dir_all(path.parent().unwrap()).unwrap();
write_board(
path.parent().unwrap(),
"qemu-aarch64",
r#"
env = { AX_IP = "10.0.2.15", AX_GW = "10.0.2.2" }
target = "aarch64-unknown-none-softfloat"
features = ["ept-level-4", "ax-std/bus-mmio"]
log = "Info"
plat_dyn = true
vm_configs = []
"#,
);
let cargo = load_cargo_config(&request(
path.clone(),
"aarch64",
"aarch64-unknown-none-softfloat",
))
.unwrap();
assert!(cargo.features.contains(&"ept-level-4".to_string()));
assert!(cargo.features.contains(&"ax-std/bus-mmio".to_string()));
assert!(path.exists());
}
#[test]
fn load_cargo_config_injects_vmconfigs() {
let root = tempdir().unwrap();
let config_path = root.path().join(".build.toml");
let vmconfigs = vec![root.path().join("a.toml"), root.path().join("b.toml")];
fs::write(
&config_path,
r#"
env = {}
features = ["fs", "ept-level-4"]
log = "Info"
plat_dyn = true
"#,
)
.unwrap();
let cargo = load_cargo_config(&ResolvedAxvisorRequest {
package: AXVISOR_PACKAGE.to_string(),
axvisor_dir: root.path().join("os/axvisor"),
arch: "aarch64".to_string(),
target: "aarch64-unknown-none-softfloat".to_string(),
plat_dyn: Some(true),
debug: false,
build_info_path: config_path,
qemu_config: None,
uboot_config: None,
vmconfigs: vmconfigs.clone(),
})
.unwrap();
assert_eq!(cargo.package, AXVISOR_PACKAGE);
assert_eq!(cargo.target, "aarch64-unknown-none-softfloat");
assert_eq!(
cargo.env.get("AX_ARCH").map(String::as_str),
Some("aarch64")
);
assert_eq!(
cargo.env.get("AX_TARGET").map(String::as_str),
Some("aarch64-unknown-none-softfloat")
);
assert_eq!(
cargo.env.get("AXVISOR_VM_CONFIGS").map(String::as_str),
Some(
std::env::join_paths(&vmconfigs)
.unwrap()
.to_string_lossy()
.as_ref()
)
);
assert_eq!(
cargo
.args
.windows(2)
.find_map(|window| (window[0] == "--bin").then_some(window[1].as_str())),
Some("axvisor")
);
}
#[test]
fn load_target_from_board_config_reads_target() {
let root = tempdir().unwrap();
let path = root.path().join("qemu-aarch64.toml");
fs::write(
&path,
r#"
env = { AX_IP = "10.0.2.15", AX_GW = "10.0.2.2" }
features = []
log = "Info"
target = "aarch64-unknown-none-softfloat"
vm_configs = []
"#,
)
.unwrap();
assert_eq!(
load_target_from_build_config(&path).unwrap(),
Some("aarch64-unknown-none-softfloat".to_string())
);
}
#[test]
fn load_cargo_config_uses_board_defaults_when_default_file_is_missing() {
let root = tempdir().unwrap();
let path = root
.path()
.join("os/axvisor/.build-x86_64-unknown-none.toml");
fs::create_dir_all(path.parent().unwrap()).unwrap();
let board_path = write_board(
path.parent().unwrap(),
"qemu-x86_64",
r#"
env = { AX_IP = "10.0.2.15", AX_GW = "10.0.2.2" }
target = "x86_64-unknown-none"
features = ["ept-level-4", "fs"]
log = "Info"
vm_configs = []
"#,
);
let cargo = load_cargo_config(&ResolvedAxvisorRequest {
package: AXVISOR_PACKAGE.to_string(),
axvisor_dir: root.path().join("os/axvisor"),
arch: "x86_64".to_string(),
target: "x86_64-unknown-none".to_string(),
plat_dyn: None,
debug: false,
build_info_path: path.clone(),
qemu_config: None,
uboot_config: None,
vmconfigs: vec![],
})
.unwrap();
assert!(path.exists());
assert_eq!(
fs::read_to_string(&path).unwrap(),
fs::read_to_string(board_path).unwrap()
);
assert!(cargo.features.contains(&"ept-level-4".to_string()));
assert!(cargo.features.contains(&"fs".to_string()));
assert!(!cargo.features.contains(&"ax-std/plat-dyn".to_string()));
assert!(!cargo.features.contains(&"ax-std/defplat".to_string()));
assert!(cargo.features.contains(&"ax-std/myplat".to_string()));
}
#[test]
fn load_cargo_config_replaces_axstd_defplat_with_myplat() {
let root = tempdir().unwrap();
let config_path = root.path().join(".build.toml");
fs::write(
&config_path,
r#"
env = {}
features = ["ax-std", "ax-std/defplat", "ept-level-4"]
log = "Info"
plat_dyn = false
"#,
)
.unwrap();
let cargo = load_cargo_config(&ResolvedAxvisorRequest {
package: AXVISOR_PACKAGE.to_string(),
axvisor_dir: root.path().join("os/axvisor"),
arch: "aarch64".to_string(),
target: "aarch64-unknown-none-softfloat".to_string(),
plat_dyn: Some(false),
debug: false,
build_info_path: config_path,
qemu_config: None,
uboot_config: None,
vmconfigs: vec![],
})
.unwrap();
assert!(!cargo.features.contains(&"ax-std/defplat".to_string()));
assert!(cargo.features.contains(&"ax-std/myplat".to_string()));
}
}