nsz Git - libfirm/blob - include/libfirm/irvrfy.h

   1 /*
   2  * Copyright (C) 1995-2009 University of Karlsruhe.  All right reserved.
   3  *
   4  * This file is part of libFirm.
   5  *
   6  * This file may be distributed and/or modified under the terms of the
   7  * GNU General Public License version 2 as published by the Free Software
   8  * Foundation and appearing in the file LICENSE.GPL included in the
   9  * packaging of this file.
  10  *
  11  * Licensees holding valid libFirm Professional Edition licenses may use
  12  * this file in accordance with the libFirm Commercial License.
  13  * Agreement provided with the Software.
  14  *
  15  * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
  16  * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  17  * PURPOSE.
  18  */
  19
  20 /**
  21  * @file
  22  * @brief    Check irnodes for correctness.
  23  * @author   Christian Schaefer, Goetz Lindenmaier, Till Riedel
  24  * @version  $Id$
  25  */
  26 #ifndef FIRM_IR_IRVRFY_H
  27 #define FIRM_IR_IRVRFY_H
  28
  29 #include "firm_types.h"
  30
  31 /**
  32  * Tests the modes of checknode and its predecessors.
  33  * checknode must be in current_ir_graph.
  34  *
  35  * @return
  36  *      NON-zero on success
  37  */
  38 int irn_vrfy(ir_node *checknode);
  39
  40 /**
  41  * Tests the modes of checknode and its predecessors.
  42  * checknode must be in given ir_graph.
  43  *
  44  * @return
  45  *      NON-zero on success
  46  */
  47 int irn_vrfy_irg(ir_node *checknode, ir_graph *irg);
  48
  49 /**
  50  * Same as irn_vrfy_irg, but temporary sets verification mode to
  51  * NODE_VERIFICATION_ERROR_ONLY.
  52  * @return
  53  *      NON-zero on success
  54  */
  55 int irn_vrfy_irg_dump(ir_node *checknode, ir_graph *irg, const char **bad_string);
  56
  57 /**
  58  * Flags for irg_verify().
  59  */
  60 typedef enum _irg_verify_flags_t {
  61         VRFY_NORMAL      = 0,      /**< check SSA property only if dominance information is available */
  62         VRFY_ENFORCE_SSA = 1       /**< check SSA property by enforcing the dominance information recalculation */
  63 } irg_verify_flags_t;
  64
  65 /**
  66  * Calls irn_vrfy() for each node in irg.
  67  * Graph must be in state "op_pin_state_pinned".
  68  *
  69  * @param irg    the IR-graph t check
  70  * @param flags  one of irg_verify_flags_t
  71  *
  72  * @return
  73  *      NON-zero on success.
  74  */
  75 int irg_verify(ir_graph *irg, unsigned flags);
  76
  77 /**
  78  * Compatibility macro. Deprecated soon.
  79  */
  80 #define irg_vrfy(irg) irg_verify(irg, 0)
  81
  82 /**
  83  * Creates an ir_graph pass for irg_verify().
  84  *
  85  * @param name   the name of this pass or NULL
  86  * @param flags  one of irg_verify_flags_t
  87  *
  88  * @return  the newly created ir_graph pass
  89  */
  90 ir_graph_pass_t *irg_verify_pass(const char *name, unsigned flags);
  91
  92 /**
  93  * Possible flags for irg_vrfy_bads().
  94  */
  95 enum verify_bad_flags_t {
  96         BAD_CF      = 1,    /**< Bad nodes are allowed as predecessors of Blocks and Phis. */
  97         BAD_DF      = 2,    /**< Bad nodes are allowed as dataflow predecessors. */
  98         BAD_BLOCK   = 4,    /**< Bad nodes are allowed as Block input. */
  99         TUPLE       = 8     /**< Tuple nodes are allowed. */
 100 };
 101
 102 /**
 103  * Verify occurrence of bad nodes in a graph.
 104  *
 105  * @param irg    The graph to verify
 106  * @param flags  combination of verify_bad_flags_t flags describing
 107  *               which Bads are allowed
 108  * @returns      a value combined of verify_bad_flags_t indicating the problems found.
 109  */
 110 int irg_vrfy_bads(ir_graph *irg, int flags);
 111
 112 /**
 113  *  Enable/disable verification of Load/Store nodes with
 114  *  its entities. If disabled, Store(SymConst(array)) will be allowed
 115  *  (C-frontend builds this :-)
 116  */
 117 void vrfy_enable_entity_tests(int enable);
 118
 119 #endif