roc/compiler/mono/src/alias_analysis.rs

use morphic_lib::TypeContext;
use morphic_lib::{
    BlockExpr, BlockId, CalleeSpecVar, FuncDef, FuncDefBuilder, FuncName, ModName, Result, TypeId,
    TypeName, UpdateModeVar, ValueId,
};
use roc_collections::all::MutMap;
use roc_module::low_level::LowLevel;
use roc_module::symbol::Symbol;
use std::convert::TryFrom;

use crate::ir::{Call, CallType, Expr, Literal, Proc, Stmt};
use crate::layout::{Builtin, Layout, ListLayout, UnionLayout};

// just using one module for now
const MOD_LIST: ModName = ModName(b"UserApp");
const MOD_APP: ModName = ModName(b"UserApp");

pub fn proc_spec(proc: &Proc) -> Result<FuncDef> {
    let mut builder = FuncDefBuilder::new();
    let mut env = Env::default();

    let block = builder.add_block();

    // introduce the arguments
    let mut argument_layouts = Vec::new();
    for (i, (layout, symbol)) in proc.args.iter().enumerate() {
        let value_id = builder.add_get_tuple_field(block, morphic_lib::ARG_VALUE_ID, i as u32)?;
        env.symbols.insert(*symbol, value_id);

        argument_layouts.push(*layout);
    }

    let value_id = stmt_spec(&mut builder, &mut env, block, &proc.ret_layout, &proc.body)?;

    let root = BlockExpr(block, value_id);
    let arg_type_id = layout_spec(&mut builder, &Layout::Struct(&argument_layouts))?;
    let ret_type_id = layout_spec(&mut builder, &proc.ret_layout)?;
    builder.build(arg_type_id, ret_type_id, root)
}

#[derive(Default)]
struct Env {
    symbols: MutMap<Symbol, ValueId>,
    join_points: MutMap<crate::ir::JoinPointId, morphic_lib::JoinPointId>,
}

fn stmt_spec(
    builder: &mut FuncDefBuilder,
    env: &mut Env,
    block: BlockId,
    layout: &Layout,
    stmt: &Stmt,
) -> Result<ValueId> {
    use Stmt::*;

    match stmt {
        Let(symbol, expr, layout, continuation) => {
            let value_id = expr_spec(builder, env, block, layout, expr)?;
            env.symbols.insert(*symbol, value_id);
            let result = stmt_spec(builder, env, block, layout, continuation)?;
            env.symbols.remove(symbol);

            Ok(result)
        }
        Invoke {
            symbol,
            call,
            layout: call_layout,
            pass,
            fail,
        } => {
            // a call that might throw an exception

            let value_id = call_spec(builder, env, block, call_layout, call)?;

            let pass_block = builder.add_block();
            env.symbols.insert(*symbol, value_id);
            let pass_value_id = stmt_spec(builder, env, pass_block, layout, pass)?;
            env.symbols.remove(symbol);
            let pass_block_expr = BlockExpr(pass_block, pass_value_id);

            let fail_block = builder.add_block();
            let fail_value_id = stmt_spec(builder, env, fail_block, layout, fail)?;
            let fail_block_expr = BlockExpr(fail_block, fail_value_id);

            builder.add_choice(block, &[pass_block_expr, fail_block_expr])
        }
        Switch {
            cond_symbol: _,
            cond_layout: _,
            branches,
            default_branch,
            ret_layout,
        } => {
            // NOTE should we touch the cond_symbol here? it is always an integer, but the
            // cond_symbol might be unused if we don't somehow "use" it here

            let mut cases = Vec::with_capacity(branches.len() + 1);

            let it = branches
                .iter()
                .map(|(_, _, body)| body)
                .chain(std::iter::once(default_branch.1));

            for branch in it {
                let block = builder.add_block();
                let value_id = stmt_spec(builder, env, block, ret_layout, branch)?;
                cases.push(BlockExpr(block, value_id));
            }

            builder.add_choice(block, &cases)
        }
        Ret(symbol) => Ok(env.symbols[symbol]),
        Refcounting(_, _) => unreachable!("not yet introduced"),
        Join {
            id,
            parameters,
            continuation,
            remainder,
        } => {
            let mut type_ids = Vec::new();

            for p in parameters.iter() {
                type_ids.push(layout_spec(builder, &p.layout)?);
            }

            let ret_type_id = layout_spec(builder, layout)?;

            let jp_arg_type_id = builder.add_tuple_type(&type_ids)?;
            // NOTE just one value_id is returned, but we need the ids of the individual arguments!
            // symbols bound by the join point won't be defined right now!
            let (jpid, jp_argument) =
                builder.declare_join_point(block, jp_arg_type_id, ret_type_id)?;

            env.join_points.insert(*id, jpid);
            let jp_body_block = builder.add_block();

            // unpack the argument
            for (i, p) in parameters.iter().enumerate() {
                let value_id = builder.add_get_tuple_field(jp_body_block, jp_argument, i as u32)?;
                env.symbols.insert(p.symbol, value_id);
            }

            let jp_body_value_id = stmt_spec(builder, env, jp_body_block, layout, remainder)?;

            // NOTE the symbols bound by the join point can shadow the argument symbols of the
            // surrounding function, so we don't remove them from the env here

            // NOTE I think we need to use add_sub_block here, but not sure how

            let cont_block = builder.add_block();
            let cont_value_id = stmt_spec(builder, env, cont_block, layout, continuation)?;

            env.join_points.remove(id);
            builder.define_join_point(jpid, BlockExpr(jp_body_block, jp_body_value_id))?;

            Ok(cont_value_id)
        }
        Jump(id, symbols) => {
            let ret_type_id = layout_spec(builder, layout)?;
            let argument = build_tuple_value(builder, env, block, symbols)?;

            let jpid = env.join_points[id];
            builder.add_jump(block, jpid, argument, ret_type_id)
        }
        Rethrow | RuntimeError(_) => {
            let type_id = layout_spec(builder, layout)?;

            builder.add_terminate(block, type_id)
        }
    }
}

