mathic 0.2.0

A compiler with builtin support of symbolic operations, built with LLVM/MLIR
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

use std::{
    ffi::CStr,
    mem::MaybeUninit,
    ptr::{addr_of_mut, null_mut},
    sync::OnceLock,
};

use llvm_sys::{
    core::LLVMDisposeMessage,
    target::{
        LLVM_InitializeAllAsmPrinters, LLVM_InitializeAllTargetInfos, LLVM_InitializeAllTargetMCs,
        LLVM_InitializeAllTargets, LLVMCopyStringRepOfTargetData, LLVMDisposeTargetData,
    },
    target_machine::{
        LLVMCodeGenOptLevel, LLVMCodeModel, LLVMCreateTargetDataLayout, LLVMCreateTargetMachine,
        LLVMDisposeTargetMachine, LLVMGetDefaultTargetTriple, LLVMGetHostCPUFeatures,
        LLVMGetHostCPUName, LLVMGetTargetFromTriple, LLVMRelocMode, LLVMTargetRef,
    },
};
use melior::{
    Context,
    dialect::DialectRegistry,
    ir::{
        Block, Identifier, Location, Module, Region, RegionLike, attribute::StringAttribute,
        operation::OperationBuilder,
    },
    utility::{register_all_dialects, register_all_llvm_translations, register_all_passes},
};

use crate::{compiler::OptLvl, diagnostics::CodegenError};

pub mod dialect_integration;

impl From<OptLvl> for LLVMCodeGenOptLevel {
    fn from(value: OptLvl) -> Self {
        match value {
            OptLvl::None => LLVMCodeGenOptLevel::LLVMCodeGenLevelNone,
            OptLvl::O1 => LLVMCodeGenOptLevel::LLVMCodeGenLevelLess,
            OptLvl::O2 => LLVMCodeGenOptLevel::LLVMCodeGenLevelDefault,
            OptLvl::O3 => LLVMCodeGenOptLevel::LLVMCodeGenLevelAggressive,
        }
    }
}

pub fn create_module<'ctx>(
    ctx: &'ctx Context,
    opt_lvl: OptLvl,
) -> Result<Module<'ctx>, CodegenError> {
    static INITIALIZED: OnceLock<()> = OnceLock::new();

    INITIALIZED.get_or_init(|| unsafe {
        LLVM_InitializeAllTargets();
        LLVM_InitializeAllTargetInfos();
        LLVM_InitializeAllTargetMCs();
        LLVM_InitializeAllAsmPrinters();
    });

    let target_triple = get_target_triple();

    let module_region = Region::new();
    module_region.append_block(Block::new(&[]));

    let data_layout_ret = &get_data_layout_rep(opt_lvl)?;

    let op = OperationBuilder::new("builtin.module", Location::unknown(ctx))
        .add_attributes(&[
            (
                Identifier::new(ctx, "llvm.target_triple"),
                StringAttribute::new(ctx, &target_triple).into(),
            ),
            (
                Identifier::new(ctx, "llvm.data_layout"),
                StringAttribute::new(ctx, data_layout_ret).into(),
            ),
        ])
        .add_regions([module_region])
        .build()?;

    Module::from_operation(op).ok_or(CodegenError::Custom("Could not create module".to_string()))
}

pub fn create_context() -> Result<Context, CodegenError> {
    let ctx = Context::new();

    ctx.append_dialect_registry(&create_dialect_registry());
    ctx.load_all_available_dialects();

    register_all_passes();
    register_all_llvm_translations(&ctx);

    Ok(ctx)
}

fn create_dialect_registry() -> DialectRegistry {
    let registry = DialectRegistry::new();

    dialect_integration::symbolic_dialect::register_symbolic_dialect(&registry);
    register_all_dialects(&registry);

    registry
}

/// Gets the target triple, which identifies the platform and ABI.
pub fn get_target_triple() -> String {
    unsafe {
        let value = LLVMGetDefaultTargetTriple();
        let result = CStr::from_ptr(value).to_string_lossy().into_owned();
        LLVMDisposeMessage(value);
        result
    }
}

/// Gets the data layout reprrsentation as a string, to be given to the MLIR module.
/// LLVM uses this to know the proper alignments for the given sizes, etc.
/// This function gets the data layout of the host target triple.
pub fn get_data_layout_rep(opt_lvl: OptLvl) -> Result<String, CodegenError> {
    unsafe {
        let mut null = null_mut();
        let error_buffer = addr_of_mut!(null);

        let target_triple = LLVMGetDefaultTargetTriple();
        let target_cpu = LLVMGetHostCPUName();
        let target_cpu_features = LLVMGetHostCPUFeatures();

        let mut target: MaybeUninit<LLVMTargetRef> = MaybeUninit::uninit();

        if LLVMGetTargetFromTriple(target_triple, target.as_mut_ptr(), error_buffer) != 0 {
            let error = CStr::from_ptr(*error_buffer);
            let err = error.to_string_lossy().to_string();
            LLVMDisposeMessage(*error_buffer);
            LLVMDisposeMessage(target_triple);
            LLVMDisposeMessage(target_cpu);
            LLVMDisposeMessage(target_cpu_features);
            Err(CodegenError::LLVMError(err))?;
        }
        if !(*error_buffer).is_null() {
            LLVMDisposeMessage(*error_buffer);
        }

        let target = target.assume_init();

        let machine = LLVMCreateTargetMachine(
            target,
            target_triple.cast(),
            target_cpu.cast(),
            target_cpu_features.cast(),
            opt_lvl.into(),
            LLVMRelocMode::LLVMRelocDefault,
            LLVMCodeModel::LLVMCodeModelDefault,
        );

        let data_layout = LLVMCreateTargetDataLayout(machine);
        let data_layout_str = CStr::from_ptr(LLVMCopyStringRepOfTargetData(data_layout));

        LLVMDisposeTargetData(data_layout);
        LLVMDisposeTargetMachine(machine);
        LLVMDisposeMessage(target_triple);
        LLVMDisposeMessage(target_cpu);
        LLVMDisposeMessage(target_cpu_features);

        Ok(data_layout_str.to_string_lossy().into_owned())
    }
}