Skip to content

JIT: Transform arithmetic using distributive property#126852

Open
BoyBaykiller wants to merge 18 commits into
dotnet:mainfrom
BoyBaykiller:transform-using-distributive-property
Open

JIT: Transform arithmetic using distributive property#126852
BoyBaykiller wants to merge 18 commits into
dotnet:mainfrom
BoyBaykiller:transform-using-distributive-property

Conversation

@BoyBaykiller

@BoyBaykiller BoyBaykiller commented Apr 13, 2026

Copy link
Copy Markdown
Contributor

Generalization of #126070
Progress towards #93954

Basically we weren't doing any simplification based on distributive property before. So transforming
((A op1 B) op2 (A op1 C)) => (A op1 (B op2 C)). And this adds some basic support. Examples:

int MulDistedOverAdd(int A, int B, int C)
{
    return (A * B) + (A * C);
}
;; ------ BASE
G_M000_IG02:
       mov      eax, edx
       imul     eax, r8d
       imul     r9d, edx
       add      eax, r9d

;; ------ DIFF
G_M48043_IG02:  ;; offset=0x0000
       lea      eax, [r8+r9]
       imul     eax, edx
bool AfterOptimizeBools(int A, int B)
{
    return (A & 4) != 0 || (A & 8) != 0;
}
;; ------ BASE
       mov      eax, edx
       and      eax, 4
       and      edx, 8
       or       eax, edx
       setne    al
       movzx    rax, al

;; ------ DIFF
G_M55610_IG02:
       test     dl, 12
       setne    al
       movzx    rax, al

We still need something that changes order to enable this opt. So (A | B) | C becoming A | (B | C) in this case:

uint Reassociate(uint foo, uint flags)
{
    return (foo | (flags & 256)) | (flags & 512);
}

Or here, the C * A need to be reversed.

int Reassociate(int A, int B, int C)
{
    return (A * B) + (C * A);
}

@github-actions github-actions Bot added the area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI label Apr 13, 2026
@dotnet-policy-service dotnet-policy-service Bot added the community-contribution Indicates that the PR has been added by a community member label Apr 13, 2026
@dotnet-policy-service

Copy link
Copy Markdown
Contributor

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

Comment thread src/coreclr/jit/morph.cpp Outdated
return tree;
}

if (((tree->gtFlags & GTF_PERSISTENT_SIDE_EFFECTS) != 0) || ((tree->gtFlags & GTF_ORDER_SIDEEFF) != 0))

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.

