Add is_Conv().
[libfirm] / ir / ir / irvrfy.h
index 46d6170..d073c88 100644 (file)
 /*
- * Project:     libFIRM
- * File name:   ir/ir/irvrfy.h
- * Purpose:     Check irnodes for correctness.
- * Author:      Christian Schaefer
- * Modified by: Goetz Lindenmaier. Till Riedel
- * Created:
- * CVS-ID:      $Id$
- * Copyright:   (c) 1998-2003 Universität Karlsruhe
- * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ *
+ * This file is part of libFirm.
+ *
+ * This file may be distributed and/or modified under the terms of the
+ * GNU General Public License version 2 as published by the Free Software
+ * Foundation and appearing in the file LICENSE.GPL included in the
+ * packaging of this file.
+ *
+ * Licensees holding valid libFirm Professional Edition licenses may use
+ * this file in accordance with the libFirm Commercial License.
+ * Agreement provided with the Software.
+ *
+ * This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
+ * WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE.
  */
 
 /**
-* @file irvrfy.h
-*
-* ir graph verification.
-*
-* @author Christian Schaefer
-*/
-
-# ifndef _IRVRFY_H_
-# define _IRVRFY_H_
-
-# include "irnode.h"
-# include "irgraph.h"
-
-typedef enum _node_verification_t {
-  NODE_VERIFICATION_OFF        = 0,    /**< do not verify nodes at all */
-  NODE_VERIFICATION_ON         = 1,    /**< do node verification and assert on error in debug version */
-  NODE_VERIFICATION_REPORT     = 2,    /**< do node verification, but report to stderr only */
-  NODE_VERIFICATION_ERROR_ONLY = 3     /**< do node verification, but NEVER do assert nor report */
-} node_verification_t;
-
-/** Select verification of nodes.
- *
- *  Per default the  verification is in mode NODE_VERIFICATION_ASSERT.
- *  Turn the verification off during development to check partial implementations.
+ * @file
+ * @brief    Check irnodes for correctness.
+ * @author   Christian Schaefer, Goetz Lindenmaier, Till Riedel
+ * @version  $Id$
  */
-void do_node_verification(node_verification_t mode);
+#ifndef FIRM_IR_IRVRFY_H
+#define FIRM_IR_IRVRFY_H
+
+#include "firm_types.h"
 
 /**
  * Tests the modes of checknode and its predecessors.
- * Checknode must be in current_ir_graph.
+ * checknode must be in current_ir_graph.
  *
- * \return
+ * @return
  *     NON-zero on success
  */
-int irn_vrfy(struct ir_node *checknode);
+int irn_vrfy(ir_node *checknode);
 
 /**
  * Tests the modes of checknode and its predecessors.
- * Checknode must be in given ir_graph.
+ * checknode must be in given ir_graph.
  *
- * \return
+ * @return
  *     NON-zero on success
  */
-int irn_vrfy_irg(struct ir_node *checknode, ir_graph *irg);
+int irn_vrfy_irg(ir_node *checknode, ir_graph *irg);
 
 /**
  * Same as irn_vrfy_irg, but temporary sets verification mode to
  * NODE_VERIFICATION_ERROR_ONLY.
- * \return
+ * @return
  *     NON-zero on success
  */
-int irn_vrfy_irg_dump(struct ir_node *checknode, ir_graph *irg, const char **bad_string);
+int irn_vrfy_irg_dump(ir_node *checknode, ir_graph *irg, const char **bad_string);
+
+/**
+ * Flags for irg_verify().
+ */
+typedef enum _irg_verify_flags_t {
+  VRFY_NORMAL      = 0,      /**< check SSA property only if dominance information is available */
+  VRFY_ENFORCE_SSA = 1       /**< check SSA property by enforcing the dominance information recalculation */
+} irg_verify_flags_t;
 
 /**
- * Calls irn_vrfy for each node in irg.
+ * Calls irn_vrfy() for each node in irg.
  * Graph must be in state "op_pin_state_pinned".
  *
- * \return
+ * @return
  *     NON-zero on success.
  */
-int irg_vrfy(ir_graph *irg);
+int irg_verify(ir_graph *irg, unsigned flags);
+
+/**
+ * Compatibility macro. Deprecated soon.
+ */
+#define irg_vrfy(irg) irg_verify(irg, 0)
+
+/**
+ * Possible flags for irg_vrfy_bads().
+ */
+enum verify_bad_flags_t {
+  BAD_CF      = 1,     /**< Bad nodes are allowed as predecessors of Blocks and Phis. */
+  BAD_DF      = 2,     /**< Bad nodes are allowed as dataflow predecessors. */
+  BAD_BLOCK   = 4,     /**< Bad nodes are allowed as Block input. */
+  TUPLE       = 8      /**< Tuple nodes are allowed. */
+};
+
+/**
+ * Verify occurrence of bad nodes in a graph.
+ *
+ * @param irg    The graph to verify
+ * @param flags  combination of verify_bad_flags_t flags describing
+ *               which Bads are allowed
+ * @returns      a value combined of verify_bad_flags_t indicating the problems found.
+ */
+int irg_vrfy_bads(ir_graph *irg, int flags);
+
+/**
+ *  Enable/disable verification of Load/Store nodes with
+ *  its entities. If disabled, Store(SymConst(array)) will be allowed
+ *  (C-frontend builds this :-)
+ */
+void vrfy_enable_entity_tests(int enable);
 
-# endif /* _IRVRFY_H_ */
+#endif