-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathx64.zig
More file actions
5148 lines (4412 loc) · 239 KB
/
x64.zig
File metadata and controls
5148 lines (4412 loc) · 239 KB
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
const std = @import("std");
const log = std.log;
const math = std.math;
const testing = std.testing;
const assert = std.debug.assert;
const expect = std.testing.expect;
const Allocator = std.mem.Allocator;
const ArrayList = std.ArrayList;
test {
std.testing.refAllDecls(@This());
}
pub const Register = enum(u7) {
// zig fmt: off
rax, rcx, rdx, rbx, rsp, rbp, rsi, rdi,
r8, r9, r10, r11, r12, r13, r14, r15,
eax, ecx, edx, ebx, esp, ebp, esi, edi,
r8d, r9d, r10d, r11d, r12d, r13d, r14d, r15d,
ax, cx, dx, bx, sp, bp, si, di,
r8w, r9w, r10w, r11w, r12w, r13w, r14w, r15w,
al, cl, dl, bl, spl, bpl, sil, dil,
r8b, r9b, r10b, r11b, r12b, r13b, r14b, r15b,
ah, ch, dh, bh,
ymm0, ymm1, ymm2, ymm3, ymm4, ymm5, ymm6, ymm7,
ymm8, ymm9, ymm10, ymm11, ymm12, ymm13, ymm14, ymm15,
xmm0, xmm1, xmm2, xmm3, xmm4, xmm5, xmm6, xmm7,
xmm8, xmm9, xmm10, xmm11, xmm12, xmm13, xmm14, xmm15,
mm0, mm1, mm2, mm3, mm4, mm5, mm6, mm7,
st0, st1, st2, st3, st4, st5, st6, st7,
es, cs, ss, ds, fs, gs,
none,
// zig fmt: on
pub const Class = enum {
general_purpose,
segment,
x87,
mmx,
sse,
};
pub fn class(reg: Register) Class {
return switch (@intFromEnum(reg)) {
// zig fmt: off
@intFromEnum(Register.rax) ... @intFromEnum(Register.r15) => .general_purpose,
@intFromEnum(Register.eax) ... @intFromEnum(Register.r15d) => .general_purpose,
@intFromEnum(Register.ax) ... @intFromEnum(Register.r15w) => .general_purpose,
@intFromEnum(Register.al) ... @intFromEnum(Register.r15b) => .general_purpose,
@intFromEnum(Register.ah) ... @intFromEnum(Register.bh) => .general_purpose,
@intFromEnum(Register.ymm0) ... @intFromEnum(Register.ymm15) => .sse,
@intFromEnum(Register.xmm0) ... @intFromEnum(Register.xmm15) => .sse,
@intFromEnum(Register.mm0) ... @intFromEnum(Register.mm7) => .mmx,
@intFromEnum(Register.st0) ... @intFromEnum(Register.st7) => .x87,
@intFromEnum(Register.es) ... @intFromEnum(Register.gs) => .segment,
else => unreachable,
// zig fmt: on
};
}
pub fn id(reg: Register) u6 {
const base = switch (@intFromEnum(reg)) {
// zig fmt: off
@intFromEnum(Register.rax) ... @intFromEnum(Register.r15) => @intFromEnum(Register.rax),
@intFromEnum(Register.eax) ... @intFromEnum(Register.r15d) => @intFromEnum(Register.eax),
@intFromEnum(Register.ax) ... @intFromEnum(Register.r15w) => @intFromEnum(Register.ax),
@intFromEnum(Register.al) ... @intFromEnum(Register.r15b) => @intFromEnum(Register.al),
@intFromEnum(Register.ah) ... @intFromEnum(Register.bh) => @intFromEnum(Register.ah) - 4,
@intFromEnum(Register.ymm0) ... @intFromEnum(Register.ymm15) => @intFromEnum(Register.ymm0) - 16,
@intFromEnum(Register.xmm0) ... @intFromEnum(Register.xmm15) => @intFromEnum(Register.xmm0) - 16,
@intFromEnum(Register.mm0) ... @intFromEnum(Register.mm7) => @intFromEnum(Register.mm0) - 32,
@intFromEnum(Register.st0) ... @intFromEnum(Register.st7) => @intFromEnum(Register.st0) - 40,
@intFromEnum(Register.es) ... @intFromEnum(Register.gs) => @intFromEnum(Register.es) - 48,
else => unreachable,
// zig fmt: on
};
return @as(u6, @intCast(@intFromEnum(reg) - base));
}
pub fn bitSize(reg: Register) u64 {
return switch (@intFromEnum(reg)) {
// zig fmt: off
@intFromEnum(Register.rax) ... @intFromEnum(Register.r15) => 64,
@intFromEnum(Register.eax) ... @intFromEnum(Register.r15d) => 32,
@intFromEnum(Register.ax) ... @intFromEnum(Register.r15w) => 16,
@intFromEnum(Register.al) ... @intFromEnum(Register.r15b) => 8,
@intFromEnum(Register.ah) ... @intFromEnum(Register.bh) => 8,
@intFromEnum(Register.ymm0) ... @intFromEnum(Register.ymm15) => 256,
@intFromEnum(Register.xmm0) ... @intFromEnum(Register.xmm15) => 128,
@intFromEnum(Register.mm0) ... @intFromEnum(Register.mm7) => 64,
@intFromEnum(Register.st0) ... @intFromEnum(Register.st7) => 80,
@intFromEnum(Register.es) ... @intFromEnum(Register.gs) => 16,
else => unreachable,
// zig fmt: on
};
}
pub fn isExtended(reg: Register) bool {
return switch (@intFromEnum(reg)) {
// zig fmt: off
@intFromEnum(Register.r8) ... @intFromEnum(Register.r15) => true,
@intFromEnum(Register.r8d) ... @intFromEnum(Register.r15d) => true,
@intFromEnum(Register.r8w) ... @intFromEnum(Register.r15w) => true,
@intFromEnum(Register.r8b) ... @intFromEnum(Register.r15b) => true,
@intFromEnum(Register.ymm8) ... @intFromEnum(Register.ymm15) => true,
@intFromEnum(Register.xmm8) ... @intFromEnum(Register.xmm15) => true,
else => false,
// zig fmt: on
};
}
pub fn enc(reg: Register) u4 {
const base = switch (@intFromEnum(reg)) {
// zig fmt: off
@intFromEnum(Register.rax) ... @intFromEnum(Register.r15) => @intFromEnum(Register.rax),
@intFromEnum(Register.eax) ... @intFromEnum(Register.r15d) => @intFromEnum(Register.eax),
@intFromEnum(Register.ax) ... @intFromEnum(Register.r15w) => @intFromEnum(Register.ax),
@intFromEnum(Register.al) ... @intFromEnum(Register.r15b) => @intFromEnum(Register.al),
@intFromEnum(Register.ah) ... @intFromEnum(Register.bh) => @intFromEnum(Register.ah) - 4,
@intFromEnum(Register.ymm0) ... @intFromEnum(Register.ymm15) => @intFromEnum(Register.ymm0),
@intFromEnum(Register.xmm0) ... @intFromEnum(Register.xmm15) => @intFromEnum(Register.xmm0),
@intFromEnum(Register.mm0) ... @intFromEnum(Register.mm7) => @intFromEnum(Register.mm0),
@intFromEnum(Register.st0) ... @intFromEnum(Register.st7) => @intFromEnum(Register.st0),
@intFromEnum(Register.es) ... @intFromEnum(Register.gs) => @intFromEnum(Register.es),
else => unreachable,
// zig fmt: on
};
return @as(u4, @truncate(@intFromEnum(reg) - base));
}
pub fn lowEnc(reg: Register) u3 {
return @as(u3, @truncate(reg.enc()));
}
pub fn toBitSize(reg: Register, bit_size: u64) Register {
return switch (bit_size) {
8 => reg.to8(),
16 => reg.to16(),
32 => reg.to32(),
64 => reg.to64(),
128 => reg.to128(),
256 => reg.to256(),
else => unreachable,
};
}
fn gpBase(reg: Register) u7 {
assert(reg.class() == .general_purpose);
return switch (@intFromEnum(reg)) {
// zig fmt: off
@intFromEnum(Register.rax) ... @intFromEnum(Register.r15) => @intFromEnum(Register.rax),
@intFromEnum(Register.eax) ... @intFromEnum(Register.r15d) => @intFromEnum(Register.eax),
@intFromEnum(Register.ax) ... @intFromEnum(Register.r15w) => @intFromEnum(Register.ax),
@intFromEnum(Register.al) ... @intFromEnum(Register.r15b) => @intFromEnum(Register.al),
@intFromEnum(Register.ah) ... @intFromEnum(Register.bh) => @intFromEnum(Register.ah) - 4,
else => unreachable,
// zig fmt: on
};
}
pub fn to64(reg: Register) Register {
return @as(Register, @enumFromInt(@intFromEnum(reg) - reg.gpBase() + @intFromEnum(Register.rax)));
}
pub fn to32(reg: Register) Register {
return @as(Register, @enumFromInt(@intFromEnum(reg) - reg.gpBase() + @intFromEnum(Register.eax)));
}
pub fn to16(reg: Register) Register {
return @as(Register, @enumFromInt(@intFromEnum(reg) - reg.gpBase() + @intFromEnum(Register.ax)));
}
pub fn to8(reg: Register) Register {
return @as(Register, @enumFromInt(@intFromEnum(reg) - reg.gpBase() + @intFromEnum(Register.al)));
}
fn sseBase(reg: Register) u7 {
assert(reg.class() == .sse);
return switch (@intFromEnum(reg)) {
@intFromEnum(Register.ymm0)...@intFromEnum(Register.ymm15) => @intFromEnum(Register.ymm0),
@intFromEnum(Register.xmm0)...@intFromEnum(Register.xmm15) => @intFromEnum(Register.xmm0),
else => unreachable,
};
}
pub fn to256(reg: Register) Register {
return @as(Register, @enumFromInt(@intFromEnum(reg) - reg.sseBase() + @intFromEnum(Register.ymm0)));
}
pub fn to128(reg: Register) Register {
return @as(Register, @enumFromInt(@intFromEnum(reg) - reg.sseBase() + @intFromEnum(Register.xmm0)));
}
};
test "Register id - different classes" {
try expect(Register.al.id() == Register.ax.id());
try expect(Register.ah.id() == Register.spl.id());
try expect(Register.ax.id() == Register.eax.id());
try expect(Register.eax.id() == Register.rax.id());
try expect(Register.ymm0.id() == 0b10000);
try expect(Register.ymm0.id() != Register.rax.id());
try expect(Register.xmm0.id() == Register.ymm0.id());
try expect(Register.xmm0.id() != Register.mm0.id());
try expect(Register.mm0.id() != Register.st0.id());
try expect(Register.es.id() == 0b110000);
}
test "Register enc - different classes" {
try expect(Register.al.enc() == Register.ax.enc());
try expect(Register.ax.enc() == Register.eax.enc());
try expect(Register.eax.enc() == Register.rax.enc());
try expect(Register.ymm0.enc() == Register.rax.enc());
try expect(Register.xmm0.enc() == Register.ymm0.enc());
try expect(Register.es.enc() == Register.rax.enc());
}
test "Register classes" {
try expect(Register.r11.class() == .general_purpose);
try expect(Register.ymm11.class() == .sse);
try expect(Register.mm3.class() == .mmx);
try expect(Register.st3.class() == .x87);
try expect(Register.fs.class() == .segment);
}
pub const FrameIndex = enum(u32) {
// This index refers to the start of the arguments passed to this function
args_frame,
// This index refers to the return address pushed by a `call` and popped by a `ret`.
ret_addr,
// This index refers to the base pointer pushed in the prologue and popped in the epilogue.
base_ptr,
// This index refers to the entire stack frame.
stack_frame,
// This index refers to the start of the call frame for arguments passed to called functions
call_frame,
// Other indices are used for local variable stack slots
_,
pub const named_count = @typeInfo(FrameIndex).@"enum".fields.len;
pub fn isNamed(fi: FrameIndex) bool {
return @intFromEnum(fi) < named_count;
}
pub fn format(
fi: FrameIndex,
writer: anytype,
) !void {
try writer.writeAll("FrameIndex");
if (fi.isNamed()) {
try writer.writeByte('.');
try writer.writeAll(@tagName(fi));
} else {
try writer.print("({d})", .{@intFromEnum(fi)});
}
}
};
pub const Base = union(enum) {
none,
reg: Register,
frame_index: FrameIndex,
pub const Tag = @typeInfo(Base).@"union".tag_type.?;
pub fn register(reg: Register) Base {
return .{ .reg = reg };
}
pub fn frame(fi: FrameIndex) Base {
return .{ .frame_index = fi };
}
pub fn isExtended(self: Base) bool {
return switch (self) {
.none, .frame_index => false, // neither rsp nor rbp are extended
.reg => |reg| reg.isExtended(),
};
}
};
pub const ScaleIndex = struct {
scale: u4,
index: Register,
const none = ScaleIndex{ .scale = 0, .index = undefined };
};
pub const PtrSize = enum {
byte,
word,
dword,
qword,
tbyte,
xword,
yword,
zword,
pub fn fromSize(size: u32) PtrSize {
return switch (size) {
1...1 => .byte,
2...2 => .word,
3...4 => .dword,
5...8 => .qword,
9...16 => .xword,
17...32 => .yword,
33...64 => .zword,
else => unreachable,
};
}
pub fn fromBitSize(bit_size: u64) PtrSize {
return switch (bit_size) {
8 => .byte,
16 => .word,
32 => .dword,
64 => .qword,
80 => .tbyte,
128 => .xword,
256 => .yword,
512 => .zword,
else => unreachable,
};
}
pub fn bitSize(s: PtrSize) u64 {
return switch (s) {
.byte => 8,
.word => 16,
.dword => 32,
.qword => 64,
.tbyte => 80,
.xword => 128,
.yword => 256,
.zword => 512,
};
}
};
pub const Sib = struct {
ptr_size: PtrSize,
base: Base,
scale_index: ScaleIndex,
disp: i32,
};
pub const Rip = struct {
ptr_size: PtrSize,
disp: i32,
};
pub const Moffs = struct {
seg: Register,
offset: u64,
};
pub const Memory = union(enum) {
m_sib: Sib,
m_rip: Rip,
m_moffs: Moffs,
pub fn moffs(reg: Register, offset: u64) Memory {
assert(reg.class() == .segment);
return .{ .m_moffs = .{ .seg = reg, .offset = offset } };
}
pub fn ptr_offset(disp: i32, offset: Register) Memory {
return .{ .m_sib = .{
.base = .register(offset),
.disp = disp,
.ptr_size = .qword,
.scale_index = ScaleIndex.none,
} };
}
pub fn sib(ptr_size: PtrSize, args: struct {
disp: i32 = 0,
base: Base = .none,
scale_index: ?ScaleIndex = null,
}) Memory {
if (args.scale_index) |si| assert(std.math.isPowerOfTwo(si.scale));
return .{ .m_sib = .{
.base = args.base,
.disp = args.disp,
.ptr_size = ptr_size,
.scale_index = if (args.scale_index) |si| si else ScaleIndex.none,
} };
}
pub fn rip(ptr_size: PtrSize, disp: i32) Memory {
return .{ .m_rip = .{ .ptr_size = ptr_size, .disp = disp } };
}
pub fn isSegmentRegister(mem: Memory) bool {
return switch (mem) {
.m_moffs => true,
.m_rip => false,
.m_sib => |s| switch (s.base) {
.none, .frame_index => false,
.reg => |reg| reg.class() == .segment,
},
};
}
pub fn base(mem: Memory) Base {
return switch (mem) {
.m_moffs => |m| .{ .reg = m.seg },
.m_sib => |s| s.base,
.m_rip => .none,
};
}
pub fn scaleIndex(mem: Memory) ?ScaleIndex {
return switch (mem) {
.m_moffs, .m_rip => null,
.m_sib => |s| if (s.scale_index.scale > 0) s.scale_index else null,
};
}
pub fn bitSize(mem: Memory) u64 {
return switch (mem) {
.m_rip => |r| r.ptr_size.bitSize(),
.m_sib => |s| s.ptr_size.bitSize(),
.m_moffs => 64,
};
}
};
pub const Immediate = union(enum) {
signed: i32,
unsigned: u64,
pub fn u(x: u64) Immediate {
return .{ .unsigned = x };
}
pub fn s(x: i32) Immediate {
return .{ .signed = x };
}
pub fn asUnsigned(imm: Immediate, bit_size: u64) u64 {
return switch (imm) {
.signed => |x| switch (bit_size) {
1, 8 => @as(u8, @bitCast(@as(i8, @intCast(x)))),
16 => @as(u16, @bitCast(@as(i16, @intCast(x)))),
32, 64 => @as(u32, @bitCast(x)),
else => unreachable,
},
.unsigned => |x| switch (bit_size) {
1, 8 => @as(u8, @intCast(x)),
16 => @as(u16, @intCast(x)),
32 => @as(u32, @intCast(x)),
64 => x,
else => unreachable,
},
};
}
};
pub const Prefix = enum(u3) {
none,
lock,
rep,
repe,
repz,
repne,
repnz,
};
pub const Operand = union(enum) {
none,
reg: Register,
mem: Memory,
imm: Immediate,
pub fn im(x: anytype) Operand {
return .{ .imm = .{ .unsigned = @as(std.meta.Int(.unsigned, @bitSizeOf(@TypeOf(x))), @bitCast(x)) } };
}
pub const rax = Operand.register(.rax);
pub const rcx = Operand.register(.rcx);
pub const rdx = Operand.register(.rdx);
pub const rbx = Operand.register(.rbx);
pub const rsp = Operand.register(.rsp);
pub const rbp = Operand.register(.rbp);
pub const rsi = Operand.register(.rsi);
pub const rdi = Operand.register(.rdi);
pub const r8 = Operand.register(.r8);
pub const r9 = Operand.register(.r9);
pub const r10 = Operand.register(.r10);
pub const r11 = Operand.register(.r11);
pub const r12 = Operand.register(.r12);
pub const r13 = Operand.register(.r13);
pub const r14 = Operand.register(.r14);
pub const r15 = Operand.register(.r15);
pub const eax = Operand.register(.eax);
pub const ecx = Operand.register(.ecx);
pub const edx = Operand.register(.edx);
pub const ebx = Operand.register(.ebx);
pub const esp = Operand.register(.esp);
pub const ebp = Operand.register(.ebp);
pub const esi = Operand.register(.esi);
pub const edi = Operand.register(.edi);
pub const r8d = Operand.register(.r8d);
pub const r9d = Operand.register(.r9d);
pub const r10d = Operand.register(.r10d);
pub const r11d = Operand.register(.r11d);
pub const r12d = Operand.register(.r12d);
pub const r13d = Operand.register(.r13d);
pub const r14d = Operand.register(.r14d);
pub const r15d = Operand.register(.r15d);
pub const ax = Operand.register(.ax);
pub const cx = Operand.register(.cx);
pub const dx = Operand.register(.dx);
pub const bx = Operand.register(.bx);
pub const sp = Operand.register(.sp);
pub const bp = Operand.register(.bp);
pub const si = Operand.register(.si);
pub const di = Operand.register(.di);
pub const r8w = Operand.register(.r8w);
pub const r9w = Operand.register(.r9w);
pub const r10w = Operand.register(.r10w);
pub const r11w = Operand.register(.r11w);
pub const r12w = Operand.register(.r12w);
pub const r13w = Operand.register(.r13w);
pub const r14w = Operand.register(.r14w);
pub const r15w = Operand.register(.r15w);
pub const al = Operand.register(.al);
pub const cl = Operand.register(.cl);
pub const dl = Operand.register(.dl);
pub const bl = Operand.register(.bl);
pub const spl = Operand.register(.spl);
pub const bpl = Operand.register(.bpl);
pub const sil = Operand.register(.sil);
pub const dil = Operand.register(.dil);
pub const r8b = Operand.register(.r8b);
pub const r9b = Operand.register(.r9b);
pub const r10b = Operand.register(.r10b);
pub const r11b = Operand.register(.r11b);
pub const r12b = Operand.register(.r12b);
pub const r13b = Operand.register(.r13b);
pub const r14b = Operand.register(.r14b);
pub const r15b = Operand.register(.r15b);
pub const ah = Operand.register(.ah);
pub const ch = Operand.register(.ch);
pub const dh = Operand.register(.dh);
pub const bh = Operand.register(.bh);
pub const ymm0 = Operand.register(.ymm0);
pub const ymm1 = Operand.register(.ymm1);
pub const ymm2 = Operand.register(.ymm2);
pub const ymm3 = Operand.register(.ymm3);
pub const ymm4 = Operand.register(.ymm4);
pub const ymm5 = Operand.register(.ymm5);
pub const ymm6 = Operand.register(.ymm6);
pub const ymm7 = Operand.register(.ymm7);
pub const ymm8 = Operand.register(.ymm8);
pub const ymm9 = Operand.register(.ymm9);
pub const ymm10 = Operand.register(.ymm10);
pub const ymm11 = Operand.register(.ymm11);
pub const ymm12 = Operand.register(.ymm12);
pub const ymm13 = Operand.register(.ymm13);
pub const ymm14 = Operand.register(.ymm14);
pub const ymm15 = Operand.register(.ymm15);
pub const xmm0 = Operand.register(.xmm0);
pub const xmm1 = Operand.register(.xmm1);
pub const xmm2 = Operand.register(.xmm2);
pub const xmm3 = Operand.register(.xmm3);
pub const xmm4 = Operand.register(.xmm4);
pub const xmm5 = Operand.register(.xmm5);
pub const xmm6 = Operand.register(.xmm6);
pub const xmm7 = Operand.register(.xmm7);
pub const xmm8 = Operand.register(.xmm8);
pub const xmm9 = Operand.register(.xmm9);
pub const xmm10 = Operand.register(.xmm10);
pub const xmm11 = Operand.register(.xmm11);
pub const xmm12 = Operand.register(.xmm12);
pub const xmm13 = Operand.register(.xmm13);
pub const xmm14 = Operand.register(.xmm14);
pub const xmm15 = Operand.register(.xmm15);
pub const mm0 = Operand.register(.mm0);
pub const mm1 = Operand.register(.mm1);
pub const mm2 = Operand.register(.mm2);
pub const mm3 = Operand.register(.mm3);
pub const mm4 = Operand.register(.mm4);
pub const mm5 = Operand.register(.mm5);
pub const mm6 = Operand.register(.mm6);
pub const mm7 = Operand.register(.mm7);
pub const st0 = Operand.register(.st0);
pub const st1 = Operand.register(.st1);
pub const st2 = Operand.register(.st2);
pub const st3 = Operand.register(.st3);
pub const st4 = Operand.register(.st4);
pub const st5 = Operand.register(.st5);
pub const st6 = Operand.register(.st6);
pub const st7 = Operand.register(.st7);
pub const es = Operand.register(.es);
pub const cs = Operand.register(.cs);
pub const ss = Operand.register(.ss);
pub const ds = Operand.register(.ds);
pub const fs = Operand.register(.fs);
pub const gs = Operand.register(.gs);
pub fn ptr_offset(r: Register, offset: i32) Operand {
return .{ .mem = Memory.ptr_offset(offset, r) };
}
pub fn register(r: Register) Operand {
return .{ .reg = r };
}
pub fn memory(mem: Memory) Operand {
return .{ .mem = mem };
}
pub fn immediate(imm: Immediate) Operand {
return .{ .imm = imm };
}
/// Returns the bitsize of the operand.
pub fn bitSize(op: Operand) u64 {
return switch (op) {
.none => unreachable,
.reg => |reg| reg.bitSize(),
.mem => |mem| mem.bitSize(),
.imm => unreachable,
};
}
/// Returns true if the operand is a segment register.
/// Asserts the operand is either register or memory.
pub fn isSegmentRegister(op: Operand) bool {
return switch (op) {
.none => unreachable,
.reg => |reg| reg.class() == .segment,
.mem => |mem| mem.isSegmentRegister(),
.imm => unreachable,
};
}
pub fn isBaseExtended(op: Operand) bool {
return switch (op) {
.none, .imm => false,
.reg => |reg| reg.isExtended(),
.mem => |mem| mem.base().isExtended(),
};
}
pub fn isIndexExtended(op: Operand) bool {
return switch (op) {
.none, .reg, .imm => false,
.mem => |mem| if (mem.scaleIndex()) |x| x.index.isExtended() else false,
};
}
fn format(
op: Operand,
writer: anytype,
) !void {
_ = op;
_ = writer;
@compileError("do not format Operand directly; use fmtPrint() instead");
}
pub fn fmtPrint(op: Operand, enc_op: Op) Formatter(FormatContext, fmtOperand) {
return .{ .data = .{ .op = op, .enc_op = enc_op } };
}
};
pub fn Formatter(
comptime Data: type,
comptime formatFn: fn (data: Data, writer: *std.Io.Writer) std.Io.Writer.Error!void,
) type {
return struct {
data: Data,
pub fn format(self: @This(), writer: *std.Io.Writer) std.Io.Writer.Error!void {
try formatFn(self.data, writer);
}
};
}
const FormatContext = struct {
op: Operand,
enc_op: Op,
};
fn fmtOperand(
ctx: FormatContext,
writer: *std.Io.Writer,
) error{WriteFailed}!void {
const op = ctx.op;
const enc_op = ctx.enc_op;
switch (op) {
.none => {},
.reg => |reg| writer.writeAll(@tagName(reg)) catch return error.WriteFailed,
.mem => |mem| switch (mem) {
.m_rip => |rip| {
writer.print("{s} ptr [rip", .{@tagName(rip.ptr_size)}) catch return error.WriteFailed;
if (rip.disp != 0) writer.print(" {c} 0x{x}", .{
@as(u8, if (rip.disp < 0) '-' else '+'),
@abs(rip.disp),
}) catch return error.WriteFailed;
writer.writeByte(']') catch return error.WriteFailed;
},
.m_sib => |sib| {
writer.print("{s} ptr ", .{@tagName(sib.ptr_size)}) catch return error.WriteFailed;
if (mem.isSegmentRegister()) {
return writer.print("{s}:0x{x}", .{ @tagName(sib.base.reg), sib.disp });
}
writer.writeByte('[') catch return error.WriteFailed;
var any = false;
switch (sib.base) {
.none => {},
.reg => |reg| {
writer.print("{s}", .{@tagName(reg)}) catch return error.WriteFailed;
any = true;
},
.frame_index => |frame| {
writer.print("{f}", .{frame}) catch return error.WriteFailed;
any = true;
},
}
if (mem.scaleIndex()) |si| {
if (any) writer.writeAll(" + ") catch return error.WriteFailed;
writer.print("{s} * {d}", .{ @tagName(si.index), si.scale }) catch return error.WriteFailed;
any = true;
}
if (sib.disp != 0 or !any) {
if (any)
writer.print(" {c} ", .{@as(u8, if (sib.disp < 0) '-' else '+')}) catch return error.WriteFailed
else if (sib.disp < 0)
writer.writeByte('-') catch return error.WriteFailed;
writer.print("0x{x}", .{@abs(sib.disp)}) catch return error.WriteFailed;
any = true;
}
writer.writeByte(']') catch return error.WriteFailed;
},
.m_moffs => |moffs| writer.print("{s}:0x{x}", .{
@tagName(moffs.seg),
moffs.offset,
}) catch return error.WriteFailed,
},
.imm => |imm| writer.print("0x{x}", .{imm.asUnsigned(enc_op.immBitSize())}) catch return error.WriteFailed,
}
}
pub const Instruction = struct {
prefix: Prefix = .none,
encoding: Encoding,
ops: [4]Operand = .{.none} ** 4,
pub fn new(prefix: Prefix, mnemonic: Mnemonic, ops: []const Operand) error{BadEncoding}!Instruction {
const encoding = Encoding.findByMnemonic(prefix, mnemonic, ops) orelse {
if (@inComptime()) {
@compileLog("no encoding found for: ", prefix, mnemonic, ops);
} else {
log.err("no encoding found for: {s} {s} {s} {s} {s} {s}{s}", .{ @tagName(prefix), @tagName(mnemonic), @tagName(if (ops.len > 0) Op.fromOperand(ops[0]) else .none), @tagName(if (ops.len > 1) Op.fromOperand(ops[1]) else .none), @tagName(if (ops.len > 2) Op.fromOperand(ops[2]) else .none), @tagName(if (ops.len > 3) Op.fromOperand(ops[3]) else .none), if (ops.len > 3) " ...?" else "" });
}
return error.BadEncoding;
};
if (@inComptime()) {
// @compileLog("selected encoding", .{encoding});
} else {
log.debug("selected encoding: {f}", .{encoding});
}
var inst = Instruction{
.prefix = prefix,
.encoding = encoding,
.ops = [1]Operand{.none} ** 4,
};
@memcpy(inst.ops[0..ops.len], ops);
return inst;
}
pub fn format(
inst: Instruction,
writer: anytype,
) !void {
if (inst.prefix != .none) try writer.print("{s} ", .{@tagName(inst.prefix)});
try writer.print("{s}", .{@tagName(inst.encoding.mnemonic)});
for (inst.ops, inst.encoding.data.ops, 0..) |op, enc, i| {
if (op == .none) break;
if (i > 0) try writer.writeByte(',');
try writer.writeByte(' ');
try writer.print("{f}", .{op.fmtPrint(enc)});
}
}
pub fn encode(inst: Instruction, writer: anytype, comptime opts: EncoderOptions) !void {
const e = Encoder(@TypeOf(writer), opts){ .writer = writer };
const enc = inst.encoding;
const data = enc.data;
if (data.mode.isVex()) {
try inst.encodeVexPrefix(e);
const opc = inst.encoding.opcode();
try e.opcode_1byte(opc[opc.len - 1]);
} else {
try inst.encodeLegacyPrefixes(e);
try inst.encodeMandatoryPrefix(e);
try inst.encodeRexPrefix(e);
try inst.encodeOpcode(e);
}
switch (data.op_en) {
.np, .o => {},
.i, .d => try encodeImm(inst.ops[0].imm, data.ops[0], e),
.zi, .oi => try encodeImm(inst.ops[1].imm, data.ops[1], e),
.fd => try e.imm64(inst.ops[1].mem.m_moffs.offset),
.td => try e.imm64(inst.ops[0].mem.m_moffs.offset),
else => {
const mem_op = switch (data.op_en) {
.m, .mi, .m1, .mc, .mr, .mri, .mrc, .mvr => inst.ops[0],
.rm, .rmi, .rm0, .vmi => inst.ops[1],
.rvm, .rvmr, .rvmi => inst.ops[2],
else => unreachable,
};
switch (mem_op) {
.reg => |reg| {
const rm = switch (data.op_en) {
.m, .mi, .m1, .mc, .vmi => enc.modRmExt(),
.mr, .mri, .mrc => inst.ops[1].reg.lowEnc(),
.rm, .rmi, .rm0, .rvm, .rvmr, .rvmi => inst.ops[0].reg.lowEnc(),
.mvr => inst.ops[2].reg.lowEnc(),
else => unreachable,
};
try e.modRm_direct(rm, reg.lowEnc());
},
.mem => |mem| {
const op = switch (data.op_en) {
.m, .mi, .m1, .mc, .vmi => .none,
.mr, .mri, .mrc => inst.ops[1],
.rm, .rmi, .rm0, .rvm, .rvmr, .rvmi => inst.ops[0],
.mvr => inst.ops[2],
else => unreachable,
};
try encodeMemory(enc, mem, op, e);
},
else => unreachable,
}
switch (data.op_en) {
.mi => try encodeImm(inst.ops[1].imm, data.ops[1], e),
.rmi, .mri, .vmi => try encodeImm(inst.ops[2].imm, data.ops[2], e),
.rvmr => try e.imm8(@as(u8, inst.ops[3].reg.enc()) << 4),
.rvmi => try encodeImm(inst.ops[3].imm, data.ops[3], e),
else => {},
}
},
}
}
fn encodeOpcode(inst: Instruction, e: anytype) !void {
const opcode = inst.encoding.opcode();
const first = @intFromBool(inst.encoding.mandatoryPrefix() != null);
const final = opcode.len - 1;
for (opcode[first..final]) |byte| try e.opcode_1byte(byte);
switch (inst.encoding.data.op_en) {
.o, .oi => try e.opcode_withReg(opcode[final], inst.ops[0].reg.lowEnc()),
else => try e.opcode_1byte(opcode[final]),
}
}
fn encodeLegacyPrefixes(inst: Instruction, e: anytype) !void {
const enc = inst.encoding;
const data = enc.data;
const op_en = data.op_en;
var legacy = LegacyPrefixes{};
switch (inst.prefix) {
.none => {},
.lock => legacy.prefix_f0 = true,
.repne, .repnz => legacy.prefix_f2 = true,
.rep, .repe, .repz => legacy.prefix_f3 = true,
}
switch (data.mode) {
.short, .rex_short => legacy.set16BitOverride(),
else => {},
}
const segment_override: ?Register = switch (op_en) {
.i, .zi, .o, .oi, .d, .np => null,
.fd => inst.ops[1].mem.base().reg,
.td => inst.ops[0].mem.base().reg,
.rm, .rmi, .rm0 => if (inst.ops[1].isSegmentRegister())
switch (inst.ops[1]) {
.reg => |reg| reg,
.mem => |mem| mem.base().reg,
else => unreachable,
}
else
null,
.m, .mi, .m1, .mc, .mr, .mri, .mrc => if (inst.ops[0].isSegmentRegister())
switch (inst.ops[0]) {
.reg => |reg| reg,
.mem => |mem| mem.base().reg,
else => unreachable,
}
else
null,
.vmi, .rvm, .rvmr, .rvmi, .mvr => unreachable,
};
if (segment_override) |seg| {
legacy.setSegmentOverride(seg);
}
try e.legacyPrefixes(legacy);
}
fn encodeRexPrefix(inst: Instruction, e: anytype) !void {
const op_en = inst.encoding.data.op_en;
var rex = Rex{};
rex.present = inst.encoding.data.mode == .rex;
rex.w = inst.encoding.data.mode == .long;
switch (op_en) {
.np, .i, .zi, .fd, .td, .d => {},
.o, .oi => rex.b = inst.ops[0].reg.isExtended(),
.m, .mi, .m1, .mc, .mr, .rm, .rmi, .mri, .mrc, .rm0 => {
const r_op = switch (op_en) {
.rm, .rmi, .rm0 => inst.ops[0],
.mr, .mri, .mrc => inst.ops[1],
else => .none,
};
rex.r = r_op.isBaseExtended();
const b_x_op = switch (op_en) {
.rm, .rmi, .rm0 => inst.ops[1],
.m, .mi, .m1, .mc, .mr, .mri, .mrc => inst.ops[0],
else => unreachable,
};
rex.b = b_x_op.isBaseExtended();
rex.x = b_x_op.isIndexExtended();
},
.vmi, .rvm, .rvmr, .rvmi, .mvr => unreachable,
}
try e.rex(rex);
}
fn encodeVexPrefix(inst: Instruction, e: anytype) !void {
const op_en = inst.encoding.data.op_en;
const opc = inst.encoding.opcode();
const mand_pre = inst.encoding.mandatoryPrefix();
var vex = Vex{};
vex.w = inst.encoding.data.mode.isLong();
switch (op_en) {
.np, .i, .zi, .fd, .td, .d => {},
.o, .oi => vex.b = inst.ops[0].reg.isExtended(),
.m, .mi, .m1, .mc, .mr, .rm, .rmi, .mri, .mrc, .rm0, .vmi, .rvm, .rvmr, .rvmi, .mvr => {
const r_op = switch (op_en) {
.rm, .rmi, .rm0, .rvm, .rvmr, .rvmi => inst.ops[0],
.mr, .mri, .mrc => inst.ops[1],