util/NavigableMap/LockStep.java

/*
 * Copyright (c) 2006, 2018, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * @test
 * @bug     6420753 6242436 6691185
 * @summary Compare NavigableMap implementations for identical behavior
 * @run main LockStep
 * @run main/othervm -XX:+IgnoreUnrecognizedVMOptions -XX:+EliminateAutoBox -XX:AutoBoxCacheMax=20000 LockStep
 * @run main/othervm -XX:+IgnoreUnrecognizedVMOptions -XX:+EliminateAutoBox -XX:AutoBoxCacheMax=20000 -Dthorough=true LockStep
 * @author  Martin Buchholz
 * @key randomness
 */

import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.NotSerializableException;
import java.io.ObjectInputStream;
import java.io.ObjectOutputStream;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Map;
import java.util.NavigableMap;
import java.util.NavigableSet;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.Random;
import java.util.Set;
import java.util.TreeMap;
import java.util.TreeSet;
import java.util.concurrent.ConcurrentSkipListMap;
import java.util.concurrent.ConcurrentSkipListSet;

import static java.util.Collections.reverseOrder;
import static java.util.Collections.singleton;
import static java.util.Collections.singletonMap;

@SuppressWarnings("unchecked")
public class LockStep {
    static final int DEFAULT_SIZE = 5;
    static int size;            // Running time is O(size**2)

    static int intArg(String[] args, int i, int defaultValue) {
        return args.length > i ? Integer.parseInt(args[i]) : defaultValue;
    }

    // Pass -Dthorough=true for more exhaustive testing
    static final boolean thorough = Boolean.getBoolean("thorough");

    static boolean maybe(int n) { return rnd.nextInt(n) == 0; }

    static void realMain(String[] args) {
        size = intArg(args, 0, DEFAULT_SIZE);

        lockSteps(new TreeMap<>(),
                  new ConcurrentSkipListMap<>());
        lockSteps(new TreeMap<>(),
                  Collections.checkedNavigableMap(new TreeMap<>(), Integer.class, Integer.class));
        lockSteps(new TreeMap<>(),
                  Collections.synchronizedNavigableMap(new TreeMap<>()));
        lockSteps(new TreeMap<>(reverseOrder()),
                  new ConcurrentSkipListMap<>(reverseOrder()));

        lockSteps(new TreeSet<>(),
                  new ConcurrentSkipListSet<>());
        lockSteps(new TreeSet<>(),
                  Collections.checkedNavigableSet(new TreeSet<>(), Integer.class));
        lockSteps(new TreeSet<>(),
                  Collections.synchronizedNavigableSet(new TreeSet<>()));
        lockSteps(new TreeSet<>(reverseOrder()),
                  new ConcurrentSkipListSet<>(reverseOrder()));
    }

    static void lockSteps(NavigableMap<Integer, Integer> m1, NavigableMap<Integer, Integer> m2) {
        if (maybe(4)) m1 = serialClone(m1);
        if (maybe(4)) m2 = serialClone(m2);
        lockStep(m1,
                 m2);
        lockStep(m1.descendingMap(),
                 m2.descendingMap());
        lockStep(fullSubMap(m1),
                 fullSubMap(m2));
        lockStep(fullSubMap(m1.descendingMap()),
                 fullSubMap(m2.descendingMap()));
        lockStep(fullHeadMap(m1),
                 fullHeadMap(m2));
        lockStep(fullHeadMap(m1.descendingMap()),
                 fullHeadMap(m2.descendingMap()));
        lockStep(fullTailMap(m1),
                 fullTailMap(m2));
        lockStep(fullTailMap(m1.descendingMap()),
                 fullTailMap(m2.descendingMap()));
    }

    static void lockSteps(NavigableSet<Integer> s1, NavigableSet<Integer> s2) {
        if (maybe(4)) s1 = serialClone(s1);
        if (maybe(4)) s2 = serialClone(s2);
        lockStep(s1,
                 s2);
        lockStep(s1.descendingSet(),
                 s2.descendingSet());
        lockStep(fullSubSet(s1),
                 fullSubSet(s2));
        lockStep(fullSubSet(s1.descendingSet()),
                 fullSubSet(s2.descendingSet()));
        lockStep(fullHeadSet(s1),
                 fullHeadSet(s2));
        lockStep(fullHeadSet(s1.descendingSet()),
                 fullHeadSet(s2.descendingSet()));
        lockStep(fullTailSet(s1),
                 fullTailSet(s2));
        lockStep(fullTailSet(s1.descendingSet()),
                 fullTailSet(s2.descendingSet()));
    }

