winch-codegen 0.2.0

Winch code generation library
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
use super::regs::{rbp, reg_name, rsp};
use crate::abi::addressing_mode::Address;
use crate::abi::local::LocalSlot;
use crate::isa::reg::Reg;
use crate::masm::{MacroAssembler as Masm, OperandSize, RegImm};

pub(crate) struct MacroAssembler {
    sp_offset: u32,
    asm: Assembler,
}

impl Masm for MacroAssembler {
    fn prologue(&mut self) {
        let frame_pointer = rbp();
        let stack_pointer = rsp();

        self.asm.push_r(frame_pointer);
        self.asm.mov_rr(stack_pointer, frame_pointer);
    }

    fn push(&mut self, reg: Reg) -> u32 {
        self.asm.push_r(reg);
        // In x64 the push instruction takes either
        // 2 or 8 bytes; in our case we're always
        // assuming 8 bytes per push.
        self.increment_sp(8);

        self.sp_offset
    }

    fn reserve_stack(&mut self, bytes: u32) {
        if bytes == 0 {
            return;
        }

        self.asm.sub_ir(bytes, rsp());
        self.increment_sp(bytes);
    }

    fn local_address(&mut self, local: &LocalSlot) -> Address {
        let (reg, offset) = local
            .addressed_from_sp()
            .then(|| {
                let offset = self.sp_offset.checked_sub(local.offset).expect(&format!(
                    "Invalid local offset = {}; sp offset = {}",
                    local.offset, self.sp_offset
                ));
                (rsp(), offset)
            })
            .unwrap_or((rbp(), local.offset));

        Address::base(reg, offset)
    }

    fn store(&mut self, src: RegImm, dst: Address, size: OperandSize) {
        let src: Operand = src.into();
        let dst: Operand = dst.into();

        match size {
            OperandSize::S32 => {
                self.asm.movl(src, dst);
            }
            OperandSize::S64 => {
                self.asm.mov(src, dst);
            }
        }
    }

    fn load(&mut self, src: Address, dst: Reg, size: OperandSize) {
        let src = src.into();
        let dst = dst.into();

        match size {
            OperandSize::S32 => self.asm.movl(src, dst),
            OperandSize::S64 => self.asm.mov(src, dst),
        }
    }

    fn sp_offset(&mut self) -> u32 {
        self.sp_offset
    }

    fn zero(&mut self, reg: Reg) {
        self.asm.xorl_rr(reg, reg);
    }

    fn mov(&mut self, src: RegImm, dst: RegImm, size: OperandSize) {
        let src: Operand = src.into();
        let dst: Operand = dst.into();

        match size {
            OperandSize::S32 => {
                self.asm.movl(src, dst);
            }
            OperandSize::S64 => {
                self.asm.mov(src, dst);
            }
        }
    }

    fn add(&mut self, dst: RegImm, lhs: RegImm, rhs: RegImm, size: OperandSize) {
        let (src, dst): (Operand, Operand) = if dst == lhs {
            (rhs.into(), dst.into())
        } else {
            panic!(
                "the destination and first source argument must be the same, dst={:?}, lhs={:?}",
                dst, lhs
            );
        };

        match size {
            OperandSize::S32 => {
                self.asm.addl(src, dst);
            }
            OperandSize::S64 => {
                self.asm.add(src, dst);
            }
        }
    }

    fn epilogue(&mut self, locals_size: u32) {
        let rsp = rsp();
        if locals_size > 0 {
            self.asm.add_ir(locals_size as i32, rsp);
        }
        self.asm.pop_r(rbp());
        self.asm.ret();
    }

    fn finalize(&mut self) -> &[String] {
        self.asm.finalize()
    }
}

impl MacroAssembler {
    /// Crate a x64 MacroAssembler
    pub fn new() -> Self {
        Self {
            sp_offset: 0,
            asm: Default::default(),
        }
    }

    fn increment_sp(&mut self, bytes: u32) {
        self.sp_offset += bytes;
    }

    #[allow(dead_code)]
    fn decrement_sp(&mut self, bytes: u32) {
        assert!(
            self.sp_offset >= bytes,
            "sp offset = {}; bytes = {}",
            self.sp_offset,
            bytes
        );
        self.sp_offset -= bytes;
    }
}

/// A x64 instruction operand.
#[derive(Debug, Copy, Clone)]
enum Operand {
    Reg(Reg),
    Mem(Address),
    Imm(i32),
}

/// Low level assembler implementation for x64
/// All instructions denote a 64 bit size, unless
/// otherwise specified by the corresponding function
/// name suffix.

// NOTE
// This is an interim, debug approach; the long term idea
// is to make each ISA assembler available through
// `cranelift_asm`. The literal representation of the
// instructions use intel syntax for easier manual verification.
// This shouldn't be an issue, once we plug in Cranelift's backend
// we are going to be able to properly disassemble.
#[derive(Default)]
struct Assembler {
    buffer: Vec<String>,
}

impl Assembler {
    pub fn push_r(&mut self, reg: Reg) {
        self.buffer.push(format!("push {}", reg_name(reg, 8)));
    }

    pub fn pop_r(&mut self, reg: Reg) {
        self.buffer.push(format!("pop {}", reg_name(reg, 8)));
    }

    pub fn ret(&mut self) {
        self.buffer.push("ret".into());
    }

    pub fn mov(&mut self, src: Operand, dst: Operand) {
        // r, r
        // r, m (displacement)
        // r, m (displace,ent, index)
        // i, r
        // i, m (displacement)
        // i, m (displacement, index)
        // load combinations
        match &(src, dst) {
            (Operand::Reg(lhs), Operand::Reg(rhs)) => self.mov_rr(*lhs, *rhs),
            (Operand::Reg(r), Operand::Mem(addr)) => match addr {
                Address::Base { base, imm } => self.mov_rm(*r, *base, *imm),
            },
            (Operand::Imm(op), Operand::Mem(addr)) => match addr {
                Address::Base { base, imm } => self.mov_im(*op, *base, *imm),
            },
            (Operand::Imm(imm), Operand::Reg(reg)) => self.mov_ir(*imm, *reg),
            (Operand::Mem(addr), Operand::Reg(reg)) => match addr {
                Address::Base { base, imm } => self.mov_mr(*base, *imm, *reg),
            },
            _ => panic!(
                "Invalid operand combination for mov; src = {:?}; dst = {:?}",
                src, dst
            ),
        }
    }

    pub fn mov_rr(&mut self, src: Reg, dst: Reg) {
        let dst = reg_name(dst, 8);
        let src = reg_name(src, 8);

        self.buffer.push(format!("mov {}, {}", dst, src));
    }

    pub fn mov_rm(&mut self, src: Reg, base: Reg, disp: u32) {
        let src = reg_name(src, 8);
        let dst = reg_name(base, 8);

        let addr = if disp == 0 {
            format!("[{}]", dst)
        } else {
            format!("[{} + {}]", dst, disp)
        };

        self.buffer.push(format!("mov {}, {}", addr, src));
    }

    pub fn mov_im(&mut self, imm: i32, base: Reg, disp: u32) {
        let reg = reg_name(base, 8);

        let addr = if disp == 0 {
            format!("[{}]", reg)
        } else {
            format!("[{} + {}]", reg, disp)
        };

        self.buffer.push(format!("mov qword {}, {}", addr, imm));
    }

    pub fn mov_ir(&mut self, imm: i32, dst: Reg) {
        let reg = reg_name(dst, 8);

        self.buffer.push(format!("mov {}, {}", reg, imm));
    }

    pub fn mov_mr(&mut self, base: Reg, disp: u32, dst: Reg) {
        let base = reg_name(base, 8);
        let dst = reg_name(dst, 8);

        let addr = if disp == 0 {
            format!("[{}]", base)
        } else {
            format!("[{} + {}]", base, disp)
        };

        self.buffer.push(format!("mov {}, {}", dst, addr));
    }

    pub fn movl(&mut self, src: Operand, dst: Operand) {
        // r, r
        // r, m (displacement)
        // r, m (displace,ent, index)
        // i, r
        // i, m (displacement)
        // i, m (displacement, index)
        // load combinations
        match &(src, dst) {
            (Operand::Reg(lhs), Operand::Reg(rhs)) => self.movl_rr(*lhs, *rhs),
            (Operand::Reg(r), Operand::Mem(addr)) => match addr {
                Address::Base { base, imm } => self.movl_rm(*r, *base, *imm),
            },
            (Operand::Imm(op), Operand::Mem(addr)) => match addr {
                Address::Base { base, imm } => self.movl_im(*op, *base, *imm),
            },
            (Operand::Imm(imm), Operand::Reg(reg)) => self.movl_ir(*imm, *reg),
            (Operand::Mem(addr), Operand::Reg(reg)) => match addr {
                Address::Base { base, imm } => self.movl_mr(*base, *imm, *reg),
            },

            _ => panic!(
                "Invalid operand combination for movl; src = {:?}; dst = {:?}",
                src, dst
            ),
        }
    }

