1;; Prelude definitions specific to lowering environments (backends) in
2;; ISLE.
3
4;;;; Primitive and External Types ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
5
6;; ISLE representation of `Vec<u8>`
7(type VecMask extern (enum))
8
9(type ValueRegs (primitive ValueRegs))
10(type WritableValueRegs (primitive WritableValueRegs))
11(type ValueRegsVec extern (enum))
12
13;; Instruction lowering result: a vector of `ValueRegs`.
14(type InstOutput (primitive InstOutput))
15
16;; Type to hold multiple Regs
17(type MultiReg
18      (enum
19       (Empty)
20       (One (a Reg))
21       (Two (a Reg) (b Reg))
22       (Three (a Reg) (b Reg) (c Reg))
23       (Four (a Reg) (b Reg) (c Reg) (d Reg))
24      ))
25
26;;;; Registers ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
27
28(model Reg (type (bv)))
29(type Reg (primitive Reg))
30(type WritableReg (primitive WritableReg))
31(type OptionWritableReg (primitive OptionWritableReg))
32(type VecReg extern (enum))
33(type VecWritableReg extern (enum))
34(type PReg (primitive PReg))
35
36;; Construct a `ValueRegs` of one register.
37(spec (value_reg arg)
38    (provide (= result arg)))
39(decl value_reg (Reg) ValueRegs)
40(extern constructor value_reg value_reg)
41
42;; Construct a `WritableValueRegs` of one register.
43(decl writable_value_reg (WritableReg) WritableValueRegs)
44(extern constructor writable_value_reg writable_value_reg)
45
46;; Construct a `ValueRegs` of two registers.
47(decl value_regs (Reg Reg) ValueRegs)
48(extern constructor value_regs value_regs)
49
50;; Construct a `WritableValueRegs` of two registers.
51(decl writable_value_regs (WritableReg WritableReg) WritableValueRegs)
52(extern constructor writable_value_regs writable_value_regs)
53
54;; Construct an empty `ValueRegs` containing only invalid register sentinels.
55(decl value_regs_invalid () ValueRegs)
56(extern constructor value_regs_invalid value_regs_invalid)
57
58;; Construct an empty `InstOutput`.
59(decl output_none () InstOutput)
60(extern constructor output_none output_none)
61
62;; Construct a single-element `InstOutput`.
63(spec (output arg)
64      (provide (= arg (conv_to (widthof arg) result))))
65(decl output (ValueRegs) InstOutput)
66(extern constructor output output)
67
68;; Construct a two-element `InstOutput`.
69(decl output_pair (ValueRegs ValueRegs) InstOutput)
70(extern constructor output_pair output_pair)
71
72;; Construct a single-element `InstOutput` from a single register.
73(spec (output_reg arg)
74      (provide (= result (conv_to (widthof result) arg))))
75(instantiate output_reg
76    ((args (bv 64)) (ret (bv 8)) (canon (bv 8)))
77    ((args (bv 64)) (ret (bv 16)) (canon (bv 16)))
78    ((args (bv 64)) (ret (bv 32)) (canon (bv 32)))
79    ((args (bv 64)) (ret (bv 64)) (canon (bv 64)))
80)
81(decl output_reg (Reg) InstOutput)
82(rule output_reg (output_reg reg) (output (value_reg reg)))
83
84;; Construct a single-element `InstOutput` from a value.
85(decl output_value (Value) InstOutput)
86(rule (output_value val) (output (put_in_regs val)))
87
88;; Construct an `InstOutput` from a vector.
89(decl output_vec (ValueRegsVec) InstOutput)
90(extern constructor output_vec output_vec)
91
92;; Get a temporary register for writing.
93(decl temp_writable_reg (Type) WritableReg)
94(extern constructor temp_writable_reg temp_writable_reg)
95
96;; Get a temporary register for reading.
97(decl temp_reg (Type) Reg)
98(rule (temp_reg ty)
99      (writable_reg_to_reg (temp_writable_reg ty)))
100
101(decl is_valid_reg (bool) Reg)
102(extern extractor infallible is_valid_reg is_valid_reg)
103
104;; Get or match the invalid register.
105(decl invalid_reg () Reg)
106(extern constructor invalid_reg invalid_reg)
107(extractor (invalid_reg) (is_valid_reg false))
108
109;; Match any register but the invalid register.
110(decl valid_reg (Reg) Reg)
111(extractor (valid_reg reg) (and (is_valid_reg true) reg))
112
113;; Mark this value as used, to ensure that it gets lowered.
114(decl mark_value_used (Value) Unit)
115(extern constructor mark_value_used mark_value_used)
116
117;; Put the given value into a register.
118;;
119;; Asserts that the value fits into a single register, and doesn't require
120;; multiple registers for its representation (like `i128` on x64 for example).
121;;
122;; As a side effect, this marks the value as used.
123(spec (put_in_reg arg)
124      (provide (= result (conv_to 64 arg))))
125(decl put_in_reg (Value) Reg)
126(extern constructor put_in_reg put_in_reg)
127
128;; Put the given value into one or more registers.
129;;
130;; As a side effect, this marks the value as used.
131(spec (put_in_regs arg) (provide (= (conv_to 64 arg) result)))
132(decl put_in_regs (Value) ValueRegs)
133(extern constructor put_in_regs put_in_regs)
134
135;; Put a slice of values into a vector of ValueRegs.
136(decl put_in_regs_vec (ValueSlice) ValueRegsVec)
137(extern constructor put_in_regs_vec put_in_regs_vec)
138
139;; Get the `n`th register inside a `ValueRegs`.
140(spec (value_regs_get arg i)
141    (provide (= arg result) (= (widthof i) 1)))
142(decl value_regs_get (ValueRegs usize) Reg)
143(extern constructor value_regs_get value_regs_get)
144
145;; Get the number of registers in a `ValueRegs`.
146(decl pure value_regs_len (ValueRegs) usize)
147(extern constructor value_regs_len value_regs_len)
148
149;; Put the value into one or more registers and return the first register.
150;;
151;; Unlike `put_in_reg`, this does not assert that the value fits in a single
152;; register. This is useful for things like a `i128` shift amount, where we mask
153;; the shift amount to the bit width of the value being shifted, and so the high
154;; half of the `i128` won't ever be used.
155;;
156;; As a side effect, this marks that value as used.
157(decl lo_reg (Value) Reg)
158(rule (lo_reg val)
159      (let ((regs ValueRegs (put_in_regs val)))
160        (value_regs_get regs 0)))
161
162;; Convert a `PReg` into a `Reg`.
163(decl preg_to_reg (PReg) Reg)
164(extern constructor preg_to_reg preg_to_reg)
165
166;; Convert a MultiReg with three registers into an InstOutput containing
167;; one ValueRegs containing the first two regs and one containing the third reg
168(decl multi_reg_to_pair_and_single (MultiReg) InstOutput)
169(rule (multi_reg_to_pair_and_single (MultiReg.Three a b c))
170      (output_pair (value_regs a b) c))
171
172;; Convert a MultiReg with two registers into an InstOutput containing one ValueRegs with both regs
173(decl multi_reg_to_pair (MultiReg) InstOutput)
174(rule (multi_reg_to_pair (MultiReg.Two a b))
175      (value_regs a b))
176
177;; Convert a MultiReg with one register into an InstOutput containing one ValueRegs with the register
178(decl multi_reg_to_single (MultiReg) InstOutput)
179(rule (multi_reg_to_single (MultiReg.One a))
180      (value_reg a))
181
182;;;; Common Mach Types ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
183
184(type MachLabel (primitive MachLabel))
185(type ValueLabel (primitive ValueLabel))
186(type UnwindInst (primitive UnwindInst))
187(type ExternalName (primitive ExternalName))
188(type BoxExternalName (primitive BoxExternalName))
189(type RelocDistance extern (enum (Near) (Far)))
190(type VecArgPair extern (enum))
191(type VecRetPair extern (enum))
192(type CallArgList (primitive CallArgList))
193(type CallRetList (primitive CallRetList))
194(type MachLabelSlice extern (enum))
195(type BoxVecMachLabel extern (enum))
196
197;; Extract a the target from a MachLabelSlice with exactly one target.
198(decl single_target (MachLabel) MachLabelSlice)
199(extern extractor single_target single_target)
200
201;; Extract a the targets from a MachLabelSlice with exactly two targets.
202(decl two_targets (MachLabel MachLabel) MachLabelSlice)
203(extern extractor two_targets two_targets)
204
205;; Extract the default target and jump table from a MachLabelSlice.
206(decl jump_table_targets (MachLabel BoxVecMachLabel) MachLabelSlice)
207(extern extractor jump_table_targets jump_table_targets)
208
209;; The size of the jump table.
210(decl jump_table_size (BoxVecMachLabel) u32)
211(extern constructor jump_table_size jump_table_size)
212
213;;;; Helper Clif Extractors ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
214
215;; Extractor to get a `ValueSlice` out of a `ValueList`.
216(decl value_list_slice (ValueSlice) ValueList)
217(extern extractor infallible value_list_slice value_list_slice)
218
219;; Extractor to test whether a `ValueSlice` is empty.
220(decl value_slice_empty () ValueSlice)
221(extern extractor value_slice_empty value_slice_empty)
222
223;; Extractor to split a `ValueSlice` into its first element plus a tail.
224(decl value_slice_unwrap (Value ValueSlice) ValueSlice)
225(extern extractor value_slice_unwrap value_slice_unwrap)
226
227;; Return the length of a `ValueSlice`.
228(decl value_slice_len (ValueSlice) usize)
229(extern constructor value_slice_len value_slice_len)
230
231;; Return any element of a `ValueSlice`.
232(decl value_slice_get (ValueSlice usize) Value)
233(extern constructor value_slice_get value_slice_get)
234
235;; Extractor to get the first element from a value list, along with its tail as
236;; a `ValueSlice`.
237(decl unwrap_head_value_list_1 (Value ValueSlice) ValueList)
238(extractor (unwrap_head_value_list_1 head tail)
239           (value_list_slice (value_slice_unwrap head tail)))
240
241;; Extractor to get the first two elements from a value list, along with its
242;; tail as a `ValueSlice`.
243(decl unwrap_head_value_list_2 (Value Value ValueSlice) ValueList)
244(extractor (unwrap_head_value_list_2 head1 head2 tail)
245           (value_list_slice (value_slice_unwrap head1 (value_slice_unwrap head2 tail))))
246
247;; Turn a `Writable<Reg>` into a `Reg` via `Writable::to_reg`.
248(decl pure writable_reg_to_reg (WritableReg) Reg)
249(extern constructor writable_reg_to_reg writable_reg_to_reg)
250
251;; Extract the result values for the given instruction.
252(decl inst_results (ValueSlice) Inst)
253(extern extractor infallible inst_results inst_results)
254
255;; Returns whether the given value is unused in this function and is a dead
256;; result.
257(decl pure value_is_unused (Value) bool)
258(extern constructor value_is_unused value_is_unused)
259
260;; Extract the first result value of the given instruction.
261(decl first_result (Value) Inst)
262(extern extractor first_result first_result)
263
264;; Extract the `InstructionData` for an `Inst`.
265(decl inst_data_value (Type InstructionData) Inst)
266(extern extractor infallible inst_data_value inst_data_value)
267
268;; Extract the type of the instruction's first result.
269(decl result_type (Type) Inst)
270(extractor (result_type ty)
271           (first_result (value_type ty)))
272
273;; Extract the type of the instruction's first result and pass along the
274;; instruction as well.
275(spec (has_type ty arg)
276      (provide (= result arg))
277      (require (= ty (widthof arg))))
278(decl has_type (Type Inst) Inst)
279(extractor (has_type ty inst)
280           (and (result_type ty)
281                inst))
282
283(decl u8_from_iconst (u8) Value)
284(extractor (u8_from_iconst x)
285           (u64_from_iconst (u8_from_u64 x)))
286
287(decl u16_from_iconst (u16) Value)
288(extractor (u16_from_iconst x)
289           (u64_from_iconst (u16_from_u64 x)))
290
291(decl u32_from_iconst (u32) Value)
292(extractor (u32_from_iconst x)
293           (u64_from_iconst (u32_from_u64 x)))
294
295;; Extract a constant `u64` from a value defined by an `iconst`.
296(spec (u64_from_iconst arg) (provide (= arg (zero_ext 64 result))))
297(decl u64_from_iconst (u64) Value)
298(extractor (u64_from_iconst x)
299           (def_inst (iconst _ (u64_from_imm64 x))))
300
301(decl i8_from_iconst (i8) Value)
302(extractor (i8_from_iconst x)
303           (i64_from_iconst (i8_from_i64 x)))
304
305(decl i16_from_iconst (i16) Value)
306(extractor (i16_from_iconst x)
307           (i64_from_iconst (i16_from_i64 x)))
308
309;; Extract a constant `i32` from a value defined by an `iconst`.
310;; The value is sign extended to 32 bits.
311(spec (i32_from_iconst arg)
312      (provide (= arg (extract 31 0 (sign_ext 64 result))))
313      (require (= result (sign_ext (widthof result) arg))))
314(decl i32_from_iconst (i32) Value)
315(extractor (i32_from_iconst x)
316           (i64_from_iconst (i32_from_i64 x)))
317
318;; Extract a constant `i64` from a value defined by an `iconst`.
319;; The value is sign extended to 64 bits.
320(decl i64_from_iconst (i64) Value)
321(extern extractor i64_from_iconst i64_from_iconst)
322
323;; Match any zero value for iconst, fconst32, fconst64, vconst and splat.
324(decl pure partial zero_value (Value) Value)
325(extern constructor zero_value zero_value)
326
327;; Match a sinkable instruction from a value operand.
328(decl pure partial is_sinkable_inst (Value) Inst)
329(extern constructor is_sinkable_inst is_sinkable_inst)
330
331;; Match a uextend or any other instruction, "seeing through" the uextend if
332;; present.
333(decl maybe_uextend (Value) Value)
334(extern extractor maybe_uextend maybe_uextend)
335
336;; Get an unsigned 8-bit immediate in a u8 from an Imm64, if possible.
337(spec (uimm8 arg)
338    (provide (= result (zero_ext 64 arg)))
339    (require (bvslt result #x0000000000000100)
340             (= (widthof arg) 8)))
341(decl uimm8 (u8) Imm64)
342(extern extractor uimm8 uimm8)
343
344(decl eq (Value Value) Value)
345(extractor (eq x y) (icmp (IntCC.Equal) x y))
346
347(decl ne (Value Value) Value)
348(extractor (ne x y) (icmp (IntCC.NotEqual) x y))
349
350(decl ult (Value Value) Value)
351(extractor (ult x y) (icmp _ (IntCC.UnsignedLessThan) x y))
352
353(decl ule (Value Value) Value)
354(extractor (ule x y) (icmp (IntCC.UnsignedLessThanOrEqual) x y))
355
356(decl ugt (Value Value) Value)
357(extractor (ugt x y) (icmp _ (IntCC.UnsignedGreaterThan) x y))
358
359(decl uge (Value Value) Value)
360(extractor (uge x y) (icmp (IntCC.UnsignedGreaterThanOrEqual) x y))
361
362(decl slt (Value Value) Value)
363(extractor (slt x y) (icmp (IntCC.SignedLessThan) x y))
364
365(decl sle (Value Value) Value)
366(extractor (sle x y) (icmp (IntCC.SignedLessThanOrEqual) x y))
367
368(decl sgt (Value Value) Value)
369(extractor (sgt x y) (icmp (IntCC.SignedGreaterThan) x y))
370
371(decl sge (Value Value) Value)
372(extractor (sge x y) (icmp (IntCC.SignedGreaterThanOrEqual) x y))
373
374;; Get the MachLabel for a particular CLIF block's indexed exception-handling successor.
375(decl block_exn_successor_label (Block u64) MachLabel)
376(extern constructor block_exn_successor_label block_exn_successor_label)
377
378;; Instruction creation helpers ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
379
380;; Emit an instruction.
381;;
382;; This is low-level and side-effectful; it should only be used as an
383;; implementation detail by helpers that preserve the SSA facade themselves.
384
385(decl emit (MInst) Unit)
386(extern constructor emit emit)
387
388;; Sink an instruction.
389;;
390;; This is a side-effectful operation that notifies the context that the
391;; instruction has been sunk into another instruction, and no longer needs to
392;; be lowered.
393(decl sink_inst (Inst) Unit)
394(extern constructor sink_inst sink_inst)
395
396;; Constant pool emission.
397
398(type VCodeConstant (primitive VCodeConstant))
399
400;; Add a u64 little-endian constant to the in-memory constant pool and
401;; return a VCodeConstant index that refers to it. This is
402;; side-effecting but idempotent (constants are deduplicated).
403(decl emit_u64_le_const (u64) VCodeConstant)
404(extern constructor emit_u64_le_const emit_u64_le_const)
405
406;; Add a u64 big-endian constant to the in-memory constant pool and
407;; return a VCodeConstant index that refers to it. This is
408;; side-effecting but idempotent (constants are deduplicated).
409(decl emit_u64_be_const (u64) VCodeConstant)
410(extern constructor emit_u64_be_const emit_u64_be_const)
411
412;; Add a u128 little-endian constant to the in-memory constant pool and
413;; return a VCodeConstant index that refers to it. This is
414;; side-effecting but idempotent (constants are deduplicated).
415(decl emit_u128_le_const (u128) VCodeConstant)
416(extern constructor emit_u128_le_const emit_u128_le_const)
417
418;; Add a u128 big-endian constant to the in-memory constant pool and
419;; return a VCodeConstant index that refers to it. This is
420;; side-effecting but idempotent (constants are deduplicated).
421(decl emit_u128_be_const (u128) VCodeConstant)
422(extern constructor emit_u128_be_const emit_u128_be_const)
423
424;; Fetch the VCodeConstant associated with a Constant.
425(decl const_to_vconst (Constant) VCodeConstant)
426(extern constructor const_to_vconst const_to_vconst)
427
428;;;; Helpers for Side-Effectful Instructions Without Results ;;;;;;;;;;;;;;;;;;;
429
430(type SideEffectNoResult (enum
431                          (Inst (inst MInst))
432                          (Inst2 (inst1 MInst)
433                                 (inst2 MInst))
434                          (Inst3 (inst1 MInst)
435                                 (inst2 MInst)
436                                 (inst3 MInst))))
437
438(model SideEffectNoResult (type Unit))
439
440;; Emit given side-effectful instruction.
441(decl emit_side_effect (SideEffectNoResult) Unit)
442(rule (emit_side_effect (SideEffectNoResult.Inst inst))
443      (emit inst))
444(rule (emit_side_effect (SideEffectNoResult.Inst2 inst1 inst2))
445      (let ((_ Unit (emit inst1)))
446        (emit inst2)))
447(rule (emit_side_effect (SideEffectNoResult.Inst3 inst1 inst2 inst3))
448      (let ((_ Unit (emit inst1))
449            (_ Unit (emit inst2)))
450        (emit inst3)))
451
452;; Create an empty `InstOutput`, but do emit the given side-effectful
453;; instruction.
454(decl side_effect (SideEffectNoResult) InstOutput)
455(spec (side_effect v)
456    (provide (= result v)))
457(rule (side_effect inst)
458      (let ((_ Unit (emit_side_effect inst)))
459        (output_none)))
460
461(decl side_effect_concat (SideEffectNoResult SideEffectNoResult) SideEffectNoResult)
462(rule (side_effect_concat (SideEffectNoResult.Inst inst1) (SideEffectNoResult.Inst inst2))
463      (SideEffectNoResult.Inst2 inst1 inst2))
464(rule (side_effect_concat (SideEffectNoResult.Inst inst1) (SideEffectNoResult.Inst2 inst2 inst3))
465      (SideEffectNoResult.Inst3 inst1 inst2 inst3))
466(rule (side_effect_concat (SideEffectNoResult.Inst2 inst1 inst2) (SideEffectNoResult.Inst inst3))
467      (SideEffectNoResult.Inst3 inst1 inst2 inst3))
468
469;; In certain cases (e.g., RMW lowerings) it can be useful to emit an invalid
470;; register after a side-effectful instruction.
471(decl side_effect_as_invalid (SideEffectNoResult) InstOutput)
472(rule (side_effect_as_invalid inst)
473      (let ((_ InstOutput (side_effect inst)))
474        (invalid_reg)))
475
476;;;; Helpers for Working with Flags ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
477
478;; Newtype wrapper around `MInst` for instructions that are used for their
479;; effect on flags.
480;;
481;; Variant determines how result is given when combined with a
482;; ConsumesFlags. See `with_flags` below for more.
483(type ProducesFlags (enum
484                     ;; For cases where the flags have been produced by another
485                     ;; instruction, and we have out-of-band reasons to know
486                     ;; that they won't be clobbered by the time we depend on
487                     ;; them.
488                     (AlreadyExistingFlags)
489                     (ProducesFlagsSideEffect (inst MInst))
490                     (ProducesFlagsTwiceSideEffect (inst1 MInst) (inst2 MInst))
491                     ;; Not directly combinable with a ConsumesFlags;
492                     ;; used in s390x and unwrapped directly by `trapif`.
493                     (ProducesFlagsReturnsReg (inst MInst) (result Reg))
494                     (ProducesFlagsReturnsResultWithConsumer (inst MInst) (result Reg))))
495
496;; Chain another producer to a `ProducesFlags`.
497(decl produces_flags_concat (ProducesFlags ProducesFlags) ProducesFlags)
498(rule (produces_flags_concat (ProducesFlags.ProducesFlagsSideEffect inst1) (ProducesFlags.ProducesFlagsSideEffect inst2))
499      (ProducesFlags.ProducesFlagsTwiceSideEffect inst1 inst2))
500
501;; Newtype wrapper around `MInst` for instructions that consume and produce flags
502(type ConsumesAndProducesFlags (enum
503                      (SideEffect (inst MInst))
504                      (ReturnsReg (inst MInst) (result Reg))))
505
506;; Newtype wrapper around `MInst` for instructions that consume flags.
507;;
508;; Variant determines how result is given when combined with a
509;; ProducesFlags. See `with_flags` below for more.
510(type ConsumesFlags (enum
511                     (ConsumesFlagsSideEffect (inst MInst))
512                     (ConsumesFlagsSideEffect2 (inst1 MInst) (inst2 MInst))
513                     (ConsumesFlagsReturnsResultWithProducer (inst MInst) (result Reg))
514                     (ConsumesFlagsReturnsReg (inst MInst) (result Reg))
515                     (ConsumesFlagsTwiceReturnsValueRegs (inst1 MInst)
516                                                         (inst2 MInst)
517                                                         (result ValueRegs))
518                     (ConsumesFlagsFourTimesReturnsValueRegs (inst1 MInst)
519                                                             (inst2 MInst)
520                                                             (inst3 MInst)
521                                                             (inst4 MInst)
522                                                             (result ValueRegs))))
523
524
525
526;; Get the produced register out of a ProducesFlags.
527(decl produces_flags_get_reg (ProducesFlags) Reg)
528(rule (produces_flags_get_reg (ProducesFlags.ProducesFlagsReturnsReg _ reg)) reg)
529(rule (produces_flags_get_reg (ProducesFlags.ProducesFlagsReturnsResultWithConsumer _ reg)) reg)
530
531;; Modify a ProducesFlags to use it only for its side-effect, ignoring
532;; its result.
533(decl produces_flags_ignore (ProducesFlags) ProducesFlags)
534(rule (produces_flags_ignore (ProducesFlags.ProducesFlagsReturnsReg inst _))
535      (ProducesFlags.ProducesFlagsSideEffect inst))
536(rule (produces_flags_ignore (ProducesFlags.ProducesFlagsReturnsResultWithConsumer inst _))
537      (ProducesFlags.ProducesFlagsSideEffect inst))
538
539;; Helper for combining two flags-consumer instructions that return a
540;; single Reg, giving a ConsumesFlags that returns both values in a
541;; ValueRegs.
542(decl consumes_flags_concat (ConsumesFlags ConsumesFlags) ConsumesFlags)
543(rule (consumes_flags_concat (ConsumesFlags.ConsumesFlagsReturnsReg inst1 reg1)
544                             (ConsumesFlags.ConsumesFlagsReturnsReg inst2 reg2))
545      (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs
546       inst1
547       inst2
548       (value_regs reg1 reg2)))
549(rule (consumes_flags_concat
550        (ConsumesFlags.ConsumesFlagsSideEffect inst1)
551        (ConsumesFlags.ConsumesFlagsSideEffect inst2))
552      (ConsumesFlags.ConsumesFlagsSideEffect2 inst1 inst2))
553
554;; Get the produced register out of a ConsumesFlags.
555(decl consumes_flags_get_reg (ConsumesFlags) Reg)
556(rule (consumes_flags_get_reg (ConsumesFlags.ConsumesFlagsReturnsReg _ reg)) reg)
557(decl consumes_flags_get_regs (ConsumesFlags) ValueRegs)
558(rule (consumes_flags_get_regs (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs _ _ regs)) regs)
559
560;; Combine flags-producing and -consuming instructions together, ensuring that
561;; they are emitted back-to-back and no other instructions can be emitted
562;; between them and potentially clobber the flags.
563;;
564;; Returns a `ValueRegs` according to the specific combination of ProducesFlags and ConsumesFlags modes:
565;; - SideEffect + ReturnsReg --> ValueReg with one Reg from consumer
566;; - SideEffect + ReturnsValueRegs --> ValueReg as given from consumer
567;; - ReturnsResultWithProducer + ReturnsResultWithConsumer --> ValueReg with low part from producer, high part from consumer
568;;
569;; See `with_flags_reg` below for a variant that extracts out just the lower Reg.
570(decl with_flags (ProducesFlags ConsumesFlags) ValueRegs)
571
572(rule (with_flags (ProducesFlags.ProducesFlagsReturnsResultWithConsumer producer_inst producer_result)
573                  (ConsumesFlags.ConsumesFlagsReturnsResultWithProducer consumer_inst consumer_result))
574      (let ((_x Unit (emit producer_inst))
575            (_y Unit (emit consumer_inst)))
576        (value_regs producer_result consumer_result)))
577
578;; A flag-producer that also produces a result, paired with a consumer that has
579;; no results.
580(rule (with_flags (ProducesFlags.ProducesFlagsReturnsResultWithConsumer producer_inst producer_result)
581                  (ConsumesFlags.ConsumesFlagsSideEffect consumer_inst))
582      (let ((_ Unit (emit producer_inst))
583            (_ Unit (emit consumer_inst)))
584        (value_reg producer_result)))
585
586(rule (with_flags (ProducesFlags.ProducesFlagsSideEffect producer_inst)
587                  (ConsumesFlags.ConsumesFlagsReturnsReg consumer_inst consumer_result))
588      (let ((_x Unit (emit producer_inst))
589            (_y Unit (emit consumer_inst)))
590        (value_reg consumer_result)))
591
592(rule (with_flags (ProducesFlags.ProducesFlagsSideEffect producer_inst)
593                  (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs consumer_inst_1
594                                                                    consumer_inst_2
595                                                                    consumer_result))
596      ;; We must emit these instructions in order as the creator of
597      ;; the ConsumesFlags may be relying on dataflow dependencies
598      ;; amongst them.
599      (let ((_x Unit (emit producer_inst))
600            (_y Unit (emit consumer_inst_1))
601            (_z Unit (emit consumer_inst_2)))
602        consumer_result))
603
604(rule (with_flags (ProducesFlags.ProducesFlagsSideEffect producer_inst)
605                  (ConsumesFlags.ConsumesFlagsFourTimesReturnsValueRegs consumer_inst_1
606                                                                        consumer_inst_2
607                                                                        consumer_inst_3
608                                                                        consumer_inst_4
609                                                                        consumer_result))
610      ;; We must emit these instructions in order as the creator of
611      ;; the ConsumesFlags may be relying on dataflow dependencies
612      ;; amongst them.
613      (let ((_x Unit (emit producer_inst))
614            (_y Unit (emit consumer_inst_1))
615            (_z Unit (emit consumer_inst_2))
616            (_w Unit (emit consumer_inst_3))
617            (_v Unit (emit consumer_inst_4)))
618        consumer_result))
619
620(rule (with_flags (ProducesFlags.ProducesFlagsTwiceSideEffect producer_inst1 producer_inst2)
621                  (ConsumesFlags.ConsumesFlagsReturnsReg consumer_inst consumer_result))
622      (let ((_ Unit (emit producer_inst1))
623            (_ Unit (emit producer_inst2))
624            (_ Unit (emit consumer_inst)))
625        (value_reg consumer_result)))
626
627(rule (with_flags (ProducesFlags.ProducesFlagsTwiceSideEffect producer_inst1 producer_inst2)
628                  (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs consumer_inst_1
629                                                                    consumer_inst_2
630                                                                    consumer_result))
631      ;; We must emit these instructions in order as the creator of
632      ;; the ConsumesFlags may be relying on dataflow dependencies
633      ;; amongst them.
634      (let ((_ Unit (emit producer_inst1))
635            (_ Unit (emit producer_inst2))
636            (_ Unit (emit consumer_inst_1))
637            (_ Unit (emit consumer_inst_2)))
638        consumer_result))
639
640(rule (with_flags (ProducesFlags.ProducesFlagsTwiceSideEffect producer_inst1 producer_inst2)
641                  (ConsumesFlags.ConsumesFlagsFourTimesReturnsValueRegs consumer_inst_1
642                                                                        consumer_inst_2
643                                                                        consumer_inst_3
644                                                                        consumer_inst_4
645                                                                        consumer_result))
646      ;; We must emit these instructions in order as the creator of
647      ;; the ConsumesFlags may be relying on dataflow dependencies
648      ;; amongst them.
649      (let ((_ Unit (emit producer_inst1))
650            (_ Unit (emit producer_inst2))
651            (_ Unit (emit consumer_inst_1))
652            (_ Unit (emit consumer_inst_2))
653            (_ Unit (emit consumer_inst_3))
654            (_ Unit (emit consumer_inst_4)))
655        consumer_result))
656
657(decl with_flags_reg (ProducesFlags ConsumesFlags) Reg)
658(rule (with_flags_reg p c)
659      (let ((v ValueRegs (with_flags p c)))
660        (value_regs_get v 0)))
661
662;; Indicate that the current state of the flags register from the instruction
663;; that produces this Value is relied on.
664(decl flags_to_producesflags (Value) ProducesFlags)
665(rule (flags_to_producesflags val)
666      (let ((_ Unit (mark_value_used val)))
667        (ProducesFlags.AlreadyExistingFlags)))
668
669;; Combine a flags-producing instruction and a flags-consuming instruction that
670;; produces no results.
671;;
672;; This function handles the following case only:
673;; - ProducesFlagsSideEffect + ConsumesFlagsSideEffect
674(decl with_flags_side_effect (ProducesFlags ConsumesFlags) SideEffectNoResult)
675
676(rule (with_flags_side_effect
677        (ProducesFlags.AlreadyExistingFlags)
678        (ConsumesFlags.ConsumesFlagsSideEffect c))
679      (SideEffectNoResult.Inst c))
680
681(rule (with_flags_side_effect
682        (ProducesFlags.AlreadyExistingFlags)
683        (ConsumesFlags.ConsumesFlagsSideEffect2 c1 c2))
684      (SideEffectNoResult.Inst2 c1 c2))
685
686(rule (with_flags_side_effect
687        (ProducesFlags.ProducesFlagsSideEffect p)
688        (ConsumesFlags.ConsumesFlagsSideEffect c))
689      (SideEffectNoResult.Inst2 p c))
690
691(rule (with_flags_side_effect
692        (ProducesFlags.ProducesFlagsSideEffect p)
693        (ConsumesFlags.ConsumesFlagsSideEffect2 c1 c2))
694      (SideEffectNoResult.Inst3 p c1 c2))
695
696(rule (with_flags_side_effect
697        (ProducesFlags.ProducesFlagsTwiceSideEffect p1 p2)
698        (ConsumesFlags.ConsumesFlagsSideEffect c))
699      (SideEffectNoResult.Inst3 p1 p2 c))
700
701;; Combine flag-producing and -consuming instruction that allows more than two results to be returned
702(decl with_flags_chained (ProducesFlags ConsumesAndProducesFlags ConsumesFlags) MultiReg)
703
704;; ProducesFlags.SideEffect + ConsumesAndProducesFlags.SideEffect with all possible ConsumeFlags options
705(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
706                          (ConsumesAndProducesFlags.SideEffect middle_inst)
707                          (ConsumesFlags.ConsumesFlagsSideEffect consume_inst))
708      (let ((_ Unit (emit prod_inst))
709            (_ Unit (emit middle_inst))
710            (_ Unit (emit consume_inst)))
711        (MultiReg.Empty)))
712
713(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
714                          (ConsumesAndProducesFlags.SideEffect middle_inst)
715                          (ConsumesFlags.ConsumesFlagsSideEffect2 consume_inst1 consume_inst2))
716      (let ((_ Unit (emit prod_inst))
717            (_ Unit (emit middle_inst))
718            (_ Unit (emit consume_inst1))
719            (_ Unit (emit consume_inst2)))
720        (MultiReg.Empty)))
721
722(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
723                          (ConsumesAndProducesFlags.SideEffect middle_inst)
724                          (ConsumesFlags.ConsumesFlagsReturnsReg consume_inst reg))
725      (let ((_ Unit (emit prod_inst))
726            (_ Unit (emit middle_inst))
727            (_ Unit (emit consume_inst)))
728        (MultiReg.One reg)))
729
730(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
731                          (ConsumesAndProducesFlags.SideEffect middle_inst)
732                          (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs consume_inst1 consume_inst2 consume_result))
733      (let ((_ Unit (emit prod_inst))
734            (_ Unit (emit middle_inst))
735            (_ Unit (emit consume_inst1))
736            (_ Unit (emit consume_inst2)))
737        (MultiReg.Two (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
738
739(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
740                          (ConsumesAndProducesFlags.SideEffect middle_inst)
741                          (ConsumesFlags.ConsumesFlagsFourTimesReturnsValueRegs consume_inst1 consume_inst2 consume_inst3 consume_inst4 consume_result))
742      (let ((_ Unit (emit prod_inst))
743            (_ Unit (emit middle_inst))
744            (_ Unit (emit consume_inst1))
745            (_ Unit (emit consume_inst2))
746            (_ Unit (emit consume_inst3))
747            (_ Unit (emit consume_inst4)))
748        (MultiReg.Two (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
749
750
751;; ProducesFlags.ReturnsReg + ConsumesAndProducesFlags.SideEffect with all possible ConsumeFlags options
752(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
753                          (ConsumesAndProducesFlags.SideEffect middle_inst)
754                          (ConsumesFlags.ConsumesFlagsSideEffect consume_inst))
755      (let ((_ Unit (emit prod_inst))
756            (_ Unit (emit middle_inst))
757            (_ Unit (emit consume_inst)))
758        (MultiReg.One prod_result)))
759
760(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
761                          (ConsumesAndProducesFlags.SideEffect middle_inst)
762                          (ConsumesFlags.ConsumesFlagsSideEffect2 consume_inst1 consume_inst2))
763      (let ((_ Unit (emit prod_inst))
764            (_ Unit (emit middle_inst))
765            (_ Unit (emit consume_inst1))
766            (_ Unit (emit consume_inst2)))
767        (MultiReg.One prod_result)))
768
769(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
770                          (ConsumesAndProducesFlags.SideEffect middle_inst)
771                          (ConsumesFlags.ConsumesFlagsReturnsReg consume_inst consume_result))
772      (let ((_ Unit (emit prod_inst))
773            (_ Unit (emit middle_inst))
774            (_ Unit (emit consume_inst)))
775        (MultiReg.Two prod_result consume_result)))
776
777(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
778                          (ConsumesAndProducesFlags.SideEffect middle_inst)
779                          (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs consume_inst1 consume_inst2 consume_result))
780      (let ((_ Unit (emit prod_inst))
781            (_ Unit (emit middle_inst))
782            (_ Unit (emit consume_inst1))
783            (_ Unit (emit consume_inst2)))
784        (MultiReg.Three prod_result (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
785
786(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
787                          (ConsumesAndProducesFlags.SideEffect middle_inst)
788                          (ConsumesFlags.ConsumesFlagsFourTimesReturnsValueRegs consume_inst1 consume_inst2 consume_inst3 consume_inst4 consume_result))
789      (let ((_ Unit (emit prod_inst))
790            (_ Unit (emit middle_inst))
791            (_ Unit (emit consume_inst1))
792            (_ Unit (emit consume_inst2))
793            (_ Unit (emit consume_inst3))
794            (_ Unit (emit consume_inst4)))
795        (MultiReg.Three prod_result (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
796
797
798;; ProducesFlags.SideEffect + ConsumesAndProducesFlags.ReturnsReg with all possible ConsumeFlags options
799(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
800                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
801                          (ConsumesFlags.ConsumesFlagsSideEffect consume_inst))
802      (let ((_ Unit (emit prod_inst))
803            (_ Unit (emit middle_inst))
804            (_ Unit (emit consume_inst)))
805        (MultiReg.One middle_result)))
806
807(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
808                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
809                          (ConsumesFlags.ConsumesFlagsSideEffect2 consume_inst1 consume_inst2))
810      (let ((_ Unit (emit prod_inst))
811            (_ Unit (emit middle_inst))
812            (_ Unit (emit consume_inst1))
813            (_ Unit (emit consume_inst2)))
814        (MultiReg.One middle_result)))
815
816(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
817                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
818                          (ConsumesFlags.ConsumesFlagsReturnsReg consume_inst consume_result))
819      (let ((_ Unit (emit prod_inst))
820            (_ Unit (emit middle_inst))
821            (_ Unit (emit consume_inst)))
822        (MultiReg.Two middle_result consume_result)))
823
824(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
825                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
826                          (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs consume_inst1 consume_inst2 consume_result))
827      (let ((_ Unit (emit prod_inst))
828            (_ Unit (emit middle_inst))
829            (_ Unit (emit consume_inst1))
830            (_ Unit (emit consume_inst2)))
831        (MultiReg.Three middle_result (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
832
833(rule (with_flags_chained (ProducesFlags.ProducesFlagsSideEffect prod_inst)
834                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
835                          (ConsumesFlags.ConsumesFlagsFourTimesReturnsValueRegs consume_inst1 consume_inst2 consume_inst3 consume_inst4 consume_result))
836      (let ((_ Unit (emit prod_inst))
837            (_ Unit (emit middle_inst))
838            (_ Unit (emit consume_inst1))
839            (_ Unit (emit consume_inst2))
840            (_ Unit (emit consume_inst3))
841            (_ Unit (emit consume_inst4)))
842        (MultiReg.Three middle_result (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
843
844
845;; ProducesFlags.ReturnsReg + ConsumesAndProducesFlags.ReturnsReg with all possible ConsumeFlags options
846(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
847                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
848                          (ConsumesFlags.ConsumesFlagsSideEffect consume_inst))
849      (let ((_ Unit (emit prod_inst))
850            (_ Unit (emit middle_inst))
851            (_ Unit (emit consume_inst)))
852        (MultiReg.Two prod_result middle_result)))
853
854(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
855                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
856                          (ConsumesFlags.ConsumesFlagsSideEffect2 consume_inst1 consume_inst2))
857      (let ((_ Unit (emit prod_inst))
858            (_ Unit (emit middle_inst))
859            (_ Unit (emit consume_inst1))
860            (_ Unit (emit consume_inst2)))
861        (MultiReg.Two prod_result middle_result)))
862
863(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
864                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
865                          (ConsumesFlags.ConsumesFlagsReturnsReg consume_inst consume_result))
866      (let ((_ Unit (emit prod_inst))
867            (_ Unit (emit middle_inst))
868            (_ Unit (emit consume_inst)))
869        (MultiReg.Three prod_result middle_result consume_result)))
870
871(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
872                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
873                          (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs consume_inst1 consume_inst2 consume_result))
874      (let ((_ Unit (emit prod_inst))
875            (_ Unit (emit middle_inst))
876            (_ Unit (emit consume_inst1))
877            (_ Unit (emit consume_inst2)))
878        (MultiReg.Four prod_result middle_result (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
879
880(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsReg prod_inst prod_result)
881                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
882                          (ConsumesFlags.ConsumesFlagsFourTimesReturnsValueRegs consume_inst1 consume_inst2 consume_inst3 consume_inst4 consume_result))
883      (let ((_ Unit (emit prod_inst))
884            (_ Unit (emit middle_inst))
885            (_ Unit (emit consume_inst1))
886            (_ Unit (emit consume_inst2))
887            (_ Unit (emit consume_inst3))
888            (_ Unit (emit consume_inst4)))
889        (MultiReg.Four prod_result middle_result (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
890
891;; ProducesFlags.ReturnsResultWithConsumer + ConsumesAndProducesFlags.ReturnsReg with all possible ConsumeFlags options
892(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsResultWithConsumer prod_inst prod_result)
893                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
894                          (ConsumesFlags.ConsumesFlagsSideEffect consume_inst))
895      (let ((_ Unit (emit prod_inst))
896            (_ Unit (emit middle_inst))
897            (_ Unit (emit consume_inst)))
898        (MultiReg.Two prod_result middle_result)))
899
900(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsResultWithConsumer prod_inst prod_result)
901                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
902                          (ConsumesFlags.ConsumesFlagsSideEffect2 consume_inst1 consume_inst2))
903      (let ((_ Unit (emit prod_inst))
904            (_ Unit (emit middle_inst))
905            (_ Unit (emit consume_inst1))
906            (_ Unit (emit consume_inst2)))
907        (MultiReg.Two prod_result middle_result)))
908
909(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsResultWithConsumer prod_inst prod_result)
910                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
911                          (ConsumesFlags.ConsumesFlagsReturnsReg consume_inst consume_result))
912      (let ((_ Unit (emit prod_inst))
913            (_ Unit (emit middle_inst))
914            (_ Unit (emit consume_inst)))
915        (MultiReg.Three prod_result middle_result consume_result)))
916
917(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsResultWithConsumer prod_inst prod_result)
918                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
919                          (ConsumesFlags.ConsumesFlagsReturnsResultWithProducer consume_inst consume_result))
920      (let ((_ Unit (emit prod_inst))
921            (_ Unit (emit middle_inst))
922            (_ Unit (emit consume_inst)))
923        (MultiReg.Three prod_result middle_result consume_result)))
924
925(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsResultWithConsumer prod_inst prod_result)
926                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
927                          (ConsumesFlags.ConsumesFlagsTwiceReturnsValueRegs consume_inst1 consume_inst2 consume_result))
928      (let ((_ Unit (emit prod_inst))
929            (_ Unit (emit middle_inst))
930            (_ Unit (emit consume_inst1))
931            (_ Unit (emit consume_inst2)))
932        (MultiReg.Four prod_result middle_result (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
933
934(rule (with_flags_chained (ProducesFlags.ProducesFlagsReturnsResultWithConsumer prod_inst prod_result)
935                          (ConsumesAndProducesFlags.ReturnsReg middle_inst middle_result)
936                          (ConsumesFlags.ConsumesFlagsFourTimesReturnsValueRegs consume_inst1 consume_inst2 consume_inst3 consume_inst4 consume_result))
937      (let ((_ Unit (emit prod_inst))
938            (_ Unit (emit middle_inst))
939            (_ Unit (emit consume_inst1))
940            (_ Unit (emit consume_inst2))
941            (_ Unit (emit consume_inst3))
942            (_ Unit (emit consume_inst4)))
943        (MultiReg.Four prod_result middle_result (value_regs_get consume_result 0) (value_regs_get consume_result 1))))
944
945;;;; Helpers for accessing compilation flags ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
946
947;; This definition should be kept up to date with the values defined in
948;; cranelift/codegen/meta/src/shared/settings.rs
949(type TlsModel extern (enum (None) (ElfGd) (Macho) (Coff)))
950
951(decl tls_model (TlsModel) Type)
952(extern extractor infallible tls_model tls_model)
953
954(decl pure partial tls_model_is_elf_gd () Unit)
955(extern constructor tls_model_is_elf_gd tls_model_is_elf_gd)
956
957(decl pure partial tls_model_is_macho () Unit)
958(extern constructor tls_model_is_macho tls_model_is_macho)
959
960(decl pure partial tls_model_is_coff () Unit)
961(extern constructor tls_model_is_coff tls_model_is_coff)
962
963(decl pure partial preserve_frame_pointers () Unit)
964(extern constructor preserve_frame_pointers preserve_frame_pointers)
965
966;; This definition should be kept up to date with the values defined in
967;; cranelift/codegen/meta/src/shared/settings.rs
968(type StackSwitchModel extern (enum (None) (Basic) (UpdateWindowsTib)))
969
970(decl pure partial stack_switch_model () StackSwitchModel)
971(extern constructor stack_switch_model stack_switch_model)
972
973;;;; Helpers for accessing instruction data ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
974
975(decl box_external_name (ExternalName) BoxExternalName)
976(extern constructor box_external_name box_external_name)
977
978;; Accessor for `FuncRef`.
979
980(decl func_ref_data (SigRef ExternalName RelocDistance bool) FuncRef)
981(extern extractor infallible func_ref_data func_ref_data)
982
983;; Accessor for `ExceptionTable`.
984(decl exception_sig (SigRef) ExceptionTable)
985(extern extractor infallible exception_sig exception_sig)
986
987;; Accessor for `GlobalValue`.
988
989(decl symbol_value_data (ExternalName RelocDistance i64) GlobalValue)
990(extern extractor symbol_value_data symbol_value_data)
991
992;; Accessor for `Immediate` as a vector of u8 values.
993
994(decl vec_mask_from_immediate (VecMask) Immediate)
995(extern extractor vec_mask_from_immediate vec_mask_from_immediate)
996
997;; Accessor for `Immediate` as u128.
998
999(decl u128_from_immediate (u128) Immediate)
1000(extern extractor u128_from_immediate u128_from_immediate)
1001
1002;; Extracts an `Immediate` as a `VCodeConstant`.
1003
1004(decl vconst_from_immediate (VCodeConstant) Immediate)
1005(extern extractor vconst_from_immediate vconst_from_immediate)
1006
1007;; Accessor for `Constant` as u128.
1008
1009(decl u128_from_constant (u128) Constant)
1010(extern extractor u128_from_constant u128_from_constant)
1011
1012;; Accessor for `Constant` as u64.
1013
1014(decl u64_from_constant (u64) Constant)
1015(extern extractor u64_from_constant u64_from_constant)
1016
1017;; Extracts lane indices, represented as u8's, if the immediate for a
1018;; `shuffle` instruction represents shuffling N-bit values. The u8 values
1019;; returned will be in the range of 0 to (256/N)-1, inclusive, and index the
1020;; N-bit chunks of two concatenated 128-bit vectors starting from the
1021;; least-significant bits.
1022(decl shuffle64_from_imm (u8 u8) Immediate)
1023(extern extractor shuffle64_from_imm shuffle64_from_imm)
1024(decl shuffle32_from_imm (u8 u8 u8 u8) Immediate)
1025(extern extractor shuffle32_from_imm shuffle32_from_imm)
1026(decl shuffle16_from_imm (u8 u8 u8 u8 u8 u8 u8 u8) Immediate)
1027(extern extractor shuffle16_from_imm shuffle16_from_imm)
1028
1029;;;; Helpers for generating returns ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1030
1031;; Extractor to check for the special case that a `WritableValueRegs`
1032;; contains only a single register.
1033(decl only_writable_reg (WritableReg) WritableValueRegs)
1034(extern extractor only_writable_reg only_writable_reg)
1035
1036;; Get the `n`th register inside a `WritableValueRegs`.
1037(decl writable_regs_get (WritableValueRegs usize) WritableReg)
1038(extern constructor writable_regs_get writable_regs_get)
1039
1040;;;; Helpers for generating calls ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1041
1042;; Type to hold information about a function call signature.
1043(type Sig (primitive Sig))
1044
1045;; Information how to pass one argument or return value.
1046(type ABIArg extern (enum))
1047
1048;; Information how to pass a single slot of one argument or return value.
1049(type ABIArgSlot extern
1050  (enum
1051    (Reg
1052      (reg RealReg)
1053      (ty Type)
1054      (extension ArgumentExtension))
1055    (Stack
1056      (offset i64)
1057      (ty Type)
1058      (extension ArgumentExtension))))
1059
1060;; Physical register that may hold an argument or return value.
1061(type RealReg (primitive RealReg))
1062
1063;; Instruction on whether and how to extend an argument value.
1064(model ArgumentExtension
1065  (enum
1066    (None)
1067    (Uext)
1068    (Sext)))
1069(type ArgumentExtension extern
1070  (enum
1071    (None)
1072    (Uext)
1073    (Sext)))
1074
1075;; Create a Sig from a SigRef.
1076(decl abi_sig (SigRef) Sig)
1077(extern constructor abi_sig abi_sig)
1078
1079;; Get the number of arguments expected.
1080(decl abi_num_args (Sig) usize)
1081(extern constructor abi_num_args abi_num_args)
1082
1083;; Get information specifying how to pass one argument.
1084(decl abi_get_arg (Sig usize) ABIArg)
1085(extern constructor abi_get_arg abi_get_arg)
1086
1087;; Get the number of return values expected.
1088(decl abi_num_rets (Sig) usize)
1089(extern constructor abi_num_rets abi_num_rets)
1090
1091;; Get information specifying how to pass one return value.
1092(decl abi_get_ret (Sig usize) ABIArg)
1093(extern constructor abi_get_ret abi_get_ret)
1094
1095;; Get information specifying how to pass the implicit pointer
1096;; to the return-value area on the stack, if required.
1097(decl abi_ret_arg (ABIArg) Sig)
1098(extern extractor abi_ret_arg abi_ret_arg)
1099
1100;; Succeeds if no implicit return-value area pointer is required.
1101(decl abi_no_ret_arg () Sig)
1102(extern extractor abi_no_ret_arg abi_no_ret_arg)
1103
1104;; Incoming return area pointer (must be present).
1105(decl abi_unwrap_ret_area_ptr () Reg)
1106(extern constructor abi_unwrap_ret_area_ptr abi_unwrap_ret_area_ptr)
1107
1108;; StackSlot addr
1109(decl abi_stackslot_addr (WritableReg StackSlot Offset32) MInst)
1110(extern constructor abi_stackslot_addr abi_stackslot_addr)
1111
1112;; StackSlot raw offset into slot region
1113(decl abi_stackslot_offset_into_slot_region (StackSlot Offset32 Offset32) i32)
1114(extern constructor abi_stackslot_offset_into_slot_region abi_stackslot_offset_into_slot_region)
1115
1116;; DynamicStackSlot addr
1117(decl abi_dynamic_stackslot_addr (WritableReg DynamicStackSlot) MInst)
1118(extern constructor abi_dynamic_stackslot_addr abi_dynamic_stackslot_addr)
1119
1120;; Extractor to detect the special case where an argument or
1121;; return value only requires a single slot to be passed.
1122(decl abi_arg_only_slot (ABIArgSlot) ABIArg)
1123(extern extractor abi_arg_only_slot abi_arg_only_slot)
1124
1125;; Extractor to detect the special case where a non-struct argument
1126;; is implicitly passed by reference using a hidden pointer.
1127(decl abi_arg_implicit_pointer (ABIArgSlot i64 Type) ABIArg)
1128(extern extractor abi_arg_implicit_pointer abi_arg_implicit_pointer)
1129
1130;; Convert a real register number into a virtual register.
1131(decl real_reg_to_reg (RealReg) Reg)
1132(extern constructor real_reg_to_reg real_reg_to_reg)
1133
1134;; Convert a real register number into a writable virtual register.
1135(decl real_reg_to_writable_reg (RealReg) WritableReg)
1136(extern constructor real_reg_to_writable_reg real_reg_to_writable_reg)
1137
1138;; Generate a move between two registers.
1139(decl gen_move (Type WritableReg Reg) MInst)
1140(extern constructor gen_move gen_move)
1141
1142;; Generate a return instruction
1143(decl lower_return (ValueSlice) InstOutput)
1144(rule (lower_return vals)
1145      (let ((_ Unit (gen_return vals)))
1146        (output_none)))
1147
1148(decl gen_return (ValueRegsVec) Unit)
1149(extern constructor gen_return gen_return)
1150
1151(decl gen_call_output (SigRef) ValueRegsVec)
1152(extern constructor gen_call_output gen_call_output)
1153
1154(decl gen_call_args (Sig ValueRegsVec) CallArgList)
1155(extern constructor gen_call_args gen_call_args)
1156
1157(decl gen_return_call_args (Sig ValueRegsVec) CallArgList)
1158(extern constructor gen_return_call_args gen_return_call_args)
1159
1160(decl gen_call_rets (Sig ValueRegsVec) CallRetList)
1161(extern constructor gen_call_rets gen_call_rets)
1162
1163(decl gen_try_call_rets (Sig) CallRetList)
1164(extern constructor gen_try_call_rets gen_try_call_rets)
1165
1166(decl gen_patchable_call_rets () CallRetList)
1167(extern constructor gen_patchable_call_rets gen_patchable_call_rets)
1168
1169(type OptionTryCallInfo (primitive OptionTryCallInfo))
1170(decl try_call_info (ExceptionTable MachLabelSlice) OptionTryCallInfo)
1171(extern constructor try_call_info try_call_info)
1172(decl try_call_none () OptionTryCallInfo)
1173(extern constructor try_call_none try_call_none)
1174
1175;; Helper for extracting an immediate that's not 0 and not -1 from an imm64.
1176 (spec (safe_divisor_from_imm64 t x)
1177       (provide (= (sign_ext 64 x) result))
1178       (require (not (= #x0000000000000000 result))
1179                (not (= #x1111111111111111 result))))
1180(decl pure partial safe_divisor_from_imm64 (Type Imm64) u64)
1181(extern constructor safe_divisor_from_imm64 safe_divisor_from_imm64)
1182
1183;;;; Automatic conversions ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1184
1185(convert Inst Value def_inst)
1186(convert Reg ValueRegs value_reg)
1187(convert WritableReg WritableValueRegs writable_value_reg)
1188(convert Value Reg put_in_reg)
1189(convert Value ValueRegs put_in_regs)
1190(convert ValueSlice ValueRegsVec put_in_regs_vec)
1191(convert WritableReg Reg writable_reg_to_reg)
1192(convert ValueRegs InstOutput output)
1193(convert Reg InstOutput output_reg)
1194(convert Value InstOutput output_value)
1195(convert ValueRegsVec InstOutput output_vec)
1196(convert ExternalName BoxExternalName box_external_name)
1197(convert PReg Reg preg_to_reg)
1198