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