fn build_tuple_value(
    builder: &mut FuncDefBuilder,
    env: &Env,
    block: BlockId,
    symbols: &[Symbol],
) -> Result<ValueId> {
    let mut value_ids = Vec::new();

    for field in symbols.iter() {
        let value_id = match env.symbols.get(field) {
            None => panic!(
                "Symbol {:?} is not defined in environment {:?}",
                field, &env.symbols
            ),
            Some(x) => *x,
        };
        value_ids.push(value_id);
    }

    builder.add_make_tuple(block, &value_ids)
}

fn build_tuple_type(builder: &mut FuncDefBuilder, layouts: &[Layout]) -> Result<TypeId> {
    let mut field_types = Vec::new();

    for field in layouts.iter() {
        field_types.push(layout_spec(builder, field)?);
    }

    builder.add_tuple_type(&field_types)
}

fn call_spec(
    builder: &mut FuncDefBuilder,
    env: &Env,
    block: BlockId,
    layout: &Layout,
    call: &Call,
) -> Result<ValueId> {
    use CallType::*;

    match &call.call_type {
        ByName {
            name: symbol,
            full_layout: _,
            ret_layout: _,
            arg_layouts: _,
        } => {
            // TODO annotate each call with a unique identifier
            let spec_var = CalleeSpecVar(&[]);

            let arg_value_id = build_tuple_value(builder, env, block, call.arguments)?;
            let slice = &symbol.to_ne_bytes();
            let name = FuncName(slice);
            let module = MOD_APP;
            builder.add_call(block, spec_var, module, name, arg_value_id)
        }
        ByPointer {
            name: _,
            full_layout: _,
            ret_layout: _,
            arg_layouts: _,
        } => todo!(),
        Foreign {
            foreign_symbol: _,
            ret_layout: _,
        } => {
            // NOTE foreign functions are those exposed by the platform
            todo!()
        }
        LowLevel { op } => lowlevel_spec(builder, env, block, layout, op, call.arguments),
    }
}

