1 /* 2 * Copyright (c) 2013, 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 org.graalvm.compiler.phases; 24 25 import org.graalvm.compiler.nodes.StructuredGraph; 26 27 /*** 28 * This phase serves as a verification, in order to check the graph for certain properties. The 29 * {@link #verify(StructuredGraph, Object)} method will be used as an assertion, and implements the 30 * actual check. Instead of returning false, it is also valid to throw an {@link VerificationError} 31 * in the implemented {@link #verify(StructuredGraph, Object)} method. 32 */ 33 public abstract class VerifyPhase<C> extends BasePhase<C> { 34 35 /** 36 * Thrown when verification performed by a {@link VerifyPhase} fails. 37 */ 38 @SuppressWarnings("serial") 39 public static class VerificationError extends AssertionError { 40 41 public VerificationError(String message) { 42 super(message); 43 } 44 45 public VerificationError(String format, Object... args) { 46 super(String.format(format, args)); 47 } 48 49 public VerificationError(String message, Throwable cause) { 50 super(message, cause); 51 } 52 } 53 54 @Override 55 protected final void run(StructuredGraph graph, C context) { 56 assert verify(graph, context); 57 } 58 59 /** 60 * Performs the actual verification. 61 * 62 * @throws VerificationError if the verification fails 63 */ 64 protected abstract boolean verify(StructuredGraph graph, C context); 65 }