RFR: 8282365: Consolidate and improve division by constant idealizations [v42]

[Stefan Karlsson]

On Mon, 25 Dec 2023 17:57:28 GMT, Quan Anh Mai <qamai at openjdk.org> wrote:

>> This patch implements idealisation for unsigned divisions to change a division by a constant into a series of multiplication and shift. I also change the idealisation of `DivI` to get a more efficient series when the magic constant overflows an int32.
>> 
>> In general, the idea behind a signed division transformation is that for a positive constant `d`, we would need to find constants `c` and `m` so that:
>> 
>>     floor(x / d) = floor(x * c / 2**m) for 0 < x < 2**(N - 1) (1)
>>     ceil(x / d) = floor(x * c / 2**m) + 1 for -2**(N - 1) <= x < 0 (2)
>> 
>> The implementation in the original book takes into consideration that the machine may not be able to perform the full multiplication `x * c`, so the constant overflow and we need to add back the dividend as in `DivLNode::Ideal` cases. However, for int32 division, `x * c` cannot overflow an int64. As a result, it is always feasible to just calculate the product and shift the result.
>> 
>> For unsigned multiplication, the situation is somewhat trickier because the condition needs to be twice as strong (the condition (1) and (2) above are mostly the same). This results in the magic constant `c` calculated based on the method presented in Hacker's Delight by Henry S. Warren, Jr. may overflow an uintN. For int division, we can depend on the theorem devised by Arch D. Robison in N-Bit Unsigned Division Via N-Bit Multiply-Add, which states that there exists either:
>> 
>>     c1 in uint32 and m1, such that floor(x / d) = floor(x * c1 / 2**m1) for 0 < x < 2**32 (3)
>>     c2 in uint32 and m2, such that floor(x / d) = floor((x + 1) * c2 / 2**m2) for 0 < x < 2**32 (4)
>> 
>> which means that either `x * c1` never overflows an uint64 or `(x + 1) * c2` never overflows an uint64. And we can perform a full multiplication.
>> 
>> For longs, there is no way to do a full multiplication so we do some basic transformations to achieve a computable formula. The details I have written as comments in the overflow case.
>> 
>> More tests are added to cover the possible patterns.
>> 
>> Please take a look and have some reviews. Thank you very much.
>
> Quan Anh Mai has updated the pull request incrementally with one additional commit since the last revision:
> 
>   power of 2

I'm not reviewing the patch itself, but I'd like to request some tweaks to the include blocks in the HotSpot code.

src/hotspot/share/opto/divconstants.cpp line 27:

> 25: #include "precompiled.hpp"
> 26: #include "utilities/powerOfTwo.hpp"
> 27: #include <limits>

Please add a blank line between the HotSpot includes and the system includes.

src/hotspot/share/opto/divnode.cpp line 27:

> 25: #include "precompiled.hpp"
> 26: #include <limits>
> 27: #include <type_traits>

These includes should be moved.

src/hotspot/share/opto/divnode.cpp line 42:

> 40: #include "utilities/powerOfTwo.hpp"
> 41: 
> 42: 

Revert this stray addition of a blank line.

test/hotspot/gtest/opto/test_constant_division.cpp line 29:

> 27: #include "runtime/os.hpp"
> 28: #include "utilities/growableArray.hpp"
> 29: #include <type_traits>

Move include.

-------------

PR Review: https://git.openjdk.org/jdk/pull/9947#pullrequestreview-1800139023
PR Review Comment: https://git.openjdk.org/jdk/pull/9947#discussion_r1439270103
PR Review Comment: https://git.openjdk.org/jdk/pull/9947#discussion_r1439270557
PR Review Comment: https://git.openjdk.org/jdk/pull/9947#discussion_r1439270384
PR Review Comment: https://git.openjdk.org/jdk/pull/9947#discussion_r1439271034