charon_lib/ast/
builtins.rs

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
//! This file contains information about the builtin functions/types/traits definitions
//!
//! **IMPORTANT**:
//! When checking whether names are equal to one of the reference names below,
//! we ignore the disambiguators (see [crate::names] and [crate::names_utils]).
// TODO: rename to "primitive"

use crate::ast;
use crate::names::*;
use crate::types::*;
use macros::EnumIsA;

// Built-in functions
// We treat this one specially in the `inline_local_panic_functions` pass. See there for details.
pub static EXPLICIT_PANIC_NAME: &[&str] = &["core", "panicking", "panic_explicit"];

/// We redefine identifiers for built-in functions here, instead of reusing the
/// identifiers from [ullbc_ast], because:
/// - some of the functions (the panic functions) will actually not be translated
///   to functions: there are thus missing identifiers.
/// - some of the ids here are actually traits, that we disambiguate later
/// TODO: merge with the other enum?
#[derive(Copy, Clone, EnumIsA)]
pub enum BuiltinFun {
    Panic,
    BoxNew,
}

impl BuiltinFun {
    /// Converts to the ullbc equivalent. Panics if `self` is `Panic` as this should be handled
    /// separately.
    pub fn to_ullbc_builtin_fun(self) -> ast::BuiltinFunId {
        match self {
            BuiltinFun::BoxNew => ast::BuiltinFunId::BoxNew,
            BuiltinFun::Panic => panic!(),
        }
    }
}

impl BuiltinTy {
    pub fn get_name(self) -> Name {
        let name: &[_] = match self {
            BuiltinTy::Box => &["alloc", "boxed", "Box"],
            BuiltinTy::Str => &["Str"],
            BuiltinTy::Array => &["Array"],
            BuiltinTy::Slice => &["Slice"],
        };
        Name::from_path(name)
    }
}

/// When translating from MIR to ULLBC, we ignore some type parameters for some builtin types.
/// For instance, many types like box or vec are parameterized (in MIR) by an allocator
/// (`std::alloc::Allocator`): we ignore it.
pub fn type_to_used_params(id: BuiltinTy) -> Vec<bool> {
    match id {
        BuiltinTy::Box => {
            vec![true, false]
        }
        BuiltinTy::Str => {
            vec![]
        }
        BuiltinTy::Array | BuiltinTy::Slice => vec![true],
    }
}