This repository has been archived by the owner on Jan 23, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2.7k
/
Copy pathstubmgr.cpp
2590 lines (2116 loc) · 74 KB
/
stubmgr.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.
// See the LICENSE file in the project root for more information.
#include "common.h"
#include "stubmgr.h"
#include "virtualcallstub.h"
#include "dllimportcallback.h"
#include "stubhelpers.h"
#include "asmconstants.h"
#ifdef FEATURE_COMINTEROP
#include "olecontexthelpers.h"
#endif
#ifdef LOGGING
const char *GetTType( TraceType tt)
{
LIMITED_METHOD_CONTRACT;
switch( tt )
{
case TRACE_ENTRY_STUB: return "TRACE_ENTRY_STUB";
case TRACE_STUB: return "TRACE_STUB";
case TRACE_UNMANAGED: return "TRACE_UNMANAGED";
case TRACE_MANAGED: return "TRACE_MANAGED";
case TRACE_FRAME_PUSH: return "TRACE_FRAME_PUSH";
case TRACE_MGR_PUSH: return "TRACE_MGR_PUSH";
case TRACE_OTHER: return "TRACE_OTHER";
case TRACE_UNJITTED_METHOD: return "TRACE_UNJITTED_METHOD";
}
return "TRACE_REALLY_WACKED";
}
void LogTraceDestination(const char * szHint, PCODE stubAddr, TraceDestination * pTrace)
{
LIMITED_METHOD_CONTRACT;
if (pTrace->GetTraceType() == TRACE_UNJITTED_METHOD)
{
MethodDesc * md = pTrace->GetMethodDesc();
LOG((LF_CORDB, LL_INFO10000, "'%s' yields '%s' to method 0x%p for input 0x%p.\n",
szHint, GetTType(pTrace->GetTraceType()),
md, stubAddr));
}
else
{
LOG((LF_CORDB, LL_INFO10000, "'%s' yields '%s' to address 0x%p for input 0x%p.\n",
szHint, GetTType(pTrace->GetTraceType()),
pTrace->GetAddress(), stubAddr));
}
}
#endif
#ifdef _DEBUG
// Get a string representation of this TraceDestination
// Uses the supplied buffer to store the memory (or may return a string literal).
const WCHAR * TraceDestination::DbgToString(SString & buffer)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
const WCHAR * pValue = W("unknown");
#ifndef DACCESS_COMPILE
if (!StubManager::IsStubLoggingEnabled())
{
return W("<unavailable while native-debugging>");
}
// Now that we know we're not interop-debugging, we can safely call new.
SUPPRESS_ALLOCATION_ASSERTS_IN_THIS_SCOPE;
FAULT_NOT_FATAL();
EX_TRY
{
switch(this->type)
{
case TRACE_ENTRY_STUB:
buffer.Printf("TRACE_ENTRY_STUB(addr=0x%p)", GetAddress());
pValue = buffer.GetUnicode();
break;
case TRACE_STUB:
buffer.Printf("TRACE_STUB(addr=0x%p)", GetAddress());
pValue = buffer.GetUnicode();
break;
case TRACE_UNMANAGED:
buffer.Printf("TRACE_UNMANAGED(addr=0x%p)", GetAddress());
pValue = buffer.GetUnicode();
break;
case TRACE_MANAGED:
buffer.Printf("TRACE_MANAGED(addr=0x%p)", GetAddress());
pValue = buffer.GetUnicode();
break;
case TRACE_UNJITTED_METHOD:
{
MethodDesc * md = this->GetMethodDesc();
buffer.Printf("TRACE_UNJITTED_METHOD(md=0x%p, %s::%s)", md, md->m_pszDebugClassName, md->m_pszDebugMethodName);
pValue = buffer.GetUnicode();
}
break;
case TRACE_FRAME_PUSH:
buffer.Printf("TRACE_FRAME_PUSH(addr=0x%p)", GetAddress());
pValue = buffer.GetUnicode();
break;
case TRACE_MGR_PUSH:
buffer.Printf("TRACE_MGR_PUSH(addr=0x%p, sm=%s)", GetAddress(), this->GetStubManager()->DbgGetName());
pValue = buffer.GetUnicode();
break;
case TRACE_OTHER:
pValue = W("TRACE_OTHER");
break;
}
}
EX_CATCH
{
pValue = W("(OOM while printing TD)");
}
EX_END_CATCH(SwallowAllExceptions);
#endif
return pValue;
}
#endif
void TraceDestination::InitForUnjittedMethod(MethodDesc * pDesc)
{
CONTRACTL
{
GC_NOTRIGGER;
NOTHROW;
MODE_ANY;
PRECONDITION(CheckPointer(pDesc));
}
CONTRACTL_END;
_ASSERTE(pDesc->SanityCheck());
{
// If this is a wrapper stub, then find the real method that it will go to and patch that.
// This is more than just a convenience - converted wrapper MD to real MD is required for correct behavior.
// Wrapper MDs look like unjitted MethodDescs. So when the debugger patches one,
// it won't actually bind + apply the patch (it'll wait for the jit-complete instead).
// But if the wrapper MD is for prejitted code, then we'll never get the Jit-complete.
// Thus it'll miss the patch completely.
if (pDesc->IsWrapperStub())
{
MethodDesc * pNewDesc = NULL;
FAULT_NOT_FATAL();
#ifndef DACCESS_COMPILE
EX_TRY
{
pNewDesc = pDesc->GetExistingWrappedMethodDesc();
}
EX_CATCH
{
// In case of an error, we'll just stick w/ the original method desc.
} EX_END_CATCH(SwallowAllExceptions)
#else
// @todo - DAC needs this too, but the method is currently not DACized.
// However, we don't throw here b/c the error may not be fatal.
// DacNotImpl();
#endif
if (pNewDesc != NULL)
{
pDesc = pNewDesc;
LOG((LF_CORDB, LL_INFO10000, "TD::UnjittedMethod: wrapper md: %p --> %p", pDesc, pNewDesc));
}
}
}
this->type = TRACE_UNJITTED_METHOD;
this->pDesc = pDesc;
this->stubManager = NULL;
}
// Initialize statics.
#ifdef _DEBUG
SString * StubManager::s_pDbgStubManagerLog = NULL;
CrstStatic StubManager::s_DbgLogCrst;
#endif
SPTR_IMPL(StubManager, StubManager, g_pFirstManager);
CrstStatic StubManager::s_StubManagerListCrst;
//-----------------------------------------------------------
// For perf reasons, the stub managers are now kept in a two
// tier system: all stub managers but the VirtualStubManagers
// are in the first tier. A VirtualStubManagerManager takes
// care of all VirtualStubManagers, and is iterated last of
// all. It does a smarter job of looking up the owning
// manager for virtual stubs, checking the current and shared
// appdomains before checking the remaining managers.
//
// Thus, this iterator will run the regular list until it
// hits the end, then it will check the VSMM, then it will
// end.
//-----------------------------------------------------------
class StubManagerIterator
{
public:
StubManagerIterator();
~StubManagerIterator();
void Reset();
BOOL Next();
PTR_StubManager Current();
protected:
enum SMI_State
{
SMI_START,
SMI_NORMAL,
SMI_VIRTUALCALLSTUBMANAGER,
SMI_END
};
SMI_State m_state;
PTR_StubManager m_pCurMgr;
SimpleReadLockHolder m_lh;
};
//-----------------------------------------------------------
// Ctor
//-----------------------------------------------------------
StubManagerIterator::StubManagerIterator()
{
WRAPPER_NO_CONTRACT;
SUPPORTS_DAC;
Reset();
}
void StubManagerIterator::Reset()
{
LIMITED_METHOD_DAC_CONTRACT;
m_pCurMgr = NULL;
m_state = SMI_START;
}
//-----------------------------------------------------------
// Ctor
//-----------------------------------------------------------
StubManagerIterator::~StubManagerIterator()
{
LIMITED_METHOD_DAC_CONTRACT;
}
//-----------------------------------------------------------
// Move to the next element. Iterators are created at
// start-1, so must call Next before using Current
//-----------------------------------------------------------
BOOL StubManagerIterator::Next()
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
#ifndef DACCESS_COMPILE
CAN_TAKE_LOCK; // because of m_lh.Assign()
#else
CANNOT_TAKE_LOCK;
#endif
}
CONTRACTL_END;
SUPPORTS_DAC;
do {
if (m_state == SMI_START) {
m_state = SMI_NORMAL;
m_pCurMgr = StubManager::g_pFirstManager;
}
else if (m_state == SMI_NORMAL) {
if (m_pCurMgr != NULL) {
m_pCurMgr = m_pCurMgr->m_pNextManager;
}
else {
// If we've reached the end of the regular list of stub managers, then we
// set the VirtualCallStubManagerManager is the current item (effectively
// forcing it to always be the last manager checked).
m_state = SMI_VIRTUALCALLSTUBMANAGER;
VirtualCallStubManagerManager *pVCSMMgr = VirtualCallStubManagerManager::GlobalManager();
m_pCurMgr = PTR_StubManager(pVCSMMgr);
#ifndef DACCESS_COMPILE
m_lh.Assign(&pVCSMMgr->m_RWLock);
#endif
}
}
else if (m_state == SMI_VIRTUALCALLSTUBMANAGER) {
m_state = SMI_END;
m_pCurMgr = NULL;
#ifndef DACCESS_COMPILE
m_lh.Clear();
#endif
}
} while (m_state != SMI_END && m_pCurMgr == NULL);
CONSISTENCY_CHECK(m_state == SMI_END || m_pCurMgr != NULL);
return (m_state != SMI_END);
}
//-----------------------------------------------------------
// Get the current contents of the iterator
//-----------------------------------------------------------
PTR_StubManager StubManagerIterator::Current()
{
LIMITED_METHOD_DAC_CONTRACT;
CONSISTENCY_CHECK(m_state != SMI_START);
CONSISTENCY_CHECK(m_state != SMI_END);
CONSISTENCY_CHECK(CheckPointer(m_pCurMgr));
return m_pCurMgr;
}
#ifndef DACCESS_COMPILE
//-----------------------------------------------------------
//-----------------------------------------------------------
StubManager::StubManager()
: m_pNextManager(NULL)
{
LIMITED_METHOD_CONTRACT;
}
//-----------------------------------------------------------
//-----------------------------------------------------------
StubManager::~StubManager()
{
CONTRACTL {
NOTHROW;
GC_NOTRIGGER;
CAN_TAKE_LOCK; // StubManager::UnlinkStubManager uses a crst
PRECONDITION(CheckPointer(this));
} CONTRACTL_END;
UnlinkStubManager(this);
}
#endif // #ifndef DACCESS_COMPILE
#ifdef _DEBUG_IMPL
//-----------------------------------------------------------
// Verify that the stub is owned by the given stub manager
// and no other stub manager. If a stub is claimed by multiple managers,
// then the wrong manager may claim ownership and improperly trace the stub.
//-----------------------------------------------------------
BOOL StubManager::IsSingleOwner(PCODE stubAddress, StubManager * pOwner)
{
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_FORBID_FAULT;
STATIC_CONTRACT_CAN_TAKE_LOCK; // courtesy StubManagerIterator
// ensure this stubmanager owns it.
_ASSERTE(pOwner != NULL);
// ensure nobody else does.
bool ownerFound = false;
int count = 0;
StubManagerIterator it;
while (it.Next())
{
// Callers would have iterated till pOwner.
if (!ownerFound && it.Current() != pOwner)
continue;
if (it.Current() == pOwner)
ownerFound = true;
if (it.Current()->CheckIsStub_Worker(stubAddress))
{
// If you hit this assert, you can tell what 2 stub managers are conflicting by inspecting their vtable.
CONSISTENCY_CHECK_MSGF((it.Current() == pOwner), ("Stub at 0x%p is owner by multiple managers (0x%p, 0x%p)",
(void*) stubAddress, pOwner, it.Current()));
count++;
}
else
{
_ASSERTE(it.Current() != pOwner);
}
}
_ASSERTE(ownerFound);
// We expect pOwner to be the only one to own this stub.
return (count == 1);
}
#endif
//-----------------------------------------------------------
//-----------------------------------------------------------
BOOL StubManager::CheckIsStub_Worker(PCODE stubStartAddress)
{
CONTRACTL
{
NOTHROW;
CAN_TAKE_LOCK; // CheckIsStub_Internal can enter SimpleRWLock
GC_NOTRIGGER;
}
CONTRACTL_END;
SUPPORTS_DAC;
// @todo - consider having a single check for null right up front.
// Though this may cover bugs where stub-managers don't handle bad addresses.
// And someone could just as easily pass (0x01) as NULL.
if (stubStartAddress == NULL)
{
return FALSE;
}
struct Param
{
BOOL fIsStub;
StubManager *pThis;
TADDR stubStartAddress;
} param;
param.fIsStub = FALSE;
param.pThis = this;
param.stubStartAddress = stubStartAddress;
// This may be called from DAC, and DAC + non-DAC have very different
// exception handling.
#ifdef DACCESS_COMPILE
PAL_TRY(Param *, pParam, ¶m)
#else
Param *pParam = ¶m;
EX_TRY
#endif
{
SUPPORTS_DAC;
#ifndef DACCESS_COMPILE
// Use CheckIsStub_Internal may AV. That's ok.
AVInRuntimeImplOkayHolder AVOkay;
#endif
// Make a Polymorphic call to derived stub manager.
// Try to see if this address is for a stub. If the address is
// completely bogus, then this might fault, so we protect it
// with SEH.
pParam->fIsStub = pParam->pThis->CheckIsStub_Internal(pParam->stubStartAddress);
}
#ifdef DACCESS_COMPILE
PAL_EXCEPT(EXCEPTION_EXECUTE_HANDLER)
#else
EX_CATCH
#endif
{
LOG((LF_CORDB, LL_INFO10000, "D::GASTSI: exception indicated addr is bad.\n"));
param.fIsStub = FALSE;
}
#ifdef DACCESS_COMPILE
PAL_ENDTRY
#else
EX_END_CATCH(SwallowAllExceptions);
#endif
return param.fIsStub;
}
//-----------------------------------------------------------
// stubAddress may be an invalid address.
//-----------------------------------------------------------
PTR_StubManager StubManager::FindStubManager(PCODE stubAddress)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
CAN_TAKE_LOCK; // courtesy StubManagerIterator
}
CONTRACTL_END;
SUPPORTS_DAC;
StubManagerIterator it;
while (it.Next())
{
if (it.Current()->CheckIsStub_Worker(stubAddress))
{
_ASSERTE_IMPL(IsSingleOwner(stubAddress, it.Current()));
return it.Current();
}
}
return NULL;
}
//-----------------------------------------------------------
// Given an address, figure out a TraceDestination describing where
// the instructions at that address will eventually transfer execution to.
//-----------------------------------------------------------
BOOL StubManager::TraceStub(PCODE stubStartAddress, TraceDestination *trace)
{
WRAPPER_NO_CONTRACT;
StubManagerIterator it;
while (it.Next())
{
StubManager * pCurrent = it.Current();
if (pCurrent->CheckIsStub_Worker(stubStartAddress))
{
LOG((LF_CORDB, LL_INFO10000,
"StubManager::TraceStub: addr 0x%p claimed by mgr "
"0x%p.\n", stubStartAddress, pCurrent));
_ASSERTE_IMPL(IsSingleOwner(stubStartAddress, pCurrent));
BOOL fValid = pCurrent->DoTraceStub(stubStartAddress, trace);
#ifdef _DEBUG
if (IsStubLoggingEnabled())
{
DbgWriteLog("Doing TraceStub for Address 0x%p, claimed by '%s' (0x%p)\n", stubStartAddress, pCurrent->DbgGetName(), pCurrent);
if (fValid)
{
SUPPRESS_ALLOCATION_ASSERTS_IN_THIS_SCOPE;
FAULT_NOT_FATAL();
SString buffer;
DbgWriteLog(" td=%S\n", trace->DbgToString(buffer));
}
else
{
DbgWriteLog(" stubmanager returned false. Does not expect to call managed code\n");
}
} // logging
#endif
return fValid;
}
}
if (ExecutionManager::IsManagedCode(stubStartAddress))
{
trace->InitForManaged(stubStartAddress);
#ifdef _DEBUG
DbgWriteLog("Doing TraceStub for Address 0x%p is jitted code claimed by codemanager\n", stubStartAddress);
#endif
LOG((LF_CORDB, LL_INFO10000,
"StubManager::TraceStub: addr 0x%p is managed code\n",
stubStartAddress));
return TRUE;
}
LOG((LF_CORDB, LL_INFO10000,
"StubManager::TraceStub: addr 0x%p unknown. TRACE_OTHER...\n",
stubStartAddress));
#ifdef _DEBUG
DbgWriteLog("Doing TraceStub for Address 0x%p is unknown!!!\n", stubStartAddress);
#endif
trace->InitForOther(stubStartAddress);
return FALSE;
}
//-----------------------------------------------------------
//-----------------------------------------------------------
BOOL StubManager::FollowTrace(TraceDestination *trace)
{
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_FORBID_FAULT;
while (trace->GetTraceType() == TRACE_STUB)
{
LOG((LF_CORDB, LL_INFO10000,
"StubManager::FollowTrace: TRACE_STUB for 0x%p\n",
trace->GetAddress()));
if (!TraceStub(trace->GetAddress(), trace))
{
//
// No stub manager claimed it - it must be an EE helper or something.
//
trace->InitForOther(trace->GetAddress());
}
}
LOG_TRACE_DESTINATION(trace, NULL, "StubManager::FollowTrace");
return trace->GetTraceType() != TRACE_OTHER;
}
#ifndef DACCESS_COMPILE
//-----------------------------------------------------------
//-----------------------------------------------------------
void StubManager::AddStubManager(StubManager *mgr)
{
WRAPPER_NO_CONTRACT;
CONSISTENCY_CHECK(CheckPointer(g_pFirstManager, NULL_OK));
CONSISTENCY_CHECK(CheckPointer(mgr));
GCX_COOP_NO_THREAD_BROKEN();
CrstHolder ch(&s_StubManagerListCrst);
if (g_pFirstManager == NULL)
{
g_pFirstManager = mgr;
}
else
{
mgr->m_pNextManager = g_pFirstManager;
g_pFirstManager = mgr;
}
LOG((LF_CORDB, LL_EVERYTHING, "StubManager::AddStubManager - 0x%p (vptr %x%p)\n", mgr, (*(PVOID*)mgr)));
}
//-----------------------------------------------------------
// NOTE: The runtime MUST be suspended to use this in a
// truly safe manner.
//-----------------------------------------------------------
void StubManager::UnlinkStubManager(StubManager *mgr)
{
STATIC_CONTRACT_GC_NOTRIGGER;
STATIC_CONTRACT_NOTHROW;
STATIC_CONTRACT_CAN_TAKE_LOCK;
CONSISTENCY_CHECK(CheckPointer(g_pFirstManager, NULL_OK));
CONSISTENCY_CHECK(CheckPointer(mgr));
CrstHolder ch(&s_StubManagerListCrst);
StubManager **m = &g_pFirstManager;
while (*m != NULL)
{
if (*m == mgr)
{
*m = (*m)->m_pNextManager;
return;
}
m = &(*m)->m_pNextManager;
}
}
#endif // #ifndef DACCESS_COMPILE
#ifdef DACCESS_COMPILE
//-----------------------------------------------------------
//-----------------------------------------------------------
void
StubManager::EnumMemoryRegions(CLRDataEnumMemoryFlags flags)
{
SUPPORTS_DAC;
// Report the global list head.
DacEnumMemoryRegion(DacGlobalBase() +
g_dacGlobals.StubManager__g_pFirstManager,
sizeof(TADDR));
//
// Report the list contents.
//
StubManagerIterator it;
while (it.Next())
{
it.Current()->DoEnumMemoryRegions(flags);
}
}
//-----------------------------------------------------------
//-----------------------------------------------------------
void
StubManager::DoEnumMemoryRegions(CLRDataEnumMemoryFlags flags)
{
SUPPORTS_DAC;
DAC_ENUM_VTHIS();
EMEM_OUT(("MEM: %p StubManager base\n", dac_cast<TADDR>(this)));
}
#endif // #ifdef DACCESS_COMPILE
//-----------------------------------------------------------
// Initialize the global stub manager service.
//-----------------------------------------------------------
void StubManager::InitializeStubManagers()
{
#if !defined(DACCESS_COMPILE)
#if defined(_DEBUG)
s_DbgLogCrst.Init(CrstDebuggerHeapLock, (CrstFlags)(CRST_UNSAFE_ANYMODE | CRST_DEBUGGER_THREAD | CRST_TAKEN_DURING_SHUTDOWN));
#endif
s_StubManagerListCrst.Init(CrstDebuggerHeapLock, (CrstFlags)(CRST_UNSAFE_ANYMODE | CRST_DEBUGGER_THREAD | CRST_TAKEN_DURING_SHUTDOWN));
#endif // !DACCESS_COMPILE
}
//-----------------------------------------------------------
// Terminate the global stub manager service.
//-----------------------------------------------------------
void StubManager::TerminateStubManagers()
{
#if !defined(DACCESS_COMPILE)
#if defined(_DEBUG)
DbgFinishLog();
s_DbgLogCrst.Destroy();
#endif
s_StubManagerListCrst.Destroy();
#endif // !DACCESS_COMPILE
}
#ifdef _DEBUG
//-----------------------------------------------------------
// Should stub-manager logging be enabled?
//-----------------------------------------------------------
bool StubManager::IsStubLoggingEnabled()
{
// Our current logging impl uses SString, which uses new(), which can't be called
// on the helper thread. (B/c it may deadlock. See SUPPRESS_ALLOCATION_ASSERTS_IN_THIS_SCOPE)
// We avoid this by just not logging when native-debugging.
if (IsDebuggerPresent())
{
return false;
}
return true;
}
//-----------------------------------------------------------
// Call to reset the log. This is used at the start of a new step-operation.
// pThread is the managed thread doing the stepping.
// It should either be the current thread or the helper thread.
//-----------------------------------------------------------
void StubManager::DbgBeginLog(TADDR addrCallInstruction, TADDR addrCallTarget)
{
#ifndef DACCESS_COMPILE
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
// We can't call new() if another thread holds the heap lock and is then suspended by
// an interop-debugging. Since this is debug-only logging code, we'll just skip
// it under those cases.
if (!IsStubLoggingEnabled())
{
return;
}
// Now that we know we're not interop-debugging, we can safely call new.
SUPPRESS_ALLOCATION_ASSERTS_IN_THIS_SCOPE;
FAULT_NOT_FATAL();
{
CrstHolder ch(&s_DbgLogCrst);
EX_TRY
{
if (s_pDbgStubManagerLog == NULL)
{
s_pDbgStubManagerLog = new SString();
}
s_pDbgStubManagerLog->Clear();
}
EX_CATCH
{
DbgFinishLog();
}
EX_END_CATCH(SwallowAllExceptions);
}
DbgWriteLog("Beginning Step-in. IP after Call instruction is at 0x%p, call target is at 0x%p\n",
addrCallInstruction, addrCallTarget);
#endif
}
//-----------------------------------------------------------
// Finish logging for this thread.
// pThread is the managed thread doing the stepping.
// It should either be the current thread or the helper thread.
//-----------------------------------------------------------
void StubManager::DbgFinishLog()
{
#ifndef DACCESS_COMPILE
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
CrstHolder ch(&s_DbgLogCrst);
// Since this is just a tool for debugging, we don't care if we call new.
SUPPRESS_ALLOCATION_ASSERTS_IN_THIS_SCOPE;
FAULT_NOT_FATAL();
delete s_pDbgStubManagerLog;
s_pDbgStubManagerLog = NULL;
#endif
}
//-----------------------------------------------------------
// Write an arbitrary string to the log.
//-----------------------------------------------------------
void StubManager::DbgWriteLog(const CHAR *format, ...)
{
#ifndef DACCESS_COMPILE
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END;
if (!IsStubLoggingEnabled())
{
return;
}
// Since this is just a tool for debugging, we don't care if we call new.
SUPPRESS_ALLOCATION_ASSERTS_IN_THIS_SCOPE;
FAULT_NOT_FATAL();
CrstHolder ch(&s_DbgLogCrst);
if (s_pDbgStubManagerLog == NULL)
{
return;
}
// Suppress asserts about lossy encoding conversion in SString::Printf
CHECK chk;
BOOL fEntered = chk.EnterAssert();
EX_TRY
{
va_list args;
va_start(args, format);
s_pDbgStubManagerLog->AppendVPrintf(format, args);
va_end(args);
}
EX_CATCH
{
}
EX_END_CATCH(SwallowAllExceptions);
if (fEntered) chk.LeaveAssert();
#endif
}
//-----------------------------------------------------------
// Get the log as a string.
//-----------------------------------------------------------
void StubManager::DbgGetLog(SString * pStringOut)
{
#ifndef DACCESS_COMPILE
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
PRECONDITION(CheckPointer(pStringOut));
}
CONTRACTL_END;
if (!IsStubLoggingEnabled())
{
return;
}
// Since this is just a tool for debugging, we don't care if we call new.
SUPPRESS_ALLOCATION_ASSERTS_IN_THIS_SCOPE;
FAULT_NOT_FATAL();
CrstHolder ch(&s_DbgLogCrst);
if (s_pDbgStubManagerLog == NULL)
{
return;
}
EX_TRY
{
pStringOut->Set(*s_pDbgStubManagerLog);
}
EX_CATCH
{
}
EX_END_CATCH(SwallowAllExceptions);
#endif
}
#endif // _DEBUG
extern "C" void STDCALL ThePreStubPatchLabel(void);
//-----------------------------------------------------------
//-----------------------------------------------------------
BOOL ThePreStubManager::DoTraceStub(PCODE stubStartAddress, TraceDestination *trace)
{
CONTRACTL
{
NOTHROW;
GC_NOTRIGGER;
MODE_ANY;
PRECONDITION(stubStartAddress != NULL);
PRECONDITION(CheckPointer(trace));
}
CONTRACTL_END;
//
// We cannot tell where the stub will end up
// until after the prestub worker has been run.
//
trace->InitForFramePush(GetEEFuncEntryPoint(ThePreStubPatchLabel));
return TRUE;
}
//-----------------------------------------------------------
BOOL ThePreStubManager::CheckIsStub_Internal(PCODE stubStartAddress)
{
LIMITED_METHOD_DAC_CONTRACT;
return stubStartAddress == GetPreStubEntryPoint();
}
// -------------------------------------------------------
// Stub manager functions & globals
// -------------------------------------------------------
SPTR_IMPL(PrecodeStubManager, PrecodeStubManager, g_pManager);
#ifndef DACCESS_COMPILE
/* static */
void PrecodeStubManager::Init()
{
CONTRACTL
{
THROWS;
GC_NOTRIGGER;
MODE_ANY;
}
CONTRACTL_END
g_pManager = new PrecodeStubManager();
StubManager::AddStubManager(g_pManager);
}
#endif // #ifndef DACCESS_COMPILE
/* static */
BOOL PrecodeStubManager::CheckIsStub_Internal(PCODE stubStartAddress)
{
CONTRACTL