use anyhow::Result;
use capstone::arch::BuildsCapstone;
use serde_derive::Serialize;
use std::{
fs::File,
io::{Write, read_to_string},
path::Path,
str::FromStr,
};
use wasmtime_environ::demangle_function_name;
pub fn generate(
config: &wasmtime::Config,
target: Option<&str>,
clif_dir: Option<&Path>,
wasm: &[u8],
dest: &mut dyn Write,
) -> Result<()> {
let target = match target {
None => target_lexicon::Triple::host(),
Some(target) => target_lexicon::Triple::from_str(target)?,
};
let wat = annotate_wat(wasm)?;
let wat_json = serde_json::to_string(&wat)?;
let asm = annotate_asm(config, &target, wasm)?;
let asm_json = serde_json::to_string(&asm)?;
let clif_json = clif_dir
.map::<anyhow::Result<String>, _>(|clif_dir| {
let clif = annotate_clif(clif_dir, &asm)?;
Ok(serde_json::to_string(&clif)?)
})
.transpose()?;
let index_css = include_str!("./index.css");
let index_js = include_str!("./index.js");
write!(
dest,
r#"
<!DOCTYPE html>
<html>
<head>
<title>Wasmtime Compiler Explorer</title>
<style>
{index_css}
</style>
</head>
<body class="hbox">
<pre id="wat"></pre>
"#
)?;
if clif_json.is_some() {
write!(dest, r#"<div id="clif"></div>"#)?;
}
write!(
dest,
r#"
<div id="asm"></div>
<script>
window.WAT = {wat_json};
"#
)?;
if let Some(clif_json) = clif_json {
write!(
dest,
r#"
window.CLIF = {clif_json};
"#
)?;
}
write!(
dest,
r#"
window.ASM = {asm_json};
</script>
<script>
{index_js}
</script>
</body>
</html>
"#
)?;
Ok(())
}
#[derive(Serialize, Clone, Copy, Debug)]
struct WasmOffset(u32);
#[derive(Serialize, Debug)]
struct AnnotatedWat {
chunks: Vec<AnnotatedWatChunk>,
}
#[derive(Serialize, Debug)]
struct AnnotatedWatChunk {
wasm_offset: Option<WasmOffset>,
wat: String,
}
fn annotate_wat(wasm: &[u8]) -> Result<AnnotatedWat> {
let printer = wasmprinter::Config::new();
let mut storage = String::new();
let chunks = printer
.offsets_and_lines(wasm, &mut storage)?
.map(|(offset, wat)| AnnotatedWatChunk {
wasm_offset: offset.map(|o| WasmOffset(u32::try_from(o).unwrap())),
wat: wat.to_string(),
})
.collect();
Ok(AnnotatedWat { chunks })
}
#[derive(Serialize, Debug)]
struct AnnotatedAsm {
functions: Vec<AnnotatedFunction>,
}
#[derive(Serialize, Debug)]
struct AnnotatedFunction {
func_index: u32,
name: Option<String>,
demangled_name: Option<String>,
instructions: Vec<AnnotatedInstruction>,
}
#[derive(Serialize, Debug)]
struct AnnotatedInstruction {
wasm_offset: Option<WasmOffset>,
address: u32,
bytes: Vec<u8>,
mnemonic: Option<String>,
operands: Option<String>,
}
fn annotate_asm(
config: &wasmtime::Config,
target: &target_lexicon::Triple,
wasm: &[u8],
) -> Result<AnnotatedAsm> {
let engine = wasmtime::Engine::new(config)?;
let module = wasmtime::Module::new(&engine, wasm)?;
let text = module.text();
let address_map: Vec<_> = module
.address_map()
.ok_or_else(|| anyhow::anyhow!("address maps must be enabled in the config"))?
.collect();
let mut address_map_iter = address_map.into_iter().peekable();
let mut current_entry = address_map_iter.next();
let mut wasm_offset_for_address = |start: usize, address: u32| -> Option<WasmOffset> {
while current_entry.map_or(false, |cur| cur.0 < start) {
current_entry = address_map_iter.next();
}
while address_map_iter.peek().map_or(false, |next_entry| {
u32::try_from(next_entry.0).unwrap() <= address
}) {
current_entry = address_map_iter.next();
}
current_entry.and_then(|entry| entry.1.map(WasmOffset))
};
let functions = module
.functions()
.map(|function| {
let body = &text[function.offset..][..function.len];
let mut cs = match target.architecture {
target_lexicon::Architecture::Aarch64(_) => capstone::Capstone::new()
.arm64()
.mode(capstone::arch::arm64::ArchMode::Arm)
.build()
.map_err(|e| anyhow::anyhow!("{e}"))?,
target_lexicon::Architecture::Riscv64(_) => capstone::Capstone::new()
.riscv()
.mode(capstone::arch::riscv::ArchMode::RiscV64)
.build()
.map_err(|e| anyhow::anyhow!("{e}"))?,
target_lexicon::Architecture::S390x => capstone::Capstone::new()
.sysz()
.mode(capstone::arch::sysz::ArchMode::Default)
.build()
.map_err(|e| anyhow::anyhow!("{e}"))?,
target_lexicon::Architecture::X86_64 => capstone::Capstone::new()
.x86()
.mode(capstone::arch::x86::ArchMode::Mode64)
.build()
.map_err(|e| anyhow::anyhow!("{e}"))?,
_ => anyhow::bail!("Unsupported target: {target}"),
};
cs.set_skipdata(true).unwrap();
let instructions = cs
.disasm_all(body, function.offset as u64)
.map_err(|e| anyhow::anyhow!("{e}"))?;
let instructions = instructions
.iter()
.map(|inst| {
let address = u32::try_from(inst.address()).unwrap();
let wasm_offset = wasm_offset_for_address(function.offset, address);
Ok(AnnotatedInstruction {
wasm_offset,
address,
bytes: inst.bytes().to_vec(),
mnemonic: inst.mnemonic().map(ToString::to_string),
operands: inst.op_str().map(ToString::to_string),
})
})
.collect::<Result<Vec<_>>>()?;
let demangled_name = if let Some(name) = &function.name {
let mut demangled = String::new();
if demangle_function_name(&mut demangled, &name).is_ok() {
Some(demangled)
} else {
None
}
} else {
None
};
Ok(AnnotatedFunction {
func_index: function.index.as_u32(),
name: function.name,
demangled_name,
instructions,
})
})
.collect::<Result<Vec<_>>>()?;
Ok(AnnotatedAsm { functions })
}
#[derive(Serialize, Debug)]
struct AnnotatedClif {
functions: Vec<AnnotatedClifFunction>,
}
#[derive(Serialize, Debug)]
struct AnnotatedClifFunction {
func_index: u32,
name: Option<String>,
demangled_name: Option<String>,
instructions: Vec<AnnotatedClifInstruction>,
}
#[derive(Serialize, Debug)]
struct AnnotatedClifInstruction {
wasm_offset: Option<WasmOffset>,
clif: String,
}
fn annotate_clif(clif_dir: &Path, asm: &AnnotatedAsm) -> Result<AnnotatedClif> {
let mut clif = AnnotatedClif {
functions: Vec::new(),
};
for function in &asm.functions {
let function_path = clif_dir.join(format!("wasm_func_{}.clif", function.func_index));
if !function_path.exists() {
continue;
}
let mut clif_function = AnnotatedClifFunction {
func_index: function.func_index,
name: function.name.clone(),
demangled_name: function.demangled_name.clone(),
instructions: Vec::new(),
};
let file = File::open(&function_path)?;
for mut line in read_to_string(file)?.lines() {
if line.is_empty() {
continue;
}
let mut wasm_offset = None;
if line.starts_with('@') {
wasm_offset = Some(WasmOffset(u32::from_str_radix(&line[1..5], 16)?));
line = &line[28..];
} else if line.starts_with(" ") {
line = &line[28..];
}
clif_function.instructions.push(AnnotatedClifInstruction {
wasm_offset,
clif: line.to_string(),
});
}
clif.functions.push(clif_function);
}
Ok(clif)
}
