-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathclr_helpers.cpp
1045 lines (905 loc) · 32.6 KB
/
clr_helpers.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
// Copyright The OpenTelemetry Authors
// SPDX-License-Identifier: Apache-2.0
#include "clr_helpers.h"
#include <cstring>
#include <set>
#include <stack>
#include "environment_variables.h"
#include "logger.h"
#include "macros.h"
#include "otel_profiler_constants.h"
#include "pal.h"
namespace trace
{
RuntimeInformation GetRuntimeInformation(ICorProfilerInfo7* info)
{
COR_PRF_RUNTIME_TYPE runtime_type;
USHORT major_version;
USHORT minor_version;
USHORT build_version;
USHORT qfe_version;
auto hr = info->GetRuntimeInformation(nullptr, &runtime_type, &major_version, &minor_version, &build_version,
&qfe_version, 0, nullptr, nullptr);
if (FAILED(hr))
{
return {};
}
return {runtime_type, major_version, minor_version, build_version, qfe_version};
}
AssemblyInfo GetAssemblyInfo(ICorProfilerInfo7* info, const AssemblyID& assembly_id)
{
WCHAR assembly_name[kNameMaxSize];
DWORD assembly_name_len = 0;
AppDomainID app_domain_id;
ModuleID manifest_module_id;
auto hr = info->GetAssemblyInfo(assembly_id, kNameMaxSize, &assembly_name_len, assembly_name, &app_domain_id,
&manifest_module_id);
if (FAILED(hr) || assembly_name_len == 0)
{
Logger::Warn("Error loading the assembly info: ", assembly_id, " [", "AssemblyLength=", assembly_name_len,
", HRESULT=0x", std::setfill('0'), std::setw(8), std::hex, hr, "]");
return {};
}
WCHAR app_domain_name[kNameMaxSize];
DWORD app_domain_name_len = 0;
hr = info->GetAppDomainInfo(app_domain_id, kNameMaxSize, &app_domain_name_len, app_domain_name, nullptr);
if (FAILED(hr) || app_domain_name_len == 0)
{
Logger::Warn("Error loading the appdomain for assembly: ", assembly_id, " [AssemblyName=",
WSTRING(assembly_name), ", AssemblyLength=", assembly_name_len, ", HRESULT=0x", std::setfill('0'),
std::setw(8), std::hex, hr, ", AppDomainId=", app_domain_id, "]");
return {};
}
return {assembly_id, WSTRING(assembly_name), manifest_module_id, app_domain_id, WSTRING(app_domain_name)};
}
AssemblyMetadata GetAssemblyImportMetadata(const ComPtr<IMetaDataAssemblyImport>& assembly_import)
{
mdAssembly current = mdAssemblyNil;
auto hr = assembly_import->GetAssemblyFromScope(¤t);
if (FAILED(hr))
{
return {};
}
WCHAR name[kNameMaxSize];
DWORD name_len = 0;
ASSEMBLYMETADATA assembly_metadata{};
DWORD assembly_flags = 0;
const ModuleID placeholder_module_id = 0;
hr = assembly_import->GetAssemblyProps(current, nullptr, nullptr, nullptr, name, kNameMaxSize, &name_len,
&assembly_metadata, &assembly_flags);
if (FAILED(hr) || name_len == 0)
{
return {};
}
return AssemblyMetadata(placeholder_module_id, name, current, assembly_metadata.usMajorVersion,
assembly_metadata.usMinorVersion, assembly_metadata.usBuildNumber,
assembly_metadata.usRevisionNumber);
}
AssemblyMetadata GetReferencedAssemblyMetadata(const ComPtr<IMetaDataAssemblyImport>& assembly_import,
const mdAssemblyRef& assembly_ref)
{
WCHAR name[kNameMaxSize];
DWORD name_len = 0;
ASSEMBLYMETADATA assembly_metadata{};
DWORD assembly_flags = 0;
const ModuleID module_id_placeholder = 0;
const auto hr = assembly_import->GetAssemblyRefProps(assembly_ref, nullptr, nullptr, name, kNameMaxSize, &name_len,
&assembly_metadata, nullptr, nullptr, &assembly_flags);
if (FAILED(hr) || name_len == 0)
{
return {};
}
return AssemblyMetadata(module_id_placeholder, name, assembly_ref, assembly_metadata.usMajorVersion,
assembly_metadata.usMinorVersion, assembly_metadata.usBuildNumber,
assembly_metadata.usRevisionNumber);
}
std::vector<BYTE> GetSignatureByteRepresentation(ULONG signature_length, PCCOR_SIGNATURE raw_signature)
{
std::vector<BYTE> signature_data(signature_length);
for (ULONG i = 0; i < signature_length; i++)
{
signature_data[i] = raw_signature[i];
}
return signature_data;
}
FunctionInfo GetFunctionInfo(const ComPtr<IMetaDataImport2>& metadata_import, const mdToken& token)
{
mdToken parent_token = mdTokenNil;
mdToken method_spec_token = mdTokenNil;
mdToken method_def_token = mdTokenNil;
WCHAR function_name[kNameMaxSize]{};
DWORD function_name_len = 0;
PCCOR_SIGNATURE raw_signature;
ULONG raw_signature_len;
BOOL is_generic = false;
std::vector<BYTE> final_signature_bytes;
std::vector<BYTE> method_spec_signature;
HRESULT hr = E_FAIL;
const auto token_type = TypeFromToken(token);
switch (token_type)
{
case mdtMemberRef:
hr = metadata_import->GetMemberRefProps(token, &parent_token, function_name, kNameMaxSize,
&function_name_len, &raw_signature, &raw_signature_len);
break;
case mdtMethodDef:
hr = metadata_import->GetMemberProps(token, &parent_token, function_name, kNameMaxSize, &function_name_len,
nullptr, &raw_signature, &raw_signature_len, nullptr, nullptr, nullptr,
nullptr, nullptr);
break;
case mdtMethodSpec:
{
hr = metadata_import->GetMethodSpecProps(token, &parent_token, &raw_signature, &raw_signature_len);
is_generic = true;
if (FAILED(hr))
{
return {};
}
const auto generic_info = GetFunctionInfo(metadata_import, parent_token);
final_signature_bytes = generic_info.signature.data;
method_spec_signature = GetSignatureByteRepresentation(raw_signature_len, raw_signature);
std::memcpy(function_name, generic_info.name.c_str(), sizeof(WCHAR) * (generic_info.name.length() + 1));
function_name_len = DWORD(generic_info.name.length() + 1);
method_spec_token = token;
method_def_token = generic_info.id;
}
break;
default:
Logger::Warn("[trace::GetFunctionInfo] unknown token type: {}", token_type);
return {};
}
if (FAILED(hr) || function_name_len == 0)
{
return {};
}
// parent_token could be: TypeDef, TypeRef, TypeSpec, ModuleRef, MethodDef
const auto type_info = GetTypeInfo(metadata_import, parent_token);
if (is_generic)
{
// use the generic constructor and feed both method signatures
return {method_spec_token,
WSTRING(function_name),
type_info,
MethodSignature(final_signature_bytes),
MethodSignature(method_spec_signature),
method_def_token,
FunctionMethodSignature(raw_signature, raw_signature_len)};
}
final_signature_bytes = GetSignatureByteRepresentation(raw_signature_len, raw_signature);
return {token, WSTRING(function_name), type_info, MethodSignature(final_signature_bytes),
FunctionMethodSignature(raw_signature, raw_signature_len)};
}
ModuleInfo GetModuleInfo(ICorProfilerInfo7* info, const ModuleID& module_id)
{
const DWORD module_path_size = 260;
WCHAR module_path[module_path_size]{};
DWORD module_path_len = 0;
LPCBYTE base_load_address;
AssemblyID assembly_id = 0;
DWORD module_flags = 0;
const HRESULT hr = info->GetModuleInfo2(module_id, &base_load_address, module_path_size, &module_path_len,
module_path, &assembly_id, &module_flags);
if (FAILED(hr) || module_path_len == 0)
{
return {};
}
return {module_id, WSTRING(module_path), GetAssemblyInfo(info, assembly_id), module_flags};
}
TypeInfo GetTypeInfo(const ComPtr<IMetaDataImport2>& metadata_import, const mdToken& token)
{
mdToken parent_token = mdTokenNil;
std::shared_ptr<TypeInfo> parentTypeInfo = nullptr;
mdToken parent_type_token = mdTokenNil;
WCHAR type_name[kNameMaxSize]{};
DWORD type_name_len = 0;
DWORD type_flags;
std::shared_ptr<TypeInfo> extendsInfo = nullptr;
mdToken type_extends = mdTokenNil;
bool type_valueType = false;
bool type_isGeneric = false;
HRESULT hr = E_FAIL;
const auto token_type = TypeFromToken(token);
switch (token_type)
{
case mdtTypeDef:
hr = metadata_import->GetTypeDefProps(token, type_name, kNameMaxSize, &type_name_len, &type_flags,
&type_extends);
metadata_import->GetNestedClassProps(token, &parent_type_token);
if (parent_type_token != mdTokenNil)
{
parentTypeInfo = std::make_shared<TypeInfo>(GetTypeInfo(metadata_import, parent_type_token));
}
if (type_extends != mdTokenNil)
{
extendsInfo = std::make_shared<TypeInfo>(GetTypeInfo(metadata_import, type_extends));
type_valueType =
extendsInfo->name == WStr("System.ValueType") || extendsInfo->name == WStr("System.Enum");
}
break;
case mdtTypeRef:
hr = metadata_import->GetTypeRefProps(token, &parent_token, type_name, kNameMaxSize, &type_name_len);
break;
case mdtTypeSpec:
{
PCCOR_SIGNATURE signature{};
ULONG signature_length{};
hr = metadata_import->GetTypeSpecFromToken(token, &signature, &signature_length);
if (FAILED(hr) || signature_length < 3)
{
return {};
}
if (signature[0] & ELEMENT_TYPE_GENERICINST)
{
mdToken type_token;
CorSigUncompressToken(&signature[2], &type_token);
const auto baseType = GetTypeInfo(metadata_import, type_token);
return {baseType.id, baseType.name, token,
token_type, baseType.extend_from, baseType.valueType,
baseType.isGeneric, baseType.parent_type, baseType.scopeToken};
}
}
break;
case mdtModuleRef:
metadata_import->GetModuleRefProps(token, type_name, kNameMaxSize, &type_name_len);
break;
case mdtMemberRef:
return GetFunctionInfo(metadata_import, token).type;
break;
case mdtMethodDef:
return GetFunctionInfo(metadata_import, token).type;
break;
}
if (FAILED(hr) || type_name_len == 0)
{
return {};
}
const auto type_name_string = WSTRING(type_name);
const auto generic_token_index = type_name_string.rfind(WStr("`"));
if (generic_token_index != std::string::npos)
{
const auto idxFromRight = type_name_string.length() - generic_token_index - 1;
type_isGeneric = idxFromRight == 1 || idxFromRight == 2;
}
return {token, type_name_string, mdTypeSpecNil, token_type, extendsInfo,
type_valueType, type_isGeneric, parentTypeInfo, parent_token};
}
mdAssemblyRef FindAssemblyRef(const ComPtr<IMetaDataAssemblyImport>& assembly_import, const WSTRING& assembly_name)
{
for (mdAssemblyRef assembly_ref : EnumAssemblyRefs(assembly_import))
{
if (GetReferencedAssemblyMetadata(assembly_import, assembly_ref).name == assembly_name)
{
return assembly_ref;
}
}
return mdAssemblyRefNil;
}
HRESULT GetCorLibAssemblyRef(const ComPtr<IMetaDataAssemblyEmit>& assembly_emit,
AssemblyProperty& corAssemblyProperty,
mdAssemblyRef* corlib_ref)
{
if (corAssemblyProperty.ppbPublicKey != nullptr)
{
// the corlib module is already loaded, use that information to create the
// assembly ref
Logger::Debug("Using existing corlib reference: ", corAssemblyProperty.szName);
return assembly_emit->DefineAssemblyRef(corAssemblyProperty.ppbPublicKey, corAssemblyProperty.pcbPublicKey,
corAssemblyProperty.szName.c_str(), &corAssemblyProperty.pMetaData,
NULL, 0, corAssemblyProperty.assemblyFlags, corlib_ref);
}
else
{
// Define an AssemblyRef to mscorlib, needed to create TypeRefs later
ASSEMBLYMETADATA metadata{};
metadata.usMajorVersion = 4;
metadata.usMinorVersion = 0;
metadata.usBuildNumber = 0;
metadata.usRevisionNumber = 0;
BYTE public_key[] = {0xB7, 0x7A, 0x5C, 0x56, 0x19, 0x34, 0xE0, 0x89};
return assembly_emit->DefineAssemblyRef(public_key, sizeof(public_key), WStr("mscorlib"), &metadata, NULL, 0,
corAssemblyProperty.assemblyFlags, corlib_ref);
}
}
// TypeSignature
std::tuple<unsigned, int> TypeSignature::GetElementTypeAndFlags() const
{
int typeFlags = 0;
unsigned elementType;
PCCOR_SIGNATURE pbCur = &pbBase[offset];
if (*pbCur == ELEMENT_TYPE_VOID)
{
elementType = ELEMENT_TYPE_VOID;
typeFlags |= TypeFlagVoid;
}
if (*pbCur == ELEMENT_TYPE_BYREF)
{
pbCur++;
typeFlags |= TypeFlagByRef;
}
elementType = *pbCur;
switch (*pbCur)
{
case ELEMENT_TYPE_BOOLEAN:
case ELEMENT_TYPE_CHAR:
case ELEMENT_TYPE_I1:
case ELEMENT_TYPE_U1:
case ELEMENT_TYPE_U2:
case ELEMENT_TYPE_I2:
case ELEMENT_TYPE_I4:
case ELEMENT_TYPE_U4:
case ELEMENT_TYPE_I8:
case ELEMENT_TYPE_U8:
case ELEMENT_TYPE_R4:
case ELEMENT_TYPE_R8:
case ELEMENT_TYPE_I:
case ELEMENT_TYPE_U:
case ELEMENT_TYPE_VALUETYPE:
case ELEMENT_TYPE_MVAR:
case ELEMENT_TYPE_VAR:
typeFlags |= TypeFlagBoxedType;
break;
case ELEMENT_TYPE_GENERICINST:
pbCur++;
if (*pbCur == ELEMENT_TYPE_VALUETYPE)
{
typeFlags |= TypeFlagBoxedType;
}
break;
default:
break;
}
return {elementType, typeFlags};
}
mdToken TypeSignature::GetTypeTok(ComPtr<IMetaDataEmit2>& pEmit, mdAssemblyRef corLibRef) const
{
mdToken token = mdTokenNil;
PCCOR_SIGNATURE pbCur = &pbBase[offset];
const PCCOR_SIGNATURE pStart = pbCur;
if (*pbCur == ELEMENT_TYPE_BYREF)
{
pbCur++;
}
switch (*pbCur)
{
case ELEMENT_TYPE_BOOLEAN:
pEmit->DefineTypeRefByName(corLibRef, SystemBoolean, &token);
break;
case ELEMENT_TYPE_CHAR:
pEmit->DefineTypeRefByName(corLibRef, SystemChar, &token);
break;
case ELEMENT_TYPE_I1:
pEmit->DefineTypeRefByName(corLibRef, SystemSByte, &token);
break;
case ELEMENT_TYPE_U1:
pEmit->DefineTypeRefByName(corLibRef, SystemByte, &token);
break;
case ELEMENT_TYPE_U2:
pEmit->DefineTypeRefByName(corLibRef, SystemUInt16, &token);
break;
case ELEMENT_TYPE_I2:
pEmit->DefineTypeRefByName(corLibRef, SystemInt16, &token);
break;
case ELEMENT_TYPE_I4:
pEmit->DefineTypeRefByName(corLibRef, SystemInt32, &token);
break;
case ELEMENT_TYPE_U4:
pEmit->DefineTypeRefByName(corLibRef, SystemUInt32, &token);
break;
case ELEMENT_TYPE_I8:
pEmit->DefineTypeRefByName(corLibRef, SystemInt64, &token);
break;
case ELEMENT_TYPE_U8:
pEmit->DefineTypeRefByName(corLibRef, SystemUInt64, &token);
break;
case ELEMENT_TYPE_R4:
pEmit->DefineTypeRefByName(corLibRef, SystemSingle, &token);
break;
case ELEMENT_TYPE_R8:
pEmit->DefineTypeRefByName(corLibRef, SystemDouble, &token);
break;
case ELEMENT_TYPE_I:
pEmit->DefineTypeRefByName(corLibRef, SystemIntPtr, &token);
break;
case ELEMENT_TYPE_U:
pEmit->DefineTypeRefByName(corLibRef, SystemUIntPtr, &token);
break;
case ELEMENT_TYPE_STRING:
pEmit->DefineTypeRefByName(corLibRef, SystemString, &token);
break;
case ELEMENT_TYPE_OBJECT:
pEmit->DefineTypeRefByName(corLibRef, SystemObject, &token);
break;
case ELEMENT_TYPE_CLASS:
pbCur++;
token = CorSigUncompressToken(pbCur);
break;
case ELEMENT_TYPE_VALUETYPE:
pbCur++;
token = CorSigUncompressToken(pbCur);
break;
case ELEMENT_TYPE_GENERICINST:
case ELEMENT_TYPE_SZARRAY:
case ELEMENT_TYPE_MVAR:
case ELEMENT_TYPE_VAR:
pEmit->GetTokenFromTypeSpec(pbCur, length - static_cast<ULONG>(pbCur - pStart), &token);
break;
default:
break;
}
return token;
}
WSTRING GetSigTypeTokName(PCCOR_SIGNATURE& pbCur, const ComPtr<IMetaDataImport2>& pImport)
{
WSTRING tokenName = EmptyWStr;
bool ref_flag = false;
if (*pbCur == ELEMENT_TYPE_BYREF)
{
pbCur++;
ref_flag = true;
}
bool pointer_flag = false;
if (*pbCur == ELEMENT_TYPE_PTR)
{
pbCur++;
pointer_flag = true;
}
switch (*pbCur)
{
case ELEMENT_TYPE_BOOLEAN:
tokenName = SystemBoolean;
pbCur++;
break;
case ELEMENT_TYPE_CHAR:
tokenName = SystemChar;
pbCur++;
break;
case ELEMENT_TYPE_I1:
tokenName = SystemSByte;
pbCur++;
break;
case ELEMENT_TYPE_U1:
tokenName = SystemByte;
pbCur++;
break;
case ELEMENT_TYPE_U2:
tokenName = SystemUInt16;
pbCur++;
break;
case ELEMENT_TYPE_I2:
tokenName = SystemInt16;
pbCur++;
break;
case ELEMENT_TYPE_I4:
tokenName = SystemInt32;
pbCur++;
break;
case ELEMENT_TYPE_U4:
tokenName = SystemUInt32;
pbCur++;
break;
case ELEMENT_TYPE_I8:
tokenName = SystemInt64;
pbCur++;
break;
case ELEMENT_TYPE_U8:
tokenName = SystemUInt64;
pbCur++;
break;
case ELEMENT_TYPE_R4:
tokenName = SystemSingle;
pbCur++;
break;
case ELEMENT_TYPE_R8:
tokenName = SystemDouble;
pbCur++;
break;
case ELEMENT_TYPE_I:
tokenName = SystemIntPtr;
pbCur++;
break;
case ELEMENT_TYPE_U:
tokenName = SystemUIntPtr;
pbCur++;
break;
case ELEMENT_TYPE_STRING:
tokenName = SystemString;
pbCur++;
break;
case ELEMENT_TYPE_OBJECT:
tokenName = SystemObject;
pbCur++;
break;
case ELEMENT_TYPE_CLASS:
case ELEMENT_TYPE_VALUETYPE:
{
pbCur++;
mdToken token;
pbCur += CorSigUncompressToken(pbCur, &token);
tokenName = GetTypeInfo(pImport, token).name;
break;
}
case ELEMENT_TYPE_SZARRAY:
{
pbCur++;
tokenName = GetSigTypeTokName(pbCur, pImport) + WStr("[]");
break;
}
case ELEMENT_TYPE_GENERICINST:
{
pbCur++;
tokenName = GetSigTypeTokName(pbCur, pImport);
tokenName += WStr("[");
ULONG num = 0;
pbCur += CorSigUncompressData(pbCur, &num);
for (ULONG i = 0; i < num; i++)
{
tokenName += GetSigTypeTokName(pbCur, pImport);
if (i != num - 1)
{
tokenName += WStr(",");
}
}
tokenName += WStr("]");
break;
}
case ELEMENT_TYPE_MVAR:
{
pbCur++;
ULONG num = 0;
pbCur += CorSigUncompressData(pbCur, &num);
tokenName = WStr("!!") + ToWSTRING(std::to_string(num));
break;
}
case ELEMENT_TYPE_VAR:
{
pbCur++;
ULONG num = 0;
pbCur += CorSigUncompressData(pbCur, &num);
tokenName = WStr("!") + ToWSTRING(std::to_string(num));
break;
}
default:
break;
}
if (ref_flag)
{
tokenName += WStr("&");
}
if (pointer_flag)
{
tokenName += WStr("*");
}
return tokenName;
}
WSTRING TypeSignature::GetTypeTokName(ComPtr<IMetaDataImport2>& pImport) const
{
PCCOR_SIGNATURE pbCur = &pbBase[offset];
return GetSigTypeTokName(pbCur, pImport);
}
ULONG TypeSignature::GetSignature(PCCOR_SIGNATURE& data) const
{
data = &pbBase[offset];
return length;
}
// FunctionMethodSignature
bool ParseByte(PCCOR_SIGNATURE& pbCur, PCCOR_SIGNATURE pbEnd, unsigned char* pbOut)
{
if (pbCur < pbEnd)
{
*pbOut = *pbCur;
pbCur++;
return true;
}
return false;
}
bool ParseNumber(PCCOR_SIGNATURE& pbCur, PCCOR_SIGNATURE pbEnd, unsigned* pOut)
{
// parse the variable length number format (0-4 bytes)
unsigned char b1 = 0, b2 = 0, b3 = 0, b4 = 0;
// at least one byte in the encoding, read that
if (!ParseByte(pbCur, pbEnd, &b1))
return false;
if (b1 == 0xff)
{
// special encoding of 'NULL'
// not sure what this means as a number, don't expect to see it except for
// string lengths which we don't encounter anyway so calling it an error
return false;
}
// early out on 1 byte encoding
if ((b1 & 0x80) == 0)
{
*pOut = (int)b1;
return true;
}
// now at least 2 bytes in the encoding, read 2nd byte
if (!ParseByte(pbCur, pbEnd, &b2))
return false;
// early out on 2 byte encoding
if ((b1 & 0x40) == 0)
{
*pOut = (((b1 & 0x3f) << 8) | b2);
return true;
}
// must be a 4 byte encoding
if ((b1 & 0x20) != 0)
{
// 4 byte encoding has this bit clear -- error if not
return false;
}
if (!ParseByte(pbCur, pbEnd, &b3))
return false;
if (!ParseByte(pbCur, pbEnd, &b4))
return false;
*pOut = ((b1 & 0x1f) << 24) | (b2 << 16) | (b3 << 8) | b4;
return true;
}
bool ParseTypeDefOrRefEncoded(PCCOR_SIGNATURE& pbCur,
PCCOR_SIGNATURE pbEnd,
unsigned char* pIndexTypeOut,
unsigned* pIndexOut)
{
// parse an encoded typedef or typeref
unsigned encoded = 0;
if (!ParseNumber(pbCur, pbEnd, &encoded))
return false;
*pIndexTypeOut = (unsigned char)(encoded & 0x3);
*pIndexOut = (encoded >> 2);
return true;
}
/* we don't support
PTR CustomMod* VOID
PTR CustomMod* Type
FNPTR MethodDefSig
FNPTR MethodRefSig
ARRAY Type ArrayShape
SZARRAY CustomMod+ Type (but we do support SZARRAY Type)
*/
bool ParseType(PCCOR_SIGNATURE& pbCur, PCCOR_SIGNATURE pbEnd)
{
/*
Type ::= ( BOOLEAN | CHAR | I1 | U1 | U2 | U2 | I4 | U4 | I8 | U8 | R4 | R8 |
I | U | | VALUETYPE TypeDefOrRefEncoded | CLASS TypeDefOrRefEncoded | STRING
| OBJECT
| PTR CustomMod* VOID
| PTR CustomMod* Type
| FNPTR MethodDefSig
| FNPTR MethodRefSig
| ARRAY Type ArrayShape
| SZARRAY CustomMod* Type
| GENERICINST (CLASS | VALUETYPE) TypeDefOrRefEncoded GenArgCount Type *
| VAR Number
| MVAR Number
*/
unsigned char elem_type;
unsigned index;
unsigned number;
unsigned char indexType;
if (!ParseByte(pbCur, pbEnd, &elem_type))
return false;
switch (elem_type)
{
case ELEMENT_TYPE_BOOLEAN:
case ELEMENT_TYPE_CHAR:
case ELEMENT_TYPE_I1:
case ELEMENT_TYPE_U1:
case ELEMENT_TYPE_U2:
case ELEMENT_TYPE_I2:
case ELEMENT_TYPE_I4:
case ELEMENT_TYPE_U4:
case ELEMENT_TYPE_I8:
case ELEMENT_TYPE_U8:
case ELEMENT_TYPE_R4:
case ELEMENT_TYPE_R8:
case ELEMENT_TYPE_I:
case ELEMENT_TYPE_U:
case ELEMENT_TYPE_STRING:
case ELEMENT_TYPE_OBJECT:
// simple types
break;
case ELEMENT_TYPE_PTR:
return false;
case ELEMENT_TYPE_CLASS:
// CLASS TypeDefOrRefEncoded
if (!ParseTypeDefOrRefEncoded(pbCur, pbEnd, &indexType, &index))
return false;
break;
case ELEMENT_TYPE_VALUETYPE:
// VALUETYPE TypeDefOrRefEncoded
if (!ParseTypeDefOrRefEncoded(pbCur, pbEnd, &indexType, &index))
return false;
break;
case ELEMENT_TYPE_FNPTR:
// FNPTR MethodDefSig
// FNPTR MethodRefSig
return false;
case ELEMENT_TYPE_ARRAY:
// ARRAY Type ArrayShape
return false;
case ELEMENT_TYPE_SZARRAY:
// SZARRAY Type
if (*pbCur == ELEMENT_TYPE_CMOD_OPT || *pbCur == ELEMENT_TYPE_CMOD_REQD)
return false;
if (!ParseType(pbCur, pbEnd))
return false;
break;
case ELEMENT_TYPE_GENERICINST:
// GENERICINST (CLASS | VALUETYPE) TypeDefOrRefEncoded GenArgCount Type *
if (!ParseByte(pbCur, pbEnd, &elem_type))
return false;
if (elem_type != ELEMENT_TYPE_CLASS && elem_type != ELEMENT_TYPE_VALUETYPE)
return false;
if (!ParseTypeDefOrRefEncoded(pbCur, pbEnd, &indexType, &index))
return false;
if (!ParseNumber(pbCur, pbEnd, &number))
return false;
for (unsigned i = 0; i < number; i++)
{
if (!ParseType(pbCur, pbEnd))
return false;
}
break;
case ELEMENT_TYPE_VAR:
// VAR Number
if (!ParseNumber(pbCur, pbEnd, &number))
return false;
break;
case ELEMENT_TYPE_MVAR:
// MVAR Number
if (!ParseNumber(pbCur, pbEnd, &number))
return false;
break;
}
return true;
}
// Param ::= CustomMod* ( TYPEDBYREF | [BYREF] Type )
// CustomMod* TYPEDBYREF we don't support
bool ParseParamOrLocal(PCCOR_SIGNATURE& pbCur, PCCOR_SIGNATURE pbEnd)
{
if (*pbCur == ELEMENT_TYPE_CMOD_OPT || *pbCur == ELEMENT_TYPE_CMOD_REQD)
{
return false;
}
if (pbCur >= pbEnd)
return false;
if (*pbCur == ELEMENT_TYPE_TYPEDBYREF)
return false;
if (*pbCur == ELEMENT_TYPE_BYREF)
pbCur++;
if (*pbCur == ELEMENT_TYPE_PTR)
pbCur++;
return ParseType(pbCur, pbEnd);
}
// RetType ::= CustomMod* ( VOID | TYPEDBYREF | [BYREF] Type )
// CustomMod* TYPEDBYREF we don't support
bool ParseRetType(PCCOR_SIGNATURE& pbCur, PCCOR_SIGNATURE pbEnd)
{
if (*pbCur == ELEMENT_TYPE_CMOD_OPT || *pbCur == ELEMENT_TYPE_CMOD_REQD)
return false;
if (pbCur >= pbEnd)
return false;
if (*pbCur == ELEMENT_TYPE_TYPEDBYREF)
return false;
if (*pbCur == ELEMENT_TYPE_VOID)
{
pbCur++;
return true;
}
if (*pbCur == ELEMENT_TYPE_BYREF)
pbCur++;
return ParseType(pbCur, pbEnd);
}
HRESULT FunctionMethodSignature::TryParse()
{
PCCOR_SIGNATURE pbCur = pbBase;
PCCOR_SIGNATURE pbEnd = pbBase + len;
unsigned char elem_type;
IfFalseRetFAIL(ParseByte(pbCur, pbEnd, &elem_type));
if (elem_type & IMAGE_CEE_CS_CALLCONV_GENERIC)
{
unsigned gen_param_count;
IfFalseRetFAIL(ParseNumber(pbCur, pbEnd, &gen_param_count));
numberOfTypeArguments = gen_param_count;
}
unsigned param_count;
IfFalseRetFAIL(ParseNumber(pbCur, pbEnd, ¶m_count));
numberOfArguments = param_count;
const PCCOR_SIGNATURE pbRet = pbCur;
IfFalseRetFAIL(ParseRetType(pbCur, pbEnd));
returnValue.pbBase = pbBase;
returnValue.length = (ULONG)(pbCur - pbRet);
returnValue.offset = (ULONG)(pbCur - pbBase - returnValue.length);
auto fEncounteredSentinal = false;
for (unsigned i = 0; i < param_count; i++)
{
if (pbCur >= pbEnd)
return E_FAIL;
if (*pbCur == ELEMENT_TYPE_SENTINEL)
{
if (fEncounteredSentinal)
return E_FAIL;
fEncounteredSentinal = true;
pbCur++;
}
const PCCOR_SIGNATURE pbParam = pbCur;
IfFalseRetFAIL(ParseParamOrLocal(pbCur, pbEnd));
TypeSignature argument{};
argument.pbBase = pbBase;
argument.length = (ULONG)(pbCur - pbParam);
argument.offset = (ULONG)(pbCur - pbBase - argument.length);
params.push_back(argument);
}
return S_OK;
}
bool FindTypeDefByName(const trace::WSTRING instrumentationTargetMethodTypeName,
const trace::WSTRING assemblyName,
const ComPtr<IMetaDataImport2>& metadata_import,
mdTypeDef& typeDef)
{
mdTypeDef parentTypeDef = mdTypeDefNil;
auto nameParts = Split(instrumentationTargetMethodTypeName, '+');
auto instrumentedMethodTypeName = instrumentationTargetMethodTypeName;
if (nameParts.size() == 2)
{
// We're instrumenting a nested class, find the parent first
auto hr = metadata_import->FindTypeDefByName(nameParts[0].c_str(), mdTokenNil, &parentTypeDef);
if (FAILED(hr))
{
// This can happen between .NET framework and .NET core, not all apis are
// available in both. Eg: WinHttpHandler, CurlHandler, and some methods in
// System.Data
Logger::Debug("Can't load the parent TypeDef: ", nameParts[0], " for nested class: ",
instrumentationTargetMethodTypeName, ", Module: ", assemblyName);
return false;
}
instrumentedMethodTypeName = nameParts[1];
}
else if (nameParts.size() > 2)
{
Logger::Warn("Invalid TypeDef-only one layer of nested classes are supported: ",
instrumentationTargetMethodTypeName, ", Module: ", assemblyName);
return false;
}
// Find the type we're instrumenting
auto hr = metadata_import->FindTypeDefByName(instrumentedMethodTypeName.c_str(), parentTypeDef, &typeDef);
if (FAILED(hr))
{
// This can happen between .NET framework and .NET core, not all apis are
// available in both. Eg: WinHttpHandler, CurlHandler, and some methods in
// System.Data
Logger::Debug("Can't load the TypeDef for: ", instrumentedMethodTypeName, ", Module: ", assemblyName);
return false;
}