This could use the same optimization you are trying to apply😅... Probably handled by c++ though, so this is purely documentation ;-)

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Lol. A new level of self documenting code. I didn't even notice that, I copied this check from elsewhere. I guess this just goes to show how useful the optimization is. Unfortunately even with this PR it's still not handled : (

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Update: This now gets handled by calling this opt again after the "optimizeBools" phase where it simplifies e.g
(A & 4) != 0 || (A & 8) != 0 into ((A & 4) | (A & 8)) != 0.

@BoyBaykiller

BoyBaykiller commented Apr 15, 2026

Copy link
Copy Markdown
Contributor Author

@EgorBo PTAL. Diffs are rather small, but nonetheless I believe it's a step in the right direction. I've written down some future work (which all improve diffs). I think the most interesting case for real-world code is arround bitwise ops.
Also should this go into post-order or pre-order morphing?

@BoyBaykiller
BoyBaykiller marked this pull request as ready for review April 15, 2026 01:07
@BoyBaykiller

Copy link
Copy Markdown
Contributor Author

Calling fgMorphBlockStmt after optimizeBools fixes point 2 in my list and produces much better diffs old new

@BoyBaykiller

BoyBaykiller commented Apr 15, 2026

Copy link
Copy Markdown
Contributor Author

Regarding point 1. The issue is that this runs first:

runtime/src/coreclr/jit/morph.cpp

Lines 10665 to 10690 in e0fb1f9

else if (mulShiftOpt && (lowestBit > 1) && jitIsScaleIndexMul(lowestBit))
{
int shift = genLog2(lowestBit);
ssize_t factor = abs_mult >> shift;
if (factor == 3 || factor == 5 || factor == 9)
{
// if negative negate (min-int does not need negation)
if (mult < 0 && mult != SSIZE_T_MIN)
{
op1 = gtNewOperNode(GT_NEG, genActualType(op1), op1);
mul->gtOp1 = op1;
fgMorphTreeDone(op1);
}
// change the multiplication into a smaller multiplication (by 3, 5 or 9) and a shift
GenTree* const factorNode = gtNewIconNodeWithVN(this, factor, mul->TypeGet());
factorNode->SetMorphed(this);
op1 = gtNewOperNode(GT_MUL, mul->TypeGet(), op1, factorNode);
mul->gtOp1 = op1;
fgMorphTreeDone(op1);
op2->AsIntConCommon()->SetIconValue(shift);
changeToShift = true;
}
}

Perhaps this should be moved to Lower. LLVM also does it in "X86 DAG->DAG Instruction Selection" and not "InstCombine" https://godbolt.org/z/jsPea1PhP

Comment thread src/coreclr/jit/optimizebools.cpp Outdated
Comment thread src/coreclr/jit/morph.cpp Outdated
Comment thread src/coreclr/jit/morph.cpp Outdated

auto isLeftDistributive = [](genTreeOps op1, genTreeOps op2) {
// op1 is left distributive over op2 iff:
// "A op1 (B op2 C)" <==> "(A op1 B) op2 (A op1 C)"

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We already do something similar for GT_ADD somewhere, we should unify it with that

@BoyBaykiller BoyBaykiller Jun 4, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I didn't find what you are refering to here

Comment thread src/coreclr/jit/optimizebools.cpp Outdated
Comment thread src/coreclr/jit/gentree.cpp Outdated
@BoyBaykiller

Copy link
Copy Markdown
Contributor Author

I've limited it to OperIsAnyLocal, as discussed. Ready for an other review.

EgorBo pushed a commit that referenced this pull request Jun 4, 2026
Basically so we always have 0 at the right-side:

1. '(A & pow2) == pow2' -> '(A & pow2) != 0'
2. '(A & pow2) != pow2' -> '(A & pow2) == 0'

Tthis currently helps optimizeBools, but I am also adding this with the
future in mind.
Here is one example:
```cs
static bool Example(int foo)
{
    return ((foo & 4) == 4) || ((foo & 8) == 8);
}
```
```assembly
;; ------ BASE
G_M000_IG02:                ;; offset=0x0000
       test     cl, 4
       je       SHORT G_M000_IG05
 
G_M000_IG03:                ;; offset=0x0005
       mov      eax, 1
 
G_M000_IG04:                ;; offset=0x000A
       ret      
 
G_M000_IG05:                ;; offset=0x000B
       test     cl, 8
       setne    al
       movzx    rax, al
 
G_M000_IG06:                ;; offset=0x0014
       ret      

;; ------ DIFF
G_M33938_IG02:  ;; offset=0x0000
       mov      eax, ecx
       and      eax, 4
       and      ecx, 8
       or       eax, ecx
       setne    al
       movzx    rax, al
```

Note: With #126852 this would then
get transformed into just `test 12`.
@JulieLeeMSFT

Copy link
Copy Markdown
Member

@EgorBo, PTAL.

@EgorBo

EgorBo commented Jun 30, 2026

Copy link
Copy Markdown
Member

@MihuBot -nuget

@EgorBo

EgorBo commented Jul 1, 2026

Copy link
Copy Markdown
Member

@MihaZupan

Copy link
Copy Markdown
Member

Just testing error reporting changes

@MihuBot -nuget

@MihuBot

MihuBot commented Jul 1, 2026

Copy link
Copy Markdown

Warning

2 extra test assemblies failed to produce JIT diffs and were excluded from the diff analysis:

  • MathNet.Numerics.dll (pr)
  • Pipelines.Sockets.Unofficial.dll (pr)

All failures happened only on the PR branch, which likely indicates a bug introduced by the PR (e.g. a JIT assert or crash while compiling these assemblies).

See job details in MihuBot/runtime-utils#2058, triggered by #126852 (comment).

eiriktsarpalis pushed a commit that referenced this pull request Jul 15, 2026
Basically so we always have 0 at the right-side:

1. '(A & pow2) == pow2' -> '(A & pow2) != 0'
2. '(A & pow2) != pow2' -> '(A & pow2) == 0'

Tthis currently helps optimizeBools, but I am also adding this with the
future in mind.
Here is one example:
```cs
static bool Example(int foo)
{
    return ((foo & 4) == 4) || ((foo & 8) == 8);
}
```
```assembly
;; ------ BASE
G_M000_IG02:                ;; offset=0x0000
       test     cl, 4
       je       SHORT G_M000_IG05
 
G_M000_IG03:                ;; offset=0x0005
       mov      eax, 1
 
G_M000_IG04:                ;; offset=0x000A
       ret      
 
G_M000_IG05:                ;; offset=0x000B
       test     cl, 8
       setne    al
       movzx    rax, al
 
G_M000_IG06:                ;; offset=0x0014
       ret      

;; ------ DIFF
G_M33938_IG02:  ;; offset=0x0000
       mov      eax, ecx
       and      eax, 4
       and      ecx, 8
       or       eax, ecx
       setne    al
       movzx    rax, al
```

Note: With #126852 this would then
get transformed into just `test 12`.
@github-actions

github-actions Bot commented Jul 19, 2026

Copy link
Copy Markdown
Contributor

Workflow state for the Holistic Review Orchestrator.

{
  "version": 5,
  "last_dispatched_commit": "ef82e04e0d0ec0a577f66e436b30a9adf3b47b77",
  "last_dispatched_base_ref": "main",
  "last_dispatched_base_sha": "f32edc0223b18865778e8e4d335e31bf9a2933f0",
  "last_reviewed_commit": "ef82e04e0d0ec0a577f66e436b30a9adf3b47b77",
  "last_reviewed_base_ref": "main",
  "last_reviewed_base_sha": "f32edc0223b18865778e8e4d335e31bf9a2933f0",
  "last_recorded_worker_run_id": "29679146097",
  "review_attempt_commit": "",
  "review_attempt_base_ref": "",
  "review_attempt_count": 0,
  "max_review_attempts": 5,
  "review_history_format": "holistic-review-disclosure-v1",
  "review_history": [
    {
      "commit": "ef82e04e0d0ec0a577f66e436b30a9adf3b47b77",
      "review_id": 4730527763
    }
  ]
}

@github-actions github-actions Bot left a comment

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.

Holistic Review

Motivation: Generalizes #126070 and makes progress on #93954 by teaching the JIT to simplify arithmetic via the distributive property, i.e. (A op1 B) op2 (A op1 C) => A op1 (B op2 C). This reduces instruction count in common patterns (e.g. (A*B)+(A*C) folding to A*(B+C), and bit-test patterns after optOptimizeBools), which is a worthwhile codegen improvement.

Approach: Adds gtFoldDistributiveArithmetic invoked from gtFoldExprBinary for GT_AND/GT_OR/GT_XOR/GT_ADD/GT_SUB trees. It uses an isLeftDistributive table (AND/OR/MUL over their duals) and, when both operands share the same outer op and their left children are matching locals, rebuilds the tree with the common factor extracted. It also re-runs gtFoldExpr on the newly-combined boolean fold result in optOptimizeBoolsUpdateTrees, and tidies an unrelated cmp->gtOp2 -> cmp->gtGetOp2() reference in morph.cpp.

Summary: The transform is conceptually sound for wrapping (unchecked) integer arithmetic, and the guarding on optimization level, overflow of the outer node, side effects, and integral type is a reasonable start. However there is one correctness concern worth resolving before merge: the overflow check only examines the outer tree, not the inner operands. For checked(A*B) + checked(A*C) the inner GT_MUL nodes carry GTF_OVERFLOW, yet the rebuilt A*(B+C) uses a plain unchecked GT_MUL, dropping the overflow checks and altering observable behavior (a missing OverflowException). See the inline comment on the guard. I'd recommend adding a targeted regression test covering the checked-arithmetic case (and confirming it is rejected) once the guard is tightened. A secondary, non-blocking note: the freshly-created newOp2 node does not get value numbers assigned even though gtFoldExpr may be reached post-VN via optOptimizeBools; only result receives SetVNsFromNode. Verify this is benign in that phase (constants typically fold away, but a non-constant B op C combination would leave an unnumbered node).

Detailed Findings

  • Checked-arithmetic correctness (see inline comment on gtFoldDistributiveArithmetic): outer-only overflow guard can drop inner checked-multiply/add/sub semantics. Recommend also bailing when the operands being merged have gtOverflowEx()/GTF_EXCEPT set.
  • VN coverage of newOp2 (non-blocking): SetVNsFromNode(tree) is applied to result only; the intermediate newOp2 = gtFoldExpr(B op C) node has no VN. Since this path is also reachable from optOptimizeBoolsUpdateTrees after value numbering, confirm an unnumbered non-constant intermediate cannot reach a consumer that requires valid VNs.
  • Scope observation (non-blocking): the transform requires the shared factor to be OperIsAnyLocal. This is a safe, conservative choice (no duplicated side effects / re-evaluation), consistent with the PR description noting reassociation is not yet handled.

Note

This review was generated by this repository's Holistic Review agentic workflow to complement the built-in Copilot review.

Generated by Holistic Review · 115.6 AIC · ⌖ 11 AIC · ⊞ 10K

Comment thread src/coreclr/jit/gentree.cpp Outdated
{
assert(tree->OperIs(GT_AND, GT_OR, GT_XOR, GT_ADD, GT_SUB));

if (opts.OptimizationDisabled() || tree->gtOverflowEx() || !varTypeIsIntegralOrI(tree))

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.

The overflow guard only inspects the outer tree, not the inner operands op1/op2. For an inner distributive op that can overflow-throw, this can silently drop checked semantics. Concretely, checked(A * B) + checked(A * C) has an unchecked outer GT_ADD but two inner GT_MUL nodes carrying GTF_OVERFLOW. isLeftDistributive(GT_MUL, GT_ADD) is true, so the transform rebuilds the tree as A * (B + C) via gtNewOperNode(GT_MUL, ...) with no overflow flag, discarding both checked multiplications. That changes observable behavior (a program that should throw OverflowException no longer does). For unchecked/wrapping arithmetic the distribution is correct mod 2^n, but the checked case is not. Consider also rejecting when op1/op2 (or their relevant children) have gtOverflowEx() set, or more conservatively bail when GTF_EXCEPT is present on the operands being merged.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@BoyBaykiller that is a good point, this PR basically breaks this:

static int F(int a, int b, int c) =>
    checked(a * b) + checked(a * c);

With:

a = 2
b = 0x40000000
c = -0x40000000

Comment thread src/coreclr/jit/gentree.cpp Outdated
{
GenTree* newOp1 = op1->gtGetOp1();
GenTree* newOp2 =
gtFoldExpr(gtNewOperNode(tree->OperGet(), tree->TypeGet(), op1->gtGetOp2(), op2->gtGetOp2()));

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

seems like this gtNewOperNode is not marked as MORPHED

@BoyBaykiller

Copy link
Copy Markdown
Contributor Author

Failures fixed?

@MihuBot -nuget

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area-CodeGen-coreclr CLR JIT compiler in src/coreclr/src/jit and related components such as SuperPMI community-contribution Indicates that the PR has been added by a community member

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants