qirc-compiler 0.1.1

Compiler and state vector simulator for QIR, the Quantum Intermediate Representation
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
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
use crate::diag::Span;

#[derive(Clone, PartialEq, Debug)]
pub enum Ty {
    Void,
    Int(u32),
    Half,
    Float,
    Double,
    X86Fp80,
    Fp128,
    Ptr(Option<Box<Ty>>),
    Array(u64, Box<Ty>),
    Vector {
        len: u64,
        scalable: bool,
        elem: Box<Ty>,
    },
    Struct {
        fields: Vec<Ty>,
        packed: bool,
    },
    Named(String),
    Func {
        ret: Box<Ty>,
        params: Vec<Ty>,
        varargs: bool,
    },
    Label,
    Metadata,
    Token,
    Opaque,
}

impl Ty {
    pub fn pointee_name(&self) -> Option<&str> {
        match self {
            Ty::Ptr(Some(inner)) => match inner.as_ref() {
                Ty::Named(name) => Some(name),
                _ => None,
            },
            _ => None,
        }
    }
}

#[derive(Clone, PartialEq, Debug)]
pub enum Value {
    Local(String),
    Global(String),
    Int(i128),
    Float(f64),
    Bool(bool),
    Null,
    NoneValue,
    Undef,
    Poison,
    ZeroInit,
    Bytes(Vec<u8>),
    Aggregate(Vec<TypedValue>),
    ConstExpr(Box<ConstExpr>),
    MetadataRef(String),
    MetadataString(String),
    BlockAddress,
}

#[derive(Clone, PartialEq, Debug)]
pub struct TypedValue {
    pub ty: Ty,
    pub value: Value,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub enum ConstExpr {
    Cast {
        op: CastOp,
        operand: TypedValue,
        to: Ty,
    },
    GetElementPtr {
        inbounds: bool,
        base_ty: Ty,
        ptr: TypedValue,
        indices: Vec<TypedValue>,
    },
    Binary {
        op: BinOp,
        lhs: TypedValue,
        rhs: TypedValue,
    },
}

macro_rules! keywords {
    ($name:ident { $($variant:ident = $text:literal),* $(,)? }) => {
        #[derive(Clone, Copy, PartialEq, Eq, Debug)]
        pub enum $name {
            $($variant),*
        }

        impl $name {
            pub fn from_keyword(keyword: &str) -> Option<$name> {
                match keyword {
                    $($text => Some($name::$variant),)*
                    _ => None,
                }
            }

            pub fn keyword(self) -> &'static str {
                match self {
                    $($name::$variant => $text),*
                }
            }
        }
    };
}

keywords!(BinOp {
    Add = "add",
    Sub = "sub",
    Mul = "mul",
    UDiv = "udiv",
    SDiv = "sdiv",
    URem = "urem",
    SRem = "srem",
    Shl = "shl",
    LShr = "lshr",
    AShr = "ashr",
    And = "and",
    Or = "or",
    Xor = "xor",
    FAdd = "fadd",
    FSub = "fsub",
    FMul = "fmul",
    FDiv = "fdiv",
    FRem = "frem",
});

impl BinOp {
    pub fn is_float(self) -> bool {
        matches!(
            self,
            BinOp::FAdd | BinOp::FSub | BinOp::FMul | BinOp::FDiv | BinOp::FRem
        )
    }
}

keywords!(CastOp {
    Trunc = "trunc",
    ZExt = "zext",
    SExt = "sext",
    FPTrunc = "fptrunc",
    FPExt = "fpext",
    FPToUI = "fptoui",
    FPToSI = "fptosi",
    UIToFP = "uitofp",
    SIToFP = "sitofp",
    PtrToInt = "ptrtoint",
    IntToPtr = "inttoptr",
    BitCast = "bitcast",
    AddrSpaceCast = "addrspacecast",
});

keywords!(IntPredicate {
    Eq = "eq",
    Ne = "ne",
    Ugt = "ugt",
    Uge = "uge",
    Ult = "ult",
    Ule = "ule",
    Sgt = "sgt",
    Sge = "sge",
    Slt = "slt",
    Sle = "sle",
});

keywords!(FloatPredicate {
    False = "false",
    Oeq = "oeq",
    Ogt = "ogt",
    Oge = "oge",
    Olt = "olt",
    Ole = "ole",
    One = "one",
    Ord = "ord",
    Ueq = "ueq",
    Ugt = "ugt",
    Uge = "uge",
    Ult = "ult",
    Ule = "ule",
    Une = "une",
    Uno = "uno",
    True = "true",
});

