codegen.rs 11.6 KB
Newer Older
1
// Copyright 2017 The Australian National University
qinsoon's avatar
qinsoon committed
2
//
3 4 5
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
qinsoon's avatar
qinsoon committed
6
//
7
//     http://www.apache.org/licenses/LICENSE-2.0
qinsoon's avatar
qinsoon committed
8
//
9 10 11 12 13 14
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

15 16
use ast::ptr::P;
use ast::ir::*;
qinsoon's avatar
qinsoon committed
17
use runtime::ValueLocation;
18

qinsoon's avatar
qinsoon committed
19
use compiler::machine_code::MachineCode;
20
use compiler::backend::{Reg, Mem};
21

qinsoon's avatar
qinsoon committed
22 23 24 25 26
/// CodeGenerator provides an interface to emit x86_64 code for instruction selection.
/// This allows us to implement the other parts of the compiler (mostly instruction selection)
/// without assuming code generator. Currently there is only an assembly backend
/// that implements this interface for ahead-of-time compilation. We plan to add
/// a binary backend for just-in-time compilation.
27
pub trait CodeGenerator {
qinsoon's avatar
qinsoon committed
28
    /// starts code for a function
29
    fn start_code(&mut self, func_name: MuName, entry: MuName) -> ValueLocation;
qinsoon's avatar
qinsoon committed
30
    /// finishes code for a function
qinsoon's avatar
qinsoon committed
31 32
    fn finish_code(&mut self, func_name: MuName)
        -> (Box<MachineCode + Sync + Send>, ValueLocation);
33

qinsoon's avatar
qinsoon committed
34
    /// starts a sequence of linear code (no branch)
35
    fn start_code_sequence(&mut self);
qinsoon's avatar
qinsoon committed
36
    /// finishes code for a sequence
37
    fn finish_code_sequence(&mut self) -> Box<MachineCode + Sync + Send>;
qinsoon's avatar
qinsoon committed
38 39

    /// outputs current code (via debug! log)
40
    fn print_cur_code(&self);
qinsoon's avatar
qinsoon committed
41 42

    /// starts a block
qinsoon's avatar
qinsoon committed
43
    fn start_block(&mut self, block_name: MuName);
qinsoon's avatar
qinsoon committed
44
    /// starts an exceptional block, and returns its code address
qinsoon's avatar
qinsoon committed
45
    fn start_exception_block(&mut self, block_name: MuName) -> ValueLocation;
qinsoon's avatar
qinsoon committed
46 47
    /// finishes a block (must have called start_block() or start_excpetion_block() first)
    fn end_block(&mut self, block_name: MuName);
qinsoon's avatar
qinsoon committed
48

qinsoon's avatar
qinsoon committed
49
    // adds CFI info
qinsoon's avatar
qinsoon committed
50 51 52 53 54 55
    fn add_cfi_startproc(&mut self);
    fn add_cfi_endproc(&mut self);
    fn add_cfi_def_cfa_register(&mut self, reg: Reg);
    fn add_cfi_def_cfa_offset(&mut self, offset: i32);
    fn add_cfi_offset(&mut self, reg: Reg, offset: i32);

qinsoon's avatar
qinsoon committed
56
    // emit code to adjust frame size
qinsoon's avatar
qinsoon committed
57
    fn emit_frame_grow(&mut self);
58

59
    fn emit_nop(&mut self, bytes: usize);
60 61

    // comparison
qinsoon's avatar
qinsoon committed
62
    fn emit_cmp_r_r(&mut self, op1: Reg, op2: Reg);
63 64
    fn emit_cmp_imm_r(&mut self, op1: i32, op2: Reg);
    fn emit_cmp_mem_r(&mut self, op1: Reg, op2: Reg);
65

qinsoon's avatar
qinsoon committed
66
    fn emit_test_r_r(&mut self, op1: Reg, op2: Reg);
qinsoon's avatar
qinsoon committed
67
    fn emit_test_imm_r(&mut self, op1: i32, op2: Reg);
68

69
    // gpr move
qinsoon's avatar
qinsoon committed
70 71

