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 #include "begin.h"
  31
  32 /**
  33  * Tests the modes of checknode and its predecessors.
  34  * checknode must be in current_ir_graph.
  35  *
  36  * @return
  37  *      NON-zero on success
  38  */
  39 FIRM_DLL int irn_vrfy(ir_node *checknode);
  40
  41 /**
  42  * Tests the modes of checknode and its predecessors.
  43  * checknode must be in given ir_graph.
  44  *
  45  * @return
  46  *      NON-zero on success
  47  */
  48 FIRM_DLL int irn_vrfy_irg(ir_node *checknode, ir_graph *irg);
  49
  50 /**
  51  * Same as irn_vrfy_irg, but temporary sets verification mode to
  52  * NODE_VERIFICATION_ERROR_ONLY.
  53  * @return
  54  *      NON-zero on success
  55  */
  56 FIRM_DLL int irn_vrfy_irg_dump(ir_node *checknode, ir_graph *irg, const char **bad_string);
  57
  58 /**
  59  * Flags for irg_verify().
  60  */
  61 typedef enum _irg_verify_flags_t {
  62         VRFY_NORMAL      = 0,      /**< check SSA property only if dominance information is available */
  63         VRFY_ENFORCE_SSA = 1       /**< check SSA property by enforcing the dominance information recalculation */
  64 } irg_verify_flags_t;
  65
  66 /**
  67  * Calls irn_vrfy() for each node in irg.
  68  * Graph must be in state "op_pin_state_pinned".
  69  *
  70  * @param irg    the IR-graph t check
  71  * @param flags  one of irg_verify_flags_t
  72  *
  73  * @return
  74  *      NON-zero on success.
  75  */
  76 FIRM_DLL int irg_verify(ir_graph *irg, unsigned flags);
  77
  78 /**
  79  * Compatibility macro. Deprecated soon.
  80  */
  81 #define irg_vrfy(irg) irg_verify(irg, 0)
  82
  83 /**
  84  * Creates an ir_graph pass for irg_verify().
  85  *
  86  * @param name   the name of this pass or NULL
  87  * @param flags  one of irg_verify_flags_t
  88  *
  89  * @return  the newly created ir_graph pass
  90  */
  91 FIRM_DLL ir_graph_pass_t *irg_verify_pass(const char *name, unsigned flags);
  92
  93 /**
  94  * Possible flags for irg_vrfy_bads().
  95  */
  96 enum verify_bad_flags_t {
  97         BAD_CF      = 1,    /**< Bad nodes are allowed as predecessors of Blocks and Phis. */
  98         BAD_DF      = 2,    /**< Bad nodes are allowed as dataflow predecessors. */
  99         BAD_BLOCK   = 4,    /**< Bad nodes are allowed as Block input. */
 100         TUPLE       = 8     /**< Tuple nodes are allowed. */
 101 };
 102
 103 /**
 104  * Verify occurrence of bad nodes in a graph.
 105  *
 106  * @param irg    The graph to verify
 107  * @param flags  combination of verify_bad_flags_t flags describing
 108  *               which Bads are allowed
 109  * @returns      a value combined of verify_bad_flags_t indicating the problems found.
 110  */
 111 FIRM_DLL int irg_vrfy_bads(ir_graph *irg, int flags);
 112
 113 /**
 114  *  Enable/disable verification of Load/Store nodes with
 115  *  its entities. If disabled, Store(SymConst(array)) will be allowed
 116  *  (C-frontend builds this :-)
 117  */
 118 FIRM_DLL void vrfy_enable_entity_tests(int enable);
 119
 120 #include "end.h"
 121
 122 #endif