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