[Windows] fix thread names in debugger / crash dumps #23204
Merged
Conversation
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
CrystalP
added
Type: Fix
thexai
reviewed
Apr 26, 2023
thexai
reviewed
Apr 27, 2023
thexai
approved these changes
Apr 27, 2023
garbear
reviewed
Apr 27, 2023
| DWORD dwType; // must be 0x1000 | ||
| LPCSTR szName; // pointer to name (in same addr space) | ||
| DWORD dwThreadID; // thread ID (-1 caller thread) | ||
| DWORD dwFlags; // reserved for future use, most be zero |
|
|
Yes a new PR against the Nexus with only commit: (cherry pick same commit) And if you want also can do the same with: #23017 |
|
@garbear OK with merge? |
|
@garbear OK with you to merge? |
garbear
approved these changes
May 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Fixed up / updated the way thread names are set so they can be seen in the debugger.
The legacy method used by Kodi so far needed a thread id instead of a thread handle (all Windows platforms)
Added the modern method SetThreadDescription available with Windows 10 1607 and above. The new method adds a few niceties, see https://learn.microsoft.com/en-us/visualstudio/debugger/how-to-set-a-thread-name-in-native-code?view=vs-2022
Both method can coexist, but might as well use only the new one when available, with fallback to the legacy method.
The new method requires dynamic loading as the function does not exist in older versions of Windows
To avoid impacting performance, LoadLibrary/GetProcAddress is done once and a cached pointer is used for every new thread. Could be simplified if thread creation time is a non-issue.
No support added for UWP (covered by legacy method). I'm not familiar with Win RT and didn't find an equivalent that didn't require bundling KernelBase.dll with the app, most likely not a good idea.
Had to define new Windows builds in order to detect Windows 10 1607 properly
Motivation and context
Generic thread names in the debugger make debugging more difficult.
How has this been tested?
Windows 10 22H2 x64 and UWP x64. With old method and new method enabled selectively by special code not included in PR.
What is the effect on users?
none
Screenshots (if appropriate):
Before, generic names assigned by Visual Studio:
After, Kodi specified names:
Types of change
Checklist: