forked from dotnet/runtime
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathunwindriscv64.cpp
2105 lines (1729 loc) · 73 KB
/
unwindriscv64.cpp
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
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
/*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XX XX
XX UnwindInfo XX
XX XX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
*/
#include "jitpch.h"
#ifdef _MSC_VER
#pragma hdrstop
#endif
#if defined(TARGET_RISCV64)
#if defined(FEATURE_CFI_SUPPORT)
short Compiler::mapRegNumToDwarfReg(regNumber reg)
{
short dwarfReg = DWARF_REG_ILLEGAL;
// On RISC-V registers from R0 to F31
// can be mapped directly to dwarf structure
if (reg >= REG_R0 && reg <= REG_F31)
{
dwarfReg = static_cast<short>(reg);
}
else
{
NYI("CFI codes"); // e.g. V-extension
}
return dwarfReg;
}
#endif // FEATURE_CFI_SUPPORT
void Compiler::unwindPush(regNumber reg)
{
unreached(); // use one of the unwindSaveReg* functions instead.
}
void Compiler::unwindAllocStack(unsigned size)
{
#if defined(FEATURE_CFI_SUPPORT)
if (generateCFIUnwindCodes())
{
if (compGeneratingProlog)
{
unwindAllocStackCFI(size);
}
return;
}
#endif // FEATURE_CFI_SUPPORT
UnwindInfo* pu = &funCurrentFunc()->uwi;
assert(size % 16 == 0);
unsigned x = size / 16;
if (x <= 0x1F)
{
// alloc_s: 000xxxxx: allocate small stack with size < 128 (2^5 * 16)
// TODO-Review: should say size < 512
pu->AddCode((BYTE)x);
}
else if (x <= 0x7F)
{
// alloc_m: 11000xxx | xxxxxxxx: allocate large stack with size < 2k (2^7 * 16)
pu->AddCode(0xC0 | (BYTE)(x >> 8), (BYTE)x);
}
else
{
// alloc_l: 11100000 | xxxxxxxx | xxxxxxxx | xxxxxxxx : allocate large stack with size < 256M (2^24 * 16)
//
// For large stack size, the most significant bits
// are stored first (and next to the opCode) per the unwind spec.
pu->AddCode(0xE0, (BYTE)(x >> 16), (BYTE)(x >> 8), (BYTE)x);
}
}
void Compiler::unwindSetFrameReg(regNumber reg, unsigned offset)
{
#if defined(FEATURE_CFI_SUPPORT)
if (generateCFIUnwindCodes())
{
if (compGeneratingProlog)
{
unwindSetFrameRegCFI(reg, offset);
}
return;
}
#endif // FEATURE_CFI_SUPPORT
UnwindInfo* pu = &funCurrentFunc()->uwi;
if (offset == 0)
{
assert(reg == REG_FP);
// set_fp: 11100001 : set up fp : with : move fp, sp
pu->AddCode(0xE1);
}
else
{
// add_fp: 11100010 | 000xxxxx | xxxxxxxx : set up fp with : addi.d fp, sp, #x * 8
assert(reg == REG_FP);
assert((offset % 8) == 0);
unsigned x = offset / 8;
assert(x <= 0x1FF);
pu->AddCode(0xE2, (BYTE)(x >> 8), (BYTE)x);
}
}
void Compiler::unwindSaveReg(regNumber reg, unsigned offset)
{
unwindSaveReg(reg, (int)offset);
}
void Compiler::unwindNop()
{
UnwindInfo* pu = &funCurrentFunc()->uwi;
#ifdef DEBUG
if (verbose)
{
printf("unwindNop: adding NOP\n");
}
#endif
INDEBUG(pu->uwiAddingNOP = true);
// nop: 11100011: no unwind operation is required.
pu->AddCode(0xE3);
INDEBUG(pu->uwiAddingNOP = false);
}
void Compiler::unwindSaveReg(regNumber reg, int offset)
{
// sd reg, sp, offset
// offset for store in prolog must be positive and a multiple of 8.
assert(0 <= offset && offset <= 2047);
assert((offset % 8) == 0);
#if defined(FEATURE_CFI_SUPPORT)
if (generateCFIUnwindCodes())
{
if (compGeneratingProlog)
{
FuncInfoDsc* func = funCurrentFunc();
UNATIVE_OFFSET cbProlog = unwindGetCurrentOffset(func);
createCfiCode(func, cbProlog, CFI_REL_OFFSET, mapRegNumToDwarfReg(reg), offset);
}
return;
}
#endif // FEATURE_CFI_SUPPORT
int z = offset / 8;
// assert(0 <= z && z <= 0xFF);
UnwindInfo* pu = &funCurrentFunc()->uwi;
if (emitter::isGeneralRegister(reg))
{
// save_reg: 11010000 | 000xxxxx | zzzzzzzz: save reg r(1 + #X) at [sp + #Z * 8], offset <= 2047
assert(reg == REG_RA || (REG_FP <= reg && reg <= REG_S11)); // first legal register: RA, last legal register:
// S11
BYTE x = (BYTE)(reg - REG_RA);
assert(0 <= x && x <= 0x1B);
pu->AddCode(0xD0, (BYTE)x, (BYTE)z);
}
else
{
// save_freg: 1101110x | xxxxzzzz | zzzzzzzz : save reg f(8 + #X) at [sp + #Z * 8], offset <= 2047
assert(REG_F8 == reg || REG_F9 == reg || // first legal register: F8
(REG_F18 <= reg && reg <= REG_F27)); // last legal register: F27
BYTE x = (BYTE)(reg - REG_F8);
assert(0 <= x && x <= 0x13);
pu->AddCode(0xDC | (BYTE)(x >> 4), (BYTE)(x << 4) | (BYTE)(z >> 8), (BYTE)z);
}
}
void Compiler::unwindSaveRegPair(regNumber reg1, regNumber reg2, int offset)
{
NYI_RISCV64("unwindSaveRegPair-----unused on RISCV64 yet----");
}
void Compiler::unwindReturn(regNumber reg)
{
// Nothing to do; we will always have at least one trailing "end" opcode in our padding.
}
/*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XX XX
XX Unwind Info Debug helpers XX
XX XX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
*/
#ifdef DEBUG
// Return the size of the unwind code (from 1 to 4 bytes), given the first byte of the unwind bytes
unsigned GetUnwindSizeFromUnwindHeader(BYTE b1)
{
static const BYTE s_UnwindSize[256] = {
// array of unwind sizes, in bytes
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 00-0F
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 10-1F
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 20-2F
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 30-3F
2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, // 40-4F
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 50-5F
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 60-6F
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 70-7F
2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, // 80-8F
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // 90-9F
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // A0-AF
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // B0-BF
2, 2, 2, 2, 2, 2, 2, 2, 3, 2, 2, 2, 3, 2, 2, 2, // C0-CF
3, 2, 2, 2, 2, 2, 3, 2, 3, 2, 3, 2, 3, 3, 2, 1, // D0-DF
4, 1, 3, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, // E0-EF
1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1 // F0-FF
};
unsigned size = s_UnwindSize[b1];
assert(1 <= size && size <= 4);
return size;
}
#endif // DEBUG
/*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XX XX
XX Unwind Info Support Classes XX
XX XX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
*/
///////////////////////////////////////////////////////////////////////////////
//
// UnwindCodesBase
//
///////////////////////////////////////////////////////////////////////////////
#ifdef DEBUG
// Walk the prolog codes and calculate the size of the prolog or epilog, in bytes.
unsigned UnwindCodesBase::GetCodeSizeFromUnwindCodes(bool isProlog)
{
BYTE* pCodesStart = GetCodes();
BYTE* pCodes = pCodesStart;
unsigned size = 0;
for (;;)
{
BYTE b1 = *pCodes;
if (IsEndCode(b1))
{
break; // We hit an "end" code; we're done
}
size += 4; // All codes represent 4 byte instructions.
pCodes += GetUnwindSizeFromUnwindHeader(b1);
assert(pCodes - pCodesStart < 256); // 255 is the absolute maximum number of code bytes allowed
}
return size;
}
#endif // DEBUG
/*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XX XX
XX Debug dumpers XX
XX XX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
*/
#ifdef DEBUG
// start is 0-based index from LSB, length is number of bits
DWORD ExtractBits(DWORD dw, DWORD start, DWORD length)
{
return (dw >> start) & ((1 << length) - 1);
}
// Dump the unwind data.
// Arguments:
// isHotCode: true if this unwind data is for the hot section
// startOffset: byte offset of the code start that this unwind data represents
// endOffset: byte offset of the code end that this unwind data represents
// pHeader: pointer to the unwind data blob
// unwindBlockSize: size in bytes of the unwind data blob
void DumpUnwindInfo(Compiler* comp,
bool isHotCode,
UNATIVE_OFFSET startOffset,
UNATIVE_OFFSET endOffset,
const BYTE* const pHeader,
ULONG unwindBlockSize)
{
printf("Unwind Info%s:\n", isHotCode ? "" : " COLD");
// pHeader is not guaranteed to be aligned. We put four 0xFF end codes at the end
// to provide padding, and round down to get a multiple of 4 bytes in size.
DWORD UNALIGNED* pdw = (DWORD UNALIGNED*)pHeader;
DWORD dw;
dw = *pdw++;
DWORD codeWords = ExtractBits(dw, 27, 5);
DWORD epilogCount = ExtractBits(dw, 22, 5);
DWORD EBit = ExtractBits(dw, 21, 1);
DWORD XBit = ExtractBits(dw, 20, 1);
DWORD Vers = ExtractBits(dw, 18, 2);
DWORD functionLength = ExtractBits(dw, 0, 18);
printf(" >> Start offset : 0x%06x (not in unwind data)\n", comp->dspOffset(startOffset));
printf(" >> End offset : 0x%06x (not in unwind data)\n", comp->dspOffset(endOffset));
printf(" Code Words : %u\n", codeWords);
printf(" Epilog Count : %u\n", epilogCount);
printf(" E bit : %u\n", EBit);
printf(" X bit : %u\n", XBit);
printf(" Vers : %u\n", Vers);
printf(" Function Length : %u (0x%05x) Actual length = %u (0x%06x)\n", functionLength, functionLength,
functionLength * 4, functionLength * 4);
assert(functionLength * 4 == endOffset - startOffset);
if (codeWords == 0 && epilogCount == 0)
{
// We have an extension word specifying a larger number of Code Words or Epilog Counts
// than can be specified in the header word.
dw = *pdw++;
codeWords = ExtractBits(dw, 16, 8);
epilogCount = ExtractBits(dw, 0, 16);
assert((dw & 0xF0000000) == 0); // reserved field should be zero
printf(" ---- Extension word ----\n");
printf(" Extended Code Words : %u\n", codeWords);
printf(" Extended Epilog Count : %u\n", epilogCount);
}
bool epilogStartAt[1024] = {}; // One byte per possible epilog start index; initialized to false
if (EBit == 0)
{
// We have an array of epilog scopes
printf(" ---- Epilog scopes ----\n");
if (epilogCount == 0)
{
printf(" No epilogs\n");
}
else
{
for (DWORD scope = 0; scope < epilogCount; scope++)
{
dw = *pdw++;
DWORD epilogStartOffset = ExtractBits(dw, 0, 18);
DWORD res = ExtractBits(dw, 18, 4);
DWORD epilogStartIndex = ExtractBits(dw, 22, 10);
// Note that epilogStartOffset for a funclet is the offset from the beginning
// of the current funclet, not the offset from the beginning of the main function.
// To help find it when looking through JitDump output, also show the offset from
// the beginning of the main function.
DWORD epilogStartOffsetFromMainFunctionBegin = epilogStartOffset * 4 + startOffset;
assert(res == 0);
printf(" ---- Scope %d\n", scope);
printf(" Epilog Start Offset : %u (0x%05x) Actual offset = %u (0x%06x) Offset from main "
"function begin = %u (0x%06x)\n",
comp->dspOffset(epilogStartOffset), comp->dspOffset(epilogStartOffset),
comp->dspOffset(epilogStartOffset * 4), comp->dspOffset(epilogStartOffset * 4),
comp->dspOffset(epilogStartOffsetFromMainFunctionBegin),
comp->dspOffset(epilogStartOffsetFromMainFunctionBegin));
printf(" Epilog Start Index : %u (0x%02x)\n", epilogStartIndex, epilogStartIndex);
epilogStartAt[epilogStartIndex] = true; // an epilog starts at this offset in the unwind codes
}
}
}
else
{
printf(" --- One epilog, unwind codes at %u\n", epilogCount);
assert(epilogCount < ArrLen(epilogStartAt));
epilogStartAt[epilogCount] = true; // the one and only epilog starts its unwind codes at this offset
}
// Dump the unwind codes
printf(" ---- Unwind codes ----\n");
DWORD countOfUnwindCodes = codeWords * 4;
PBYTE pUnwindCode = (PBYTE)pdw;
BYTE b1, b2, b3, b4;
DWORD x, z;
for (DWORD i = 0; i < countOfUnwindCodes; i++)
{
// Does this byte start an epilog sequence? If so, note that fact.
if (epilogStartAt[i])
{
printf(" ---- Epilog start at index %u ----\n", i);
}
b1 = *pUnwindCode++;
if ((b1 & 0xE0) == 0)
{
// alloc_s: 000xxxxx: allocate small stack with size < 128 (2^5 * 16)
// TODO-Review:should say size < 512
x = b1 & 0x1F;
printf(" %02X alloc_s #%u (0x%02X); addi sp, sp, -%u (0x%03X)\n", b1, x, x, x * 16, x * 16);
}
#if 0
else if ((b1 & 0xE0) == 0x20)
{
// save_s0s1_x: 001zzzzz: save <s0,s1> pair at [sp-#Z*8]!, pre-indexed offset >= -248
z = b1 & 0x1F;
printf(" %02X save_s0s1_x #%u (0x%02X); Two sd %s, %s, [sp, #-%u]!\n", b1, z, z,
getRegName(REG_S0), getRegName(REG_S1), z * 8);
}
else if ((b1 & 0xF0) == 0x40)
{
// save_fpra: 0100zzzz | zzzzzzzz: save <fp,ra> pair at [sp+#Z*8], offset <= 4080
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
i++;
z = ((DWORD)(b1 & 0xF) << 8) | (DWORD)b2;
printf(" %02X %02X save_fpra #%u (0x%03X); Two sd %s, %s, [sp, #%u]\n", b1, b2, z, z, getRegName(REG_FP),
getRegName(REG_RA), z * 8);
}
else if ((b1 & 0xF0) == 0x80)
{
// save_fpra_x: 1000zzzz | zzzzzzzz: save <fp,ra> pair at [sp-(#Z+1)*8]!, pre-indexed offset >= -32768
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
i++;
z = ((DWORD)(b1 & 0xF) << 8) | (DWORD)b2;
printf(" %02X %02X save_fpra_x #%u (0x%03X); Two sd %s, %s, [sp, #-%u]!\n", b1, b2, z, z,
getRegName(REG_FP), getRegName(REG_RA), (z + 1) * 8);
}
#endif
else if ((b1 & 0xF8) == 0xC0)
{
// alloc_m: 11000xxx | xxxxxxxx: allocate large stack with size < 2k (2^7 * 16)
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
i++;
x = ((DWORD)(b1 & 0x7) << 8) | (DWORD)b2;
printf(" %02X %02X alloc_m #%u (0x%03X); addi sp, sp, -%u (0x%04X)\n", b1, b2, x, x, x * 16,
x * 16);
}
else if (b1 == 0xD0)
{
// save_reg: 11010000 | 000xxxxx | zzzzzzzz: save reg r(1 + #X) at [sp + #Z * 8], offset <= 2047
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
i += 2;
x = (DWORD)b2;
z = (DWORD)b3;
printf(" %02X %02X %02X save_reg X#%u Z#%u (0x%02X); sd %s, sp, %u\n", b1, b2, b3, x, z, z,
getRegName(REG_RA + x), z * 8);
}
#if 0
else if (b1 == 0xC8)
{
// save_regp: 11001000 | 0xxxzzzz | zzzzzzzz: save s(0 + #X) pair at [sp + #Z * 8], offset <= 4080
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
i += 2;
x = (DWORD)(b2 >> 4);
z = ((DWORD)(b2 & 0xF) << 8) | (DWORD)b3;
printf(" %02X %02X %02X save_regp X#%u Z#%u (0x%02X); Two sd %s, %s, [sp, #%u]\n", b1, b2, b3, x, z, z,
getRegName(REG_S0 + x), getRegName(REG_S0 + x + 1), z * 8);
}
else if (b1 == 0xCC)
{
// save_regp_x: 11001100 | 0xxxzzzz | zzzzzzzz: save pair s(0 + #X) at [sp - (#Z + 1) * 8]!, pre-indexed offset >=
// -32768
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
i+= 2;
x = (DWORD)(b2 >> 4);
z = ((DWORD)(b2 & 0xF) << 8) | (DWORD)b3;
printf(" %02X %02X %02X save_regp_x X#%u Z#%u (0x%02X); Two sd %s, %s, [sp, #-%u]!\n", b1, b2, b3, x, z, z,
getRegName(REG_S0 + x), getRegName(REG_S0 + x + 1), (z + 1) * 8);
}
else if ((b1 & 0xFE) == 0xD4)
{
// save_reg_x: 1101010x | xxxzzzzz: save reg s(0 + #X) at [sp - (#Z + 1) * 8]!, pre-indexed offset >= -16384
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
i++;
x = ((DWORD)(b1 & 0x1) << 3) | (DWORD)(b2 >> 5);
z = (DWORD)(b2 & 0x1F);
printf(" %02X %02X save_reg_x X#%u Z#%u (0x%02X); sd %s, [sp, #-%u]!\n", b1, b2, x, z, z,
getRegName(REG_S0 + x), (z + 1) * 8);
}
else if (b1 == 0xD6)
{
// save_rapair: 11010110 | 0xxxzzzz | zzzzzzzz: save pair <s0 + #X, ra> at [sp + #Z * 8], offset <= 32767
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
i += 2;
x = (DWORD)(b2 >> 4);
z = ((DWORD)(b2 & 0xF) << 8) | (DWORD)b3;
printf(" %02X %02X %02X save_lrpair X#%u Z#%u (0x%02X); Two sd %s, %s, [sp, #%u]\n", b1, b2, b3, x, z, z,
getRegName(REG_S0 + x), getRegName(REG_RA), z * 8);
}
else if (b1 == 0xD8)
{
// save_fregp: 11011000 | 0xxxzzzz | zzzzzzzz : save pair f(24 + #X) at [sp + #Z * 8], offset <= 32767
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
i += 2;
x = (DWORD)(b2 >> 4);
z = ((DWORD)(b2 & 0xF) << 8) | (DWORD)b3;
printf(" %02X %02X %02X save_fregp X#%u Z#%u (0x%02X); Two sdc1 %s, %s, [sp, #%u]\n", b1, b2, b3, x, z, z,
getRegName(REG_F24 + x, true), getRegName(REG_F24 + x + 1, true), z * 8);
}
else if (b1 == 0xDA)
{
// save_fregp_x: 11011010 | 0xxxzzzz | zzzzzzzz : save pair f(24 + #X), at [sp - (#Z + 1) * 8]!, pre-indexed offset >=
// -32768
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
i += 2;
x = (DWORD)(b2 >> 4);
z = ((DWORD)(b2 & 0xF) << 8) | (DWORD)b3;
printf(" %02X %02X %02X save_fregp_x X#%u Z#%u (0x%02X); Two sdc1 %s, %s, [sp, #-%u]!\n", b1, b2, b3, x, z, z,
getRegName(REG_F24 + x, true), getRegName(REG_F24 + x + 1, true), (z + 1) * 8);
}
#endif
else if ((b1 & 0xDC) == 0xDC)
{
// save_freg: 1101110x | xxxxzzzz | zzzzzzzz : save reg f(8 + #X) at [sp + #Z * 8], offset <= 2047
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
i += 2;
x = (DWORD)((b1 & 0x1) << 4) | (DWORD)(b2 >> 4);
z = ((DWORD)(2 & 0xF) << 8) | (DWORD)b3;
printf(" %02X %02X %02X save_freg X#%u Z#%u (0x%02X); fsd %s, [sp, #%u]\n", b1, b2, b3, x, z, z,
getRegName(REG_F8 + x), z * 8);
}
#if 0
else if (b1 == 0xDE)
{
// save_freg_x: 11011110 | xxxzzzzz : save reg f(24 + #X) at [sp - (#Z + 1) * 8]!, pre - indexed offset >=
// -16384
assert(i + 1 < countOfUnwindCodes);
b2 = *pUnwindCode++;
i++;
x = (DWORD)(b2 >> 5);
z = (DWORD)(b2 & 0x1F);
printf(" %02X %02X save_freg_x X#%u Z#%u (0x%02X); sdc1 %s, [sp, #-%u]!\n", b1, b2, x, z, z,
getRegName(REG_F24 + x, true), (z + 1) * 8);
}
#endif
else if (b1 == 0xE0)
{
// alloc_l: 11100000 | xxxxxxxx | xxxxxxxx | xxxxxxxx : allocate large stack with size < 256M (2^24 * 16)
assert(i + 3 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
b4 = *pUnwindCode++;
i += 3;
x = ((DWORD)b2 << 16) | ((DWORD)b3 << 8) | (DWORD)b4;
printf(" %02X %02X %02X %02X alloc_l %u (0x%06X); addi sp, sp, -%u (%06X)\n", b1, b2, b3, b4, x, x,
x * 16, x * 16);
}
else if (b1 == 0xE1)
{
// set_fp: 11100001 : set up $29 : with : move fp, sp
printf(" %02X set_fp; move %s, sp\n", b1, getRegName(REG_FP));
}
else if (b1 == 0xE2)
{
// add_fp: 11100010 | 000xxxxx | xxxxxxxx : set up fp with : addi.d fp, sp, #x * 8
assert(i + 2 < countOfUnwindCodes);
b2 = *pUnwindCode++;
b3 = *pUnwindCode++;
i += 2;
x = ((DWORD)(b2 & 0x1F) << 8) | (DWORD)b3;
printf(" %02X %02X %02X add_fp %u (0x%02X); addi %s, sp, #%u\n", b1, b2, b3, x, x,
getRegName(REG_FP), x * 8);
}
else if (b1 == 0xE3)
{
// nop: 11100011: no unwind operation is required.
printf(" %02X nop\n", b1);
}
else if (b1 == 0xE4)
{
// end: 11100100 : end of unwind code
printf(" %02X end\n", b1);
}
else if (b1 == 0xE5)
{
// end_c: 11100101 : end of unwind code in current chained scope.
printf(" %02X end_c\n", b1);
}
else if (b1 == 0xE6)
{
// save_next: 11100110 : save next non - volatile Int or FP register pair.
printf(" %02X save_next\n", b1);
}
else
{
printf("===========[riscv64] Unknown / reserved unwind code: %02X\n", b1);
// Unknown / reserved unwind code
assert(!"Internal error decoding unwind codes");
}
}
pdw += codeWords;
assert((PBYTE)pdw == pUnwindCode);
assert((PBYTE)pdw == pHeader + unwindBlockSize);
assert(XBit == 0); // We don't handle the case where exception data is present, such as the Exception Handler RVA
printf("\n");
}
#endif // DEBUG
/*XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XX XX
XX Unwind APIs XX
XX XX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
*/
void Compiler::unwindBegProlog()
{
assert(compGeneratingProlog);
assert(!compGeneratingUnwindProlog);
compGeneratingUnwindProlog = true;
#if defined(FEATURE_CFI_SUPPORT)
if (generateCFIUnwindCodes())
{
unwindBegPrologCFI();
return;
}
#endif // FEATURE_CFI_SUPPORT
FuncInfoDsc* func = funCurrentFunc();
// There is only one prolog for a function/funclet, and it comes first. So now is
// a good time to initialize all the unwind data structures.
emitLocation* startLoc;
emitLocation* endLoc;
unwindGetFuncLocations(func, true, &startLoc, &endLoc);
func->uwi.InitUnwindInfo(this, startLoc, endLoc);
func->uwi.CaptureLocation();
func->uwiCold = NULL; // No cold data yet
}
void Compiler::unwindEndProlog()
{
assert(compGeneratingProlog);
assert(compGeneratingUnwindProlog);
compGeneratingUnwindProlog = false;
}
void Compiler::unwindBegEpilog()
{
assert(compGeneratingEpilog);
assert(!compGeneratingUnwindEpilog);
compGeneratingUnwindEpilog = true;
#if defined(FEATURE_CFI_SUPPORT)
if (generateCFIUnwindCodes())
{
return;
}
#endif // FEATURE_CFI_SUPPORT
funCurrentFunc()->uwi.AddEpilog();
}
void Compiler::unwindEndEpilog()
{
assert(compGeneratingEpilog);
assert(compGeneratingUnwindEpilog);
compGeneratingUnwindEpilog = false;
}
// The instructions between the last captured "current state" and the current instruction
// are in the prolog but have no effect for unwinding. Emit the appropriate NOP unwind codes
// for them.
void Compiler::unwindPadding()
{
#if defined(FEATURE_CFI_SUPPORT)
if (generateCFIUnwindCodes())
{
return;
}
#endif // FEATURE_CFI_SUPPORT
UnwindInfo* pu = &funCurrentFunc()->uwi;
GetEmitter()->emitUnwindNopPadding(pu->GetCurrentEmitterLocation(), this);
}
// Ask the VM to reserve space for the unwind information for the function and
// all its funclets.
void Compiler::unwindReserve()
{
assert(!compGeneratingProlog);
assert(!compGeneratingEpilog);
assert(compFuncInfoCount > 0);
for (unsigned funcIdx = 0; funcIdx < compFuncInfoCount; funcIdx++)
{
unwindReserveFunc(funGetFunc(funcIdx));
}
}
void Compiler::unwindReserveFunc(FuncInfoDsc* func)
{
BOOL isFunclet = (func->funKind == FUNC_ROOT) ? FALSE : TRUE;
bool funcHasColdSection = false;
#if defined(FEATURE_CFI_SUPPORT)
if (generateCFIUnwindCodes())
{
DWORD unwindCodeBytes = 0;
if (fgFirstColdBlock != nullptr)
{
eeReserveUnwindInfo(isFunclet, true /*isColdCode*/, unwindCodeBytes);
}
unwindCodeBytes = (DWORD)(func->cfiCodes->size() * sizeof(CFI_CODE));
eeReserveUnwindInfo(isFunclet, false /*isColdCode*/, unwindCodeBytes);
return;
}
#endif // FEATURE_CFI_SUPPORT
// If there is cold code, split the unwind data between the hot section and the
// cold section. This needs to be done before we split into fragments, as each
// of the hot and cold sections can have multiple fragments.
if (fgFirstColdBlock != NULL)
{
assert(!isFunclet); // TODO-CQ: support hot/cold splitting with EH
emitLocation* startLoc;
emitLocation* endLoc;
unwindGetFuncLocations(func, false, &startLoc, &endLoc);
func->uwiCold = new (this, CMK_UnwindInfo) UnwindInfo();
func->uwiCold->InitUnwindInfo(this, startLoc, endLoc);
func->uwiCold->HotColdSplitCodes(&func->uwi);
funcHasColdSection = true;
}
// First we need to split the function or funclet into fragments that are no larger
// than 512K, so the fragment size will fit in the unwind data "Function Length" field.
// The RISCV64 Exception Data specification "Function Fragments" section describes this.
func->uwi.Split();
func->uwi.Reserve(isFunclet, true);
// After the hot section, split and reserve the cold section
if (funcHasColdSection)
{
assert(func->uwiCold != NULL);
func->uwiCold->Split();
func->uwiCold->Reserve(isFunclet, false);
}
}
// unwindEmit: Report all the unwind information to the VM.
// Arguments:
// pHotCode: Pointer to the beginning of the memory with the function and funclet hot code
// pColdCode: Pointer to the beginning of the memory with the function and funclet cold code.
void Compiler::unwindEmit(void* pHotCode, void* pColdCode)
{
assert(compFuncInfoCount > 0);
for (unsigned funcIdx = 0; funcIdx < compFuncInfoCount; funcIdx++)
{
unwindEmitFunc(funGetFunc(funcIdx), pHotCode, pColdCode);
}
}
void Compiler::unwindEmitFunc(FuncInfoDsc* func, void* pHotCode, void* pColdCode)
{
// Verify that the JIT enum is in sync with the JIT-EE interface enum
static_assert_no_msg(FUNC_ROOT == (FuncKind)CORJIT_FUNC_ROOT);
static_assert_no_msg(FUNC_HANDLER == (FuncKind)CORJIT_FUNC_HANDLER);
static_assert_no_msg(FUNC_FILTER == (FuncKind)CORJIT_FUNC_FILTER);
#if defined(FEATURE_CFI_SUPPORT)
if (generateCFIUnwindCodes())
{
unwindEmitFuncCFI(func, pHotCode, pColdCode);
return;
}
#endif // FEATURE_CFI_SUPPORT
func->uwi.Allocate((CorJitFuncKind)func->funKind, pHotCode, pColdCode, true);
if (func->uwiCold != NULL)
{
func->uwiCold->Allocate((CorJitFuncKind)func->funKind, pHotCode, pColdCode, false);
}
}
///////////////////////////////////////////////////////////////////////////////
//
// UnwindPrologCodes
//
///////////////////////////////////////////////////////////////////////////////
// We're going to use the prolog codes memory to store the final unwind data.
// Ensure we have enough memory to store everything. If 'epilogBytes' > 0, then
// move the prolog codes so there are 'epilogBytes' bytes after the prolog codes.
// Set the header pointer for future use, adding the header bytes (this pointer
// is updated when a header byte is added), and remember the index that points
// to the beginning of the header.
void UnwindPrologCodes::SetFinalSize(int headerBytes, int epilogBytes)
{
#ifdef DEBUG
// We're done adding codes. Check that we didn't accidentally create a bigger prolog.
unsigned codeSize = GetCodeSizeFromUnwindCodes(true);
assert(codeSize <= MAX_PROLOG_SIZE_BYTES);
#endif // DEBUG
int prologBytes = Size();
EnsureSize(headerBytes + prologBytes + epilogBytes + 3); // 3 = padding bytes for alignment
upcUnwindBlockSlot = upcCodeSlot - headerBytes - epilogBytes; // Index of the first byte of the unwind header
assert(upcMemSize == upcUnwindBlockSlot + headerBytes + prologBytes + epilogBytes + 3);
upcHeaderSlot = upcUnwindBlockSlot - 1; // upcHeaderSlot is always incremented before storing
assert(upcHeaderSlot >= -1);
if (epilogBytes > 0)
{
// The prolog codes that are already at the end of the array need to get moved to the middle,
// with space for the non-matching epilog codes to follow.
memmove_s(&upcMem[upcUnwindBlockSlot + headerBytes], upcMemSize - (upcUnwindBlockSlot + headerBytes),
&upcMem[upcCodeSlot], prologBytes);
// Note that the three UWC_END padding bytes still exist at the end of the array.
CLANG_FORMAT_COMMENT_ANCHOR;
#ifdef DEBUG
// Zero out the epilog codes memory, to ensure we've copied the right bytes. Don't zero the padding bytes.
memset(&upcMem[upcUnwindBlockSlot + headerBytes + prologBytes], 0, epilogBytes);
#endif // DEBUG
upcEpilogSlot =
upcUnwindBlockSlot + headerBytes + prologBytes; // upcEpilogSlot points to the next epilog location to fill
// Update upcCodeSlot to point at the new beginning of the prolog codes
upcCodeSlot = upcUnwindBlockSlot + headerBytes;
}
}
// Add a header word. Header words are added starting at the beginning, in order: first to last.
// This is in contrast to the prolog unwind codes, which are added in reverse order.
void UnwindPrologCodes::AddHeaderWord(DWORD d)
{
assert(-1 <= upcHeaderSlot);
assert(upcHeaderSlot + 4 < upcCodeSlot); // Don't collide with the unwind codes that are already there!
// Store it byte-by-byte in little-endian format. We've already ensured there is enough space
// in SetFinalSize().
upcMem[++upcHeaderSlot] = (BYTE)d;
upcMem[++upcHeaderSlot] = (BYTE)(d >> 8);
upcMem[++upcHeaderSlot] = (BYTE)(d >> 16);
upcMem[++upcHeaderSlot] = (BYTE)(d >> 24);
}
// AppendEpilog: copy the epilog bytes to the next epilog bytes slot
void UnwindPrologCodes::AppendEpilog(UnwindEpilogInfo* pEpi)
{
assert(upcEpilogSlot != -1);
int epiSize = pEpi->Size();
memcpy_s(&upcMem[upcEpilogSlot], upcMemSize - upcEpilogSlot - 3, pEpi->GetCodes(),
epiSize); // -3 to avoid writing to the alignment padding
assert(pEpi->GetStartIndex() == upcEpilogSlot - upcCodeSlot); // Make sure we copied it where we expected to copy
// it.
upcEpilogSlot += epiSize;
assert(upcEpilogSlot <= upcMemSize - 3);
}
// GetFinalInfo: return a pointer to the final unwind info to hand to the VM, and the size of this info in bytes
void UnwindPrologCodes::GetFinalInfo(/* OUT */ BYTE** ppUnwindBlock, /* OUT */ ULONG* pUnwindBlockSize)
{
assert(upcHeaderSlot + 1 == upcCodeSlot); // We better have filled in the header before asking for the final data!
*ppUnwindBlock = &upcMem[upcUnwindBlockSlot];
// We put 4 'end' codes at the end for padding, so we can ensure we have an
// unwind block that is a multiple of 4 bytes in size. Subtract off three 'end'
// codes (leave one), and then align the size up to a multiple of 4.
*pUnwindBlockSize = AlignUp((UINT)(upcMemSize - upcUnwindBlockSlot - 3), sizeof(DWORD));
}
int UnwindPrologCodes::Match(UnwindEpilogInfo* pEpi)
{
if (Size() < pEpi->Size())
{
return -1;
}
int matchIndex = 0; // Size() - pEpi->Size();
BYTE* pProlog = GetCodes();
BYTE* pEpilog = pEpi->GetCodes();
// First check set_fp.
if (0 < pEpi->Size())
{
if (*pProlog == 0xE1)
{