Skip to content
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

JIT: Add helper method for updating bbTargetEdge #99362

Merged
merged 7 commits into from
Mar 7, 2024

Conversation

amanasifkhalid
Copy link
Member

Part of #93020. Adds fgRedirectTargetEdge, which updates bbTargetEdge's block target while maintaining the rest of the edge's state to simplify edge profile maintenance (and avoid additional allocations). My goal is to eventually have some generalized version of this that can replace any block's successor edges without having to consider the block's kind, such as by updating the edge via a FlowEdge**. I tried this locally, and there are some quirks around duplicate edges that complicate this approach, and it might make sense to have a fast path for updating blocks with only one successor anyway, so I'm starting here.

Note that I didn't update fgReplaceJumpTarget to use this yet, as the method is frequently called while iterating a block's predecessors, and fgRedirectTargetEdge modifies bbPreds, breaking the iterator. This can be easily fixed through multiple approaches, though I'm not sure which one is preferable:

  • We could convert problematic iterator usages to raw loops that cache the next pred edge pointer before calling fgReplaceJumpTarget, though this isn't as elegant.
  • We already have a m_next pointer in pred iterators in Debug builds for consistency checking. We can make this available all the time, and then update the iterator to it instead of using m_pred->getNextPredEdge, as that will traverse the pred list of the new target. This will impact TP, so perhaps this should be tried in a separate PR.
  • To lessen the TP impact of the above approach, we could add a new iterator type that caches the next pred edge specifically for these situations, though it might be confusing having multiple pred iterator types.

@dotnet-issue-labeler dotnet-issue-labeler bot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Mar 6, 2024
@ghost ghost assigned amanasifkhalid Mar 6, 2024
@ghost
Copy link

ghost commented Mar 6, 2024

Tagging subscribers to this area: @JulieLeeMSFT, @jakobbotsch
See info in area-owners.md if you want to be subscribed.

Issue Details

Part of #93020. Adds fgRedirectTargetEdge, which updates bbTargetEdge's block target while maintaining the rest of the edge's state to simplify edge profile maintenance (and avoid additional allocations). My goal is to eventually have some generalized version of this that can replace any block's successor edges without having to consider the block's kind, such as by updating the edge via a FlowEdge**. I tried this locally, and there are some quirks around duplicate edges that complicate this approach, and it might make sense to have a fast path for updating blocks with only one successor anyway, so I'm starting here.

Note that I didn't update fgReplaceJumpTarget to use this yet, as the method is frequently called while iterating a block's predecessors, and fgRedirectTargetEdge modifies bbPreds, breaking the iterator. This can be easily fixed through multiple approaches, though I'm not sure which one is preferable:

  • We could convert problematic iterator usages to raw loops that cache the next pred edge pointer before calling fgReplaceJumpTarget, though this isn't as elegant.
  • We already have a m_next pointer in pred iterators in Debug builds for consistency checking. We can make this available all the time, and then update the iterator to it instead of using m_pred->getNextPredEdge, as that will traverse the pred list of the new target. This will impact TP, so perhaps this should be tried in a separate PR.
  • To lessen the TP impact of the above approach, we could add a new iterator type that caches the next pred edge specifically for these situations, though it might be confusing having multiple pred iterator types.
Author: amanasifkhalid
Assignees: -
Labels:

area-CodeGen-coreclr

Milestone: -

@amanasifkhalid
Copy link
Member Author

cc @dotnet/jit-contrib, @AndyAyersMS PTAL. This change has some small diffs. I was expecting this to be a no-diff change, but it looks like there are a few fgAddRefPred call sites where we previously didn't carry over the old edge's weight, so we would calculate the min/max weights using block weights; now that we just keep the old edge, the existing edge weights are automatically preserved. This seems to influence fgReorderBlocks in a few methods.

@AndyAyersMS
Copy link
Member

  • To lessen the TP impact of the above approach, we could add a new iterator type that caches the next pred edge specifically for these situations, though it might be confusing having multiple pred iterator types.

We had this sort of setup in Phoenix, there were "Editing" iterators that allowed modification with explicit resume points, and regular iterators that did a limited amount of checking in debug to try and verify the collections weren't modified.

Copy link
Member

@AndyAyersMS AndyAyersMS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one comment typo -- feel free to fix later.

src/coreclr/jit/fgflow.cpp Outdated Show resolved Hide resolved
@amanasifkhalid
Copy link
Member Author

We had this sort of setup in Phoenix, there were "Editing" iterators that allowed modification with explicit resume points, and regular iterators that did a limited amount of checking in debug to try and verify the collections weren't modified.

I'm leaning towards this approach; I'll try this out in a follow-up PR.

Co-authored-by: Andy Ayers <[email protected]>
@amanasifkhalid amanasifkhalid merged commit c806bf6 into dotnet:main Mar 7, 2024
6 checks passed
@amanasifkhalid amanasifkhalid deleted the update-target-edge branch March 7, 2024 21:14
amanasifkhalid added a commit that referenced this pull request Mar 11, 2024
…99466)

Follow-up to #99362. fgRedirectTargetEdge modifies the predecessor lists of the old and new successor blocks, so if we want to be able to use it in fgReplaceJumpTarget, we need a pred block iterator that is resilient to these changes, as we frequently call the latter method while iterating predecessors.
amanasifkhalid added a commit that referenced this pull request Mar 12, 2024
Follow-up to #99362. Adds helper methods for redirecting BBJ_COND blocks' true/false targets to new successors while reusing the existing flow edge.
@github-actions github-actions bot locked and limited conversation to collaborators Apr 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants