-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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.
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
Add SPGO support and MIBC comparison in dotnet-pgo #52765
Merged
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,273 @@ | ||
| // Licensed to the .NET Foundation under one or more agreements. | ||
| // The .NET Foundation licenses this file to you under the MIT license. | ||
|
|
||
| using System; | ||
| using System.Collections; | ||
| using System.Collections.Generic; | ||
| using System.Diagnostics; | ||
| using System.Linq; | ||
| using System.Text; | ||
| using System.Threading.Tasks; | ||
|
|
||
| namespace Internal.IL | ||
| { | ||
| internal class BasicBlock : IEquatable<BasicBlock> | ||
| { | ||
| public BasicBlock(int start, int size) | ||
| => (Start, Size) = (start, size); | ||
|
|
||
| // First IL offset | ||
| public int Start { get; } | ||
| // Number of IL bytes in this basic block | ||
| public int Size { get; } | ||
|
|
||
| public HashSet<BasicBlock> Sources { get; } = new HashSet<BasicBlock>(); | ||
| public HashSet<BasicBlock> Targets { get; } = new HashSet<BasicBlock>(); | ||
|
|
||
| public override string ToString() => $"Start={Start}, Size={Size}"; | ||
|
|
||
| public override bool Equals(object obj) => Equals(obj as BasicBlock); | ||
| public bool Equals(BasicBlock other) => other != null && Start == other.Start; | ||
| public override int GetHashCode() => HashCode.Combine(Start); | ||
|
|
||
| public static bool operator ==(BasicBlock left, BasicBlock right) => EqualityComparer<BasicBlock>.Default.Equals(left, right); | ||
| public static bool operator !=(BasicBlock left, BasicBlock right) => !(left == right); | ||
| } | ||
|
|
||
| internal class FlowGraph | ||
| { | ||
| private readonly int[] _bbKeys; | ||
|
|
||
| private FlowGraph(IEnumerable<BasicBlock> bbs) | ||
| { | ||
| BasicBlocks = bbs.OrderBy(bb => bb.Start).ToList(); | ||
| _bbKeys = BasicBlocks.Select(bb => bb.Start).ToArray(); | ||
| } | ||
|
|
||
| /// <summary>Basic blocks, ordered by start IL offset.</summary> | ||
| public List<BasicBlock> BasicBlocks { get; } | ||
|
|
||
| /// <summary>Find index of basic block containing IL offset.</summary> | ||
| public int LookupIndex(int ilOffset) | ||
| { | ||
| int index = Array.BinarySearch(_bbKeys, ilOffset); | ||
| if (index < 0) | ||
| index = ~index - 1; | ||
|
|
||
| // If ilOffset is negative (more generally, before the first BB) | ||
| // then binarySearch will return ~0 since index 0 is the first BB | ||
| // that's greater. | ||
| if (index < 0) | ||
| return -1; | ||
|
|
||
| // If this is the last BB we could be after as well. | ||
| BasicBlock bb = BasicBlocks[index]; | ||
| if (ilOffset >= bb.Start + bb.Size) | ||
| return -1; | ||
|
|
||
| return index; | ||
| } | ||
|
|
||
| public BasicBlock Lookup(int ilOffset) | ||
| => LookupIndex(ilOffset) switch | ||
| { | ||
| -1 => null, | ||
| int idx => BasicBlocks[idx] | ||
| }; | ||
|
|
||
| public IEnumerable<BasicBlock> LookupRange(int ilOffsetStart, int ilOffsetEnd) | ||
| { | ||
| if (ilOffsetStart < BasicBlocks[0].Start) | ||
| ilOffsetStart = BasicBlocks[0].Start; | ||
|
|
||
| if (ilOffsetEnd > BasicBlocks.Last().Start) | ||
| ilOffsetEnd = BasicBlocks.Last().Start; | ||
|
|
||
| int end = LookupIndex(ilOffsetEnd); | ||
| for (int i = LookupIndex(ilOffsetStart); i <= end; i++) | ||
| yield return BasicBlocks[i]; | ||
| } | ||
|
|
||
| internal string Dump(Func<BasicBlock, string> getNodeAnnot, Func<(BasicBlock, BasicBlock), string> getEdgeAnnot) | ||
| { | ||
| var sb = new StringBuilder(); | ||
| sb.AppendLine("digraph G {"); | ||
| sb.AppendLine(" forcelabels=true;"); | ||
| sb.AppendLine(); | ||
| Dictionary<long, int> bbToIndex = new Dictionary<long, int>(); | ||
| for (int i = 0; i < BasicBlocks.Count; i++) | ||
| bbToIndex.Add(BasicBlocks[i].Start, i); | ||
|
|
||
| foreach (BasicBlock bb in BasicBlocks) | ||
| { | ||
| string label = $"[{bb.Start:x}..{bb.Start + bb.Size:x})\\n{getNodeAnnot(bb)}"; | ||
| sb.AppendLine($" BB{bbToIndex[bb.Start]} [label=\"{label}\"];"); | ||
| } | ||
|
|
||
| sb.AppendLine(); | ||
|
|
||
| foreach (BasicBlock bb in BasicBlocks) | ||
| { | ||
| foreach (BasicBlock tar in bb.Targets) | ||
| { | ||
| string label = getEdgeAnnot((bb, tar)); | ||
| string postfix = string.IsNullOrEmpty(label) ? "" : $" [label=\"{label}\"]"; | ||
| sb.AppendLine($" BB{bbToIndex[bb.Start]} -> BB{bbToIndex[tar.Start]}{postfix};"); | ||
| } | ||
| } | ||
|
|
||
| // Write ranks with BFS. | ||
| List<BasicBlock> curRank = new List<BasicBlock> { BasicBlocks.Single(bb => bb.Start == 0) }; | ||
| HashSet<BasicBlock> seen = new HashSet<BasicBlock>(curRank); | ||
| while (curRank.Count > 0) | ||
| { | ||
| sb.AppendLine($" {{rank = same; {string.Concat(curRank.Select(bb => $"BB{bbToIndex[bb.Start]}; "))}}}"); | ||
| curRank = curRank.SelectMany(bb => bb.Targets).Where(seen.Add).ToList(); | ||
| } | ||
|
|
||
| sb.AppendLine("}"); | ||
| return sb.ToString(); | ||
| } | ||
|
|
||
| public static FlowGraph Create(MethodIL il) | ||
| { | ||
| HashSet<int> bbStarts = GetBasicBlockStarts(il); | ||
|
|
||
| List<BasicBlock> bbs = new List<BasicBlock>(); | ||
| void AddBB(int start, int count) | ||
| { | ||
| if (count > 0) | ||
| bbs.Add(new BasicBlock(start, count)); | ||
| } | ||
|
|
||
| int prevStart = 0; | ||
| foreach (int ofs in bbStarts.OrderBy(o => o)) | ||
| { | ||
| AddBB(prevStart, ofs - prevStart); | ||
| prevStart = ofs; | ||
| } | ||
|
|
||
| AddBB(prevStart, il.GetILBytes().Length - prevStart); | ||
|
|
||
| FlowGraph fg = new FlowGraph(bbs); | ||
|
|
||
| // We know where each basic block starts now. Proceed by linking them together. | ||
| ILReader reader = new ILReader(il.GetILBytes()); | ||
| foreach (BasicBlock bb in bbs) | ||
| { | ||
| reader.Seek(bb.Start); | ||
| while (reader.HasNext) | ||
| { | ||
| Debug.Assert(fg.Lookup(reader.Offset) == bb); | ||
| ILOpcode opc = reader.ReadILOpcode(); | ||
| if (opc.IsBranch()) | ||
| { | ||
| int tar = reader.ReadBranchDestination(opc); | ||
| bb.Targets.Add(fg.Lookup(tar)); | ||
| if (!opc.IsUnconditionalBranch()) | ||
| bb.Targets.Add(fg.Lookup(reader.Offset)); | ||
|
|
||
| break; | ||
| } | ||
|
|
||
| if (opc == ILOpcode.switch_) | ||
| { | ||
| uint numCases = reader.ReadILUInt32(); | ||
| int jmpBase = reader.Offset + checked((int)(numCases * 4)); | ||
| bb.Targets.Add(fg.Lookup(jmpBase)); | ||
|
|
||
| for (uint i = 0; i < numCases; i++) | ||
| { | ||
| int caseOfs = jmpBase + (int)reader.ReadILUInt32(); | ||
| bb.Targets.Add(fg.Lookup(caseOfs)); | ||
| } | ||
|
|
||
| break; | ||
| } | ||
|
|
||
| if (opc == ILOpcode.ret || opc == ILOpcode.endfinally || opc == ILOpcode.endfilter || opc == ILOpcode.throw_ || opc == ILOpcode.rethrow) | ||
| { | ||
| break; | ||
| } | ||
|
|
||
| reader.Skip(opc); | ||
| // Check fall through | ||
| if (reader.HasNext) | ||
| { | ||
| BasicBlock nextBB = fg.Lookup(reader.Offset); | ||
| if (nextBB != bb) | ||
| { | ||
| // Falling through | ||
| bb.Targets.Add(nextBB); | ||
| break; | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| foreach (BasicBlock bb in bbs) | ||
| { | ||
| foreach (BasicBlock tar in bb.Targets) | ||
| tar.Sources.Add(bb); | ||
| } | ||
|
|
||
| return fg; | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Find IL offsets at which basic blocks begin. | ||
| /// </summary> | ||
| private static HashSet<int> GetBasicBlockStarts(MethodIL il) | ||
| { | ||
| ILReader reader = new ILReader(il.GetILBytes()); | ||
| HashSet<int> bbStarts = new HashSet<int>(); | ||
| bbStarts.Add(0); | ||
| while (reader.HasNext) | ||
| { | ||
| ILOpcode opc = reader.ReadILOpcode(); | ||
| if (opc.IsBranch()) | ||
| { | ||
| int tar = reader.ReadBranchDestination(opc); | ||
| bbStarts.Add(tar); | ||
| // Conditional branches can fall through. | ||
| if (!opc.IsUnconditionalBranch()) | ||
| bbStarts.Add(reader.Offset); | ||
| } | ||
| else if (opc == ILOpcode.switch_) | ||
| { | ||
| uint numCases = reader.ReadILUInt32(); | ||
| int jmpBase = reader.Offset + checked((int)(numCases * 4)); | ||
| // Default case is at jmpBase. | ||
| bbStarts.Add(jmpBase); | ||
|
|
||
| for (uint i = 0; i < numCases; i++) | ||
| { | ||
| int caseOfs = jmpBase + (int)reader.ReadILUInt32(); | ||
| bbStarts.Add(caseOfs); | ||
| } | ||
| } | ||
| else if (opc == ILOpcode.ret || opc == ILOpcode.endfinally || opc == ILOpcode.endfilter || opc == ILOpcode.throw_ || opc == ILOpcode.rethrow) | ||
| { | ||
| if (reader.HasNext) | ||
| bbStarts.Add(reader.Offset); | ||
| } | ||
| else | ||
| { | ||
| reader.Skip(opc); | ||
| } | ||
| } | ||
|
|
||
| foreach (ILExceptionRegion ehRegion in il.GetExceptionRegions()) | ||
| { | ||
| bbStarts.Add(ehRegion.TryOffset); | ||
| bbStarts.Add(ehRegion.TryOffset + ehRegion.TryLength); | ||
| bbStarts.Add(ehRegion.HandlerOffset); | ||
| bbStarts.Add(ehRegion.HandlerOffset + ehRegion.HandlerLength); | ||
| if (ehRegion.Kind.HasFlag(ILExceptionRegionKind.Filter)) | ||
| bbStarts.Add(ehRegion.FilterOffset); | ||
| } | ||
|
|
||
| return bbStarts; | ||
| } | ||
| } | ||
| } |
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
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 missed this in #51625 so merging files with 64-bit counts currently does not work.
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.
Is there anything else you know of that would block us from using 64 bit counts across dynamic/static PGO?
I think we might want to update the class probe counter, but I don't think we use the value for anything right now, so perhaps it's not urgent. Changing this is a bit tricky as the runtime helper also knows the layout of this data.
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'm not familiar with anything, no. At least I believe I have modified all places using
EdgeIntCountandBlockIntCountin the code base now, but maybe something else could be hiding somewhere.I do now see that I missed the class probe counter. I'll submit a PR for that.
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.
There is actually still this left:
runtime/src/coreclr/tools/aot/ILCompiler.ReadyToRun/JitInterface/CorInfoImpl.ReadyToRun.cs
Lines 2456 to 2457 in 3b8adb7
I don't know if this is currently being used, however. Do we ever crossgen with instrumentation turned on?