    pub fn movl_rr(&mut self, src: Reg, dst: Reg) {
        let dst = reg_name(dst, 4);
        let src = reg_name(src, 4);

        self.buffer.push(format!("mov {}, {}", dst, src));
    }

    pub fn movl_rm(&mut self, src: Reg, base: Reg, disp: u32) {
        let src = reg_name(src, 4);
        let dst = reg_name(base, 8);

        let addr = if disp == 0 {
            format!("[{}]", dst)
        } else {
            format!("[{} + {}]", dst, disp)
        };

        self.buffer.push(format!("mov {}, {}", addr, src));
    }

    pub fn movl_im(&mut self, imm: i32, base: Reg, disp: u32) {
        let reg = reg_name(base, 8);

        let addr = if disp == 0 {
            format!("[{}]", reg)
        } else {
            format!("[{} + {}]", reg, disp)
        };

        self.buffer.push(format!("mov dword {}, {}", addr, imm));
    }

    pub fn movl_ir(&mut self, imm: i32, dst: Reg) {
        let reg = reg_name(dst, 4);

        self.buffer.push(format!("mov {}, {}", reg, imm));
    }

    pub fn movl_mr(&mut self, base: Reg, disp: u32, dst: Reg) {
        let base = reg_name(base, 8);
        let dst = reg_name(dst, 4);

        let addr = if disp == 0 {
            format!("[{}]", base)
        } else {
            format!("[{} + {}]", base, disp)
        };

        self.buffer.push(format!("mov {}, {}", dst, addr));
    }

    pub fn sub_ir(&mut self, imm: u32, dst: Reg) {
        let dst = reg_name(dst, 8);
        self.buffer.push(format!("sub {}, {}", dst, imm));
    }

    pub fn add(&mut self, src: Operand, dst: Operand) {
        match &(src, dst) {
            (Operand::Imm(imm), Operand::Reg(dst)) => self.add_ir(*imm, *dst),
            (Operand::Reg(src), Operand::Reg(dst)) => self.add_rr(*src, *dst),
            _ => panic!(
                "Invalid operand combination for add; src = {:?} dst = {:?}",
                src, dst
            ),
        }
    }

    pub fn add_ir(&mut self, imm: i32, dst: Reg) {
        let dst = reg_name(dst, 8);

        self.buffer.push(format!("add {}, {}", dst, imm));
    }

    pub fn add_rr(&mut self, src: Reg, dst: Reg) {
        let src = reg_name(src, 8);
        let dst = reg_name(dst, 8);

        self.buffer.push(format!("add {}, {}", dst, src));
    }

    pub fn addl(&mut self, src: Operand, dst: Operand) {
        match &(src, dst) {
            (Operand::Imm(imm), Operand::Reg(dst)) => self.addl_ir(*imm, *dst),
            (Operand::Reg(src), Operand::Reg(dst)) => self.addl_rr(*src, *dst),
            _ => panic!(
                "Invalid operand combination for add; src = {:?} dst = {:?}",
                src, dst
            ),
        }
    }

    pub fn addl_ir(&mut self, imm: i32, dst: Reg) {
        let dst = reg_name(dst, 4);

        self.buffer.push(format!("add {}, {}", dst, imm));
    }

    pub fn addl_rr(&mut self, src: Reg, dst: Reg) {
        let src = reg_name(src, 4);
        let dst = reg_name(dst, 4);

        self.buffer.push(format!("add {}, {}", dst, src));
    }

    pub fn xorl_rr(&mut self, src: Reg, dst: Reg) {
        let src = reg_name(src, 4);
        let dst = reg_name(dst, 4);

        self.buffer.push(format!("xor {}, {}", dst, src));
    }

    /// Return the emitted code
    pub fn finalize(&mut self) -> &[String] {
        &self.buffer
    }
}

impl From<RegImm> for Operand {
    fn from(rimm: RegImm) -> Self {
        match rimm {
            RegImm::Reg(r) => r.into(),
            RegImm::Imm(imm) => Operand::Imm(imm),
        }
    }
}

impl From<Reg> for Operand {
    fn from(reg: Reg) -> Self {
        Operand::Reg(reg)
    }
}

impl From<Address> for Operand {
    fn from(addr: Address) -> Self {
        Operand::Mem(addr)
    }
}