1 /*
   2  * Copyright (c) 2006, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 /*
  25  * @test
  26  * @bug     6420753 6242436 6691185
  27  * @summary Compare NavigableMap implementations for identical behavior
  28  * @run main LockStep
  29  * @run main/othervm -XX:+IgnoreUnrecognizedVMOptions -XX:+EliminateAutoBox -XX:AutoBoxCacheMax=20000 LockStep
  30  * @run main/othervm -XX:+IgnoreUnrecognizedVMOptions -XX:+EliminateAutoBox -XX:AutoBoxCacheMax=20000 -Dthorough=true LockStep
  31  * @author  Martin Buchholz
  32  * @key randomness
  33  */
  34 
  35 import java.io.ByteArrayInputStream;
  36 import java.io.ByteArrayOutputStream;
  37 import java.io.IOException;
  38 import java.io.InputStream;
  39 import java.io.NotSerializableException;
  40 import java.io.ObjectInputStream;
  41 import java.io.ObjectOutputStream;
  42 import java.io.Serializable;
  43 import java.util.Arrays;
  44 import java.util.Collection;
  45 import java.util.Collections;
  46 import java.util.Comparator;
  47 import java.util.HashSet;
  48 import java.util.Iterator;
  49 import java.util.Map;
  50 import java.util.NavigableMap;
  51 import java.util.NavigableSet;
  52 import java.util.NoSuchElementException;
  53 import java.util.Objects;
  54 import java.util.Random;
  55 import java.util.Set;
  56 import java.util.TreeMap;
  57 import java.util.TreeSet;
  58 import java.util.concurrent.ConcurrentSkipListMap;
  59 import java.util.concurrent.ConcurrentSkipListSet;
  60 
  61 import static java.util.Collections.reverseOrder;
  62 import static java.util.Collections.singleton;
  63 import static java.util.Collections.singletonMap;
  64 
  65 @SuppressWarnings("unchecked")
  66 public class LockStep {
  67     static final int DEFAULT_SIZE = 5;
  68     static int size;            // Running time is O(size**2)
  69 
  70     static int intArg(String[] args, int i, int defaultValue) {
  71         return args.length > i ? Integer.parseInt(args[i]) : defaultValue;
  72     }
  73 
  74     // Pass -Dthorough=true for more exhaustive testing
  75     static final boolean thorough = Boolean.getBoolean("thorough");
  76 
  77     static boolean maybe(int n) { return rnd.nextInt(n) == 0; }
  78 
  79     static void realMain(String[] args) {
  80         size = intArg(args, 0, DEFAULT_SIZE);
  81 
  82         lockSteps(new TreeMap<>(),
  83                   new ConcurrentSkipListMap<>());
  84         lockSteps(new TreeMap<>(),
  85                   Collections.checkedNavigableMap(new TreeMap<>(), Integer.class, Integer.class));
  86         lockSteps(new TreeMap<>(),
  87                   Collections.synchronizedNavigableMap(new TreeMap<>()));
  88         lockSteps(new TreeMap<>(reverseOrder()),
  89                   new ConcurrentSkipListMap<>(reverseOrder()));
  90 
  91         lockSteps(new TreeSet<>(),
  92                   new ConcurrentSkipListSet<>());
  93         lockSteps(new TreeSet<>(),
  94                   Collections.checkedNavigableSet(new TreeSet<>(), Integer.class));
  95         lockSteps(new TreeSet<>(),
  96                   Collections.synchronizedNavigableSet(new TreeSet<>()));
  97         lockSteps(new TreeSet<>(reverseOrder()),
  98                   new ConcurrentSkipListSet<>(reverseOrder()));
  99     }
 100 
 101     static void lockSteps(NavigableMap<Integer, Integer> m1, NavigableMap<Integer, Integer> m2) {
 102         if (maybe(4)) m1 = serialClone(m1);
 103         if (maybe(4)) m2 = serialClone(m2);
 104         lockStep(m1,
 105                  m2);
 106         lockStep(m1.descendingMap(),
 107                  m2.descendingMap());
 108         lockStep(fullSubMap(m1),
 109                  fullSubMap(m2));
 110         lockStep(fullSubMap(m1.descendingMap()),
 111                  fullSubMap(m2.descendingMap()));
 112         lockStep(fullHeadMap(m1),
 113                  fullHeadMap(m2));
 114         lockStep(fullHeadMap(m1.descendingMap()),
 115                  fullHeadMap(m2.descendingMap()));
 116         lockStep(fullTailMap(m1),
 117                  fullTailMap(m2));
 118         lockStep(fullTailMap(m1.descendingMap()),
 119                  fullTailMap(m2.descendingMap()));
 120     }
 121 
 122     static void lockSteps(NavigableSet<Integer> s1, NavigableSet<Integer> s2) {
 123         if (maybe(4)) s1 = serialClone(s1);
 124         if (maybe(4)) s2 = serialClone(s2);
 125         lockStep(s1,
 126                  s2);
 127         lockStep(s1.descendingSet(),
 128                  s2.descendingSet());
 129         lockStep(fullSubSet(s1),
 130                  fullSubSet(s2));
 131         lockStep(fullSubSet(s1.descendingSet()),
 132                  fullSubSet(s2.descendingSet()));
 133         lockStep(fullHeadSet(s1),
 134                  fullHeadSet(s2));
 135         lockStep(fullHeadSet(s1.descendingSet()),
 136                  fullHeadSet(s2.descendingSet()));
 137         lockStep(fullTailSet(s1),
 138                  fullTailSet(s2));
 139         lockStep(fullTailSet(s1.descendingSet()),
 140                  fullTailSet(s2.descendingSet()));
 141     }
 142 
 143     static boolean isAscending(NavigableMap<Integer, Integer> m) {
 144         var cmp = m.comparator();
 145         return (cmp == null || cmp.compare(1, 2) < 0);
 146     }
 147 
 148     static NavigableMap<Integer, Integer> fullSubMap(NavigableMap<Integer, Integer> m) {
 149         return isAscending(m)
 150             ? m.subMap(Integer.MIN_VALUE, true, Integer.MAX_VALUE, true)
 151             : m.subMap(Integer.MAX_VALUE, true, Integer.MIN_VALUE, true);
 152     }
 153 
 154     static NavigableMap<Integer, Integer> fullHeadMap(NavigableMap<Integer, Integer> m) {
 155         return isAscending(m)
 156             ? m.headMap(Integer.MAX_VALUE, true)
 157             : m.headMap(Integer.MIN_VALUE, true);
 158     }
 159 
 160     static NavigableMap<Integer, Integer> fullTailMap(NavigableMap<Integer, Integer> m) {
 161         return isAscending(m)
 162             ? m.tailMap(Integer.MIN_VALUE, true)
 163             : m.tailMap(Integer.MAX_VALUE, true);
 164     }
 165 
 166     static boolean isAscending(NavigableSet<Integer> s) {
 167         var cmp = s.comparator();
 168         return (cmp == null || cmp.compare(1, 2) < 0);
 169     }
 170 
 171     static NavigableSet<Integer> fullSubSet(NavigableSet<Integer> s) {
 172         return isAscending(s)
 173             ? s.subSet(Integer.MIN_VALUE, true, Integer.MAX_VALUE, true)
 174             : s.subSet(Integer.MAX_VALUE, true, Integer.MIN_VALUE, true);
 175     }
 176 
 177     static NavigableSet<Integer> fullHeadSet(NavigableSet<Integer> s) {
 178         return isAscending(s)
 179             ? s.headSet(Integer.MAX_VALUE, true)
 180             : s.headSet(Integer.MIN_VALUE, true);
 181     }
 182 
 183     static NavigableSet<Integer> fullTailSet(NavigableSet<Integer> s) {
 184         return isAscending(s)
 185             ? s.tailSet(Integer.MIN_VALUE, true)
 186             : s.tailSet(Integer.MAX_VALUE, true);
 187     }
 188 
 189     static void testEmptyCollection(Collection<?> c) {
 190         check(c.isEmpty());
 191         equal(c.size(), 0);
 192         equal(c.toString(),"[]");
 193         equal(c.toArray().length, 0);
 194         equal(c.toArray(new Object[0]).length, 0);
 195 
 196         Object[] a = new Object[1]; a[0] = Boolean.TRUE;
 197         equal(c.toArray(a), a);
 198         equal(a[0], null);
 199         check(! c.iterator().hasNext());
 200     }
 201 
 202     static void testEmptySet(Set<?> c) {
 203         testEmptyCollection(c);
 204         equal(c.hashCode(), 0);
 205         equal2(c, Collections.<Integer>emptySet());
 206     }
 207 
 208     static void testEmptyMap(final Map<?,?> m) {
 209         check(m.isEmpty());
 210         equal(m.size(), 0);
 211         equal(m.toString(),"{}");
 212         equal(m.hashCode(), 0);
 213         testEmptySet(m.keySet());
 214         testEmptySet(m.entrySet());
 215         testEmptyCollection(m.values());
 216     }
 217 
 218     static final Random rnd;
 219 
 220     static {
 221         // sufficiently random for this test
 222         long seed = System.nanoTime();
 223         System.out.println(LockStep.class.getCanonicalName() + ": Trial random seed: " + seed );
 224 
 225         rnd = new Random(seed);
 226     }
 227 
 228     static void equalNext(final Iterator<?> it, Object expected) {
 229         if (maybe(2))
 230             check(it.hasNext());
 231         equal(it.next(), expected);
 232     }
 233 
 234     static Comparator<? super Integer> comparator(NavigableSet<Integer> s) {
 235         var cmp = s.comparator();
 236         return cmp != null ? cmp : Comparator.naturalOrder();
 237     }
 238 
 239     static Comparator<? super Integer> comparator(NavigableMap<Integer, Integer> m) {
 240         var cmp = m.comparator();
 241         return cmp != null ? cmp : Comparator.naturalOrder();
 242     }
 243 
 244     static void checkNavigableSet(final NavigableSet<Integer> s) {
 245         if (s.comparator() == null)
 246             check(s.descendingSet().descendingSet().comparator() == null);
 247         equal(s.isEmpty(), s.size() == 0);
 248         equal2(s, s.descendingSet());
 249         if (maybe(4) && s instanceof Serializable) {
 250             try {
 251                 equal2(s, serialClone(s));
 252             } catch (RuntimeException uhoh) {
 253                 if (!(uhoh.getCause() instanceof NotSerializableException)) {
 254                     throw uhoh;
 255                 }
 256             }
 257         }
 258         var cmp = comparator(s);
 259         if (s.isEmpty()) {
 260             THROWS(NoSuchElementException.class,
 261                    () -> s.first(),
 262                    () -> s.last());
 263             equal(null, s.lower(1));
 264             equal(null, s.floor(1));
 265             equal(null, s.ceiling(1));
 266             equal(null, s.higher(1));
 267         } else {
 268             Integer a = s.first();
 269             Integer z = s.last();
 270             equal(s.lower(a), null);
 271             equal(s.higher(z), null);
 272             equal2(s, s.tailSet(a));
 273             equal2(s, s.headSet(z, true));
 274             equal2(s, s.subSet(a, true, z, true));
 275 
 276             testEmptySet(s.subSet(a, true, a, false));
 277             testEmptySet(s.subSet(z, true, z, false));
 278             testEmptySet(s.headSet(a, false));
 279             testEmptySet(s.tailSet(z, false));
 280 
 281             equal2(s.headSet(a, true), singleton(a));
 282             equal2(s.tailSet(z, true), singleton(z));
 283         }
 284         Iterator<?>[] its = new Iterator[] {
 285             s.iterator(),
 286             s.descendingSet().descendingSet().iterator(),
 287         };
 288         for (final Iterator<?> it : its)
 289             if (maybe(4))
 290                 THROWS(IllegalStateException.class, () -> it.remove());
 291         Integer prev = null;
 292         for (final Integer e : s) {
 293             check(s.contains(e));
 294             for (Iterator<?> it : its) equalNext(it, e);
 295             equal(e, s.ceiling(e));
 296             equal(e, s.floor(e));
 297             check(s.higher(e) == null || cmp.compare(e, s.higher(e)) < 0);
 298             equal(s.lower(e), prev);
 299             if (prev != null) {
 300                 check(cmp.compare(prev, e) < 0);
 301             }
 302             prev = e;
 303         }
 304         for (final Iterator<?> it : its) {
 305             if (maybe(2))
 306                 check(! it.hasNext());
 307             Fun fun = () -> it.next();
 308             THROWS(NoSuchElementException.class, fun, fun, fun);
 309         }
 310     }
 311 
 312     static void equalIterators(final Iterator<?> it1,
 313                                final Iterator<?> it2) {
 314         while (it1.hasNext()) {
 315             if (maybe(2))
 316                 check(it2.hasNext());
 317             equal(it1.next(), it2.next());
 318         }
 319         check(! it2.hasNext());
 320     }
 321 
 322     static void equalSetsLeaf(final Set<?> s1, final Set<?> s2) {
 323         equal2(s1,            s2);
 324         equal( s1.size(),     s2.size());
 325         equal( s1.isEmpty(),  s2.isEmpty());
 326         equal( s1.hashCode(), s2.hashCode());
 327         equal( s1.toString(), s2.toString());
 328         equal( s1.containsAll(s2), s2.containsAll(s1));
 329     }
 330 
 331     static void equalNavigableSetsLeaf(final NavigableSet<Integer> s1,
 332                                        final NavigableSet<Integer> s2) {
 333         equal2(s1,            s2);
 334         equal( s1.size(),     s2.size());
 335         equal( s1.isEmpty(),  s2.isEmpty());
 336         equal( s1.hashCode(), s2.hashCode());
 337         equal( s1.toString(), s2.toString());
 338         if (! s1.isEmpty()) {
 339             equal(s1.first(), s2.first());
 340             equal(s1.last(),  s2.last());
 341         }
 342         equalIterators(s1.iterator(), s2.iterator());
 343         equalIterators(s1.descendingIterator(), s2.descendingIterator());
 344         checkNavigableSet(s1);
 345         checkNavigableSet(s2);
 346     }
 347 
 348     static void equalNavigableSets(final NavigableSet<Integer> s1,
 349                                    final NavigableSet<Integer> s2) {
 350         equalNavigableSetsLeaf(s1, s2);
 351         equalNavigableSetsLeaf(s1.descendingSet(), s2.descendingSet());
 352         equalNavigableSetsLeaf(s1.descendingSet().descendingSet(), s2);
 353         Integer min = s1.isEmpty() ? Integer.MIN_VALUE : s1.first();
 354         Integer max = s2.isEmpty() ? Integer.MAX_VALUE : s2.last();
 355         if (s1.comparator() != null &&
 356             s1.comparator().compare(min, max) > 0) {
 357             Integer tmp = min; min = max; max = tmp;
 358         }
 359 
 360         equalNavigableSetsLeaf(s1.subSet(min, true, max, true),
 361                                s2.subSet(min, true, max, true));
 362         equalNavigableSetsLeaf(s1.tailSet(min, true),
 363                                s2.tailSet(min, true));
 364         equalNavigableSetsLeaf(s1.headSet(max, true),
 365                                s2.headSet(max, true));
 366         equalNavigableSetsLeaf((NavigableSet<Integer>) s1.subSet(min, max),
 367                                (NavigableSet<Integer>) s2.subSet(min, max));
 368         equalNavigableSetsLeaf((NavigableSet<Integer>) s1.tailSet(min),
 369                                (NavigableSet<Integer>) s2.tailSet(min));
 370         equalNavigableSetsLeaf((NavigableSet<Integer>) s1.headSet(max),
 371                                (NavigableSet<Integer>) s2.headSet(max));
 372     }
 373 
 374     // Destined for a Collections.java near you?
 375     static <T> T[] concat(T[]... arrays) {
 376         int len = 0;
 377         for (T[] arr : arrays) len += arr.length;
 378         T[] a = (T[])java.lang.reflect.Array
 379             .newInstance(arrays[0].getClass().getComponentType(), len);
 380         int k = 0;
 381         for (T[] arr : arrays) {
 382             System.arraycopy(arr, 0, a, k, arr.length);
 383             k += arr.length;
 384         }
 385         return a;
 386     }
 387 
 388     static void checkNavigableMap(final NavigableMap<Integer, Integer> m) {
 389         if (m.comparator() == null) {
 390             check(m.descendingMap().descendingMap().comparator() == null);
 391             check(m.descendingKeySet().descendingSet().comparator() == null);
 392         }
 393         equal(m.isEmpty(), m.size() == 0);
 394         equal2(m, m.descendingMap());
 395         if (maybe(4))
 396             equal2(m, serialClone(m));
 397         equal2(m.keySet(), m.descendingKeySet());
 398         var cmp = comparator(m);
 399         if (m.isEmpty()) {
 400             THROWS(NoSuchElementException.class,
 401                    () -> m.firstKey(),
 402                    () -> m.lastKey());
 403             equal(null, m.firstEntry());
 404             equal(null, m.lastEntry());
 405             equal(null, m.pollFirstEntry());
 406             equal(null, m.pollLastEntry());
 407             equal(null, m.lowerKey(1));
 408             equal(null, m.floorKey(1));
 409             equal(null, m.ceilingKey(1));
 410             equal(null, m.higherKey(1));
 411             equal(null, m.lowerEntry(1));
 412             equal(null, m.floorEntry(1));
 413             equal(null, m.ceilingEntry(1));
 414             equal(null, m.higherEntry(1));
 415         } else {
 416             Integer a = m.firstKey();
 417             Integer z = m.lastKey();
 418             equal(m.lowerKey(a), null);
 419             equal(m.higherKey(z), null);
 420             equal(a, m.firstEntry().getKey());
 421             equal(z, m.lastEntry().getKey());
 422             equal2(m, m.tailMap(a));
 423             equal2(m, m.headMap(z, true));
 424             equal2(m, m.subMap(a, true, z, true));
 425 
 426             testEmptyMap(m.subMap(a, true, a, false));
 427             testEmptyMap(m.subMap(z, true, z, false));
 428             testEmptyMap(m.headMap(a, false));
 429             testEmptyMap(m.tailMap(z, false));
 430 
 431             equal2(m.headMap(a, true), singletonMap(a, m.get(a)));
 432             equal2(m.tailMap(z, true), singletonMap(z, m.get(z)));
 433         }
 434 
 435         Iterator<?>[] kits = new Iterator[] {
 436             m.keySet().iterator(),
 437             m.descendingMap().descendingKeySet().iterator(),
 438             m.descendingKeySet().descendingSet().iterator(),
 439         };
 440         Iterator<?>[] vits = new Iterator[] {
 441             m.values().iterator(),
 442             m.descendingMap().descendingMap().values().iterator(),
 443         };
 444         Iterator<?>[] eits = new Iterator[] {
 445             m.entrySet().iterator(),
 446             m.descendingMap().descendingMap().entrySet().iterator(),
 447         };
 448         Iterator<?>[] its = concat(kits, vits, eits);
 449         for (final Iterator<?> it : its)
 450             if (maybe(4))
 451                 THROWS(IllegalStateException.class, () -> it.remove());
 452         Map.Entry<Integer, Integer> prev = null;
 453         for (var e : m.entrySet()) {
 454             Integer k = e.getKey();
 455             Integer v = e.getValue();
 456             check(m.containsKey(k));
 457             check(m.containsValue(v));
 458             for (var kit : kits) equalNext(kit, k);
 459             for (var vit : vits) equalNext(vit, v);
 460             for (var eit : eits) equalNext(eit, e);
 461             equal(k, m.ceilingKey(k));
 462             equal(k, m.ceilingEntry(k).getKey());
 463             equal(k, m.floorKey(k));
 464             equal(k, m.floorEntry(k).getKey());
 465             check(m.higherKey(k) == null || cmp.compare(k, m.higherKey(k)) < 0);
 466             check(m.lowerKey(k)  == null || cmp.compare(k, m.lowerKey(k))  > 0);
 467             equal(m.lowerEntry(k), prev);
 468             if (prev == null) {
 469                 equal(m.lowerKey(k), null);
 470             } else {
 471                 equal(m.lowerKey(k), prev.getKey());
 472                 check(cmp.compare(prev.getKey(), e.getKey()) < 0);
 473             }
 474             prev = e;
 475         }
 476         for (final var it : its) {
 477             if (maybe(2))
 478                 check(! it.hasNext());
 479             Fun fun = () -> it.next();
 480             THROWS(NoSuchElementException.class, fun, fun, fun);
 481         }
 482     }
 483 
 484     static void equalNavigableMapsLeaf(final NavigableMap<Integer, Integer> m1,
 485                                        final NavigableMap<Integer, Integer> m2) {
 486         equal2(m1,              m2);
 487         equal( m1.size(),       m2.size());
 488         equal( m1.isEmpty(),    m2.isEmpty());
 489         equal( m1.hashCode(),   m2.hashCode());
 490         equal( m1.toString(),   m2.toString());
 491         equal2(m1.firstEntry(), m2.firstEntry());
 492         equal2(m1.lastEntry(),  m2.lastEntry());
 493         checkNavigableMap(m1);
 494         checkNavigableMap(m2);
 495     }
 496 
 497     static void equalNavigableMaps(NavigableMap<Integer, Integer> m1,
 498                                    NavigableMap<Integer, Integer> m2) {
 499         equalNavigableMapsLeaf(m1, m2);
 500         equalSetsLeaf(m1.keySet(), m2.keySet());
 501         equalNavigableSets(m1.navigableKeySet(),
 502                            m2.navigableKeySet());
 503         equalNavigableSets(m1.descendingKeySet(),
 504                            m2.descendingKeySet());
 505         equal2(m1.entrySet(),
 506                m2.entrySet());
 507         equalNavigableMapsLeaf(m1.descendingMap(),
 508                                m2.descendingMap());
 509         equalNavigableMapsLeaf(m1.descendingMap().descendingMap(),
 510                                m2);
 511         equalNavigableSetsLeaf((NavigableSet<Integer>) m1.descendingMap().keySet(),
 512                                (NavigableSet<Integer>) m2.descendingMap().keySet());
 513         equalNavigableSetsLeaf(m1.descendingMap().descendingKeySet(),
 514                                m2.descendingMap().descendingKeySet());
 515         equal2(m1.descendingMap().entrySet(),
 516                m2.descendingMap().entrySet());
 517 
 518         //----------------------------------------------------------------
 519         // submaps
 520         //----------------------------------------------------------------
 521         Integer min = Integer.MIN_VALUE;
 522         Integer max = Integer.MAX_VALUE;
 523         if (m1.comparator() != null
 524             && m1.comparator().compare(min, max) > 0) {
 525             Integer tmp = min; min = max; max = tmp;
 526         }
 527         switch (rnd.nextInt(6)) {
 528         case 0:
 529             equalNavigableMapsLeaf(m1.subMap(min, true, max, true),
 530                                    m2.subMap(min, true, max, true));
 531             break;
 532         case 1:
 533             equalNavigableMapsLeaf(m1.tailMap(min, true),
 534                                    m2.tailMap(min, true));
 535             break;
 536         case 2:
 537             equalNavigableMapsLeaf(m1.headMap(max, true),
 538                                    m2.headMap(max, true));
 539             break;
 540         case 3:
 541             equalNavigableMapsLeaf((NavigableMap<Integer, Integer>) m1.subMap(min, max),
 542                                    (NavigableMap<Integer, Integer>) m2.subMap(min, max));
 543             break;
 544         case 4:
 545             equalNavigableMapsLeaf((NavigableMap<Integer, Integer>) m1.tailMap(min),
 546                                    (NavigableMap<Integer, Integer>) m2.tailMap(min));
 547             break;
 548         case 5:
 549             equalNavigableMapsLeaf((NavigableMap<Integer, Integer>) m1.headMap(max),
 550                                    (NavigableMap<Integer, Integer>) m2.headMap(max));
 551             break;
 552         }
 553     }
 554 
 555     interface MapFrobber { void frob(NavigableMap<Integer, Integer> m); }
 556     interface SetFrobber { void frob(NavigableSet<Integer> m); }
 557 
 558     static MapFrobber randomAdder(NavigableMap<Integer, Integer> m) {
 559         final Integer k = unusedKey(m);
 560         final MapFrobber[] randomAdders = {
 561             map -> {
 562                 equal(map.put(k, k + 1), null);
 563                 equal(map.get(k), k + 1);
 564                 if (maybe(4)) {
 565                     equal(map.put(k, k + 1), k + 1);
 566                     equal(map.get(k), k + 1);}},
 567             map -> {
 568                 map.descendingMap().put(k, k + 1);
 569                 equal(map.get(k), k + 1);},
 570             map -> map.tailMap(k,true).headMap(k,true).put(k, k + 1),
 571             map -> {
 572                 equal(map.tailMap(k,true).headMap(k,true).putIfAbsent(k, k + 1), null);
 573                 equal(map.tailMap(k,true).headMap(k,true).putIfAbsent(k, k + 1), k + 1);},
 574             map -> {
 575                 equal(map.tailMap(k,true).headMap(k,true).merge(k,k,Integer::sum), k);
 576                 equal(map.tailMap(k,true).headMap(k,true).merge(k,1,Integer::sum), k+1);},
 577             map -> equal(map.subMap(k,true, k, true).computeIfAbsent(k, key -> key + 1), k + 1),
 578             map -> {
 579                 equal(map.subMap(k,true, k, true).computeIfPresent(k, (key, val) -> 1), null);
 580                 equal(map.tailMap(k,true).compute(k, (key, val) -> {
 581                     equal(val, null);
 582                     return 1;
 583                 }), 1);
 584                 equal(map.headMap(k, true).computeIfPresent(k, (key, val) -> val + key), k + 1);
 585                 equal(map.tailMap(k, false).computeIfPresent(k, (key, val) -> 1), null);
 586                 equal(map.headMap(k, false).compute(k, (key, val) -> null), null);
 587                 equal(map.tailMap(k, false).computeIfAbsent(k, key -> null), null);
 588             },
 589             map -> map.tailMap(k,true).headMap(k,true).descendingMap().put(k, k + 1)
 590         };
 591         return map -> {
 592             randomAdders[rnd.nextInt(randomAdders.length)].frob(map);
 593             if (maybe(2)) equal(map.get(k), k + 1);
 594             if (maybe(4)) {
 595                 equal(map.put(k, k + 1), k + 1);
 596                 equal(map.get(k), k + 1);}};
 597     }
 598 
 599     static SetFrobber randomAdder(NavigableSet<Integer> s) {
 600         final Integer e = unusedElt(s);
 601         final SetFrobber[] randomAdders = {
 602             set -> check(set.add(e)),
 603             set -> set.descendingSet().add(e),
 604             set -> set.tailSet(e,true).headSet(e,true).add(e),
 605             set -> set.descendingSet().tailSet(e,true).headSet(e,true).add(e)
 606         };
 607         return set -> {
 608             if (maybe(2)) check(! set.contains(e));
 609             randomAdders[rnd.nextInt(randomAdders.length)].frob(set);
 610             if (maybe(2)) check(! set.add(e));
 611             if (maybe(2)) check(set.contains(e));};
 612     }
 613 
 614     static Integer unusedElt(NavigableSet<Integer> s) {
 615         Integer e;
 616         do { e = rnd.nextInt(1024); }
 617         while (s.contains(e));
 618         return e;
 619     }
 620 
 621     static Integer unusedKey(NavigableMap<Integer, Integer> m) {
 622         Integer k;
 623         do { k = rnd.nextInt(1024); }
 624         while (m.containsKey(k));
 625         return k;
 626     }
 627 
 628     static Integer usedKey(NavigableMap<Integer, Integer> m) {
 629         Integer x = rnd.nextInt(1024);
 630         Integer floor   = m.floorKey(x);
 631         Integer ceiling = m.ceilingKey(x);
 632         if (floor != null) return floor;
 633         check(ceiling != null);
 634         return ceiling;
 635     }
 636 
 637     static Integer usedElt(NavigableSet<Integer> s) {
 638         Integer x = rnd.nextInt(1024);
 639         Integer floor   = s.floor(x);
 640         Integer ceiling = s.ceiling(x);
 641         if (floor != null) return floor;
 642         check(ceiling != null);
 643         return ceiling;
 644     }
 645 
 646     static void checkUnusedKey(NavigableMap<Integer, Integer> m, Integer k) {
 647         check(! m.containsKey(k));
 648         equal(m.get(k), null);
 649         if (maybe(2))
 650             equal(m.remove(k), null);
 651     }
 652 
 653     static void checkUnusedElt(NavigableSet<Integer> s, Integer e) {
 654         if (maybe(2))
 655             check(! s.contains(e));
 656         if (maybe(2)) {
 657             check(s.ceiling(e) != e);
 658             check(s.floor(e)   != e);
 659         }
 660         if (maybe(2))
 661             check(! s.remove(e));
 662     }
 663 
 664     static Fun remover(final Iterator<?> it) {
 665         return () -> it.remove();
 666     }
 667 
 668     static MapFrobber randomRemover(NavigableMap<Integer, Integer> m) {
 669         final Integer k = usedKey(m);
 670         final MapFrobber[] randomRemovers = {
 671             map -> {
 672                 var e = map.firstEntry();
 673                 equal(map.pollFirstEntry(), e);
 674                 checkUnusedKey(map, e.getKey());},
 675             map -> {
 676                 var e = map.lastEntry();
 677                 equal(map.pollLastEntry(), e);
 678                 checkUnusedKey(map, e.getKey());},
 679             map -> {
 680                 check(map.remove(k) != null);
 681                 checkUnusedKey(map, k);},
 682             map -> {
 683                 map.subMap(k, true, k, true).clear();
 684                 checkUnusedKey(map, k);},
 685             map -> {
 686                 map.descendingMap().subMap(k, true, k, true).clear();
 687                 checkUnusedKey(map, k);},
 688             map -> {
 689                 final var it = map.keySet().iterator();
 690                 while (it.hasNext())
 691                     if (it.next().equals(k)) {
 692                         it.remove();
 693                         if (maybe(2))
 694                             THROWS(IllegalStateException.class,
 695                                    () -> it.remove());
 696                     }
 697                 checkUnusedKey(map, k);},
 698             map -> {
 699                 final var it = map.navigableKeySet().descendingIterator();
 700                 while (it.hasNext())
 701                     if (it.next().equals(k)) {
 702                         it.remove();
 703                         if (maybe(2))
 704                             THROWS(IllegalStateException.class,
 705                                    () -> it.remove());
 706                     }
 707                 checkUnusedKey(map, k);},
 708             map -> {
 709                 final var it = map.entrySet().iterator();
 710                 while (it.hasNext())
 711                     if (it.next().getKey().equals(k)) {
 712                         it.remove();
 713                         if (maybe(2))
 714                             THROWS(IllegalStateException.class, remover(it));
 715                     }
 716                 checkUnusedKey(map, k);},
 717         };
 718 
 719         return randomRemovers[rnd.nextInt(randomRemovers.length)];
 720     }
 721 
 722     static SetFrobber randomRemover(NavigableSet<Integer> s) {
 723         final Integer e = usedElt(s);
 724 
 725         final SetFrobber[] randomRemovers = {
 726             set -> {
 727                 var fst = set.first();
 728                 equal(set.pollFirst(), fst);
 729                 checkUnusedElt(set, fst);},
 730             set -> {
 731                 var lst = set.last();
 732                 equal(set.pollLast(), lst);
 733                 checkUnusedElt(set, lst);},
 734             set -> {
 735                 check(set.remove(e));
 736                 checkUnusedElt(set, e);},
 737             set -> {
 738                 set.subSet(e, true, e, true).clear();
 739                 checkUnusedElt(set, e);},
 740             set -> {
 741                 set.descendingSet().subSet(e, true, e, true).clear();
 742                 checkUnusedElt(set, e);},
 743             set -> {
 744                 final var it = set.iterator();
 745                 while (it.hasNext())
 746                     if (it.next().equals(e)) {
 747                         it.remove();
 748                         if (maybe(2))
 749                             THROWS(IllegalStateException.class,
 750                                    () -> it.remove());
 751                     }
 752                 checkUnusedElt(set, e);},
 753             set -> {
 754                 final var it = set.descendingSet().iterator();
 755                 while (it.hasNext())
 756                     if (it.next().equals(e)) {
 757                         it.remove();
 758                         if (maybe(2))
 759                             THROWS(IllegalStateException.class,
 760                                    () -> it.remove());
 761                     }
 762                 checkUnusedElt(set, e);},
 763             set -> {
 764                 final var it = set.descendingIterator();
 765                 while (it.hasNext())
 766                     if (it.next().equals(e)) {
 767                         it.remove();
 768                         if (maybe(2))
 769                             THROWS(IllegalStateException.class,
 770                                    () -> it.remove());
 771                     }
 772                 checkUnusedElt(set, e);}
 773         };
 774 
 775         return randomRemovers[rnd.nextInt(randomRemovers.length)];
 776     }
 777 
 778     static void lockStep(NavigableMap<Integer, Integer> m1,
 779                          NavigableMap<Integer, Integer> m2) {
 780         if (! (thorough || maybe(3))) return;
 781         if (maybe(4)) m1 = serialClone(m1);
 782         if (maybe(4)) m2 = serialClone(m2);
 783 
 784         var maps = Arrays.asList(m1, m2);
 785         for (var m : maps) testEmptyMap(m);
 786         final Set<Integer> ints = new HashSet<>();
 787         while (ints.size() < size)
 788             ints.add(rnd.nextInt(1024));
 789         final Integer[] elts = ints.toArray(new Integer[size]);
 790         equal(elts.length, size);
 791         for (int i = 0; i < size; i++) {
 792             MapFrobber adder = randomAdder(m1);
 793             for (var m : maps) {
 794                 adder.frob(m);
 795                 equal(m.size(), i+1);
 796             }
 797             equalNavigableMaps(m1, m2);
 798         }
 799         for (var m : maps) {
 800             final var e = usedKey(m);
 801             THROWS(IllegalArgumentException.class,
 802                    () -> m.subMap(e,true,e,false).subMap(e,true,e,true),
 803                    () -> m.subMap(e,false,e,true).subMap(e,true,e,true),
 804                    () -> m.tailMap(e,false).tailMap(e,true),
 805                    () -> m.headMap(e,false).headMap(e,true),
 806                    () -> m.headMap(e, false).put(e, 0),
 807                    () -> m.tailMap(e, false).putIfAbsent(e, 0),
 808                    () -> m.headMap(e, false).computeIfAbsent(e, k -> 1),
 809                    () -> m.tailMap(e, false).compute(e, (k, v) -> 0));
 810         }
 811         //System.out.printf("%s%n", m1);
 812         for (int i = size; i > 0; i--) {
 813             MapFrobber remover = randomRemover(m1);
 814             for (var m : maps) {
 815                 remover.frob(m);
 816                 equal(m.size(), i-1);
 817             }
 818             equalNavigableMaps(m1, m2);
 819         }
 820         for (var m : maps) testEmptyMap(m);
 821     }
 822 
 823     static void lockStep(NavigableSet<Integer> s1,
 824                          NavigableSet<Integer> s2) {
 825         if (! (thorough || maybe(3))) return;
 826         if (maybe(4)) s1 = serialClone(s1);
 827         if (maybe(4)) s2 = serialClone(s2);
 828 
 829         var sets = Arrays.asList(s1, s2);
 830         for (var s : sets) testEmptySet(s);
 831         final Set<Integer> ints = new HashSet<>();
 832         while (ints.size() < size)
 833             ints.add(rnd.nextInt(1024));
 834         final Integer[] elts = ints.toArray(new Integer[size]);
 835         equal(elts.length, size);
 836         for (int i = 0; i < size; i++) {
 837             SetFrobber adder = randomAdder(s1);
 838             for (var s : sets) {
 839                 adder.frob(s);
 840                 equal(s.size(), i+1);
 841             }
 842             equalNavigableSets(s1, s2);
 843         }
 844         for (var s : sets) {
 845             final Integer e = usedElt(s);
 846             THROWS(IllegalArgumentException.class,
 847                    () -> s.subSet(e,true,e,false).subSet(e,true,e,true),
 848                    () -> s.subSet(e,false,e,true).subSet(e,true,e,true),
 849                    () -> s.tailSet(e,false).tailSet(e,true),
 850                    () -> s.headSet(e,false).headSet(e,true));
 851         }
 852         //System.out.printf("%s%n", s1);
 853         for (int i = size; i > 0; i--) {
 854             SetFrobber remover = randomRemover(s1);
 855             for (var s : sets) {
 856                 remover.frob(s);
 857                 equal(s.size(), i-1);
 858             }
 859             equalNavigableSets(s1, s2);
 860         }
 861         for (var s : sets) testEmptySet(s);
 862     }
 863 
 864     //--------------------- Infrastructure ---------------------------
 865     static volatile int passed = 0, failed = 0;
 866     static void pass() { passed++; }
 867     static void fail() { failed++; Thread.dumpStack(); }
 868     static void fail(String msg) { System.out.println(msg); fail(); }
 869     static void unexpected(Throwable t) { failed++; t.printStackTrace(); }
 870     static void check(boolean cond) { if (cond) pass(); else fail(); }
 871     static void equal(Object x, Object y) {
 872         if (Objects.equals(x, y)) pass();
 873         else {System.out.println(x + " not equal to " + y); fail();}}
 874     static void equal2(Object x, Object y) {equal(x, y); equal(y, x);}
 875     public static void main(String[] args) throws Throwable {
 876         try { realMain(args); } catch (Throwable t) { unexpected(t); }
 877 
 878         System.out.printf("%nPassed = %d, failed = %d%n%n", passed, failed);
 879         if (failed > 0) throw new Exception("Some tests failed");
 880     }
 881     interface Fun {void f() throws Throwable;}
 882     static void THROWS(Class<? extends Throwable> k, Fun... fs) {
 883         for (Fun f : fs)
 884             try { f.f(); fail("Expected " + k.getName() + " not thrown"); }
 885             catch (Throwable t) {
 886                 if (k.isAssignableFrom(t.getClass())) pass();
 887                 else unexpected(t);}}
 888     static byte[] serializedForm(Object obj) {
 889         try {
 890             ByteArrayOutputStream baos = new ByteArrayOutputStream();
 891             new ObjectOutputStream(baos).writeObject(obj);
 892             return baos.toByteArray();
 893         } catch (IOException e) { throw new RuntimeException(e); }}
 894     static Object readObject(byte[] bytes)
 895         throws IOException, ClassNotFoundException {
 896         InputStream is = new ByteArrayInputStream(bytes);
 897         return new ObjectInputStream(is).readObject();}
 898     @SuppressWarnings("unchecked")
 899     static <T> T serialClone(T obj) {
 900         try { return (T) readObject(serializedForm(obj)); }
 901         catch (Error|RuntimeException e) { throw e; }
 902         catch (Throwable e) { throw new RuntimeException(e); }
 903     }
 904 }