give Bad nodes a mode
[libfirm] / ir / be / bepeephole.h
index 1aeb422..34fafab 100644 (file)
@@ -1,16 +1,86 @@
+/*
+ * Copyright (C) 1995-2008 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
+ * @brief       peephole optimisation framework
+ * @author      Matthias Braun
+ * @version     $Id$
+ */
 #ifndef BEPEEPHOLE_H
 #define BEPEEPHOLE_H
 
 #include "beirg.h"
+#include "bearch.h"
 
 extern ir_node ***register_values;
 
-static inline ir_node *get_value_in_reg(unsigned regclass_idx,
-                                        unsigned register_idx)
+static inline ir_node *be_peephole_get_value(unsigned regclass_idx,
+                                             unsigned register_idx)
 {
        return register_values[regclass_idx][register_idx];
 }
 
-void be_peephole_opt(be_irg_t *birg);
+static inline ir_node *be_peephole_get_reg_value(const arch_register_t *reg)
+{
+       unsigned regclass_idx = arch_register_class_index(arch_register_get_class(reg));
+       unsigned register_idx = arch_register_get_index(reg);
+
+       return be_peephole_get_value(regclass_idx, register_idx);
+}
+
+/**
+ * Datatype of the generic op handler for optimisation.
+ */
+typedef void (*peephole_opt_func) (ir_node *node);
+
+/**
+ * Notify the peephole phase about a newly added node, so it can update its
+ * internal state.  This is not needed for the new node, when
+ * be_peephole_exchange() is used. */
+void be_peephole_new_node(ir_node *nw);
+
+/**
+ * When doing peephole optimisation use this function instead of plain
+ * exchange(), so it can update its internal state. */
+void be_peephole_exchange(ir_node *old, ir_node *nw);
+
+/**
+ * Tries to optimize a beIncSp node with its previous IncSP node.
+ * Must be run from a be_peephole_opt() context.
+ *
+ * @param node  a be_IncSP node
+ *
+ * @return the new IncSP node or node itself
+ */
+ir_node *be_peephole_IncSP_IncSP(ir_node *node);
+
+bool be_has_only_one_user(ir_node *node);
+
+/**
+ * Do peephole optimisations. It traverses the schedule of all blocks in
+ * backward direction. The register_values variable indicates which (live)
+ * values are stored in which register.
+ * The generic op handler is called for each node if it exists. That's where
+ * backend specific optimisations should be performed based on the
+ * register-liveness information.
+ */
+void be_peephole_opt(ir_graph *irg);
 
 #endif