[cDAC] Implement GetTieredVersions for cDAC #126164
+474
−5
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -22,6 +22,14 @@ public enum ModuleFlags | |
| Tenured = 0x1, // Set once we know for sure the Module will not be freed until the appdomain itself exits | ||
| EditAndContinue = 0x8, // Edit and Continue is enabled for this module | ||
| ReflectionEmit = 0x40, // Reflection.Emit was used to create this module | ||
| ProfilerDisableOpt = 0x80, // Profiler disabled JIT optimizations when module was loaded | ||
| } | ||
|
|
||
| [Flags] | ||
| public enum DebuggerAssemblyControlFlags | ||
| { | ||
| DACF_USER_OVERRIDE = 0x01, | ||
| DACF_ALLOW_JIT_OPTS = 0x02, | ||
|
Contributor
There was a problem hiding this comment. When adding these flags that mirror enums, please add comments in the native enum of the format [cDAC] [insert whichever contract depends on it] : cDAC depends on this value. See runtime/src/coreclr/vm/comcallablewrapper.h Line 752 in 67495bc |
||
| } | ||
|
|
||
| [Flags] | ||
|
|
@@ -75,6 +83,8 @@ public interface ILoader : IContract | |
|
|
||
| bool IsProbeExtensionResultValid(ModuleHandle handle) => throw new NotImplementedException(); | ||
| ModuleFlags GetFlags(ModuleHandle handle) => throw new NotImplementedException(); | ||
| bool IsReadyToRun(ModuleHandle handle) => throw new NotImplementedException(); | ||
| DebuggerAssemblyControlFlags GetDebuggerInfoBits(ModuleHandle handle) => throw new NotImplementedException(); | ||
| bool TryGetSimpleName(ModuleHandle handle, out string simpleName) => throw new NotImplementedException(); | ||
| string GetPath(ModuleHandle handle) => throw new NotImplementedException(); | ||
| string GetFileName(ModuleHandle handle) => throw new NotImplementedException(); | ||
|
|
||
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -413,4 +413,31 @@ bool ICodeVersions.HasDefaultIL(ILCodeVersionHandle iLCodeVersionHandle) | |||||
| { | ||||||
| return iLCodeVersionHandle.IsExplicit ? AsNode(iLCodeVersionHandle).ILAddress == TargetPointer.Null : true; | ||||||
| } | ||||||
|
|
||||||
| NativeCodeVersionOptimizationTier ICodeVersions.GetOptimizationTier(NativeCodeVersionHandle codeVersionHandle) | ||||||
| { | ||||||
| if (!codeVersionHandle.Valid) | ||||||
| { | ||||||
| throw new ArgumentException("Invalid NativeCodeVersionHandle"); | ||||||
| } | ||||||
|
|
||||||
| if (codeVersionHandle.IsExplicit) | ||||||
| { | ||||||
| NativeCodeVersionNode nativeCodeVersionNode = _target.ProcessedData.GetOrAdd<NativeCodeVersionNode>(codeVersionHandle.CodeVersionNodeAddress); | ||||||
| return nativeCodeVersionNode.OptimizationTier is null | ||||||
| ? NativeCodeVersionOptimizationTier.OptimizationTierUnknown | ||||||
| : (NativeCodeVersionOptimizationTier) nativeCodeVersionNode.OptimizationTier; | ||||||
|
There was a problem hiding this comment. The explicit-handle branch is casting a nullable uint (OptimizationTier is uint?) directly to NativeCodeVersionOptimizationTier. This won’t compile; use the nullable’s Value (after the null check) when performing the cast.
Suggested change
|
||||||
| } | ||||||
| else | ||||||
| { | ||||||
| IRuntimeTypeSystem rtsContract = _target.Contracts.RuntimeTypeSystem; | ||||||
| MethodDescHandle methodDescHandle = rtsContract.GetMethodDescHandle(codeVersionHandle.MethodDescAddress); | ||||||
| NativeCodeVersionOptimizationTier optimizationTier = rtsContract.GetMethodDescOptimizationTier(methodDescHandle); | ||||||
| if (optimizationTier == NativeCodeVersionOptimizationTier.OptimizationTierUnknown) | ||||||
| { | ||||||
| return rtsContract.GetInitialOptimizationTier(methodDescHandle); | ||||||
| } | ||||||
| return optimizationTier; | ||||||
| } | ||||||
| } | ||||||
| } | ||||||
This file contains hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -1645,6 +1645,86 @@ TargetPointer IRuntimeTypeSystem.GetGCStressCodeCopy(MethodDescHandle methodDesc | |
| return TargetPointer.Null; | ||
| } | ||
|
|
||
| NativeCodeVersionOptimizationTier IRuntimeTypeSystem.GetMethodDescOptimizationTier(MethodDescHandle methodDescHandle) | ||
|
Comment on lines
1645
to
+1648
There was a problem hiding this comment. In GetMethodDescOptimizationTier just above this block, the code returns (NativeCodeVersionOptimizationTier)codeData.OptimizationTier, but OptimizationTier is a uint? on MethodDescCodeData. Casting a nullable numeric directly to a non-nullable enum won’t compile; cast codeData.OptimizationTier.Value after the null check. |
||
| { | ||
| MethodDesc methodDesc = _methodDescs[methodDescHandle.Address]; | ||
| TargetPointer codeDataAddress = methodDesc.CodeData; | ||
| if (codeDataAddress == TargetPointer.Null) | ||
| return NativeCodeVersionOptimizationTier.OptimizationTierUnknown; | ||
|
|
||
| Data.MethodDescCodeData codeData = _target.ProcessedData.GetOrAdd<Data.MethodDescCodeData>(codeDataAddress); | ||
| return codeData.OptimizationTier is null | ||
| ? NativeCodeVersionOptimizationTier.OptimizationTierUnknown | ||
| : (NativeCodeVersionOptimizationTier)codeData.OptimizationTier; | ||
| } | ||
|
|
||
| bool IRuntimeTypeSystem.IsEligibleForTieredCompilation(MethodDescHandle methodDescHandle) | ||
| { | ||
| MethodDesc methodDesc = _methodDescs[methodDescHandle.Address]; | ||
| return methodDesc.IsEligibleForTieredCompilation; | ||
| } | ||
|
|
||
| private bool IsJitOptimizationDisabledForSpecificMethod(MethodDescHandle methodDescHandle) | ||
| { | ||
| MethodDesc methodDesc = _methodDescs[methodDescHandle.Address]; | ||
| MethodTable methodTable = GetOrCreateMethodTable(methodDesc); | ||
|
Comment on lines
+1654
to
+1670
There was a problem hiding this comment. IsJitOptimizationDisabledForSpecificMethod throws when metadata isn’t available (mdReader is null) for non-dynamic methods. In dumps/minidumps this can happen and would cause GetTieredVersions to fail; native behavior treats missing metadata as ‘no NoOptimization flag’ rather than throwing. Consider returning false (or otherwise falling back) instead of throwing here. |
||
| ModuleHandle moduleHandle = _target.Contracts.Loader.GetModuleHandleFromModulePtr(methodTable.Module); | ||
| MetadataReader? mdReader = _target.Contracts.EcmaMetadata.GetMetadata(moduleHandle); | ||
|
|
||
| bool isNoMetadata = methodDesc.Classification == MethodClassification.Dynamic; | ||
| bool isMiNoOptimization = false; | ||
| if (mdReader is not null) | ||
| { | ||
| MethodDefinitionHandle methodDefHandle = MetadataTokens.MethodDefinitionHandle((int)methodDesc.Token); | ||
| MethodDefinition methodDef = mdReader.GetMethodDefinition(methodDefHandle); | ||
| MethodImplAttributes implAttrs = methodDef.ImplAttributes; | ||
| isMiNoOptimization = (implAttrs & MethodImplAttributes.NoOptimization) != 0; | ||
| } | ||
| else if (!isNoMetadata) | ||
|
Comment on lines
+1679
to
+1683
There was a problem hiding this comment. These reads assume the new globals (CORDebuggerControlFlags / EEConfig) are always present in the target’s contract metadata. ReadGlobalPointer throws if the global isn’t available, which would break tier classification on older runtimes/dumps. Consider using TryReadGlobalPointer (and a safe default) so IsJitOptimizationDisabled can degrade gracefully when the globals aren’t exposed. |
||
| { | ||
| throw new InvalidOperationException("Failed to get metadata for method"); | ||
| } | ||
|
|
||
| return !isNoMetadata && isMiNoOptimization; | ||
| } | ||
|
|
||
| private bool IsJitOptimizationDisabledForAllMethodsInChunk(MethodDescHandle methodDescHandle) | ||
|
Contributor
There was a problem hiding this comment.
Member
There was a problem hiding this comment. It would be better to call this |
||
| { | ||
| MethodDesc methodDesc = _methodDescs[methodDescHandle.Address]; | ||
| MethodTable methodTable = GetOrCreateMethodTable(methodDesc); | ||
| ModuleHandle moduleHandle = _target.Contracts.Loader.GetModuleHandleFromModulePtr(methodTable.Module); | ||
| DebuggerAssemblyControlFlags debuggerInfoBits = _target.Contracts.Loader.GetDebuggerInfoBits(moduleHandle); | ||
| DebuggerControlFlag corDebuggerControlFlags = (DebuggerControlFlag)_target.Read<uint>(_target.ReadGlobalPointer(Constants.Globals.CORDebuggerControlFlags)); | ||
| TargetPointer eeConfigPtr = _target.ReadPointer(_target.ReadGlobalPointer(Constants.Globals.EEConfig)); | ||
| Data.EEConfig eeConfig = _target.ProcessedData.GetOrAdd<Data.EEConfig>(eeConfigPtr); | ||
|
|
||
| bool corDebuggerAllowJITOpts = debuggerInfoBits.HasFlag(DebuggerAssemblyControlFlags.DACF_ALLOW_JIT_OPTS) | ||
| || (corDebuggerControlFlags.HasFlag(DebuggerControlFlag.DBCF_ALLOW_JIT_OPT) | ||
| && !debuggerInfoBits.HasFlag(DebuggerAssemblyControlFlags.DACF_USER_OVERRIDE)); | ||
| bool profilerDisabledOptimizations = _target.Contracts.Loader.GetFlags(moduleHandle).HasFlag(ModuleFlags.ProfilerDisableOpt); | ||
| bool areJITOptimizationsDisabled = !corDebuggerAllowJITOpts || profilerDisabledOptimizations; | ||
|
|
||
| return eeConfig.JitMinOpts || eeConfig.GenDebuggable || areJITOptimizationsDisabled; | ||
| } | ||
|
|
||
| bool IRuntimeTypeSystem.IsJitOptimizationDisabled(MethodDescHandle methodDescHandle) | ||
|
Comment on lines
+1699
to
+1710
There was a problem hiding this comment. GetInitialOptimizationTier also unconditionally reads the EEConfig global via ReadGlobalPointer/ReadPointer. If the EEConfig global isn’t present in a target’s contract metadata (older runtime/dump), this will throw and bubble up through GetOptimizationTier/GetTieredVersions. Consider TryReadGlobalPointer + fallback (e.g., Optimized or Unknown) to keep the API usable across contract versions.
Contributor
There was a problem hiding this comment. We do not care about these things. |
||
| { | ||
| return IsJitOptimizationDisabledForAllMethodsInChunk(methodDescHandle) || IsJitOptimizationDisabledForSpecificMethod(methodDescHandle); | ||
| } | ||
|
|
||
| NativeCodeVersionOptimizationTier IRuntimeTypeSystem.GetInitialOptimizationTier(MethodDescHandle methodDescHandle) | ||
| { | ||
| MethodDesc methodDesc = _methodDescs[methodDescHandle.Address]; | ||
| if (!methodDesc.IsEligibleForTieredCompilation) | ||
| { | ||
| return NativeCodeVersionOptimizationTier.OptimizationTierOptimized; | ||
| } | ||
|
|
||
| TargetPointer eeConfigPtr = _target.ReadPointer(_target.ReadGlobalPointer(Constants.Globals.EEConfig)); | ||
| Data.EEConfig eeConfig = _target.ProcessedData.GetOrAdd<Data.EEConfig>(eeConfigPtr); | ||
| return (NativeCodeVersionOptimizationTier)eeConfig.TieredCompilation_DefaultTier; | ||
| } | ||
|
|
||
| private sealed class NonValidatedMethodTableQueries : MethodValidation.IMethodTableQueries | ||
| { | ||
| private readonly RuntimeTypeSystem_1 _rts; | ||
|
|
||
This file contains hidden or 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,23 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| namespace Microsoft.Diagnostics.DataContractReader.Data; | ||
|
|
||
| internal sealed class EEConfig : IData<EEConfig> | ||
| { | ||
| static EEConfig IData<EEConfig>.Create(Target target, TargetPointer address) | ||
| => new EEConfig(target, address); | ||
|
|
||
| public EEConfig(Target target, TargetPointer address) | ||
| { | ||
| Target.TypeInfo type = target.GetTypeInfo(DataType.EEConfig); | ||
|
|
||
| JitMinOpts = target.Read<byte>(address + (ulong)type.Fields[nameof(JitMinOpts)].Offset) != 0; | ||
| GenDebuggable = target.Read<byte>(address + (ulong)type.Fields[nameof(GenDebuggable)].Offset) != 0; | ||
| TieredCompilation_DefaultTier = target.Read<uint>(address + (ulong)type.Fields[nameof(TieredCompilation_DefaultTier)].Offset); | ||
| } | ||
|
|
||
| public bool JitMinOpts { get; init; } | ||
| public bool GenDebuggable { get; init; } | ||
| public uint TieredCompilation_DefaultTier { get; init; } | ||
| } |
This file contains hidden or 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 hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
Same here with the enum. Since these are not included in the data descriptor we have to ensure that anyone who decides to change these also changes the cDAC contract