1 /*
   2  * Copyright (c) 2015, 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 package com.oracle.testlibrary.jsr292;
  24 
  25 import jdk.testlibrary.Utils;
  26 
  27 /**
  28  * Helper class used to catch and process VirtualMachineError with message "Out
  29  * of space in CodeCache". Some JSR292 tests run out of code cache size, so code
  30  * cache overflows and VME is thrown. This VME is considered as non-critical in
  31  * some JSR292 tests, so it should be processed to prevent test failure.
  32  * <p>
  33  * The result of a VirtualMachineError being thrown at class initialization time
  34  * is an unusable class, which when tried to be used again, triggers a secondary
  35  * NoClassDefFoundError with message "Could not initialize class ClassName" and
  36  * no cause. This NCDFE is also considered non-critical because it is a consequence
  37  * of the VME (or any other exception) being thrown from {@code &lt;clinit&gt;}.
  38  * If the cause for secondary exception is not VME, then the test should fail
  39  * because of the primary exception anyway.
  40  */
  41 public class CodeCacheOverflowProcessor {
  42 
  43     /**
  44      * Checks if an instance of Throwable is caused by VirtualMachineError with
  45      * message "Out of space in CodeCache" or by NoClassDefFoundError with message
  46      * "Could not initialize class ClassName". May be used as filter in method
  47      * {@code jdk.testlibrary.Utils.filterException}.
  48      *
  49      * @param t - Throwable to check.
  50      * @return true if Throwable is caused by VME, false otherwise.
  51      */
  52     public static Boolean isThrowableCausedByVME(Throwable t) {
  53         Throwable causeOfT = t;
  54         do {
  55             if (causeOfT instanceof VirtualMachineError
  56                     && causeOfT.getMessage().matches(".*[Oo]ut of space"
  57                             + " in CodeCache.*")) {
  58                 return true;
  59             }
  60             if (causeOfT instanceof NoClassDefFoundError
  61                     && causeOfT.getMessage().matches("Could not initialize class.*")
  62                     && causeOfT.getCause() == null) {
  63                 return true;
  64             }
  65             causeOfT = causeOfT != null ? causeOfT.getCause() : null;
  66         } while (causeOfT != null && causeOfT != t);
  67         return false;
  68     }
  69 
  70     /**
  71      * Checks if the given test throws an exception caused by
  72      * VirtualMachineError with message "Out of space in CodeCache" or by
  73      * NoClassDefFoundError with message "Could not initialize class ClassName",
  74      * and, if this is the case, processes it so that no exception is thrown,
  75      * and prints its stack trace. If test throws any other exception,
  76      * this method just re-throws this exception.
  77      *
  78      * @param test - test to check for and process VirtualMachineError.
  79      * @return - an exception caused by VME or null
  80      *           if test has thrown no exception.
  81      * @throws Throwable - if test has thrown an exception
  82      *                     that is not caused by VME.
  83      */
  84     public static Throwable runMHTest(Utils.ThrowingRunnable test) throws Throwable {
  85         Throwable t = Utils.filterException(test::run,
  86                 CodeCacheOverflowProcessor::isThrowableCausedByVME);
  87         if (t != null) {
  88             System.err.printf("%nNon-critical exception caught becuse of"
  89                     + " code cache size is not enough to run all test cases.%n%n");
  90             t.printStackTrace();
  91         }
  92         return t;
  93     }
  94 }