//! Provides the compiler backend to generate Roc binaries fast, for a nice
//! developer experience. See [README.md](./compiler/gen_dev/README.md) for
//! more information.
#![warn(clippy::dbg_macro)]
// See github.com/roc-lang/roc/issues/800 for discussion of the large_enum_variant check.
#![allow(clippy::large_enum_variant, clippy::upper_case_acronyms)]

use bumpalo::{collections::Vec, Bump};
use roc_builtins::bitcode::{self, FloatWidth, IntWidth};
use roc_collections::all::{MutMap, MutSet};
use roc_error_macros::internal_error;
use roc_module::ident::ModuleName;
use roc_module::low_level::{LowLevel, LowLevelWrapperType};
use roc_module::symbol::{Interns, ModuleId, Symbol};
use roc_mono::code_gen_help::CodeGenHelp;
use roc_mono::ir::{
    BranchInfo, CallType, Expr, JoinPointId, ListLiteralElement, Literal, Param, Proc, ProcLayout,
    SelfRecursive, Stmt,
};
use roc_mono::layout::{
    Builtin, InLayout, Layout, LayoutIds, LayoutInterner, STLayoutInterner, TagIdIntType,
    UnionLayout,
};
use roc_mono::list_element_layout;

mod generic64;
mod object_builder;
pub use object_builder::build_module;
mod run_roc;

pub struct Env<'a> {
    pub arena: &'a Bump,
    pub module_id: ModuleId,
    pub exposed_to_host: MutSet<Symbol>,
    pub lazy_literals: bool,
    pub generate_allocators: bool,
}

// These relocations likely will need a length.
// They may even need more definition, but this should be at least good enough for how we will use elf.
#[derive(Debug, Clone)]
#[allow(dead_code)]
pub enum Relocation {
    LocalData {
        offset: u64,
        // This should probably technically be a bumpalo::Vec.
        // The problem is that it currently is built in a place that can't access the arena.
        data: std::vec::Vec<u8>,
    },
    LinkedFunction {
        offset: u64,
        name: String,
    },
    LinkedData {
        offset: u64,
        name: String,
    },
    JmpToReturn {
        inst_loc: u64,
        inst_size: u64,
        offset: u64,
    },
}

