Add edge likelihood dumping; fix one edge likelihood update case#99740

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.

Sign up for GitHub

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

Merged
BruceForstall merged 1 commit into from
Mar 14, 2024
Merged

Add edge likelihood dumping; fix one edge likelihood update case #99740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 44 additions & 21 deletions src/coreclr/jit/block.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,20 @@ void FlowEdge::setLikelihood(weight_t likelihood)
{
assert(likelihood >= 0.0);
assert(likelihood <= 1.0);

if (m_likelihoodSet)
{
JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
m_destBlock->bbNum, m_likelihood, likelihood);
}
else
{
JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum,
m_destBlock->bbNum, likelihood);
}

m_likelihoodSet = true;
m_likelihood = likelihood;

JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
m_likelihood);
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -114,10 +123,11 @@ void FlowEdge::addLikelihood(weight_t addedLikelihood)

assert(newLikelihood >= 0.0);
assert(newLikelihood <= 1.0);
m_likelihood = newLikelihood;

JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
m_likelihood);
JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
m_destBlock->bbNum, m_likelihood, newLikelihood);

m_likelihood = newLikelihood;
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -678,20 +688,33 @@ void BasicBlock::dspSuccs(Compiler* compiler)
// things strictly.
void BasicBlock::dspKind() const
{
auto dspBlockNum = [](const BasicBlock* b) -> const char* {
auto dspBlockNum = [](const FlowEdge* e) -> const char* {
static char buffers[3][64]; // static array of 3 to allow 3 concurrent calls in one printf()
static int nextBufferIndex = 0;

auto& buffer = buffers[nextBufferIndex];
nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
auto& buffer = buffers[nextBufferIndex];
nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
const size_t sizeOfBuffer = ArrLen(buffer);
int written;

const BasicBlock* b = e->getDestinationBlock();
if (b == nullptr)
{
_snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), "NULL");
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, "NULL");
}
else
{
_snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), FMT_BB, b->bbNum);
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, FMT_BB, b->bbNum);
}

const bool printEdgeLikelihoods = true; // TODO: parameterize this?
if (printEdgeLikelihoods)
{
if (e->hasLikelihood())
{
written = _snprintf_s(buffer + written, sizeOfBuffer - written, sizeOfBuffer - written, "(" FMT_WT ")",
e->getLikelihood());
}
}

return buffer;
Expand All@@ -715,7 +738,7 @@ void BasicBlock::dspKind() const

for (unsigned i = 0; i < jumpCnt; i++)
{
printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));
}
}

Expand All@@ -728,11 +751,11 @@ void BasicBlock::dspKind() const
break;

case BBJ_EHFILTERRET:
printf(" -> %s (fltret)", dspBlockNum(GetTarget()));
printf(" -> %s (fltret)", dspBlockNum(GetTargetEdge()));
break;

case BBJ_EHCATCHRET:
printf(" -> %s (cret)", dspBlockNum(GetTarget()));
printf(" -> %s (cret)", dspBlockNum(GetTargetEdge()));
break;

case BBJ_THROW:
Expand All@@ -746,28 +769,28 @@ void BasicBlock::dspKind() const
case BBJ_ALWAYS:
if (HasFlag(BBF_KEEP_BBJ_ALWAYS))
{
printf(" -> %s (ALWAYS)", dspBlockNum(GetTarget()));
printf(" -> %s (ALWAYS)", dspBlockNum(GetTargetEdge()));
}
else
{
printf(" -> %s (always)", dspBlockNum(GetTarget()));
printf(" -> %s (always)", dspBlockNum(GetTargetEdge()));
}
break;

case BBJ_LEAVE:
printf(" -> %s (leave)", dspBlockNum(GetTarget()));
printf(" -> %s (leave)", dspBlockNum(GetTargetEdge()));
break;

case BBJ_CALLFINALLY:
printf(" -> %s (callf)", dspBlockNum(GetTarget()));
printf(" -> %s (callf)", dspBlockNum(GetTargetEdge()));
break;

case BBJ_CALLFINALLYRET:
printf(" -> %s (callfr)", dspBlockNum(GetTarget()));
printf(" -> %s (callfr)", dspBlockNum(GetTargetEdge()));
break;

case BBJ_COND:
printf(" -> %s,%s (cond)", dspBlockNum(GetTrueTarget()), dspBlockNum(GetFalseTarget()));
printf(" -> %s,%s (cond)", dspBlockNum(GetTrueEdge()), dspBlockNum(GetFalseEdge()));
break;

case BBJ_SWITCH:
Expand All@@ -779,7 +802,7 @@ void BasicBlock::dspKind() const

for (unsigned i = 0; i < jumpCnt; i++)
{
printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));

const bool isDefault = bbSwtTargets->bbsHasDefault && (i == jumpCnt - 1);
if (isDefault)
Expand Down
29 changes: 27 additions & 2 deletions src/coreclr/jit/block.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,9 +46,13 @@ typedef BitVec_ValRet_T ASSERT_VALRET_TP;
// Use this format for loop indices
#define FMT_LP "L%02u"

// And this format for profile weights
// Use this format for profile weights
#define FMT_WT "%.7g"

// Use this format for profile weights where we want to conserve horizontal space, at the expense of displaying
// less precision.
#define FMT_WT_NARROW "%.3g"