    // mov imm64 to r64
qinsoon's avatar
qinsoon committed
72
    fn emit_mov_r64_imm64(&mut self, dest: Reg, src: i64);
qinsoon's avatar
qinsoon committed
73
    // mov r64 to fpr
qinsoon's avatar
qinsoon committed
74
    fn emit_mov_fpr_r64(&mut self, dest: Reg, src: Reg);
75

qinsoon's avatar
qinsoon committed
76 77 78 79
    fn emit_mov_r_imm(&mut self, dest: Reg, src: i32);
    fn emit_mov_r_mem(&mut self, dest: Reg, src: Mem); // load
    fn emit_mov_r_r(&mut self, dest: Reg, src: Reg);
    fn emit_mov_mem_r(&mut self, dest: Mem, src: Reg); // store
80 81 82
    // we can infer imm length from Reg, but cannot from Mem
    // because mem may only have type as ADDRESS_TYPE
    fn emit_mov_mem_imm(&mut self, dest: Mem, src: i32, oplen: usize); // store
83

qinsoon's avatar
qinsoon committed
84 85
    fn emit_mov_mem_r_callee_saved(&mut self, dest: Mem, src: Reg); // store callee saved register
    fn emit_mov_r_mem_callee_saved(&mut self, dest: Reg, src: Mem); // load callee saved register
86

87
    // zero/sign extend mov
qinsoon's avatar
qinsoon committed
88 89
    fn emit_movs_r_r(&mut self, dest: Reg, src: Reg);
    fn emit_movz_r_r(&mut self, dest: Reg, src: Reg);
90

qinsoon's avatar
qinsoon committed
91
    // set byte
qinsoon's avatar
qinsoon committed
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    fn emit_sets_r8(&mut self, dest: Reg);
    fn emit_setz_r8(&mut self, dest: Reg);
    fn emit_seto_r8(&mut self, dest: Reg);
    fn emit_setb_r8(&mut self, dest: Reg);

    fn emit_seta_r(&mut self, dest: Reg);
    fn emit_setae_r(&mut self, dest: Reg);
    fn emit_setb_r(&mut self, dest: Reg);
    fn emit_setbe_r(&mut self, dest: Reg);
    fn emit_sete_r(&mut self, dest: Reg);
    fn emit_setg_r(&mut self, dest: Reg);
    fn emit_setge_r(&mut self, dest: Reg);
    fn emit_setl_r(&mut self, dest: Reg);
    fn emit_setle_r(&mut self, dest: Reg);
    fn emit_setne_r(&mut self, dest: Reg);
107

qinsoon's avatar
qinsoon committed
108 109
    // gpr conditional move

qinsoon's avatar
qinsoon committed
110
    fn emit_cmova_r_r(&mut self, dest: Reg, src: Reg);
111
    fn emit_cmova_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
112

qinsoon's avatar
qinsoon committed
113
    fn emit_cmovae_r_r(&mut self, dest: Reg, src: Reg);
114
    fn emit_cmovae_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
115

qinsoon's avatar
qinsoon committed
116
    fn emit_cmovb_r_r(&mut self, dest: Reg, src: Reg);
117
    fn emit_cmovb_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
118

qinsoon's avatar
qinsoon committed
119
    fn emit_cmovbe_r_r(&mut self, dest: Reg, src: Reg);
120
    fn emit_cmovbe_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
121

qinsoon's avatar
qinsoon committed
122
    fn emit_cmove_r_r(&mut self, dest: Reg, src: Reg);
123
    fn emit_cmove_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
124

qinsoon's avatar
qinsoon committed
125
    fn emit_cmovg_r_r(&mut self, dest: Reg, src: Reg);
126
    fn emit_cmovg_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
127

qinsoon's avatar
qinsoon committed
128
    fn emit_cmovge_r_r(&mut self, dest: Reg, src: Reg);
129
    fn emit_cmovge_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
130

qinsoon's avatar
qinsoon committed
131
    fn emit_cmovl_r_r(&mut self, dest: Reg, src: Reg);
132
    fn emit_cmovl_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
133

qinsoon's avatar
qinsoon committed
134
    fn emit_cmovle_r_r(&mut self, dest: Reg, src: Reg);
135
    fn emit_cmovle_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
136

qinsoon's avatar
qinsoon committed
137
    fn emit_cmovne_r_r(&mut self, dest: Reg, src: Reg);
138
    fn emit_cmovne_r_mem(&mut self, dest: Reg, src: Mem); // load
qinsoon's avatar
qinsoon committed
139

140
    // lea
141
    fn emit_lea_r64(&mut self, dest: Reg, src: Mem);
142 143

