Removed C99 features and fixed 2 wrong assertions.
[libfirm] / ir / be / bepeephole.h
index 697f8fe..af02f34 100644 (file)
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 1995-2007 University of Karlsruhe.  All right reserved.
+ * Copyright (C) 1995-2008 University of Karlsruhe.  All right reserved.
  *
  * This file is part of libFirm.
  *
  * @author      Matthias Braun
  * @version     $Id$
  */
-
 #ifndef BEPEEPHOLE_H
 #define BEPEEPHOLE_H
 
 #include "beirg.h"
-#include "bearch_t.h"
+#include "bearch.h"
 
 extern ir_node ***register_values;
 
@@ -46,12 +45,39 @@ static inline ir_node *be_peephole_get_reg_value(const arch_register_t *reg)
        return be_peephole_get_value(regclass_idx, register_idx);
 }
 
-typedef ir_node*(*peephole_opt_func) (ir_node *node);
+/**
+ * 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 it's 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);
 
 /**
- * Do peephole optimisations, works backwards over blockschedules and calls the generic op handler function
- * which should be of type peephole_opt_func. The values of the values in the registers are availble
- * in the register_values variable during the optimisation functions.
+ * 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(be_irg_t *birg);