/*****************************************************************************
*
* Each basic block ends with a jump which is described as a value
Expand DownExpand Up@@ -1037,6 +1041,27 @@ struct BasicBlock : private LIR::Range
return (bbFalseEdge == nullptr) ? nullptr : bbFalseEdge->getDestinationBlock();
}

// Return the target edge; it might be null. Only used during dumping.
FlowEdge* GetTargetEdgeRaw() const
{
assert(HasTarget());
return bbTargetEdge;
}

// Return the BBJ_COND true target edge; it might be null. Only used during dumping.
FlowEdge* GetTrueEdgeRaw() const
{
assert(KindIs(BBJ_COND));
return bbTrueEdge;
}

// Return the BBJ_COND false target edge; it might be null. Only used during dumping.
FlowEdge* GetFalseEdgeRaw() const
{
assert(KindIs(BBJ_COND));
return bbFalseEdge;
}

#endif // DEBUG

private:
Expand DownExpand Up@@ -1537,7 +1562,7 @@ struct BasicBlock : private LIR::Range
}

// PredBlocksEditing: convenience method for enabling range-based `for` iteration over predecessor blocks, e.g.:
// for (BasicBlock* const predBlock : block->PredBlocksList()) ...
// for (BasicBlock* const predBlock : block->PredBlocksEditing()) ...
// This iterator tolerates modifications to bbPreds.
//
PredBlockList<true> PredBlocksEditing() const
Expand Down
10 changes: 7 additions & 3 deletions src/coreclr/jit/clrjit.natvis
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,8 @@ The .NET Foundation licenses this file to you under the MIT license.
<!--
Visual Studio debugger visualizers for RyuJIT.

Documentation for VS natvis format: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019

Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2019
Documentation for VS natvis format: https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022
Documentation for VS debugger format specifiers: https://learn.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2022
-->

<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
Expand All@@ -27,6 +26,11 @@ Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-u
<DisplayString>BB{bbNum,d}; {bbKind,en}</DisplayString>
</Type>

<Type Name="FlowEdge">
<DisplayString Condition="m_dupCount!=1">BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g}) (dup {m_dupCount,d})</DisplayString>
<DisplayString>BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g})</DisplayString>
</Type>

<Type Name="Compiler::LoopDsc">
<DisplayString Condition="lpFlags &amp; LPFLG_REMOVED">REMOVED</DisplayString>
<DisplayString Condition="lpFlags &amp; LPFLG_HAS_PREHEAD">[BB{lpTop->bbNum,d}..BB{lpBottom->bbNum,d}] pre-h:BB{lpHead->bbNum,d} e:BB{lpEntry->bbNum,d} {lpFlags,en}</DisplayString>
Expand Down
8 changes: 6 additions & 2 deletions src/coreclr/jit/compiler.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1584,7 +1584,7 @@ enum class ProfileChecks : unsigned int
CHECK_NONE = 0,
CHECK_CLASSIC = 1 << 0, // check "classic" jit weights
CHECK_HASLIKELIHOOD = 1 << 1, // check all FlowEdges for hasLikelihood
CHECK_LIKELIHOODSUM = 1 << 2, // check block succesor likelihoods sum to 1
CHECK_LIKELIHOODSUM = 1 << 2, // check block successor likelihoods sum to 1
CHECK_LIKELY = 1 << 3, // fully check likelihood based weights
RAISE_ASSERT = 1 << 4, // assert on check failure
CHECK_ALL_BLOCKS = 1 << 5, // check blocks even if bbHasProfileWeight is false
Expand DownExpand Up@@ -6074,7 +6074,11 @@ class Compiler

void fgDispBBLiveness(BasicBlock* block);
void fgDispBBLiveness();
void fgTableDispBasicBlock(const BasicBlock* block, const BasicBlock* nextBlock = nullptr, int blockTargetFieldWidth = 21, int ibcColWidth = 0);
void fgTableDispBasicBlock(const BasicBlock* block,
const BasicBlock* nextBlock = nullptr,
bool printEdgeLikelihoods = true,
int blockTargetFieldWidth = 21,
int ibcColWidth = 0);
void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
void fgDispBasicBlocks(bool dumpTrees = false);
void fgDumpStmtTree(const BasicBlock* block, Statement* stmt);
Expand Down
46 changes: 41 additions & 5 deletions src/coreclr/jit/fgbasic.cpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -686,20 +686,56 @@ void Compiler::fgReplaceJumpTarget(BasicBlock* block, BasicBlock* oldTarget, Bas

case BBJ_SWITCH:
{
unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
bool changed = false;
unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
bool existingEdge = false;
FlowEdge* oldEdge = nullptr;
FlowEdge* newEdge = nullptr;
bool changed = false;

for (unsigned i = 0; i < jumpCnt; i++)
{
if (jumpTab[i]->getDestinationBlock() == newTarget)
{
// The new target already has an edge from this switch statement.
// We'll need to add the likelihood from the edge we're redirecting
// to the existing edge. Note that if there is no existing edge,
// then we'll copy the likelihood from the existing edge we pass to
// `fgAddRefPred`. Note also that we can visit the same edge multiple
// times if there are multiple switch cases with the same target. The
// edge has a dup count and a single likelihood for all the possible
// paths to the target, so we only want to add the likelihood once
// despite visiting the duplicated edges in the `jumpTab` array
// multiple times.
existingEdge = true;
}

if (jumpTab[i]->getDestinationBlock() == oldTarget)
{
fgRemoveRefPred(jumpTab[i]);
jumpTab[i] = fgAddRefPred(newTarget, block, jumpTab[i]);
assert((oldEdge == nullptr) || (oldEdge == jumpTab[i]));
oldEdge = jumpTab[i];
fgRemoveRefPred(oldEdge);
newEdge = fgAddRefPred(newTarget, block, oldEdge);
jumpTab[i] = newEdge;
changed = true;
}
}

if (existingEdge)
{
assert(oldEdge != nullptr);
assert(oldEdge->getSourceBlock() == block);
assert(oldEdge->getDestinationBlock() == oldTarget);
assert(newEdge != nullptr);
assert(newEdge->getSourceBlock() == block);
assert(newEdge->getDestinationBlock() == newTarget);

if (newEdge->hasLikelihood() && oldEdge->hasLikelihood())

@amanasifkhalidamanasifkhalidMar 14, 2024

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I wonder if we can start skipping these checks and asserting that the edges have likelihoods already. Once Andy's last PR for propagating likelihoods is merged in, I'll take a look at removing these.

{
newEdge->addLikelihood(oldEdge->getLikelihood());
}
}

assert(changed);
InvalidateUniqueSwitchSuccMap();
break;
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add edge likelihood dumping; fix one edge likelihood update case#99740

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.

 Sign up for GitHub

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

 Merged

BruceForstall
merged 1 commit into

from

Mar 14, 2024
 Merged


Add edge likelihood dumping; fix one edge likelihood update case
#99740
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 44 additions & 21 deletions
src/coreclr/jit/block.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,20 @@ void FlowEdge::setLikelihood(weight_t likelihood)
{
 assert(likelihood >= 0.0);
 assert(likelihood <= 1.0);

 if (m_likelihoodSet)
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, likelihood);
 }
 else
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, likelihood);
 }

 m_likelihoodSet = true;
 m_likelihood = likelihood;

 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -114,10 +123,11 @@ void FlowEdge::addLikelihood(weight_t addedLikelihood)

 assert(newLikelihood >= 0.0);
 assert(newLikelihood <= 1.0);
 m_likelihood = newLikelihood;

 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, newLikelihood);

 m_likelihood = newLikelihood;
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -678,20 +688,33 @@ void BasicBlock::dspSuccs(Compiler* compiler)
// things strictly.
void BasicBlock::dspKind() const
{
 auto dspBlockNum = [](const BasicBlock* b) -> const char* {
 auto dspBlockNum = [](const FlowEdge* e) -> const char* {
 static char buffers[3][64]; // static array of 3 to allow 3 concurrent calls in one printf()
 static int nextBufferIndex = 0;

 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 const size_t sizeOfBuffer = ArrLen(buffer);
 int written;

 const BasicBlock* b = e->getDestinationBlock();
 if (b == nullptr)
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), "NULL");
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, "NULL");
 }
 else
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), FMT_BB, b->bbNum);
 written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, FMT_BB, b->bbNum);
 }

 const bool printEdgeLikelihoods = true; // TODO: parameterize this?
 if (printEdgeLikelihoods)
 {
 if (e->hasLikelihood())
 {
 written = _snprintf_s(buffer + written, sizeOfBuffer - written, sizeOfBuffer - written, "(" FMT_WT ")",
 e->getLikelihood());
 }
 }

 return buffer;
Expand All@@ -715,7 +738,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));
 }
 }

Expand All@@ -728,11 +751,11 @@ void BasicBlock::dspKind() const
 break;

 case BBJ_EHFILTERRET:
 printf(" -> %s (fltret)", dspBlockNum(GetTarget()));
 printf(" -> %s (fltret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_EHCATCHRET:
 printf(" -> %s (cret)", dspBlockNum(GetTarget()));
 printf(" -> %s (cret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_THROW:
Expand All@@ -746,28 +769,28 @@ void BasicBlock::dspKind() const
 case BBJ_ALWAYS:
 if (HasFlag(BBF_KEEP_BBJ_ALWAYS))
 {
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTarget()));
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTargetEdge()));
 }
 else
 {
 printf(" -> %s (always)", dspBlockNum(GetTarget()));
 printf(" -> %s (always)", dspBlockNum(GetTargetEdge()));
 }
 break;

 case BBJ_LEAVE:
 printf(" -> %s (leave)", dspBlockNum(GetTarget()));
 printf(" -> %s (leave)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLY:
 printf(" -> %s (callf)", dspBlockNum(GetTarget()));
 printf(" -> %s (callf)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLYRET:
 printf(" -> %s (callfr)", dspBlockNum(GetTarget()));
 printf(" -> %s (callfr)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_COND:
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueTarget()), dspBlockNum(GetFalseTarget()));
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueEdge()), dspBlockNum(GetFalseEdge()));
 break;

 case BBJ_SWITCH:
Expand All@@ -779,7 +802,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));

 const bool isDefault = bbSwtTargets->bbsHasDefault && (i == jumpCnt - 1);
 if (isDefault)
Expand Down

29 changes: 27 additions & 2 deletions
src/coreclr/jit/block.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,9 +46,13 @@ typedef BitVec_ValRet_T ASSERT_VALRET_TP;
// Use this format for loop indices
#define FMT_LP "L%02u"

// And this format for profile weights
// Use this format for profile weights
#define FMT_WT "%.7g"

// Use this format for profile weights where we want to conserve horizontal space, at the expense of displaying
// less precision.
#define FMT_WT_NARROW "%.3g"

/*****************************************************************************
 *
 * Each basic block ends with a jump which is described as a value
Expand DownExpand Up@@ -1037,6 +1041,27 @@ struct BasicBlock : private LIR::Range
 return (bbFalseEdge == nullptr) ? nullptr : bbFalseEdge->getDestinationBlock();
 }

 // Return the target edge; it might be null. Only used during dumping.
 FlowEdge* GetTargetEdgeRaw() const
 {
 assert(HasTarget());
 return bbTargetEdge;
 }

 // Return the BBJ_COND true target edge; it might be null. Only used during dumping.
 FlowEdge* GetTrueEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbTrueEdge;
 }

 // Return the BBJ_COND false target edge; it might be null. Only used during dumping.
 FlowEdge* GetFalseEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbFalseEdge;
 }

#endif // DEBUG

private:
Expand DownExpand Up@@ -1537,7 +1562,7 @@ struct BasicBlock : private LIR::Range
 }

 // PredBlocksEditing: convenience method for enabling range-based `for` iteration over predecessor blocks, e.g.:
 // for (BasicBlock* const predBlock : block->PredBlocksList()) ...
 // for (BasicBlock* const predBlock : block->PredBlocksEditing()) ...
 // This iterator tolerates modifications to bbPreds.
 //
 PredBlockList<true> PredBlocksEditing() const
Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/jit/clrjit.natvis

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,8 @@ The .NET Foundation licenses this file to you under the MIT license.
<!--
Visual Studio debugger visualizers for RyuJIT.

Documentation for VS natvis format: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019

Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2019
Documentation for VS natvis format: https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022
Documentation for VS debugger format specifiers: https://learn.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2022
-->

<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
Expand All@@ -27,6 +26,11 @@ Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-u
 <DisplayString>BB{bbNum,d}; {bbKind,en}</DisplayString>
 </Type>

 <Type Name="FlowEdge">
 <DisplayString Condition="m_dupCount!=1">BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g}) (dup {m_dupCount,d})</DisplayString>
 <DisplayString>BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g})</DisplayString>
 </Type>

 <Type Name="Compiler::LoopDsc">
 <DisplayString Condition="lpFlags &amp; LPFLG_REMOVED">REMOVED</DisplayString>
 <DisplayString Condition="lpFlags &amp; LPFLG_HAS_PREHEAD">[BB{lpTop->bbNum,d}..BB{lpBottom->bbNum,d}] pre-h:BB{lpHead->bbNum,d} e:BB{lpEntry->bbNum,d} {lpFlags,en}</DisplayString>
Expand Down

8 changes: 6 additions & 2 deletions
src/coreclr/jit/compiler.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1584,7 +1584,7 @@ enum class ProfileChecks : unsigned int
 CHECK_NONE = 0,
 CHECK_CLASSIC = 1 << 0, // check "classic" jit weights
 CHECK_HASLIKELIHOOD = 1 << 1, // check all FlowEdges for hasLikelihood
 CHECK_LIKELIHOODSUM = 1 << 2, // check block succesor likelihoods sum to 1 
 CHECK_LIKELIHOODSUM = 1 << 2, // check block successor likelihoods sum to 1 
 CHECK_LIKELY = 1 << 3, // fully check likelihood based weights
 RAISE_ASSERT = 1 << 4, // assert on check failure
 CHECK_ALL_BLOCKS = 1 << 5, // check blocks even if bbHasProfileWeight is false
Expand DownExpand Up@@ -6074,7 +6074,11 @@ class Compiler

 void fgDispBBLiveness(BasicBlock* block);
 void fgDispBBLiveness();
 void fgTableDispBasicBlock(const BasicBlock* block, const BasicBlock* nextBlock = nullptr, int blockTargetFieldWidth = 21, int ibcColWidth = 0);
 void fgTableDispBasicBlock(const BasicBlock* block,
 const BasicBlock* nextBlock = nullptr,
 bool printEdgeLikelihoods = true,
 int blockTargetFieldWidth = 21,
 int ibcColWidth = 0);
 void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
 void fgDispBasicBlocks(bool dumpTrees = false);
 void fgDumpStmtTree(const BasicBlock* block, Statement* stmt);
Expand Down

46 changes: 41 additions & 5 deletions
src/coreclr/jit/fgbasic.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,20 +686,56 @@ void Compiler::fgReplaceJumpTarget(BasicBlock* block, BasicBlock* oldTarget, Bas

 case BBJ_SWITCH:
 {
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool changed = false;
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool existingEdge = false;
 FlowEdge* oldEdge = nullptr;
 FlowEdge* newEdge = nullptr;
 bool changed = false;

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 if (jumpTab[i]->getDestinationBlock() == newTarget)
 {
 // The new target already has an edge from this switch statement.
 // We'll need to add the likelihood from the edge we're redirecting
 // to the existing edge. Note that if there is no existing edge,
 // then we'll copy the likelihood from the existing edge we pass to
 // `fgAddRefPred`. Note also that we can visit the same edge multiple
 // times if there are multiple switch cases with the same target. The
 // edge has a dup count and a single likelihood for all the possible
 // paths to the target, so we only want to add the likelihood once
 // despite visiting the duplicated edges in the `jumpTab` array
 // multiple times.
 existingEdge = true;
 }

 if (jumpTab[i]->getDestinationBlock() == oldTarget)
 {
 fgRemoveRefPred(jumpTab[i]);
 jumpTab[i] = fgAddRefPred(newTarget, block, jumpTab[i]);
 assert((oldEdge == nullptr) || (oldEdge == jumpTab[i]));
 oldEdge = jumpTab[i];
 fgRemoveRefPred(oldEdge);
 newEdge = fgAddRefPred(newTarget, block, oldEdge);
 jumpTab[i] = newEdge;
 changed = true;
 }
 }

 if (existingEdge)
 {
 assert(oldEdge != nullptr);
 assert(oldEdge->getSourceBlock() == block);
 assert(oldEdge->getDestinationBlock() == oldTarget);
 assert(newEdge != nullptr);
 assert(newEdge->getSourceBlock() == block);
 assert(newEdge->getDestinationBlock() == newTarget);

 if (newEdge->hasLikelihood() && oldEdge->hasLikelihood())
@amanasifkhalidamanasifkhalidMar 14, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I wonder if we can start skipping these checks and asserting that the edges have likelihoods already. Once Andy's last PR for propagating likelihoods is merged in, I'll take a look at removing these.
 {
 newEdge->addLikelihood(oldEdge->getLikelihood());
 }
 }

 assert(changed);
 InvalidateUniqueSwitchSuccMap();
 break;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add edge likelihood dumping; fix one edge likelihood update case#99740

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.

 Sign up for GitHub

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

 Merged

BruceForstall
merged 1 commit into

from

Mar 14, 2024
 Merged


Add edge likelihood dumping; fix one edge likelihood update case
#99740
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 44 additions & 21 deletions
src/coreclr/jit/block.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,20 @@ void FlowEdge::setLikelihood(weight_t likelihood)
{
 assert(likelihood >= 0.0);
 assert(likelihood <= 1.0);

 if (m_likelihoodSet)
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, likelihood);
 }
 else
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, likelihood);
 }

 m_likelihoodSet = true;
 m_likelihood = likelihood;

 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -114,10 +123,11 @@ void FlowEdge::addLikelihood(weight_t addedLikelihood)

 assert(newLikelihood >= 0.0);
 assert(newLikelihood <= 1.0);
 m_likelihood = newLikelihood;

 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, newLikelihood);

 m_likelihood = newLikelihood;
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -678,20 +688,33 @@ void BasicBlock::dspSuccs(Compiler* compiler)
// things strictly.
void BasicBlock::dspKind() const
{
 auto dspBlockNum = [](const BasicBlock* b) -> const char* {
 auto dspBlockNum = [](const FlowEdge* e) -> const char* {
 static char buffers[3][64]; // static array of 3 to allow 3 concurrent calls in one printf()
 static int nextBufferIndex = 0;

 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 const size_t sizeOfBuffer = ArrLen(buffer);
 int written;

 const BasicBlock* b = e->getDestinationBlock();
 if (b == nullptr)
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), "NULL");
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, "NULL");
 }
 else
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), FMT_BB, b->bbNum);
 written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, FMT_BB, b->bbNum);
 }

 const bool printEdgeLikelihoods = true; // TODO: parameterize this?
 if (printEdgeLikelihoods)
 {
 if (e->hasLikelihood())
 {
 written = _snprintf_s(buffer + written, sizeOfBuffer - written, sizeOfBuffer - written, "(" FMT_WT ")",
 e->getLikelihood());
 }
 }

 return buffer;
Expand All@@ -715,7 +738,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));
 }
 }

Expand All@@ -728,11 +751,11 @@ void BasicBlock::dspKind() const
 break;

 case BBJ_EHFILTERRET:
 printf(" -> %s (fltret)", dspBlockNum(GetTarget()));
 printf(" -> %s (fltret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_EHCATCHRET:
 printf(" -> %s (cret)", dspBlockNum(GetTarget()));
 printf(" -> %s (cret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_THROW:
Expand All@@ -746,28 +769,28 @@ void BasicBlock::dspKind() const
 case BBJ_ALWAYS:
 if (HasFlag(BBF_KEEP_BBJ_ALWAYS))
 {
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTarget()));
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTargetEdge()));
 }
 else
 {
 printf(" -> %s (always)", dspBlockNum(GetTarget()));
 printf(" -> %s (always)", dspBlockNum(GetTargetEdge()));
 }
 break;

 case BBJ_LEAVE:
 printf(" -> %s (leave)", dspBlockNum(GetTarget()));
 printf(" -> %s (leave)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLY:
 printf(" -> %s (callf)", dspBlockNum(GetTarget()));
 printf(" -> %s (callf)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLYRET:
 printf(" -> %s (callfr)", dspBlockNum(GetTarget()));
 printf(" -> %s (callfr)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_COND:
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueTarget()), dspBlockNum(GetFalseTarget()));
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueEdge()), dspBlockNum(GetFalseEdge()));
 break;

 case BBJ_SWITCH:
Expand All@@ -779,7 +802,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));

 const bool isDefault = bbSwtTargets->bbsHasDefault && (i == jumpCnt - 1);
 if (isDefault)
Expand Down

29 changes: 27 additions & 2 deletions
src/coreclr/jit/block.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,9 +46,13 @@ typedef BitVec_ValRet_T ASSERT_VALRET_TP;
// Use this format for loop indices
#define FMT_LP "L%02u"

// And this format for profile weights
// Use this format for profile weights
#define FMT_WT "%.7g"

// Use this format for profile weights where we want to conserve horizontal space, at the expense of displaying
// less precision.
#define FMT_WT_NARROW "%.3g"

/*****************************************************************************
 *
 * Each basic block ends with a jump which is described as a value
Expand DownExpand Up@@ -1037,6 +1041,27 @@ struct BasicBlock : private LIR::Range
 return (bbFalseEdge == nullptr) ? nullptr : bbFalseEdge->getDestinationBlock();
 }

 // Return the target edge; it might be null. Only used during dumping.
 FlowEdge* GetTargetEdgeRaw() const
 {
 assert(HasTarget());
 return bbTargetEdge;
 }

 // Return the BBJ_COND true target edge; it might be null. Only used during dumping.
 FlowEdge* GetTrueEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbTrueEdge;
 }

 // Return the BBJ_COND false target edge; it might be null. Only used during dumping.
 FlowEdge* GetFalseEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbFalseEdge;
 }

#endif // DEBUG

private:
Expand DownExpand Up@@ -1537,7 +1562,7 @@ struct BasicBlock : private LIR::Range
 }

 // PredBlocksEditing: convenience method for enabling range-based `for` iteration over predecessor blocks, e.g.:
 // for (BasicBlock* const predBlock : block->PredBlocksList()) ...
 // for (BasicBlock* const predBlock : block->PredBlocksEditing()) ...
 // This iterator tolerates modifications to bbPreds.
 //
 PredBlockList<true> PredBlocksEditing() const
Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/jit/clrjit.natvis

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,8 @@ The .NET Foundation licenses this file to you under the MIT license.
<!--
Visual Studio debugger visualizers for RyuJIT.

Documentation for VS natvis format: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019

Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2019
Documentation for VS natvis format: https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022
Documentation for VS debugger format specifiers: https://learn.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2022
-->

<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
Expand All@@ -27,6 +26,11 @@ Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-u
 <DisplayString>BB{bbNum,d}; {bbKind,en}</DisplayString>
 </Type>

 <Type Name="FlowEdge">
 <DisplayString Condition="m_dupCount!=1">BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g}) (dup {m_dupCount,d})</DisplayString>
 <DisplayString>BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g})</DisplayString>
 </Type>

 <Type Name="Compiler::LoopDsc">
 <DisplayString Condition="lpFlags &amp; LPFLG_REMOVED">REMOVED</DisplayString>
 <DisplayString Condition="lpFlags &amp; LPFLG_HAS_PREHEAD">[BB{lpTop->bbNum,d}..BB{lpBottom->bbNum,d}] pre-h:BB{lpHead->bbNum,d} e:BB{lpEntry->bbNum,d} {lpFlags,en}</DisplayString>
Expand Down

8 changes: 6 additions & 2 deletions
src/coreclr/jit/compiler.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1584,7 +1584,7 @@ enum class ProfileChecks : unsigned int
 CHECK_NONE = 0,
 CHECK_CLASSIC = 1 << 0, // check "classic" jit weights
 CHECK_HASLIKELIHOOD = 1 << 1, // check all FlowEdges for hasLikelihood
 CHECK_LIKELIHOODSUM = 1 << 2, // check block succesor likelihoods sum to 1 
 CHECK_LIKELIHOODSUM = 1 << 2, // check block successor likelihoods sum to 1 
 CHECK_LIKELY = 1 << 3, // fully check likelihood based weights
 RAISE_ASSERT = 1 << 4, // assert on check failure
 CHECK_ALL_BLOCKS = 1 << 5, // check blocks even if bbHasProfileWeight is false
Expand DownExpand Up@@ -6074,7 +6074,11 @@ class Compiler

 void fgDispBBLiveness(BasicBlock* block);
 void fgDispBBLiveness();
 void fgTableDispBasicBlock(const BasicBlock* block, const BasicBlock* nextBlock = nullptr, int blockTargetFieldWidth = 21, int ibcColWidth = 0);
 void fgTableDispBasicBlock(const BasicBlock* block,
 const BasicBlock* nextBlock = nullptr,
 bool printEdgeLikelihoods = true,
 int blockTargetFieldWidth = 21,
 int ibcColWidth = 0);
 void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
 void fgDispBasicBlocks(bool dumpTrees = false);
 void fgDumpStmtTree(const BasicBlock* block, Statement* stmt);
Expand Down

46 changes: 41 additions & 5 deletions
src/coreclr/jit/fgbasic.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,20 +686,56 @@ void Compiler::fgReplaceJumpTarget(BasicBlock* block, BasicBlock* oldTarget, Bas

 case BBJ_SWITCH:
 {
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool changed = false;
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool existingEdge = false;
 FlowEdge* oldEdge = nullptr;
 FlowEdge* newEdge = nullptr;
 bool changed = false;

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 if (jumpTab[i]->getDestinationBlock() == newTarget)
 {
 // The new target already has an edge from this switch statement.
 // We'll need to add the likelihood from the edge we're redirecting
 // to the existing edge. Note that if there is no existing edge,
 // then we'll copy the likelihood from the existing edge we pass to
 // `fgAddRefPred`. Note also that we can visit the same edge multiple
 // times if there are multiple switch cases with the same target. The
 // edge has a dup count and a single likelihood for all the possible
 // paths to the target, so we only want to add the likelihood once
 // despite visiting the duplicated edges in the `jumpTab` array
 // multiple times.
 existingEdge = true;
 }

 if (jumpTab[i]->getDestinationBlock() == oldTarget)
 {
 fgRemoveRefPred(jumpTab[i]);
 jumpTab[i] = fgAddRefPred(newTarget, block, jumpTab[i]);
 assert((oldEdge == nullptr) || (oldEdge == jumpTab[i]));
 oldEdge = jumpTab[i];
 fgRemoveRefPred(oldEdge);
 newEdge = fgAddRefPred(newTarget, block, oldEdge);
 jumpTab[i] = newEdge;
 changed = true;
 }
 }

 if (existingEdge)
 {
 assert(oldEdge != nullptr);
 assert(oldEdge->getSourceBlock() == block);
 assert(oldEdge->getDestinationBlock() == oldTarget);
 assert(newEdge != nullptr);
 assert(newEdge->getSourceBlock() == block);
 assert(newEdge->getDestinationBlock() == newTarget);

 if (newEdge->hasLikelihood() && oldEdge->hasLikelihood())
@amanasifkhalidamanasifkhalidMar 14, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I wonder if we can start skipping these checks and asserting that the edges have likelihoods already. Once Andy's last PR for propagating likelihoods is merged in, I'll take a look at removing these.
 {
 newEdge->addLikelihood(oldEdge->getLikelihood());
 }
 }

 assert(changed);
 InvalidateUniqueSwitchSuccMap();
 break;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add edge likelihood dumping; fix one edge likelihood update case#99740

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.

 Sign up for GitHub

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

 Merged

BruceForstall
merged 1 commit into

from

Mar 14, 2024
 Merged


Add edge likelihood dumping; fix one edge likelihood update case
#99740
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 44 additions & 21 deletions
src/coreclr/jit/block.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,20 @@ void FlowEdge::setLikelihood(weight_t likelihood)
{
 assert(likelihood >= 0.0);
 assert(likelihood <= 1.0);

 if (m_likelihoodSet)
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, likelihood);
 }
 else
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, likelihood);
 }

 m_likelihoodSet = true;
 m_likelihood = likelihood;

 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -114,10 +123,11 @@ void FlowEdge::addLikelihood(weight_t addedLikelihood)

 assert(newLikelihood >= 0.0);
 assert(newLikelihood <= 1.0);
 m_likelihood = newLikelihood;

 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, newLikelihood);

 m_likelihood = newLikelihood;
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -678,20 +688,33 @@ void BasicBlock::dspSuccs(Compiler* compiler)
// things strictly.
void BasicBlock::dspKind() const
{
 auto dspBlockNum = [](const BasicBlock* b) -> const char* {
 auto dspBlockNum = [](const FlowEdge* e) -> const char* {
 static char buffers[3][64]; // static array of 3 to allow 3 concurrent calls in one printf()
 static int nextBufferIndex = 0;

 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 const size_t sizeOfBuffer = ArrLen(buffer);
 int written;

 const BasicBlock* b = e->getDestinationBlock();
 if (b == nullptr)
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), "NULL");
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, "NULL");
 }
 else
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), FMT_BB, b->bbNum);
 written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, FMT_BB, b->bbNum);
 }

 const bool printEdgeLikelihoods = true; // TODO: parameterize this?
 if (printEdgeLikelihoods)
 {
 if (e->hasLikelihood())
 {
 written = _snprintf_s(buffer + written, sizeOfBuffer - written, sizeOfBuffer - written, "(" FMT_WT ")",
 e->getLikelihood());
 }
 }

 return buffer;
Expand All@@ -715,7 +738,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));
 }
 }

Expand All@@ -728,11 +751,11 @@ void BasicBlock::dspKind() const
 break;

 case BBJ_EHFILTERRET:
 printf(" -> %s (fltret)", dspBlockNum(GetTarget()));
 printf(" -> %s (fltret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_EHCATCHRET:
 printf(" -> %s (cret)", dspBlockNum(GetTarget()));
 printf(" -> %s (cret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_THROW:
Expand All@@ -746,28 +769,28 @@ void BasicBlock::dspKind() const
 case BBJ_ALWAYS:
 if (HasFlag(BBF_KEEP_BBJ_ALWAYS))
 {
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTarget()));
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTargetEdge()));
 }
 else
 {
 printf(" -> %s (always)", dspBlockNum(GetTarget()));
 printf(" -> %s (always)", dspBlockNum(GetTargetEdge()));
 }
 break;

 case BBJ_LEAVE:
 printf(" -> %s (leave)", dspBlockNum(GetTarget()));
 printf(" -> %s (leave)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLY:
 printf(" -> %s (callf)", dspBlockNum(GetTarget()));
 printf(" -> %s (callf)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLYRET:
 printf(" -> %s (callfr)", dspBlockNum(GetTarget()));
 printf(" -> %s (callfr)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_COND:
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueTarget()), dspBlockNum(GetFalseTarget()));
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueEdge()), dspBlockNum(GetFalseEdge()));
 break;

 case BBJ_SWITCH:
Expand All@@ -779,7 +802,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));

 const bool isDefault = bbSwtTargets->bbsHasDefault && (i == jumpCnt - 1);
 if (isDefault)
Expand Down

29 changes: 27 additions & 2 deletions
src/coreclr/jit/block.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,9 +46,13 @@ typedef BitVec_ValRet_T ASSERT_VALRET_TP;
// Use this format for loop indices
#define FMT_LP "L%02u"

// And this format for profile weights
// Use this format for profile weights
#define FMT_WT "%.7g"

// Use this format for profile weights where we want to conserve horizontal space, at the expense of displaying
// less precision.
#define FMT_WT_NARROW "%.3g"

/*****************************************************************************
 *
 * Each basic block ends with a jump which is described as a value
Expand DownExpand Up@@ -1037,6 +1041,27 @@ struct BasicBlock : private LIR::Range
 return (bbFalseEdge == nullptr) ? nullptr : bbFalseEdge->getDestinationBlock();
 }

 // Return the target edge; it might be null. Only used during dumping.
 FlowEdge* GetTargetEdgeRaw() const
 {
 assert(HasTarget());
 return bbTargetEdge;
 }

 // Return the BBJ_COND true target edge; it might be null. Only used during dumping.
 FlowEdge* GetTrueEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbTrueEdge;
 }

 // Return the BBJ_COND false target edge; it might be null. Only used during dumping.
 FlowEdge* GetFalseEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbFalseEdge;
 }

#endif // DEBUG

private:
Expand DownExpand Up@@ -1537,7 +1562,7 @@ struct BasicBlock : private LIR::Range
 }

 // PredBlocksEditing: convenience method for enabling range-based `for` iteration over predecessor blocks, e.g.:
 // for (BasicBlock* const predBlock : block->PredBlocksList()) ...
 // for (BasicBlock* const predBlock : block->PredBlocksEditing()) ...
 // This iterator tolerates modifications to bbPreds.
 //
 PredBlockList<true> PredBlocksEditing() const
Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/jit/clrjit.natvis

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,8 @@ The .NET Foundation licenses this file to you under the MIT license.
<!--
Visual Studio debugger visualizers for RyuJIT.

Documentation for VS natvis format: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019

Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2019
Documentation for VS natvis format: https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022
Documentation for VS debugger format specifiers: https://learn.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2022
-->

<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
Expand All@@ -27,6 +26,11 @@ Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-u
 <DisplayString>BB{bbNum,d}; {bbKind,en}</DisplayString>
 </Type>

 <Type Name="FlowEdge">
 <DisplayString Condition="m_dupCount!=1">BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g}) (dup {m_dupCount,d})</DisplayString>
 <DisplayString>BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g})</DisplayString>
 </Type>

 <Type Name="Compiler::LoopDsc">
 <DisplayString Condition="lpFlags &amp; LPFLG_REMOVED">REMOVED</DisplayString>
 <DisplayString Condition="lpFlags &amp; LPFLG_HAS_PREHEAD">[BB{lpTop->bbNum,d}..BB{lpBottom->bbNum,d}] pre-h:BB{lpHead->bbNum,d} e:BB{lpEntry->bbNum,d} {lpFlags,en}</DisplayString>
Expand Down

8 changes: 6 additions & 2 deletions
src/coreclr/jit/compiler.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1584,7 +1584,7 @@ enum class ProfileChecks : unsigned int
 CHECK_NONE = 0,
 CHECK_CLASSIC = 1 << 0, // check "classic" jit weights
 CHECK_HASLIKELIHOOD = 1 << 1, // check all FlowEdges for hasLikelihood
 CHECK_LIKELIHOODSUM = 1 << 2, // check block succesor likelihoods sum to 1 
 CHECK_LIKELIHOODSUM = 1 << 2, // check block successor likelihoods sum to 1 
 CHECK_LIKELY = 1 << 3, // fully check likelihood based weights
 RAISE_ASSERT = 1 << 4, // assert on check failure
 CHECK_ALL_BLOCKS = 1 << 5, // check blocks even if bbHasProfileWeight is false
Expand DownExpand Up@@ -6074,7 +6074,11 @@ class Compiler

 void fgDispBBLiveness(BasicBlock* block);
 void fgDispBBLiveness();
 void fgTableDispBasicBlock(const BasicBlock* block, const BasicBlock* nextBlock = nullptr, int blockTargetFieldWidth = 21, int ibcColWidth = 0);
 void fgTableDispBasicBlock(const BasicBlock* block,
 const BasicBlock* nextBlock = nullptr,
 bool printEdgeLikelihoods = true,
 int blockTargetFieldWidth = 21,
 int ibcColWidth = 0);
 void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
 void fgDispBasicBlocks(bool dumpTrees = false);
 void fgDumpStmtTree(const BasicBlock* block, Statement* stmt);
Expand Down

46 changes: 41 additions & 5 deletions
src/coreclr/jit/fgbasic.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,20 +686,56 @@ void Compiler::fgReplaceJumpTarget(BasicBlock* block, BasicBlock* oldTarget, Bas

 case BBJ_SWITCH:
 {
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool changed = false;
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool existingEdge = false;
 FlowEdge* oldEdge = nullptr;
 FlowEdge* newEdge = nullptr;
 bool changed = false;

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 if (jumpTab[i]->getDestinationBlock() == newTarget)
 {
 // The new target already has an edge from this switch statement.
 // We'll need to add the likelihood from the edge we're redirecting
 // to the existing edge. Note that if there is no existing edge,
 // then we'll copy the likelihood from the existing edge we pass to
 // `fgAddRefPred`. Note also that we can visit the same edge multiple
 // times if there are multiple switch cases with the same target. The
 // edge has a dup count and a single likelihood for all the possible
 // paths to the target, so we only want to add the likelihood once
 // despite visiting the duplicated edges in the `jumpTab` array
 // multiple times.
 existingEdge = true;
 }

 if (jumpTab[i]->getDestinationBlock() == oldTarget)
 {
 fgRemoveRefPred(jumpTab[i]);
 jumpTab[i] = fgAddRefPred(newTarget, block, jumpTab[i]);
 assert((oldEdge == nullptr) || (oldEdge == jumpTab[i]));
 oldEdge = jumpTab[i];
 fgRemoveRefPred(oldEdge);
 newEdge = fgAddRefPred(newTarget, block, oldEdge);
 jumpTab[i] = newEdge;
 changed = true;
 }
 }

 if (existingEdge)
 {
 assert(oldEdge != nullptr);
 assert(oldEdge->getSourceBlock() == block);
 assert(oldEdge->getDestinationBlock() == oldTarget);
 assert(newEdge != nullptr);
 assert(newEdge->getSourceBlock() == block);
 assert(newEdge->getDestinationBlock() == newTarget);

 if (newEdge->hasLikelihood() && oldEdge->hasLikelihood())
@amanasifkhalidamanasifkhalidMar 14, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I wonder if we can start skipping these checks and asserting that the edges have likelihoods already. Once Andy's last PR for propagating likelihoods is merged in, I'll take a look at removing these.
 {
 newEdge->addLikelihood(oldEdge->getLikelihood());
 }
 }

 assert(changed);
 InvalidateUniqueSwitchSuccMap();
 break;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add edge likelihood dumping; fix one edge likelihood update case#99740

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.

 Sign up for GitHub

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

 Merged

BruceForstall
merged 1 commit into

from

Mar 14, 2024
 Merged


Add edge likelihood dumping; fix one edge likelihood update case
#99740
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 44 additions & 21 deletions
src/coreclr/jit/block.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,20 @@ void FlowEdge::setLikelihood(weight_t likelihood)
{
 assert(likelihood >= 0.0);
 assert(likelihood <= 1.0);

 if (m_likelihoodSet)
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, likelihood);
 }
 else
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, likelihood);
 }

 m_likelihoodSet = true;
 m_likelihood = likelihood;

 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -114,10 +123,11 @@ void FlowEdge::addLikelihood(weight_t addedLikelihood)

 assert(newLikelihood >= 0.0);
 assert(newLikelihood <= 1.0);
 m_likelihood = newLikelihood;

 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, newLikelihood);

 m_likelihood = newLikelihood;
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -678,20 +688,33 @@ void BasicBlock::dspSuccs(Compiler* compiler)
// things strictly.
void BasicBlock::dspKind() const
{
 auto dspBlockNum = [](const BasicBlock* b) -> const char* {
 auto dspBlockNum = [](const FlowEdge* e) -> const char* {
 static char buffers[3][64]; // static array of 3 to allow 3 concurrent calls in one printf()
 static int nextBufferIndex = 0;

 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 const size_t sizeOfBuffer = ArrLen(buffer);
 int written;

 const BasicBlock* b = e->getDestinationBlock();
 if (b == nullptr)
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), "NULL");
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, "NULL");
 }
 else
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), FMT_BB, b->bbNum);
 written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, FMT_BB, b->bbNum);
 }

 const bool printEdgeLikelihoods = true; // TODO: parameterize this?
 if (printEdgeLikelihoods)
 {
 if (e->hasLikelihood())
 {
 written = _snprintf_s(buffer + written, sizeOfBuffer - written, sizeOfBuffer - written, "(" FMT_WT ")",
 e->getLikelihood());
 }
 }

 return buffer;
Expand All@@ -715,7 +738,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));
 }
 }

Expand All@@ -728,11 +751,11 @@ void BasicBlock::dspKind() const
 break;

 case BBJ_EHFILTERRET:
 printf(" -> %s (fltret)", dspBlockNum(GetTarget()));
 printf(" -> %s (fltret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_EHCATCHRET:
 printf(" -> %s (cret)", dspBlockNum(GetTarget()));
 printf(" -> %s (cret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_THROW:
Expand All@@ -746,28 +769,28 @@ void BasicBlock::dspKind() const
 case BBJ_ALWAYS:
 if (HasFlag(BBF_KEEP_BBJ_ALWAYS))
 {
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTarget()));
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTargetEdge()));
 }
 else
 {
 printf(" -> %s (always)", dspBlockNum(GetTarget()));
 printf(" -> %s (always)", dspBlockNum(GetTargetEdge()));
 }
 break;

 case BBJ_LEAVE:
 printf(" -> %s (leave)", dspBlockNum(GetTarget()));
 printf(" -> %s (leave)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLY:
 printf(" -> %s (callf)", dspBlockNum(GetTarget()));
 printf(" -> %s (callf)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLYRET:
 printf(" -> %s (callfr)", dspBlockNum(GetTarget()));
 printf(" -> %s (callfr)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_COND:
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueTarget()), dspBlockNum(GetFalseTarget()));
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueEdge()), dspBlockNum(GetFalseEdge()));
 break;

 case BBJ_SWITCH:
Expand All@@ -779,7 +802,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));

 const bool isDefault = bbSwtTargets->bbsHasDefault && (i == jumpCnt - 1);
 if (isDefault)
Expand Down

29 changes: 27 additions & 2 deletions
src/coreclr/jit/block.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,9 +46,13 @@ typedef BitVec_ValRet_T ASSERT_VALRET_TP;
// Use this format for loop indices
#define FMT_LP "L%02u"

// And this format for profile weights
// Use this format for profile weights
#define FMT_WT "%.7g"

// Use this format for profile weights where we want to conserve horizontal space, at the expense of displaying
// less precision.
#define FMT_WT_NARROW "%.3g"

/*****************************************************************************
 *
 * Each basic block ends with a jump which is described as a value
Expand DownExpand Up@@ -1037,6 +1041,27 @@ struct BasicBlock : private LIR::Range
 return (bbFalseEdge == nullptr) ? nullptr : bbFalseEdge->getDestinationBlock();
 }

 // Return the target edge; it might be null. Only used during dumping.
 FlowEdge* GetTargetEdgeRaw() const
 {
 assert(HasTarget());
 return bbTargetEdge;
 }

 // Return the BBJ_COND true target edge; it might be null. Only used during dumping.
 FlowEdge* GetTrueEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbTrueEdge;
 }

 // Return the BBJ_COND false target edge; it might be null. Only used during dumping.
 FlowEdge* GetFalseEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbFalseEdge;
 }

#endif // DEBUG

private:
Expand DownExpand Up@@ -1537,7 +1562,7 @@ struct BasicBlock : private LIR::Range
 }

 // PredBlocksEditing: convenience method for enabling range-based `for` iteration over predecessor blocks, e.g.:
 // for (BasicBlock* const predBlock : block->PredBlocksList()) ...
 // for (BasicBlock* const predBlock : block->PredBlocksEditing()) ...
 // This iterator tolerates modifications to bbPreds.
 //
 PredBlockList<true> PredBlocksEditing() const
Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/jit/clrjit.natvis

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,8 @@ The .NET Foundation licenses this file to you under the MIT license.
<!--
Visual Studio debugger visualizers for RyuJIT.

Documentation for VS natvis format: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019

Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2019
Documentation for VS natvis format: https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022
Documentation for VS debugger format specifiers: https://learn.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2022
-->

<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
Expand All@@ -27,6 +26,11 @@ Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-u
 <DisplayString>BB{bbNum,d}; {bbKind,en}</DisplayString>
 </Type>

 <Type Name="FlowEdge">
 <DisplayString Condition="m_dupCount!=1">BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g}) (dup {m_dupCount,d})</DisplayString>
 <DisplayString>BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g})</DisplayString>
 </Type>

 <Type Name="Compiler::LoopDsc">
 <DisplayString Condition="lpFlags &amp; LPFLG_REMOVED">REMOVED</DisplayString>
 <DisplayString Condition="lpFlags &amp; LPFLG_HAS_PREHEAD">[BB{lpTop->bbNum,d}..BB{lpBottom->bbNum,d}] pre-h:BB{lpHead->bbNum,d} e:BB{lpEntry->bbNum,d} {lpFlags,en}</DisplayString>
Expand Down

8 changes: 6 additions & 2 deletions
src/coreclr/jit/compiler.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1584,7 +1584,7 @@ enum class ProfileChecks : unsigned int
 CHECK_NONE = 0,
 CHECK_CLASSIC = 1 << 0, // check "classic" jit weights
 CHECK_HASLIKELIHOOD = 1 << 1, // check all FlowEdges for hasLikelihood
 CHECK_LIKELIHOODSUM = 1 << 2, // check block succesor likelihoods sum to 1 
 CHECK_LIKELIHOODSUM = 1 << 2, // check block successor likelihoods sum to 1 
 CHECK_LIKELY = 1 << 3, // fully check likelihood based weights
 RAISE_ASSERT = 1 << 4, // assert on check failure
 CHECK_ALL_BLOCKS = 1 << 5, // check blocks even if bbHasProfileWeight is false
Expand DownExpand Up@@ -6074,7 +6074,11 @@ class Compiler

 void fgDispBBLiveness(BasicBlock* block);
 void fgDispBBLiveness();
 void fgTableDispBasicBlock(const BasicBlock* block, const BasicBlock* nextBlock = nullptr, int blockTargetFieldWidth = 21, int ibcColWidth = 0);
 void fgTableDispBasicBlock(const BasicBlock* block,
 const BasicBlock* nextBlock = nullptr,
 bool printEdgeLikelihoods = true,
 int blockTargetFieldWidth = 21,
 int ibcColWidth = 0);
 void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
 void fgDispBasicBlocks(bool dumpTrees = false);
 void fgDumpStmtTree(const BasicBlock* block, Statement* stmt);
Expand Down

46 changes: 41 additions & 5 deletions
src/coreclr/jit/fgbasic.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,20 +686,56 @@ void Compiler::fgReplaceJumpTarget(BasicBlock* block, BasicBlock* oldTarget, Bas

 case BBJ_SWITCH:
 {
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool changed = false;
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool existingEdge = false;
 FlowEdge* oldEdge = nullptr;
 FlowEdge* newEdge = nullptr;
 bool changed = false;

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 if (jumpTab[i]->getDestinationBlock() == newTarget)
 {
 // The new target already has an edge from this switch statement.
 // We'll need to add the likelihood from the edge we're redirecting
 // to the existing edge. Note that if there is no existing edge,
 // then we'll copy the likelihood from the existing edge we pass to
 // `fgAddRefPred`. Note also that we can visit the same edge multiple
 // times if there are multiple switch cases with the same target. The
 // edge has a dup count and a single likelihood for all the possible
 // paths to the target, so we only want to add the likelihood once
 // despite visiting the duplicated edges in the `jumpTab` array
 // multiple times.
 existingEdge = true;
 }

 if (jumpTab[i]->getDestinationBlock() == oldTarget)
 {
 fgRemoveRefPred(jumpTab[i]);
 jumpTab[i] = fgAddRefPred(newTarget, block, jumpTab[i]);
 assert((oldEdge == nullptr) || (oldEdge == jumpTab[i]));
 oldEdge = jumpTab[i];
 fgRemoveRefPred(oldEdge);
 newEdge = fgAddRefPred(newTarget, block, oldEdge);
 jumpTab[i] = newEdge;
 changed = true;
 }
 }

 if (existingEdge)
 {
 assert(oldEdge != nullptr);
 assert(oldEdge->getSourceBlock() == block);
 assert(oldEdge->getDestinationBlock() == oldTarget);
 assert(newEdge != nullptr);
 assert(newEdge->getSourceBlock() == block);
 assert(newEdge->getDestinationBlock() == newTarget);

 if (newEdge->hasLikelihood() && oldEdge->hasLikelihood())
@amanasifkhalidamanasifkhalidMar 14, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I wonder if we can start skipping these checks and asserting that the edges have likelihoods already. Once Andy's last PR for propagating likelihoods is merged in, I'll take a look at removing these.
 {
 newEdge->addLikelihood(oldEdge->getLikelihood());
 }
 }

 assert(changed);
 InvalidateUniqueSwitchSuccMap();
 break;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add edge likelihood dumping; fix one edge likelihood update case#99740

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.

 Sign up for GitHub

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

 Merged

BruceForstall
merged 1 commit into

from

Mar 14, 2024
 Merged


Add edge likelihood dumping; fix one edge likelihood update case
#99740
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 44 additions & 21 deletions
src/coreclr/jit/block.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,20 @@ void FlowEdge::setLikelihood(weight_t likelihood)
{
 assert(likelihood >= 0.0);
 assert(likelihood <= 1.0);

 if (m_likelihoodSet)
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, likelihood);
 }
 else
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, likelihood);
 }

 m_likelihoodSet = true;
 m_likelihood = likelihood;

 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -114,10 +123,11 @@ void FlowEdge::addLikelihood(weight_t addedLikelihood)

 assert(newLikelihood >= 0.0);
 assert(newLikelihood <= 1.0);
 m_likelihood = newLikelihood;

 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, newLikelihood);

 m_likelihood = newLikelihood;
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -678,20 +688,33 @@ void BasicBlock::dspSuccs(Compiler* compiler)
// things strictly.
void BasicBlock::dspKind() const
{
 auto dspBlockNum = [](const BasicBlock* b) -> const char* {
 auto dspBlockNum = [](const FlowEdge* e) -> const char* {
 static char buffers[3][64]; // static array of 3 to allow 3 concurrent calls in one printf()
 static int nextBufferIndex = 0;

 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 const size_t sizeOfBuffer = ArrLen(buffer);
 int written;

 const BasicBlock* b = e->getDestinationBlock();
 if (b == nullptr)
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), "NULL");
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, "NULL");
 }
 else
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), FMT_BB, b->bbNum);
 written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, FMT_BB, b->bbNum);
 }

 const bool printEdgeLikelihoods = true; // TODO: parameterize this?
 if (printEdgeLikelihoods)
 {
 if (e->hasLikelihood())
 {
 written = _snprintf_s(buffer + written, sizeOfBuffer - written, sizeOfBuffer - written, "(" FMT_WT ")",
 e->getLikelihood());
 }
 }

 return buffer;
Expand All@@ -715,7 +738,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));
 }
 }

Expand All@@ -728,11 +751,11 @@ void BasicBlock::dspKind() const
 break;

 case BBJ_EHFILTERRET:
 printf(" -> %s (fltret)", dspBlockNum(GetTarget()));
 printf(" -> %s (fltret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_EHCATCHRET:
 printf(" -> %s (cret)", dspBlockNum(GetTarget()));
 printf(" -> %s (cret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_THROW:
Expand All@@ -746,28 +769,28 @@ void BasicBlock::dspKind() const
 case BBJ_ALWAYS:
 if (HasFlag(BBF_KEEP_BBJ_ALWAYS))
 {
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTarget()));
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTargetEdge()));
 }
 else
 {
 printf(" -> %s (always)", dspBlockNum(GetTarget()));
 printf(" -> %s (always)", dspBlockNum(GetTargetEdge()));
 }
 break;

 case BBJ_LEAVE:
 printf(" -> %s (leave)", dspBlockNum(GetTarget()));
 printf(" -> %s (leave)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLY:
 printf(" -> %s (callf)", dspBlockNum(GetTarget()));
 printf(" -> %s (callf)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLYRET:
 printf(" -> %s (callfr)", dspBlockNum(GetTarget()));
 printf(" -> %s (callfr)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_COND:
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueTarget()), dspBlockNum(GetFalseTarget()));
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueEdge()), dspBlockNum(GetFalseEdge()));
 break;

 case BBJ_SWITCH:
Expand All@@ -779,7 +802,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));

 const bool isDefault = bbSwtTargets->bbsHasDefault && (i == jumpCnt - 1);
 if (isDefault)
Expand Down

29 changes: 27 additions & 2 deletions
src/coreclr/jit/block.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,9 +46,13 @@ typedef BitVec_ValRet_T ASSERT_VALRET_TP;
// Use this format for loop indices
#define FMT_LP "L%02u"

// And this format for profile weights
// Use this format for profile weights
#define FMT_WT "%.7g"

// Use this format for profile weights where we want to conserve horizontal space, at the expense of displaying
// less precision.
#define FMT_WT_NARROW "%.3g"

/*****************************************************************************
 *
 * Each basic block ends with a jump which is described as a value
Expand DownExpand Up@@ -1037,6 +1041,27 @@ struct BasicBlock : private LIR::Range
 return (bbFalseEdge == nullptr) ? nullptr : bbFalseEdge->getDestinationBlock();
 }

 // Return the target edge; it might be null. Only used during dumping.
 FlowEdge* GetTargetEdgeRaw() const
 {
 assert(HasTarget());
 return bbTargetEdge;
 }

 // Return the BBJ_COND true target edge; it might be null. Only used during dumping.
 FlowEdge* GetTrueEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbTrueEdge;
 }

 // Return the BBJ_COND false target edge; it might be null. Only used during dumping.
 FlowEdge* GetFalseEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbFalseEdge;
 }

#endif // DEBUG

private:
Expand DownExpand Up@@ -1537,7 +1562,7 @@ struct BasicBlock : private LIR::Range
 }

 // PredBlocksEditing: convenience method for enabling range-based `for` iteration over predecessor blocks, e.g.:
 // for (BasicBlock* const predBlock : block->PredBlocksList()) ...
 // for (BasicBlock* const predBlock : block->PredBlocksEditing()) ...
 // This iterator tolerates modifications to bbPreds.
 //
 PredBlockList<true> PredBlocksEditing() const
Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/jit/clrjit.natvis

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,8 @@ The .NET Foundation licenses this file to you under the MIT license.
<!--
Visual Studio debugger visualizers for RyuJIT.

Documentation for VS natvis format: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019

Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2019
Documentation for VS natvis format: https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022
Documentation for VS debugger format specifiers: https://learn.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2022
-->

<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
Expand All@@ -27,6 +26,11 @@ Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-u
 <DisplayString>BB{bbNum,d}; {bbKind,en}</DisplayString>
 </Type>

 <Type Name="FlowEdge">
 <DisplayString Condition="m_dupCount!=1">BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g}) (dup {m_dupCount,d})</DisplayString>
 <DisplayString>BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g})</DisplayString>
 </Type>

 <Type Name="Compiler::LoopDsc">
 <DisplayString Condition="lpFlags &amp; LPFLG_REMOVED">REMOVED</DisplayString>
 <DisplayString Condition="lpFlags &amp; LPFLG_HAS_PREHEAD">[BB{lpTop->bbNum,d}..BB{lpBottom->bbNum,d}] pre-h:BB{lpHead->bbNum,d} e:BB{lpEntry->bbNum,d} {lpFlags,en}</DisplayString>
Expand Down

8 changes: 6 additions & 2 deletions
src/coreclr/jit/compiler.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1584,7 +1584,7 @@ enum class ProfileChecks : unsigned int
 CHECK_NONE = 0,
 CHECK_CLASSIC = 1 << 0, // check "classic" jit weights
 CHECK_HASLIKELIHOOD = 1 << 1, // check all FlowEdges for hasLikelihood
 CHECK_LIKELIHOODSUM = 1 << 2, // check block succesor likelihoods sum to 1 
 CHECK_LIKELIHOODSUM = 1 << 2, // check block successor likelihoods sum to 1 
 CHECK_LIKELY = 1 << 3, // fully check likelihood based weights
 RAISE_ASSERT = 1 << 4, // assert on check failure
 CHECK_ALL_BLOCKS = 1 << 5, // check blocks even if bbHasProfileWeight is false
Expand DownExpand Up@@ -6074,7 +6074,11 @@ class Compiler

 void fgDispBBLiveness(BasicBlock* block);
 void fgDispBBLiveness();
 void fgTableDispBasicBlock(const BasicBlock* block, const BasicBlock* nextBlock = nullptr, int blockTargetFieldWidth = 21, int ibcColWidth = 0);
 void fgTableDispBasicBlock(const BasicBlock* block,
 const BasicBlock* nextBlock = nullptr,
 bool printEdgeLikelihoods = true,
 int blockTargetFieldWidth = 21,
 int ibcColWidth = 0);
 void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
 void fgDispBasicBlocks(bool dumpTrees = false);
 void fgDumpStmtTree(const BasicBlock* block, Statement* stmt);
Expand Down

46 changes: 41 additions & 5 deletions
src/coreclr/jit/fgbasic.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,20 +686,56 @@ void Compiler::fgReplaceJumpTarget(BasicBlock* block, BasicBlock* oldTarget, Bas

 case BBJ_SWITCH:
 {
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool changed = false;
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool existingEdge = false;
 FlowEdge* oldEdge = nullptr;
 FlowEdge* newEdge = nullptr;
 bool changed = false;

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 if (jumpTab[i]->getDestinationBlock() == newTarget)
 {
 // The new target already has an edge from this switch statement.
 // We'll need to add the likelihood from the edge we're redirecting
 // to the existing edge. Note that if there is no existing edge,
 // then we'll copy the likelihood from the existing edge we pass to
 // `fgAddRefPred`. Note also that we can visit the same edge multiple
 // times if there are multiple switch cases with the same target. The
 // edge has a dup count and a single likelihood for all the possible
 // paths to the target, so we only want to add the likelihood once
 // despite visiting the duplicated edges in the `jumpTab` array
 // multiple times.
 existingEdge = true;
 }

 if (jumpTab[i]->getDestinationBlock() == oldTarget)
 {
 fgRemoveRefPred(jumpTab[i]);
 jumpTab[i] = fgAddRefPred(newTarget, block, jumpTab[i]);
 assert((oldEdge == nullptr) || (oldEdge == jumpTab[i]));
 oldEdge = jumpTab[i];
 fgRemoveRefPred(oldEdge);
 newEdge = fgAddRefPred(newTarget, block, oldEdge);
 jumpTab[i] = newEdge;
 changed = true;
 }
 }

 if (existingEdge)
 {
 assert(oldEdge != nullptr);
 assert(oldEdge->getSourceBlock() == block);
 assert(oldEdge->getDestinationBlock() == oldTarget);
 assert(newEdge != nullptr);
 assert(newEdge->getSourceBlock() == block);
 assert(newEdge->getDestinationBlock() == newTarget);

 if (newEdge->hasLikelihood() && oldEdge->hasLikelihood())
@amanasifkhalidamanasifkhalidMar 14, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I wonder if we can start skipping these checks and asserting that the edges have likelihoods already. Once Andy's last PR for propagating likelihoods is merged in, I'll take a look at removing these.
 {
 newEdge->addLikelihood(oldEdge->getLikelihood());
 }
 }

 assert(changed);
 InvalidateUniqueSwitchSuccMap();
 break;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add edge likelihood dumping; fix one edge likelihood update case#99740

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.

 Sign up for GitHub

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

 Merged

BruceForstall
merged 1 commit into

from

Mar 14, 2024
 Merged


Add edge likelihood dumping; fix one edge likelihood update case
#99740
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 44 additions & 21 deletions
src/coreclr/jit/block.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,20 @@ void FlowEdge::setLikelihood(weight_t likelihood)
{
 assert(likelihood >= 0.0);
 assert(likelihood <= 1.0);

 if (m_likelihoodSet)
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, likelihood);
 }
 else
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, likelihood);
 }

 m_likelihoodSet = true;
 m_likelihood = likelihood;

 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -114,10 +123,11 @@ void FlowEdge::addLikelihood(weight_t addedLikelihood)

 assert(newLikelihood >= 0.0);
 assert(newLikelihood <= 1.0);
 m_likelihood = newLikelihood;

 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, newLikelihood);

 m_likelihood = newLikelihood;
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -678,20 +688,33 @@ void BasicBlock::dspSuccs(Compiler* compiler)
// things strictly.
void BasicBlock::dspKind() const
{
 auto dspBlockNum = [](const BasicBlock* b) -> const char* {
 auto dspBlockNum = [](const FlowEdge* e) -> const char* {
 static char buffers[3][64]; // static array of 3 to allow 3 concurrent calls in one printf()
 static int nextBufferIndex = 0;

 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 const size_t sizeOfBuffer = ArrLen(buffer);
 int written;

 const BasicBlock* b = e->getDestinationBlock();
 if (b == nullptr)
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), "NULL");
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, "NULL");
 }
 else
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), FMT_BB, b->bbNum);
 written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, FMT_BB, b->bbNum);
 }

 const bool printEdgeLikelihoods = true; // TODO: parameterize this?
 if (printEdgeLikelihoods)
 {
 if (e->hasLikelihood())
 {
 written = _snprintf_s(buffer + written, sizeOfBuffer - written, sizeOfBuffer - written, "(" FMT_WT ")",
 e->getLikelihood());
 }
 }

 return buffer;
Expand All@@ -715,7 +738,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));
 }
 }

Expand All@@ -728,11 +751,11 @@ void BasicBlock::dspKind() const
 break;

 case BBJ_EHFILTERRET:
 printf(" -> %s (fltret)", dspBlockNum(GetTarget()));
 printf(" -> %s (fltret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_EHCATCHRET:
 printf(" -> %s (cret)", dspBlockNum(GetTarget()));
 printf(" -> %s (cret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_THROW:
Expand All@@ -746,28 +769,28 @@ void BasicBlock::dspKind() const
 case BBJ_ALWAYS:
 if (HasFlag(BBF_KEEP_BBJ_ALWAYS))
 {
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTarget()));
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTargetEdge()));
 }
 else
 {
 printf(" -> %s (always)", dspBlockNum(GetTarget()));
 printf(" -> %s (always)", dspBlockNum(GetTargetEdge()));
 }
 break;

 case BBJ_LEAVE:
 printf(" -> %s (leave)", dspBlockNum(GetTarget()));
 printf(" -> %s (leave)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLY:
 printf(" -> %s (callf)", dspBlockNum(GetTarget()));
 printf(" -> %s (callf)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLYRET:
 printf(" -> %s (callfr)", dspBlockNum(GetTarget()));
 printf(" -> %s (callfr)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_COND:
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueTarget()), dspBlockNum(GetFalseTarget()));
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueEdge()), dspBlockNum(GetFalseEdge()));
 break;

 case BBJ_SWITCH:
Expand All@@ -779,7 +802,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));

 const bool isDefault = bbSwtTargets->bbsHasDefault && (i == jumpCnt - 1);
 if (isDefault)
Expand Down

29 changes: 27 additions & 2 deletions
src/coreclr/jit/block.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,9 +46,13 @@ typedef BitVec_ValRet_T ASSERT_VALRET_TP;
// Use this format for loop indices
#define FMT_LP "L%02u"

// And this format for profile weights
// Use this format for profile weights
#define FMT_WT "%.7g"

// Use this format for profile weights where we want to conserve horizontal space, at the expense of displaying
// less precision.
#define FMT_WT_NARROW "%.3g"

/*****************************************************************************
 *
 * Each basic block ends with a jump which is described as a value
Expand DownExpand Up@@ -1037,6 +1041,27 @@ struct BasicBlock : private LIR::Range
 return (bbFalseEdge == nullptr) ? nullptr : bbFalseEdge->getDestinationBlock();
 }

 // Return the target edge; it might be null. Only used during dumping.
 FlowEdge* GetTargetEdgeRaw() const
 {
 assert(HasTarget());
 return bbTargetEdge;
 }

 // Return the BBJ_COND true target edge; it might be null. Only used during dumping.
 FlowEdge* GetTrueEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbTrueEdge;
 }

 // Return the BBJ_COND false target edge; it might be null. Only used during dumping.
 FlowEdge* GetFalseEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbFalseEdge;
 }

#endif // DEBUG

private:
Expand DownExpand Up@@ -1537,7 +1562,7 @@ struct BasicBlock : private LIR::Range
 }

 // PredBlocksEditing: convenience method for enabling range-based `for` iteration over predecessor blocks, e.g.:
 // for (BasicBlock* const predBlock : block->PredBlocksList()) ...
 // for (BasicBlock* const predBlock : block->PredBlocksEditing()) ...
 // This iterator tolerates modifications to bbPreds.
 //
 PredBlockList<true> PredBlocksEditing() const
Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/jit/clrjit.natvis

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,8 @@ The .NET Foundation licenses this file to you under the MIT license.
<!--
Visual Studio debugger visualizers for RyuJIT.

Documentation for VS natvis format: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019

Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2019
Documentation for VS natvis format: https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022
Documentation for VS debugger format specifiers: https://learn.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2022
-->

<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
Expand All@@ -27,6 +26,11 @@ Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-u
 <DisplayString>BB{bbNum,d}; {bbKind,en}</DisplayString>
 </Type>

 <Type Name="FlowEdge">
 <DisplayString Condition="m_dupCount!=1">BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g}) (dup {m_dupCount,d})</DisplayString>
 <DisplayString>BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g})</DisplayString>
 </Type>

 <Type Name="Compiler::LoopDsc">
 <DisplayString Condition="lpFlags &amp; LPFLG_REMOVED">REMOVED</DisplayString>
 <DisplayString Condition="lpFlags &amp; LPFLG_HAS_PREHEAD">[BB{lpTop->bbNum,d}..BB{lpBottom->bbNum,d}] pre-h:BB{lpHead->bbNum,d} e:BB{lpEntry->bbNum,d} {lpFlags,en}</DisplayString>
Expand Down

8 changes: 6 additions & 2 deletions
src/coreclr/jit/compiler.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1584,7 +1584,7 @@ enum class ProfileChecks : unsigned int
 CHECK_NONE = 0,
 CHECK_CLASSIC = 1 << 0, // check "classic" jit weights
 CHECK_HASLIKELIHOOD = 1 << 1, // check all FlowEdges for hasLikelihood
 CHECK_LIKELIHOODSUM = 1 << 2, // check block succesor likelihoods sum to 1 
 CHECK_LIKELIHOODSUM = 1 << 2, // check block successor likelihoods sum to 1 
 CHECK_LIKELY = 1 << 3, // fully check likelihood based weights
 RAISE_ASSERT = 1 << 4, // assert on check failure
 CHECK_ALL_BLOCKS = 1 << 5, // check blocks even if bbHasProfileWeight is false
Expand DownExpand Up@@ -6074,7 +6074,11 @@ class Compiler

 void fgDispBBLiveness(BasicBlock* block);
 void fgDispBBLiveness();
 void fgTableDispBasicBlock(const BasicBlock* block, const BasicBlock* nextBlock = nullptr, int blockTargetFieldWidth = 21, int ibcColWidth = 0);
 void fgTableDispBasicBlock(const BasicBlock* block,
 const BasicBlock* nextBlock = nullptr,
 bool printEdgeLikelihoods = true,
 int blockTargetFieldWidth = 21,
 int ibcColWidth = 0);
 void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
 void fgDispBasicBlocks(bool dumpTrees = false);
 void fgDumpStmtTree(const BasicBlock* block, Statement* stmt);
Expand Down

46 changes: 41 additions & 5 deletions
src/coreclr/jit/fgbasic.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,20 +686,56 @@ void Compiler::fgReplaceJumpTarget(BasicBlock* block, BasicBlock* oldTarget, Bas

 case BBJ_SWITCH:
 {
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool changed = false;
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool existingEdge = false;
 FlowEdge* oldEdge = nullptr;
 FlowEdge* newEdge = nullptr;
 bool changed = false;

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 if (jumpTab[i]->getDestinationBlock() == newTarget)
 {
 // The new target already has an edge from this switch statement.
 // We'll need to add the likelihood from the edge we're redirecting
 // to the existing edge. Note that if there is no existing edge,
 // then we'll copy the likelihood from the existing edge we pass to
 // `fgAddRefPred`. Note also that we can visit the same edge multiple
 // times if there are multiple switch cases with the same target. The
 // edge has a dup count and a single likelihood for all the possible
 // paths to the target, so we only want to add the likelihood once
 // despite visiting the duplicated edges in the `jumpTab` array
 // multiple times.
 existingEdge = true;
 }

 if (jumpTab[i]->getDestinationBlock() == oldTarget)
 {
 fgRemoveRefPred(jumpTab[i]);
 jumpTab[i] = fgAddRefPred(newTarget, block, jumpTab[i]);
 assert((oldEdge == nullptr) || (oldEdge == jumpTab[i]));
 oldEdge = jumpTab[i];
 fgRemoveRefPred(oldEdge);
 newEdge = fgAddRefPred(newTarget, block, oldEdge);
 jumpTab[i] = newEdge;
 changed = true;
 }
 }

 if (existingEdge)
 {
 assert(oldEdge != nullptr);
 assert(oldEdge->getSourceBlock() == block);
 assert(oldEdge->getDestinationBlock() == oldTarget);
 assert(newEdge != nullptr);
 assert(newEdge->getSourceBlock() == block);
 assert(newEdge->getDestinationBlock() == newTarget);

 if (newEdge->hasLikelihood() && oldEdge->hasLikelihood())
@amanasifkhalidamanasifkhalidMar 14, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I wonder if we can start skipping these checks and asserting that the edges have likelihoods already. Once Andy's last PR for propagating likelihoods is merged in, I'll take a look at removing these.
 {
 newEdge->addLikelihood(oldEdge->getLikelihood());
 }
 }

 assert(changed);
 InvalidateUniqueSwitchSuccMap();
 break;
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add edge likelihood dumping; fix one edge likelihood update case#99740

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.

 Sign up for GitHub

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

 Merged

BruceForstall
merged 1 commit into

from

Mar 14, 2024
 Merged


Add edge likelihood dumping; fix one edge likelihood update case
#99740
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


65 changes: 44 additions & 21 deletions
src/coreclr/jit/block.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -79,11 +79,20 @@ void FlowEdge::setLikelihood(weight_t likelihood)
{
 assert(likelihood >= 0.0);
 assert(likelihood <= 1.0);

 if (m_likelihoodSet)
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, likelihood);
 }
 else
 {
 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, likelihood);
 }

 m_likelihoodSet = true;
 m_likelihood = likelihood;

 JITDUMP("setting likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -114,10 +123,11 @@ void FlowEdge::addLikelihood(weight_t addedLikelihood)

 assert(newLikelihood >= 0.0);
 assert(newLikelihood <= 1.0);
 m_likelihood = newLikelihood;

 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " to " FMT_WT "\n", m_sourceBlock->bbNum, m_destBlock->bbNum,
 m_likelihood);
 JITDUMP("updating likelihood of " FMT_BB " -> " FMT_BB " from " FMT_WT " to " FMT_WT "\n", m_sourceBlock->bbNum,
 m_destBlock->bbNum, m_likelihood, newLikelihood);

 m_likelihood = newLikelihood;
}

//------------------------------------------------------------------------
Expand DownExpand Up@@ -678,20 +688,33 @@ void BasicBlock::dspSuccs(Compiler* compiler)
// things strictly.
void BasicBlock::dspKind() const
{
 auto dspBlockNum = [](const BasicBlock* b) -> const char* {
 auto dspBlockNum = [](const FlowEdge* e) -> const char* {
 static char buffers[3][64]; // static array of 3 to allow 3 concurrent calls in one printf()
 static int nextBufferIndex = 0;

 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 auto& buffer = buffers[nextBufferIndex];
 nextBufferIndex = (nextBufferIndex + 1) % ArrLen(buffers);
 const size_t sizeOfBuffer = ArrLen(buffer);
 int written;

 const BasicBlock* b = e->getDestinationBlock();
 if (b == nullptr)
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), "NULL");
written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, "NULL");
 }
 else
 {
 _snprintf_s(buffer, ArrLen(buffer), ArrLen(buffer), FMT_BB, b->bbNum);
 written = _snprintf_s(buffer, sizeOfBuffer, sizeOfBuffer, FMT_BB, b->bbNum);
 }

 const bool printEdgeLikelihoods = true; // TODO: parameterize this?
 if (printEdgeLikelihoods)
 {
 if (e->hasLikelihood())
 {
 written = _snprintf_s(buffer + written, sizeOfBuffer - written, sizeOfBuffer - written, "(" FMT_WT ")",
 e->getLikelihood());
 }
 }

 return buffer;
Expand All@@ -715,7 +738,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));
 }
 }

Expand All@@ -728,11 +751,11 @@ void BasicBlock::dspKind() const
 break;

 case BBJ_EHFILTERRET:
 printf(" -> %s (fltret)", dspBlockNum(GetTarget()));
 printf(" -> %s (fltret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_EHCATCHRET:
 printf(" -> %s (cret)", dspBlockNum(GetTarget()));
 printf(" -> %s (cret)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_THROW:
Expand All@@ -746,28 +769,28 @@ void BasicBlock::dspKind() const
 case BBJ_ALWAYS:
 if (HasFlag(BBF_KEEP_BBJ_ALWAYS))
 {
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTarget()));
 printf(" -> %s (ALWAYS)", dspBlockNum(GetTargetEdge()));
 }
 else
 {
 printf(" -> %s (always)", dspBlockNum(GetTarget()));
 printf(" -> %s (always)", dspBlockNum(GetTargetEdge()));
 }
 break;

 case BBJ_LEAVE:
 printf(" -> %s (leave)", dspBlockNum(GetTarget()));
 printf(" -> %s (leave)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLY:
 printf(" -> %s (callf)", dspBlockNum(GetTarget()));
 printf(" -> %s (callf)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_CALLFINALLYRET:
 printf(" -> %s (callfr)", dspBlockNum(GetTarget()));
 printf(" -> %s (callfr)", dspBlockNum(GetTargetEdge()));
 break;

 case BBJ_COND:
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueTarget()), dspBlockNum(GetFalseTarget()));
 printf(" -> %s,%s (cond)", dspBlockNum(GetTrueEdge()), dspBlockNum(GetFalseEdge()));
 break;

 case BBJ_SWITCH:
Expand All@@ -779,7 +802,7 @@ void BasicBlock::dspKind() const

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]->getDestinationBlock()));
 printf("%c%s", (i == 0) ? ' ' : ',', dspBlockNum(jumpTab[i]));

 const bool isDefault = bbSwtTargets->bbsHasDefault && (i == jumpCnt - 1);
 if (isDefault)
Expand Down

29 changes: 27 additions & 2 deletions
src/coreclr/jit/block.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -46,9 +46,13 @@ typedef BitVec_ValRet_T ASSERT_VALRET_TP;
// Use this format for loop indices
#define FMT_LP "L%02u"

// And this format for profile weights
// Use this format for profile weights
#define FMT_WT "%.7g"

// Use this format for profile weights where we want to conserve horizontal space, at the expense of displaying
// less precision.
#define FMT_WT_NARROW "%.3g"

/*****************************************************************************
 *
 * Each basic block ends with a jump which is described as a value
Expand DownExpand Up@@ -1037,6 +1041,27 @@ struct BasicBlock : private LIR::Range
 return (bbFalseEdge == nullptr) ? nullptr : bbFalseEdge->getDestinationBlock();
 }

 // Return the target edge; it might be null. Only used during dumping.
 FlowEdge* GetTargetEdgeRaw() const
 {
 assert(HasTarget());
 return bbTargetEdge;
 }

 // Return the BBJ_COND true target edge; it might be null. Only used during dumping.
 FlowEdge* GetTrueEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbTrueEdge;
 }

 // Return the BBJ_COND false target edge; it might be null. Only used during dumping.
 FlowEdge* GetFalseEdgeRaw() const
 {
 assert(KindIs(BBJ_COND));
 return bbFalseEdge;
 }

#endif // DEBUG

private:
Expand DownExpand Up@@ -1537,7 +1562,7 @@ struct BasicBlock : private LIR::Range
 }

 // PredBlocksEditing: convenience method for enabling range-based `for` iteration over predecessor blocks, e.g.:
 // for (BasicBlock* const predBlock : block->PredBlocksList()) ...
 // for (BasicBlock* const predBlock : block->PredBlocksEditing()) ...
 // This iterator tolerates modifications to bbPreds.
 //
 PredBlockList<true> PredBlocksEditing() const
Expand Down

10 changes: 7 additions & 3 deletions
src/coreclr/jit/clrjit.natvis

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,8 @@ The .NET Foundation licenses this file to you under the MIT license.
<!--
Visual Studio debugger visualizers for RyuJIT.

Documentation for VS natvis format: https://docs.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2019

Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2019
Documentation for VS natvis format: https://learn.microsoft.com/en-us/visualstudio/debugger/create-custom-views-of-native-objects?view=vs-2022
Documentation for VS debugger format specifiers: https://learn.microsoft.com/en-us/visualstudio/debugger/format-specifiers-in-cpp?view=vs-2022
-->

<AutoVisualizer xmlns="http://schemas.microsoft.com/vstudio/debugger/natvis/2010">
Expand All@@ -27,6 +26,11 @@ Documentation for VS debugger format specifiers: https://docs.microsoft.com/en-u
 <DisplayString>BB{bbNum,d}; {bbKind,en}</DisplayString>
 </Type>

 <Type Name="FlowEdge">
 <DisplayString Condition="m_dupCount!=1">BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g}) (dup {m_dupCount,d})</DisplayString>
 <DisplayString>BB{m_sourceBlock->bbNum,d}->BB{m_destBlock->bbNum,d} ({m_likelihood,g})</DisplayString>
 </Type>

 <Type Name="Compiler::LoopDsc">
 <DisplayString Condition="lpFlags &amp; LPFLG_REMOVED">REMOVED</DisplayString>
 <DisplayString Condition="lpFlags &amp; LPFLG_HAS_PREHEAD">[BB{lpTop->bbNum,d}..BB{lpBottom->bbNum,d}] pre-h:BB{lpHead->bbNum,d} e:BB{lpEntry->bbNum,d} {lpFlags,en}</DisplayString>
Expand Down

8 changes: 6 additions & 2 deletions
src/coreclr/jit/compiler.h

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1584,7 +1584,7 @@ enum class ProfileChecks : unsigned int
 CHECK_NONE = 0,
 CHECK_CLASSIC = 1 << 0, // check "classic" jit weights
 CHECK_HASLIKELIHOOD = 1 << 1, // check all FlowEdges for hasLikelihood
 CHECK_LIKELIHOODSUM = 1 << 2, // check block succesor likelihoods sum to 1 
 CHECK_LIKELIHOODSUM = 1 << 2, // check block successor likelihoods sum to 1 
 CHECK_LIKELY = 1 << 3, // fully check likelihood based weights
 RAISE_ASSERT = 1 << 4, // assert on check failure
 CHECK_ALL_BLOCKS = 1 << 5, // check blocks even if bbHasProfileWeight is false
Expand DownExpand Up@@ -6074,7 +6074,11 @@ class Compiler

 void fgDispBBLiveness(BasicBlock* block);
 void fgDispBBLiveness();
 void fgTableDispBasicBlock(const BasicBlock* block, const BasicBlock* nextBlock = nullptr, int blockTargetFieldWidth = 21, int ibcColWidth = 0);
 void fgTableDispBasicBlock(const BasicBlock* block,
 const BasicBlock* nextBlock = nullptr,
 bool printEdgeLikelihoods = true,
 int blockTargetFieldWidth = 21,
 int ibcColWidth = 0);
 void fgDispBasicBlocks(BasicBlock* firstBlock, BasicBlock* lastBlock, bool dumpTrees);
 void fgDispBasicBlocks(bool dumpTrees = false);
 void fgDumpStmtTree(const BasicBlock* block, Statement* stmt);
Expand Down

46 changes: 41 additions & 5 deletions
src/coreclr/jit/fgbasic.cpp

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -686,20 +686,56 @@ void Compiler::fgReplaceJumpTarget(BasicBlock* block, BasicBlock* oldTarget, Bas

 case BBJ_SWITCH:
 {
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool changed = false;
 unsigned const jumpCnt = block->GetSwitchTargets()->bbsCount;
 FlowEdge** const jumpTab = block->GetSwitchTargets()->bbsDstTab;
 bool existingEdge = false;
 FlowEdge* oldEdge = nullptr;
 FlowEdge* newEdge = nullptr;
 bool changed = false;

 for (unsigned i = 0; i < jumpCnt; i++)
 {
 if (jumpTab[i]->getDestinationBlock() == newTarget)
 {
 // The new target already has an edge from this switch statement.
 // We'll need to add the likelihood from the edge we're redirecting
 // to the existing edge. Note that if there is no existing edge,
 // then we'll copy the likelihood from the existing edge we pass to
 // `fgAddRefPred`. Note also that we can visit the same edge multiple
 // times if there are multiple switch cases with the same target. The
 // edge has a dup count and a single likelihood for all the possible
 // paths to the target, so we only want to add the likelihood once
 // despite visiting the duplicated edges in the `jumpTab` array
 // multiple times.
 existingEdge = true;
 }

 if (jumpTab[i]->getDestinationBlock() == oldTarget)
 {
 fgRemoveRefPred(jumpTab[i]);
 jumpTab[i] = fgAddRefPred(newTarget, block, jumpTab[i]);
 assert((oldEdge == nullptr) || (oldEdge == jumpTab[i]));
 oldEdge = jumpTab[i];
 fgRemoveRefPred(oldEdge);
 newEdge = fgAddRefPred(newTarget, block, oldEdge);
 jumpTab[i] = newEdge;
 changed = true;
 }
 }

 if (existingEdge)
 {
 assert(oldEdge != nullptr);
 assert(oldEdge->getSourceBlock() == block);
 assert(oldEdge->getDestinationBlock() == oldTarget);
 assert(newEdge != nullptr);
 assert(newEdge->getSourceBlock() == block);
 assert(newEdge->getDestinationBlock() == newTarget);

 if (newEdge->hasLikelihood() && oldEdge->hasLikelihood())
@amanasifkhalidamanasifkhalidMar 14, 2024

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

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

I wonder if we can start skipping these checks and asserting that the edges have likelihoods already. Once Andy's last PR for propagating likelihoods is merged in, I'll take a look at removing these.
 {
 newEdge->addLikelihood(oldEdge->getLikelihood());
 }
 }

 assert(changed);
 InvalidateUniqueSwitchSuccMap();
 break;
Expand Down
Loading