1/*
2 * Copyright (c) 2015, 2017, 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
24package test.java.lang.invoke.lib;
25
26import jdk.testlibrary.Utils;
27
28/**
29 * Helper class used to catch and process VirtualMachineError with message "Out
30 * of space in CodeCache". Some JSR292 tests run out of code cache size, so code
31 * cache overflows and VME is thrown. This VME is considered as non-critical in
32 * some JSR292 tests, so it should be processed to prevent test failure.
33 */
34public class CodeCacheOverflowProcessor {
35
36    /**
37     * Checks if an instance of Throwable is caused by VirtualMachineError with
38     * message "Out of space in CodeCache". May be used as filter in method
39     * {@code jdk.testlibrary.Utils.filterException}.
40     *
41     * @param t - Throwable to check.
42     * @return true if Throwable is caused by VME, false otherwise.
43     */
44    public static Boolean isThrowableCausedByVME(Throwable t) {
45        Throwable causeOfT = t;
46        do {
47            if (causeOfT instanceof VirtualMachineError
48                    && causeOfT.getMessage().matches(".*[Oo]ut of space"
49                            + " in CodeCache.*")) {
50                return true;
51            }
52            causeOfT = causeOfT != null ? causeOfT.getCause() : null;
53        } while (causeOfT != null && causeOfT != t);
54        return false;
55    }
56
57    /**
58     * Checks if the given test throws an exception caused by
59     * VirtualMachineError with message "Out of space in CodeCache", and, if VME
60     * takes place, processes it so that no exception is thrown, and prints its
61     * stack trace. If test throws exception not caused by VME, this method just
62     * re-throws this exception.
63     *
64     * @param test - test to check for and process VirtualMachineError.
65     * @return - an exception caused by VME or null
66     *           if test has thrown no exception.
67     * @throws Throwable - if test has thrown an exception
68     *                     that is not caused by VME.
69     */
70    public static Throwable runMHTest(Utils.ThrowingRunnable test) throws Throwable {
71        Throwable t = Utils.filterException(test::run,
72                CodeCacheOverflowProcessor::isThrowableCausedByVME);
73        if (t != null) {
74            System.err.printf("%nNon-critical exception caught becuse of"
75                    + " code cache size is not enough to run all test cases.%n%n");
76        }
77        return t;
78    }
79}
80