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
|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.
//*****************************************************************************
// File: gdbjit.h
//
//
// Header file for GDB JIT interface implemenation.
//
//*****************************************************************************
#ifndef __GDBJIT_H__
#define __GDBJIT_H__
#include <stdint.h>
#include "typekey.h"
#include "typestring.h"
#include "method.hpp"
#include "dbginterface.h"
#include "../inc/llvm/ELF.h"
#include "../inc/llvm/Dwarf.h"
#if defined(_TARGET_X86_) || defined(_TARGET_ARM_)
typedef Elf32_Ehdr Elf_Ehdr;
typedef Elf32_Shdr Elf_Shdr;
typedef Elf32_Sym Elf_Sym;
const uint16_t DW_FORM_size = DW_FORM_data4;
#define ADDRESS_SIZE 4
#elif defined(_TARGET_AMD64_) || defined(_TARGET_ARM64_)
typedef Elf64_Ehdr Elf_Ehdr;
typedef Elf64_Shdr Elf_Shdr;
typedef Elf64_Sym Elf_Sym;
const uint16_t DW_FORM_size = DW_FORM_data8;
#define ADDRESS_SIZE 8
#else
#error "Target is not supported"
#endif
static constexpr const int CorElementTypeToDWEncoding[] =
{
/* ELEMENT_TYPE_END */ 0,
/* ELEMENT_TYPE_VOID */ DW_ATE_address,
/* ELEMENT_TYPE_BOOLEAN */ DW_ATE_boolean,
/* ELEMENT_TYPE_CHAR */ DW_ATE_UTF,
/* ELEMENT_TYPE_I1 */ DW_ATE_signed,
/* ELEMENT_TYPE_U1 */ DW_ATE_unsigned,
/* ELEMENT_TYPE_I2 */ DW_ATE_signed,
/* ELEMENT_TYPE_U2 */ DW_ATE_unsigned,
/* ELEMENT_TYPE_I4 */ DW_ATE_signed,
/* ELEMENT_TYPE_U4 */ DW_ATE_unsigned,
/* ELEMENT_TYPE_I8 */ DW_ATE_signed,
/* ELEMENT_TYPE_U8 */ DW_ATE_unsigned,
/* ELEMENT_TYPE_R4 */ DW_ATE_float,
/* ELEMENT_TYPE_R8 */ DW_ATE_float,
/* ELEMENT_TYPE_STRING */ DW_ATE_address,
/* ELEMENT_TYPE_PTR */ DW_ATE_address,
/* ELEMENT_TYPE_BYREF */ DW_ATE_address,
/* ELEMENT_TYPE_VALUETYPE */ DW_ATE_address,
/* ELEMENT_TYPE_CLASS */ DW_ATE_address,
/* ELEMENT_TYPE_VAR */ DW_ATE_address,
/* ELEMENT_TYPE_ARRAY */ DW_ATE_address,
/* ELEMENT_TYPE_GENERICINST */ DW_ATE_address,
/* ELEMENT_TYPE_TYPEDBYREF */ DW_ATE_address,
/* SKIP 17 */ DW_ATE_address,
/* ELEMENT_TYPE_I */ DW_ATE_signed,
/* ELEMENT_TYPE_U */ DW_ATE_unsigned,
/* SKIP 1a */ DW_ATE_address,
/* ELEMENT_TYPE_FNPTR */ DW_ATE_address,
/* ELEMENT_TYPE_OBJECT */ DW_ATE_address,
/* ELEMENT_TYPE_SZARRAY */ DW_ATE_address,
/* ELEMENT_TYPE_MVAR */ DW_ATE_address,
/* ELEMENT_TYPE_CMOD_REQD */ DW_ATE_address,
/* ELEMENT_TYPE_CMOD_OPT */ DW_ATE_address,
/* ELEMENT_TYPE_INTERNAL */ DW_ATE_address,
/* ELEMENT_TYPE_MAX */ DW_ATE_address,
};
struct __attribute__((packed)) DwarfCompUnit
{
uint32_t m_length;
uint16_t m_version;
uint32_t m_abbrev_offset;
uint8_t m_addr_size;
};
struct __attribute__((packed)) DwarfPubHeader
{
uint32_t m_length;
uint16_t m_version;
uint32_t m_debug_info_off;
uint32_t m_debug_info_len;
};
#define DW_LNS_MAX DW_LNS_set_isa
struct __attribute__((packed)) DwarfLineNumHeader
{
uint32_t m_length;
uint16_t m_version;
uint32_t m_hdr_length;
uint8_t m_min_instr_len;
uint8_t m_def_is_stmt;
int8_t m_line_base;
uint8_t m_line_range;
uint8_t m_opcode_base;
uint8_t m_std_num_arg[DW_LNS_MAX];
};
const ULONG32 HiddenLine = 0x00feefee;
struct SymbolsInfo
{
int lineNumber, ilOffset, nativeOffset, fileIndex;
char fileName[2*MAX_PATH_FNAME];
ICorDebugInfo::SourceTypes source;
};
class DwarfDumpable
{
public:
DwarfDumpable() :
m_base_ptr(nullptr),
m_is_visited(false)
{
}
// writes all string literals this type needs to ptr
virtual void DumpStrings(char* ptr, int& offset) = 0;
virtual void DumpDebugInfo(char* ptr, int& offset) = 0;
virtual ~DwarfDumpable() {}
char *m_base_ptr;
bool m_is_visited;
};
class LocalsInfo
{
public:
struct Scope {
int ilStartOffset;
int ilEndOffset;
};
int size;
NewArrayHolder< NewArrayHolder<char> > localsName;
NewArrayHolder<Scope> localsScope;
ULONG32 countVars;
NewArrayHolder<ICorDebugInfo::NativeVarInfo> vars;
};
class TypeMember;
class TypeInfoBase : public DwarfDumpable
{
public:
TypeInfoBase(TypeHandle typeHandle)
: m_type_name(nullptr),
m_type_name_offset(0),
m_type_size(0),
m_type_offset(0),
typeHandle(typeHandle),
typeKey(typeHandle.GetTypeKey())
{
}
virtual void DumpStrings(char* ptr, int& offset) override;
void CalculateName();
void SetTypeHandle(TypeHandle handle);
TypeHandle GetTypeHandle();
TypeKey* GetTypeKey();
NewArrayHolder<char> m_type_name;
int m_type_name_offset;
ULONG m_type_size;
int m_type_offset;
private:
TypeHandle typeHandle;
TypeKey typeKey;
};
class TypeDefInfo : public DwarfDumpable
{
public:
TypeDefInfo(char *typedef_name,int typedef_type):
m_typedef_name(typedef_name), m_typedef_type(typedef_type), m_typedef_type_offset(0) {}
void DumpStrings(char* ptr, int& offset) override;
void DumpDebugInfo(char* ptr, int& offset) override;
NewArrayHolder<char> m_typedef_name;
int m_typedef_type;
int m_typedef_type_offset;
int m_typedef_name_offset;
};
class PrimitiveTypeInfo: public TypeInfoBase
{
public:
PrimitiveTypeInfo(TypeHandle typeHandle);
void DumpDebugInfo(char* ptr, int& offset) override;
void DumpStrings(char* ptr, int& offset) override;
int m_type_encoding;
NewHolder<TypeDefInfo> m_typedef_info;
};
class RefTypeInfo: public TypeInfoBase
{
public:
RefTypeInfo(TypeHandle typeHandle, TypeInfoBase *value_type)
: TypeInfoBase(typeHandle),
m_value_type(value_type)
{
m_type_size = sizeof(TADDR);
CalculateName();
}
void DumpStrings(char* ptr, int& offset) override;
void DumpDebugInfo(char* ptr, int& offset) override;
TypeInfoBase *m_value_type;
};
class NamedRefTypeInfo: public RefTypeInfo
{
public:
NamedRefTypeInfo(TypeHandle typeHandle, TypeInfoBase *value_type)
: RefTypeInfo(typeHandle, value_type), m_value_type_storage(value_type)
{
}
void DumpDebugInfo(char* ptr, int& offset) override;
NewHolder<TypeInfoBase> m_value_type_storage;
};
class FunctionMemberPtrArrayHolder;
class ArrayTypeInfo;
class ClassTypeInfo: public TypeInfoBase
{
public:
ClassTypeInfo(TypeHandle typeHandle, int num_members, FunctionMemberPtrArrayHolder &method);
void DumpStrings(char* ptr, int& offset) override;
void DumpDebugInfo(char* ptr, int& offset) override;
int m_num_members;
NewArrayHolder<TypeMember> members;
TypeInfoBase* m_parent;
FunctionMemberPtrArrayHolder &m_method;
NewHolder<ArrayTypeInfo> m_array_type;
NewHolder<ArrayTypeInfo> m_array_bounds_type;
};
class TypeMember: public DwarfDumpable
{
public:
TypeMember()
: m_member_name(nullptr),
m_member_name_offset(0),
m_member_offset(0),
m_static_member_address(0),
m_member_type(nullptr)
{
}
void DumpStrings(char* ptr, int& offset) override;
void DumpDebugInfo(char* ptr, int& offset) override;
void DumpStaticDebugInfo(char* ptr, int& offset);
NewArrayHolder<char> m_member_name;
int m_member_name_offset;
int m_member_offset;
TADDR m_static_member_address;
TypeInfoBase *m_member_type;
};
class ArrayTypeInfo: public TypeInfoBase
{
public:
ArrayTypeInfo(TypeHandle typeHandle, int count, TypeInfoBase* elemType)
: TypeInfoBase(typeHandle),
m_count(count),
m_elem_type(elemType)
{
}
void DumpDebugInfo(char* ptr, int& offset) override;
int m_count;
TypeInfoBase *m_elem_type;
};
class VarDebugInfo: public DwarfDumpable
{
public:
VarDebugInfo(int abbrev)
: m_var_name(nullptr),
m_var_abbrev(abbrev),
m_var_name_offset(0),
m_il_index(0),
m_native_offset(0),
m_var_type(nullptr),
m_low_pc(0),
m_high_pc(0)
{
}
VarDebugInfo()
: m_var_name(nullptr),
m_var_abbrev(6),
m_var_name_offset(0),
m_il_index(0),
m_native_offset(0),
m_var_type(nullptr),
m_low_pc(0),
m_high_pc(0)
{
}
void DumpStrings(char* ptr, int& offset) override;
void DumpDebugInfo(char* ptr, int& offset) override;
NewArrayHolder<char> m_var_name;
int m_var_abbrev;
int m_var_name_offset;
int m_il_index;
int m_native_offset;
TypeInfoBase *m_var_type;
uintptr_t m_low_pc;
uintptr_t m_high_pc;
};
struct Elf_Symbol;
class Elf_Builder;
class NotifyGdb
{
public:
static void MethodPrepared(MethodDesc* methodDescPtr);
static void MethodPitched(MethodDesc* methodDescPtr);
template <typename PARENT_TRAITS>
class DeleteValuesOnDestructSHashTraits : public PARENT_TRAITS
{
public:
static inline void OnDestructPerEntryCleanupAction(typename PARENT_TRAITS::element_t e)
{
delete e.Value();
}
static const bool s_DestructPerEntryCleanupAction = true;
};
template <typename VALUE>
class TypeKeyHashTraits : public DefaultSHashTraits< KeyValuePair<TypeKey*,VALUE> >
{
public:
// explicitly declare local typedefs for these traits types, otherwise
// the compiler may get confused
typedef typename DefaultSHashTraits< KeyValuePair<TypeKey*,VALUE> >::element_t element_t;
typedef typename DefaultSHashTraits< KeyValuePair<TypeKey*,VALUE> >::count_t count_t;
typedef TypeKey* key_t;
static key_t GetKey(element_t e)
{
LIMITED_METHOD_CONTRACT;
return e.Key();
}
static BOOL Equals(key_t k1, key_t k2)
{
LIMITED_METHOD_CONTRACT;
return k1->Equals(k2);
}
static count_t Hash(key_t k)
{
LIMITED_METHOD_CONTRACT;
return k->ComputeHash();
}
static const element_t Null() { LIMITED_METHOD_CONTRACT; return element_t(key_t(),VALUE()); }
static const element_t Deleted() { LIMITED_METHOD_CONTRACT; return element_t(key_t(-1), VALUE()); }
static bool IsNull(const element_t &e) { LIMITED_METHOD_CONTRACT; return e.Key() == key_t(); }
static bool IsDeleted(const element_t &e) { return e.Key() == key_t(-1); }
};
typedef MapSHash<TypeKey*, TypeInfoBase*, DeleteValuesOnDestructSHashTraits<TypeKeyHashTraits<TypeInfoBase*>>> TK_TypeInfoMap;
typedef TK_TypeInfoMap* PTK_TypeInfoMap;
typedef SetSHash< TADDR,
NoRemoveSHashTraits <
NonDacAwareSHashTraits< SetSHashTraits <TADDR> >
> > AddrSet;
private:
struct MemBuf
{
NewArrayHolder<char> MemPtr;
unsigned MemSize;
MemBuf() : MemPtr(0), MemSize(0)
{}
void Resize(unsigned newSize)
{
if (newSize == 0)
{
MemPtr = nullptr;
MemSize = 0;
return;
}
char *tmp = new char [newSize];
memmove(tmp, MemPtr.GetValue(), newSize < MemSize ? newSize : MemSize);
MemPtr = tmp;
MemSize = newSize;
}
};
static void OnMethodPrepared(MethodDesc* methodDescPtr);
#ifdef FEATURE_GDBJIT_FRAME
static bool EmitFrameInfo(Elf_Builder &, PCODE pCode, TADDR codeSzie);
#endif // FEATURE_GDBJIT_FRAME
#ifdef FEATURE_GDBJIT_SYMTAB
static bool EmitSymtab(Elf_Builder &, MethodDesc* methodDescPtr, PCODE pCode, TADDR codeSize);
#endif // FEATURE_GDBJIT_SYMTAB
static bool EmitDebugInfo(Elf_Builder &, MethodDesc* methodDescPtr, PCODE pCode, TADDR codeSize, const char *szModuleFile);
static bool BuildSymbolTableSection(MemBuf& buf, PCODE addr, TADDR codeSize, int methodCount,
NewArrayHolder<Elf_Symbol> &symbolNames, int symbolCount,
unsigned int thunkIndexBase);
static bool BuildStringTableSection(MemBuf& strTab, NewArrayHolder<Elf_Symbol> &symbolNames, int symbolCount);
static bool BuildDebugStrings(MemBuf& buf, PTK_TypeInfoMap pTypeMap, FunctionMemberPtrArrayHolder &method);
static bool BuildDebugAbbrev(MemBuf& buf);
static bool BuildDebugInfo(MemBuf& buf, PTK_TypeInfoMap pTypeMap, FunctionMemberPtrArrayHolder &method);
static bool BuildDebugPub(MemBuf& buf, const char* name, uint32_t size, uint32_t dieOffset);
static bool BuildLineTable(MemBuf& buf, PCODE startAddr, TADDR codeSize, SymbolsInfo* lines, unsigned nlines);
static bool BuildFileTable(MemBuf& buf, SymbolsInfo* lines, unsigned nlines);
static bool BuildLineProg(MemBuf& buf, PCODE startAddr, TADDR codeSize, SymbolsInfo* lines, unsigned nlines);
static void IssueSetAddress(char*& ptr, PCODE addr);
static void IssueEndOfSequence(char*& ptr);
static void IssueSimpleCommand(char*& ptr, uint8_t command);
static void IssueParamCommand(char*& ptr, uint8_t command, char* param, int param_len);
static void SplitPathname(const char* path, const char*& pathName, const char*& fileName);
static bool CollectCalledMethods(CalledMethod* pCM, TADDR nativeCode, FunctionMemberPtrArrayHolder &method,
NewArrayHolder<Elf_Symbol> &symbolNames, int &symbolCount);
};
class FunctionMember: public TypeMember
{
public:
FunctionMember(MethodDesc *md, int num_locals, int num_args)
: TypeMember(),
md(md),
m_file(1),
m_line(1),
m_sub_low_pc(0),
m_sub_high_pc(0),
m_sub_loc(),
m_num_args(num_args),
m_num_locals(num_locals),
m_num_vars(num_args + num_locals),
m_entry_offset(0),
vars(new VarDebugInfo[m_num_vars]),
lines(NULL),
nlines(0),
m_linkage_name_offset(0),
dumped(false)
{
m_sub_loc[0] = 1;
#if defined(_TARGET_AMD64_)
m_sub_loc[1] = DW_OP_reg6;
#elif defined(_TARGET_X86_)
m_sub_loc[1] = DW_OP_reg5;
#elif defined(_TARGET_ARM64_)
m_sub_loc[1] = DW_OP_reg29;
#elif defined(_TARGET_ARM_)
m_sub_loc[1] = DW_OP_reg11;
#else
#error Unsupported platform!
#endif
}
void DumpStrings(char* ptr, int& offset) override;
void DumpDebugInfo(char* ptr, int& offset) override;
void DumpTryCatchDebugInfo(char* ptr, int& offset);
HRESULT GetLocalsDebugInfo(NotifyGdb::PTK_TypeInfoMap pTypeMap,
LocalsInfo& locals,
int startNativeOffset,
FunctionMemberPtrArrayHolder &method);
BOOL IsDumped()
{
return dumped;
}
MethodDesc *md;
uint8_t m_file, m_line;
uintptr_t m_sub_low_pc, m_sub_high_pc;
uint8_t m_sub_loc[2];
uint8_t m_num_args;
uint8_t m_num_locals;
uint16_t m_num_vars;
int m_entry_offset;
NewArrayHolder<VarDebugInfo> vars;
SymbolsInfo* lines;
unsigned nlines;
int m_linkage_name_offset;
private:
int GetArgsAndLocalsLen();
void MangleName(char *buf, int &buf_offset, const char *name);
void DumpMangledNamespaceAndMethod(char *buf, int &offset, const char *nspace, const char *mname);
void DumpLinkageName(char* ptr, int& offset);
bool GetBlockInNativeCode(int blockILOffset, int blockILLen, TADDR *startOffset, TADDR *endOffset);
void DumpTryCatchBlock(char* ptr, int& offset, int ilOffset, int ilLen, int abbrev);
void DumpVarsWithScopes(char* ptr, int& offset);
BOOL dumped;
};
#endif // #ifndef __GDBJIT_H__
|