mirage-analyzer 1.3.0

Path-Aware Code Intelligence Engine for Rust
Documentation 
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221

//! Charon LLBC JSON representation
//!
//! Based on AeneasVerif/charon's exported JSON format for Low-Level Borrow Calculus (LLBC).

use serde::{Deserialize, Serialize};

/// Top-level structure for a Charon exported crate
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Crate {
    pub crate_name: String,
    pub files: Vec<File>,
    pub fun_decls: Vec<FunDecl>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct File {
    pub path: String,
    pub contents: Option<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FunDecl {
    pub def_id: u32,
    pub name: Vec<String>,
    pub meta: Meta,
    pub signature: FunSignature,
    pub body: Option<Body>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Meta {
    pub span: Span,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Span {
    pub file_id: u32,
    pub beg: Loc,
    pub end: Loc,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Loc {
    pub line: u32,
    pub col: u32,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FunSignature {
    pub inputs: Vec<Ty>,
    pub output: Ty,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub enum Ty {
    Adt { id: String, generics: Generics },
    Bool,
    Char,
    Integer(IntegerTy),
    Str,
    Array(Box<Ty>, usize),
    Slice(Box<Ty>),
    Ref(Box<Ty>, RefKind),
    Never,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum IntegerTy {
    Isize,
    I8,
    I16,
    I32,
    I64,
    I128,
    Usize,
    U8,
    U16,
    U32,
    U64,
    U128,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum RefKind {
    Mut,
    Shared,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Generics {
    pub types: Vec<String>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Body {
    pub arg_count: usize,
    pub locals: Vec<Local>,
    #[serde(rename = "unstructured_body")]
    pub unstructured: Option<UllbcBody>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Local {
    pub name: Option<String>,
    pub ty: Ty,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UllbcBody {
    pub blocks: Vec<BlockData>,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct BlockData {
    pub id: u32,
    pub statements: Vec<Statement>,
    pub terminator: Terminator,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub enum Statement {
    Assign(Place, Rvalue),
    FakeRead(Place),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub enum Terminator {
    Goto(u32),
    #[serde(rename_all = "camelCase")]
    SwitchInt {
        discr: Operand,
        targets: Vec<SwitchTarget>,
        otherwise: u32,
    },
    Return,
    Panic,
    #[serde(rename_all = "camelCase")]
    Call {
        func: FnPtr,
        args: Vec<Operand>,
        dest: Place,
        yield_target: Option<u32>,
        target: Option<u32>,
    },
    #[serde(rename_all = "camelCase")]
    Assert {
        cond: Operand,
        expected: bool,
        target: u32,
    },
    #[serde(rename_all = "camelCase")]
    Drop {
        place: Place,
        target: u32,
    },
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub enum FnPtr {
    Regular { id: u32, generics: Generics },
    // Add other variants if needed
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct SwitchTarget {
    pub value: String,
    pub target: u32,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub enum Place {
    Local(u32),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub enum Rvalue {
    BinaryOp(BinOp, Operand, Operand),
    UnaryOp(UnOp, Operand),
    Use(Operand),
    Constant(String),
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum UnOp {
    Not,
    Neg,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
pub enum BinOp {
    Add,
    Sub,
    Mul,
    Div,
    Rem,
    BitAnd,
    BitOr,
    BitXor,
    Shl,
    Shr,
    Eq,
    Ne,
    Lt,
    Le,
    Gt,
    Ge,
}

#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub enum Operand {
    Copy(Place),
    Move(Place),
    Constant(String),
}