Skip to content

Add support for ISOSDacInterface15 - MethodTable enumeration api#4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
davidwrighton merged 4 commits into from
Jul 17, 2024
Merged

Add support for ISOSDacInterface15 - MethodTable enumeration api #4767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e332209
Add support for ISOSDacInterface15
davidwrighton Jun 28, 2024
35928c9
Address feedback
davidwrighton Jul 16, 2024
dec93a4
Merge branch 'main' of https://github.com/dotnet/diagnostics into sos…
davidwrighton Jul 16, 2024
d883b49
Fix build breaks
davidwrighton Jul 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
110 changes: 66 additions & 44 deletions src/SOS/Strike/strike.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1239,72 +1239,94 @@ DECLARE_API(DumpMT)

if (bDumpMDTable)
{
table.ReInit(4, POINTERSIZE_HEX, AlignRight);
table.ReInit(5, POINTERSIZE_HEX, AlignRight);
table.SetColAlignment(3, AlignLeft);
table.SetColWidth(2, 6);

Print("--------------------------------------\n");
Print("MethodDesc Table\n");

table.WriteRow("Entry", "MethodDesc", "JIT", "Name");
table.WriteRow("Entry", "MethodDesc", "JIT", "Slot", "Name");

for (DWORD n = 0; n < vMethTable.wNumMethods; n++)
ISOSMethodEnum *pMethodEnumerator;
if (SUCCEEDED(g_sos15->GetMethodTableSlotEnumerator(dwStartAddr, &pMethodEnumerator)))
{
JITTypes jitType;
DWORD_PTR methodDesc=0;
DWORD_PTR gcinfoAddr;

CLRDATA_ADDRESS entry;
if (g_sos->GetMethodTableSlot(dwStartAddr, n, &entry) != S_OK)
SOSMethodData entry;
unsigned int fetched;
while (SUCCEEDED(pMethodEnumerator->Next(1, &entry, &fetched)) && fetched != 0)
{
PrintLn("<error getting slot ", Decimal(n), ">");
continue;
}
JITTypes jitType = TYPE_UNKNOWN;
DWORD_PTR methodDesc = (DWORD_PTR)entry.MethodDesc;
DWORD_PTR methodDescFromIP2MD = 0;
DWORD_PTR gcinfoAddr = 0;

if (entry.Entrypoint != 0)
{
IP2MethodDesc((DWORD_PTR)entry.Entrypoint, methodDescFromIP2MD, jitType, gcinfoAddr);
if ((methodDescFromIP2MD != methodDesc) && methodDesc != 0)
{
ExtOut("MethodDesc from IP2MD does not match MethodDesc from enumerator\n");
}
}

IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);
table.WriteColumn(0, entry);
table.WriteColumn(1, MethodDescPtr(methodDesc));
table.WriteColumn(0, entry.Entrypoint);
table.WriteColumn(1, MethodDescPtr(methodDesc));

if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
{
// We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
// because the methodtable entry hasn't always been patched.
DacpMethodDescData tmpMethodDescData;
if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
{
DacpCodeHeaderData codeHeaderData;
if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
// We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
// because the methodtable entry hasn't always been patched.
DacpMethodDescData tmpMethodDescData;
if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
{
jitType = (JITTypes) codeHeaderData.JITType;
DacpCodeHeaderData codeHeaderData;
if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
{
jitType = (JITTypes) codeHeaderData.JITType;
}
}
}
}

const char *pszJitType = "NONE";
if (jitType == TYPE_JIT)
pszJitType = "JIT";
else if (jitType == TYPE_PJIT)
pszJitType = "PreJIT";
else
{
DacpMethodDescData MethodDescData;
if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
const char *pszJitType = "NONE";
if (jitType == TYPE_JIT)
pszJitType = "JIT";
else if (jitType == TYPE_PJIT)
pszJitType = "PreJIT";
else
{
// Is it an fcall?
ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
ULONG64 size = g_pRuntime->GetModuleSize();
if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
DacpMethodDescData MethodDescData;
if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
{
pszJitType = "FCALL";
// Is it an fcall?
ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
ULONG64 size = g_pRuntime->GetModuleSize();
if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
{
pszJitType = "FCALL";
}
}
}
}

table.WriteColumn(2, pszJitType);
table.WriteColumn(2, pszJitType);
table.WriteColumn(3, entry.Slot);

NameForMD_s(methodDesc,g_mdName,mdNameLen);
table.WriteColumn(3, g_mdName);
if (methodDesc != 0)
NameForMD_s(methodDesc,g_mdName,mdNameLen);
else
{
DacpModuleData moduleData;
if(moduleData.Request(g_sos, entry.DefiningModule)==S_OK)
{
NameForToken_s(&moduleData, entry.Token, g_mdName, mdNameLen, true);
}
else
{
_snwprintf_s(g_mdName, mdNameLen, _TRUNCATE, W("Unknown Module!%08x"), entry.Token);
}
}
table.WriteColumn(4, g_mdName);
}
}
}
return Status;
Expand Down
156 changes: 156 additions & 0 deletions src/SOS/Strike/util.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,7 @@ const char * const CorElementTypeNamespace[ELEMENT_TYPE_MAX]=

IXCLRDataProcess *g_clrData = NULL;
ISOSDacInterface *g_sos = NULL;
ISOSDacInterface15 *g_sos15 = NULL;

#ifndef IfFailRet
#define IfFailRet(EXPR) do { Status = (EXPR); if(FAILED(Status)) { return (Status); } } while (0)
Expand DownExpand Up@@ -3930,6 +3931,154 @@ void ResetGlobals(void)
Output::ResetIndent();
}

class SOSDacInterface15Simulator : public ISOSDacInterface15
{
class SOSMethodEnum : public ISOSMethodEnum
{
CLRDATA_ADDRESS pMT;
unsigned int index;
unsigned int slotCount;
ULONG refCount;
public:
SOSMethodEnum(CLRDATA_ADDRESS mt) : pMT(mt), refCount(1)
{
}

virtual ~SOSMethodEnum() {}

virtual HRESULT STDMETHODCALLTYPE Reset()
{
index = 0;
DacpMethodTableData vMethTable;
HRESULT hr = vMethTable.Request(g_sos, pMT);
if (FAILED(hr))
return hr;

slotCount = vMethTable.wNumMethods;
return S_OK;
}

virtual HRESULT STDMETHODCALLTYPE GetCount(unsigned int *pc)
{
*pc = slotCount;
return S_OK;
}

virtual HRESULT STDMETHODCALLTYPE Skip(unsigned int skipCount)
{
index += skipCount;
return S_OK;
}

virtual HRESULT STDMETHODCALLTYPE Next(
/* [in] */ unsigned int count,
/* [length_is][size_is][out] */ SOSMethodData methods[ ],
/* [out] */ unsigned int *pFetched)
{
if (!pFetched)
return E_POINTER;

if (!methods)
return E_POINTER;

unsigned int i = 0;
while (i < count && index < slotCount)
{
SOSMethodData methodData = { 0 };

JITTypes jitType;
DWORD_PTR methodDesc=0;
DWORD_PTR gcinfoAddr;

CLRDATA_ADDRESS entry;
methodData.Slot = index;
HRESULT hr = g_sos->GetMethodTableSlot(pMT, index++, &entry);
if (hr != S_OK)
{
PrintLn("<error getting slot ", Decimal(index - 1), ">");
continue;
}

IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);

methodData.MethodDesc = methodDesc;
methodData.Entrypoint = entry;

methods[i++] = methodData;
}

*pFetched = i;
return i < count ? S_FALSE : S_OK;
}

STDMETHOD_(ULONG, AddRef)() { return ++refCount; }
STDMETHOD_(ULONG, Release)()
{
--refCount;
if (refCount == 0)
{
delete this;
return 0;
}
return refCount;
}

STDMETHOD(QueryInterface)(
THIS_
___in REFIID InterfaceId,
___out PVOID* Interface
)
{
if (InterfaceId == IID_IUnknown ||
InterfaceId == IID_ISOSMethodEnum)
{
*Interface = (ISOSMethodEnum*)this;
AddRef();
return S_OK;
}
*Interface = NULL;
return E_NOINTERFACE;
}
};

public:
STDMETHOD_(ULONG, AddRef)() { return 1; };
STDMETHOD_(ULONG, Release)() { return 1; };
STDMETHOD(QueryInterface)(
THIS_
___in REFIID InterfaceId,
___out PVOID* Interface
)
{
if (InterfaceId == IID_IUnknown ||
InterfaceId == IID_ISOSDacInterface15)
{
*Interface = (ISOSDacInterface15*)this;
return S_OK;
}
*Interface = NULL;
return E_NOINTERFACE;
}

virtual HRESULT STDMETHODCALLTYPE GetMethodTableSlotEnumerator(
CLRDATA_ADDRESS mt,
ISOSMethodEnum **enumerator)
{
SOSMethodEnum *simulator = new(std::nothrow) SOSMethodEnum(mt);
*enumerator = simulator;
if (simulator == NULL)
{
return E_OUTOFMEMORY;
}
HRESULT hr = simulator->Reset();
if (FAILED(hr))
{
simulator->Release();
}
return hr;
}
} SOSDacInterface15Simulator_Instance;

//---------------------------------------------------------------------------------------
//
// Loads private DAC interface, and points g_clrData to it.
Expand DownExpand Up@@ -3960,6 +4109,13 @@ HRESULT LoadClrDebugDll(void)
g_sos = NULL;
return hr;
}

// Always have an instance of the MethodTable enumerator
hr = g_clrData->QueryInterface(__uuidof(ISOSDacInterface15), (void**)&g_sos15);
if (FAILED(hr))
{
g_sos15 = &SOSDacInterface15Simulator_Instance;
}
return S_OK;
}

Expand Down
1 change: 1 addition & 0 deletions src/SOS/Strike/util.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -150,6 +150,7 @@ enum EEFLAVOR {UNKNOWNEE, MSCOREE, MSCORWKS, MSCOREND};
#include "sospriv.h"
extern IXCLRDataProcess *g_clrData;
extern ISOSDacInterface *g_sos;
extern ISOSDacInterface15 *g_sos15;

#include "dacprivate.h"

Expand Down
43 changes: 43 additions & 0 deletions src/shared/inc/sospriv.idl
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -519,3 +519,46 @@ interface ISOSDacInterface14 : IUnknown
HRESULT GetThreadStaticBaseAddress(CLRDATA_ADDRESS methodTable, CLRDATA_ADDRESS thread, CLRDATA_ADDRESS *nonGCStaticsAddress, CLRDATA_ADDRESS *GCStaticsAddress);
HRESULT GetMethodTableInitializationFlags(CLRDATA_ADDRESS methodTable, MethodTableInitializationFlags *initializationStatus);
}

cpp_quote("#ifndef _SOS_MethodData")
cpp_quote("#define _SOS_MethodData")

typedef struct _SOSMethodData
{
// At least one of MethodDesc, Entrypoint, or Token/DefiningMethodTable/DefiningModule is guaranteed to be set.
// Multiple of them may be set as well
CLRDATA_ADDRESS MethodDesc;

CLRDATA_ADDRESS Entrypoint;

CLRDATA_ADDRESS DefininingMethodTable; // Useful for when the method is inherited from a parent type which is instantiated
CLRDATA_ADDRESS DefiningModule;
unsigned int Token;

// Slot data, a given MethodDesc may be present in multiple slots for a single MethodTable
unsigned int Slot; // Will be set to 0xFFFFFFFF for EnC added methods
} SOSMethodData;

cpp_quote("#endif //_SOS_MethodData")

[
object,
local,
uuid(3c0fe725-c324-4a4f-8100-d399588a662e)
]
interface ISOSMethodEnum : ISOSEnum
{
HRESULT Next([in] unsigned int count,
[out, size_is(count), length_is(*pNeeded)] SOSMethodData handles[],
[out] unsigned int *pNeeded);
}