    // and
144
    fn emit_and_r_imm(&mut self, dest: Reg, src: i32);
qinsoon's avatar
qinsoon committed
145
    fn emit_and_r_r(&mut self, dest: Reg, src: Reg);
146
    fn emit_and_r_mem(&mut self, dest: Reg, src: Mem);
147

148
    // or
qinsoon's avatar
qinsoon committed
149
    fn emit_or_r_r(&mut self, dest: Reg, src: Reg);
150 151
    fn emit_or_r_imm(&mut self, dest: Reg, src: i32);
    fn emit_or_r_mem(&mut self, dest: Reg, src: Mem);
152

153
    // xor
qinsoon's avatar
qinsoon committed
154
    fn emit_xor_r_r(&mut self, dest: Reg, src: Reg);
155 156
    fn emit_xor_r_mem(&mut self, dest: Reg, src: Mem);
    fn emit_xor_r_imm(&mut self, dest: Reg, src: i32);
157

158
    // add
qinsoon's avatar
qinsoon committed
159
    fn emit_add_r_r(&mut self, dest: Reg, src: Reg);
160 161
    fn emit_add_r_mem(&mut self, dest: Reg, src: Mem);
    fn emit_add_r_imm(&mut self, dest: Reg, src: i32);
qinsoon's avatar
qinsoon committed
162 163

    // add with carry
qinsoon's avatar
qinsoon committed
164
    fn emit_adc_r_r(&mut self, dest: Reg, src: Reg);
qinsoon's avatar
qinsoon committed
165 166
    fn emit_adc_r_mem(&mut self, dest: Reg, src: Mem);
    fn emit_adc_r_imm(&mut self, dest: Reg, src: i32);
qinsoon's avatar
qinsoon committed
167

168
    // sub
qinsoon's avatar
qinsoon committed
169
    fn emit_sub_r_r(&mut self, dest: Reg, src: Reg);
170 171
    fn emit_sub_r_mem(&mut self, dest: Reg, src: Mem);
    fn emit_sub_r_imm(&mut self, dest: Reg, src: i32);
172

173
    // sub with borrow
qinsoon's avatar
qinsoon committed
174
    fn emit_sbb_r_r(&mut self, dest: Reg, src: Reg);
175 176 177
    fn emit_sbb_r_mem(&mut self, dest: Reg, src: Mem);
    fn emit_sbb_r_imm(&mut self, dest: Reg, src: i32);

178
    // multiply
qinsoon's avatar
qinsoon committed
179
    fn emit_mul_r(&mut self, src: Reg);
180
    fn emit_mul_mem(&mut self, src: Mem);
181

182 183 184
    // signed multiply
    fn emit_imul_r_r(&mut self, dest: Reg, src: Reg);

185
    // div
qinsoon's avatar
qinsoon committed
186 187
    fn emit_div_r(&mut self, src: Reg);
    fn emit_div_mem(&mut self, src: Mem);
188 189

    // idiv
qinsoon's avatar
qinsoon committed
190
    fn emit_idiv_r(&mut self, src: Reg);
191
    fn emit_idiv_mem(&mut self, src: Mem);
192 193

    // shl
qinsoon's avatar
qinsoon committed
194 195 196
    fn emit_shl_r_cl(&mut self, dest: Reg);
    fn emit_shl_r_imm8(&mut self, dest: Reg, src: i8);
    fn emit_shld_r_r_cl(&mut self, dest: Reg, src: Reg);
qinsoon's avatar
qinsoon committed
197

qinsoon's avatar
qinsoon committed
198 199 200
    fn emit_shr_r_cl(&mut self, dest: &P<Value>);
    fn emit_shr_r_imm8(&mut self, dest: &P<Value>, src: i8);
    fn emit_shrd_r_r_cl(&mut self, dest: Reg, src: Reg);
qinsoon's avatar
qinsoon committed
201

qinsoon's avatar
qinsoon committed
202 203
    fn emit_sar_r_cl(&mut self, dest: &P<Value>);
    fn emit_sar_r_imm8(&mut self, dest: &P<Value>, src: i8);
qinsoon's avatar
qinsoon committed
204

qinsoon's avatar
qinsoon committed
205 206 207
    fn emit_cqo(&mut self); // sign extend rax to rdx:rax
    fn emit_cdq(&mut self); // sign extend eax to edx:eax
    fn emit_cwd(&mut self); // sign extend ax  to dx:ax
qinsoon's avatar
qinsoon committed
208 209

    // jump, conditional jump
210
    fn emit_jmp(&mut self, dest: MuName);
qinsoon's avatar
qinsoon committed
211
    fn emit_je(&mut self, dest: MuName);
212
    fn emit_jne(&mut self, dest: MuName);
qinsoon's avatar
qinsoon committed
213
    fn emit_ja(&mut self, dest: MuName);
214
    fn emit_jae(&mut self, dest: MuName);
qinsoon's avatar
qinsoon committed
215
    fn emit_jb(&mut self, dest: MuName);
216
    fn emit_jbe(&mut self, dest: MuName);
qinsoon's avatar
qinsoon committed
217
    fn emit_jg(&mut self, dest: MuName);
218
    fn emit_jge(&mut self, dest: MuName);
qinsoon's avatar
qinsoon committed
219
    fn emit_jl(&mut self, dest: MuName);
220
    fn emit_jle(&mut self, dest: MuName);
221
    fn emit_js(&mut self, dest: MuName);
qinsoon's avatar
qinsoon committed
222 223

    // call
qinsoon's avatar
qinsoon committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
    fn emit_call_near_rel32(
        &mut self,
        callsite: String,
        func: MuName,
        pe: Option<MuName>,
        is_native: bool,
    ) -> ValueLocation;
    fn emit_call_near_r64(
        &mut self,
        callsite: String,
        func: &P<Value>,
        pe: Option<MuName>,
    ) -> ValueLocation;
    fn emit_call_near_mem64(
        &mut self,
        callsite: String,
        func: &P<Value>,
        pe: Option<MuName>,
    ) -> ValueLocation;

qinsoon's avatar
qinsoon committed
244
    fn emit_ret(&mut self);
qinsoon's avatar
qinsoon committed
245

qinsoon's avatar
qinsoon committed
246
    // push/pop
247
    fn emit_push_r64(&mut self, src: &P<Value>);
248
    fn emit_push_imm32(&mut self, src: i32);
249
    fn emit_pop_r64(&mut self, dest: &P<Value>);
250 251

