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