[
object,
local,
uuid(7ed81261-52a9-4a23-a358-c3313dea30a8)
]
interface ISOSDacInterface15 : IUnknown
{
HRESULT GetMethodTableSlotEnumerator(CLRDATA_ADDRESS mt, ISOSMethodEnum **enumerator);
}
6 changes: 6 additions & 0 deletions src/shared/pal/prebuilt/idl/sospriv_i.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,12 @@ MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface13,0x3176a8ed,0x597b,0x4f54,0xa7,0x1f,

MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface14,0x9aa22aca,0x6dc6,0x4a0c,0xb4,0xe0,0x70,0xd2,0x41,0x6b,0x98,0x37);


MIDL_DEFINE_GUID(IID, IID_ISOSMethodEnum,0x3c0fe725,0xc324,0x4a4f,0x81,0x00,0xd3,0x99,0x58,0x8a,0x66,0x2e);


MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface15,0x7ed81261,0x52a9,0x4a23,0xa3,0x58,0xc3,0x31,0x3d,0xea,0x30,0xa8);

#undef MIDL_DEFINE_GUID

#ifdef __cplusplus
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add support for ISOSDacInterface15 - MethodTable enumeration api by davidwrighton · Pull Request #4767 · dotnet/diagnostics · GitHub
Skip to content
Add support for ISOSDacInterface15 - MethodTable enumeration api#4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

davidwrighton
merged 4 commits into

from

Jul 17, 2024
 Merged


Add support for ISOSDacInterface15 - MethodTable enumeration api
#4767
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e332209

Add support for ISOSDacInterface15


davidwrighton Jun 28, 2024
35928c9

Address feedback


davidwrighton Jul 16, 2024
dec93a4

Merge branch 'main' of https://github.com/dotnet/diagnostics into sos…


davidwrighton Jul 16, 2024
d883b49

Fix build breaks


davidwrighton Jul 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


110 changes: 66 additions & 44 deletions
src/SOS/Strike/strike.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1239,72 +1239,94 @@ DECLARE_API(DumpMT)

 if (bDumpMDTable)
 {
 table.ReInit(4, POINTERSIZE_HEX, AlignRight);
 table.ReInit(5, POINTERSIZE_HEX, AlignRight);
 table.SetColAlignment(3, AlignLeft);
 table.SetColWidth(2, 6);

 Print("--------------------------------------\n");
 Print("MethodDesc Table\n");

 table.WriteRow("Entry", "MethodDesc", "JIT", "Name");
 table.WriteRow("Entry", "MethodDesc", "JIT", "Slot", "Name");

 for (DWORD n = 0; n < vMethTable.wNumMethods; n++)
 ISOSMethodEnum *pMethodEnumerator;
 if (SUCCEEDED(g_sos15->GetMethodTableSlotEnumerator(dwStartAddr, &pMethodEnumerator)))
 {
 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 if (g_sos->GetMethodTableSlot(dwStartAddr, n, &entry) != S_OK)
 SOSMethodData entry;
 unsigned int fetched;
 while (SUCCEEDED(pMethodEnumerator->Next(1, &entry, &fetched)) && fetched != 0)
 {
 PrintLn("<error getting slot ", Decimal(n), ">");
 continue;
 }
 JITTypes jitType = TYPE_UNKNOWN;
 DWORD_PTR methodDesc = (DWORD_PTR)entry.MethodDesc;
 DWORD_PTR methodDescFromIP2MD = 0;
 DWORD_PTR gcinfoAddr = 0;

 if (entry.Entrypoint != 0)
 {
 IP2MethodDesc((DWORD_PTR)entry.Entrypoint, methodDescFromIP2MD, jitType, gcinfoAddr);
 if ((methodDescFromIP2MD != methodDesc) && methodDesc != 0)
 {
 ExtOut("MethodDesc from IP2MD does not match MethodDesc from enumerator\n");
 }
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);
 table.WriteColumn(0, entry);
 table.WriteColumn(1, MethodDescPtr(methodDesc));
 table.WriteColumn(0, entry.Entrypoint);
 table.WriteColumn(1, MethodDescPtr(methodDesc));

 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 }
 }
 }
 }

 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 pszJitType = "FCALL";
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 {
 pszJitType = "FCALL";
 }
 }
 }
 }

 table.WriteColumn(2, pszJitType);
 table.WriteColumn(2, pszJitType);
 table.WriteColumn(3, entry.Slot);

 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 table.WriteColumn(3, g_mdName);
 if (methodDesc != 0)
 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 else
 {
 DacpModuleData moduleData;
 if(moduleData.Request(g_sos, entry.DefiningModule)==S_OK)
 {
 NameForToken_s(&moduleData, entry.Token, g_mdName, mdNameLen, true);
 }
 else
 {
 _snwprintf_s(g_mdName, mdNameLen, _TRUNCATE, W("Unknown Module!%08x"), entry.Token);
 }
 }
 table.WriteColumn(4, g_mdName);
 }
 }
 }
 return Status;
Expand Down

156 changes: 156 additions & 0 deletions
src/SOS/Strike/util.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,7 @@ const char * const CorElementTypeNamespace[ELEMENT_TYPE_MAX]=

IXCLRDataProcess *g_clrData = NULL;
ISOSDacInterface *g_sos = NULL;
ISOSDacInterface15 *g_sos15 = NULL;

#ifndef IfFailRet
#define IfFailRet(EXPR) do { Status = (EXPR); if(FAILED(Status)) { return (Status); } } while (0)
Expand DownExpand Up@@ -3930,6 +3931,154 @@ void ResetGlobals(void)
 Output::ResetIndent();
}

class SOSDacInterface15Simulator : public ISOSDacInterface15
{
 class SOSMethodEnum : public ISOSMethodEnum
 {
 CLRDATA_ADDRESS pMT;
 unsigned int index;
 unsigned int slotCount;
 ULONG refCount;
 public:
 SOSMethodEnum(CLRDATA_ADDRESS mt) : pMT(mt), refCount(1)
 {
 }

 virtual ~SOSMethodEnum() {}

 virtual HRESULT STDMETHODCALLTYPE Reset()
 {
 index = 0;
 DacpMethodTableData vMethTable;
 HRESULT hr = vMethTable.Request(g_sos, pMT);
 if (FAILED(hr))
 return hr;

 slotCount = vMethTable.wNumMethods;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE GetCount(unsigned int *pc)
 {
 *pc = slotCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Skip(unsigned int skipCount)
 {
 index += skipCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Next( 
 /* [in] */ unsigned int count,
 /* [length_is][size_is][out] */ SOSMethodData methods[ ],
 /* [out] */ unsigned int *pFetched)
 {
 if (!pFetched)
 return E_POINTER;

 if (!methods)
 return E_POINTER;

 unsigned int i = 0;
 while (i < count && index < slotCount)
 {
 SOSMethodData methodData = { 0 };

 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 methodData.Slot = index;
 HRESULT hr = g_sos->GetMethodTableSlot(pMT, index++, &entry);
 if (hr != S_OK)
 {
 PrintLn("<error getting slot ", Decimal(index - 1), ">");
 continue;
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);

 methodData.MethodDesc = methodDesc;
 methodData.Entrypoint = entry;

 methods[i++] = methodData;
 }

 *pFetched = i;
 return i < count ? S_FALSE : S_OK;
 }

 STDMETHOD_(ULONG, AddRef)() { return ++refCount; }
 STDMETHOD_(ULONG, Release)()
 {
 --refCount;
 if (refCount == 0)
 {
 delete this;
 return 0;
 }
 return refCount;
 }

 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSMethodEnum)
 {
 *Interface = (ISOSMethodEnum*)this;
 AddRef();
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }
 };

public:
 STDMETHOD_(ULONG, AddRef)() { return 1; };
 STDMETHOD_(ULONG, Release)() { return 1; };
 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSDacInterface15)
 {
 *Interface = (ISOSDacInterface15*)this;
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }

 virtual HRESULT STDMETHODCALLTYPE GetMethodTableSlotEnumerator( 
 CLRDATA_ADDRESS mt,
 ISOSMethodEnum **enumerator)
 {
 SOSMethodEnum *simulator = new(std::nothrow) SOSMethodEnum(mt);
 *enumerator = simulator;
 if (simulator == NULL)
 {
 return E_OUTOFMEMORY;
 }
 HRESULT hr = simulator->Reset();
 if (FAILED(hr))
 {
 simulator->Release();
 }
 return hr;
 }
} SOSDacInterface15Simulator_Instance;

//---------------------------------------------------------------------------------------
//
// Loads private DAC interface, and points g_clrData to it.
Expand DownExpand Up@@ -3960,6 +4109,13 @@ HRESULT LoadClrDebugDll(void)
 g_sos = NULL;
 return hr;
 }

 // Always have an instance of the MethodTable enumerator
 hr = g_clrData->QueryInterface(__uuidof(ISOSDacInterface15), (void**)&g_sos15);
 if (FAILED(hr))
 {
 g_sos15 = &SOSDacInterface15Simulator_Instance;
 }
 return S_OK;
}

Expand Down

1 change: 1 addition & 0 deletions
src/SOS/Strike/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,6 +150,7 @@ enum EEFLAVOR {UNKNOWNEE, MSCOREE, MSCORWKS, MSCOREND};
#include "sospriv.h"
extern IXCLRDataProcess *g_clrData;
extern ISOSDacInterface *g_sos;
extern ISOSDacInterface15 *g_sos15;

#include "dacprivate.h"

Expand Down

43 changes: 43 additions & 0 deletions
src/shared/inc/sospriv.idl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -519,3 +519,46 @@ interface ISOSDacInterface14 : IUnknown
 HRESULT GetThreadStaticBaseAddress(CLRDATA_ADDRESS methodTable, CLRDATA_ADDRESS thread, CLRDATA_ADDRESS *nonGCStaticsAddress, CLRDATA_ADDRESS *GCStaticsAddress);
 HRESULT GetMethodTableInitializationFlags(CLRDATA_ADDRESS methodTable, MethodTableInitializationFlags *initializationStatus);
}

cpp_quote("#ifndef _SOS_MethodData")
cpp_quote("#define _SOS_MethodData")

typedef struct _SOSMethodData
{
 // At least one of MethodDesc, Entrypoint, or Token/DefiningMethodTable/DefiningModule is guaranteed to be set.
 // Multiple of them may be set as well
 CLRDATA_ADDRESS MethodDesc;

 CLRDATA_ADDRESS Entrypoint;

 CLRDATA_ADDRESS DefininingMethodTable; // Useful for when the method is inherited from a parent type which is instantiated
 CLRDATA_ADDRESS DefiningModule;
 unsigned int Token;

 // Slot data, a given MethodDesc may be present in multiple slots for a single MethodTable
 unsigned int Slot; // Will be set to 0xFFFFFFFF for EnC added methods
} SOSMethodData;

cpp_quote("#endif //_SOS_MethodData")

[
 object,
 local,
 uuid(3c0fe725-c324-4a4f-8100-d399588a662e)
]
interface ISOSMethodEnum : ISOSEnum
{
 HRESULT Next([in] unsigned int count,
 [out, size_is(count), length_is(*pNeeded)] SOSMethodData handles[],
 [out] unsigned int *pNeeded);
}

[
 object,
 local,
 uuid(7ed81261-52a9-4a23-a358-c3313dea30a8)
]
interface ISOSDacInterface15 : IUnknown
{
 HRESULT GetMethodTableSlotEnumerator(CLRDATA_ADDRESS mt, ISOSMethodEnum **enumerator);
}