    static boolean isAscending(NavigableMap<Integer, Integer> m) {
        var cmp = m.comparator();
        return (cmp == null || cmp.compare(1, 2) < 0);
    }

    static NavigableMap<Integer, Integer> fullSubMap(NavigableMap<Integer, Integer> m) {
        return isAscending(m)
            ? m.subMap(Integer.MIN_VALUE, true, Integer.MAX_VALUE, true)
            : m.subMap(Integer.MAX_VALUE, true, Integer.MIN_VALUE, true);
    }

    static NavigableMap<Integer, Integer> fullHeadMap(NavigableMap<Integer, Integer> m) {
        return isAscending(m)
            ? m.headMap(Integer.MAX_VALUE, true)
            : m.headMap(Integer.MIN_VALUE, true);
    }

    static NavigableMap<Integer, Integer> fullTailMap(NavigableMap<Integer, Integer> m) {
        return isAscending(m)
            ? m.tailMap(Integer.MIN_VALUE, true)
            : m.tailMap(Integer.MAX_VALUE, true);
    }

    static boolean isAscending(NavigableSet<Integer> s) {
        var cmp = s.comparator();
        return (cmp == null || cmp.compare(1, 2) < 0);
    }

    static NavigableSet<Integer> fullSubSet(NavigableSet<Integer> s) {
        return isAscending(s)
            ? s.subSet(Integer.MIN_VALUE, true, Integer.MAX_VALUE, true)
            : s.subSet(Integer.MAX_VALUE, true, Integer.MIN_VALUE, true);
    }

    static NavigableSet<Integer> fullHeadSet(NavigableSet<Integer> s) {
        return isAscending(s)
            ? s.headSet(Integer.MAX_VALUE, true)
            : s.headSet(Integer.MIN_VALUE, true);
    }

    static NavigableSet<Integer> fullTailSet(NavigableSet<Integer> s) {
        return isAscending(s)
            ? s.tailSet(Integer.MIN_VALUE, true)
            : s.tailSet(Integer.MAX_VALUE, true);
    }

    static void testEmptyCollection(Collection<?> c) {
        check(c.isEmpty());
        equal(c.size(), 0);
        equal(c.toString(),"[]");
        equal(c.toArray().length, 0);
        equal(c.toArray(new Object[0]).length, 0);

        Object[] a = new Object[1]; a[0] = Boolean.TRUE;
        equal(c.toArray(a), a);
        equal(a[0], null);
        check(! c.iterator().hasNext());
    }

    static void testEmptySet(Set<?> c) {
        testEmptyCollection(c);
        equal(c.hashCode(), 0);
        equal2(c, Collections.<Integer>emptySet());
    }

    static void testEmptyMap(final Map<?,?> m) {
        check(m.isEmpty());
        equal(m.size(), 0);
        equal(m.toString(),"{}");
        equal(m.hashCode(), 0);
        testEmptySet(m.keySet());
        testEmptySet(m.entrySet());
        testEmptyCollection(m.values());
    }

    static final Random rnd;

    static {
        // sufficiently random for this test
        long seed = System.nanoTime();
        System.out.println(LockStep.class.getCanonicalName() + ": Trial random seed: " + seed );

        rnd = new Random(seed);
    }

    static void equalNext(final Iterator<?> it, Object expected) {
        if (maybe(2))
            check(it.hasNext());
        equal(it.next(), expected);
    }

    static Comparator<? super Integer> comparator(NavigableSet<Integer> s) {
        var cmp = s.comparator();
        return cmp != null ? cmp : Comparator.naturalOrder();
    }

    static Comparator<? super Integer> comparator(NavigableMap<Integer, Integer> m) {
        var cmp = m.comparator();
        return cmp != null ? cmp : Comparator.naturalOrder();
    }

