[cDAC] Implement basic stackwalking #111759
+2,376
−114
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| # Contract StackWalk | ||
|
|
||
| This contract encapsulates support for StackWalking managed threads. | ||
|
|
||
| ## APIs of contract | ||
|
|
||
| ```csharp | ||
| public interface IStackWalkHandle { }; | ||
| public interface IStackDataFrameHandle { }; | ||
| ``` | ||
|
|
||
| ```csharp | ||
| // Creates a stack walk and returns a handle | ||
| IStackWalkHandle CreateStackWalk(ThreadData threadData); | ||
| // Iterates the stackWalkHandle to the next frame. If successful, returns true. Otherwise false. | ||
| bool Next(IStackWalkHandle stackWalkHandle); | ||
| // Gets the current frame from a stack walk and returns a IStackDataFrameHandle to it. | ||
| IStackDataFrameHandle GetCurrentFrame(IStackWalkHandle stackWalkHandle); | ||
max-charlamb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // Gets the thread context at the given stack dataframe. | ||
| byte[] GetRawContext(IStackDataFrameHandle stackDataFrameHandle); | ||
| // Gets the Frame address at the given stack dataframe. Returns TargetPointer.Null if the current dataframe does not have a valid Frame. | ||
| TargetPointer GetFrameAddress(IStackDataFrameHandle stackDataFrameHandle); | ||
| ``` | ||
|
|
||
| ## Version 1 | ||
|
|
||
| The `StackWalk` contract provides an interface for walking the stack of a managed thread. It includes methods to create a stack walk, move to the next frame, get the current frame, retrieve the raw context, and get the frame address. | ||
|
|
||
| ### CreateStackWalk | ||
|
|
||
| ```csharp | ||
| IStackWalkHandle CreateStackWalk(ThreadData threadData); | ||
| ``` | ||
|
|
||
| Creates a stack walk handle for the given thread data. This initializes the context and frame iterator for the stack walk. | ||
|
There was a problem hiding this comment. I don't see documentation about how to do all of this. We need that before we can actually merge this change, not just C# implementation in the actual cDAC codebase. Where we use the a well documented standard like the Win32 unwinder, you can just drop in a link, but for everything else... it needs correct documentation/algorithms |
||
|
|
||
| ### Next | ||
|
|
||
| ```csharp | ||
| bool Next(IStackWalkHandle stackWalkHandle); | ||
| ``` | ||
|
|
||
| Moves to the next frame in the stack walk. Returns `true` if successfully moved to the next frame. Otherwise returns `false`. | ||
|
|
||
| ### GetCurrentFrame | ||
|
|
||
| ```csharp | ||
| IStackDataFrameHandle GetCurrentFrame(IStackWalkHandle stackWalkHandle); | ||
| ``` | ||
|
|
||
| Gets the current frame in the stack walk. Returns a handle to the stack data frame. | ||
|
|
||
| ### GetRawContext | ||
|
|
||
| ```csharp | ||
| byte[] GetRawContext(IStackDataFrameHandle stackDataFrameHandle); | ||
| ``` | ||
|
|
||
| Retrieves the raw Windows thread context of the current frame as a byte array. The size and shape of the context is platform dependent. See [CONTEXT structure](https://learn.microsoft.com/en-us/windows/win32/api/winnt/ns-winnt-context) for more info. | ||
|
|
||
| ### GetFrameAddress | ||
|
|
||
| ```csharp | ||
| TargetPointer GetFrameAddress(IStackDataFrameHandle stackDataFrameHandle); | ||
| ``` | ||
|
|
||
| Gets the frame address of the current frame. Returns `TargetPointer.Null` if the frame is not valid. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -367,7 +367,7 @@ extends: | |
| - windows_x64 | ||
| jobParameters: | ||
| templatePath: 'templates-official' | ||
| buildArgs: -s tools.illink+libs -pack -c $(_BuildConfig) /p:TestAssemblies=false /p:TestPackages=true | ||
|
There was a problem hiding this comment. Discussed with @jkoritzinsky , cDAC should not currently be built in the |
||
| nameSuffix: Libraries_WithPackages | ||
| isOfficialBuild: ${{ variables.isOfficialBuild }} | ||
| postBuildSteps: | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -20,5 +20,6 @@ | |
| "PrecodeStubs": 1, | ||
| "ReJIT": 1, | ||
| "RuntimeTypeSystem": 1, | ||
| "StackWalk": 1, | ||
| "Thread": 1 | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,31 +1,92 @@ | ||
| set(UNWINDER_SOURCES | ||
| baseunwinder.cpp | ||
| ${ARCH_SOURCES_DIR}/unwinder.cpp | ||
| ) | ||
|
|
||
| convert_to_absolute_path(UNWINDER_SOURCES ${UNWINDER_SOURCES}) | ||
|
|
||
| if(CLR_CMAKE_HOST_UNIX) | ||
| add_library_clr(unwinder_wks OBJECT ${UNWINDER_SOURCES}) | ||
| target_include_directories(unwinder_wks BEFORE PRIVATE ${VM_DIR}) | ||
| target_include_directories(unwinder_wks BEFORE PRIVATE ${VM_DIR}/${ARCH_SOURCES_DIR}) | ||
max-charlamb marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| target_include_directories(unwinder_wks BEFORE PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) | ||
| target_include_directories(unwinder_wks BEFORE PRIVATE ${CLR_DIR}/unwinder) | ||
| target_include_directories(unwinder_wks PRIVATE ${CLR_DIR}/debug/ee) | ||
| target_include_directories(unwinder_wks PRIVATE ${CLR_DIR}/gc) | ||
| target_include_directories(unwinder_wks PRIVATE ${CLR_DIR}/gcdump) | ||
| target_include_directories(unwinder_wks PRIVATE ${CLR_DIR}/debug/daccess) | ||
| target_include_directories(unwinder_wks PRIVATE ${ARCH_SOURCES_DIR}) | ||
| add_dependencies(unwinder_wks eventing_headers) | ||
| endif(CLR_CMAKE_HOST_UNIX) | ||
|
|
||
| add_library_clr(unwinder_dac ${UNWINDER_SOURCES}) | ||
| target_include_directories(unwinder_dac BEFORE PRIVATE ${VM_DIR}) | ||
| target_include_directories(unwinder_dac BEFORE PRIVATE ${VM_DIR}/${ARCH_SOURCES_DIR}) | ||
| target_include_directories(unwinder_dac BEFORE PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) | ||
| target_include_directories(unwinder_dac BEFORE PRIVATE ${CLR_DIR}/unwinder) | ||
| target_include_directories(unwinder_dac PRIVATE ${CLR_DIR}/debug/ee) | ||
| target_include_directories(unwinder_dac PRIVATE ${CLR_DIR}/gc) | ||
| target_include_directories(unwinder_dac PRIVATE ${CLR_DIR}/gcdump) | ||
| target_include_directories(unwinder_dac PRIVATE ${CLR_DIR}/debug/daccess) | ||
| target_include_directories(unwinder_dac PRIVATE ${ARCH_SOURCES_DIR}) | ||
| add_dependencies(unwinder_dac eventing_headers) | ||
| set_target_properties(unwinder_dac PROPERTIES DAC_COMPONENT TRUE) | ||
| target_compile_definitions(unwinder_dac PRIVATE FEATURE_NO_HOST) | ||
|
|
||
| # Helper function for platform specific cDAC uwninder builds. | ||
| function(create_platform_unwinder) | ||
| set(oneValueArgs TARGET ARCH) | ||
| set(multiValueArgs DESTINATIONS) | ||
| cmake_parse_arguments(TARGETDETAILS "" "${oneValueArgs}" "${multiValueArgs}" ${ARGN}) | ||
|
|
||
| if(TARGETDETAILS_ARCH STREQUAL "x64") | ||
| set(ARCH_SOURCES_DIR amd64) | ||
| elseif((TARGETDETAILS_ARCH STREQUAL "arm") OR (TARGETDETAILS_ARCH STREQUAL "armel")) | ||
| set(ARCH_SOURCES_DIR arm) | ||
| elseif(TARGETDETAILS_ARCH STREQUAL "x86") | ||
| set(ARCH_SOURCES_DIR i386) | ||
| elseif(TARGETDETAILS_ARCH STREQUAL "arm64") | ||
| set(ARCH_SOURCES_DIR arm64) | ||
| else() | ||
| clr_unknown_arch() | ||
| endif() | ||
|
|
||
| set(UNWINDER_SOURCES | ||
| baseunwinder.cpp | ||
| ${ARCH_SOURCES_DIR}/unwinder.cpp | ||
| ) | ||
|
|
||
| convert_to_absolute_path(UNWINDER_SOURCES ${UNWINDER_SOURCES}) | ||
|
|
||
| add_library_clr(${TARGETDETAILS_TARGET} | ||
| SHARED | ||
| ${UNWINDER_SOURCES} | ||
| ) | ||
|
|
||
| target_include_directories(${TARGETDETAILS_TARGET} BEFORE PRIVATE ${VM_DIR}) | ||
| target_include_directories(${TARGETDETAILS_TARGET} BEFORE PRIVATE ${VM_DIR}/${ARCH_SOURCES_DIR}) | ||
| target_include_directories(${TARGETDETAILS_TARGET} BEFORE PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) | ||
| target_include_directories(${TARGETDETAILS_TARGET} BEFORE PRIVATE ${CLR_DIR}/unwinder) | ||
| target_include_directories(${TARGETDETAILS_TARGET} PRIVATE ${CLR_DIR}/debug/ee) | ||
| target_include_directories(${TARGETDETAILS_TARGET} PRIVATE ${CLR_DIR}/gc) | ||
| target_include_directories(${TARGETDETAILS_TARGET} PRIVATE ${CLR_DIR}/gcdump) | ||
| target_include_directories(${TARGETDETAILS_TARGET} PRIVATE ${CLR_DIR}/debug/daccess) | ||
| target_include_directories(${TARGETDETAILS_TARGET} PRIVATE ${ARCH_SOURCES_DIR}) | ||
|
|
||
| target_link_libraries(${TARGETDETAILS_TARGET} PRIVATE ${STATIC_MT_CRT_LIB} ${STATIC_MT_VCRT_LIB}) | ||
|
|
||
| # add the install targets | ||
| install_clr(TARGETS ${TARGETDETAILS_TARGET} DESTINATIONS ${TARGETDETAILS_DESTINATIONS} COMPONENT debug INSTALL_ALL_ARTIFACTS) | ||
|
|
||
| # Set the target to be built for the specified OS and ARCH | ||
| set_target_definitions_to_custom_os_and_arch(TARGET ${TARGETDETAILS_TARGET} OS win ARCH ${TARGETDETAILS_ARCH}) | ||
|
|
||
| target_compile_definitions(${TARGETDETAILS_TARGET} PRIVATE FEATURE_NO_HOST FEATURE_CDAC_UNWINDER) | ||
| endfunction() | ||
|
|
||
| # TODO: Support building cDAC unwinders on other platforms | ||
| # https://github.com/dotnet/runtime/issues/112272#issue-2838611496 | ||
| if(CLR_CMAKE_TARGET_WIN32 AND CLR_CMAKE_TARGET_ARCH_AMD64) | ||
| create_platform_unwinder(TARGET unwinder_cdac_amd64 ARCH x64 DESTINATIONS cdaclibs) | ||
| create_platform_unwinder(TARGET unwinder_cdac_arm64 ARCH arm64 DESTINATIONS cdaclibs) | ||
| endif(CLR_CMAKE_TARGET_WIN32 AND CLR_CMAKE_TARGET_ARCH_AMD64) | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't like this naming/meaning. Looking closer at this, this concept of "module" isn't used anywhere else in the documentation. Other parts of the documentation refer to modules as the IL concept, but in this case it refers to the concept of a module which is either a PE binary which holds R2R code, or a CodeHeap which may have code from many different IL modules within it. Possibly change the name here to something like "GetUnwindInfoBaseAddress" and document that it serves as the base pointer for the RUNTIME_FUNCTION found in the GetUnwindInfo api?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I renamed
GetModuleBaseAddress->GetUnwindInfoBaseAddress. It's documented as "returning the base address that the unwind info for a givenCodeBlockHandleis relative to."I changed all of cDAC to reference the base address using
unwindInfoBasebut left the pre-existing native references tomoduleBaseandimageBase.