fn lowlevel_spec(
    builder: &mut FuncDefBuilder,
    env: &Env,
    block: BlockId,
    layout: &Layout,
    op: &LowLevel,
    arguments: &[Symbol],
) -> Result<ValueId> {
    use LowLevel::*;

    let type_id = layout_spec(builder, layout)?;

    match op {
        NumAdd | NumSub => {
            // NOTE these numeric operations panic (e.g. on overflow)

            let pass_block = {
                let block = builder.add_block();
                let value = new_num(builder, block)?;
                BlockExpr(block, value)
            };

            let fail_block = {
                let block = builder.add_block();
                let value = builder.add_terminate(block, type_id)?;
                BlockExpr(block, value)
            };

            let sub_block = {
                let block = builder.add_block();
                let choice = builder.add_choice(block, &[pass_block, fail_block])?;

                BlockExpr(block, choice)
            };

            builder.add_sub_block(block, sub_block)
        }
        Eq | NotEq => new_bool(builder, block),
        NumLte | NumLt | NumGt | NumGte => new_order(builder, block),
        ListLen => {
            let list = env.symbols[&arguments[0]];

            builder.add_get_tuple_field(block, list, LIST_LEN_INDEX)
        }
        ListGetUnsafe => {
            // NOTE the ListGet lowlevel op is only evaluated if the index is in-bounds
            let list = env.symbols[&arguments[0]];

            let bag = builder.add_get_tuple_field(block, list, LIST_BAG_INDEX)?;
            let cell = builder.add_get_tuple_field(block, list, LIST_CELL_INDEX)?;

            let _unit = builder.add_touch(block, cell)?;

            builder.add_bag_get(block, bag)
        }
        ListSet => {
            let list = env.symbols[&arguments[0]];
            let to_insert = env.symbols[&arguments[2]];

            let bag = builder.add_get_tuple_field(block, list, LIST_BAG_INDEX)?;
            let cell = builder.add_get_tuple_field(block, list, LIST_CELL_INDEX)?;

            // even if this has been written to before, it's okay to write to it again
            let update_mode_var = UpdateModeVar(&[]);
            let _unit = builder.add_update_write_only(block, update_mode_var, cell);

            builder.add_bag_insert(block, bag, to_insert)?;

            Ok(list)
        }
        other => todo!("lowlevel op not implemented: {:?}", other),
    }
}

fn build_variant_types(
    builder: &mut FuncDefBuilder,
    layout: &Layout,
) -> Option<Result<Vec<TypeId>>> {
    match layout {
        Layout::Union(union_layout) => Some(build_variant_types_help(builder, union_layout)),
        _ => None,
    }
}

fn build_variant_types_help(
    builder: &mut FuncDefBuilder,
    union_layout: &UnionLayout,
) -> Result<Vec<TypeId>> {
    use UnionLayout::*;

    let mut result = Vec::new();

    match union_layout {
        NonRecursive(tags) => {
            for tag in tags.iter() {
                result.push(build_tuple_type(builder, tag)?);
            }
        }
        Recursive(_) => todo!(),
        NonNullableUnwrapped(_) => todo!(),
        NullableWrapped {
            nullable_id: _,
            other_tags: _,
        } => todo!(),
        NullableUnwrapped {
            nullable_id: _,
            other_fields: _,
        } => todo!(),
    }

    Ok(result)
}

fn expr_spec(
    builder: &mut FuncDefBuilder,
    env: &Env,
    block: BlockId,
    layout: &Layout,
    expr: &Expr,
) -> Result<ValueId> {
    use Expr::*;

    match expr {
        Literal(literal) => literal_spec(builder, block, literal),
        FunctionPointer(_, _) => todo!(),
        Call(call) => call_spec(builder, env, block, layout, call),
        Tag {
            tag_layout,
            tag_name: _,
            tag_id,
            union_size: _,
            arguments,
        } => {
            let value_id = build_tuple_value(builder, env, block, arguments)?;
            let variant_types = build_variant_types(builder, tag_layout).unwrap()?;
            builder.add_make_union(block, &variant_types, *tag_id as u32, value_id)
        }
        Struct(fields) => build_tuple_value(builder, env, block, fields),
        AccessAtIndex {
            index,
            field_layouts: _,
            structure,
            wrapped,
        } => {
            use crate::ir::Wrapped;

            let value_id = env.symbols[structure];

            match wrapped {
                Wrapped::EmptyRecord => {
                    // this is a unit value
                    builder.add_make_tuple(block, &[])
                }
                Wrapped::SingleElementRecord => {
                    todo!("do we unwrap single-element records still?")
                }
                Wrapped::RecordOrSingleTagUnion => {
                    builder.add_get_tuple_field(block, value_id, *index as u32)
                }
                Wrapped::MultiTagUnion => {
                    // TODO this is likely wrong; how can we extract a field from an union constructor?
                    builder.add_get_tuple_field(block, value_id, *index as u32)
                }
            }
        }
        Array { elem_layout, elems } => {
            let type_id = layout_spec(builder, elem_layout)?;

            let list = new_list(builder, block, type_id)?;

            let mut bag = builder.add_get_tuple_field(block, list, LIST_BAG_INDEX)?;

            for symbol in elems.iter() {
                let value_id = env.symbols[symbol];

                bag = builder.add_bag_insert(block, bag, value_id)?;
            }

            Ok(bag)
        }

        EmptyArray => {
            use ListLayout::*;

            match ListLayout::try_from(layout) {
                Ok(EmptyList) => {
                    // just make up an element type
                    let type_id = builder.add_tuple_type(&[])?;
                    new_list(builder, block, type_id)
                }
                Ok(List(element_layout)) => {
                    let type_id = layout_spec(builder, element_layout)?;
                    new_list(builder, block, type_id)
                }
                Err(()) => unreachable!("empty array does not have a list layout"),
            }
        }
        Reuse { .. } => todo!("currently unused"),
        Reset(_) => todo!("currently unused"),
        RuntimeErrorFunction(_) => {
            let type_id = layout_spec(builder, layout)?;

            builder.add_terminate(block, type_id)
        }
    }
}