6 changes: 6 additions & 0 deletions
src/shared/pal/prebuilt/idl/sospriv_i.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,12 @@ MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface13,0x3176a8ed,0x597b,0x4f54,0xa7,0x1f,

MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface14,0x9aa22aca,0x6dc6,0x4a0c,0xb4,0xe0,0x70,0xd2,0x41,0x6b,0x98,0x37);


MIDL_DEFINE_GUID(IID, IID_ISOSMethodEnum,0x3c0fe725,0xc324,0x4a4f,0x81,0x00,0xd3,0x99,0x58,0x8a,0x66,0x2e);


MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface15,0x7ed81261,0x52a9,0x4a23,0xa3,0x58,0xc3,0x31,0x3d,0xea,0x30,0xa8);

#undef MIDL_DEFINE_GUID

#ifdef __cplusplus
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for ISOSDacInterface15 - MethodTable enumeration api by davidwrighton · Pull Request #4767 · dotnet/diagnostics · GitHub
Skip to content
Add support for ISOSDacInterface15 - MethodTable enumeration api#4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

davidwrighton
merged 4 commits into

from

Jul 17, 2024
 Merged


Add support for ISOSDacInterface15 - MethodTable enumeration api
#4767
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e332209

Add support for ISOSDacInterface15


davidwrighton Jun 28, 2024
35928c9

Address feedback


davidwrighton Jul 16, 2024
dec93a4

Merge branch 'main' of https://github.com/dotnet/diagnostics into sos…


davidwrighton Jul 16, 2024
d883b49

Fix build breaks


davidwrighton Jul 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


110 changes: 66 additions & 44 deletions
src/SOS/Strike/strike.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1239,72 +1239,94 @@ DECLARE_API(DumpMT)

 if (bDumpMDTable)
 {
 table.ReInit(4, POINTERSIZE_HEX, AlignRight);
 table.ReInit(5, POINTERSIZE_HEX, AlignRight);
 table.SetColAlignment(3, AlignLeft);
 table.SetColWidth(2, 6);

 Print("--------------------------------------\n");
 Print("MethodDesc Table\n");

 table.WriteRow("Entry", "MethodDesc", "JIT", "Name");
 table.WriteRow("Entry", "MethodDesc", "JIT", "Slot", "Name");

 for (DWORD n = 0; n < vMethTable.wNumMethods; n++)
 ISOSMethodEnum *pMethodEnumerator;
 if (SUCCEEDED(g_sos15->GetMethodTableSlotEnumerator(dwStartAddr, &pMethodEnumerator)))
 {
 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 if (g_sos->GetMethodTableSlot(dwStartAddr, n, &entry) != S_OK)
 SOSMethodData entry;
 unsigned int fetched;
 while (SUCCEEDED(pMethodEnumerator->Next(1, &entry, &fetched)) && fetched != 0)
 {
 PrintLn("<error getting slot ", Decimal(n), ">");
 continue;
 }
 JITTypes jitType = TYPE_UNKNOWN;
 DWORD_PTR methodDesc = (DWORD_PTR)entry.MethodDesc;
 DWORD_PTR methodDescFromIP2MD = 0;
 DWORD_PTR gcinfoAddr = 0;

 if (entry.Entrypoint != 0)
 {
 IP2MethodDesc((DWORD_PTR)entry.Entrypoint, methodDescFromIP2MD, jitType, gcinfoAddr);
 if ((methodDescFromIP2MD != methodDesc) && methodDesc != 0)
 {
 ExtOut("MethodDesc from IP2MD does not match MethodDesc from enumerator\n");
 }
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);
 table.WriteColumn(0, entry);
 table.WriteColumn(1, MethodDescPtr(methodDesc));
 table.WriteColumn(0, entry.Entrypoint);
 table.WriteColumn(1, MethodDescPtr(methodDesc));

 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 }
 }
 }
 }

 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 pszJitType = "FCALL";
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 {
 pszJitType = "FCALL";
 }
 }
 }
 }

 table.WriteColumn(2, pszJitType);
 table.WriteColumn(2, pszJitType);
 table.WriteColumn(3, entry.Slot);

 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 table.WriteColumn(3, g_mdName);
 if (methodDesc != 0)
 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 else
 {
 DacpModuleData moduleData;
 if(moduleData.Request(g_sos, entry.DefiningModule)==S_OK)
 {
 NameForToken_s(&moduleData, entry.Token, g_mdName, mdNameLen, true);
 }
 else
 {
 _snwprintf_s(g_mdName, mdNameLen, _TRUNCATE, W("Unknown Module!%08x"), entry.Token);
 }
 }
 table.WriteColumn(4, g_mdName);
 }
 }
 }
 return Status;
Expand Down

156 changes: 156 additions & 0 deletions
src/SOS/Strike/util.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,7 @@ const char * const CorElementTypeNamespace[ELEMENT_TYPE_MAX]=

IXCLRDataProcess *g_clrData = NULL;
ISOSDacInterface *g_sos = NULL;
ISOSDacInterface15 *g_sos15 = NULL;

#ifndef IfFailRet
#define IfFailRet(EXPR) do { Status = (EXPR); if(FAILED(Status)) { return (Status); } } while (0)
Expand DownExpand Up@@ -3930,6 +3931,154 @@ void ResetGlobals(void)
 Output::ResetIndent();
}

class SOSDacInterface15Simulator : public ISOSDacInterface15
{
 class SOSMethodEnum : public ISOSMethodEnum
 {
 CLRDATA_ADDRESS pMT;
 unsigned int index;
 unsigned int slotCount;
 ULONG refCount;
 public:
 SOSMethodEnum(CLRDATA_ADDRESS mt) : pMT(mt), refCount(1)
 {
 }

 virtual ~SOSMethodEnum() {}

 virtual HRESULT STDMETHODCALLTYPE Reset()
 {
 index = 0;
 DacpMethodTableData vMethTable;
 HRESULT hr = vMethTable.Request(g_sos, pMT);
 if (FAILED(hr))
 return hr;

 slotCount = vMethTable.wNumMethods;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE GetCount(unsigned int *pc)
 {
 *pc = slotCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Skip(unsigned int skipCount)
 {
 index += skipCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Next( 
 /* [in] */ unsigned int count,
 /* [length_is][size_is][out] */ SOSMethodData methods[ ],
 /* [out] */ unsigned int *pFetched)
 {
 if (!pFetched)
 return E_POINTER;

 if (!methods)
 return E_POINTER;

 unsigned int i = 0;
 while (i < count && index < slotCount)
 {
 SOSMethodData methodData = { 0 };

 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 methodData.Slot = index;
 HRESULT hr = g_sos->GetMethodTableSlot(pMT, index++, &entry);
 if (hr != S_OK)
 {
 PrintLn("<error getting slot ", Decimal(index - 1), ">");
 continue;
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);

 methodData.MethodDesc = methodDesc;
 methodData.Entrypoint = entry;

 methods[i++] = methodData;
 }

 *pFetched = i;
 return i < count ? S_FALSE : S_OK;
 }

 STDMETHOD_(ULONG, AddRef)() { return ++refCount; }
 STDMETHOD_(ULONG, Release)()
 {
 --refCount;
 if (refCount == 0)
 {
 delete this;
 return 0;
 }
 return refCount;
 }

 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSMethodEnum)
 {
 *Interface = (ISOSMethodEnum*)this;
 AddRef();
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }
 };

public:
 STDMETHOD_(ULONG, AddRef)() { return 1; };
 STDMETHOD_(ULONG, Release)() { return 1; };
 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSDacInterface15)
 {
 *Interface = (ISOSDacInterface15*)this;
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }

 virtual HRESULT STDMETHODCALLTYPE GetMethodTableSlotEnumerator( 
 CLRDATA_ADDRESS mt,
 ISOSMethodEnum **enumerator)
 {
 SOSMethodEnum *simulator = new(std::nothrow) SOSMethodEnum(mt);
 *enumerator = simulator;
 if (simulator == NULL)
 {
 return E_OUTOFMEMORY;
 }
 HRESULT hr = simulator->Reset();
 if (FAILED(hr))
 {
 simulator->Release();
 }
 return hr;
 }
} SOSDacInterface15Simulator_Instance;

//---------------------------------------------------------------------------------------
//
// Loads private DAC interface, and points g_clrData to it.
Expand DownExpand Up@@ -3960,6 +4109,13 @@ HRESULT LoadClrDebugDll(void)
 g_sos = NULL;
 return hr;
 }

 // Always have an instance of the MethodTable enumerator
 hr = g_clrData->QueryInterface(__uuidof(ISOSDacInterface15), (void**)&g_sos15);
 if (FAILED(hr))
 {
 g_sos15 = &SOSDacInterface15Simulator_Instance;
 }
 return S_OK;
}

Expand Down

1 change: 1 addition & 0 deletions
src/SOS/Strike/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,6 +150,7 @@ enum EEFLAVOR {UNKNOWNEE, MSCOREE, MSCORWKS, MSCOREND};
#include "sospriv.h"
extern IXCLRDataProcess *g_clrData;
extern ISOSDacInterface *g_sos;
extern ISOSDacInterface15 *g_sos15;

#include "dacprivate.h"

Expand Down

43 changes: 43 additions & 0 deletions
src/shared/inc/sospriv.idl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -519,3 +519,46 @@ interface ISOSDacInterface14 : IUnknown
 HRESULT GetThreadStaticBaseAddress(CLRDATA_ADDRESS methodTable, CLRDATA_ADDRESS thread, CLRDATA_ADDRESS *nonGCStaticsAddress, CLRDATA_ADDRESS *GCStaticsAddress);
 HRESULT GetMethodTableInitializationFlags(CLRDATA_ADDRESS methodTable, MethodTableInitializationFlags *initializationStatus);
}

cpp_quote("#ifndef _SOS_MethodData")
cpp_quote("#define _SOS_MethodData")

typedef struct _SOSMethodData
{
 // At least one of MethodDesc, Entrypoint, or Token/DefiningMethodTable/DefiningModule is guaranteed to be set.
 // Multiple of them may be set as well
 CLRDATA_ADDRESS MethodDesc;

 CLRDATA_ADDRESS Entrypoint;

 CLRDATA_ADDRESS DefininingMethodTable; // Useful for when the method is inherited from a parent type which is instantiated
 CLRDATA_ADDRESS DefiningModule;
 unsigned int Token;

 // Slot data, a given MethodDesc may be present in multiple slots for a single MethodTable
 unsigned int Slot; // Will be set to 0xFFFFFFFF for EnC added methods
} SOSMethodData;

cpp_quote("#endif //_SOS_MethodData")

[
 object,
 local,
 uuid(3c0fe725-c324-4a4f-8100-d399588a662e)
]
interface ISOSMethodEnum : ISOSEnum
{
 HRESULT Next([in] unsigned int count,
 [out, size_is(count), length_is(*pNeeded)] SOSMethodData handles[],
 [out] unsigned int *pNeeded);
}

[
 object,
 local,
 uuid(7ed81261-52a9-4a23-a358-c3313dea30a8)
]
interface ISOSDacInterface15 : IUnknown
{
 HRESULT GetMethodTableSlotEnumerator(CLRDATA_ADDRESS mt, ISOSMethodEnum **enumerator);
}

6 changes: 6 additions & 0 deletions
src/shared/pal/prebuilt/idl/sospriv_i.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,12 @@ MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface13,0x3176a8ed,0x597b,0x4f54,0xa7,0x1f,

MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface14,0x9aa22aca,0x6dc6,0x4a0c,0xb4,0xe0,0x70,0xd2,0x41,0x6b,0x98,0x37);


MIDL_DEFINE_GUID(IID, IID_ISOSMethodEnum,0x3c0fe725,0xc324,0x4a4f,0x81,0x00,0xd3,0x99,0x58,0x8a,0x66,0x2e);


MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface15,0x7ed81261,0x52a9,0x4a23,0xa3,0x58,0xc3,0x31,0x3d,0xea,0x30,0xa8);

#undef MIDL_DEFINE_GUID

#ifdef __cplusplus
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for ISOSDacInterface15 - MethodTable enumeration api by davidwrighton · Pull Request #4767 · dotnet/diagnostics · GitHub
Skip to content
Add support for ISOSDacInterface15 - MethodTable enumeration api#4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

davidwrighton
merged 4 commits into

from

Jul 17, 2024
 Merged


Add support for ISOSDacInterface15 - MethodTable enumeration api
#4767
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e332209

Add support for ISOSDacInterface15


davidwrighton Jun 28, 2024
35928c9

Address feedback


davidwrighton Jul 16, 2024
dec93a4

Merge branch 'main' of https://github.com/dotnet/diagnostics into sos…


davidwrighton Jul 16, 2024
d883b49

Fix build breaks


davidwrighton Jul 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


110 changes: 66 additions & 44 deletions
src/SOS/Strike/strike.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1239,72 +1239,94 @@ DECLARE_API(DumpMT)

 if (bDumpMDTable)
 {
 table.ReInit(4, POINTERSIZE_HEX, AlignRight);
 table.ReInit(5, POINTERSIZE_HEX, AlignRight);
 table.SetColAlignment(3, AlignLeft);
 table.SetColWidth(2, 6);

 Print("--------------------------------------\n");
 Print("MethodDesc Table\n");

 table.WriteRow("Entry", "MethodDesc", "JIT", "Name");
 table.WriteRow("Entry", "MethodDesc", "JIT", "Slot", "Name");

 for (DWORD n = 0; n < vMethTable.wNumMethods; n++)
 ISOSMethodEnum *pMethodEnumerator;
 if (SUCCEEDED(g_sos15->GetMethodTableSlotEnumerator(dwStartAddr, &pMethodEnumerator)))
 {
 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 if (g_sos->GetMethodTableSlot(dwStartAddr, n, &entry) != S_OK)
 SOSMethodData entry;
 unsigned int fetched;
 while (SUCCEEDED(pMethodEnumerator->Next(1, &entry, &fetched)) && fetched != 0)
 {
 PrintLn("<error getting slot ", Decimal(n), ">");
 continue;
 }
 JITTypes jitType = TYPE_UNKNOWN;
 DWORD_PTR methodDesc = (DWORD_PTR)entry.MethodDesc;
 DWORD_PTR methodDescFromIP2MD = 0;
 DWORD_PTR gcinfoAddr = 0;

 if (entry.Entrypoint != 0)
 {
 IP2MethodDesc((DWORD_PTR)entry.Entrypoint, methodDescFromIP2MD, jitType, gcinfoAddr);
 if ((methodDescFromIP2MD != methodDesc) && methodDesc != 0)
 {
 ExtOut("MethodDesc from IP2MD does not match MethodDesc from enumerator\n");
 }
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);
 table.WriteColumn(0, entry);
 table.WriteColumn(1, MethodDescPtr(methodDesc));
 table.WriteColumn(0, entry.Entrypoint);
 table.WriteColumn(1, MethodDescPtr(methodDesc));

 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 }
 }
 }
 }

 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 pszJitType = "FCALL";
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 {
 pszJitType = "FCALL";
 }
 }
 }
 }

 table.WriteColumn(2, pszJitType);
 table.WriteColumn(2, pszJitType);
 table.WriteColumn(3, entry.Slot);

 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 table.WriteColumn(3, g_mdName);
 if (methodDesc != 0)
 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 else
 {
 DacpModuleData moduleData;
 if(moduleData.Request(g_sos, entry.DefiningModule)==S_OK)
 {
 NameForToken_s(&moduleData, entry.Token, g_mdName, mdNameLen, true);
 }
 else
 {
 _snwprintf_s(g_mdName, mdNameLen, _TRUNCATE, W("Unknown Module!%08x"), entry.Token);
 }
 }
 table.WriteColumn(4, g_mdName);
 }
 }
 }
 return Status;
Expand Down

156 changes: 156 additions & 0 deletions
src/SOS/Strike/util.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,7 @@ const char * const CorElementTypeNamespace[ELEMENT_TYPE_MAX]=

IXCLRDataProcess *g_clrData = NULL;
ISOSDacInterface *g_sos = NULL;
ISOSDacInterface15 *g_sos15 = NULL;

#ifndef IfFailRet
#define IfFailRet(EXPR) do { Status = (EXPR); if(FAILED(Status)) { return (Status); } } while (0)
Expand DownExpand Up@@ -3930,6 +3931,154 @@ void ResetGlobals(void)
 Output::ResetIndent();
}

class SOSDacInterface15Simulator : public ISOSDacInterface15
{
 class SOSMethodEnum : public ISOSMethodEnum
 {
 CLRDATA_ADDRESS pMT;
 unsigned int index;
 unsigned int slotCount;
 ULONG refCount;
 public:
 SOSMethodEnum(CLRDATA_ADDRESS mt) : pMT(mt), refCount(1)
 {
 }

 virtual ~SOSMethodEnum() {}

 virtual HRESULT STDMETHODCALLTYPE Reset()
 {
 index = 0;
 DacpMethodTableData vMethTable;
 HRESULT hr = vMethTable.Request(g_sos, pMT);
 if (FAILED(hr))
 return hr;

 slotCount = vMethTable.wNumMethods;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE GetCount(unsigned int *pc)
 {
 *pc = slotCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Skip(unsigned int skipCount)
 {
 index += skipCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Next( 
 /* [in] */ unsigned int count,
 /* [length_is][size_is][out] */ SOSMethodData methods[ ],
 /* [out] */ unsigned int *pFetched)
 {
 if (!pFetched)
 return E_POINTER;

 if (!methods)
 return E_POINTER;

 unsigned int i = 0;
 while (i < count && index < slotCount)
 {
 SOSMethodData methodData = { 0 };

 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 methodData.Slot = index;
 HRESULT hr = g_sos->GetMethodTableSlot(pMT, index++, &entry);
 if (hr != S_OK)
 {
 PrintLn("<error getting slot ", Decimal(index - 1), ">");
 continue;
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);

 methodData.MethodDesc = methodDesc;
 methodData.Entrypoint = entry;

 methods[i++] = methodData;
 }

 *pFetched = i;
 return i < count ? S_FALSE : S_OK;
 }

 STDMETHOD_(ULONG, AddRef)() { return ++refCount; }
 STDMETHOD_(ULONG, Release)()
 {
 --refCount;
 if (refCount == 0)
 {
 delete this;
 return 0;
 }
 return refCount;
 }

 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSMethodEnum)
 {
 *Interface = (ISOSMethodEnum*)this;
 AddRef();
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }
 };

public:
 STDMETHOD_(ULONG, AddRef)() { return 1; };
 STDMETHOD_(ULONG, Release)() { return 1; };
 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSDacInterface15)
 {
 *Interface = (ISOSDacInterface15*)this;
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }

 virtual HRESULT STDMETHODCALLTYPE GetMethodTableSlotEnumerator( 
 CLRDATA_ADDRESS mt,
 ISOSMethodEnum **enumerator)
 {
 SOSMethodEnum *simulator = new(std::nothrow) SOSMethodEnum(mt);
 *enumerator = simulator;
 if (simulator == NULL)
 {
 return E_OUTOFMEMORY;
 }
 HRESULT hr = simulator->Reset();
 if (FAILED(hr))
 {
 simulator->Release();
 }
 return hr;
 }
} SOSDacInterface15Simulator_Instance;

//---------------------------------------------------------------------------------------
//
// Loads private DAC interface, and points g_clrData to it.
Expand DownExpand Up@@ -3960,6 +4109,13 @@ HRESULT LoadClrDebugDll(void)
 g_sos = NULL;
 return hr;
 }

 // Always have an instance of the MethodTable enumerator
 hr = g_clrData->QueryInterface(__uuidof(ISOSDacInterface15), (void**)&g_sos15);
 if (FAILED(hr))
 {
 g_sos15 = &SOSDacInterface15Simulator_Instance;
 }
 return S_OK;
}

Expand Down

1 change: 1 addition & 0 deletions
src/SOS/Strike/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,6 +150,7 @@ enum EEFLAVOR {UNKNOWNEE, MSCOREE, MSCORWKS, MSCOREND};
#include "sospriv.h"
extern IXCLRDataProcess *g_clrData;
extern ISOSDacInterface *g_sos;
extern ISOSDacInterface15 *g_sos15;

#include "dacprivate.h"

Expand Down

43 changes: 43 additions & 0 deletions
src/shared/inc/sospriv.idl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -519,3 +519,46 @@ interface ISOSDacInterface14 : IUnknown
 HRESULT GetThreadStaticBaseAddress(CLRDATA_ADDRESS methodTable, CLRDATA_ADDRESS thread, CLRDATA_ADDRESS *nonGCStaticsAddress, CLRDATA_ADDRESS *GCStaticsAddress);
 HRESULT GetMethodTableInitializationFlags(CLRDATA_ADDRESS methodTable, MethodTableInitializationFlags *initializationStatus);
}

cpp_quote("#ifndef _SOS_MethodData")
cpp_quote("#define _SOS_MethodData")

typedef struct _SOSMethodData
{
 // At least one of MethodDesc, Entrypoint, or Token/DefiningMethodTable/DefiningModule is guaranteed to be set.
 // Multiple of them may be set as well
 CLRDATA_ADDRESS MethodDesc;

 CLRDATA_ADDRESS Entrypoint;

 CLRDATA_ADDRESS DefininingMethodTable; // Useful for when the method is inherited from a parent type which is instantiated
 CLRDATA_ADDRESS DefiningModule;
 unsigned int Token;

 // Slot data, a given MethodDesc may be present in multiple slots for a single MethodTable
 unsigned int Slot; // Will be set to 0xFFFFFFFF for EnC added methods
} SOSMethodData;

cpp_quote("#endif //_SOS_MethodData")

[
 object,
 local,
 uuid(3c0fe725-c324-4a4f-8100-d399588a662e)
]
interface ISOSMethodEnum : ISOSEnum
{
 HRESULT Next([in] unsigned int count,
 [out, size_is(count), length_is(*pNeeded)] SOSMethodData handles[],
 [out] unsigned int *pNeeded);
}

[
 object,
 local,
 uuid(7ed81261-52a9-4a23-a358-c3313dea30a8)
]
interface ISOSDacInterface15 : IUnknown
{
 HRESULT GetMethodTableSlotEnumerator(CLRDATA_ADDRESS mt, ISOSMethodEnum **enumerator);
}

6 changes: 6 additions & 0 deletions
src/shared/pal/prebuilt/idl/sospriv_i.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,12 @@ MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface13,0x3176a8ed,0x597b,0x4f54,0xa7,0x1f,

MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface14,0x9aa22aca,0x6dc6,0x4a0c,0xb4,0xe0,0x70,0xd2,0x41,0x6b,0x98,0x37);


MIDL_DEFINE_GUID(IID, IID_ISOSMethodEnum,0x3c0fe725,0xc324,0x4a4f,0x81,0x00,0xd3,0x99,0x58,0x8a,0x66,0x2e);


MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface15,0x7ed81261,0x52a9,0x4a23,0xa3,0x58,0xc3,0x31,0x3d,0xea,0x30,0xa8);

#undef MIDL_DEFINE_GUID

#ifdef __cplusplus
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add support for ISOSDacInterface15 - MethodTable enumeration api by davidwrighton · Pull Request #4767 · dotnet/diagnostics · GitHub
Skip to content
Add support for ISOSDacInterface15 - MethodTable enumeration api#4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

