-
-
Notifications
You must be signed in to change notification settings - Fork 5.4k
/
debuginfo.cpp
1623 lines (1507 loc) · 60.4 KB
/
debuginfo.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
// This file is a part of Julia. License is MIT: https://julialang.org/license
#include "platform.h"
#include "llvm-version.h"
#include <llvm/DebugInfo/DIContext.h>
#include <llvm/DebugInfo/DWARF/DWARFContext.h>
#include <llvm/Object/SymbolSize.h>
#include <llvm/Support/MemoryBuffer.h>
#include <llvm/IR/Function.h>
#include <llvm/ADT/StringRef.h>
#include <llvm/ADT/StringMap.h>
#include <llvm/IR/DebugInfo.h>
#include <llvm/IR/DataLayout.h>
#include <llvm/IR/Mangler.h>
#include <llvm/ExecutionEngine/RTDyldMemoryManager.h>
#include <llvm/ExecutionEngine/RuntimeDyld.h>
#include <llvm/BinaryFormat/Magic.h>
#include <llvm/Object/MachO.h>
#include <llvm/Object/COFF.h>
#include <llvm/Object/ELFObjectFile.h>
#ifdef _OS_DARWIN_
#include <CoreFoundation/CoreFoundation.h>
#endif
using namespace llvm;
#include "jitlayers.h"
#include "debuginfo.h"
#if defined(_OS_LINUX_)
# include <link.h>
#endif
#include "processor.h"
#include <string>
#include <map>
#include <vector>
#include <set>
#include <mutex>
#include "julia_assert.h"
#include "debug-registry.h"
static JITDebugInfoRegistry *DebugRegistry = new JITDebugInfoRegistry;
static JITDebugInfoRegistry &getJITDebugRegistry() JL_NOTSAFEPOINT {
return *DebugRegistry;
}
struct debug_link_info {
StringRef filename;
uint32_t crc32;
};
#if (defined(_OS_LINUX_) || defined(_OS_FREEBSD_) || (defined(_OS_DARWIN_) && defined(LLVM_SHLIB)))
extern "C" void __register_frame(void*) JL_NOTSAFEPOINT;
extern "C" void __deregister_frame(void*) JL_NOTSAFEPOINT;
template <typename callback>
static void processFDEs(const char *EHFrameAddr, size_t EHFrameSize, callback f)
{
const char *P = EHFrameAddr;
const char *End = P + EHFrameSize;
do {
const char *Entry = P;
P += 4;
assert(P <= End);
uint32_t Length = *(const uint32_t*)Entry;
// Length == 0: Terminator
if (Length == 0)
break;
assert(P + Length <= End);
uint32_t Offset = *(const uint32_t*)P;
// Offset == 0: CIE
if (Offset != 0)
f(Entry);
P += Length;
} while (P != End);
}
#endif
std::string JITDebugInfoRegistry::mangle(StringRef Name, const DataLayout &DL)
{
std::string MangledName;
{
raw_string_ostream MangledNameStream(MangledName);
Mangler::getNameWithPrefix(MangledNameStream, Name, DL);
}
return MangledName;
}
void JITDebugInfoRegistry::add_code_in_flight(StringRef name, jl_code_instance_t *codeinst, const DataLayout &DL) {
(**codeinst_in_flight)[mangle(name, DL)] = codeinst;
}
jl_method_instance_t *JITDebugInfoRegistry::lookupLinfo(size_t pointer)
{
jl_lock_profile();
auto region = linfomap.lower_bound(pointer);
jl_method_instance_t *linfo = NULL;
if (region != linfomap.end() && pointer < region->first + region->second.first)
linfo = region->second.second;
jl_unlock_profile();
return linfo;
}
//Protected by debuginfo_asyncsafe (profile) lock
JITDebugInfoRegistry::objectmap_t &
JITDebugInfoRegistry::getObjectMap()
{
return objectmap;
}
void JITDebugInfoRegistry::add_image_info(image_info_t info) {
(**this->image_info)[info.base] = info;
}
bool JITDebugInfoRegistry::get_image_info(uint64_t base, JITDebugInfoRegistry::image_info_t *info) const {
auto infos = *this->image_info;
auto it = infos->find(base);
if (it != infos->end()) {
*info = it->second;
return true;
}
return false;
}
JITDebugInfoRegistry::Locked<JITDebugInfoRegistry::objfilemap_t>::LockT
JITDebugInfoRegistry::get_objfile_map() {
return *this->objfilemap;
}
JITDebugInfoRegistry::JITDebugInfoRegistry() { }
struct unw_table_entry
{
int32_t start_ip_offset;
int32_t fde_offset;
};
// some actions aren't signal (especially profiler) safe so we acquire a lock
// around them to establish a mutual exclusion with unwinding from a signal
template <typename T>
static void jl_profile_atomic(T f) JL_NOTSAFEPOINT
{
assert(0 == jl_lock_profile_rd_held());
jl_lock_profile_wr();
#ifndef _OS_WINDOWS_
sigset_t sset;
sigset_t oset;
sigfillset(&sset);
pthread_sigmask(SIG_BLOCK, &sset, &oset);
#endif
f();
#ifndef _OS_WINDOWS_
pthread_sigmask(SIG_SETMASK, &oset, NULL);
#endif
jl_unlock_profile_wr();
}
// --- storing and accessing source location metadata ---
void jl_add_code_in_flight(StringRef name, jl_code_instance_t *codeinst, const DataLayout &DL)
{
getJITDebugRegistry().add_code_in_flight(name, codeinst, DL);
}
#if defined(_OS_WINDOWS_)
static void create_PRUNTIME_FUNCTION(uint8_t *Code, size_t Size, StringRef fnname,
uint8_t *Section, size_t Allocated, uint8_t *UnwindData)
{
// GC safe
DWORD mod_size = 0;
#if defined(_CPU_X86_64_)
PRUNTIME_FUNCTION tbl = (PRUNTIME_FUNCTION)malloc_s(sizeof(RUNTIME_FUNCTION));
tbl->BeginAddress = (DWORD)(Code - Section);
tbl->EndAddress = (DWORD)(Code - Section + Size);
tbl->UnwindData = (DWORD)(UnwindData - Section);
assert(Code >= Section && Code + Size <= Section + Allocated);
assert(UnwindData >= Section && UnwindData <= Section + Allocated);
#else // defined(_CPU_X86_64_)
Section += (uintptr_t)Code;
mod_size = Size;
#endif
if (0) {
uv_mutex_lock(&jl_in_stackwalk);
if (mod_size && !SymLoadModuleEx(GetCurrentProcess(), NULL, NULL, NULL, (DWORD64)Section, mod_size, NULL, SLMFLAG_VIRTUAL)) {
static int warned = 0;
if (!warned) {
jl_safe_printf("WARNING: failed to insert module info for backtrace: %lu\n", GetLastError());
warned = 1;
}
}
else {
size_t len = fnname.size()+1;
if (len > MAX_SYM_NAME)
len = MAX_SYM_NAME;
char *name = (char*)alloca(len);
memcpy(name, fnname.data(), len-1);
name[len-1] = 0;
if (!SymAddSymbol(GetCurrentProcess(), (ULONG64)Section, name,
(DWORD64)Code, (DWORD)Size, 0)) {
jl_safe_printf("WARNING: failed to insert function name %s into debug info: %lu\n", name, GetLastError());
}
}
uv_mutex_unlock(&jl_in_stackwalk);
}
#if defined(_CPU_X86_64_)
jl_profile_atomic([&]() JL_NOTSAFEPOINT {
if (!RtlAddFunctionTable(tbl, 1, (DWORD64)Section)) {
static int warned = 0;
if (!warned) {
jl_safe_printf("WARNING: failed to insert function stack unwind info: %lu\n", GetLastError());
warned = 1;
}
}
});
#endif
}
#endif
void JITDebugInfoRegistry::registerJITObject(const object::ObjectFile &Object,
std::function<uint64_t(const StringRef &)> getLoadAddress,
std::function<void*(void*)> lookupWriteAddress)
{
object::section_iterator EndSection = Object.section_end();
#ifdef _CPU_ARM_
// ARM does not have/use .eh_frame
uint64_t arm_exidx_addr = 0;
size_t arm_exidx_len = 0;
uint64_t arm_text_addr = 0;
size_t arm_text_len = 0;
for (auto §ion: Object.sections()) {
bool istext = false;
if (section.isText()) {
istext = true;
}
else {
auto sName = section.getName();
if (!sName)
continue;
if (sName.get() != ".ARM.exidx") {
continue;
}
}
uint64_t loadaddr = getLoadAddress(section.getName().get());
size_t seclen = section.getSize();
if (istext) {
arm_text_addr = loadaddr;
arm_text_len = seclen;
if (!arm_exidx_addr) {
continue;
}
}
else {
arm_exidx_addr = loadaddr;
arm_exidx_len = seclen;
if (!arm_text_addr) {
continue;
}
}
unw_dyn_info_t *di = new unw_dyn_info_t;
di->gp = 0;
di->format = UNW_INFO_FORMAT_ARM_EXIDX;
di->start_ip = (uintptr_t)arm_text_addr;
di->end_ip = (uintptr_t)(arm_text_addr + arm_text_len);
di->u.rti.name_ptr = 0;
di->u.rti.table_data = arm_exidx_addr;
di->u.rti.table_len = arm_exidx_len;
jl_profile_atomic([&]() JL_NOTSAFEPOINT {
_U_dyn_register(di);
});
break;
}
#endif
#if defined(_OS_WINDOWS_)
uint64_t SectionAddrCheck = 0;
uint64_t SectionLoadCheck = 0; (void)SectionLoadCheck;
uint64_t SectionWriteCheck = 0; (void)SectionWriteCheck;
uint8_t *UnwindData = NULL;
#if defined(_CPU_X86_64_)
uint8_t *catchjmp = NULL;
for (const object::SymbolRef &sym_iter : Object.symbols()) {
StringRef sName = cantFail(sym_iter.getName());
if (sName.equals("__UnwindData") || sName.equals("__catchjmp")) {
uint64_t Addr = cantFail(sym_iter.getAddress());
auto Section = cantFail(sym_iter.getSection());
assert(Section != EndSection && Section->isText());
uint64_t SectionAddr = Section->getAddress();
StringRef secName = cantFail(Section->getName());
uint64_t SectionLoadAddr = getLoadAddress(secName);
assert(SectionLoadAddr);
if (SectionAddrCheck) // assert that all of the Sections are at the same location
assert(SectionAddrCheck == SectionAddr &&
SectionLoadCheck == SectionLoadAddr);
SectionAddrCheck = SectionAddr;
SectionLoadCheck = SectionLoadAddr;
SectionWriteCheck = SectionLoadAddr;
if (lookupWriteAddress)
SectionWriteCheck = (uintptr_t)lookupWriteAddress((void*)SectionLoadAddr);
Addr += SectionWriteCheck - SectionLoadCheck;
if (sName.equals("__UnwindData")) {
UnwindData = (uint8_t*)Addr;
}
else if (sName.equals("__catchjmp")) {
catchjmp = (uint8_t*)Addr;
}
}
}
assert(catchjmp);
assert(UnwindData);
assert(SectionAddrCheck);
assert(SectionLoadCheck);
assert(!memcmp(catchjmp, "\0\0\0\0\0\0\0\0\0\0\0\0", 12) &&
!memcmp(UnwindData, "\0\0\0\0\0\0\0\0\0\0\0\0", 12));
catchjmp[0] = 0x48;
catchjmp[1] = 0xb8; // mov RAX, QWORD PTR [&__julia_personality]
*(uint64_t*)(&catchjmp[2]) = (uint64_t)&__julia_personality;
catchjmp[10] = 0xff;
catchjmp[11] = 0xe0; // jmp RAX
UnwindData[0] = 0x09; // version info, UNW_FLAG_EHANDLER
UnwindData[1] = 4; // size of prolog (bytes)
UnwindData[2] = 2; // count of unwind codes (slots)
UnwindData[3] = 0x05; // frame register (rbp) = rsp
UnwindData[4] = 4; // second instruction
UnwindData[5] = 0x03; // mov RBP, RSP
UnwindData[6] = 1; // first instruction
UnwindData[7] = 0x50; // push RBP
*(DWORD*)&UnwindData[8] = (DWORD)(catchjmp - (uint8_t*)SectionWriteCheck); // relative location of catchjmp
UnwindData -= SectionWriteCheck - SectionLoadCheck;
#endif // defined(_OS_X86_64_)
#endif // defined(_OS_WINDOWS_)
auto symbols = object::computeSymbolSizes(Object);
bool first = true;
for (const auto &sym_size : symbols) {
const object::SymbolRef &sym_iter = sym_size.first;
object::SymbolRef::Type SymbolType = cantFail(sym_iter.getType());
if (SymbolType != object::SymbolRef::ST_Function) continue;
uint64_t Addr = cantFail(sym_iter.getAddress());
auto Section = cantFail(sym_iter.getSection());
if (Section == EndSection) continue;
if (!Section->isText()) continue;
uint64_t SectionAddr = Section->getAddress();
StringRef secName = cantFail(Section->getName());
uint64_t SectionLoadAddr = getLoadAddress(secName);
Addr -= SectionAddr - SectionLoadAddr;
StringRef sName = cantFail(sym_iter.getName());
uint64_t SectionSize = Section->getSize();
size_t Size = sym_size.second;
#if defined(_OS_WINDOWS_)
if (SectionAddrCheck)
assert(SectionAddrCheck == SectionAddr &&
SectionLoadCheck == SectionLoadAddr);
SectionAddrCheck = SectionAddr;
SectionLoadCheck = SectionLoadAddr;
create_PRUNTIME_FUNCTION(
(uint8_t*)(uintptr_t)Addr, (size_t)Size, sName,
(uint8_t*)(uintptr_t)SectionLoadAddr, (size_t)SectionSize, UnwindData);
#endif
jl_code_instance_t *codeinst = NULL;
{
auto lock = *this->codeinst_in_flight;
auto &codeinst_in_flight = *lock;
StringMap<jl_code_instance_t*>::iterator codeinst_it = codeinst_in_flight.find(sName);
if (codeinst_it != codeinst_in_flight.end()) {
codeinst = codeinst_it->second;
codeinst_in_flight.erase(codeinst_it);
}
}
jl_profile_atomic([&]() JL_NOTSAFEPOINT {
if (codeinst)
linfomap[Addr] = std::make_pair(Size, codeinst->def);
if (first) {
objectmap[SectionLoadAddr] = {&Object,
(size_t)SectionSize,
(ptrdiff_t)(SectionAddr - SectionLoadAddr),
*Section,
nullptr,
};
first = false;
}
});
}
}
void jl_register_jit_object(const object::ObjectFile &Object,
std::function<uint64_t(const StringRef &)> getLoadAddress,
std::function<void *(void *)> lookupWriteAddress) JL_NOTSAFEPOINT
{
getJITDebugRegistry().registerJITObject(Object, getLoadAddress, lookupWriteAddress);
}
// TODO: convert the safe names from aotcomile.cpp:makeSafeName back into symbols
static std::pair<char *, bool> jl_demangle(const char *name) JL_NOTSAFEPOINT
{
// This function is not allowed to reference any TLS variables since
// it can be called from an unmanaged thread on OSX.
const char *start = name + 6;
const char *end = name + strlen(name);
char *ret;
if (end <= start)
goto done;
if (strncmp(name, "japi1_", 6) &&
strncmp(name, "japi3_", 6) &&
strncmp(name, "julia_", 6) &&
strncmp(name, "jsys1_", 6) &&
strncmp(name, "jlsys_", 6))
goto done;
if (*start == '\0')
goto done;
while (*(--end) != '_') {
char c = *end;
if (c < '0' || c > '9')
goto done;
}
if (end <= start)
goto done;
ret = (char*)malloc_s(end - start + 1);
memcpy(ret, start, end - start);
ret[end - start] = '\0';
return std::make_pair(ret, true);
done:
return std::make_pair(strdup(name), false);
}
// *frames is a one element array containing whatever we could come up
// with for the current frame. here we'll try to expand it using debug info
// func_name and file_name are either NULL or malloc'd pointers
static int lookup_pointer(
object::SectionRef Section, DIContext *context,
jl_frame_t **frames, size_t pointer, int64_t slide,
bool demangle, bool noInline) JL_NOTSAFEPOINT
{
// This function is not allowed to reference any TLS variables
// since it can be called from an unmanaged thread on OSX.
if (!context || !Section.getObject()) {
if (demangle) {
char *oldname = (*frames)[0].func_name;
if (oldname != NULL) {
std::pair<char *, bool> demangled = jl_demangle(oldname);
(*frames)[0].func_name = demangled.first;
(*frames)[0].fromC = !demangled.second;
free(oldname);
}
else {
// We do this to hide the jlcall wrappers when getting julia backtraces,
// but it is still good to have them for regular lookup of C frames.
// Technically not true, but we don't want them
// in julia backtraces, so close enough
(*frames)[0].fromC = 1;
}
}
return 1;
}
DILineInfoSpecifier infoSpec(DILineInfoSpecifier::FileLineInfoKind::AbsoluteFilePath,
DILineInfoSpecifier::FunctionNameKind::ShortName);
// DWARFContext/DWARFUnit update some internal tables during these queries, so
// a lock is needed.
assert(0 == jl_lock_profile_rd_held());
jl_lock_profile_wr();
auto inlineInfo = context->getInliningInfoForAddress(makeAddress(Section, pointer + slide), infoSpec);
jl_unlock_profile_wr();
int fromC = (*frames)[0].fromC;
int n_frames = inlineInfo.getNumberOfFrames();
if (n_frames == 0) {
// no line number info available in the context, return without the context
return lookup_pointer(object::SectionRef(), NULL, frames, pointer, slide, demangle, noInline);
}
if (noInline)
n_frames = 1;
if (n_frames > 1) {
jl_frame_t *new_frames = (jl_frame_t*)calloc(sizeof(jl_frame_t), n_frames);
memcpy(&new_frames[n_frames - 1], *frames, sizeof(jl_frame_t));
free(*frames);
*frames = new_frames;
}
for (int i = 0; i < n_frames; i++) {
bool inlined_frame = i != n_frames - 1;
DILineInfo info;
if (!noInline) {
info = inlineInfo.getFrame(i);
}
else {
jl_lock_profile_wr();
info = context->getLineInfoForAddress(makeAddress(Section, pointer + slide), infoSpec);
jl_unlock_profile_wr();
}
jl_frame_t *frame = &(*frames)[i];
std::string func_name(info.FunctionName);
if (inlined_frame) {
frame->inlined = 1;
frame->fromC = fromC;
if (!fromC) {
std::size_t semi_pos = func_name.find(';');
if (semi_pos != std::string::npos) {
func_name = func_name.substr(0, semi_pos);
frame->linfo = NULL; // Looked up on Julia side
}
}
}
if (func_name == "<invalid>")
frame->func_name = NULL;
else
jl_copy_str(&frame->func_name, func_name.c_str());
if (!frame->func_name)
frame->fromC = 1;
frame->line = info.Line;
std::string file_name(info.FileName);
if (file_name == "<invalid>")
frame->file_name = NULL;
else
jl_copy_str(&frame->file_name, file_name.c_str());
}
return n_frames;
}
#ifdef _OS_DARWIN_
#include <mach-o/dyld.h>
#else
#define LC_UUID 0
#endif
#ifndef _OS_WINDOWS_
#include <dlfcn.h>
#endif
#if defined(_OS_DARWIN_) && defined(LLVM_SHLIB)
void JITDebugInfoRegistry::libc_frames_t::libc_register_frame(const char *Entry) {
auto libc_register_frame_ = jl_atomic_load_relaxed(&this->libc_register_frame_);
if (!libc_register_frame_) {
libc_register_frame_ = (void(*)(void*))dlsym(RTLD_NEXT, "__register_frame");
jl_atomic_store_release(&this->libc_register_frame_, libc_register_frame_);
}
assert(libc_register_frame_);
jl_profile_atomic([&]() JL_NOTSAFEPOINT {
libc_register_frame_(const_cast<char *>(Entry));
__register_frame(const_cast<char *>(Entry));
});
}
void JITDebugInfoRegistry::libc_frames_t::libc_deregister_frame(const char *Entry) {
auto libc_deregister_frame_ = jl_atomic_load_relaxed(&this->libc_deregister_frame_);
if (!libc_deregister_frame_) {
libc_deregister_frame_ = (void(*)(void*))dlsym(RTLD_NEXT, "__deregister_frame");
jl_atomic_store_release(&this->libc_deregister_frame_, libc_deregister_frame_);
}
assert(libc_deregister_frame_);
jl_profile_atomic([&]() JL_NOTSAFEPOINT {
libc_deregister_frame_(const_cast<char *>(Entry));
__deregister_frame(const_cast<char *>(Entry));
});
}
#endif
static bool getObjUUID(llvm::object::MachOObjectFile *obj, uint8_t uuid[16]) JL_NOTSAFEPOINT
{
for (auto Load : obj->load_commands())
{
if (Load.C.cmd == LC_UUID) {
memcpy(uuid, ((const MachO::uuid_command*)Load.Ptr)->uuid, 16);
return true;
}
}
return false;
}
static debug_link_info getDebuglink(const object::ObjectFile &Obj) JL_NOTSAFEPOINT
{
debug_link_info info = {};
for (const object::SectionRef &Section: Obj.sections()) {
Expected<StringRef> sName = Section.getName();
if (sName && *sName == ".gnu_debuglink")
{
auto found = Section.getContents();
if (found) {
StringRef Contents = *found;
size_t length = Contents.find('\0');
info.filename = Contents.substr(0, length);
info.crc32 = *(const uint32_t*)Contents.substr(LLT_ALIGN(length + 1, 4), 4).data();
break;
}
}
}
return info;
}
/*
* crc function from http:https://svnweb.freebsd.org/base/head/sys/libkern/crc32.c (and lldb)
*
* COPYRIGHT (C) 1986 Gary S. Brown. You may use this program, or
* code or tables extracted from it, as desired without restriction.
*/
static uint32_t
calc_gnu_debuglink_crc32(const void *buf, size_t size) JL_NOTSAFEPOINT
{
static const uint32_t g_crc32_tab[] =
{
0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
};
const uint8_t *p = (const uint8_t *)buf;
uint32_t crc;
crc = ~0U;
while (size--)
crc = g_crc32_tab[(crc ^ *p++) & 0xFF] ^ (crc >> 8);
return crc ^ ~0U;
}
static Expected<object::OwningBinary<object::ObjectFile>>
openDebugInfo(StringRef debuginfopath, const debug_link_info &info) JL_NOTSAFEPOINT
{
auto SplitFile = MemoryBuffer::getFile(debuginfopath);
if (std::error_code EC = SplitFile.getError()) {
return errorCodeToError(EC);
}
uint32_t crc32 = calc_gnu_debuglink_crc32(
SplitFile.get()->getBufferStart(),
SplitFile.get()->getBufferSize());
if (crc32 != info.crc32) {
return errorCodeToError(object::object_error::arch_not_found);
}
auto error_splitobj = object::ObjectFile::createObjectFile(
SplitFile.get().get()->getMemBufferRef(),
file_magic::unknown);
if (!error_splitobj) {
return error_splitobj.takeError();
}
// successfully validated and loaded split debug info file
return object::OwningBinary<object::ObjectFile>(
std::move(error_splitobj.get()),
std::move(SplitFile.get()));
}
extern "C" JL_DLLEXPORT
void jl_register_fptrs_impl(uint64_t image_base, const jl_image_fptrs_t *fptrs,
jl_method_instance_t **linfos, size_t n)
{
getJITDebugRegistry().add_image_info({(uintptr_t) image_base, *fptrs, linfos, n});
}
template<typename T>
static inline void ignoreError(T &err) JL_NOTSAFEPOINT
{
#if !defined(NDEBUG) // Needed only with LLVM assertion build
consumeError(err.takeError());
#endif
}
static void get_function_name_and_base(llvm::object::SectionRef Section, size_t pointer, int64_t slide, bool inimage,
void **saddr, char **name, bool untrusted_dladdr) JL_NOTSAFEPOINT
{
bool needs_saddr = saddr && (!*saddr || untrusted_dladdr);
bool needs_name = name && (!*name || untrusted_dladdr);
// Try platform specific methods first since they are usually faster
if (needs_saddr) {
#if (defined(_OS_LINUX_) || defined(_OS_FREEBSD_)) && !defined(JL_DISABLE_LIBUNWIND)
unw_proc_info_t pip;
// Seems that libunwind may return NULL IP depending on what info it finds...
if (unw_get_proc_info_by_ip(unw_local_addr_space, pointer,
&pip, NULL) == 0 && pip.start_ip) {
*saddr = (void*)pip.start_ip;
needs_saddr = false;
}
#endif
#if defined(_OS_WINDOWS_) && defined(_CPU_X86_64_)
DWORD64 ImageBase;
PRUNTIME_FUNCTION fn = RtlLookupFunctionEntry(pointer, &ImageBase, NULL);
if (fn) {
*saddr = (void*)(ImageBase + fn->BeginAddress);
needs_saddr = false;
}
#endif
}
if (Section.getObject() && (needs_saddr || needs_name)) {
size_t distance = (size_t)-1;
object::SymbolRef sym_found;
for (auto sym : Section.getObject()->symbols()) {
if (!Section.containsSymbol(sym))
continue;
auto addr = sym.getAddress();
if (!addr)
continue;
size_t symptr = addr.get();
if (symptr > pointer + slide)
continue;
size_t new_dist = pointer + slide - symptr;
if (new_dist > distance)
continue;
distance = new_dist;
sym_found = sym;
}
if (distance != (size_t)-1) {
if (needs_saddr) {
uintptr_t addr = cantFail(sym_found.getAddress());
*saddr = (void*)(addr - slide);
needs_saddr = false;
}
if (needs_name) {
if (auto name_or_err = sym_found.getName()) {
auto nameref = name_or_err.get();
const char globalPrefix = // == DataLayout::getGlobalPrefix
#if defined(_OS_WINDOWS_) && !defined(_CPU_X86_64_)
'_';
#elif defined(_OS_DARWIN_)
'_';
#else
'\0';
#endif
if (globalPrefix) {
if (nameref[0] == globalPrefix)
nameref = nameref.drop_front();
#if defined(_OS_WINDOWS_) && !defined(_CPU_X86_64_)
else if (nameref[0] == '@') // X86_VectorCall
nameref = nameref.drop_front();
#endif
// else VectorCall, Assembly, Internal, etc.
}
#if defined(_OS_WINDOWS_) && !defined(_CPU_X86_64_)
nameref = nameref.split('@').first;
#endif
size_t len = nameref.size();
*name = (char*)realloc_s(*name, len + 1);
memcpy(*name, nameref.data(), len);
(*name)[len] = 0;
needs_name = false;
}
}
}
}
#ifdef _OS_WINDOWS_
// For ntdll and msvcrt since we are currently only parsing DWARF debug info through LLVM
if (!inimage && needs_name) {
static char frame_info_func[
sizeof(SYMBOL_INFO) +
MAX_SYM_NAME * sizeof(TCHAR)];
DWORD64 dwDisplacement64 = 0;
DWORD64 dwAddress = pointer;
PSYMBOL_INFO pSymbol = (PSYMBOL_INFO)frame_info_func;
pSymbol->SizeOfStruct = sizeof(SYMBOL_INFO);
pSymbol->MaxNameLen = MAX_SYM_NAME;
uv_mutex_lock(&jl_in_stackwalk);
if (SymFromAddr(GetCurrentProcess(), dwAddress, &dwDisplacement64, pSymbol)) {
// errors are ignored
jl_copy_str(name, pSymbol->Name);
}
uv_mutex_unlock(&jl_in_stackwalk);
}
#endif
}
static objfileentry_t find_object_file(uint64_t fbase, StringRef fname) JL_NOTSAFEPOINT
{
int isdarwin = 0, islinux = 0, iswindows = 0;
#if defined(_OS_DARWIN_)
isdarwin = 1;
#elif defined(_OS_LINUX_) || defined(_OS_FREEBSD_)
islinux = 1;
#elif defined(_OS_WINDOWS_)
iswindows = 1;
#endif
(void)iswindows;
// GOAL: Read debuginfo from file
objfileentry_t entry{nullptr, nullptr, 0};
auto success = getJITDebugRegistry().get_objfile_map()->emplace(fbase, entry);
if (!success.second)
// Return cached value
return success.first->second;
// GOAL: Assign errorobj
StringRef objpath;
std::string debuginfopath;
uint8_t uuid[16], uuid2[16];
if (isdarwin) {
// Hide Darwin symbols (e.g. CoreFoundation) from non-Darwin systems.
#ifdef _OS_DARWIN_
size_t msize = (size_t)(((uint64_t)-1) - fbase);
std::unique_ptr<MemoryBuffer> membuf = MemoryBuffer::getMemBuffer(
StringRef((const char *)fbase, msize), "", false);
auto origerrorobj = llvm::object::ObjectFile::createObjectFile(
membuf->getMemBufferRef(), file_magic::unknown);
if (!origerrorobj) {
ignoreError(origerrorobj);
return entry;
}
llvm::object::MachOObjectFile *morigobj = (llvm::object::MachOObjectFile*)
origerrorobj.get().get();
// First find the uuid of the object file (we'll use this to make sure we find the
// correct debug symbol file).
if (!getObjUUID(morigobj, uuid))
return entry;
// On macOS, debug symbols are not contained in the dynamic library.
// Use DBGCopyFullDSYMURLForUUID from the private DebugSymbols framework
// to make use of spotlight to find the dSYM file. If that fails, lookup
// the dSYM file in the same directory as the dynamic library. TODO: If
// the DebugSymbols framework is moved or removed, an alternative would
// be to directly query Spotlight for the dSYM bundle.
typedef CFURLRef (*DBGCopyFullDSYMURLForUUIDfn)(CFUUIDRef, CFURLRef) JL_NOTSAFEPOINT;
DBGCopyFullDSYMURLForUUIDfn DBGCopyFullDSYMURLForUUID = NULL;
// First, try to load the private DebugSymbols framework.
CFURLRef dsfmwkurl = CFURLCreateWithFileSystemPath(
kCFAllocatorDefault,
CFSTR("/System/Library/PrivateFrameworks/DebugSymbols.framework"),
kCFURLPOSIXPathStyle, true);
CFBundleRef dsfmwkbundle =
CFBundleCreate(kCFAllocatorDefault, dsfmwkurl);
CFRelease(dsfmwkurl);
if (dsfmwkbundle) {
DBGCopyFullDSYMURLForUUID =
(DBGCopyFullDSYMURLForUUIDfn)CFBundleGetFunctionPointerForName(
dsfmwkbundle, CFSTR("DBGCopyFullDSYMURLForUUID"));
}
if (DBGCopyFullDSYMURLForUUID != NULL) {
// Prepare UUID and shared object path URL.
CFUUIDRef objuuid = CFUUIDCreateWithBytes(
kCFAllocatorDefault, uuid[0], uuid[1], uuid[2], uuid[3],
uuid[4], uuid[5], uuid[6], uuid[7], uuid[8], uuid[9], uuid[10],
uuid[11], uuid[12], uuid[13], uuid[14], uuid[15]);
CFURLRef objurl = CFURLCreateFromFileSystemRepresentation(
kCFAllocatorDefault, (UInt8 const *)fname.data(),
(CFIndex)strlen(fname.data()), FALSE);
// Call private DBGCopyFullDSYMURLForUUID() to find dSYM.
CFURLRef dsympathurl = DBGCopyFullDSYMURLForUUID(objuuid, objurl);
CFRelease(objuuid);
CFRelease(objurl);
char objpathcstr[JL_PATH_MAX];
if (dsympathurl != NULL &&
CFURLGetFileSystemRepresentation(
dsympathurl, true, (UInt8 *)objpathcstr,
(CFIndex)sizeof(objpathcstr))) {
// The dSYM was found. Copy its path.
debuginfopath = objpathcstr;
objpath = debuginfopath;
CFRelease(dsympathurl);
}
}
if (dsfmwkbundle) {
CFRelease(dsfmwkbundle);
}
if (objpath.empty()) {
// Fall back to simple path relative to the dynamic library.
size_t sep = fname.rfind('/');
debuginfopath = fname.str();
debuginfopath += ".dSYM/Contents/Resources/DWARF/";
debuginfopath += fname.substr(sep + 1);
objpath = debuginfopath;
}
#endif
}
else {
// On Linux systems we need to mmap another copy because of the permissions on the mmap'ed shared library.
// On Windows we need to mmap another copy since reading the in-memory copy seems to return object_error:unexpected_eof
objpath = fname;
}
auto errorobj = llvm::object::ObjectFile::createObjectFile(objpath);
// GOAL: Find obj, context, slide (if above succeeded)
if (errorobj) {
auto *debugobj = errorobj->getBinary();
if (islinux) {
// if the file has a .gnu_debuglink section,
// try to load its companion file instead
// in the expected locations
// for now, we don't support the build-id method
debug_link_info info = getDebuglink(*debugobj);
if (!info.filename.empty()) {
size_t sep = fname.rfind('/');
Expected<object::OwningBinary<object::ObjectFile>>
DebugInfo(errorCodeToError(std::make_error_code(std::errc::no_such_file_or_directory)));
// Can't find a way to construct an empty Expected object
// that can be ignored.
if (fname.substr(sep + 1) != info.filename) {
debuginfopath = fname.substr(0, sep + 1).str();
debuginfopath += info.filename;
ignoreError(DebugInfo);
DebugInfo = openDebugInfo(debuginfopath, info);
}
if (!DebugInfo) {
debuginfopath = fname.substr(0, sep + 1).str();
debuginfopath += ".debug/";
debuginfopath += info.filename;
ignoreError(DebugInfo);
DebugInfo = openDebugInfo(debuginfopath, info);
}
if (!DebugInfo) {
debuginfopath = "/usr/lib/debug/";
debuginfopath += fname.substr(0, sep + 1);
debuginfopath += info.filename;
ignoreError(DebugInfo);
DebugInfo = openDebugInfo(debuginfopath, info);
}
if (DebugInfo) {
errorobj = std::move(DebugInfo);
// Yes, we've checked, and yes LLVM want us to check again.
ignoreError(errorobj);
debugobj = errorobj->getBinary();
}
else {
ignoreError(DebugInfo);
}
}
}
if (isdarwin) {
// verify the UUID matches
if (!getObjUUID((llvm::object::MachOObjectFile*)debugobj, uuid2) ||
memcmp(uuid, uuid2, sizeof(uuid)) != 0) {
return entry;
}
}
int64_t slide = 0;
if (auto *OF = dyn_cast<const object::COFFObjectFile>(debugobj)) {
assert(iswindows);
slide = OF->getImageBase() - fbase;
}
else {
slide = -(int64_t)fbase;
}
auto context = DWARFContext::create(*debugobj).release();
auto binary = errorobj->takeBinary();
binary.first.release();
binary.second.release();
entry = {debugobj, context, slide};
// update cache
(*getJITDebugRegistry().get_objfile_map())[fbase] = entry;
}
else {
// TODO: report the error instead of silently consuming it?
// jl_error might run into the same error again...