    static void checkNavigableSet(final NavigableSet<Integer> s) {
        if (s.comparator() == null)
            check(s.descendingSet().descendingSet().comparator() == null);
        equal(s.isEmpty(), s.size() == 0);
        equal2(s, s.descendingSet());
        if (maybe(4) && s instanceof Serializable) {
            try {
                equal2(s, serialClone(s));
            } catch (RuntimeException uhoh) {
                if (!(uhoh.getCause() instanceof NotSerializableException)) {
                    throw uhoh;
                }
            }
        }
        var cmp = comparator(s);
        if (s.isEmpty()) {
            THROWS(NoSuchElementException.class,
                   () -> s.first(),
                   () -> s.last());
            equal(null, s.lower(1));
            equal(null, s.floor(1));
            equal(null, s.ceiling(1));
            equal(null, s.higher(1));
        } else {
            Integer a = s.first();
            Integer z = s.last();
            equal(s.lower(a), null);
            equal(s.higher(z), null);
            equal2(s, s.tailSet(a));
            equal2(s, s.headSet(z, true));
            equal2(s, s.subSet(a, true, z, true));

            testEmptySet(s.subSet(a, true, a, false));
            testEmptySet(s.subSet(z, true, z, false));
            testEmptySet(s.headSet(a, false));
            testEmptySet(s.tailSet(z, false));

            equal2(s.headSet(a, true), singleton(a));
            equal2(s.tailSet(z, true), singleton(z));
        }
        Iterator<?>[] its = new Iterator[] {
            s.iterator(),
            s.descendingSet().descendingSet().iterator(),
        };
        for (final Iterator<?> it : its)
            if (maybe(4))
                THROWS(IllegalStateException.class, () -> it.remove());
        Integer prev = null;
        for (final Integer e : s) {
            check(s.contains(e));
            for (Iterator<?> it : its) equalNext(it, e);
            equal(e, s.ceiling(e));
            equal(e, s.floor(e));
            check(s.higher(e) == null || cmp.compare(e, s.higher(e)) < 0);
            equal(s.lower(e), prev);
            if (prev != null) {
                check(cmp.compare(prev, e) < 0);
            }
            prev = e;
        }
        for (final Iterator<?> it : its) {
            if (maybe(2))
                check(! it.hasNext());
            Fun fun = () -> it.next();
            THROWS(NoSuchElementException.class, fun, fun, fun);
        }
    }

    static void equalIterators(final Iterator<?> it1,
                               final Iterator<?> it2) {
        while (it1.hasNext()) {
            if (maybe(2))
                check(it2.hasNext());
            equal(it1.next(), it2.next());
        }
        check(! it2.hasNext());
    }

    static void equalSetsLeaf(final Set<?> s1, final Set<?> s2) {
        equal2(s1,            s2);
        equal( s1.size(),     s2.size());
        equal( s1.isEmpty(),  s2.isEmpty());
        equal( s1.hashCode(), s2.hashCode());
        equal( s1.toString(), s2.toString());
        equal( s1.containsAll(s2), s2.containsAll(s1));
    }

    static void equalNavigableSetsLeaf(final NavigableSet<Integer> s1,
                                       final NavigableSet<Integer> s2) {
        equal2(s1,            s2);
        equal( s1.size(),     s2.size());
        equal( s1.isEmpty(),  s2.isEmpty());
        equal( s1.hashCode(), s2.hashCode());
        equal( s1.toString(), s2.toString());
        if (! s1.isEmpty()) {
            equal(s1.first(), s2.first());
            equal(s1.last(),  s2.last());
        }
        equalIterators(s1.iterator(), s2.iterator());
        equalIterators(s1.descendingIterator(), s2.descendingIterator());
        checkNavigableSet(s1);
        checkNavigableSet(s2);
    }

    static void equalNavigableSets(final NavigableSet<Integer> s1,
                                   final NavigableSet<Integer> s2) {
        equalNavigableSetsLeaf(s1, s2);
        equalNavigableSetsLeaf(s1.descendingSet(), s2.descendingSet());
        equalNavigableSetsLeaf(s1.descendingSet().descendingSet(), s2);
        Integer min = s1.isEmpty() ? Integer.MIN_VALUE : s1.first();
        Integer max = s2.isEmpty() ? Integer.MAX_VALUE : s2.last();
        if (s1.comparator() != null &&
            s1.comparator().compare(min, max) > 0) {
            Integer tmp = min; min = max; max = tmp;
        }

        equalNavigableSetsLeaf(s1.subSet(min, true, max, true),
                               s2.subSet(min, true, max, true));
        equalNavigableSetsLeaf(s1.tailSet(min, true),
                               s2.tailSet(min, true));
        equalNavigableSetsLeaf(s1.headSet(max, true),
                               s2.headSet(max, true));
        equalNavigableSetsLeaf((NavigableSet<Integer>) s1.subSet(min, max),
                               (NavigableSet<Integer>) s2.subSet(min, max));
        equalNavigableSetsLeaf((NavigableSet<Integer>) s1.tailSet(min),
                               (NavigableSet<Integer>) s2.tailSet(min));
        equalNavigableSetsLeaf((NavigableSet<Integer>) s1.headSet(max),
                               (NavigableSet<Integer>) s2.headSet(max));
    }

    // Destined for a Collections.java near you?
    static <T> T[] concat(T[]... arrays) {
        int len = 0;
        for (T[] arr : arrays) len += arr.length;
        T[] a = (T[])java.lang.reflect.Array
            .newInstance(arrays[0].getClass().getComponentType(), len);
        int k = 0;
        for (T[] arr : arrays) {
            System.arraycopy(arr, 0, a, k, arr.length);
            k += arr.length;
        }
        return a;
    }

    static void checkNavigableMap(final NavigableMap<Integer, Integer> m) {
        if (m.comparator() == null) {
            check(m.descendingMap().descendingMap().comparator() == null);
            check(m.descendingKeySet().descendingSet().comparator() == null);
        }
        equal(m.isEmpty(), m.size() == 0);
        equal2(m, m.descendingMap());
        if (maybe(4))
            equal2(m, serialClone(m));
        equal2(m.keySet(), m.descendingKeySet());
        var cmp = comparator(m);
        if (m.isEmpty()) {
            THROWS(NoSuchElementException.class,
                   () -> m.firstKey(),
                   () -> m.lastKey());
            equal(null, m.firstEntry());
            equal(null, m.lastEntry());
            equal(null, m.pollFirstEntry());
            equal(null, m.pollLastEntry());
            equal(null, m.lowerKey(1));
            equal(null, m.floorKey(1));
            equal(null, m.ceilingKey(1));
            equal(null, m.higherKey(1));
            equal(null, m.lowerEntry(1));
            equal(null, m.floorEntry(1));
            equal(null, m.ceilingEntry(1));
            equal(null, m.higherEntry(1));
        } else {
            Integer a = m.firstKey();
            Integer z = m.lastKey();
            equal(m.lowerKey(a), null);
            equal(m.higherKey(z), null);
            equal(a, m.firstEntry().getKey());
            equal(z, m.lastEntry().getKey());
            equal2(m, m.tailMap(a));
            equal2(m, m.headMap(z, true));
            equal2(m, m.subMap(a, true, z, true));

            testEmptyMap(m.subMap(a, true, a, false));
            testEmptyMap(m.subMap(z, true, z, false));
            testEmptyMap(m.headMap(a, false));
            testEmptyMap(m.tailMap(z, false));

            equal2(m.headMap(a, true), singletonMap(a, m.get(a)));
            equal2(m.tailMap(z, true), singletonMap(z, m.get(z)));
        }

        Iterator<?>[] kits = new Iterator[] {
            m.keySet().iterator(),
            m.descendingMap().descendingKeySet().iterator(),
            m.descendingKeySet().descendingSet().iterator(),
        };
        Iterator<?>[] vits = new Iterator[] {
            m.values().iterator(),
            m.descendingMap().descendingMap().values().iterator(),
        };
        Iterator<?>[] eits = new Iterator[] {
            m.entrySet().iterator(),
            m.descendingMap().descendingMap().entrySet().iterator(),
        };
        Iterator<?>[] its = concat(kits, vits, eits);
        for (final Iterator<?> it : its)
            if (maybe(4))
                THROWS(IllegalStateException.class, () -> it.remove());
        Map.Entry<Integer, Integer> prev = null;
        for (var e : m.entrySet()) {
            Integer k = e.getKey();
            Integer v = e.getValue();
            check(m.containsKey(k));
            check(m.containsValue(v));
            for (var kit : kits) equalNext(kit, k);
            for (var vit : vits) equalNext(vit, v);
            for (var eit : eits) equalNext(eit, e);
            equal(k, m.ceilingKey(k));
            equal(k, m.ceilingEntry(k).getKey());
            equal(k, m.floorKey(k));
            equal(k, m.floorEntry(k).getKey());
            check(m.higherKey(k) == null || cmp.compare(k, m.higherKey(k)) < 0);
            check(m.lowerKey(k)  == null || cmp.compare(k, m.lowerKey(k))  > 0);
            equal(m.lowerEntry(k), prev);
            if (prev == null) {
                equal(m.lowerKey(k), null);
            } else {
                equal(m.lowerKey(k), prev.getKey());
                check(cmp.compare(prev.getKey(), e.getKey()) < 0);
            }
            prev = e;
        }
        for (final var it : its) {
            if (maybe(2))
                check(! it.hasNext());
            Fun fun = () -> it.next();
            THROWS(NoSuchElementException.class, fun, fun, fun);
        }
    }