davidwrighton
merged 4 commits into

from

Jul 17, 2024
 Merged


Add support for ISOSDacInterface15 - MethodTable enumeration api
#4767
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e332209

Add support for ISOSDacInterface15


davidwrighton Jun 28, 2024
35928c9

Address feedback


davidwrighton Jul 16, 2024
dec93a4

Merge branch 'main' of https://github.com/dotnet/diagnostics into sos…


davidwrighton Jul 16, 2024
d883b49

Fix build breaks


davidwrighton Jul 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


110 changes: 66 additions & 44 deletions
src/SOS/Strike/strike.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1239,72 +1239,94 @@ DECLARE_API(DumpMT)

 if (bDumpMDTable)
 {
 table.ReInit(4, POINTERSIZE_HEX, AlignRight);
 table.ReInit(5, POINTERSIZE_HEX, AlignRight);
 table.SetColAlignment(3, AlignLeft);
 table.SetColWidth(2, 6);

 Print("--------------------------------------\n");
 Print("MethodDesc Table\n");

 table.WriteRow("Entry", "MethodDesc", "JIT", "Name");
 table.WriteRow("Entry", "MethodDesc", "JIT", "Slot", "Name");

 for (DWORD n = 0; n < vMethTable.wNumMethods; n++)
 ISOSMethodEnum *pMethodEnumerator;
 if (SUCCEEDED(g_sos15->GetMethodTableSlotEnumerator(dwStartAddr, &pMethodEnumerator)))
 {
 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 if (g_sos->GetMethodTableSlot(dwStartAddr, n, &entry) != S_OK)
 SOSMethodData entry;
 unsigned int fetched;
 while (SUCCEEDED(pMethodEnumerator->Next(1, &entry, &fetched)) && fetched != 0)
 {
 PrintLn("<error getting slot ", Decimal(n), ">");
 continue;
 }
 JITTypes jitType = TYPE_UNKNOWN;
 DWORD_PTR methodDesc = (DWORD_PTR)entry.MethodDesc;
 DWORD_PTR methodDescFromIP2MD = 0;
 DWORD_PTR gcinfoAddr = 0;

 if (entry.Entrypoint != 0)
 {
 IP2MethodDesc((DWORD_PTR)entry.Entrypoint, methodDescFromIP2MD, jitType, gcinfoAddr);
 if ((methodDescFromIP2MD != methodDesc) && methodDesc != 0)
 {
 ExtOut("MethodDesc from IP2MD does not match MethodDesc from enumerator\n");
 }
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);
 table.WriteColumn(0, entry);
 table.WriteColumn(1, MethodDescPtr(methodDesc));
 table.WriteColumn(0, entry.Entrypoint);
 table.WriteColumn(1, MethodDescPtr(methodDesc));

 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 }
 }
 }
 }

 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 pszJitType = "FCALL";
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 {
 pszJitType = "FCALL";
 }
 }
 }
 }

 table.WriteColumn(2, pszJitType);
 table.WriteColumn(2, pszJitType);
 table.WriteColumn(3, entry.Slot);

 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 table.WriteColumn(3, g_mdName);
 if (methodDesc != 0)
 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 else
 {
 DacpModuleData moduleData;
 if(moduleData.Request(g_sos, entry.DefiningModule)==S_OK)
 {
 NameForToken_s(&moduleData, entry.Token, g_mdName, mdNameLen, true);
 }
 else
 {
 _snwprintf_s(g_mdName, mdNameLen, _TRUNCATE, W("Unknown Module!%08x"), entry.Token);
 }
 }
 table.WriteColumn(4, g_mdName);
 }
 }
 }
 return Status;
Expand Down

156 changes: 156 additions & 0 deletions
src/SOS/Strike/util.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,7 @@ const char * const CorElementTypeNamespace[ELEMENT_TYPE_MAX]=

IXCLRDataProcess *g_clrData = NULL;
ISOSDacInterface *g_sos = NULL;
ISOSDacInterface15 *g_sos15 = NULL;

#ifndef IfFailRet
#define IfFailRet(EXPR) do { Status = (EXPR); if(FAILED(Status)) { return (Status); } } while (0)
Expand DownExpand Up@@ -3930,6 +3931,154 @@ void ResetGlobals(void)
 Output::ResetIndent();
}

class SOSDacInterface15Simulator : public ISOSDacInterface15
{
 class SOSMethodEnum : public ISOSMethodEnum
 {
 CLRDATA_ADDRESS pMT;
 unsigned int index;
 unsigned int slotCount;
 ULONG refCount;
 public:
 SOSMethodEnum(CLRDATA_ADDRESS mt) : pMT(mt), refCount(1)
 {
 }

 virtual ~SOSMethodEnum() {}

 virtual HRESULT STDMETHODCALLTYPE Reset()
 {
 index = 0;
 DacpMethodTableData vMethTable;
 HRESULT hr = vMethTable.Request(g_sos, pMT);
 if (FAILED(hr))
 return hr;

 slotCount = vMethTable.wNumMethods;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE GetCount(unsigned int *pc)
 {
 *pc = slotCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Skip(unsigned int skipCount)
 {
 index += skipCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Next( 
 /* [in] */ unsigned int count,
 /* [length_is][size_is][out] */ SOSMethodData methods[ ],
 /* [out] */ unsigned int *pFetched)
 {
 if (!pFetched)
 return E_POINTER;

 if (!methods)
 return E_POINTER;

 unsigned int i = 0;
 while (i < count && index < slotCount)
 {
 SOSMethodData methodData = { 0 };

 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 methodData.Slot = index;
 HRESULT hr = g_sos->GetMethodTableSlot(pMT, index++, &entry);
 if (hr != S_OK)
 {
 PrintLn("<error getting slot ", Decimal(index - 1), ">");
 continue;
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);

 methodData.MethodDesc = methodDesc;
 methodData.Entrypoint = entry;

 methods[i++] = methodData;
 }

 *pFetched = i;
 return i < count ? S_FALSE : S_OK;
 }

 STDMETHOD_(ULONG, AddRef)() { return ++refCount; }
 STDMETHOD_(ULONG, Release)()
 {
 --refCount;
 if (refCount == 0)
 {
 delete this;
 return 0;
 }
 return refCount;
 }

 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSMethodEnum)
 {
 *Interface = (ISOSMethodEnum*)this;
 AddRef();
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }
 };

public:
 STDMETHOD_(ULONG, AddRef)() { return 1; };
 STDMETHOD_(ULONG, Release)() { return 1; };
 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSDacInterface15)
 {
 *Interface = (ISOSDacInterface15*)this;
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }

 virtual HRESULT STDMETHODCALLTYPE GetMethodTableSlotEnumerator( 
 CLRDATA_ADDRESS mt,
 ISOSMethodEnum **enumerator)
 {
 SOSMethodEnum *simulator = new(std::nothrow) SOSMethodEnum(mt);
 *enumerator = simulator;
 if (simulator == NULL)
 {
 return E_OUTOFMEMORY;
 }
 HRESULT hr = simulator->Reset();
 if (FAILED(hr))
 {
 simulator->Release();
 }
 return hr;
 }
} SOSDacInterface15Simulator_Instance;

//---------------------------------------------------------------------------------------
//
// Loads private DAC interface, and points g_clrData to it.
Expand DownExpand Up@@ -3960,6 +4109,13 @@ HRESULT LoadClrDebugDll(void)
 g_sos = NULL;
 return hr;
 }

 // Always have an instance of the MethodTable enumerator
 hr = g_clrData->QueryInterface(__uuidof(ISOSDacInterface15), (void**)&g_sos15);
 if (FAILED(hr))
 {
 g_sos15 = &SOSDacInterface15Simulator_Instance;
 }
 return S_OK;
}

Expand Down

1 change: 1 addition & 0 deletions
src/SOS/Strike/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,6 +150,7 @@ enum EEFLAVOR {UNKNOWNEE, MSCOREE, MSCORWKS, MSCOREND};
#include "sospriv.h"
extern IXCLRDataProcess *g_clrData;
extern ISOSDacInterface *g_sos;
extern ISOSDacInterface15 *g_sos15;

#include "dacprivate.h"

Expand Down

43 changes: 43 additions & 0 deletions
src/shared/inc/sospriv.idl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -519,3 +519,46 @@ interface ISOSDacInterface14 : IUnknown
 HRESULT GetThreadStaticBaseAddress(CLRDATA_ADDRESS methodTable, CLRDATA_ADDRESS thread, CLRDATA_ADDRESS *nonGCStaticsAddress, CLRDATA_ADDRESS *GCStaticsAddress);
 HRESULT GetMethodTableInitializationFlags(CLRDATA_ADDRESS methodTable, MethodTableInitializationFlags *initializationStatus);
}

cpp_quote("#ifndef _SOS_MethodData")
cpp_quote("#define _SOS_MethodData")

typedef struct _SOSMethodData
{
 // At least one of MethodDesc, Entrypoint, or Token/DefiningMethodTable/DefiningModule is guaranteed to be set.
 // Multiple of them may be set as well
 CLRDATA_ADDRESS MethodDesc;

 CLRDATA_ADDRESS Entrypoint;

 CLRDATA_ADDRESS DefininingMethodTable; // Useful for when the method is inherited from a parent type which is instantiated
 CLRDATA_ADDRESS DefiningModule;
 unsigned int Token;

 // Slot data, a given MethodDesc may be present in multiple slots for a single MethodTable
 unsigned int Slot; // Will be set to 0xFFFFFFFF for EnC added methods
} SOSMethodData;

cpp_quote("#endif //_SOS_MethodData")

[
 object,
 local,
 uuid(3c0fe725-c324-4a4f-8100-d399588a662e)
]
interface ISOSMethodEnum : ISOSEnum
{
 HRESULT Next([in] unsigned int count,
 [out, size_is(count), length_is(*pNeeded)] SOSMethodData handles[],
 [out] unsigned int *pNeeded);
}

[
 object,
 local,
 uuid(7ed81261-52a9-4a23-a358-c3313dea30a8)
]
interface ISOSDacInterface15 : IUnknown
{
 HRESULT GetMethodTableSlotEnumerator(CLRDATA_ADDRESS mt, ISOSMethodEnum **enumerator);
}

6 changes: 6 additions & 0 deletions
src/shared/pal/prebuilt/idl/sospriv_i.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,12 @@ MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface13,0x3176a8ed,0x597b,0x4f54,0xa7,0x1f,

MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface14,0x9aa22aca,0x6dc6,0x4a0c,0xb4,0xe0,0x70,0xd2,0x41,0x6b,0x98,0x37);


MIDL_DEFINE_GUID(IID, IID_ISOSMethodEnum,0x3c0fe725,0xc324,0x4a4f,0x81,0x00,0xd3,0x99,0x58,0x8a,0x66,0x2e);


MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface15,0x7ed81261,0x52a9,0x4a23,0xa3,0x58,0xc3,0x31,0x3d,0xea,0x30,0xa8);

#undef MIDL_DEFINE_GUID

#ifdef __cplusplus
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for ISOSDacInterface15 - MethodTable enumeration api by davidwrighton · Pull Request #4767 · dotnet/diagnostics · GitHub
Skip to content
Add support for ISOSDacInterface15 - MethodTable enumeration api#4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

davidwrighton
merged 4 commits into

from

Jul 17, 2024
 Merged


Add support for ISOSDacInterface15 - MethodTable enumeration api
#4767
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e332209

Add support for ISOSDacInterface15


davidwrighton Jun 28, 2024
35928c9

Address feedback


davidwrighton Jul 16, 2024
dec93a4

Merge branch 'main' of https://github.com/dotnet/diagnostics into sos…


davidwrighton Jul 16, 2024
d883b49

Fix build breaks


davidwrighton Jul 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


