ViewVC Help
View File | Revision Log | Show Annotations | Download File | Root Listing
root/jsr166/jsr166/src/test/jtreg/util/Collection/IteratorMicroBenchmark.java
Revision: 1.39
Committed: Mon Mar 26 21:04:36 2018 UTC (6 years, 2 months ago) by jsr166
Branch: MAIN
Changes since 1.38: +18 -22 lines
Log Message:
use same boring infrastructure for listJobs as for other kinds of Jobs

File Contents

# Content
1 /*
2 * Copyright (c) 2007, 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 * @summary micro-benchmark correctness mode
27 * @run main IteratorMicroBenchmark iterations=1 size=8 warmup=0
28 */
29
30 import static java.util.stream.Collectors.summingInt;
31 import static java.util.stream.Collectors.toCollection;
32
33 import java.lang.ref.WeakReference;
34 import java.util.ArrayDeque;
35 import java.util.ArrayList;
36 import java.util.Collection;
37 import java.util.Collections;
38 import java.util.Deque;
39 import java.util.HashMap;
40 import java.util.Iterator;
41 import java.util.LinkedList;
42 import java.util.List;
43 import java.util.ListIterator;
44 import java.util.PriorityQueue;
45 import java.util.Spliterator;
46 import java.util.Vector;
47 import java.util.concurrent.ArrayBlockingQueue;
48 import java.util.concurrent.ConcurrentLinkedDeque;
49 import java.util.concurrent.ConcurrentLinkedQueue;
50 import java.util.concurrent.CopyOnWriteArrayList;
51 import java.util.concurrent.LinkedBlockingDeque;
52 import java.util.concurrent.LinkedBlockingQueue;
53 import java.util.concurrent.LinkedTransferQueue;
54 import java.util.concurrent.PriorityBlockingQueue;
55 import java.util.concurrent.CountDownLatch;
56 import java.util.concurrent.ThreadLocalRandom;
57 import java.util.concurrent.TimeUnit;
58 import java.util.concurrent.atomic.LongAdder;
59 import java.util.regex.Pattern;
60 import java.util.stream.Stream;
61 import java.util.function.ToIntFunction;
62
63 /**
64 * Usage: [iterations=N] [size=N] [filter=REGEXP] [warmup=SECONDS]
65 *
66 * To run this in micro-benchmark mode, simply run as a normal java program.
67 * Be patient; this program runs for a very long time.
68 * For faster runs, restrict execution using command line args.
69 *
70 * This is an interface based version of ArrayList/IteratorMicroBenchmark
71 *
72 * @author Martin Buchholz
73 */
74 public class IteratorMicroBenchmark {
75 abstract static class Job {
76 private final String name;
77 public Job(String name) { this.name = name; }
78 public String name() { return name; }
79 public abstract void work() throws Throwable;
80 public void run() {
81 try { work(); }
82 catch (Throwable ex) {
83 // current job cannot always be deduced from stacktrace.
84 throw new RuntimeException("Job failed: " + name(), ex);
85 }
86 }
87 }
88
89 final int iterations;
90 final int size; // number of elements in collections
91 final double warmupSeconds;
92 final long warmupNanos;
93 final Pattern nameFilter; // select subset of Jobs to run
94 final boolean reverse; // reverse order of Jobs
95 final boolean shuffle; // randomize order of Jobs
96
97 IteratorMicroBenchmark(String[] args) {
98 iterations = intArg(args, "iterations", 10_000);
99 size = intArg(args, "size", 1000);
100 warmupSeconds = doubleArg(args, "warmup", 7.0);
101 nameFilter = patternArg(args, "filter");
102 reverse = booleanArg(args, "reverse");
103 shuffle = booleanArg(args, "shuffle");
104
105 warmupNanos = (long) (warmupSeconds * (1000L * 1000L * 1000L));
106 }
107
108 // --------------- GC finalization infrastructure ---------------
109
110 /** No guarantees, but effective in practice. */
111 static void forceFullGc() {
112 CountDownLatch finalizeDone = new CountDownLatch(1);
113 WeakReference<?> ref = new WeakReference<Object>(new Object() {
114 @SuppressWarnings("deprecation")
115 protected void finalize() { finalizeDone.countDown(); }});
116 try {
117 for (int i = 0; i < 10; i++) {
118 System.gc();
119 if (finalizeDone.await(1L, TimeUnit.SECONDS) && ref.get() == null) {
120 System.runFinalization(); // try to pick up stragglers
121 return;
122 }
123 }
124 } catch (InterruptedException unexpected) {
125 throw new AssertionError("unexpected InterruptedException");
126 }
127 throw new AssertionError("failed to do a \"full\" gc");
128 }
129
130 /**
131 * Runs each job for long enough that all the runtime compilers
132 * have had plenty of time to warm up, i.e. get around to
133 * compiling everything worth compiling.
134 * Returns array of average times per job per run.
135 */
136 long[] time0(List<Job> jobs) {
137 final int size = jobs.size();
138 long[] nanoss = new long[size];
139 for (int i = 0; i < size; i++) {
140 if (warmupNanos > 0) forceFullGc();
141 Job job = jobs.get(i);
142 long totalTime;
143 int runs = 0;
144 long startTime = System.nanoTime();
145 do { job.run(); runs++; }
146 while ((totalTime = System.nanoTime() - startTime) < warmupNanos);
147 nanoss[i] = totalTime/runs;
148 }
149 return nanoss;
150 }
151
152 void time(List<Job> jobs) throws Throwable {
153 if (warmupNanos > 0) time0(jobs); // Warm up run
154 final int size = jobs.size();
155 final long[] nanoss = time0(jobs); // Real timing run
156 final long[] milliss = new long[size];
157 final double[] ratios = new double[size];
158
159 final String nameHeader = "Method";
160 final String millisHeader = "Millis";
161 final String ratioHeader = "Ratio";
162
163 int nameWidth = nameHeader.length();
164 int millisWidth = millisHeader.length();
165 int ratioWidth = ratioHeader.length();
166
167 for (int i = 0; i < size; i++) {
168 nameWidth = Math.max(nameWidth, jobs.get(i).name().length());
169
170 milliss[i] = nanoss[i]/(1000L * 1000L);
171 millisWidth = Math.max(millisWidth,
172 String.format("%d", milliss[i]).length());
173
174 ratios[i] = (double) nanoss[i] / (double) nanoss[0];
175 ratioWidth = Math.max(ratioWidth,
176 String.format("%.3f", ratios[i]).length());
177 }
178
179 String format = String.format("%%-%ds %%%dd %%%d.3f%%n",
180 nameWidth, millisWidth, ratioWidth);
181 String headerFormat = String.format("%%-%ds %%%ds %%%ds%%n",
182 nameWidth, millisWidth, ratioWidth);
183 System.out.printf(headerFormat, "Method", "Millis", "Ratio");
184
185 // Print out absolute and relative times, calibrated against first job
186 for (int i = 0; i < size; i++)
187 System.out.printf(format, jobs.get(i).name(), milliss[i], ratios[i]);
188 }
189
190 private static String keywordValue(String[] args, String keyword) {
191 for (String arg : args)
192 if (arg.startsWith(keyword))
193 return arg.substring(keyword.length() + 1);
194 return null;
195 }
196
197 private static int intArg(String[] args, String keyword, int defaultValue) {
198 String val = keywordValue(args, keyword);
199 return (val == null) ? defaultValue : Integer.parseInt(val);
200 }
201
202 private static double doubleArg(String[] args, String keyword, double defaultValue) {
203 String val = keywordValue(args, keyword);
204 return (val == null) ? defaultValue : Double.parseDouble(val);
205 }
206
207 private static Pattern patternArg(String[] args, String keyword) {
208 String val = keywordValue(args, keyword);
209 return (val == null) ? null : Pattern.compile(val);
210 }
211
212 private static boolean booleanArg(String[] args, String keyword) {
213 String val = keywordValue(args, keyword);
214 if (val == null || val.equals("false")) return false;
215 if (val.equals("true")) return true;
216 throw new IllegalArgumentException(val);
217 }
218
219 private static void deoptimize(int sum) {
220 if (sum == 42)
221 System.out.println("the answer");
222 }
223
224 private static <T> Iterable<T> backwards(final List<T> list) {
225 return new Iterable<T>() {
226 public Iterator<T> iterator() {
227 return new Iterator<T>() {
228 final ListIterator<T> it = list.listIterator(list.size());
229 public boolean hasNext() { return it.hasPrevious(); }
230 public T next() { return it.previous(); }
231 public void remove() { it.remove(); }};}};
232 }
233
234 // Checks for correctness *and* prevents loop optimizations
235 static class Check {
236 private int sum;
237 public void sum(int sum) {
238 if (this.sum == 0)
239 this.sum = sum;
240 if (this.sum != sum)
241 throw new AssertionError("Sum mismatch");
242 }
243 }
244 volatile Check check = new Check();
245
246 public static void main(String[] args) throws Throwable {
247 new IteratorMicroBenchmark(args).run();
248 }
249
250 HashMap<Class<?>, String> goodClassName = new HashMap<>();
251
252 String goodClassName(Class<?> klazz) {
253 return goodClassName.computeIfAbsent(
254 klazz,
255 k -> {
256 String simple = k.getSimpleName();
257 return (simple.equals("SubList")) // too simple!
258 ? k.getName().replaceFirst(".*\\.", "")
259 : simple;
260 });
261 }
262
263 static List<Integer> makeSubList(List<Integer> list) {
264 final ThreadLocalRandom rnd = ThreadLocalRandom.current();
265 int size = list.size();
266 if (size <= 2) return list.subList(0, size);
267 List<Integer> subList = list.subList(rnd.nextInt(0, 2),
268 size - rnd.nextInt(0, 2));
269 List<Integer> copy = new ArrayList<>(list);
270 subList.clear();
271 subList.addAll(copy);
272 return subList;
273 }
274
275 void run() throws Throwable {
276 // System.out.printf(
277 // "iterations=%d size=%d, warmup=%1g, filter=\"%s\"%n",
278 // iterations, size, warmupSeconds, nameFilter);
279
280 final ArrayList<Integer> al = new ArrayList<>(size);
281
282 // Populate collections with random data
283 final ThreadLocalRandom rnd = ThreadLocalRandom.current();
284 for (int i = 0; i < size; i++)
285 al.add(rnd.nextInt(size));
286
287 final ArrayDeque<Integer> ad = new ArrayDeque<>(al);
288 final ArrayBlockingQueue<Integer> abq = new ArrayBlockingQueue<>(al.size());
289 abq.addAll(al);
290
291 // shuffle circular array elements so they wrap
292 for (int i = 0, n = rnd.nextInt(size); i < n; i++) {
293 ad.addLast(ad.removeFirst());
294 abq.add(abq.remove());
295 }
296
297 ArrayList<Job> jobs = Stream.<Collection<Integer>>of(
298 al, ad, abq,
299 makeSubList(new ArrayList<>(al)),
300 new LinkedList<>(al),
301 makeSubList(new LinkedList<>(al)),
302 new PriorityQueue<>(al),
303 new Vector<>(al),
304 makeSubList(new Vector<>(al)),
305 new CopyOnWriteArrayList<>(al),
306 makeSubList(new CopyOnWriteArrayList<>(al)),
307 new ConcurrentLinkedQueue<>(al),
308 new ConcurrentLinkedDeque<>(al),
309 new LinkedBlockingQueue<>(al),
310 new LinkedBlockingDeque<>(al),
311 new LinkedTransferQueue<>(al),
312 new PriorityBlockingQueue<>(al))
313 .flatMap(x -> jobs(x))
314 .filter(job ->
315 nameFilter == null || nameFilter.matcher(job.name()).find())
316 .collect(toCollection(ArrayList::new));
317
318 if (reverse) Collections.reverse(jobs);
319 if (shuffle) Collections.shuffle(jobs);
320
321 time(jobs);
322 }
323
324 @SafeVarargs @SuppressWarnings("varargs")
325 private <T> Stream<T> concatStreams(Stream<T> ... streams) {
326 return Stream.of(streams).flatMap(s -> s);
327 }
328
329 Stream<Job> jobs(Collection<Integer> x) {
330 return concatStreams(
331 collectionJobs(x),
332 (x instanceof Deque)
333 ? dequeJobs((Deque<Integer>)x)
334 : Stream.empty(),
335 (x instanceof List)
336 ? listJobs((List<Integer>)x)
337 : Stream.empty());
338 }
339
340 Object sneakyAdder(int[] sneakySum) {
341 return new Object() {
342 public int hashCode() { throw new AssertionError(); }
343 public boolean equals(Object z) {
344 sneakySum[0] += (int) z; return false; }};
345 }
346
347 Stream<Job> collectionJobs(Collection<Integer> x) {
348 final String klazz = goodClassName(x.getClass());
349 return Stream.of(
350 new Job(klazz + " iterate for loop") {
351 public void work() throws Throwable {
352 for (int i = 0; i < iterations; i++) {
353 int sum = 0;
354 for (Integer n : x)
355 sum += n;
356 check.sum(sum);}}},
357 new Job(klazz + " iterator().forEachRemaining()") {
358 public void work() throws Throwable {
359 int[] sum = new int[1];
360 for (int i = 0; i < iterations; i++) {
361 sum[0] = 0;
362 x.iterator().forEachRemaining(n -> sum[0] += n);
363 check.sum(sum[0]);}}},
364 new Job(klazz + " spliterator().tryAdvance()") {
365 public void work() throws Throwable {
366 int[] sum = new int[1];
367 for (int i = 0; i < iterations; i++) {
368 sum[0] = 0;
369 Spliterator<Integer> spliterator = x.spliterator();
370 do {} while (spliterator.tryAdvance(n -> sum[0] += n));
371 check.sum(sum[0]);}}},
372 new Job(klazz + " spliterator().forEachRemaining()") {
373 public void work() throws Throwable {
374 int[] sum = new int[1];
375 for (int i = 0; i < iterations; i++) {
376 sum[0] = 0;
377 x.spliterator().forEachRemaining(n -> sum[0] += n);
378 check.sum(sum[0]);}}},
379 new Job(klazz + " removeIf") {
380 public void work() throws Throwable {
381 int[] sum = new int[1];
382 for (int i = 0; i < iterations; i++) {
383 sum[0] = 0;
384 if (x.removeIf(n -> { sum[0] += n; return false; }))
385 throw new AssertionError();
386 check.sum(sum[0]);}}},
387 new Job(klazz + " contains") {
388 public void work() throws Throwable {
389 int[] sum = new int[1];
390 Object sneakyAdder = sneakyAdder(sum);
391 for (int i = 0; i < iterations; i++) {
392 sum[0] = 0;
393 if (x.contains(sneakyAdder)) throw new AssertionError();
394 check.sum(sum[0]);}}},
395 new Job(klazz + " remove(Object)") {
396 public void work() throws Throwable {
397 int[] sum = new int[1];
398 Object sneakyAdder = sneakyAdder(sum);
399 for (int i = 0; i < iterations; i++) {
400 sum[0] = 0;
401 if (x.remove(sneakyAdder)) throw new AssertionError();
402 check.sum(sum[0]);}}},
403 new Job(klazz + " forEach") {
404 public void work() throws Throwable {
405 int[] sum = new int[1];
406 for (int i = 0; i < iterations; i++) {
407 sum[0] = 0;
408 x.forEach(n -> sum[0] += n);
409 check.sum(sum[0]);}}},
410 new Job(klazz + " toArray()") {
411 public void work() throws Throwable {
412 int[] sum = new int[1];
413 for (int i = 0; i < iterations; i++) {
414 sum[0] = 0;
415 for (Object o : x.toArray())
416 sum[0] += (Integer) o;
417 check.sum(sum[0]);}}},
418 new Job(klazz + " toArray(a)") {
419 public void work() throws Throwable {
420 Integer[] a = new Integer[x.size()];
421 int[] sum = new int[1];
422 for (int i = 0; i < iterations; i++) {
423 sum[0] = 0;
424 x.toArray(a);
425 for (Object o : a)
426 sum[0] += (Integer) o;
427 check.sum(sum[0]);}}},
428 new Job(klazz + " toArray(empty)") {
429 public void work() throws Throwable {
430 Integer[] empty = new Integer[0];
431 int[] sum = new int[1];
432 for (int i = 0; i < iterations; i++) {
433 sum[0] = 0;
434 for (Integer o : x.toArray(empty))
435 sum[0] += o;
436 check.sum(sum[0]);}}},
437 new Job(klazz + " stream().forEach") {
438 public void work() throws Throwable {
439 int[] sum = new int[1];
440 for (int i = 0; i < iterations; i++) {
441 sum[0] = 0;
442 x.stream().forEach(n -> sum[0] += n);
443 check.sum(sum[0]);}}},
444 new Job(klazz + " stream().mapToInt") {
445 public void work() throws Throwable {
446 for (int i = 0; i < iterations; i++) {
447 check.sum(x.stream().mapToInt(e -> e).sum());}}},
448 new Job(klazz + " stream().collect") {
449 public void work() throws Throwable {
450 for (int i = 0; i < iterations; i++) {
451 check.sum(x.stream()
452 .collect(summingInt(e -> e)));}}},
453 new Job(klazz + " stream()::iterator") {
454 public void work() throws Throwable {
455 int[] sum = new int[1];
456 for (int i = 0; i < iterations; i++) {
457 sum[0] = 0;
458 for (Integer o : (Iterable<Integer>) x.stream()::iterator)
459 sum[0] += o;
460 check.sum(sum[0]);}}},
461 new Job(klazz + " parallelStream().forEach") {
462 public void work() throws Throwable {
463 for (int i = 0; i < iterations; i++) {
464 LongAdder sum = new LongAdder();
465 x.parallelStream().forEach(n -> sum.add(n));
466 check.sum((int) sum.sum());}}},
467 new Job(klazz + " parallelStream().mapToInt") {
468 public void work() throws Throwable {
469 for (int i = 0; i < iterations; i++) {
470 check.sum(x.parallelStream().mapToInt(e -> e).sum());}}},
471 new Job(klazz + " parallelStream().collect") {
472 public void work() throws Throwable {
473 for (int i = 0; i < iterations; i++) {
474 check.sum(x.parallelStream()
475 .collect(summingInt(e -> e)));}}},
476 new Job(klazz + " parallelStream()::iterator") {
477 public void work() throws Throwable {
478 int[] sum = new int[1];
479 for (int i = 0; i < iterations; i++) {
480 sum[0] = 0;
481 for (Integer o : (Iterable<Integer>) x.parallelStream()::iterator)
482 sum[0] += o;
483 check.sum(sum[0]);}}});
484 }
485
486 Stream<Job> dequeJobs(Deque<Integer> x) {
487 String klazz = goodClassName(x.getClass());
488 return Stream.of(
489 new Job(klazz + " descendingIterator() loop") {
490 public void work() throws Throwable {
491 for (int i = 0; i < iterations; i++) {
492 int sum = 0;
493 Iterator<Integer> it = x.descendingIterator();
494 while (it.hasNext())
495 sum += it.next();
496 check.sum(sum);}}},
497 new Job(klazz + " descendingIterator().forEachRemaining()") {
498 public void work() throws Throwable {
499 int[] sum = new int[1];
500 for (int i = 0; i < iterations; i++) {
501 sum[0] = 0;
502 x.descendingIterator().forEachRemaining(n -> sum[0] += n);
503 check.sum(sum[0]);}}});
504 }
505
506 Stream<Job> listJobs(List<Integer> x) {
507 final String klazz = goodClassName(x.getClass());
508 return Stream.of(
509 new Job(klazz + " indexOf") {
510 public void work() throws Throwable {
511 int[] sum = new int[1];
512 Object sneakyAdder = sneakyAdder(sum);
513 for (int i = 0; i < iterations; i++) {
514 sum[0] = 0;
515 if (x.indexOf(sneakyAdder) != -1)
516 throw new AssertionError();
517 check.sum(sum[0]);}}},
518 new Job(klazz + " lastIndexOf") {
519 public void work() throws Throwable {
520 int[] sum = new int[1];
521 Object sneakyAdder = sneakyAdder(sum);
522 for (int i = 0; i < iterations; i++) {
523 sum[0] = 0;
524 if (x.lastIndexOf(sneakyAdder) != -1)
525 throw new AssertionError();
526 check.sum(sum[0]);}}});
527 }
528 }