-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
gen_inst.rs
1144 lines (1043 loc) · 39 KB
/
gen_inst.rs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! Generate instruction data (including opcodes, formats, builders, etc.).
use std::fmt;
use cranelift_codegen_shared::constant_hash;
use cranelift_entity::EntityRef;
use crate::cdsl::camel_case;
use crate::cdsl::formats::InstructionFormat;
use crate::cdsl::instructions::{AllInstructions, Instruction};
use crate::cdsl::operands::Operand;
use crate::cdsl::typevar::{TypeSet, TypeVar};
use crate::error;
use crate::srcgen::{Formatter, Match};
use crate::unique_table::{UniqueSeqTable, UniqueTable};
// TypeSet indexes are encoded in 8 bits, with `0xff` reserved.
const TYPESET_LIMIT: usize = 0xff;
/// Generate an instruction format enumeration.
fn gen_formats(formats: &[&InstructionFormat], fmt: &mut Formatter) {
fmt.doc_comment(
r#"
An instruction format
Every opcode has a corresponding instruction format
which is represented by both the `InstructionFormat`
and the `InstructionData` enums.
"#,
);
fmt.line("#[derive(Copy, Clone, PartialEq, Eq, Debug)]");
fmt.line("pub enum InstructionFormat {");
fmt.indent(|fmt| {
for format in formats {
fmt.doc_comment(format.to_string());
fmtln!(fmt, "{},", format.name);
}
});
fmt.line("}");
fmt.empty_line();
// Emit a From<InstructionData> which also serves to verify that
// InstructionFormat and InstructionData are in sync.
fmt.line("impl<'a> From<&'a InstructionData> for InstructionFormat {");
fmt.indent(|fmt| {
fmt.line("fn from(inst: &'a InstructionData) -> Self {");
fmt.indent(|fmt| {
let mut m = Match::new("*inst");
for format in formats {
m.arm(
format!("InstructionData::{}", format.name),
vec![".."],
format!("Self::{}", format.name),
);
}
fmt.add_match(m);
});
fmt.line("}");
});
fmt.line("}");
fmt.empty_line();
}
/// Generate the InstructionData enum.
///
/// Every variant must contain an `opcode` field. The size of `InstructionData` should be kept at
/// 16 bytes on 64-bit architectures. If more space is needed to represent an instruction, use a
/// `ValueList` to store the additional information out of line.
fn gen_instruction_data(formats: &[&InstructionFormat], fmt: &mut Formatter) {
fmt.line("#[derive(Clone, Debug)]");
fmt.line("#[allow(missing_docs)]");
fmt.line("pub enum InstructionData {");
fmt.indent(|fmt| {
for format in formats {
fmtln!(fmt, "{} {{", format.name);
fmt.indent(|fmt| {
fmt.line("opcode: Opcode,");
if format.typevar_operand.is_some() {
if format.has_value_list {
fmt.line("args: ValueList,");
} else if format.num_value_operands == 1 {
fmt.line("arg: Value,");
} else {
fmtln!(fmt, "args: [Value; {}],", format.num_value_operands);
}
}
for field in &format.imm_fields {
fmtln!(fmt, "{}: {},", field.member, field.kind.rust_type);
}
});
fmtln!(fmt, "},");
}
});
fmt.line("}");
}
fn gen_arguments_method(formats: &[&InstructionFormat], fmt: &mut Formatter, is_mut: bool) {
let (method, mut_, rslice, as_slice) = if is_mut {
(
"arguments_mut",
"mut ",
"core::slice::from_mut",
"as_mut_slice",
)
} else {
("arguments", "", "core::slice::from_ref", "as_slice")
};
fmtln!(
fmt,
"pub fn {}<'a>(&'a {}self, pool: &'a {}ir::ValueListPool) -> &{}[Value] {{",
method,
mut_,
mut_,
mut_
);
fmt.indent(|fmt| {
let mut m = Match::new("*self");
for format in formats {
let name = format!("Self::{}", format.name);
// Formats with a value list put all of their arguments in the list. We don't split
// them up, just return it all as variable arguments. (I expect the distinction to go
// away).
if format.has_value_list {
m.arm(
name,
vec![format!("ref {}args", mut_), "..".to_string()],
format!("args.{}(pool)", as_slice),
);
continue;
}
// Fixed args.
let mut fields = Vec::new();
let arg = if format.num_value_operands == 0 {
format!("&{}[]", mut_)
} else if format.num_value_operands == 1 {
fields.push(format!("ref {}arg", mut_));
format!("{}(arg)", rslice)
} else {
let arg = format!("args_arity{}", format.num_value_operands);
fields.push(format!("args: ref {}{}", mut_, arg));
arg
};
fields.push("..".into());
m.arm(name, fields, arg);
}
fmt.add_match(m);
});
fmtln!(fmt, "}");
}
/// Generate the boring parts of the InstructionData implementation.
///
/// These methods in `impl InstructionData` can be generated automatically from the instruction
/// formats:
///
/// - `pub fn opcode(&self) -> Opcode`
/// - `pub fn arguments(&self, &pool) -> &[Value]`
/// - `pub fn arguments_mut(&mut self, &pool) -> &mut [Value]`
/// - `pub fn take_value_list(&mut self) -> Option<ir::ValueList>`
/// - `pub fn put_value_list(&mut self, args: ir::ValueList>`
/// - `pub fn eq(&self, &other: Self, &pool) -> bool`
/// - `pub fn hash<H: Hasher>(&self, state: &mut H, &pool)`
fn gen_instruction_data_impl(formats: &[&InstructionFormat], fmt: &mut Formatter) {
fmt.line("impl InstructionData {");
fmt.indent(|fmt| {
fmt.doc_comment("Get the opcode of this instruction.");
fmt.line("pub fn opcode(&self) -> Opcode {");
fmt.indent(|fmt| {
let mut m = Match::new("*self");
for format in formats {
m.arm(format!("Self::{}", format.name), vec!["opcode", ".."],
"opcode".to_string());
}
fmt.add_match(m);
});
fmt.line("}");
fmt.empty_line();
fmt.doc_comment("Get the controlling type variable operand.");
fmt.line("pub fn typevar_operand(&self, pool: &ir::ValueListPool) -> Option<Value> {");
fmt.indent(|fmt| {
let mut m = Match::new("*self");
for format in formats {
let name = format!("Self::{}", format.name);
if format.typevar_operand.is_none() {
m.arm(name, vec![".."], "None".to_string());
} else if format.has_value_list {
// We keep all arguments in a value list.
m.arm(name, vec!["ref args", ".."], format!("args.get({}, pool)", format.typevar_operand.unwrap()));
} else if format.num_value_operands == 1 {
m.arm(name, vec!["arg", ".."], "Some(arg)".to_string());
} else {
// We have multiple value operands and an array `args`.
// Which `args` index to use?
let args = format!("args_arity{}", format.num_value_operands);
m.arm(name, vec![format!("args: ref {}", args), "..".to_string()],
format!("Some({}[{}])", args, format.typevar_operand.unwrap()));
}
}
fmt.add_match(m);
});
fmt.line("}");
fmt.empty_line();
fmt.doc_comment("Get the value arguments to this instruction.");
gen_arguments_method(formats, fmt, false);
fmt.empty_line();
fmt.doc_comment(r#"Get mutable references to the value arguments to this
instruction."#);
gen_arguments_method(formats, fmt, true);
fmt.empty_line();
fmt.doc_comment(r#"
Take out the value list with all the value arguments and return
it.
This leaves the value list in the instruction empty. Use
`put_value_list` to put the value list back.
"#);
fmt.line("pub fn take_value_list(&mut self) -> Option<ir::ValueList> {");
fmt.indent(|fmt| {
let mut m = Match::new("*self");
for format in formats {
if format.has_value_list {
m.arm(format!("Self::{}", format.name),
vec!["ref mut args", ".."],
"Some(args.take())".to_string());
}
}
m.arm_no_fields("_", "None");
fmt.add_match(m);
});
fmt.line("}");
fmt.empty_line();
fmt.doc_comment(r#"
Put back a value list.
After removing a value list with `take_value_list()`, use this
method to put it back. It is required that this instruction has
a format that accepts a value list, and that the existing value
list is empty. This avoids leaking list pool memory.
"#);
fmt.line("pub fn put_value_list(&mut self, vlist: ir::ValueList) {");
fmt.indent(|fmt| {
fmt.line("let args = match *self {");
fmt.indent(|fmt| {
for format in formats {
if format.has_value_list {
fmtln!(fmt, "Self::{} {{ ref mut args, .. }} => args,", format.name);
}
}
fmt.line("_ => panic!(\"No value list: {:?}\", self),");
});
fmt.line("};");
fmt.line("debug_assert!(args.is_empty(), \"Value list already in use\");");
fmt.line("*args = vlist;");
});
fmt.line("}");
fmt.empty_line();
fmt.doc_comment(r#"
Compare two `InstructionData` for equality.
This operation requires a reference to a `ValueListPool` to
determine if the contents of any `ValueLists` are equal.
"#);
fmt.line("pub fn eq(&self, other: &Self, pool: &ir::ValueListPool) -> bool {");
fmt.indent(|fmt| {
fmt.line("if ::core::mem::discriminant(self) != ::core::mem::discriminant(other) {");
fmt.indent(|fmt| {
fmt.line("return false;");
});
fmt.line("}");
fmt.line("match (self, other) {");
fmt.indent(|fmt| {
for format in formats {
let name = format!("&Self::{}", format.name);
let mut members = vec!["opcode"];
let args_eq = if format.typevar_operand.is_none() {
None
} else if format.has_value_list {
members.push("args");
Some("args1.as_slice(pool) == args2.as_slice(pool)")
} else if format.num_value_operands == 1 {
members.push("arg");
Some("arg1 == arg2")
} else {
members.push("args");
Some("args1 == args2")
};
for field in &format.imm_fields {
members.push(field.member);
}
let pat1 = members.iter().map(|x| format!("{}: ref {}1", x, x)).collect::<Vec<_>>().join(", ");
let pat2 = members.iter().map(|x| format!("{}: ref {}2", x, x)).collect::<Vec<_>>().join(", ");
fmtln!(fmt, "({} {{ {} }}, {} {{ {} }}) => {{", name, pat1, name, pat2);
fmt.indent(|fmt| {
fmt.line("opcode1 == opcode2");
for field in &format.imm_fields {
fmtln!(fmt, "&& {}1 == {}2", field.member, field.member);
}
if let Some(args_eq) = args_eq {
fmtln!(fmt, "&& {}", args_eq);
}
});
fmtln!(fmt, "}");
}
fmt.line("_ => unreachable!()");
});
fmt.line("}");
});
fmt.line("}");
fmt.empty_line();
fmt.doc_comment(r#"
Hash an `InstructionData`.
This operation requires a reference to a `ValueListPool` to
hash the contents of any `ValueLists`.
"#);
fmt.line("pub fn hash<H: ::core::hash::Hasher>(&self, state: &mut H, pool: &ir::ValueListPool) {");
fmt.indent(|fmt| {
fmt.line("match *self {");
fmt.indent(|fmt| {
for format in formats {
let name = format!("Self::{}", format.name);
let mut members = vec!["opcode"];
let args = if format.typevar_operand.is_none() {
"&()"
} else if format.has_value_list {
members.push("ref args");
"args.as_slice(pool)"
} else if format.num_value_operands == 1 {
members.push("ref arg");
"arg"
} else {
members.push("ref args");
"args"
};
for field in &format.imm_fields {
members.push(field.member);
}
let members = members.join(", ");
fmtln!(fmt, "{}{{{}}} => {{", name, members ); // beware the moustaches
fmt.indent(|fmt| {
fmt.line("::core::hash::Hash::hash( &::core::mem::discriminant(self), state);");
fmt.line("::core::hash::Hash::hash(&opcode, state);");
for field in &format.imm_fields {
fmtln!(fmt, "::core::hash::Hash::hash(&{}, state);", field.member);
}
fmtln!(fmt, "::core::hash::Hash::hash({}, state);", args);
});
fmtln!(fmt, "}");
}
});
fmt.line("}");
});
fmt.line("}");
});
fmt.line("}");
}
fn gen_bool_accessor<T: Fn(&Instruction) -> bool>(
all_inst: &AllInstructions,
get_attr: T,
name: &'static str,
doc: &'static str,
fmt: &mut Formatter,
) {
fmt.doc_comment(doc);
fmtln!(fmt, "pub fn {}(self) -> bool {{", name);
fmt.indent(|fmt| {
let mut m = Match::new("self");
for inst in all_inst.values() {
if get_attr(inst) {
m.arm_no_fields(format!("Self::{}", inst.camel_name), "true");
}
}
m.arm_no_fields("_", "false");
fmt.add_match(m);
});
fmtln!(fmt, "}");
fmt.empty_line();
}
fn gen_opcodes(all_inst: &AllInstructions, fmt: &mut Formatter) {
fmt.doc_comment(
r#"
An instruction opcode.
All instructions from all supported ISAs are present.
"#,
);
fmt.line("#[derive(Copy, Clone, PartialEq, Eq, Debug, Hash)]");
// We explicitly set the discriminant of the first variant to 1, which allows us to take
// advantage of the NonZero optimization, meaning that wrapping enums can use the 0
// discriminant instead of increasing the size of the whole type, and so the size of
// Option<Opcode> is the same as Opcode's.
fmt.line("pub enum Opcode {");
fmt.indent(|fmt| {
let mut is_first_opcode = true;
for inst in all_inst.values() {
fmt.doc_comment(format!("`{}`. ({})", inst, inst.format.name));
// Document polymorphism.
if let Some(poly) = &inst.polymorphic_info {
if poly.use_typevar_operand {
let op_num = inst.value_opnums[inst.format.typevar_operand.unwrap()];
fmt.doc_comment(format!(
"Type inferred from `{}`.",
inst.operands_in[op_num].name
));
}
}
// Enum variant itself.
if is_first_opcode {
assert!(inst.opcode_number.index() == 0);
// TODO the python crate requires opcode numbers to start from one.
fmtln!(fmt, "{} = 1,", inst.camel_name);
is_first_opcode = false;
} else {
fmtln!(fmt, "{},", inst.camel_name)
}
}
});
fmt.line("}");
fmt.empty_line();
fmt.line("impl Opcode {");
fmt.indent(|fmt| {
gen_bool_accessor(
all_inst,
|inst| inst.is_terminator,
"is_terminator",
"True for instructions that terminate the block",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.is_branch,
"is_branch",
"True for all branch or jump instructions.",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.is_indirect_branch,
"is_indirect_branch",
"True for all indirect branch or jump instructions.",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.is_call,
"is_call",
"Is this a call instruction?",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.is_return,
"is_return",
"Is this a return instruction?",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.is_ghost,
"is_ghost",
"Is this a ghost instruction?",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.can_load,
"can_load",
"Can this instruction read from memory?",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.can_store,
"can_store",
"Can this instruction write to memory?",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.can_trap,
"can_trap",
"Can this instruction cause a trap?",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.other_side_effects,
"other_side_effects",
"Does this instruction have other side effects besides can_* flags?",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.writes_cpu_flags,
"writes_cpu_flags",
"Does this instruction write to CPU flags?",
fmt,
);
gen_bool_accessor(
all_inst,
|inst| inst.clobbers_all_regs,
"clobbers_all_regs",
"Should this opcode be considered to clobber all the registers, during regalloc?",
fmt,
);
});
fmt.line("}");
fmt.empty_line();
// Generate a private opcode_format table.
fmtln!(
fmt,
"const OPCODE_FORMAT: [InstructionFormat; {}] = [",
all_inst.len()
);
fmt.indent(|fmt| {
for inst in all_inst.values() {
fmtln!(
fmt,
"InstructionFormat::{}, // {}",
inst.format.name,
inst.name
);
}
});
fmtln!(fmt, "];");
fmt.empty_line();
// Generate a private opcode_name function.
fmt.line("fn opcode_name(opc: Opcode) -> &\'static str {");
fmt.indent(|fmt| {
let mut m = Match::new("opc");
for inst in all_inst.values() {
m.arm_no_fields(
format!("Opcode::{}", inst.camel_name),
format!("\"{}\"", inst.name),
);
}
fmt.add_match(m);
});
fmt.line("}");
fmt.empty_line();
// Generate an opcode hash table for looking up opcodes by name.
let hash_table = constant_hash::generate_table(all_inst.values(), all_inst.len(), |inst| {
constant_hash::simple_hash(&inst.name)
});
fmtln!(
fmt,
"const OPCODE_HASH_TABLE: [Option<Opcode>; {}] = [",
hash_table.len()
);
fmt.indent(|fmt| {
for i in hash_table {
match i {
Some(i) => fmtln!(fmt, "Some(Opcode::{}),", i.camel_name),
None => fmtln!(fmt, "None,"),
}
}
});
fmtln!(fmt, "];");
fmt.empty_line();
}
/// Get the value type constraint for an SSA value operand, where
/// `ctrl_typevar` is the controlling type variable.
///
/// Each operand constraint is represented as a string, one of:
/// - `Concrete(vt)`, where `vt` is a value type name.
/// - `Free(idx)` where `idx` is an index into `type_sets`.
/// - `Same`, `Lane`, `AsBool` for controlling typevar-derived constraints.
fn get_constraint<'entries, 'table>(
operand: &'entries Operand,
ctrl_typevar: Option<&TypeVar>,
type_sets: &'table mut UniqueTable<'entries, TypeSet>,
) -> String {
assert!(operand.is_value());
let type_var = operand.type_var().unwrap();
if let Some(typ) = type_var.singleton_type() {
return format!("Concrete({})", typ.rust_name());
}
if let Some(free_typevar) = type_var.free_typevar() {
if ctrl_typevar.is_some() && free_typevar != *ctrl_typevar.unwrap() {
assert!(type_var.base.is_none());
return format!("Free({})", type_sets.add(&type_var.get_raw_typeset()));
}
}
if let Some(base) = &type_var.base {
assert!(base.type_var == *ctrl_typevar.unwrap());
return camel_case(base.derived_func.name());
}
assert!(type_var == ctrl_typevar.unwrap());
"Same".into()
}
fn gen_bitset<'a, T: IntoIterator<Item = &'a u16>>(
iterable: T,
name: &'static str,
field_size: u8,
fmt: &mut Formatter,
) {
let bits = iterable.into_iter().fold(0, |acc, x| {
assert!(x.is_power_of_two());
assert!(u32::from(*x) < (1 << u32::from(field_size)));
acc | x
});
fmtln!(fmt, "{}: BitSet::<u{}>({}),", name, field_size, bits);
}
fn iterable_to_string<I: fmt::Display, T: IntoIterator<Item = I>>(iterable: T) -> String {
let elems = iterable
.into_iter()
.map(|x| x.to_string())
.collect::<Vec<_>>()
.join(", ");
format!("{{{}}}", elems)
}
fn typeset_to_string(ts: &TypeSet) -> String {
let mut result = format!("TypeSet(lanes={}", iterable_to_string(&ts.lanes));
if !ts.ints.is_empty() {
result += &format!(", ints={}", iterable_to_string(&ts.ints));
}
if !ts.floats.is_empty() {
result += &format!(", floats={}", iterable_to_string(&ts.floats));
}
if !ts.bools.is_empty() {
result += &format!(", bools={}", iterable_to_string(&ts.bools));
}
if !ts.specials.is_empty() {
result += &format!(", specials=[{}]", iterable_to_string(&ts.specials));
}
if !ts.refs.is_empty() {
result += &format!(", refs={}", iterable_to_string(&ts.refs));
}
result += ")";
result
}
/// Generate the table of ValueTypeSets described by type_sets.
pub(crate) fn gen_typesets_table(type_sets: &UniqueTable<TypeSet>, fmt: &mut Formatter) {
if type_sets.len() == 0 {
return;
}
fmt.comment("Table of value type sets.");
assert!(type_sets.len() <= TYPESET_LIMIT, "Too many type sets!");
fmtln!(
fmt,
"const TYPE_SETS: [ir::instructions::ValueTypeSet; {}] = [",
type_sets.len()
);
fmt.indent(|fmt| {
for ts in type_sets.iter() {
fmt.line("ir::instructions::ValueTypeSet {");
fmt.indent(|fmt| {
fmt.comment(typeset_to_string(ts));
gen_bitset(&ts.lanes, "lanes", 16, fmt);
gen_bitset(&ts.ints, "ints", 8, fmt);
gen_bitset(&ts.floats, "floats", 8, fmt);
gen_bitset(&ts.bools, "bools", 8, fmt);
gen_bitset(&ts.refs, "refs", 8, fmt);
});
fmt.line("},");
}
});
fmtln!(fmt, "];");
}
/// Generate value type constraints for all instructions.
/// - Emit a compact constant table of ValueTypeSet objects.
/// - Emit a compact constant table of OperandConstraint objects.
/// - Emit an opcode-indexed table of instruction constraints.
fn gen_type_constraints(all_inst: &AllInstructions, fmt: &mut Formatter) {
// Table of TypeSet instances.
let mut type_sets = UniqueTable::new();
// Table of operand constraint sequences (as tuples). Each operand
// constraint is represented as a string, one of:
// - `Concrete(vt)`, where `vt` is a value type name.
// - `Free(idx)` where `idx` is an index into `type_sets`.
// - `Same`, `Lane`, `AsBool` for controlling typevar-derived constraints.
let mut operand_seqs = UniqueSeqTable::new();
// Preload table with constraints for typical binops.
#[allow(clippy::useless_vec)]
operand_seqs.add(&vec!["Same".to_string(); 3]);
fmt.comment("Table of opcode constraints.");
fmtln!(
fmt,
"const OPCODE_CONSTRAINTS: [OpcodeConstraints; {}] = [",
all_inst.len()
);
fmt.indent(|fmt| {
for inst in all_inst.values() {
let (ctrl_typevar, ctrl_typeset) = if let Some(poly) = &inst.polymorphic_info {
let index = type_sets.add(&*poly.ctrl_typevar.get_raw_typeset());
(Some(&poly.ctrl_typevar), index)
} else {
(None, TYPESET_LIMIT)
};
// Collect constraints for the value results, not including `variable_args` results
// which are always special cased.
let mut constraints = Vec::new();
for &index in &inst.value_results {
constraints.push(get_constraint(&inst.operands_out[index], ctrl_typevar, &mut type_sets));
}
for &index in &inst.value_opnums {
constraints.push(get_constraint(&inst.operands_in[index], ctrl_typevar, &mut type_sets));
}
let constraint_offset = operand_seqs.add(&constraints);
let fixed_results = inst.value_results.len();
let fixed_values = inst.value_opnums.len();
// Can the controlling type variable be inferred from the designated operand?
let use_typevar_operand = if let Some(poly) = &inst.polymorphic_info {
poly.use_typevar_operand
} else {
false
};
// Can the controlling type variable be inferred from the result?
let use_result = fixed_results > 0 && inst.operands_out[inst.value_results[0]].type_var() == ctrl_typevar;
// Are we required to use the designated operand instead of the result?
let requires_typevar_operand = use_typevar_operand && !use_result;
fmt.comment(
format!("{}: fixed_results={}, use_typevar_operand={}, requires_typevar_operand={}, fixed_values={}",
inst.camel_name,
fixed_results,
use_typevar_operand,
requires_typevar_operand,
fixed_values)
);
fmt.comment(format!("Constraints=[{}]", constraints
.iter()
.map(|x| format!("'{}'", x))
.collect::<Vec<_>>()
.join(", ")));
if let Some(poly) = &inst.polymorphic_info {
fmt.comment(format!("Polymorphic over {}", typeset_to_string(&poly.ctrl_typevar.get_raw_typeset())));
}
// Compute the bit field encoding, c.f. instructions.rs.
assert!(fixed_results < 8 && fixed_values < 8, "Bit field encoding too tight");
let mut flags = fixed_results; // 3 bits
if use_typevar_operand {
flags |= 1<<3; // 4th bit
}
if requires_typevar_operand {
flags |= 1<<4; // 5th bit
}
flags |= fixed_values << 5; // 6th bit and more
fmt.line("OpcodeConstraints {");
fmt.indent(|fmt| {
fmtln!(fmt, "flags: {:#04x},", flags);
fmtln!(fmt, "typeset_offset: {},", ctrl_typeset);
fmtln!(fmt, "constraint_offset: {},", constraint_offset);
});
fmt.line("},");
}
});
fmtln!(fmt, "];");
fmt.empty_line();
gen_typesets_table(&type_sets, fmt);
fmt.empty_line();
fmt.comment("Table of operand constraint sequences.");
fmtln!(
fmt,
"const OPERAND_CONSTRAINTS: [OperandConstraint; {}] = [",
operand_seqs.len()
);
fmt.indent(|fmt| {
for constraint in operand_seqs.iter() {
fmtln!(fmt, "OperandConstraint::{},", constraint);
}
});
fmtln!(fmt, "];");
}
/// Emit member initializers for an instruction format.
fn gen_member_inits(format: &InstructionFormat, fmt: &mut Formatter) {
// Immediate operands.
// We have local variables with the same names as the members.
for f in &format.imm_fields {
fmtln!(fmt, "{},", f.member);
}
// Value operands.
if format.has_value_list {
fmt.line("args,");
} else if format.num_value_operands == 1 {
fmt.line("arg: arg0,");
} else if format.num_value_operands > 1 {
let mut args = Vec::new();
for i in 0..format.num_value_operands {
args.push(format!("arg{}", i));
}
fmtln!(fmt, "args: [{}],", args.join(", "));
}
}
/// Emit a method for creating and inserting an instruction format.
///
/// All instruction formats take an `opcode` argument and a `ctrl_typevar` argument for deducing
/// the result types.
fn gen_format_constructor(format: &InstructionFormat, fmt: &mut Formatter) {
// Construct method arguments.
let mut args = vec![
"self".to_string(),
"opcode: Opcode".into(),
"ctrl_typevar: Type".into(),
];
// Normal operand arguments. Start with the immediate operands.
for f in &format.imm_fields {
args.push(format!("{}: {}", f.member, f.kind.rust_type));
}
// Then the value operands.
if format.has_value_list {
// Take all value arguments as a finished value list. The value lists
// are created by the individual instruction constructors.
args.push("args: ir::ValueList".into());
} else {
// Take a fixed number of value operands.
for i in 0..format.num_value_operands {
args.push(format!("arg{}: Value", i));
}
}
let proto = format!(
"{}({}) -> (Inst, &'f mut ir::DataFlowGraph)",
format.name,
args.join(", ")
);
fmt.doc_comment(format.to_string());
fmt.line("#[allow(non_snake_case)]");
fmtln!(fmt, "fn {} {{", proto);
fmt.indent(|fmt| {
// Generate the instruction data.
fmtln!(fmt, "let data = ir::InstructionData::{} {{", format.name);
fmt.indent(|fmt| {
fmt.line("opcode,");
gen_member_inits(format, fmt);
});
fmtln!(fmt, "};");
fmt.line("self.build(data, ctrl_typevar)");
});
fmtln!(fmt, "}");
}
/// Emit a method for generating the instruction `inst`.
///
/// The method will create and insert an instruction, then return the result values, or the
/// instruction reference itself for instructions that don't have results.
fn gen_inst_builder(inst: &Instruction, format: &InstructionFormat, fmt: &mut Formatter) {
// Construct method arguments.
let mut args = vec![if format.has_value_list {
"mut self"
} else {
"self"
}
.to_string()];
let mut args_doc = Vec::new();
let mut rets_doc = Vec::new();
// The controlling type variable will be inferred from the input values if
// possible. Otherwise, it is the first method argument.
if let Some(poly) = &inst.polymorphic_info {
if !poly.use_typevar_operand {
args.push(format!("{}: crate::ir::Type", poly.ctrl_typevar.name));
args_doc.push(format!(
"- {} (controlling type variable): {}",
poly.ctrl_typevar.name, poly.ctrl_typevar.doc
));
}
}
let mut tmpl_types = Vec::new();
let mut into_args = Vec::new();
for op in &inst.operands_in {
let t = if op.is_immediate() {
let t = format!("T{}", tmpl_types.len() + 1);
tmpl_types.push(format!("{}: Into<{}>", t, op.kind.rust_type));
into_args.push(op.name);
t
} else {
op.kind.rust_type.to_string()
};
args.push(format!("{}: {}", op.name, t));
args_doc.push(format!(
"- {}: {}",
op.name,
op.doc()
.expect("every instruction's input operand must be documented")
));
}
for op in &inst.operands_out {
rets_doc.push(format!(
"- {}: {}",
op.name,
op.doc()
.expect("every instruction's output operand must be documented")
));
}
let rtype = match inst.value_results.len() {
0 => "Inst".into(),
1 => "Value".into(),
_ => format!("({})", vec!["Value"; inst.value_results.len()].join(", ")),
};
let tmpl = if !tmpl_types.is_empty() {
format!("<{}>", tmpl_types.join(", "))
} else {
"".into()
};
let proto = format!(
"{}{}({}) -> {}",
inst.snake_name(),
tmpl,
args.join(", "),
rtype
);
fmt.doc_comment(&inst.doc);
if !args_doc.is_empty() {
fmt.line("///");
fmt.doc_comment("Inputs:");
fmt.line("///");
for doc_line in args_doc {
fmt.doc_comment(doc_line);
}
}
if !rets_doc.is_empty() {
fmt.line("///");
fmt.doc_comment("Outputs:");
fmt.line("///");
for doc_line in rets_doc {
fmt.doc_comment(doc_line);
}
}
fmt.line("#[allow(non_snake_case)]");
fmtln!(fmt, "fn {} {{", proto);
fmt.indent(|fmt| {
// Convert all of the `Into<>` arguments.
for arg in &into_args {
fmtln!(fmt, "let {} = {}.into();", arg, arg);
}
// Arguments for instruction constructor.
let first_arg = format!("Opcode::{}", inst.camel_name);
let mut args = vec![first_arg.as_str()];
if let Some(poly) = &inst.polymorphic_info {
if poly.use_typevar_operand {