#[derive(Clone, PartialEq, Debug)]
pub struct Argument {
    pub ty: Ty,
    pub attrs: Vec<String>,
    pub value: Value,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub struct Call {
    pub tail: bool,
    pub ret_ty: Ty,
    pub explicit_fn_ty: Option<Ty>,
    pub callee: Value,
    pub args: Vec<Argument>,
    pub attr_groups: Vec<String>,
    pub span: Span,
}

impl Call {
    pub fn callee_name(&self) -> Option<&str> {
        match &self.callee {
            Value::Global(name) => Some(name),
            _ => None,
        }
    }
}

#[derive(Clone, PartialEq, Debug)]
pub enum InstKind {
    Call(Call),
    Binary {
        op: BinOp,
        ty: Ty,
        lhs: Value,
        rhs: Value,
    },
    ICmp {
        pred: IntPredicate,
        ty: Ty,
        lhs: Value,
        rhs: Value,
    },
    FCmp {
        pred: FloatPredicate,
        ty: Ty,
        lhs: Value,
        rhs: Value,
    },
    Cast {
        op: CastOp,
        operand: TypedValue,
        to: Ty,
    },
    Select {
        cond: TypedValue,
        if_true: TypedValue,
        if_false: TypedValue,
    },
    Phi {
        ty: Ty,
        incoming: Vec<(Value, String)>,
    },
    Alloca {
        ty: Ty,
        count: Option<TypedValue>,
    },
    Load {
        ty: Ty,
        ptr: TypedValue,
    },
    Store {
        value: TypedValue,
        ptr: TypedValue,
    },
    GetElementPtr {
        inbounds: bool,
        base_ty: Ty,
        ptr: TypedValue,
        indices: Vec<TypedValue>,
    },
    ExtractValue {
        aggregate: TypedValue,
        indices: Vec<u64>,
    },
    InsertValue {
        aggregate: TypedValue,
        value: TypedValue,
        indices: Vec<u64>,
    },
    Freeze(TypedValue),
    Fence,
    Unsupported {
        opcode: String,
    },
}

#[derive(Clone, PartialEq, Debug)]
pub struct Instruction {
    pub result: Option<String>,
    pub kind: InstKind,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub enum Terminator {
    Ret(Option<TypedValue>),
    Br {
        target: String,
    },
    CondBr {
        cond: TypedValue,
        if_true: String,
        if_false: String,
    },
    Switch {
        scrutinee: TypedValue,
        default: String,
        cases: Vec<(TypedValue, String)>,
    },
    Unreachable,
}

#[derive(Clone, PartialEq, Debug)]
pub struct BasicBlock {
    pub label: String,
    pub instructions: Vec<Instruction>,
    pub terminator: Terminator,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub struct Param {
    pub ty: Ty,
    pub name: Option<String>,
    pub attrs: Vec<String>,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub struct FuncSig {
    pub name: String,
    pub ret_ty: Ty,
    pub params: Vec<Param>,
    pub varargs: bool,
    pub attr_groups: Vec<String>,
    pub attrs: Vec<Attribute>,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub struct Function {
    pub sig: FuncSig,
    pub blocks: Vec<BasicBlock>,
    pub span: Span,
}

impl Function {
    pub fn block(&self, label: &str) -> Option<&BasicBlock> {
        self.blocks.iter().find(|b| b.label == label)
    }
}

#[derive(Clone, PartialEq, Eq, Debug)]
pub enum Attribute {
    Flag(String),
    KeyValue(String, String),
}

impl Attribute {
    pub fn key(&self) -> &str {
        match self {
            Attribute::Flag(k) | Attribute::KeyValue(k, _) => k,
        }
    }

    pub fn value(&self) -> Option<&str> {
        match self {
            Attribute::Flag(_) => None,
            Attribute::KeyValue(_, v) => Some(v),
        }
    }
}

#[derive(Clone, PartialEq, Eq, Debug)]
pub struct AttrGroup {
    pub id: String,
    pub attrs: Vec<Attribute>,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub struct GlobalVar {
    pub name: String,
    pub ty: Ty,
    pub initializer: Option<Value>,
    pub is_constant: bool,
    pub linkage: Vec<String>,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub struct TypeDef {
    pub name: String,
    pub ty: Ty,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub struct NamedMetadata {
    pub name: String,
    pub operands: Vec<String>,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug)]
pub enum MetadataNode {
    Tuple(Vec<MetadataItem>),
    Specialized { kind: String, body: String },
}

#[derive(Clone, PartialEq, Debug)]
pub enum MetadataItem {
    Value(TypedValue),
    Ref(String),
    Str(String),
    Node(Vec<MetadataItem>),
    Null,
}

#[derive(Clone, PartialEq, Debug)]
pub struct MetadataDef {
    pub id: String,
    pub distinct: bool,
    pub node: MetadataNode,
    pub span: Span,
}

#[derive(Clone, PartialEq, Debug, Default)]
pub struct Module {
    pub source_filename: Option<String>,
    pub datalayout: Option<String>,
    pub triple: Option<String>,
    pub type_defs: Vec<TypeDef>,
    pub globals: Vec<GlobalVar>,
    pub declarations: Vec<FuncSig>,
    pub functions: Vec<Function>,
    pub attr_groups: Vec<AttrGroup>,
    pub named_metadata: Vec<NamedMetadata>,
    pub metadata: Vec<MetadataDef>,
}

impl Module {
    pub fn function(&self, name: &str) -> Option<&Function> {
        self.functions.iter().find(|f| f.sig.name == name)
    }

    pub fn attr_group(&self, id: &str) -> Option<&AttrGroup> {
        self.attr_groups.iter().find(|g| g.id == id)
    }

    pub fn global(&self, name: &str) -> Option<&GlobalVar> {
        self.globals.iter().find(|g| g.name == name)
    }

    pub fn metadata_def(&self, id: &str) -> Option<&MetadataDef> {
        self.metadata.iter().find(|m| m.id == id)
    }

    pub fn named_metadata_node(&self, name: &str) -> Option<&NamedMetadata> {
        self.named_metadata.iter().find(|n| n.name == name)
    }

    pub fn attributes_of<'a>(&'a self, sig: &'a FuncSig) -> Vec<&'a Attribute> {
        let mut out: Vec<&Attribute> = sig.attrs.iter().collect();
        for id in &sig.attr_groups {
            if let Some(group) = self.attr_group(id) {
                out.extend(group.attrs.iter());
            }
        }
        out
    }

    pub fn entry_point(&self) -> Option<&Function> {
        self.functions
            .iter()
            .find(|f| {
                self.attributes_of(&f.sig)
                    .iter()
                    .any(|a| a.key() == "entry_point")
            })
            .or_else(|| self.function("main"))
    }
}