RFR: 8349637: Integer.numberOfLeadingZeros outputs incorrectly in certain cases [v3]

[Emanuel Peter]

On Wed, 12 Feb 2025 19:45:34 GMT, Jasmine Karthikeyan <jkarthikeyan at openjdk.org> wrote:

>> Hi all,
>> This is a fix for a miscompile in the AVX2 implementation of `CountLeadingZerosV` for int types. Currently, the implementation turns ints into floats, in order to calculating the leading zeros based on the exponent part of the float. Unfortunately, floats can only accurately represent integers up to 2^24. After that, multiple integer values can map onto the same floating point value. The issue manifests when an int is converted to a floating point representation that is higher than it, crossing a bit boundary. As an example, `(float)0x01FFFFFF == (float)0x02000000`, but `lzcnt(0x01FFFFFF) == 7` and `lzcnt(0x02000000) == 6`. The values are incorrectly rounded up.
>> 
>> This patch fixes the issue by masking the input in the cases where it is larger than 2^24, to set the low bits to 0. Removing these bits prevents the accidental rounding behavior. I've added these cases to`TestNumberOfContinuousZeros`, and removed the set random seed so that it can produce random inputs to test with.
>> 
>> Reviews would be appreciated!
>
> Jasmine Karthikeyan has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Improve explanation of logic

@jaskarth I have a Vector API test that should also reproduce the issue, and I used your special values.


import jdk.incubator.vector.IntVector;
import jdk.incubator.vector.VectorOperators;
import jdk.incubator.vector.VectorSpecies;

public class TestVectorAPI {
    private static final VectorSpecies<Integer> SPECIES = IntVector.SPECIES_PREFERRED;
    static int SIZE = 1024;

    private static final int[] SPECIAL = { 0x01FFFFFF, 0x03FFFFFE, 0x07FFFFFC, 0x0FFFFFF8, 0x1FFFFFF0, 0x3FFFFFE0, 0xFFFFFFFF };

    static int[] a = new int[SIZE];
    static int[] r = new int[SIZE];
    static int[] gold = new int[SIZE];

    public static void main(String[] args) {
        for (int i = 0; i < a.length; i++) {
            a[i] = SPECIAL[i % SPECIAL.length];
        }
        System.out.println("Compute in interpreter:");
        test(gold);
        System.out.println("Warmup and compute with compiled eventually:");
        for (int i = 0; i < 10_000; i++) {
            test(r);
        }
        System.out.println("Verify:");
        for (int i = 0; i < a.length; i++) {
            if (r[i] != gold[i]) {
                throw new RuntimeException("Wrong value: " + r[i] + " vs " + gold[i] + " for " + a[i] + " at " + i);
            }
        }
    }

    static void test(int[] out) {
        for (int i = 0; i < a.length; i += SPECIES.length()) {
            IntVector av = IntVector.fromArray(SPECIES, a, i);
            av.lanewise(VectorOperators.LEADING_ZEROS_COUNT).intoArray(out, i);
        }
    }
}



Run with:
`java -XX:UseAVX=2 -Xbatch -XX:CompileCommand=compileonly,TestVectorAPI::test -XX:CompileCommand=printcompilation,TestVectorAPI::test -XX:-PrintIdeal TestVectorAPI.java`

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

PR Comment: https://git.openjdk.org/jdk/pull/23579#issuecomment-2659586753