trait Backend<'a> {
    fn env(&self) -> &Env<'a>;
    fn interns(&self) -> &Interns;
    fn interner(&self) -> &STLayoutInterner<'a>;

    // This method is suboptimal, but it seems to be the only way to make rust understand
    // that all of these values can be mutable at the same time. By returning them together,
    // rust understands that they are part of a single use of mutable self.
    fn module_interns_helpers_mut(
        &mut self,
    ) -> (
        ModuleId,
        &mut STLayoutInterner<'a>,
        &mut Interns,
        &mut CodeGenHelp<'a>,
    );

    fn function_symbol_to_string<'b, I>(
        &self,
        symbol: Symbol,
        arguments: I,
        _lambda_set: Option<InLayout>,
        result: InLayout,
    ) -> String
    where
        I: Iterator<Item = InLayout<'b>>,
    {
        use std::hash::{BuildHasher, Hash, Hasher};

        // NOTE: due to randomness, this will not be consistent between runs
        let mut state = roc_collections::all::BuildHasher::default().build_hasher();
        for a in arguments {
            a.hash(&mut state);
        }

        // lambda set should not matter; it should already be added as an argument
        // lambda_set.hash(&mut state);

        result.hash(&mut state);

        let interns = self.interns();
        let ident_string = symbol.as_str(interns);
        let module_string = interns.module_ids.get_name(symbol.module_id()).unwrap();

        // the functions from the generates #help module (refcounting, equality) is always suffixed
        // with 1. That is fine, they are always unique anyway.
        if ident_string.contains("#help") {
            format!("{}_{}_1", module_string, ident_string)
        } else {
            format!("{}_{}_{}", module_string, ident_string, state.finish())
        }
    }

    fn defined_in_app_module(&self, symbol: Symbol) -> bool {
        symbol
            .module_string(self.interns())
            .starts_with(ModuleName::APP)
    }

    fn helper_proc_gen_mut(&mut self) -> &mut CodeGenHelp<'a>;

    fn helper_proc_symbols_mut(&mut self) -> &mut Vec<'a, (Symbol, ProcLayout<'a>)>;

    fn helper_proc_symbols(&self) -> &Vec<'a, (Symbol, ProcLayout<'a>)>;

    /// reset resets any registers or other values that may be occupied at the end of a procedure.
    /// It also passes basic procedure information to the builder for setup of the next function.
    fn reset(&mut self, name: String, is_self_recursive: SelfRecursive);

    /// finalize does any setup and cleanup that should happen around the procedure.
    /// finalize does setup because things like stack size and jump locations are not know until the function is written.
    /// For example, this can store the frame pointer and setup stack space.
    /// finalize is run at the end of build_proc when all internal code is finalized.
    fn finalize(&mut self) -> (Vec<u8>, Vec<Relocation>);

    // load_args is used to let the backend know what the args are.
    // The backend should track these args so it can use them as needed.
    fn load_args(&mut self, args: &'a [(InLayout<'a>, Symbol)], ret_layout: &InLayout<'a>);

    /// Used for generating wrappers for malloc/realloc/free
    fn build_wrapped_jmp(&mut self) -> (&'a [u8], u64);

    /// build_proc creates a procedure and outputs it to the wrapped object writer.
    /// Returns the procedure bytes, its relocations, and the names of the refcounting functions it references.
    fn build_proc(
        &mut self,
        proc: Proc<'a>,
        layout_ids: &mut LayoutIds<'a>,
    ) -> (Vec<u8>, Vec<Relocation>, Vec<'a, (Symbol, String)>) {
        let proc_name = self.function_symbol_to_string(
            proc.name.name(),
            proc.args.iter().map(|t| t.0),
            proc.closure_data_layout,
            proc.ret_layout,
        );

        self.reset(proc_name, proc.is_self_recursive);
        self.load_args(proc.args, &proc.ret_layout);
        for (layout, sym) in proc.args {
            self.set_layout_map(*sym, layout);
        }
        self.scan_ast(&proc.body);
        self.create_free_map();
        self.build_stmt(&proc.body, &proc.ret_layout);
        let mut helper_proc_names = bumpalo::vec![in self.env().arena];
        helper_proc_names.reserve(self.helper_proc_symbols().len());
        for (rc_proc_sym, rc_proc_layout) in self.helper_proc_symbols() {
            let name = layout_ids
                .get_toplevel(*rc_proc_sym, rc_proc_layout)
                .to_symbol_string(*rc_proc_sym, self.interns());

            helper_proc_names.push((*rc_proc_sym, name));
        }
        let (bytes, relocs) = self.finalize();
        (bytes, relocs, helper_proc_names)
    }

    /// build_stmt builds a statement and outputs at the end of the buffer.
    fn build_stmt(&mut self, stmt: &Stmt<'a>, ret_layout: &InLayout<'a>) {
        match stmt {
            Stmt::Let(sym, expr, layout, following) => {
                self.build_expr(sym, expr, layout);
                self.set_layout_map(*sym, layout);
                self.free_symbols(stmt);
                self.build_stmt(following, ret_layout);
            }
            Stmt::Ret(sym) => {
                self.load_literal_symbols(&[*sym]);
                self.return_symbol(sym, ret_layout);
                self.free_symbols(stmt);
            }
            Stmt::Refcounting(modify, following) => {
                let sym = modify.get_symbol();
                let layout = *self.layout_map().get(&sym).unwrap();

                // Expand the Refcounting statement into more detailed IR with a function call
                // If this layout requires a new RC proc, we get enough info to create a linker symbol
                // for it. Here we don't create linker symbols at this time, but in Wasm backend, we do.
                let (rc_stmt, new_specializations) = {
                    let (module_id, layout_interner, interns, rc_proc_gen) =
                        self.module_interns_helpers_mut();
                    let ident_ids = interns.all_ident_ids.get_mut(&module_id).unwrap();

                    rc_proc_gen.expand_refcount_stmt(
                        ident_ids,
                        layout_interner,
                        layout,
                        modify,
                        following,
                    )
                };

                for spec in new_specializations.into_iter() {
                    self.helper_proc_symbols_mut().push(spec);
                }

                self.build_stmt(rc_stmt, ret_layout)
            }
            Stmt::Switch {
                cond_symbol,
                cond_layout,
                branches,
                default_branch,
                ret_layout,
            } => {
                self.load_literal_symbols(&[*cond_symbol]);
                self.build_switch(
                    cond_symbol,
                    cond_layout,
                    branches,
                    default_branch,
                    ret_layout,
                );
                self.free_symbols(stmt);
            }
            Stmt::Join {
                id,
                parameters,
                body,
                remainder,
            } => {
                for param in parameters.iter() {
                    self.set_layout_map(param.symbol, &param.layout);
                }
                self.build_join(id, parameters, body, remainder, ret_layout);
                self.free_symbols(stmt);
            }
            Stmt::Jump(id, args) => {
                self.load_literal_symbols(args);
                let mut arg_layouts: bumpalo::collections::Vec<InLayout<'a>> =
                    bumpalo::vec![in self.env().arena];
                arg_layouts.reserve(args.len());
                let layout_map = self.layout_map();
                for arg in *args {
                    if let Some(layout) = layout_map.get(arg) {
                        arg_layouts.push(*layout);
                    } else {
                        internal_error!("the argument, {:?}, has no know layout", arg);
                    }
                }
                self.build_jump(id, args, arg_layouts.into_bump_slice(), ret_layout);
                self.free_symbols(stmt);
            }
            x => todo!("the statement, {:?}", x),
        }
    }
    // build_switch generates a instructions for a switch statement.
    fn build_switch(
        &mut self,
        cond_symbol: &Symbol,
        cond_layout: &InLayout<'a>,
        branches: &'a [(u64, BranchInfo<'a>, Stmt<'a>)],
        default_branch: &(BranchInfo<'a>, &'a Stmt<'a>),
        ret_layout: &InLayout<'a>,
    );

    // build_join generates a instructions for a join statement.
    fn build_join(
        &mut self,
        id: &JoinPointId,
        parameters: &'a [Param<'a>],
        body: &'a Stmt<'a>,
        remainder: &'a Stmt<'a>,
        ret_layout: &InLayout<'a>,
    );

    // build_jump generates a instructions for a jump statement.
    fn build_jump(
        &mut self,
        id: &JoinPointId,
        args: &[Symbol],
        arg_layouts: &[InLayout<'a>],
        ret_layout: &InLayout<'a>,
    );

    /// build_expr builds the expressions for the specified symbol.
    /// The builder must keep track of the symbol because it may be referred to later.
    fn build_expr(&mut self, sym: &Symbol, expr: &Expr<'a>, layout: &InLayout<'a>) {
        match expr {
            Expr::Literal(lit) => {
                if self.env().lazy_literals {
                    self.literal_map().insert(*sym, (lit, layout));
                } else {
                    self.load_literal(sym, layout, lit);
                }
            }
            Expr::Call(roc_mono::ir::Call {
                call_type,
                arguments,
            }) => {
                match call_type {
                    CallType::ByName {
                        name: func_sym,
                        arg_layouts,
                        ret_layout,
                        ..
                    } => {
                        if let LowLevelWrapperType::CanBeReplacedBy(lowlevel) =
                            LowLevelWrapperType::from_symbol(func_sym.name())
                        {
                            return self.build_run_low_level(
                                sym,
                                &lowlevel,
                                arguments,
                                arg_layouts,
                                ret_layout,
                            );
                        } else if sym.is_builtin() {
                            // These builtins can be built through `build_fn_call` as well, but the
                            // implementation in `build_builtin` inlines some of the symbols.
                            return self.build_builtin(
                                sym,
                                func_sym.name(),
                                arguments,
                                arg_layouts,
                                ret_layout,
                            );
                        }

                        let fn_name = self.function_symbol_to_string(
                            func_sym.name(),
                            arg_layouts.iter().copied(),
                            None,
                            *ret_layout,
                        );

                        // Now that the arguments are needed, load them if they are literals.
                        self.load_literal_symbols(arguments);
                        self.build_fn_call(sym, fn_name, arguments, arg_layouts, ret_layout)
                    }

                    CallType::LowLevel { op: lowlevel, .. } => {
                        let mut arg_layouts: bumpalo::collections::Vec<InLayout<'a>> =
                            bumpalo::vec![in self.env().arena];
                        arg_layouts.reserve(arguments.len());
                        let layout_map = self.layout_map();
                        for arg in *arguments {
                            if let Some(layout) = layout_map.get(arg) {
                                arg_layouts.push(*layout);
                            } else {
                                internal_error!("the argument, {:?}, has no know layout", arg);
                            }
                        }
                        self.build_run_low_level(
                            sym,
                            lowlevel,
                            arguments,
                            arg_layouts.into_bump_slice(),
                            layout,
                        )
                    }
                    x => todo!("the call type, {:?}", x),
                }
            }
            Expr::EmptyArray => {
                self.create_empty_array(sym);
            }
            Expr::Array { elem_layout, elems } => {
                let mut syms = bumpalo::vec![in self.env().arena];
                for sym in elems.iter().filter_map(|x| match x {
                    ListLiteralElement::Symbol(sym) => Some(sym),
                    _ => None,
                }) {
                    syms.push(*sym);
                }
                // TODO: This could be a huge waste.
                // We probably want to call this within create_array, one element at a time.
                self.load_literal_symbols(syms.into_bump_slice());
                self.create_array(sym, elem_layout, elems);
            }
            Expr::Struct(fields) => {
                self.load_literal_symbols(fields);
                self.create_struct(sym, layout, fields);
            }
            Expr::StructAtIndex {
                index,
                field_layouts,
                structure,
            } => {
                self.load_struct_at_index(sym, structure, *index, field_layouts);
            }
            Expr::UnionAtIndex {
                structure,
                tag_id,
                union_layout,
                index,
            } => {
                self.load_union_at_index(sym, structure, *tag_id, *index, union_layout);
            }
            Expr::GetTagId {
                structure,
                union_layout,
            } => {
                self.get_tag_id(sym, structure, union_layout);
            }
            Expr::Tag {
                tag_layout,
                tag_id,
                arguments,
                ..
            } => {
                self.load_literal_symbols(arguments);
                self.tag(sym, arguments, tag_layout, *tag_id);
            }
            Expr::ExprBox { symbol: value } => {
                let element_layout = match self.interner().get(*layout) {
                    Layout::Boxed(boxed) => boxed,
                    _ => unreachable!("{:?}", self.interner().dbg(*layout)),
                };

                self.load_literal_symbols([*value].as_slice());
                self.expr_box(*sym, *value, element_layout)
            }
            Expr::ExprUnbox { symbol: ptr } => {
                let element_layout = *layout;

                self.load_literal_symbols([*ptr].as_slice());
                self.expr_unbox(*sym, *ptr, element_layout)
            }
            x => todo!("the expression, {:?}", x),
        }
    }

    /// build_run_low_level builds the low level opertation and outputs to the specified symbol.
    /// The builder must keep track of the symbol because it may be referred to later.
    fn build_run_low_level(
        &mut self,
        sym: &Symbol,
        lowlevel: &LowLevel,
        args: &'a [Symbol],
        arg_layouts: &[InLayout<'a>],
        ret_layout: &InLayout<'a>,
    ) {
        // Now that the arguments are needed, load them if they are literals.
        self.load_literal_symbols(args);
        match lowlevel {
            LowLevel::NumAbs => {
                debug_assert_eq!(
                    1,
                    args.len(),
                    "NumAbs: expected to have exactly one argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], *ret_layout,
                    "NumAbs: expected to have the same argument and return layout"
                );
                self.build_num_abs(sym, &args[0], ret_layout)
            }
            LowLevel::NumAdd => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumAdd: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumAdd: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    arg_layouts[0], *ret_layout,
                    "NumAdd: expected to have the same argument and return layout"
                );
                self.build_num_add(sym, &args[0], &args[1], ret_layout)
            }
            LowLevel::NumAddChecked => {
                self.build_num_add_checked(sym, &args[0], &args[1], &arg_layouts[0], ret_layout)
            }
            LowLevel::NumSubChecked => {
                self.build_num_sub_checked(sym, &args[0], &args[1], &arg_layouts[0], ret_layout)
            }
            LowLevel::NumAcos => self.build_fn_call(
                sym,
                bitcode::NUM_ACOS[FloatWidth::F64].to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::NumAsin => self.build_fn_call(
                sym,
                bitcode::NUM_ASIN[FloatWidth::F64].to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::NumAtan => self.build_fn_call(
                sym,
                bitcode::NUM_ATAN[FloatWidth::F64].to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::NumMul => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumMul: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumMul: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    arg_layouts[0], *ret_layout,
                    "NumMul: expected to have the same argument and return layout"
                );
                self.build_num_mul(sym, &args[0], &args[1], ret_layout)
            }
            LowLevel::NumDivTruncUnchecked | LowLevel::NumDivFrac => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumDiv: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumDiv: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    arg_layouts[0], *ret_layout,
                    "NumDiv: expected to have the same argument and return layout"
                );
                self.build_num_div(sym, &args[0], &args[1], ret_layout)
            }
            LowLevel::NumNeg => {
                debug_assert_eq!(
                    1,
                    args.len(),
                    "NumNeg: expected to have exactly one argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], *ret_layout,
                    "NumNeg: expected to have the same argument and return layout"
                );
                self.build_num_neg(sym, &args[0], ret_layout)
            }
            LowLevel::NumPowInt => self.build_fn_call(
                sym,
                bitcode::NUM_POW_INT[IntWidth::I64].to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::NumSub => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumSub: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumSub: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    arg_layouts[0], *ret_layout,
                    "NumSub: expected to have the same argument and return layout"
                );
                self.build_num_sub(sym, &args[0], &args[1], ret_layout)
            }
            LowLevel::NumSubWrap => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumSubWrap: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumSubWrap: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    arg_layouts[0], *ret_layout,
                    "NumSubWrap: expected to have the same argument and return layout"
                );
                self.build_num_sub_wrap(sym, &args[0], &args[1], ret_layout)
            }
            LowLevel::NumSubSaturated => match self.interner().get(*ret_layout) {
                Layout::Builtin(Builtin::Int(int_width)) => self.build_fn_call(
                    sym,
                    bitcode::NUM_SUB_SATURATED_INT[int_width].to_string(),
                    args,
                    arg_layouts,
                    ret_layout,
                ),
                Layout::Builtin(Builtin::Float(FloatWidth::F32)) => {
                    self.build_num_sub(sym, &args[0], &args[1], ret_layout)
                }
                Layout::Builtin(Builtin::Float(FloatWidth::F64)) => {
                    // saturated sub is just normal sub
                    self.build_num_sub(sym, &args[0], &args[1], ret_layout)
                }
                Layout::Builtin(Builtin::Decimal) => {
                    // self.load_args_and_call_zig(backend, bitcode::DEC_SUB_SATURATED)
                    todo!()
                }
                _ => internal_error!("invalid return type"),
            },
            LowLevel::NumBitwiseAnd => {
                if let Layout::Builtin(Builtin::Int(int_width)) = self.interner().get(*ret_layout) {
                    self.build_int_bitwise_and(sym, &args[0], &args[1], int_width)
                } else {
                    internal_error!("bitwise and on a non-integer")
                }
            }
            LowLevel::NumBitwiseOr => {
                if let Layout::Builtin(Builtin::Int(int_width)) = self.interner().get(*ret_layout) {
                    self.build_int_bitwise_or(sym, &args[0], &args[1], int_width)
                } else {
                    internal_error!("bitwise or on a non-integer")
                }
            }
            LowLevel::NumBitwiseXor => {
                if let Layout::Builtin(Builtin::Int(int_width)) = self.interner().get(*ret_layout) {
                    self.build_int_bitwise_xor(sym, &args[0], &args[1], int_width)
                } else {
                    internal_error!("bitwise xor on a non-integer")
                }
            }
            LowLevel::And => {
                if let Layout::Builtin(Builtin::Bool) = self.interner().get(*ret_layout) {
                    self.build_int_bitwise_and(sym, &args[0], &args[1], IntWidth::U8)
                } else {
                    internal_error!("bitwise and on a non-integer")
                }
            }
            LowLevel::Or => {
                if let Layout::Builtin(Builtin::Bool) = self.interner().get(*ret_layout) {
                    self.build_int_bitwise_or(sym, &args[0], &args[1], IntWidth::U8)
                } else {
                    internal_error!("bitwise or on a non-integer")
                }
            }
            LowLevel::NumShiftLeftBy => {
                if let Layout::Builtin(Builtin::Int(int_width)) = self.interner().get(*ret_layout) {
                    self.build_int_shift_left(sym, &args[0], &args[1], int_width)
                } else {
                    internal_error!("shift left on a non-integer")
                }
            }
            LowLevel::NumShiftRightBy => {
                if let Layout::Builtin(Builtin::Int(int_width)) = self.interner().get(*ret_layout) {
                    self.build_int_shift_right(sym, &args[0], &args[1], int_width)
                } else {
                    internal_error!("shift right on a non-integer")
                }
            }
            LowLevel::NumShiftRightZfBy => {
                if let Layout::Builtin(Builtin::Int(int_width)) = self.interner().get(*ret_layout) {
                    self.build_int_shift_right_zero_fill(sym, &args[0], &args[1], int_width)
                } else {
                    internal_error!("shift right zero-fill on a non-integer")
                }
            }
            LowLevel::Eq => {
                debug_assert_eq!(2, args.len(), "Eq: expected to have exactly two argument");
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "Eq: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    Layout::BOOL,
                    *ret_layout,
                    "Eq: expected to have return layout of type Bool"
                );
                self.build_eq(sym, &args[0], &args[1], &arg_layouts[0])
            }
            LowLevel::NotEq => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NotEq: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NotEq: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    Layout::BOOL,
                    *ret_layout,
                    "NotEq: expected to have return layout of type Bool"
                );
                self.build_neq(sym, &args[0], &args[1], &arg_layouts[0])
            }
            LowLevel::Not => {
                debug_assert_eq!(1, args.len(), "Not: expected to have exactly one argument");
                debug_assert_eq!(
                    Layout::BOOL,
                    *ret_layout,
                    "Not: expected to have return layout of type Bool"
                );
                self.build_not(sym, &args[0], &arg_layouts[0])
            }
            LowLevel::NumLt => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumLt: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumLt: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    Layout::BOOL,
                    *ret_layout,
                    "NumLt: expected to have return layout of type Bool"
                );
                self.build_num_lt(sym, &args[0], &args[1], &arg_layouts[0])
            }
            LowLevel::NumGt => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumGt: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumGt: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    Layout::BOOL,
                    *ret_layout,
                    "NumGt: expected to have return layout of type Bool"
                );
                self.build_num_gt(sym, &args[0], &args[1], &arg_layouts[0])
            }
            LowLevel::NumToFrac => {
                debug_assert_eq!(
                    1,
                    args.len(),
                    "NumToFrac: expected to have exactly one argument"
                );

                debug_assert!(
                    matches!(*ret_layout, Layout::F32 | Layout::F64),
                    "NumToFrac: expected to have return layout of type Float"
                );
                self.build_num_to_frac(sym, &args[0], &arg_layouts[0], ret_layout)
            }
            LowLevel::NumLte => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumLte: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumLte: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    Layout::BOOL,
                    *ret_layout,
                    "NumLte: expected to have return layout of type Bool"
                );
                self.build_num_lte(sym, &args[0], &args[1], &arg_layouts[0])
            }
            LowLevel::NumGte => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "NumGte: expected to have exactly two argument"
                );
                debug_assert_eq!(
                    arg_layouts[0], arg_layouts[1],
                    "NumGte: expected all arguments of to have the same layout"
                );
                debug_assert_eq!(
                    Layout::BOOL,
                    *ret_layout,
                    "NumGte: expected to have return layout of type Bool"
                );
                self.build_num_gte(sym, &args[0], &args[1], &arg_layouts[0])
            }
            LowLevel::NumLogUnchecked => {
                let float_width = match arg_layouts[0] {
                    Layout::F64 => FloatWidth::F64,
                    Layout::F32 => FloatWidth::F32,
                    _ => unreachable!("invalid layout for sqrt"),
                };

                self.build_fn_call(
                    sym,
                    bitcode::NUM_LOG[float_width].to_string(),
                    args,
                    arg_layouts,
                    ret_layout,
                )
            }
            LowLevel::NumSqrtUnchecked => {
                let float_width = match arg_layouts[0] {
                    Layout::F64 => FloatWidth::F64,
                    Layout::F32 => FloatWidth::F32,
                    _ => unreachable!("invalid layout for sqrt"),
                };

                self.build_num_sqrt(*sym, args[0], float_width);
            }
            LowLevel::NumRound => self.build_fn_call(
                sym,
                bitcode::NUM_ROUND_F64[IntWidth::I64].to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::ListLen => {
                debug_assert_eq!(
                    1,
                    args.len(),
                    "ListLen: expected to have exactly one argument"
                );
                self.build_list_len(sym, &args[0])
            }
            LowLevel::ListWithCapacity => {
                debug_assert_eq!(
                    1,
                    args.len(),
                    "ListWithCapacity: expected to have exactly one argument"
                );
                let elem_layout = list_element_layout!(self.interner(), *ret_layout);
                self.build_list_with_capacity(sym, args[0], arg_layouts[0], elem_layout, ret_layout)
            }
            LowLevel::ListReserve => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "ListReserve: expected to have exactly two arguments"
                );
                self.build_list_reserve(sym, args, arg_layouts, ret_layout)
            }
            LowLevel::ListAppendUnsafe => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "ListAppendUnsafe: expected to have exactly two arguments"
                );
                self.build_list_append_unsafe(sym, args, arg_layouts, ret_layout)
            }
            LowLevel::ListGetUnsafe => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "ListGetUnsafe: expected to have exactly two arguments"
                );
                self.build_list_get_unsafe(sym, &args[0], &args[1], ret_layout)
            }
            LowLevel::ListReplaceUnsafe => {
                debug_assert_eq!(
                    3,
                    args.len(),
                    "ListReplaceUnsafe: expected to have exactly three arguments"
                );
                self.build_list_replace_unsafe(sym, args, arg_layouts, ret_layout)
            }
            LowLevel::ListConcat => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "ListConcat: expected to have exactly two arguments"
                );
                let elem_layout = list_element_layout!(self.interner(), *ret_layout);
                self.build_list_concat(sym, args, arg_layouts, elem_layout, ret_layout)
            }
            LowLevel::ListPrepend => {
                debug_assert_eq!(
                    2,
                    args.len(),
                    "ListPrepend: expected to have exactly two arguments"
                );
                self.build_list_prepend(sym, args, arg_layouts, ret_layout)
            }
            LowLevel::StrConcat => self.build_fn_call(
                sym,
                bitcode::STR_CONCAT.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrJoinWith => self.build_fn_call(
                sym,
                bitcode::STR_JOIN_WITH.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrSplit => self.build_fn_call(
                sym,
                bitcode::STR_SPLIT.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrStartsWith => self.build_fn_call(
                sym,
                bitcode::STR_STARTS_WITH.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrStartsWithScalar => self.build_fn_call(
                sym,
                bitcode::STR_STARTS_WITH_SCALAR.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrAppendScalar => self.build_fn_call(
                sym,
                bitcode::STR_APPEND_SCALAR.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrEndsWith => self.build_fn_call(
                sym,
                bitcode::STR_ENDS_WITH.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrCountGraphemes => self.build_fn_call(
                sym,
                bitcode::STR_COUNT_GRAPEHEME_CLUSTERS.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrSubstringUnsafe => self.build_fn_call(
                sym,
                bitcode::STR_SUBSTRING_UNSAFE.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrToUtf8 => self.build_fn_call(
                sym,
                bitcode::STR_TO_UTF8.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrCountUtf8Bytes => self.build_fn_call(
                sym,
                bitcode::STR_COUNT_UTF8_BYTES.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrFromUtf8Range => self.build_fn_call(
                sym,
                bitcode::STR_FROM_UTF8_RANGE.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            //            LowLevel::StrToUtf8 => self.build_fn_call(
            //                sym,
            //                bitcode::STR_TO_UTF8.to_string(),
            //                args,
            //                arg_layouts,
            //                ret_layout,
            //            ),
            LowLevel::StrRepeat => self.build_fn_call(
                sym,
                bitcode::STR_REPEAT.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrTrim => self.build_fn_call(
                sym,
                bitcode::STR_TRIM.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrTrimLeft => self.build_fn_call(
                sym,
                bitcode::STR_TRIM_LEFT.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrTrimRight => self.build_fn_call(
                sym,
                bitcode::STR_TRIM_RIGHT.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrReserve => self.build_fn_call(
                sym,
                bitcode::STR_RESERVE.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrWithCapacity => self.build_fn_call(
                sym,
                bitcode::STR_WITH_CAPACITY.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrToScalars => self.build_fn_call(
                sym,
                bitcode::STR_TO_SCALARS.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrGetUnsafe => self.build_fn_call(
                sym,
                bitcode::STR_GET_UNSAFE.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrGetScalarUnsafe => self.build_fn_call(
                sym,
                bitcode::STR_GET_SCALAR_UNSAFE.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::StrToNum => {
                let number_layout = match self.interner().get(*ret_layout) {
                    Layout::Struct { field_layouts, .. } => field_layouts[0], // TODO: why is it sometimes a struct?
                    _ => unreachable!(),
                };

                // match on the return layout to figure out which zig builtin we need
                let intrinsic = match self.interner().get(number_layout) {
                    Layout::Builtin(Builtin::Int(int_width)) => &bitcode::STR_TO_INT[int_width],
                    Layout::Builtin(Builtin::Float(float_width)) => {
                        &bitcode::STR_TO_FLOAT[float_width]
                    }
                    Layout::Builtin(Builtin::Decimal) => bitcode::DEC_FROM_STR,
                    _ => unreachable!(),
                };

                self.build_fn_call(sym, intrinsic.to_string(), args, arg_layouts, ret_layout)
            }
            LowLevel::PtrCast => {
                debug_assert_eq!(
                    1,
                    args.len(),
                    "RefCountGetPtr: expected to have exactly one argument"
                );
                self.build_ptr_cast(sym, &args[0])
            }
            LowLevel::RefCountDec => self.build_fn_call(
                sym,
                bitcode::UTILS_DECREF.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            LowLevel::RefCountInc => self.build_fn_call(
                sym,
                bitcode::UTILS_INCREF.to_string(),
                args,
                arg_layouts,
                ret_layout,
            ),
            x => todo!("low level, {:?}", x),
        }
    }

    /// Builds a builtin functions that do not map directly to a low level
    /// If the builtin is simple enough, it will be inlined.
    fn build_builtin(
        &mut self,
        sym: &Symbol,
        func_sym: Symbol,
        args: &'a [Symbol],
        arg_layouts: &[InLayout<'a>],
        ret_layout: &InLayout<'a>,
    ) {
        match func_sym {
            Symbol::NUM_IS_ZERO => {
                debug_assert_eq!(
                    1,
                    args.len(),
                    "NumIsZero: expected to have exactly one argument"
                );
                debug_assert_eq!(
                    Layout::BOOL,
                    *ret_layout,
                    "NumIsZero: expected to have return layout of type Bool"
                );

                self.load_literal_symbols(args);
                self.load_literal(
                    &Symbol::DEV_TMP,
                    &arg_layouts[0],
                    &Literal::Int(0i128.to_ne_bytes()),
                );
                self.build_eq(sym, &args[0], &Symbol::DEV_TMP, &arg_layouts[0]);
                self.free_symbol(&Symbol::DEV_TMP)
            }
            Symbol::LIST_GET | Symbol::LIST_SET | Symbol::LIST_REPLACE | Symbol::LIST_APPEND => {
                // TODO: This is probably simple enough to be worth inlining.
                let fn_name = self.function_symbol_to_string(
                    func_sym,
                    arg_layouts.iter().copied(),
                    None,
                    *ret_layout,
                );
                // Now that the arguments are needed, load them if they are literals.
                self.load_literal_symbols(args);
                self.build_fn_call(sym, fn_name, args, arg_layouts, ret_layout)
            }
            Symbol::BOOL_TRUE => {
                let bool_layout = Layout::BOOL;
                self.load_literal(&Symbol::DEV_TMP, &bool_layout, &Literal::Bool(true));
                self.return_symbol(&Symbol::DEV_TMP, &bool_layout);
                self.free_symbol(&Symbol::DEV_TMP)
            }
            Symbol::BOOL_FALSE => {
                let bool_layout = Layout::BOOL;
                self.load_literal(&Symbol::DEV_TMP, &bool_layout, &Literal::Bool(false));
                self.return_symbol(&Symbol::DEV_TMP, &bool_layout);
                self.free_symbol(&Symbol::DEV_TMP)
            }
            Symbol::STR_IS_VALID_SCALAR => {
                // just call the function
                let fn_name = self.function_symbol_to_string(
                    func_sym,
                    arg_layouts.iter().copied(),
                    None,
                    *ret_layout,
                );
                // Now that the arguments are needed, load them if they are literals.
                self.load_literal_symbols(args);
                self.build_fn_call(sym, fn_name, args, arg_layouts, ret_layout)
            }
            other => {
                eprintln!("maybe {other:?} should have a custom implementation?");

                // just call the function
                let fn_name = self.function_symbol_to_string(
                    func_sym,
                    arg_layouts.iter().copied(),
                    None,
                    *ret_layout,
                );
                // Now that the arguments are needed, load them if they are literals.
                self.load_literal_symbols(args);
                self.build_fn_call(sym, fn_name, args, arg_layouts, ret_layout)
            }
        }
    }

    /// build_fn_call creates a call site for a function.
    /// This includes dealing with things like saving regs and propagating the returned value.
    fn build_fn_call(
        &mut self,
        dst: &Symbol,
        fn_name: String,
        args: &[Symbol],
        arg_layouts: &[InLayout<'a>],
        ret_layout: &InLayout<'a>,
    );

    /// Move a returned value into `dst`
    fn move_return_value(&mut self, dst: &Symbol, ret_layout: &InLayout<'a>);

    /// build_num_abs stores the absolute value of src into dst.
    fn build_num_abs(&mut self, dst: &Symbol, src: &Symbol, layout: &InLayout<'a>);

    /// build_num_add stores the sum of src1 and src2 into dst.
    fn build_num_add(&mut self, dst: &Symbol, src1: &Symbol, src2: &Symbol, layout: &InLayout<'a>);

    /// build_num_add_checked stores the sum of src1 and src2 into dst.
    fn build_num_add_checked(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        num_layout: &InLayout<'a>,
        return_layout: &InLayout<'a>,
    );

    /// build_num_sub_checked stores the sum of src1 and src2 into dst.
    fn build_num_sub_checked(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        num_layout: &InLayout<'a>,
        return_layout: &InLayout<'a>,
    );

    /// build_num_mul stores `src1 * src2` into dst.
    fn build_num_mul(&mut self, dst: &Symbol, src1: &Symbol, src2: &Symbol, layout: &InLayout<'a>);

    /// build_num_mul stores `src1 / src2` into dst.
    fn build_num_div(&mut self, dst: &Symbol, src1: &Symbol, src2: &Symbol, layout: &InLayout<'a>);

    /// build_num_neg stores the negated value of src into dst.
    fn build_num_neg(&mut self, dst: &Symbol, src: &Symbol, layout: &InLayout<'a>);

    /// build_num_sub stores the `src1 - src2` difference into dst.
    fn build_num_sub(&mut self, dst: &Symbol, src1: &Symbol, src2: &Symbol, layout: &InLayout<'a>);

    /// build_num_sub_wrap stores the `src1 - src2` difference into dst.
    fn build_num_sub_wrap(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        layout: &InLayout<'a>,
    );

    /// stores the `src1 & src2` into dst.
    fn build_int_bitwise_and(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        int_width: IntWidth,
    );

    /// stores the `src1 | src2` into dst.
    fn build_int_bitwise_or(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        int_width: IntWidth,
    );

    /// stores the `src1 ^ src2` into dst.
    fn build_int_bitwise_xor(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        int_width: IntWidth,
    );

    /// stores the `Num.shiftLeftBy src1 src2` into dst.
    fn build_int_shift_left(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        int_width: IntWidth,
    );

    /// stores the `Num.shiftRightBy src1 src2` into dst.
    fn build_int_shift_right(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        int_width: IntWidth,
    );

    /// stores the `Num.shiftRightZfBy src1 src2` into dst.
    fn build_int_shift_right_zero_fill(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        int_width: IntWidth,
    );

    /// build_eq stores the result of `src1 == src2` into dst.
    fn build_eq(&mut self, dst: &Symbol, src1: &Symbol, src2: &Symbol, arg_layout: &InLayout<'a>);

    /// build_neq stores the result of `src1 != src2` into dst.
    fn build_neq(&mut self, dst: &Symbol, src1: &Symbol, src2: &Symbol, arg_layout: &InLayout<'a>);

    /// build_not stores the result of `!src` into dst.
    fn build_not(&mut self, dst: &Symbol, src: &Symbol, arg_layout: &InLayout<'a>);

    /// build_num_lt stores the result of `src1 < src2` into dst.
    fn build_num_lt(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        arg_layout: &InLayout<'a>,
    );

    /// build_num_gt stores the result of `src1 > src2` into dst.
    fn build_num_gt(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        arg_layout: &InLayout<'a>,
    );

    /// build_num_to_frac convert Number to Frac
    fn build_num_to_frac(
        &mut self,
        dst: &Symbol,
        src: &Symbol,
        arg_layout: &InLayout<'a>,
        ret_layout: &InLayout<'a>,
    );

    /// build_num_lte stores the result of `src1 <= src2` into dst.
    fn build_num_lte(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        arg_layout: &InLayout<'a>,
    );

    /// build_num_gte stores the result of `src1 >= src2` into dst.
    fn build_num_gte(
        &mut self,
        dst: &Symbol,
        src1: &Symbol,
        src2: &Symbol,
        arg_layout: &InLayout<'a>,
    );

    /// build_sqrt stores the result of `sqrt(src)` into dst.
    fn build_num_sqrt(&mut self, dst: Symbol, src: Symbol, float_width: FloatWidth);

    /// build_list_len returns the length of a list.
    fn build_list_len(&mut self, dst: &Symbol, list: &Symbol);

    /// build_list_with_capacity creates and returns a list with the given capacity.
    fn build_list_with_capacity(
        &mut self,
        dst: &Symbol,
        capacity: Symbol,
        capacity_layout: InLayout<'a>,
        elem_layout: InLayout<'a>,
        ret_layout: &InLayout<'a>,
    );

    /// build_list_reserve enlarges a list to at least accommodate the given capacity.
    fn build_list_reserve(
        &mut self,
        dst: &Symbol,
        args: &'a [Symbol],
        arg_layouts: &[InLayout<'a>],
        ret_layout: &InLayout<'a>,
    );

    /// build_list_append_unsafe returns a new list with a given element appended.
    fn build_list_append_unsafe(
        &mut self,
        dst: &Symbol,
        args: &'a [Symbol],
        arg_layouts: &[InLayout<'a>],
        ret_layout: &InLayout<'a>,
    );

    /// build_list_get_unsafe loads the element from the list at the index.
    fn build_list_get_unsafe(
        &mut self,
        dst: &Symbol,
        list: &Symbol,
        index: &Symbol,
        ret_layout: &InLayout<'a>,
    );

    /// build_list_replace_unsafe returns the old element and new list with the list having the new element inserted.
    fn build_list_replace_unsafe(
        &mut self,
        dst: &Symbol,
        args: &'a [Symbol],
        arg_layouts: &[InLayout<'a>],
        ret_layout: &InLayout<'a>,
    );

    /// build_list_concat returns a new list containing the two argument lists concatenated.
    fn build_list_concat(
        &mut self,
        dst: &Symbol,
        args: &'a [Symbol],
        arg_layouts: &[InLayout<'a>],
        elem_layout: InLayout<'a>,
        ret_layout: &InLayout<'a>,
    );

    /// build_list_prepend returns a new list with a given element prepended.
    fn build_list_prepend(
        &mut self,
        dst: &Symbol,
        args: &'a [Symbol],
        arg_layouts: &[InLayout<'a>],
        ret_layout: &InLayout<'a>,
    );

    /// build_refcount_getptr loads the pointer to the reference count of src into dst.
    fn build_ptr_cast(&mut self, dst: &Symbol, src: &Symbol);

    /// literal_map gets the map from symbol to literal and layout, used for lazy loading and literal folding.
    fn literal_map(&mut self) -> &mut MutMap<Symbol, (*const Literal<'a>, *const InLayout<'a>)>;

    fn load_literal_symbols(&mut self, syms: &[Symbol]) {
        if self.env().lazy_literals {
            for sym in syms {
                if let Some((lit, layout)) = self.literal_map().remove(sym) {
                    // This operation is always safe but complicates lifetimes.
                    // The map is reset when building a procedure and then used for that single procedure.
                    // Since the lifetime is shorter than the entire backend, we need to use a pointer.
                    let (lit, layout) = unsafe { (*lit, *layout) };
                    self.load_literal(sym, &layout, &lit);
                }
            }
        }
    }

    /// load_literal sets a symbol to be equal to a literal.
    fn load_literal(&mut self, sym: &Symbol, layout: &InLayout<'a>, lit: &Literal<'a>);

    /// create_empty_array creates an empty array with nullptr, zero length, and zero capacity.
    fn create_empty_array(&mut self, sym: &Symbol);

    /// create_array creates an array filling it with the specified objects.
    fn create_array(
        &mut self,
        sym: &Symbol,
        elem_layout: &InLayout<'a>,
        elems: &'a [ListLiteralElement<'a>],
    );

    /// create_struct creates a struct with the elements specified loaded into it as data.
    fn create_struct(&mut self, sym: &Symbol, layout: &InLayout<'a>, fields: &'a [Symbol]);

    /// load_struct_at_index loads into `sym` the value at `index` in `structure`.
    fn load_struct_at_index(
        &mut self,
        sym: &Symbol,
        structure: &Symbol,
        index: u64,
        field_layouts: &'a [InLayout<'a>],
    );

    /// load_union_at_index loads into `sym` the value at `index` for `tag_id`.
    fn load_union_at_index(
        &mut self,
        sym: &Symbol,
        structure: &Symbol,
        tag_id: TagIdIntType,
        index: u64,
        union_layout: &UnionLayout<'a>,
    );

    /// get_tag_id loads the tag id from a the union.
    fn get_tag_id(&mut self, sym: &Symbol, structure: &Symbol, union_layout: &UnionLayout<'a>);

    /// tag sets the tag for a union.
    fn tag(
        &mut self,
        sym: &Symbol,
        args: &'a [Symbol],
        tag_layout: &UnionLayout<'a>,
        tag_id: TagIdIntType,
    );

    /// load a value from a pointer
    fn expr_unbox(&mut self, sym: Symbol, ptr: Symbol, element_layout: InLayout<'a>);

    /// store a refcounted value on the heap
    fn expr_box(&mut self, sym: Symbol, value: Symbol, element_layout: InLayout<'a>);

    /// return_symbol moves a symbol to the correct return location for the backend and adds a jump to the end of the function.
    fn return_symbol(&mut self, sym: &Symbol, layout: &InLayout<'a>);

    /// free_symbols will free all symbols for the given statement.
    fn free_symbols(&mut self, stmt: &Stmt<'a>) {
        if let Some(syms) = self.free_map().remove(&(stmt as *const Stmt<'a>)) {
            for sym in syms {
                // println!("Freeing symbol: {:?}", sym);
                self.free_symbol(&sym);
            }
        }
    }

    /// free_symbol frees any registers or stack space used to hold a symbol.
    fn free_symbol(&mut self, sym: &Symbol);

    /// set_last_seen sets the statement a symbol was last seen in.
    fn set_last_seen(&mut self, sym: Symbol, stmt: &Stmt<'a>) {
        self.last_seen_map().insert(sym, stmt);
    }

    /// last_seen_map gets the map from symbol to when it is last seen in the function.
    fn last_seen_map(&mut self) -> &mut MutMap<Symbol, *const Stmt<'a>>;

    /// set_layout_map sets the layout for a specific symbol.
    fn set_layout_map(&mut self, sym: Symbol, layout: &InLayout<'a>) {
        if let Some(old_layout) = self.layout_map().insert(sym, *layout) {
            // Layout map already contains the symbol. We should never need to overwrite.
            // If the layout is not the same, that is a bug.
            if &old_layout != layout {
                internal_error!(
                    "Overwriting layout for symbol, {:?}: got {:?}, want {:?}",
                    sym,
                    layout,
                    old_layout
                )
            }
        }
    }

    /// layout_map gets the map from symbol to layout.
    fn layout_map(&mut self) -> &mut MutMap<Symbol, InLayout<'a>>;

    fn create_free_map(&mut self) {
        let mut free_map = MutMap::default();
        let arena = self.env().arena;
        for (sym, stmt) in self.last_seen_map() {
            let vals = free_map
                .entry(*stmt)
                .or_insert_with(|| bumpalo::vec![in arena]);
            vals.push(*sym);
        }
        self.set_free_map(free_map);
    }

    /// free_map gets the map statement to the symbols that are free after they run.
    fn free_map(&mut self) -> &mut MutMap<*const Stmt<'a>, Vec<'a, Symbol>>;

    /// set_free_map sets the free map to the given map.
    fn set_free_map(&mut self, map: MutMap<*const Stmt<'a>, Vec<'a, Symbol>>);

    /// scan_ast runs through the ast and fill the last seen map.
    /// This must iterate through the ast in the same way that build_stmt does. i.e. then before else.
    fn scan_ast(&mut self, stmt: &Stmt<'a>) {
        // Join map keeps track of join point parameters so that we can keep them around while they still might be jumped to.
        let mut join_map: MutMap<JoinPointId, &'a [Param<'a>]> = MutMap::default();
        match stmt {
            Stmt::Let(sym, expr, _, following) => {
                self.set_last_seen(*sym, stmt);
                match expr {
                    Expr::Literal(_) => {}
                    Expr::NullPointer => {}

                    Expr::Call(call) => self.scan_ast_call(call, stmt),

                    Expr::Tag { arguments, .. } => {
                        for sym in *arguments {
                            self.set_last_seen(*sym, stmt);
                        }
                    }
                    Expr::ExprBox { symbol } => {
                        self.set_last_seen(*symbol, stmt);
                    }
                    Expr::ExprUnbox { symbol } => {
                        self.set_last_seen(*symbol, stmt);
                    }
                    Expr::Struct(syms) => {
                        for sym in *syms {
                            self.set_last_seen(*sym, stmt);
                        }
                    }
                    Expr::StructAtIndex { structure, .. } => {
                        self.set_last_seen(*structure, stmt);
                    }
                    Expr::GetTagId { structure, .. } => {
                        self.set_last_seen(*structure, stmt);
                    }
                    Expr::UnionAtIndex { structure, .. } => {
                        self.set_last_seen(*structure, stmt);
                    }
                    Expr::Array { elems, .. } => {
                        for elem in *elems {
                            if let ListLiteralElement::Symbol(sym) = elem {
                                self.set_last_seen(*sym, stmt);
                            }
                        }
                    }
                    Expr::Reuse {
                        symbol, arguments, ..
                    } => {
                        self.set_last_seen(*symbol, stmt);
                        for sym in *arguments {
                            self.set_last_seen(*sym, stmt);
                        }
                    }
                    Expr::Reset { symbol, .. } | Expr::ResetRef { symbol, .. } => {
                        self.set_last_seen(*symbol, stmt);
                    }
                    Expr::EmptyArray => {}
                    Expr::RuntimeErrorFunction(_) => {}
                }
                self.scan_ast(following);
            }

            Stmt::Switch {
                cond_symbol,
                branches,
                default_branch,
                ..
            } => {
                self.set_last_seen(*cond_symbol, stmt);
                for (_, _, branch) in *branches {
                    self.scan_ast(branch);
                }
                self.scan_ast(default_branch.1);
            }
            Stmt::Ret(sym) => {
                self.set_last_seen(*sym, stmt);
            }
            Stmt::Refcounting(modify, following) => {
                let sym = modify.get_symbol();

                self.set_last_seen(sym, stmt);
                self.scan_ast(following);
            }
            Stmt::Join {
                parameters,
                body: continuation,
                remainder,
                id: JoinPointId(sym),
                ..
            } => {
                self.set_last_seen(*sym, stmt);
                join_map.insert(JoinPointId(*sym), parameters);
                for param in *parameters {
                    self.set_last_seen(param.symbol, stmt);
                }
                self.scan_ast(remainder);
                self.scan_ast(continuation);
            }
            Stmt::Jump(JoinPointId(sym), symbols) => {
                if let Some(parameters) = join_map.get(&JoinPointId(*sym)) {
                    // Keep the parameters around. They will be overwritten when jumping.
                    for param in *parameters {
                        self.set_last_seen(param.symbol, stmt);
                    }
                }
                for sym in *symbols {
                    self.set_last_seen(*sym, stmt);
                }
            }

            Stmt::Dbg { .. } => todo!("dbg not implemented in the dev backend"),
            Stmt::Expect { .. } => todo!("expect is not implemented in the dev backend"),
            Stmt::ExpectFx { .. } => todo!("expect-fx is not implemented in the dev backend"),

            Stmt::Crash(..) => todo!("crash is not implemented in the dev backend"),
        }
    }

    fn scan_ast_call(&mut self, call: &roc_mono::ir::Call, stmt: &roc_mono::ir::Stmt<'a>) {
        let roc_mono::ir::Call {
            call_type,
            arguments,
        } = call;

        for sym in *arguments {
            self.set_last_seen(*sym, stmt);
        }

        match call_type {
            CallType::ByName { .. } => {}
            CallType::LowLevel { .. } => {}
            CallType::HigherOrder { .. } => {}
            CallType::Foreign { .. } => {}
        }
    }
}