2 * Copyright (C) 1995-2009 University of Karlsruhe. All right reserved.
4 * This file is part of libFirm.
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.
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.
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
22 * @brief Check irnodes for correctness.
23 * @author Christian Schaefer, Goetz Lindenmaier, Till Riedel
26 #ifndef FIRM_IR_IRVERIFY_H
27 #define FIRM_IR_IRVERIFY_H
29 #include "firm_types.h"
33 * Tests the modes of checknode and its predecessors.
34 * checknode must be in current_ir_graph.
36 * @return NON-zero on success
38 FIRM_API int irn_verify(ir_node *checknode);
41 * Tests the modes of checknode and its predecessors.
42 * checknode must be in given ir_graph.
44 * @return NON-zero on success
46 FIRM_API int irn_verify_irg(ir_node *checknode, ir_graph *irg);
49 * Same as irn_verify_irg, but temporary sets verification mode to
50 * NODE_VERIFICATION_ERROR_ONLY.
51 * @return NON-zero on success
53 FIRM_API int irn_verify_irg_dump(ir_node *checknode, ir_graph *irg, const char **bad_string);
56 * Flags for irg_verify().
58 typedef enum irg_verify_flags_t {
59 VERIFY_NORMAL = 0, /**< check SSA property only if dominance information is available */
60 VERIFY_ENFORCE_SSA = 1 /**< check SSA property by enforcing the dominance information recalculation */
64 * Calls irn_verify() for each node in irg.
65 * Graph must be in state "op_pin_state_pinned".
67 * @param irg the IR-graph t check
68 * @param flags one of irg_verify_flags_t
70 * @return NON-zero on success.
72 FIRM_API int irg_verify(ir_graph *irg, unsigned flags);
75 * Creates an ir_graph pass for irg_verify().
77 * @param name the name of this pass or NULL
78 * @param flags one of irg_verify_flags_t
80 * @return the newly created ir_graph pass
82 FIRM_API ir_graph_pass_t *irg_verify_pass(const char *name, unsigned flags);
85 * Possible flags for irg_verify_bads().
87 enum verify_bad_flags_t {
88 BAD_CF = 1, /**< Bad nodes are allowed as predecessors of Blocks and Phis. */
89 BAD_DF = 2, /**< Bad nodes are allowed as dataflow predecessors. */
90 BAD_BLOCK = 4, /**< Bad nodes are allowed as Block input. */
91 TUPLE = 8 /**< Tuple nodes are allowed. */
95 * Verify occurrence of bad nodes in a graph.
97 * @param irg The graph to verify
98 * @param flags combination of verify_bad_flags_t flags describing
99 * which Bads are allowed
100 * @returns a value combined of verify_bad_flags_t indicating the problems found.
102 FIRM_API int irg_verify_bads(ir_graph *irg, int flags);
105 * Enable/disable verification of Load/Store nodes with
106 * its entities. If disabled, Store(SymConst(array)) will be allowed
107 * (C-frontend builds this :-)
109 FIRM_API void verify_enable_entity_tests(int enable);