use crate::materialize::{
CachedCompilation, CachedOutput, Materialization, StagedOutputs, denormalize_output_text,
executable_mode_matches, exit_code, file_mode, find_blobs, normalize_output_text,
persist_outputs, read_canonical_blob, read_verified_blob, record_action_hit,
record_verification, replay_bytes, resolve_executable, stage_verified_cached_output,
staging_directory, validate_file_mode,
};
use crate::session;
use eyre::{Context, Result, bail};
use mbx_cache_cc::{
CcAction, CcActionContext, CcBypassReason, CcCompilerFamily, CcCompilerIdentity, CcDepfile,
CcDiscoveredInputs, CcInputPrediction, CcInvocation, CcLanguage, environment_inputs,
is_system_path, manifest_snapshot,
};
use mbx_cache_core::{
ActionPrediction, AgentRequest, AgentResponse, CacheDigest, CacheDirectory, CacheFileNode,
CcMetadata, RemoteActionResult, RestoreStats, canonical_json,
};
use mbx_cache_rustc::PathMapping;
use std::collections::{BTreeMap, BTreeSet};
use std::ffi::{OsStr, OsString};
use std::path::{Path, PathBuf};
use std::process::{Command, ExitCode, Output};
use std::time::{Instant, SystemTime};
const ADAPTER: &str = "cc";
pub fn compile(compiler: &OsStr, arguments: &[OsString], language: CcLanguage) -> Result<ExitCode> {
let invocation = CcInvocation::parse(arguments)?;
let working_dir = std::env::current_dir()?;
let environment = environment_inputs(|name| std::env::var(name).ok(), invocation.sysroot())?;
let identity = compiler_identity(compiler, language)?;
let mut context = CcActionContext {
compiler: identity,
working_dir: working_dir.clone(),
path_mappings: path_mappings(&working_dir),
environment,
inputs: Vec::new(),
};
let verify = session::verify_requested();
let invocation_digest = invocation.invocation_digest(&context)?;
let task = prediction_task(&invocation_digest);
let mut verification = None;
let usable = find_prediction(&task, &invocation_digest)?.and_then(|prediction| {
prediction
.discover(&working_dir, &context.path_mappings)
.ok()
});
let mut looked_up = false;
if let Some(discovered) = usable {
let mut candidate = context.clone();
discovered.clone().apply_to(&mut candidate)?;
let action = invocation.action(candidate)?;
looked_up = true;
let restored = match restore_result(
&action,
&invocation,
&discovered,
!verify,
&context.path_mappings,
) {
Ok(restored) => restored,
Err(error) => {
session::report_shim_warning(&format!("cc result was not restored: {error:#}"));
None
}
};
if let Some(cached) = restored {
if !verify {
replay_bytes(&cached.stdout, &cached.stderr)?;
record_action_hit(
&action.digest,
cached.restore,
&compilation_name(&invocation),
);
return Ok(ExitCode::SUCCESS);
}
verification = Some(cached);
}
} else {
session::record_unconsulted();
}
let depfile_staging = staging_directory()?;
let depfile = depfile_staging.path().join("compile.d");
let searchable = searchable_directories(&invocation, &working_dir);
let before = manifest_snapshot(&searchable).ok();
let started = Instant::now();
let compilation_started = SystemTime::now();
let mut command = Command::new(compiler);
command.args(arguments);
command.args(invocation.dependency_arguments(&depfile));
let output = command
.output()
.wrap_err_with(|| format!("failed to run {}", Path::new(compiler).display()))?;
let duration_ns = duration_ns(started.elapsed());
session::record_compiler_invocation(
if verification.is_some() {
"verification"
} else if looked_up {
"miss"
} else {
"unconsulted"
},
Some(&compilation_name(&invocation)),
duration_ns,
);
if let Some(cached) = verification {
let matched = cached_matches(&cached, &output);
record_verification(matched, cached.restore);
if !matched {
session::report_shim_warning("shadow verification diverged from cached output");
}
}
replay_bytes(&output.stdout, &output.stderr)?;
if !output.status.success() {
return Ok(exit_code(output.status));
}
if let Err(error) = publish(
&invocation,
&mut context,
&depfile,
&output,
compilation_started,
&task,
&invocation_digest,
duration_ns,
&searchable,
before,
) {
#[cfg(debug_assertions)]
session::report_shim_warning(&format!("cc result was not published: {error:#}"));
#[cfg(not(debug_assertions))]
let _ = error;
}
Ok(exit_code(output.status))
}
#[allow(clippy::too_many_arguments)]
fn publish(
invocation: &CcInvocation,
context: &mut CcActionContext,
depfile: &Path,
output: &Output,
compilation_started: SystemTime,
task: &str,
invocation_digest: &CacheDigest,
duration_ns: u64,
searchable: &BTreeSet<PathBuf>,
before: Option<BTreeMap<PathBuf, CacheDigest>>,
) -> Result<()> {
let discovered = discover(invocation, context, depfile)?;
discovered.verify_not_modified_since(compilation_started)?;
verify_search_path_unchanged(searchable, before)?;
discovered.verify()?;
discovered.apply_to(context)?;
let action = invocation.action(context.clone())?;
publish_result(&action, invocation, output, &context.path_mappings)?;
let prediction = invocation.prediction(context, duration_ns)?;
record_prediction(task, invocation_digest, &action.digest, &prediction);
Ok(())
}
fn discover(
invocation: &CcInvocation,
context: &CcActionContext,
depfile: &Path,
) -> Result<CcDiscoveredInputs> {
let dependencies = CcDepfile::read(depfile)?;
let mut files = BTreeSet::new();
for path in dependencies
.files
.into_iter()
.chain(invocation.required_inputs().iter().map(ToOwned::to_owned))
{
files.insert(absolute(&path, &context.working_dir));
}
Ok(CcDiscoveredInputs::collect(
&context.working_dir,
files.clone(),
manifest_directories(invocation, context, &files),
)?)
}
fn searchable_directories(invocation: &CcInvocation, working_dir: &Path) -> BTreeSet<PathBuf> {
invocation
.include_dirs()
.iter()
.map(|directory| absolute(directory, working_dir))
.chain(
invocation
.source()
.parent()
.map(|parent| absolute(parent, working_dir)),
)
.filter(|directory| !is_system_path(directory))
.collect()
}
fn verify_search_path_unchanged(
searchable: &BTreeSet<PathBuf>,
before: Option<BTreeMap<PathBuf, CacheDigest>>,
) -> Result<()> {
let Some(before) = before else {
return Ok(());
};
let after = manifest_snapshot(searchable)?;
for (directory, digest) in &before {
if after.get(directory) != Some(digest) {
return Err(
CcBypassReason::SearchPathModifiedDuringCompilation(directory.clone()).into(),
);
}
}
Ok(())
}
fn manifest_directories(
invocation: &CcInvocation,
context: &CcActionContext,
files: &BTreeSet<PathBuf>,
) -> BTreeSet<PathBuf> {
invocation
.include_dirs()
.iter()
.map(|directory| absolute(directory, &context.working_dir))
.chain(
files
.iter()
.filter_map(|file| file.parent().map(Path::to_path_buf)),
)
.filter(|directory| !is_system_path(directory))
.collect()
}
fn absolute(path: &Path, working_dir: &Path) -> PathBuf {
if path.is_absolute() {
path.to_path_buf()
} else {
working_dir.join(path)
}
}
fn path_mappings(working_dir: &Path) -> Vec<PathMapping> {
let mut mappings = Vec::new();
let mut add = |root: Option<PathBuf>, placeholder: &str| {
if let Some(root) = root.filter(|root| root.is_absolute())
&& !mappings
.iter()
.any(|existing: &PathMapping| existing.root == root)
{
mappings.push(PathMapping::new(root, placeholder));
}
};
add(session_path(session::TARGET_DIR_ENV), "target");
add(session_path(session::WORKSPACE_ROOT_ENV), "workspace");
add(
std::env::var_os("CARGO_HOME")
.map(PathBuf::from)
.or_else(|| dirs::home_dir().map(|home| home.join(".cargo"))),
"cargo_home",
);
add(
std::env::var_os("RUSTUP_HOME")
.map(PathBuf::from)
.or_else(|| dirs::home_dir().map(|home| home.join(".rustup"))),
"rustup_home",
);
add(dirs::home_dir(), "home");
let _ = working_dir;
mappings
}
fn session_path(name: &str) -> Option<PathBuf> {
std::env::var_os(name)
.filter(|value| !value.is_empty())
.map(PathBuf::from)
}
fn compiler_identity(compiler: &OsStr, language: CcLanguage) -> Result<CcCompilerIdentity> {
let executable = resolve_executable(compiler)?;
let probe = probe_executable(&executable, &["-v"], &executable)?;
let family = CcCompilerFamily::classify(&probe)?;
let target = probe
.lines()
.find_map(|line| line.strip_prefix("Target: "))
.unwrap_or_default()
.to_string();
let assembler = if family.uses_external_assembler() {
assembler_identity(&executable)
} else {
String::new()
};
let _ = language;
Ok(CcCompilerIdentity {
family,
version_text: probe,
target,
assembler,
})
}
fn named_assembler(printed: &str) -> Option<PathBuf> {
let trimmed = printed.trim();
Path::new(trimmed)
.is_absolute()
.then(|| PathBuf::from(trimmed))
}
fn assembler_identity(compiler: &Path) -> String {
let named = probe_executable(compiler, &["-print-prog-name=as"], &compiler.join("as"))
.unwrap_or_default();
let assembler = match named_assembler(&named) {
Some(assembler) => assembler,
None => match resolve_executable(OsStr::new("as")) {
Ok(found) => found,
Err(_) => return "unresolved".into(),
},
};
let version = probe_executable(&assembler, &["--version"], &assembler)
.ok()
.and_then(|probe| probe.lines().next().map(ToOwned::to_owned))
.unwrap_or_default();
format!("{}; {version}", assembler.display())
}
fn probe_executable(executable: &Path, arguments: &[&str], memo: &Path) -> Result<String> {
let key = memo.to_path_buf();
let environment = BTreeMap::new();
let responses = session::request_agent(&[AgentRequest::FindExecutableIdentity {
executable: key.clone(),
environment: environment.clone(),
}]);
if let Ok(responses) = responses
&& let Some(AgentResponse::ExecutableIdentity { stdout: Some(text) }) =
responses.into_iter().next()
{
return Ok(String::from_utf8_lossy(&text).into_owned());
}
let output = Command::new(executable)
.args(arguments)
.output()
.map_err(|error| CcBypassReason::CompilerIdentityUnavailable(error.to_string()))?;
if !output.status.success() {
return Err(CcBypassReason::CompilerIdentityUnavailable(format!(
"{} exited with {}",
executable.display(),
output.status
))
.into());
}
let mut text = String::from_utf8_lossy(&output.stderr).into_owned();
if text.trim().is_empty() {
text = String::from_utf8_lossy(&output.stdout).into_owned();
}
let _ = session::request_agent(&[AgentRequest::StoreExecutableIdentity {
executable: key,
environment,
stdout: text.clone().into_bytes(),
}]);
Ok(text)
}
fn find_prediction(task: &str, invocation: &CacheDigest) -> Result<Option<CcInputPrediction>> {
let responses = session::request_agent(&[AgentRequest::FindActionPrediction {
task: task.to_string(),
invocation: invocation.clone(),
}])?;
let Some(AgentResponse::ActionPrediction { prediction }) = responses.into_iter().next() else {
return Ok(None);
};
let Some(prediction) = prediction else {
return Ok(None);
};
if prediction.adapter != ADAPTER {
return Ok(None);
}
let payload: CcInputPrediction = serde_json::from_str(&prediction.payload)?;
Ok(Some(payload))
}
fn record_prediction(
task: &str,
invocation: &CacheDigest,
action: &CacheDigest,
prediction: &CcInputPrediction,
) {
let Ok(payload) = serde_json::to_string(prediction) else {
return;
};
let _ = session::request_agent(&[AgentRequest::RecordActionPrediction {
task: task.to_string(),
prediction: ActionPrediction {
invocation: invocation.clone(),
action: action.clone(),
adapter: ADAPTER.into(),
payload,
},
}]);
}
fn prediction_task(invocation: &CacheDigest) -> String {
std::env::var(session::BUILD_ENV).unwrap_or_else(|_| standalone_prediction_task(invocation))
}
fn standalone_prediction_task(invocation: &CacheDigest) -> String {
let shard = invocation.hash.get(..2).unwrap_or(&invocation.hash);
CacheDigest::blake3(format!("cc-standalone-predictions-v1\0{shard}").as_bytes()).hash
}
fn restore_result(
action: &CcAction,
invocation: &CcInvocation,
discovered: &CcDiscoveredInputs,
restore_outputs: bool,
mappings: &[PathMapping],
) -> Result<Option<CachedCompilation>> {
let responses = session::request_agent(&[AgentRequest::FindActionResult {
action: action.digest.clone(),
}])?;
let Some(response) = responses.into_iter().next() else {
bail!("cache agent did not return an action lookup response");
};
let result = match response {
AgentResponse::ActionResult { result } => match result {
Some(result) => result,
None => return Ok(None),
},
AgentResponse::Error { message } => bail!(message),
_ => bail!("cache agent returned an unexpected action lookup response"),
};
if result.version != 1 || result.action != action.digest {
bail!("cached cc action result has an invalid identity");
}
let metadata_digest = result
.metadata
.ok_or_else(|| eyre::eyre!("cached cc action result has no metadata"))?;
let output_root_digest = result
.output_root
.ok_or_else(|| eyre::eyre!("cached cc action result has no output root"))?;
let roots = find_blobs(&[
action.digest.clone(),
metadata_digest.clone(),
output_root_digest.clone(),
])?;
let cached_action = read_verified_blob(&roots[0], &action.digest, "action descriptor")?;
if cached_action != action.bytes {
bail!("cached cc action descriptor does not match the invocation");
}
let metadata: CcMetadata = read_canonical_blob(&roots[1], &metadata_digest, "cc metadata")?;
if !metadata.validate() {
bail!("cached cc metadata is unsupported");
}
let directory: CacheDirectory =
read_canonical_blob(&roots[2], &output_root_digest, "output directory")?;
let node = validated_object(directory, invocation)?;
let destination = invocation.output().to_path_buf();
let blobs = find_blobs(&[
metadata.stdout.clone(),
metadata.stderr.clone(),
node.digest.clone(),
])?;
let stdout = denormalize_output_text(
&read_verified_blob(&blobs[0], &metadata.stdout, "stdout")?,
mappings,
);
let stderr = denormalize_output_text(
&read_verified_blob(&blobs[1], &metadata.stderr, "stderr")?,
mappings,
);
let materialization_started = Instant::now();
let parent = destination
.parent()
.ok_or_else(|| eyre::eyre!("cc output has no parent directory"))?;
std::fs::create_dir_all(parent)?;
let staging = tempfile::tempdir_in(parent)?;
let mut restore = RestoreStats {
output_files: 1,
output_bytes: node.digest.size,
..RestoreStats::default()
};
let (temporary, materialization) =
stage_verified_cached_output(staging.path(), 0, &blobs[2], &node)?;
match materialization {
Materialization::Reflink => {
restore.reflinked_output_files = 1;
restore.reflinked_output_bytes = node.digest.size;
}
Materialization::Copy => {
restore.copied_output_files = 1;
restore.copied_output_bytes = node.digest.size;
}
}
let staged = StagedOutputs {
directory: staging,
files: vec![(temporary, destination.clone())],
};
discovered.verify()?;
if restore_outputs {
persist_outputs(staged)?;
}
restore.duration_ns = duration_ns(materialization_started.elapsed());
Ok(Some(CachedCompilation {
stdout,
stderr,
outputs: vec![CachedOutput {
path: destination,
digest: node.digest,
executable: node.executable,
mode: node.mode,
}],
restore,
}))
}
fn validated_object(directory: CacheDirectory, invocation: &CcInvocation) -> Result<CacheFileNode> {
if directory.version != 1 || !directory.directories.is_empty() || !directory.symlinks.is_empty()
{
bail!("cached cc output directory has unsupported entries");
}
let name = invocation
.output()
.file_name()
.and_then(|name| name.to_str())
.ok_or_else(|| eyre::eyre!("cc output name is not UTF-8"))?;
let [node] = <[CacheFileNode; 1]>::try_from(directory.files)
.map_err(|_| eyre::eyre!("cached cc output set does not match the invocation"))?;
if node.name != name {
bail!("cached cc output is unexpected: {}", node.name);
}
validate_file_mode(&node, false)?;
Ok(node)
}
fn publish_result(
action: &CcAction,
invocation: &CcInvocation,
output: &Output,
mappings: &[PathMapping],
) -> Result<()> {
let object = invocation.output();
let metadata = std::fs::metadata(object)
.wrap_err_with(|| format!("failed to inspect cc output {}", object.display()))?;
if !metadata.is_file() {
bail!("cc output is not a regular file: {}", object.display());
}
let staging = staging_directory()?;
let mut blobs = vec![staged_bytes(staging.path(), "action.json", &action.bytes)?];
let stdout = staged_bytes(
staging.path(),
"stdout",
&normalize_output_text(&output.stdout, mappings),
)?;
let stderr = staged_bytes(
staging.path(),
"stderr",
&normalize_output_text(&output.stderr, mappings),
)?;
blobs.extend([stdout.clone(), stderr.clone()]);
let digest = CacheDigest::blake3_file(object)?;
blobs.push((digest.clone(), object.to_path_buf()));
let files = vec![CacheFileNode {
digest,
executable: false,
mode: file_mode(&metadata),
name: object
.file_name()
.and_then(|name| name.to_str())
.ok_or_else(|| eyre::eyre!("cc output name is not UTF-8"))?
.to_string(),
}];
let metadata_bytes = canonical_json(&CcMetadata {
version: 1,
kind: ADAPTER.into(),
stdout: stdout.0,
stderr: stderr.0,
})?;
let metadata = staged_bytes(staging.path(), "metadata.json", &metadata_bytes)?;
blobs.push(metadata.clone());
let directory_bytes = canonical_json(&CacheDirectory {
directories: Vec::new(),
files,
symlinks: Vec::new(),
version: 1,
})?;
let directory = staged_bytes(staging.path(), "directory.json", &directory_bytes)?;
blobs.push(directory.clone());
let mut requests = Vec::new();
let mut published = BTreeSet::new();
for (digest, source) in blobs {
if published.insert(digest.clone()) {
requests.push(AgentRequest::StoreBlob { digest, source });
}
}
requests.push(AgentRequest::StoreActionResult {
result: RemoteActionResult {
action: action.digest.clone(),
metadata: Some(metadata.0),
output_root: Some(directory.0),
version: 1,
},
});
for response in session::request_agent(&requests)? {
match response {
AgentResponse::Stored { .. } | AgentResponse::ActionStored { .. } => {}
AgentResponse::Error { message } => bail!(message),
_ => bail!("cache agent returned an unexpected publish response"),
}
}
Ok(())
}
fn staged_bytes(directory: &Path, name: &str, bytes: &[u8]) -> Result<(CacheDigest, PathBuf)> {
let path = directory.join(name);
std::fs::write(&path, bytes)?;
Ok((CacheDigest::blake3(bytes), path))
}
fn cached_matches(cached: &CachedCompilation, output: &Output) -> bool {
output.status.success()
&& cached.stdout == output.stdout
&& cached.stderr == output.stderr
&& cached.outputs.iter().all(|expected| {
std::fs::metadata(&expected.path).is_ok_and(|metadata| {
file_mode(&metadata) == expected.mode
&& executable_mode_matches(&metadata, expected.executable)
&& expected
.digest
.matches_file(&expected.path)
.unwrap_or(false)
})
})
}
fn compilation_name(invocation: &CcInvocation) -> String {
format!("{ADAPTER}:{}", invocation.source_name())
}
fn duration_ns(duration: std::time::Duration) -> u64 {
duration.as_nanos().try_into().unwrap_or(u64::MAX)
}
#[cfg(test)]
#[path = "cc_tests.rs"]
mod tests;