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

   1 /*
   2  * Copyright (C) 1995-2007 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  * Project:     libFIRM
  22  * File name:   ir/ir/irvrfy.h
  23  * Purpose:     Check irnodes for correctness.
  24  * Author:      Christian Schaefer
  25  * Modified by: Goetz Lindenmaier. Till Riedel
  26  * Created:
  27  * CVS-ID:      $Id$
  28  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  29  */
  30
  31 /**
  32  * @file irvrfy.h
  33  *
  34  * ir graph verification.
  35  *
  36  * @author Christian Schaefer
  37  */
  38 #ifndef _FIRM_IR_IRVRFY_H_
  39 #define _FIRM_IR_IRVRFY_H_
  40
  41 #include "firm_types.h"
  42
  43 /**
  44  * Tests the modes of checknode and its predecessors.
  45  * checknode must be in current_ir_graph.
  46  *
  47  * @return
  48  *      NON-zero on success
  49  */
  50 int irn_vrfy(ir_node *checknode);
  51
  52 /**
  53  * Tests the modes of checknode and its predecessors.
  54  * checknode must be in given ir_graph.
  55  *
  56  * @return
  57  *      NON-zero on success
  58  */
  59 int irn_vrfy_irg(ir_node *checknode, ir_graph *irg);
  60
  61 /**
  62  * Same as irn_vrfy_irg, but temporary sets verification mode to
  63  * NODE_VERIFICATION_ERROR_ONLY.
  64  * @return
  65  *      NON-zero on success
  66  */
  67 int irn_vrfy_irg_dump(ir_node *checknode, ir_graph *irg, const char **bad_string);
  68
  69 /**
  70  * Flags for irg_verify().
  71  */
  72 typedef enum _irg_verify_flags_t {
  73   VRFY_NORMAL      = 0,      /**< check SSA property only if dominance information is available */
  74   VRFY_ENFORCE_SSA = 1       /**< check SSA property by enforcing the dominance information recalculation */
  75 } irg_verify_flags_t;
  76
  77 /**
  78  * Calls irn_vrfy() for each node in irg.
  79  * Graph must be in state "op_pin_state_pinned".
  80  *
  81  * @return
  82  *      NON-zero on success.
  83  */
  84 int irg_verify(ir_graph *irg, unsigned flags);
  85
  86 /**
  87  * Compatibility macro. Deprecated soon.
  88  */
  89 #define irg_vrfy(irg) irg_verify(irg, 0)
  90
  91 /**
  92  * Possible flags for irg_vrfy_bads().
  93  */
  94 enum verify_bad_flags_t {
  95   BAD_CF      = 1,      /**< Bad nodes are allowed as predecessors of Blocks and Phis. */
  96   BAD_DF      = 2,      /**< Bad nodes are allowed as dataflow predecessors. */
  97   BAD_BLOCK   = 4,      /**< Bad nodes are allowed as Block input. */
  98   TUPLE       = 8       /**< Tuple nodes are allowed. */
  99 };
 100
 101 /**
 102  * Verify occurrence of bad nodes in a graph.
 103  *
 104  * @param irg    The graph to verify
 105  * @param flags  combination of verify_bad_flags_t flags describing
 106  *               which Bads are allowed
 107  * @returns      a value combined of verify_bad_flags_t indicating the problems found.
 108  */
 109 int irg_vrfy_bads(ir_graph *irg, int flags);
 110
 111 /**
 112  *  Enable/disable verification of Load/Store nodes with
 113  *  its entities. If disabled, Store(SymConst(array)) will be allowed
 114  *  (C-frontend builds this :-)
 115  */
 116 void vrfy_enable_entity_tests(int enable);
 117
 118 #endif /* _FIRM_IR_IRVRFY_H_ */