fn literal_spec(
    builder: &mut FuncDefBuilder,
    block: BlockId,
    literal: &Literal,
) -> Result<ValueId> {
    use Literal::*;

    match literal {
        Str(_) => new_static_string(builder, block),
        Int(_) | Float(_) | Bool(_) | Byte(_) => builder.add_make_tuple(block, &[]),
    }
}

fn layout_spec(builder: &mut FuncDefBuilder, layout: &Layout) -> Result<TypeId> {
    use Layout::*;

    match layout {
        Builtin(builtin) => builtin_spec(builder, builtin),
        PhantomEmptyStruct => todo!(),
        Struct(fields) => build_tuple_type(builder, fields),
        Union(union_layout) => {
            let variant_types = build_variant_types_help(builder, union_layout)?;
            builder.add_union_type(&variant_types)
        }
        RecursivePointer => todo!(),
        FunctionPointer(_, _) => todo!(),
        Closure(_, _, _) => todo!(),
        Pointer(_) => todo!(),
    }
}

fn builtin_spec(builder: &mut FuncDefBuilder, builtin: &Builtin) -> Result<TypeId> {
    use Builtin::*;

    match builtin {
        Int128 | Int64 | Int32 | Int16 | Int8 | Int1 | Usize => builder.add_tuple_type(&[]),
        Float128 => todo!(),
        Float64 => todo!(),
        Float32 => todo!(),
        Float16 => todo!(),
        Str => todo!(),
        Dict(_, _) => todo!(),
        Set(_) => todo!(),
        List(_, _) => {
            // TODO should incorporate the element type into the name
            Ok(builder.add_named_type(MOD_LIST, TypeName(b"List")))
        }
        EmptyStr => todo!(),
        EmptyList => todo!(),
        EmptyDict => todo!(),
        EmptySet => todo!(),
    }
}

// const OK_TAG_ID: u8 = 1u8;
// const ERR_TAG_ID: u8 = 0u8;

const LIST_CELL_INDEX: u32 = 0;
const LIST_BAG_INDEX: u32 = 1;
const LIST_LEN_INDEX: u32 = 2;

fn new_list(builder: &mut FuncDefBuilder, block: BlockId, element_type: TypeId) -> Result<ValueId> {
    let cell = builder.add_new_heap_cell(block)?;
    let bag = builder.add_empty_bag(block, element_type)?;
    let length = new_usize(builder, block)?;
    builder.add_make_tuple(block, &[cell, bag, length])
}

fn new_usize(builder: &mut FuncDefBuilder, block: BlockId) -> Result<ValueId> {
    new_num(builder, block)
}

fn new_static_string(builder: &mut FuncDefBuilder, block: BlockId) -> Result<ValueId> {
    let cell = builder.add_new_heap_cell(block)?;

    // immediately mutate the cell, so any future updates on this value are invalid
    // updating a static string would cause a crash at runtime
    let _ = builder.add_update(block, UpdateModeVar(&[]), cell)?;

    let length = new_usize(builder, block)?;
    builder.add_make_tuple(block, &[cell, length])
}

fn new_order(builder: &mut FuncDefBuilder, block: BlockId) -> Result<ValueId> {
    // always generats EQ
    let tag_id = 0;

    let unit = builder.add_tuple_type(&[])?;
    let unit_value = builder.add_make_tuple(block, &[])?;
    builder.add_make_union(block, &[unit, unit, unit], tag_id, unit_value)
}

fn new_bool(builder: &mut FuncDefBuilder, block: BlockId) -> Result<ValueId> {
    // always generats False
    let tag_id = 0;

    let unit = builder.add_tuple_type(&[])?;
    let unit_value = builder.add_make_tuple(block, &[])?;
    builder.add_make_union(block, &[unit, unit], tag_id, unit_value)
}

fn new_num(builder: &mut FuncDefBuilder, block: BlockId) -> Result<ValueId> {
    // we model all our numbers as unit values
    builder.add_make_tuple(block, &[])
}