revive-llvm-context 1.2.0

Shared front end code of the revive PolkaVM compilers
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

//! The LLVM pointer.

use inkwell::types::BasicType;

use crate::polkavm::context::address_space::AddressSpace;
use crate::polkavm::context::global::Global;
use crate::polkavm::context::Context;

pub mod heap;
pub mod storage;

/// The LLVM pointer.
#[derive(Debug, Clone, Copy)]
pub struct Pointer<'ctx> {
    /// The pointee type.
    pub r#type: inkwell::types::BasicTypeEnum<'ctx>,
    /// The address space.
    pub address_space: AddressSpace,
    /// The pointer value.
    pub value: inkwell::values::PointerValue<'ctx>,
}

impl<'ctx> Pointer<'ctx> {
    /// A shortcut constructor.
    pub fn new<T>(
        r#type: T,
        address_space: AddressSpace,
        value: inkwell::values::PointerValue<'ctx>,
    ) -> Self
    where
        T: BasicType<'ctx>,
    {
        Self {
            r#type: r#type.as_basic_type_enum(),
            address_space,
            value,
        }
    }

    /// Wraps a 256-bit primitive type pointer.
    pub fn new_stack_field(
        context: &Context<'ctx>,
        value: inkwell::values::PointerValue<'ctx>,
    ) -> Self {
        Self {
            r#type: context.word_type().as_basic_type_enum(),
            address_space: AddressSpace::Stack,
            value,
        }
    }

    /// Creates a new pointer with the specified `offset`.
    pub fn new_with_offset<T>(
        context: &Context<'ctx>,
        address_space: AddressSpace,
        r#type: T,
        offset: inkwell::values::IntValue<'ctx>,
        name: &str,
    ) -> Self
    where
        T: BasicType<'ctx>,
    {
        assert_ne!(
            address_space,
            AddressSpace::Stack,
            "Stack pointers cannot be addressed"
        );

        let offset = context.safe_truncate_int_to_xlen(offset).unwrap();
        let value = context
            .builder
            .build_int_to_ptr(offset, context.llvm().ptr_type(address_space.into()), name)
            .unwrap();
        Self::new(r#type, address_space, value)
    }

    /// Casts the pointer into another type.
    pub fn cast<T>(self, r#type: T) -> Self
    where
        T: BasicType<'ctx>,
    {
        Self {
            r#type: r#type.as_basic_type_enum(),
            address_space: self.address_space,
            value: self.value,
        }
    }

    /// Cast this pointer to a register sized integer value.
    pub fn to_int(&self, context: &Context<'ctx>) -> inkwell::values::IntValue<'ctx> {
        context
            .builder()
            .build_ptr_to_int(self.value, context.xlen_type(), "ptr_to_xlen")
            .expect("we should be positioned")
    }

    pub fn address_space_cast(
        self,
        context: &Context<'ctx>,
        address_space: AddressSpace,
        name: &str,
    ) -> anyhow::Result<Self> {
        let value = context.builder().build_address_space_cast(
            self.value,
            context.llvm().ptr_type(address_space.into()),
            name,
        )?;

        Ok(Self {
            address_space,
            value,
            ..self
        })
    }
}

impl<'ctx> From<Global<'ctx>> for Pointer<'ctx> {
    fn from(global: Global<'ctx>) -> Self {
        Self {
            r#type: global.r#type,
            address_space: AddressSpace::Stack,
            value: global.value.as_pointer_value(),
        }
    }
}