    static void equalNavigableMapsLeaf(final NavigableMap<Integer, Integer> m1,
                                       final NavigableMap<Integer, Integer> m2) {
        equal2(m1,              m2);
        equal( m1.size(),       m2.size());
        equal( m1.isEmpty(),    m2.isEmpty());
        equal( m1.hashCode(),   m2.hashCode());
        equal( m1.toString(),   m2.toString());
        equal2(m1.firstEntry(), m2.firstEntry());
        equal2(m1.lastEntry(),  m2.lastEntry());
        checkNavigableMap(m1);
        checkNavigableMap(m2);
    }

    static void equalNavigableMaps(NavigableMap<Integer, Integer> m1,
                                   NavigableMap<Integer, Integer> m2) {
        equalNavigableMapsLeaf(m1, m2);
        equalSetsLeaf(m1.keySet(), m2.keySet());
        equalNavigableSets(m1.navigableKeySet(),
                           m2.navigableKeySet());
        equalNavigableSets(m1.descendingKeySet(),
                           m2.descendingKeySet());
        equal2(m1.entrySet(),
               m2.entrySet());
        equalNavigableMapsLeaf(m1.descendingMap(),
                               m2.descendingMap());
        equalNavigableMapsLeaf(m1.descendingMap().descendingMap(),
                               m2);
        equalNavigableSetsLeaf((NavigableSet<Integer>) m1.descendingMap().keySet(),
                               (NavigableSet<Integer>) m2.descendingMap().keySet());
        equalNavigableSetsLeaf(m1.descendingMap().descendingKeySet(),
                               m2.descendingMap().descendingKeySet());
        equal2(m1.descendingMap().entrySet(),
               m2.descendingMap().entrySet());

        //----------------------------------------------------------------
        // submaps
        //----------------------------------------------------------------
        Integer min = Integer.MIN_VALUE;
        Integer max = Integer.MAX_VALUE;
        if (m1.comparator() != null
            && m1.comparator().compare(min, max) > 0) {
            Integer tmp = min; min = max; max = tmp;
        }
        switch (rnd.nextInt(6)) {
        case 0:
            equalNavigableMapsLeaf(m1.subMap(min, true, max, true),
                                   m2.subMap(min, true, max, true));
            break;
        case 1:
            equalNavigableMapsLeaf(m1.tailMap(min, true),
                                   m2.tailMap(min, true));
            break;
        case 2:
            equalNavigableMapsLeaf(m1.headMap(max, true),
                                   m2.headMap(max, true));
            break;
        case 3:
            equalNavigableMapsLeaf((NavigableMap<Integer, Integer>) m1.subMap(min, max),
                                   (NavigableMap<Integer, Integer>) m2.subMap(min, max));
            break;
        case 4:
            equalNavigableMapsLeaf((NavigableMap<Integer, Integer>) m1.tailMap(min),
                                   (NavigableMap<Integer, Integer>) m2.tailMap(min));
            break;
        case 5:
            equalNavigableMapsLeaf((NavigableMap<Integer, Integer>) m1.headMap(max),
                                   (NavigableMap<Integer, Integer>) m2.headMap(max));
            break;
        }
    }

    interface MapFrobber { void frob(NavigableMap<Integer, Integer> m); }
    interface SetFrobber { void frob(NavigableSet<Integer> m); }

