1 /*
   2  * Copyright (c) 2014, 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 package jdk.testlibrary;
  25 
  26 import java.util.Objects;
  27 import java.util.concurrent.Callable;
  28 
  29 /**
  30  * Auxiliary class to run target w/ given timeout.
  31  */
  32 public class TimeLimitedRunner implements Callable<Void> {
  33     private final long              stoptime;
  34     private final long              timeout;
  35     private final double            factor;
  36     private final Callable<Boolean> target;
  37 
  38     /**
  39      * @param timeout   a timeout. zero means no time limitation
  40      * @param factor    a multiplier used to estimate next iteration time
  41      * @param target    a target to run
  42      * @throws NullPointerException     if target is null
  43      * @throws IllegalArgumentException if timeout is negative or
  44                                         factor isn't positive
  45      */
  46     public TimeLimitedRunner(long timeout, double factor,
  47             Callable<Boolean> target) {
  48         Objects.requireNonNull(target, "target must not be null");
  49         if (timeout < 0) {
  50             throw new IllegalArgumentException("timeout[" + timeout + "] < 0");
  51         }
  52         if (factor <= 0d) {
  53             throw new IllegalArgumentException("factor[" + factor + "] <= 0");
  54         }
  55         this.stoptime = System.currentTimeMillis() + timeout;
  56         this.timeout = timeout;
  57         this.factor = factor;
  58         this.target = target;
  59     }
  60 
  61     /**
  62      * Runs @{linkplan target} while it returns true and timeout isn't exceeded
  63      */
  64     @Override
  65     public Void call() throws Exception {
  66         long maxDuration = 0L;
  67         long iterStart = System.currentTimeMillis();
  68         if (timeout != 0 && iterStart > stoptime) {
  69             return null;
  70         }
  71         while (target.call()) {
  72             if (timeout != 0) {
  73                 long iterDuration = System.currentTimeMillis() - iterStart;
  74                 maxDuration = Math.max(maxDuration, iterDuration);
  75                 iterStart = System.currentTimeMillis();
  76                 if (iterStart + (maxDuration * factor) > stoptime) {
  77                     System.out.println("Not enough time to continue execution. "
  78                             + "Interrupted.");
  79                     break;
  80                 }
  81             }
  82         }
  83         return null;
  84     }
  85 
  86 }