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

   1 /*
   2  * Project:     libFIRM
   3  * File name:   ir/ir/irvrfy.h
   4  * Purpose:     Check irnodes for correctness.
   5  * Author:      Christian Schaefer
   6  * Modified by: Goetz Lindenmaier. Till Riedel
   7  * Created:
   8  * CVS-ID:      $Id$
   9  * Copyright:   (c) 1998-2003 Universität Karlsruhe
  10  * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
  11  */
  12
  13 /**
  14 * @file irvrfy.h
  15 *
  16 * ir graph verification.
  17 *
  18 * @author Christian Schaefer
  19 */
  20
  21 # ifndef _IRVRFY_H_
  22 # define _IRVRFY_H_
  23
  24 # include "irnode.h"
  25 # include "irgraph.h"
  26
  27 typedef enum _node_verification_t {
  28   NODE_VERIFICATION_OFF        = 0,     /**< do not verify nodes at all */
  29   NODE_VERIFICATION_ON         = 1,     /**< do node verification and assert on error in debug version */
  30   NODE_VERIFICATION_REPORT     = 2,     /**< do node verification, but report to stderr only */
  31   NODE_VERIFICATION_ERROR_ONLY = 3      /**< do node verification, but NEVER do assert nor report */
  32 } node_verification_t;
  33
  34 /** Select verification of nodes.
  35  *
  36  *  Per default the  verification is in mode NODE_VERIFICATION_ASSERT.
  37  *  Turn the verification off during development to check partial implementations.
  38  */
  39 void do_node_verification(node_verification_t mode);
  40
  41 /**
  42  * Tests the modes of checknode and its predecessors.
  43  * Checknode must be in current_ir_graph.
  44  *
  45  * \return
  46  *      NON-zero on success
  47  */
  48 int irn_vrfy(struct ir_node *checknode);
  49
  50 /**
  51  * Tests the modes of checknode and its predecessors.
  52  * Checknode must be in given ir_graph.
  53  *
  54  * \return
  55  *      NON-zero on success
  56  */
  57 int irn_vrfy_irg(struct ir_node *checknode, ir_graph *irg);
  58
  59 /**
  60  * Same as irn_vrfy_irg, but temporary sets verification mode to
  61  * NODE_VERIFICATION_ERROR_ONLY.
  62  * \return
  63  *      NON-zero on success
  64  */
  65 int irn_vrfy_irg_dump(struct ir_node *checknode, ir_graph *irg, const char **bad_string);
  66
  67 /**
  68  * Calls irn_vrfy for each node in irg.
  69  * Graph must be in state "op_pin_state_pinned".
  70  *
  71  * \return
  72  *      NON-zero on success.
  73  */
  74 int irg_vrfy(ir_graph *irg);
  75
  76 /**
  77  * Possible flags for irg_vrfy_bads().
  78  */
  79 enum verify_bad_flags_t {
  80   BAD_CF      = 1,      /**< Bad nodes are allowed as predecessors of Blocks and Phis. */
  81   BAD_DF      = 2,      /**< Bad nodes are allowed as dataflow predecessors. */
  82   BAD_BLOCK   = 4,      /**< Bad nodes are allowed as Block input. */
  83   TUPLE       = 8       /**< Tuple nodes are allowed. */
  84 };
  85
  86 /**
  87  * Verify occurance of bad nodes in a graph.
  88  *
  89  * @param irg    The graph to verify
  90  * @param flags  combination of verify_bad_flags_t flags describing
  91  *               which Bads are allowed
  92  * @returns      a value combined of verify_bad_flags_t indicating the problems found.
  93  */
  94 int irg_vrfy_bads(ir_graph *irg, int flags);
  95
  96 /**
  97  *  Enable/disable verification of Load/Store nodes with
  98  *  its entities. If disabled, Store(SymConst(array)) will be allowed
  99  *  (C-frontend builds this :-)
 100  */
 101 void vrfy_enable_entity_tests(int enable);
 102
 103 # endif /* _IRVRFY_H_ */