    static MapFrobber randomAdder(NavigableMap<Integer, Integer> m) {
        final Integer k = unusedKey(m);
        final MapFrobber[] randomAdders = {
            map -> {
                equal(map.put(k, k + 1), null);
                equal(map.get(k), k + 1);
                if (maybe(4)) {
                    equal(map.put(k, k + 1), k + 1);
                    equal(map.get(k), k + 1);}},
            map -> {
                map.descendingMap().put(k, k + 1);
                equal(map.get(k), k + 1);},
            map -> map.tailMap(k,true).headMap(k,true).put(k, k + 1),
            map -> {
                equal(map.tailMap(k,true).headMap(k,true).putIfAbsent(k, k + 1), null);
                equal(map.tailMap(k,true).headMap(k,true).putIfAbsent(k, k + 1), k + 1);},
            map -> {
                equal(map.tailMap(k,true).headMap(k,true).merge(k,k,Integer::sum), k);
                equal(map.tailMap(k,true).headMap(k,true).merge(k,1,Integer::sum), k+1);},
            map -> equal(map.subMap(k,true, k, true).computeIfAbsent(k, key -> key + 1), k + 1),
            map -> {
                equal(map.subMap(k,true, k, true).computeIfPresent(k, (key, val) -> 1), null);
                equal(map.tailMap(k,true).compute(k, (key, val) -> {
                    equal(val, null);
                    return 1;
                }), 1);
                equal(map.headMap(k, true).computeIfPresent(k, (key, val) -> val + key), k + 1);
                equal(map.tailMap(k, false).computeIfPresent(k, (key, val) -> 1), null);
                equal(map.headMap(k, false).compute(k, (key, val) -> null), null);
                equal(map.tailMap(k, false).computeIfAbsent(k, key -> null), null);
            },
            map -> map.tailMap(k,true).headMap(k,true).descendingMap().put(k, k + 1)
        };
        return map -> {
            randomAdders[rnd.nextInt(randomAdders.length)].frob(map);
            if (maybe(2)) equal(map.get(k), k + 1);
            if (maybe(4)) {
                equal(map.put(k, k + 1), k + 1);
                equal(map.get(k), k + 1);}};
    }

    static SetFrobber randomAdder(NavigableSet<Integer> s) {
        final Integer e = unusedElt(s);
        final SetFrobber[] randomAdders = {
            set -> check(set.add(e)),
            set -> set.descendingSet().add(e),
            set -> set.tailSet(e,true).headSet(e,true).add(e),
            set -> set.descendingSet().tailSet(e,true).headSet(e,true).add(e)
        };
        return set -> {
            if (maybe(2)) check(! set.contains(e));
            randomAdders[rnd.nextInt(randomAdders.length)].frob(set);
            if (maybe(2)) check(! set.add(e));
            if (maybe(2)) check(set.contains(e));};
    }

    static Integer unusedElt(NavigableSet<Integer> s) {
        Integer e;
        do { e = rnd.nextInt(1024); }
        while (s.contains(e));
        return e;
    }

    static Integer unusedKey(NavigableMap<Integer, Integer> m) {
        Integer k;
        do { k = rnd.nextInt(1024); }
        while (m.containsKey(k));
        return k;
    }

    static Integer usedKey(NavigableMap<Integer, Integer> m) {
        Integer x = rnd.nextInt(1024);
        Integer floor   = m.floorKey(x);
        Integer ceiling = m.ceilingKey(x);
        if (floor != null) return floor;
        check(ceiling != null);
        return ceiling;
    }

    static Integer usedElt(NavigableSet<Integer> s) {
        Integer x = rnd.nextInt(1024);
        Integer floor   = s.floor(x);
        Integer ceiling = s.ceiling(x);
        if (floor != null) return floor;
        check(ceiling != null);
        return ceiling;
    }

    static void checkUnusedKey(NavigableMap<Integer, Integer> m, Integer k) {
        check(! m.containsKey(k));
        equal(m.get(k), null);
        if (maybe(2))
            equal(m.remove(k), null);
    }

    static void checkUnusedElt(NavigableSet<Integer> s, Integer e) {
        if (maybe(2))
            check(! s.contains(e));
        if (maybe(2)) {
            check(s.ceiling(e) != e);
            check(s.floor(e)   != e);
        }
        if (maybe(2))
            check(! s.remove(e));
    }

    static Fun remover(final Iterator<?> it) {
        return () -> it.remove();
    }