    // fpr move
qinsoon's avatar
qinsoon committed
252
    fn emit_movsd_f64_f64(&mut self, dest: &P<Value>, src: &P<Value>);
253 254
    fn emit_movsd_f64_mem64(&mut self, dest: &P<Value>, src: &P<Value>); // load
    fn emit_movsd_mem64_f64(&mut self, dest: &P<Value>, src: &P<Value>); // store
qinsoon's avatar
qinsoon committed
255

qinsoon's avatar
qinsoon committed
256
    fn emit_movss_f32_f32(&mut self, dest: &P<Value>, src: &P<Value>);
257 258 259
    fn emit_movss_f32_mem32(&mut self, dest: &P<Value>, src: &P<Value>); // load
    fn emit_movss_mem32_f32(&mut self, dest: &P<Value>, src: &P<Value>); // store

qinsoon's avatar
qinsoon committed
260
    // fp add
qinsoon's avatar
qinsoon committed
261
    fn emit_addsd_f64_f64(&mut self, dest: Reg, src: Reg);
qinsoon's avatar
qinsoon committed
262 263
    fn emit_addsd_f64_mem64(&mut self, dest: Reg, src: Mem);

qinsoon's avatar
qinsoon committed
264
    fn emit_addss_f32_f32(&mut self, dest: Reg, src: Reg);
265 266
    fn emit_addss_f32_mem32(&mut self, dest: Reg, src: Mem);

qinsoon's avatar
qinsoon committed
267
    // fp sub
qinsoon's avatar
qinsoon committed
268
    fn emit_subsd_f64_f64(&mut self, dest: Reg, src: Reg);
qinsoon's avatar
qinsoon committed
269 270
    fn emit_subsd_f64_mem64(&mut self, dest: Reg, src: Mem);

qinsoon's avatar
qinsoon committed
271
    fn emit_subss_f32_f32(&mut self, dest: Reg, src: Reg);
272 273
    fn emit_subss_f32_mem32(&mut self, dest: Reg, src: Mem);

qinsoon's avatar
qinsoon committed
274
    // fp div
qinsoon's avatar
qinsoon committed
275
    fn emit_divsd_f64_f64(&mut self, dest: Reg, src: Reg);
qinsoon's avatar
qinsoon committed
276 277
    fn emit_divsd_f64_mem64(&mut self, dest: Reg, src: Mem);

qinsoon's avatar
qinsoon committed
278
    fn emit_divss_f32_f32(&mut self, dest: Reg, src: Reg);
279 280
    fn emit_divss_f32_mem32(&mut self, dest: Reg, src: Mem);

qinsoon's avatar
qinsoon committed
281
    // fp mul
qinsoon's avatar
qinsoon committed
282
    fn emit_mulsd_f64_f64(&mut self, dest: Reg, src: Reg);
qinsoon's avatar
qinsoon committed
283 284
    fn emit_mulsd_f64_mem64(&mut self, dest: Reg, src: Mem);

qinsoon's avatar
qinsoon committed
285
    fn emit_mulss_f32_f32(&mut self, dest: Reg, src: Reg);
286 287
    fn emit_mulss_f32_mem32(&mut self, dest: Reg, src: Mem);

qinsoon's avatar
qinsoon committed
288
    // fp comparison
qinsoon's avatar
qinsoon committed
289 290
    fn emit_comisd_f64_f64(&mut self, op1: Reg, op2: Reg);
    fn emit_ucomisd_f64_f64(&mut self, op1: Reg, op2: Reg);
291

qinsoon's avatar
qinsoon committed
292 293
    fn emit_comiss_f32_f32(&mut self, op1: Reg, op2: Reg);
    fn emit_ucomiss_f32_f32(&mut self, op1: Reg, op2: Reg);
294

295
    // fp conversion
qinsoon's avatar
qinsoon committed
296 297
    fn emit_cvtsi2sd_f64_r(&mut self, dest: Reg, src: Reg);
    fn emit_cvtsd2si_r_f64(&mut self, dest: Reg, src: Reg);
298

qinsoon's avatar
qinsoon committed
299 300
    fn emit_cvtsi2ss_f32_r(&mut self, dest: Reg, src: Reg);
    fn emit_cvtss2si_r_f32(&mut self, dest: Reg, src: Reg);
301 302 303

    // used for unsigned int to fp conversion

qinsoon's avatar
qinsoon committed
304 305
    fn emit_cvttsd2si_r_f64(&mut self, dest: Reg, src: Reg);
    fn emit_cvttss2si_r_f32(&mut self, dest: Reg, src: Reg);
306

307 308 309
    // unpack low data - interleave low byte
    fn emit_punpckldq_f64_mem128(&mut self, dest: Reg, src: Mem);
    // substract packed double-fp
qinsoon's avatar
qinsoon committed
310
    fn emit_subpd_f64_mem128(&mut self, dest: Reg, src: Mem);
311
    // packed double-fp horizontal add
qinsoon's avatar
qinsoon committed
312
    fn emit_haddpd_f64_f64(&mut self, dest: Reg, src: Reg);
313 314 315

    // move aligned packed double-precision fp values
    fn emit_movapd_f64_mem128(&mut self, dest: Reg, src: Mem);
qinsoon's avatar
qinsoon committed
316
    fn emit_movapd_f64_f64(&mut self, dest: Reg, src: Mem);
317

qinsoon's avatar
qinsoon committed
318
    fn emit_movaps_f32_f32(&mut self, dest: Reg, src: Reg);
319 320 321

    // memory fence
    fn emit_mfence(&mut self);
322
}