110 changes: 66 additions & 44 deletions
src/SOS/Strike/strike.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1239,72 +1239,94 @@ DECLARE_API(DumpMT)

 if (bDumpMDTable)
 {
 table.ReInit(4, POINTERSIZE_HEX, AlignRight);
 table.ReInit(5, POINTERSIZE_HEX, AlignRight);
 table.SetColAlignment(3, AlignLeft);
 table.SetColWidth(2, 6);

 Print("--------------------------------------\n");
 Print("MethodDesc Table\n");

 table.WriteRow("Entry", "MethodDesc", "JIT", "Name");
 table.WriteRow("Entry", "MethodDesc", "JIT", "Slot", "Name");

 for (DWORD n = 0; n < vMethTable.wNumMethods; n++)
 ISOSMethodEnum *pMethodEnumerator;
 if (SUCCEEDED(g_sos15->GetMethodTableSlotEnumerator(dwStartAddr, &pMethodEnumerator)))
 {
 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 if (g_sos->GetMethodTableSlot(dwStartAddr, n, &entry) != S_OK)
 SOSMethodData entry;
 unsigned int fetched;
 while (SUCCEEDED(pMethodEnumerator->Next(1, &entry, &fetched)) && fetched != 0)
 {
 PrintLn("<error getting slot ", Decimal(n), ">");
 continue;
 }
 JITTypes jitType = TYPE_UNKNOWN;
 DWORD_PTR methodDesc = (DWORD_PTR)entry.MethodDesc;
 DWORD_PTR methodDescFromIP2MD = 0;
 DWORD_PTR gcinfoAddr = 0;

 if (entry.Entrypoint != 0)
 {
 IP2MethodDesc((DWORD_PTR)entry.Entrypoint, methodDescFromIP2MD, jitType, gcinfoAddr);
 if ((methodDescFromIP2MD != methodDesc) && methodDesc != 0)
 {
 ExtOut("MethodDesc from IP2MD does not match MethodDesc from enumerator\n");
 }
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);
 table.WriteColumn(0, entry);
 table.WriteColumn(1, MethodDescPtr(methodDesc));
 table.WriteColumn(0, entry.Entrypoint);
 table.WriteColumn(1, MethodDescPtr(methodDesc));

 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 }
 }
 }
 }

 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 pszJitType = "FCALL";
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 {
 pszJitType = "FCALL";
 }
 }
 }
 }

 table.WriteColumn(2, pszJitType);
 table.WriteColumn(2, pszJitType);
 table.WriteColumn(3, entry.Slot);

 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 table.WriteColumn(3, g_mdName);
 if (methodDesc != 0)
 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 else
 {
 DacpModuleData moduleData;
 if(moduleData.Request(g_sos, entry.DefiningModule)==S_OK)
 {
 NameForToken_s(&moduleData, entry.Token, g_mdName, mdNameLen, true);
 }
 else
 {
 _snwprintf_s(g_mdName, mdNameLen, _TRUNCATE, W("Unknown Module!%08x"), entry.Token);
 }
 }
 table.WriteColumn(4, g_mdName);
 }
 }
 }
 return Status;
Expand Down

156 changes: 156 additions & 0 deletions
src/SOS/Strike/util.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,7 @@ const char * const CorElementTypeNamespace[ELEMENT_TYPE_MAX]=

IXCLRDataProcess *g_clrData = NULL;
ISOSDacInterface *g_sos = NULL;
ISOSDacInterface15 *g_sos15 = NULL;

#ifndef IfFailRet
#define IfFailRet(EXPR) do { Status = (EXPR); if(FAILED(Status)) { return (Status); } } while (0)
Expand DownExpand Up@@ -3930,6 +3931,154 @@ void ResetGlobals(void)
 Output::ResetIndent();
}

class SOSDacInterface15Simulator : public ISOSDacInterface15
{
 class SOSMethodEnum : public ISOSMethodEnum
 {
 CLRDATA_ADDRESS pMT;
 unsigned int index;
 unsigned int slotCount;
 ULONG refCount;
 public:
 SOSMethodEnum(CLRDATA_ADDRESS mt) : pMT(mt), refCount(1)
 {
 }

 virtual ~SOSMethodEnum() {}

 virtual HRESULT STDMETHODCALLTYPE Reset()
 {
 index = 0;
 DacpMethodTableData vMethTable;
 HRESULT hr = vMethTable.Request(g_sos, pMT);
 if (FAILED(hr))
 return hr;

 slotCount = vMethTable.wNumMethods;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE GetCount(unsigned int *pc)
 {
 *pc = slotCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Skip(unsigned int skipCount)
 {
 index += skipCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Next( 
 /* [in] */ unsigned int count,
 /* [length_is][size_is][out] */ SOSMethodData methods[ ],
 /* [out] */ unsigned int *pFetched)
 {
 if (!pFetched)
 return E_POINTER;

 if (!methods)
 return E_POINTER;

 unsigned int i = 0;
 while (i < count && index < slotCount)
 {
 SOSMethodData methodData = { 0 };

 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 methodData.Slot = index;
 HRESULT hr = g_sos->GetMethodTableSlot(pMT, index++, &entry);
 if (hr != S_OK)
 {
 PrintLn("<error getting slot ", Decimal(index - 1), ">");
 continue;
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);

 methodData.MethodDesc = methodDesc;
 methodData.Entrypoint = entry;

 methods[i++] = methodData;
 }

 *pFetched = i;
 return i < count ? S_FALSE : S_OK;
 }

 STDMETHOD_(ULONG, AddRef)() { return ++refCount; }
 STDMETHOD_(ULONG, Release)()
 {
 --refCount;
 if (refCount == 0)
 {
 delete this;
 return 0;
 }
 return refCount;
 }

 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSMethodEnum)
 {
 *Interface = (ISOSMethodEnum*)this;
 AddRef();
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }
 };

public:
 STDMETHOD_(ULONG, AddRef)() { return 1; };
 STDMETHOD_(ULONG, Release)() { return 1; };
 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSDacInterface15)
 {
 *Interface = (ISOSDacInterface15*)this;
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }

 virtual HRESULT STDMETHODCALLTYPE GetMethodTableSlotEnumerator( 
 CLRDATA_ADDRESS mt,
 ISOSMethodEnum **enumerator)
 {
 SOSMethodEnum *simulator = new(std::nothrow) SOSMethodEnum(mt);
 *enumerator = simulator;
 if (simulator == NULL)
 {
 return E_OUTOFMEMORY;
 }
 HRESULT hr = simulator->Reset();
 if (FAILED(hr))
 {
 simulator->Release();
 }
 return hr;
 }
} SOSDacInterface15Simulator_Instance;

//---------------------------------------------------------------------------------------
//
// Loads private DAC interface, and points g_clrData to it.
Expand DownExpand Up@@ -3960,6 +4109,13 @@ HRESULT LoadClrDebugDll(void)
 g_sos = NULL;
 return hr;
 }

 // Always have an instance of the MethodTable enumerator
 hr = g_clrData->QueryInterface(__uuidof(ISOSDacInterface15), (void**)&g_sos15);
 if (FAILED(hr))
 {
 g_sos15 = &SOSDacInterface15Simulator_Instance;
 }
 return S_OK;
}

Expand Down

1 change: 1 addition & 0 deletions
src/SOS/Strike/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,6 +150,7 @@ enum EEFLAVOR {UNKNOWNEE, MSCOREE, MSCORWKS, MSCOREND};
#include "sospriv.h"
extern IXCLRDataProcess *g_clrData;
extern ISOSDacInterface *g_sos;
extern ISOSDacInterface15 *g_sos15;

#include "dacprivate.h"

Expand Down

43 changes: 43 additions & 0 deletions
src/shared/inc/sospriv.idl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -519,3 +519,46 @@ interface ISOSDacInterface14 : IUnknown
 HRESULT GetThreadStaticBaseAddress(CLRDATA_ADDRESS methodTable, CLRDATA_ADDRESS thread, CLRDATA_ADDRESS *nonGCStaticsAddress, CLRDATA_ADDRESS *GCStaticsAddress);
 HRESULT GetMethodTableInitializationFlags(CLRDATA_ADDRESS methodTable, MethodTableInitializationFlags *initializationStatus);
}

cpp_quote("#ifndef _SOS_MethodData")
cpp_quote("#define _SOS_MethodData")

typedef struct _SOSMethodData
{
 // At least one of MethodDesc, Entrypoint, or Token/DefiningMethodTable/DefiningModule is guaranteed to be set.
 // Multiple of them may be set as well
 CLRDATA_ADDRESS MethodDesc;

 CLRDATA_ADDRESS Entrypoint;

 CLRDATA_ADDRESS DefininingMethodTable; // Useful for when the method is inherited from a parent type which is instantiated
 CLRDATA_ADDRESS DefiningModule;
 unsigned int Token;

 // Slot data, a given MethodDesc may be present in multiple slots for a single MethodTable
 unsigned int Slot; // Will be set to 0xFFFFFFFF for EnC added methods
} SOSMethodData;

cpp_quote("#endif //_SOS_MethodData")

[
 object,
 local,
 uuid(3c0fe725-c324-4a4f-8100-d399588a662e)
]
interface ISOSMethodEnum : ISOSEnum
{
 HRESULT Next([in] unsigned int count,
 [out, size_is(count), length_is(*pNeeded)] SOSMethodData handles[],
 [out] unsigned int *pNeeded);
}

[
 object,
 local,
 uuid(7ed81261-52a9-4a23-a358-c3313dea30a8)
]
interface ISOSDacInterface15 : IUnknown
{
 HRESULT GetMethodTableSlotEnumerator(CLRDATA_ADDRESS mt, ISOSMethodEnum **enumerator);
}

6 changes: 6 additions & 0 deletions
src/shared/pal/prebuilt/idl/sospriv_i.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,12 @@ MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface13,0x3176a8ed,0x597b,0x4f54,0xa7,0x1f,

MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface14,0x9aa22aca,0x6dc6,0x4a0c,0xb4,0xe0,0x70,0xd2,0x41,0x6b,0x98,0x37);


MIDL_DEFINE_GUID(IID, IID_ISOSMethodEnum,0x3c0fe725,0xc324,0x4a4f,0x81,0x00,0xd3,0x99,0x58,0x8a,0x66,0x2e);


MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface15,0x7ed81261,0x52a9,0x4a23,0xa3,0x58,0xc3,0x31,0x3d,0xea,0x30,0xa8);

#undef MIDL_DEFINE_GUID

#ifdef __cplusplus
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add support for ISOSDacInterface15 - MethodTable enumeration api by davidwrighton · Pull Request #4767 · dotnet/diagnostics · GitHub
Skip to content
Add support for ISOSDacInterface15 - MethodTable enumeration api#4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

davidwrighton
merged 4 commits into

from

Jul 17, 2024
 Merged


Add support for ISOSDacInterface15 - MethodTable enumeration api
#4767
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e332209

Add support for ISOSDacInterface15


davidwrighton Jun 28, 2024
35928c9

Address feedback


davidwrighton Jul 16, 2024
dec93a4

Merge branch 'main' of https://github.com/dotnet/diagnostics into sos…


davidwrighton Jul 16, 2024
d883b49

Fix build breaks


davidwrighton Jul 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


