revive-llvm-context 1.3.0

//! Translates the heap memory operations.

use inkwell::values::BasicValue;
use inkwell::values::BasicValueEnum;
use revive_common::BYTE_LENGTH_BYTE;

use crate::polkavm::context::address_space::AddressSpace;
use crate::polkavm::context::pointer::heap::{
    build_efficient_load_swap, build_efficient_store_swap,
};
use crate::polkavm::context::pointer::Pointer;
use crate::polkavm::context::Context;

/// Translates the `msize` instruction.
pub fn msize<'ctx>(
    context: &mut Context<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
    Ok(context
        .builder()
        .build_int_z_extend(
            context.build_msize()?,
            context.word_type(),
            "heap_size_extended",
        )?
        .as_basic_value_enum())
}

/// Translates the `mload` instruction.
/// Uses the main heap.
pub fn load<'ctx>(
    context: &mut Context<'ctx>,
    offset: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
    let pointer = Pointer::new_with_offset(
        context,
        AddressSpace::Heap,
        context.word_type(),
        offset,
        "memory_load_pointer",
    );
    context.build_load(pointer, "memory_load_result")
}

/// Translates the `mstore` instruction.
/// Uses the main heap.
pub fn store<'ctx>(
    context: &mut Context<'ctx>,
    offset: inkwell::values::IntValue<'ctx>,
    value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> {
    let pointer = Pointer::new_with_offset(
        context,
        AddressSpace::Heap,
        context.word_type(),
        offset,
        "memory_store_pointer",
    );
    context.build_store(pointer, value)?;
    Ok(())
}

/// Translates the `mstore8` instruction.
/// Uses the main heap.
pub fn store_byte<'ctx>(
    context: &mut Context<'ctx>,
    offset: inkwell::values::IntValue<'ctx>,
    value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> {
    let byte_type = context.byte_type();
    let value = context
        .builder()
        .build_int_truncate(value, byte_type, "mstore8_value")?;
    let pointer = Pointer::new_with_offset(
        context,
        AddressSpace::Heap,
        byte_type,
        offset,
        "mstore8_destination",
    );
    let pointer = context.build_sbrk(
        pointer.to_int(context),
        context.xlen_type().const_int(1, false),
    )?;
    context
        .builder()
        .build_store(pointer, value)?
        .set_alignment(BYTE_LENGTH_BYTE as u32)
        .expect("ICE: alignment is valid");
    Ok(())
}

/// Builds an efficient 256-bit store with byte-swap at a pointer obtained via unchecked GEP
/// (no sbrk bounds check). For use by the newyork InlineByteSwap mode on constant offsets
/// within the static heap.
pub fn store_bswap_unchecked<'ctx>(
    context: &Context<'ctx>,
    offset: inkwell::values::IntValue<'ctx>,
    value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> {
    let pointer = context.build_heap_gep_unchecked(offset)?;
    build_efficient_store_swap(context, pointer.value, value)
}

/// Builds an efficient 256-bit load with byte-swap at a pointer obtained via unchecked GEP
/// (no sbrk bounds check). For use by the newyork InlineByteSwap mode on constant offsets
/// within the static heap.
pub fn load_bswap_unchecked<'ctx>(
    context: &Context<'ctx>,
    offset: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<BasicValueEnum<'ctx>> {
    let pointer = context.build_heap_gep_unchecked(offset)?;
    build_efficient_load_swap(context, pointer.value)
}

/// Translates the `mload` instruction without byte-swapping, inlined.
/// This version inlines the load directly without a function call,
/// saving both call overhead and function body size when not all
/// memory accesses need native mode.
pub fn load_native_inline<'ctx>(
    context: &mut Context<'ctx>,
    offset: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<inkwell::values::BasicValueEnum<'ctx>> {
    let length = context
        .xlen_type()
        .const_int(revive_common::BYTE_LENGTH_WORD as u64, false);
    let pointer = context.build_heap_gep(offset, length)?;
    let value = context
        .builder()
        .build_load(context.word_type(), pointer.value, "native_load")?;
    context
        .basic_block()
        .get_last_instruction()
        .expect("ICE: load instruction always exists")
        .set_alignment(BYTE_LENGTH_BYTE as u32)
        .expect("ICE: alignment is valid");
    Ok(value)
}

/// Translates the `mstore` instruction without byte-swapping, inlined.
/// This version inlines the store directly without a function call,
/// saving both call overhead and function body size when not all
/// memory accesses need native mode.
pub fn store_native_inline<'ctx>(
    context: &mut Context<'ctx>,
    offset: inkwell::values::IntValue<'ctx>,
    value: inkwell::values::IntValue<'ctx>,
) -> anyhow::Result<()> {
    let length = context
        .xlen_type()
        .const_int(revive_common::BYTE_LENGTH_WORD as u64, false);
    let pointer = context.build_heap_gep(offset, length)?;
    context
        .builder()
        .build_store(pointer.value, value)?
        .set_alignment(BYTE_LENGTH_BYTE as u32)
        .expect("ICE: alignment is valid");
    Ok(())
}