1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
use anyhow::{anyhow, Result};
use delegate::delegate;
use hugr::{
ops::{FuncDecl, FuncDefn, OpType},
types::PolyFuncType,
HugrView, Node,
};
use inkwell::{
builder::Builder,
context::Context,
module::{Linkage, Module},
types::{AnyType, BasicType, BasicTypeEnum, FunctionType},
values::{BasicValueEnum, CallSiteValue, FunctionValue, GlobalValue},
};
use std::{collections::HashSet, rc::Rc};
use crate::types::{HugrFuncType, HugrSumType, HugrType, TypingSession};
use crate::{
custom::CodegenExtsMap,
fat::FatNode,
types::{LLVMSumType, TypeConverter},
};
pub mod args;
pub mod func;
pub mod libc;
pub mod namer;
pub mod ops;
pub use args::EmitOpArgs;
pub use func::{EmitFuncContext, RowPromise};
pub use namer::Namer;
pub use ops::emit_value;
/// A trait used to abstract over emission.
///
/// In particular a `Box<dyn EmitOp>` is returned by
/// [crate::custom::CodegenExtension::emitter].
///
/// Any non-trivial implementation will need to contain an [&mut
/// EmitFuncContext](EmitFuncContext) in `Self` in order to be able to implement
/// this trait.
pub trait EmitOp<'c, OT, H> {
/// Emit the node in `args` using the inputs, and [finishing](RowPromise::finish) the outputs.
fn emit(&mut self, args: EmitOpArgs<'c, OT, H>) -> Result<()>;
}
/// A trivial implementation of [EmitOp] used for [crate::custom::CodegenExtension]s that do
/// not support emitting any ops.
pub struct NullEmitLlvm;
impl<OT, H> EmitOp<'_, OT, H> for NullEmitLlvm {
fn emit(&mut self, _args: EmitOpArgs<OT, H>) -> Result<()> {
Err(anyhow!("NullEmitLLVM"))
}
}
pub struct EmitModuleContext<'c, H> {
module: Module<'c>,
extensions: Rc<CodegenExtsMap<'c, H>>,
typer: Rc<TypeConverter<'c>>,
namer: Rc<Namer>,
}
impl<'c, H> EmitModuleContext<'c, H> {
delegate! {
to self.typer {
/// Returns a reference to the inner [Context].
pub fn iw_context(&self) -> &'c Context;
}
to self.typer.clone() {
/// Convert a [HugrType] into an LLVM [Type](BasicTypeEnum).
pub fn llvm_type(&self, [self.extensions()], hugr_type: &HugrType) -> Result<BasicTypeEnum<'c>>;
/// Convert a [HugrFuncType] into an LLVM [FunctionType].
pub fn llvm_func_type(&self, [self.extensions()], hugr_type: &HugrFuncType) -> Result<FunctionType<'c>>;
/// Convert a hugr [HugrSumType] into an LLVM [LLVMSumType].
pub fn llvm_sum_type(&self, [self.extensions()], sum_type: HugrSumType) -> Result<LLVMSumType<'c>>;
}
to self.namer {
/// Mangle the name of a [FuncDefn] or a [FuncDecl].
pub fn name_func(&self, name: impl AsRef<str>, node: Node) -> String;
}
}
/// Creates a new `EmitModuleContext`. We take ownership of the [Module],
/// and return it in [EmitModuleContext::finish].
pub fn new(
module: Module<'c>,
namer: Rc<Namer>,
extensions: Rc<CodegenExtsMap<'c, H>>,
typer: Rc<TypeConverter<'c>>,
) -> Self {
Self {
module,
namer,
extensions,
typer,
}
}
/// Returns a reference to the inner [Module]. Note that this type has
/// "interior mutability", and this reference can be used to add functions
/// and globals to the [Module].
pub fn module(&self) -> &Module<'c> {
&self.module
}
/// Returns a reference to the inner [CodegenExtsMap].
pub fn extensions(&self) -> Rc<CodegenExtsMap<'c, H>> {
self.extensions.clone()
}
/// Returns a [TypingSession] constructed from it's members.
pub fn typing_session(&self) -> TypingSession<'c, H> {
self.typer.clone().session::<H>(self.extensions())
}
fn get_func_impl(
&self,
name: impl AsRef<str>,
func_ty: FunctionType<'c>,
linkage: Option<Linkage>,
) -> Result<FunctionValue<'c>> {
let func = self
.module()
.get_function(name.as_ref())
.unwrap_or_else(|| self.module.add_function(name.as_ref(), func_ty, linkage));
if func.get_type() != func_ty {
Err(anyhow!(
"Function '{}' has wrong type: expected: {func_ty} actual: {}",
name.as_ref(),
func.get_type()
))?
}
Ok(func)
}
fn get_hugr_func_impl(
&self,
name: impl AsRef<str>,
node: Node,
func_ty: &PolyFuncType,
) -> Result<FunctionValue<'c>> {
let func_ty = (func_ty.params().is_empty())
.then_some(func_ty.body())
.ok_or(anyhow!("function has type params"))?;
let llvm_func_ty = self.llvm_func_type(func_ty)?;
let name = self.name_func(name, node);
self.get_func_impl(name, llvm_func_ty, None)
}
/// Adds or gets the [FunctionValue] in the [Module] corresponding to the given [FuncDefn].
///
/// The name of the result is mangled by [EmitModuleContext::name_func].
pub fn get_func_defn(&self, node: FatNode<'c, FuncDefn, H>) -> Result<FunctionValue<'c>>
where
H: HugrView,
{
self.get_hugr_func_impl(&node.name, node.node(), &node.signature)
}
/// Adds or gets the [FunctionValue] in the [Module] corresponding to the given [FuncDecl].
///
/// The name of the result is mangled by [EmitModuleContext::name_func].
pub fn get_func_decl(&self, node: FatNode<'c, FuncDecl, H>) -> Result<FunctionValue<'c>>
where
H: HugrView,
{
self.get_hugr_func_impl(&node.name, node.node(), &node.signature)
}
/// Adds or get the [FunctionValue] in the [Module] with the given symbol
/// and function type.
///
/// The name undergoes no mangling. The [FunctionValue] will have
/// [Linkage::External].
///
/// If this function is called multiple times with the same arguments it
/// will return the same [FunctionValue].
///
/// If a function with the given name exists but the type does not match
/// then an Error is returned.
pub fn get_extern_func(
&self,
symbol: impl AsRef<str>,
typ: FunctionType<'c>,
) -> Result<FunctionValue<'c>> {
self.get_func_impl(symbol, typ, Some(Linkage::External))
}
/// Adds or gets the [GlobalValue] in the [Module] corresponding to the
/// given symbol and LLVM type.
///
/// The name will not be mangled.
///
/// If a global with the given name exists but the type or constant-ness
/// does not match then an error will be returned.
pub fn get_global(
&self,
symbol: impl AsRef<str>,
typ: impl BasicType<'c>,
constant: bool,
) -> Result<GlobalValue<'c>> {
let symbol = symbol.as_ref();
let typ = typ.as_basic_type_enum();
if let Some(global) = self.module().get_global(symbol) {
let global_type = {
// TODO This is exposed as `get_value_type` on the master branch
// of inkwell, will be in the next release. When it's released
// use `get_value_type`.
use inkwell::types::AnyTypeEnum;
use inkwell::values::AsValueRef;
unsafe {
AnyTypeEnum::new(inkwell::llvm_sys::core::LLVMGlobalGetValueType(
global.as_value_ref(),
))
}
};
if global_type != typ.as_any_type_enum() {
Err(anyhow!(
"Global '{symbol}' has wrong type: expected: {typ} actual: {global_type}"
))?
}
if global.is_constant() != constant {
Err(anyhow!(
"Global '{symbol}' has wrong constant-ness: expected: {constant} actual: {}",
global.is_constant()
))?
}
Ok(global)
} else {
let global = self.module().add_global(typ, None, symbol.as_ref());
global.set_constant(constant);
Ok(global)
}
}
/// Consumes the `EmitModuleContext` and returns the internal [Module].
pub fn finish(self) -> Module<'c> {
self.module
}
}
type EmissionSet<'c, H> = HashSet<FatNode<'c, FuncDefn, H>>;
/// Emits [HugrView]s into an LLVM [Module].
pub struct EmitHugr<'c, H> {
emitted: EmissionSet<'c, H>,
module_context: EmitModuleContext<'c, H>,
}
impl<'c, H: HugrView> EmitHugr<'c, H> {
delegate! {
to self.module_context {
/// Returns a reference to the inner [Context].
pub fn iw_context(&self) -> &'c Context;
/// Returns a reference to the inner [Module]. Note that this type has
/// "interior mutability", and this reference can be used to add functions
/// and globals to the [Module].
pub fn module(&self) -> &Module<'c>;
}
}
/// Creates a new `EmitHugr`. We take ownership of the [Module], and return it in [Self::finish].
pub fn new(
context: &'c Context,
module: Module<'c>,
namer: Rc<Namer>,
extensions: Rc<CodegenExtsMap<'c, H>>,
) -> Self {
assert_eq!(context, &module.get_context());
Self {
emitted: Default::default(),
module_context: EmitModuleContext::new(
module,
namer,
extensions,
TypeConverter::new(context),
),
}
}
/// Emits a FuncDefn into the inner [Module].
///
/// `node` need not be a child of a hugr [Module](hugr::ops::Module), but it will
/// be emitted as a top-level function in the inner [Module]. Indeed, there
/// are only top-level functions in LLVM IR.
///
/// Any child [FuncDefn] will also be emitted.
///
/// It is safe to emit the same node multiple times: the second and further
/// emissions will be no-ops.
///
/// If any LLVM IR declaration which is to be emitted already exists in the
/// [Module] and it differs from what would be emitted, then we fail.
pub fn emit_func(mut self, node: FatNode<'c, FuncDefn, H>) -> Result<Self> {
let mut worklist: EmissionSet<'c, H> = [node].into_iter().collect();
let pop =
|wl: &mut EmissionSet<'c, H>| wl.iter().next().cloned().map(|x| wl.take(&x).unwrap());
while let Some(x) = pop(&mut worklist) {
let (new_self, new_tasks) = self.emit_func_impl(x)?;
self = new_self;
worklist.extend(new_tasks.into_iter());
}
Ok(self)
}
/// Emits all children of a hugr [Module](hugr::ops::Module).
///
/// Note that type aliases are not supported, and that [hugr::ops::Const]
/// and [hugr::ops::FuncDecl] nodes are not emitted directly, but instead by
/// emission of ops with static edges from them. So [FuncDefn] are the only
/// interesting children.
pub fn emit_module(mut self, node: FatNode<'c, hugr::ops::Module, H>) -> Result<Self> {
for c in node.children() {
match c.as_ref() {
OpType::FuncDefn(ref fd) => {
let fat_ot = c.into_ot(fd);
self = self.emit_func(fat_ot)?;
}
// FuncDecls are allowed, but we don't need to do anything here.
OpType::FuncDecl(_) => (),
// Consts are allowed, but we don't need to do anything here.
OpType::Const(_) => (),
_ => Err(anyhow!("Module has invalid child: {c}"))?,
}
}
Ok(self)
}
fn emit_func_impl(
mut self,
node: FatNode<'c, FuncDefn, H>,
) -> Result<(Self, EmissionSet<'c, H>)> {
if !self.emitted.insert(node) {
return Ok((self, EmissionSet::default()));
}
let func = self.module_context.get_func_defn(node)?;
let mut func_ctx = EmitFuncContext::new(self.module_context, func)?;
let ret_rmb = func_ctx.new_row_mail_box(node.signature.body().output.iter(), "ret")?;
ops::emit_dataflow_parent(
&mut func_ctx,
EmitOpArgs {
node,
inputs: func.get_params(),
outputs: ret_rmb.promise(),
},
)?;
let builder = func_ctx.builder();
match &ret_rmb.read::<Vec<_>>(builder, [])?[..] {
[] => builder.build_return(None)?,
[x] => builder.build_return(Some(x))?,
xs => builder.build_aggregate_return(xs)?,
};
let (mctx, todos) = func_ctx.finish()?;
self.module_context = mctx;
Ok((self, todos))
}
/// Consumes the `EmitHugr` and returns the internal [Module].
pub fn finish(self) -> Module<'c> {
self.module_context.finish()
}
}
/// Extract all return values from the result of a `call`.
///
/// LLVM only supports functions with exactly zero or one return value.
/// For functions with multiple return values, we return a struct containing
/// all the return values.
///
/// `inkwell` provides a helper [Builder::build_aggregate_return] to construct
/// the return value, see `EmitHugr::emit_func_impl`. This function performs the
/// inverse.
pub fn deaggregate_call_result<'c>(
builder: &Builder<'c>,
call_result: CallSiteValue<'c>,
num_results: usize,
) -> Result<Vec<BasicValueEnum<'c>>> {
let call_result = call_result.try_as_basic_value();
Ok(match num_results as u32 {
0 => {
call_result.expect_right("void");
vec![]
}
1 => vec![call_result.expect_left("non-void")],
n => {
let return_struct = call_result.expect_left("non-void").into_struct_value();
(0..n)
.map(|i| builder.build_extract_value(return_struct, i, ""))
.collect::<Result<Vec<_>, _>>()?
}
})
}
#[cfg(test)]
pub mod test;