    static MapFrobber randomRemover(NavigableMap<Integer, Integer> m) {
        final Integer k = usedKey(m);
        final MapFrobber[] randomRemovers = {
            map -> {
                var e = map.firstEntry();
                equal(map.pollFirstEntry(), e);
                checkUnusedKey(map, e.getKey());},
            map -> {
                var e = map.lastEntry();
                equal(map.pollLastEntry(), e);
                checkUnusedKey(map, e.getKey());},
            map -> {
                check(map.remove(k) != null);
                checkUnusedKey(map, k);},
            map -> {
                map.subMap(k, true, k, true).clear();
                checkUnusedKey(map, k);},
            map -> {
                map.descendingMap().subMap(k, true, k, true).clear();
                checkUnusedKey(map, k);},
            map -> {
                final var it = map.keySet().iterator();
                while (it.hasNext())
                    if (it.next().equals(k)) {
                        it.remove();
                        if (maybe(2))
                            THROWS(IllegalStateException.class,
                                   () -> it.remove());
                    }
                checkUnusedKey(map, k);},
            map -> {
                final var it = map.navigableKeySet().descendingIterator();
                while (it.hasNext())
                    if (it.next().equals(k)) {
                        it.remove();
                        if (maybe(2))
                            THROWS(IllegalStateException.class,
                                   () -> it.remove());
                    }
                checkUnusedKey(map, k);},
            map -> {
                final var it = map.entrySet().iterator();
                while (it.hasNext())
                    if (it.next().getKey().equals(k)) {
                        it.remove();
                        if (maybe(2))
                            THROWS(IllegalStateException.class, remover(it));
                    }
                checkUnusedKey(map, k);},
        };

        return randomRemovers[rnd.nextInt(randomRemovers.length)];
    }

    static SetFrobber randomRemover(NavigableSet<Integer> s) {
        final Integer e = usedElt(s);

        final SetFrobber[] randomRemovers = {
            set -> {
                var fst = set.first();
                equal(set.pollFirst(), fst);
                checkUnusedElt(set, fst);},
            set -> {
                var lst = set.last();
                equal(set.pollLast(), lst);
                checkUnusedElt(set, lst);},
            set -> {
                check(set.remove(e));
                checkUnusedElt(set, e);},
            set -> {
                set.subSet(e, true, e, true).clear();
                checkUnusedElt(set, e);},
            set -> {
                set.descendingSet().subSet(e, true, e, true).clear();
                checkUnusedElt(set, e);},
            set -> {
                final var it = set.iterator();
                while (it.hasNext())
                    if (it.next().equals(e)) {
                        it.remove();
                        if (maybe(2))
                            THROWS(IllegalStateException.class,
                                   () -> it.remove());
                    }
                checkUnusedElt(set, e);},
            set -> {
                final var it = set.descendingSet().iterator();
                while (it.hasNext())
                    if (it.next().equals(e)) {
                        it.remove();
                        if (maybe(2))
                            THROWS(IllegalStateException.class,
                                   () -> it.remove());
                    }
                checkUnusedElt(set, e);},
            set -> {
                final var it = set.descendingIterator();
                while (it.hasNext())
                    if (it.next().equals(e)) {
                        it.remove();
                        if (maybe(2))
                            THROWS(IllegalStateException.class,
                                   () -> it.remove());
                    }
                checkUnusedElt(set, e);}
        };

        return randomRemovers[rnd.nextInt(randomRemovers.length)];
    }

    static void lockStep(NavigableMap<Integer, Integer> m1,
                         NavigableMap<Integer, Integer> m2) {
        if (! (thorough || maybe(3))) return;
        if (maybe(4)) m1 = serialClone(m1);
        if (maybe(4)) m2 = serialClone(m2);

        var maps = Arrays.asList(m1, m2);
        for (var m : maps) testEmptyMap(m);
        final Set<Integer> ints = new HashSet<>();
        while (ints.size() < size)
            ints.add(rnd.nextInt(1024));
        final Integer[] elts = ints.toArray(new Integer[size]);
        equal(elts.length, size);
        for (int i = 0; i < size; i++) {
            MapFrobber adder = randomAdder(m1);
            for (var m : maps) {
                adder.frob(m);
                equal(m.size(), i+1);
            }
            equalNavigableMaps(m1, m2);
        }
        for (var m : maps) {
            final var e = usedKey(m);
            THROWS(IllegalArgumentException.class,
                   () -> m.subMap(e,true,e,false).subMap(e,true,e,true),
                   () -> m.subMap(e,false,e,true).subMap(e,true,e,true),
                   () -> m.tailMap(e,false).tailMap(e,true),
                   () -> m.headMap(e,false).headMap(e,true),
                   () -> m.headMap(e, false).put(e, 0),
                   () -> m.tailMap(e, false).putIfAbsent(e, 0),
                   () -> m.headMap(e, false).computeIfAbsent(e, k -> 1),
                   () -> m.tailMap(e, false).compute(e, (k, v) -> 0));
        }
        //System.out.printf("%s%n", m1);
        for (int i = size; i > 0; i--) {
            MapFrobber remover = randomRemover(m1);
            for (var m : maps) {
                remover.frob(m);
                equal(m.size(), i-1);
            }
            equalNavigableMaps(m1, m2);
        }
        for (var m : maps) testEmptyMap(m);
    }