110 changes: 66 additions & 44 deletions
src/SOS/Strike/strike.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1239,72 +1239,94 @@ DECLARE_API(DumpMT)

 if (bDumpMDTable)
 {
 table.ReInit(4, POINTERSIZE_HEX, AlignRight);
 table.ReInit(5, POINTERSIZE_HEX, AlignRight);
 table.SetColAlignment(3, AlignLeft);
 table.SetColWidth(2, 6);

 Print("--------------------------------------\n");
 Print("MethodDesc Table\n");

 table.WriteRow("Entry", "MethodDesc", "JIT", "Name");
 table.WriteRow("Entry", "MethodDesc", "JIT", "Slot", "Name");

 for (DWORD n = 0; n < vMethTable.wNumMethods; n++)
 ISOSMethodEnum *pMethodEnumerator;
 if (SUCCEEDED(g_sos15->GetMethodTableSlotEnumerator(dwStartAddr, &pMethodEnumerator)))
 {
 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 if (g_sos->GetMethodTableSlot(dwStartAddr, n, &entry) != S_OK)
 SOSMethodData entry;
 unsigned int fetched;
 while (SUCCEEDED(pMethodEnumerator->Next(1, &entry, &fetched)) && fetched != 0)
 {
 PrintLn("<error getting slot ", Decimal(n), ">");
 continue;
 }
 JITTypes jitType = TYPE_UNKNOWN;
 DWORD_PTR methodDesc = (DWORD_PTR)entry.MethodDesc;
 DWORD_PTR methodDescFromIP2MD = 0;
 DWORD_PTR gcinfoAddr = 0;

 if (entry.Entrypoint != 0)
 {
 IP2MethodDesc((DWORD_PTR)entry.Entrypoint, methodDescFromIP2MD, jitType, gcinfoAddr);
 if ((methodDescFromIP2MD != methodDesc) && methodDesc != 0)
 {
 ExtOut("MethodDesc from IP2MD does not match MethodDesc from enumerator\n");
 }
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);
 table.WriteColumn(0, entry);
 table.WriteColumn(1, MethodDescPtr(methodDesc));
 table.WriteColumn(0, entry.Entrypoint);
 table.WriteColumn(1, MethodDescPtr(methodDesc));

 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 }
 }
 }
 }

 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 pszJitType = "FCALL";
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 {
 pszJitType = "FCALL";
 }
 }
 }
 }

 table.WriteColumn(2, pszJitType);
 table.WriteColumn(2, pszJitType);
 table.WriteColumn(3, entry.Slot);

 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 table.WriteColumn(3, g_mdName);
 if (methodDesc != 0)
 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 else
 {
 DacpModuleData moduleData;
 if(moduleData.Request(g_sos, entry.DefiningModule)==S_OK)
 {
 NameForToken_s(&moduleData, entry.Token, g_mdName, mdNameLen, true);
 }
 else
 {
 _snwprintf_s(g_mdName, mdNameLen, _TRUNCATE, W("Unknown Module!%08x"), entry.Token);
 }
 }
 table.WriteColumn(4, g_mdName);
 }
 }
 }
 return Status;
Expand Down

156 changes: 156 additions & 0 deletions
src/SOS/Strike/util.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,7 @@ const char * const CorElementTypeNamespace[ELEMENT_TYPE_MAX]=

IXCLRDataProcess *g_clrData = NULL;
ISOSDacInterface *g_sos = NULL;
ISOSDacInterface15 *g_sos15 = NULL;

#ifndef IfFailRet
#define IfFailRet(EXPR) do { Status = (EXPR); if(FAILED(Status)) { return (Status); } } while (0)
Expand DownExpand Up@@ -3930,6 +3931,154 @@ void ResetGlobals(void)
 Output::ResetIndent();
}

class SOSDacInterface15Simulator : public ISOSDacInterface15
{
 class SOSMethodEnum : public ISOSMethodEnum
 {
 CLRDATA_ADDRESS pMT;
 unsigned int index;
 unsigned int slotCount;
 ULONG refCount;
 public:
 SOSMethodEnum(CLRDATA_ADDRESS mt) : pMT(mt), refCount(1)
 {
 }

 virtual ~SOSMethodEnum() {}

 virtual HRESULT STDMETHODCALLTYPE Reset()
 {
 index = 0;
 DacpMethodTableData vMethTable;
 HRESULT hr = vMethTable.Request(g_sos, pMT);
 if (FAILED(hr))
 return hr;

 slotCount = vMethTable.wNumMethods;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE GetCount(unsigned int *pc)
 {
 *pc = slotCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Skip(unsigned int skipCount)
 {
 index += skipCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Next( 
 /* [in] */ unsigned int count,
 /* [length_is][size_is][out] */ SOSMethodData methods[ ],
 /* [out] */ unsigned int *pFetched)
 {
 if (!pFetched)
 return E_POINTER;

 if (!methods)
 return E_POINTER;

 unsigned int i = 0;
 while (i < count && index < slotCount)
 {
 SOSMethodData methodData = { 0 };

 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 methodData.Slot = index;
 HRESULT hr = g_sos->GetMethodTableSlot(pMT, index++, &entry);
 if (hr != S_OK)
 {
 PrintLn("<error getting slot ", Decimal(index - 1), ">");
 continue;
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);

 methodData.MethodDesc = methodDesc;
 methodData.Entrypoint = entry;

 methods[i++] = methodData;
 }

 *pFetched = i;
 return i < count ? S_FALSE : S_OK;
 }

 STDMETHOD_(ULONG, AddRef)() { return ++refCount; }
 STDMETHOD_(ULONG, Release)()
 {
 --refCount;
 if (refCount == 0)
 {
 delete this;
 return 0;
 }
 return refCount;
 }

 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSMethodEnum)
 {
 *Interface = (ISOSMethodEnum*)this;
 AddRef();
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }
 };

public:
 STDMETHOD_(ULONG, AddRef)() { return 1; };
 STDMETHOD_(ULONG, Release)() { return 1; };
 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSDacInterface15)
 {
 *Interface = (ISOSDacInterface15*)this;
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }

 virtual HRESULT STDMETHODCALLTYPE GetMethodTableSlotEnumerator( 
 CLRDATA_ADDRESS mt,
 ISOSMethodEnum **enumerator)
 {
 SOSMethodEnum *simulator = new(std::nothrow) SOSMethodEnum(mt);
 *enumerator = simulator;
 if (simulator == NULL)
 {
 return E_OUTOFMEMORY;
 }
 HRESULT hr = simulator->Reset();
 if (FAILED(hr))
 {
 simulator->Release();
 }
 return hr;
 }
} SOSDacInterface15Simulator_Instance;

//---------------------------------------------------------------------------------------
//
// Loads private DAC interface, and points g_clrData to it.
Expand DownExpand Up@@ -3960,6 +4109,13 @@ HRESULT LoadClrDebugDll(void)
 g_sos = NULL;
 return hr;
 }

 // Always have an instance of the MethodTable enumerator
 hr = g_clrData->QueryInterface(__uuidof(ISOSDacInterface15), (void**)&g_sos15);
 if (FAILED(hr))
 {
 g_sos15 = &SOSDacInterface15Simulator_Instance;
 }
 return S_OK;
}

Expand Down

1 change: 1 addition & 0 deletions
src/SOS/Strike/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,6 +150,7 @@ enum EEFLAVOR {UNKNOWNEE, MSCOREE, MSCORWKS, MSCOREND};
#include "sospriv.h"
extern IXCLRDataProcess *g_clrData;
extern ISOSDacInterface *g_sos;
extern ISOSDacInterface15 *g_sos15;

#include "dacprivate.h"

Expand Down

43 changes: 43 additions & 0 deletions
src/shared/inc/sospriv.idl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -519,3 +519,46 @@ interface ISOSDacInterface14 : IUnknown
 HRESULT GetThreadStaticBaseAddress(CLRDATA_ADDRESS methodTable, CLRDATA_ADDRESS thread, CLRDATA_ADDRESS *nonGCStaticsAddress, CLRDATA_ADDRESS *GCStaticsAddress);
 HRESULT GetMethodTableInitializationFlags(CLRDATA_ADDRESS methodTable, MethodTableInitializationFlags *initializationStatus);
}

cpp_quote("#ifndef _SOS_MethodData")
cpp_quote("#define _SOS_MethodData")

typedef struct _SOSMethodData
{
 // At least one of MethodDesc, Entrypoint, or Token/DefiningMethodTable/DefiningModule is guaranteed to be set.
 // Multiple of them may be set as well
 CLRDATA_ADDRESS MethodDesc;

 CLRDATA_ADDRESS Entrypoint;

 CLRDATA_ADDRESS DefininingMethodTable; // Useful for when the method is inherited from a parent type which is instantiated
 CLRDATA_ADDRESS DefiningModule;
 unsigned int Token;

 // Slot data, a given MethodDesc may be present in multiple slots for a single MethodTable
 unsigned int Slot; // Will be set to 0xFFFFFFFF for EnC added methods
} SOSMethodData;

cpp_quote("#endif //_SOS_MethodData")

[
 object,
 local,
 uuid(3c0fe725-c324-4a4f-8100-d399588a662e)
]
interface ISOSMethodEnum : ISOSEnum
{
 HRESULT Next([in] unsigned int count,
 [out, size_is(count), length_is(*pNeeded)] SOSMethodData handles[],
 [out] unsigned int *pNeeded);
}

[
 object,
 local,
 uuid(7ed81261-52a9-4a23-a358-c3313dea30a8)
]
interface ISOSDacInterface15 : IUnknown
{
 HRESULT GetMethodTableSlotEnumerator(CLRDATA_ADDRESS mt, ISOSMethodEnum **enumerator);
}

6 changes: 6 additions & 0 deletions
src/shared/pal/prebuilt/idl/sospriv_i.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,12 @@ MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface13,0x3176a8ed,0x597b,0x4f54,0xa7,0x1f,

MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface14,0x9aa22aca,0x6dc6,0x4a0c,0xb4,0xe0,0x70,0xd2,0x41,0x6b,0x98,0x37);


MIDL_DEFINE_GUID(IID, IID_ISOSMethodEnum,0x3c0fe725,0xc324,0x4a4f,0x81,0x00,0xd3,0x99,0x58,0x8a,0x66,0x2e);


MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface15,0x7ed81261,0x52a9,0x4a23,0xa3,0x58,0xc3,0x31,0x3d,0xea,0x30,0xa8);

#undef MIDL_DEFINE_GUID

#ifdef __cplusplus
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add support for ISOSDacInterface15 - MethodTable enumeration api by davidwrighton · Pull Request #4767 · dotnet/diagnostics · GitHub
Skip to content
Add support for ISOSDacInterface15 - MethodTable enumeration api#4767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

davidwrighton
merged 4 commits into

from

Jul 17, 2024
 Merged


Add support for ISOSDacInterface15 - MethodTable enumeration api
#4767
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


4 commits


Select commit
Hold shift + click to select a range
e332209

Add support for ISOSDacInterface15


davidwrighton Jun 28, 2024
35928c9

Address feedback


davidwrighton Jul 16, 2024
dec93a4

Merge branch 'main' of https://github.com/dotnet/diagnostics into sos…


davidwrighton Jul 16, 2024
d883b49

Fix build breaks


davidwrighton Jul 16, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


110 changes: 66 additions & 44 deletions
src/SOS/Strike/strike.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1239,72 +1239,94 @@ DECLARE_API(DumpMT)

 if (bDumpMDTable)
 {
 table.ReInit(4, POINTERSIZE_HEX, AlignRight);
 table.ReInit(5, POINTERSIZE_HEX, AlignRight);
 table.SetColAlignment(3, AlignLeft);
 table.SetColWidth(2, 6);

 Print("--------------------------------------\n");
 Print("MethodDesc Table\n");

 table.WriteRow("Entry", "MethodDesc", "JIT", "Name");
 table.WriteRow("Entry", "MethodDesc", "JIT", "Slot", "Name");

 for (DWORD n = 0; n < vMethTable.wNumMethods; n++)
 ISOSMethodEnum *pMethodEnumerator;
 if (SUCCEEDED(g_sos15->GetMethodTableSlotEnumerator(dwStartAddr, &pMethodEnumerator)))
 {
 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 if (g_sos->GetMethodTableSlot(dwStartAddr, n, &entry) != S_OK)
 SOSMethodData entry;
 unsigned int fetched;
 while (SUCCEEDED(pMethodEnumerator->Next(1, &entry, &fetched)) && fetched != 0)
 {
 PrintLn("<error getting slot ", Decimal(n), ">");
 continue;
 }
 JITTypes jitType = TYPE_UNKNOWN;
 DWORD_PTR methodDesc = (DWORD_PTR)entry.MethodDesc;
 DWORD_PTR methodDescFromIP2MD = 0;
 DWORD_PTR gcinfoAddr = 0;

 if (entry.Entrypoint != 0)
 {
 IP2MethodDesc((DWORD_PTR)entry.Entrypoint, methodDescFromIP2MD, jitType, gcinfoAddr);
 if ((methodDescFromIP2MD != methodDesc) && methodDesc != 0)
 {
 ExtOut("MethodDesc from IP2MD does not match MethodDesc from enumerator\n");
 }
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);
 table.WriteColumn(0, entry);
 table.WriteColumn(1, MethodDescPtr(methodDesc));
 table.WriteColumn(0, entry.Entrypoint);
 table.WriteColumn(1, MethodDescPtr(methodDesc));

 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 if (jitType == TYPE_UNKNOWN && methodDesc != (TADDR)0)
 {
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 // We can get a more accurate jitType from NativeCodeAddr of the methoddesc,
 // because the methodtable entry hasn't always been patched.
 DacpMethodDescData tmpMethodDescData;
 if (tmpMethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 DacpCodeHeaderData codeHeaderData;
 if (codeHeaderData.Request(g_sos,tmpMethodDescData.NativeCodeAddr) == S_OK)
 {
 jitType = (JITTypes) codeHeaderData.JITType;
 }
 }
 }
 }

 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 const char *pszJitType = "NONE";
 if (jitType == TYPE_JIT)
 pszJitType = "JIT";
 else if (jitType == TYPE_PJIT)
 pszJitType = "PreJIT";
 else
 {
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 DacpMethodDescData MethodDescData;
 if (MethodDescData.Request(g_sos, TO_CDADDR(methodDesc)) == S_OK)
 {
 pszJitType = "FCALL";
 // Is it an fcall?
 ULONG64 baseAddress = g_pRuntime->GetModuleAddress();
 ULONG64 size = g_pRuntime->GetModuleSize();
 if ((TO_TADDR(MethodDescData.NativeCodeAddr) >= TO_TADDR(baseAddress)) &&
 ((TO_TADDR(MethodDescData.NativeCodeAddr) < TO_TADDR(baseAddress + size))))
 {
 pszJitType = "FCALL";
 }
 }
 }
 }

 table.WriteColumn(2, pszJitType);
 table.WriteColumn(2, pszJitType);
 table.WriteColumn(3, entry.Slot);

 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 table.WriteColumn(3, g_mdName);
 if (methodDesc != 0)
 NameForMD_s(methodDesc,g_mdName,mdNameLen);
 else
 {
 DacpModuleData moduleData;
 if(moduleData.Request(g_sos, entry.DefiningModule)==S_OK)
 {
 NameForToken_s(&moduleData, entry.Token, g_mdName, mdNameLen, true);
 }
 else
 {
 _snwprintf_s(g_mdName, mdNameLen, _TRUNCATE, W("Unknown Module!%08x"), entry.Token);
 }
 }
 table.WriteColumn(4, g_mdName);
 }
 }
 }
 return Status;
Expand Down

156 changes: 156 additions & 0 deletions
src/SOS/Strike/util.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -59,6 +59,7 @@ const char * const CorElementTypeNamespace[ELEMENT_TYPE_MAX]=

IXCLRDataProcess *g_clrData = NULL;
ISOSDacInterface *g_sos = NULL;
ISOSDacInterface15 *g_sos15 = NULL;

#ifndef IfFailRet
#define IfFailRet(EXPR) do { Status = (EXPR); if(FAILED(Status)) { return (Status); } } while (0)
Expand DownExpand Up@@ -3930,6 +3931,154 @@ void ResetGlobals(void)
 Output::ResetIndent();
}

class SOSDacInterface15Simulator : public ISOSDacInterface15
{
 class SOSMethodEnum : public ISOSMethodEnum
 {
 CLRDATA_ADDRESS pMT;
 unsigned int index;
 unsigned int slotCount;
 ULONG refCount;
 public:
 SOSMethodEnum(CLRDATA_ADDRESS mt) : pMT(mt), refCount(1)
 {
 }

 virtual ~SOSMethodEnum() {}

 virtual HRESULT STDMETHODCALLTYPE Reset()
 {
 index = 0;
 DacpMethodTableData vMethTable;
 HRESULT hr = vMethTable.Request(g_sos, pMT);
 if (FAILED(hr))
 return hr;

 slotCount = vMethTable.wNumMethods;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE GetCount(unsigned int *pc)
 {
 *pc = slotCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Skip(unsigned int skipCount)
 {
 index += skipCount;
 return S_OK;
 }

 virtual HRESULT STDMETHODCALLTYPE Next( 
 /* [in] */ unsigned int count,
 /* [length_is][size_is][out] */ SOSMethodData methods[ ],
 /* [out] */ unsigned int *pFetched)
 {
 if (!pFetched)
 return E_POINTER;

 if (!methods)
 return E_POINTER;

 unsigned int i = 0;
 while (i < count && index < slotCount)
 {
 SOSMethodData methodData = { 0 };

 JITTypes jitType;
 DWORD_PTR methodDesc=0;
 DWORD_PTR gcinfoAddr;

 CLRDATA_ADDRESS entry;
 methodData.Slot = index;
 HRESULT hr = g_sos->GetMethodTableSlot(pMT, index++, &entry);
 if (hr != S_OK)
 {
 PrintLn("<error getting slot ", Decimal(index - 1), ">");
 continue;
 }

 IP2MethodDesc((DWORD_PTR)entry, methodDesc, jitType, gcinfoAddr);

 methodData.MethodDesc = methodDesc;
 methodData.Entrypoint = entry;

 methods[i++] = methodData;
 }

 *pFetched = i;
 return i < count ? S_FALSE : S_OK;
 }

 STDMETHOD_(ULONG, AddRef)() { return ++refCount; }
 STDMETHOD_(ULONG, Release)()
 {
 --refCount;
 if (refCount == 0)
 {
 delete this;
 return 0;
 }
 return refCount;
 }

 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSMethodEnum)
 {
 *Interface = (ISOSMethodEnum*)this;
 AddRef();
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }
 };

public:
 STDMETHOD_(ULONG, AddRef)() { return 1; };
 STDMETHOD_(ULONG, Release)() { return 1; };
 STDMETHOD(QueryInterface)(
 THIS_
 ___in REFIID InterfaceId,
 ___out PVOID* Interface
 )
 {
 if (InterfaceId == IID_IUnknown ||
 InterfaceId == IID_ISOSDacInterface15)
 {
 *Interface = (ISOSDacInterface15*)this;
 return S_OK;
 }
 *Interface = NULL;
 return E_NOINTERFACE;
 }

 virtual HRESULT STDMETHODCALLTYPE GetMethodTableSlotEnumerator( 
 CLRDATA_ADDRESS mt,
 ISOSMethodEnum **enumerator)
 {
 SOSMethodEnum *simulator = new(std::nothrow) SOSMethodEnum(mt);
 *enumerator = simulator;
 if (simulator == NULL)
 {
 return E_OUTOFMEMORY;
 }
 HRESULT hr = simulator->Reset();
 if (FAILED(hr))
 {
 simulator->Release();
 }
 return hr;
 }
} SOSDacInterface15Simulator_Instance;

//---------------------------------------------------------------------------------------
//
// Loads private DAC interface, and points g_clrData to it.
Expand DownExpand Up@@ -3960,6 +4109,13 @@ HRESULT LoadClrDebugDll(void)
 g_sos = NULL;
 return hr;
 }

 // Always have an instance of the MethodTable enumerator
 hr = g_clrData->QueryInterface(__uuidof(ISOSDacInterface15), (void**)&g_sos15);
 if (FAILED(hr))
 {
 g_sos15 = &SOSDacInterface15Simulator_Instance;
 }
 return S_OK;
}

Expand Down

1 change: 1 addition & 0 deletions
src/SOS/Strike/util.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -150,6 +150,7 @@ enum EEFLAVOR {UNKNOWNEE, MSCOREE, MSCORWKS, MSCOREND};
#include "sospriv.h"
extern IXCLRDataProcess *g_clrData;
extern ISOSDacInterface *g_sos;
extern ISOSDacInterface15 *g_sos15;

#include "dacprivate.h"

Expand Down

43 changes: 43 additions & 0 deletions
src/shared/inc/sospriv.idl

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -519,3 +519,46 @@ interface ISOSDacInterface14 : IUnknown
 HRESULT GetThreadStaticBaseAddress(CLRDATA_ADDRESS methodTable, CLRDATA_ADDRESS thread, CLRDATA_ADDRESS *nonGCStaticsAddress, CLRDATA_ADDRESS *GCStaticsAddress);
 HRESULT GetMethodTableInitializationFlags(CLRDATA_ADDRESS methodTable, MethodTableInitializationFlags *initializationStatus);
}

cpp_quote("#ifndef _SOS_MethodData")
cpp_quote("#define _SOS_MethodData")

typedef struct _SOSMethodData
{
 // At least one of MethodDesc, Entrypoint, or Token/DefiningMethodTable/DefiningModule is guaranteed to be set.
 // Multiple of them may be set as well
 CLRDATA_ADDRESS MethodDesc;

 CLRDATA_ADDRESS Entrypoint;

 CLRDATA_ADDRESS DefininingMethodTable; // Useful for when the method is inherited from a parent type which is instantiated
 CLRDATA_ADDRESS DefiningModule;
 unsigned int Token;

 // Slot data, a given MethodDesc may be present in multiple slots for a single MethodTable
 unsigned int Slot; // Will be set to 0xFFFFFFFF for EnC added methods
} SOSMethodData;

cpp_quote("#endif //_SOS_MethodData")

[
 object,
 local,
 uuid(3c0fe725-c324-4a4f-8100-d399588a662e)
]
interface ISOSMethodEnum : ISOSEnum
{
 HRESULT Next([in] unsigned int count,
 [out, size_is(count), length_is(*pNeeded)] SOSMethodData handles[],
 [out] unsigned int *pNeeded);
}

[
 object,
 local,
 uuid(7ed81261-52a9-4a23-a358-c3313dea30a8)
]
interface ISOSDacInterface15 : IUnknown
{
 HRESULT GetMethodTableSlotEnumerator(CLRDATA_ADDRESS mt, ISOSMethodEnum **enumerator);
}

6 changes: 6 additions & 0 deletions
src/shared/pal/prebuilt/idl/sospriv_i.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -121,6 +121,12 @@ MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface13,0x3176a8ed,0x597b,0x4f54,0xa7,0x1f,

MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface14,0x9aa22aca,0x6dc6,0x4a0c,0xb4,0xe0,0x70,0xd2,0x41,0x6b,0x98,0x37);


MIDL_DEFINE_GUID(IID, IID_ISOSMethodEnum,0x3c0fe725,0xc324,0x4a4f,0x81,0x00,0xd3,0x99,0x58,0x8a,0x66,0x2e);


MIDL_DEFINE_GUID(IID, IID_ISOSDacInterface15,0x7ed81261,0x52a9,0x4a23,0xa3,0x58,0xc3,0x31,0x3d,0xea,0x30,0xa8);

#undef MIDL_DEFINE_GUID

#ifdef __cplusplus
Expand Down
Loading