    static void lockStep(NavigableSet<Integer> s1,
                         NavigableSet<Integer> s2) {
        if (! (thorough || maybe(3))) return;
        if (maybe(4)) s1 = serialClone(s1);
        if (maybe(4)) s2 = serialClone(s2);

        var sets = Arrays.asList(s1, s2);
        for (var s : sets) testEmptySet(s);
        final Set<Integer> ints = new HashSet<>();
        while (ints.size() < size)
            ints.add(rnd.nextInt(1024));
        final Integer[] elts = ints.toArray(new Integer[size]);
        equal(elts.length, size);
        for (int i = 0; i < size; i++) {
            SetFrobber adder = randomAdder(s1);
            for (var s : sets) {
                adder.frob(s);
                equal(s.size(), i+1);
            }
            equalNavigableSets(s1, s2);
        }
        for (var s : sets) {
            final Integer e = usedElt(s);
            THROWS(IllegalArgumentException.class,
                   () -> s.subSet(e,true,e,false).subSet(e,true,e,true),
                   () -> s.subSet(e,false,e,true).subSet(e,true,e,true),
                   () -> s.tailSet(e,false).tailSet(e,true),
                   () -> s.headSet(e,false).headSet(e,true));
        }
        //System.out.printf("%s%n", s1);
        for (int i = size; i > 0; i--) {
            SetFrobber remover = randomRemover(s1);
            for (var s : sets) {
                remover.frob(s);
                equal(s.size(), i-1);
            }
            equalNavigableSets(s1, s2);
        }
        for (var s : sets) testEmptySet(s);
    }

    //--------------------- Infrastructure ---------------------------
    static volatile int passed = 0, failed = 0;
    static void pass() { passed++; }
    static void fail() { failed++; Thread.dumpStack(); }
    static void fail(String msg) { System.out.println(msg); fail(); }
    static void unexpected(Throwable t) { failed++; t.printStackTrace(); }
    static void check(boolean cond) { if (cond) pass(); else fail(); }
    static void equal(Object x, Object y) {
        if (Objects.equals(x, y)) pass();
        else {System.out.println(x + " not equal to " + y); fail();}}
    static void equal2(Object x, Object y) {equal(x, y); equal(y, x);}
    public static void main(String[] args) throws Throwable {
        try { realMain(args); } catch (Throwable t) { unexpected(t); }

        System.out.printf("%nPassed = %d, failed = %d%n%n", passed, failed);
        if (failed > 0) throw new Exception("Some tests failed");
    }
    interface Fun {void f() throws Throwable;}
    static void THROWS(Class<? extends Throwable> k, Fun... fs) {
        for (Fun f : fs)
            try { f.f(); fail("Expected " + k.getName() + " not thrown"); }
            catch (Throwable t) {
                if (k.isAssignableFrom(t.getClass())) pass();
                else unexpected(t);}}
    static byte[] serializedForm(Object obj) {
        try {
            ByteArrayOutputStream baos = new ByteArrayOutputStream();
            new ObjectOutputStream(baos).writeObject(obj);
            return baos.toByteArray();
        } catch (IOException e) { throw new RuntimeException(e); }}
    static Object readObject(byte[] bytes)
        throws IOException, ClassNotFoundException {
        InputStream is = new ByteArrayInputStream(bytes);
        return new ObjectInputStream(is).readObject();}
    @SuppressWarnings("unchecked")
    static <T> T serialClone(T obj) {
        try { return (T) readObject(serializedForm(obj)); }
        catch (Error|RuntimeException e) { throw e; }
        catch (Throwable e) { throw new RuntimeException(e); }
    }
}
Revision:	1.10
Committed:	Tue Aug 11 19:32:56 2020 UTC (3 years, 9 months ago) by jsr166
Branch:	MAIN
CVS Tags:	HEAD
Changes since 1.9:	+238 -231 lines
Log Message:	8244288: Specialized implementations for putIfAbsent, merge, compute* methods in TreeMap derived maps