beflags: move be_Keep logic out of is_modify_flags function where it didn't really...

[libfirm] / ir / be / beutil.h

diff --git a/ir/be/beutil.h b/ir/be/beutil.h
index dcb18b1..0404d18 100644 (file)
--- a/ir/be/beutil.h
+++ b/ir/be/beutil.h
@@ -1,16 +1,57 @@
+/*
+ * 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.
+ */
 
-#ifndef _BEUTIL_H
-#define _BEUTIL_H
+/**
+ * @file
+ * @brief       Contains some useful function for the backend.
+ * @author      Sebastian Hack
+ * @version     $Id$
+ */
+#ifndef FIRM_BE_BEUTIL_H
+#define FIRM_BE_BEUTIL_H
 
 #include <stdio.h>
 
-#include "irnode.h"
-#include "config.h"
+#include "firm_types.h"
+#include "pset.h"
 
 #include "bearch.h"
 
-/** Undefine this to disable debugging mode. */
-#define BE_DEBUG 1
+/* iterate over a list of ir_nodes linked by link field */
+#define foreach_linked_irns(head, iter) for ((iter) = (head); (iter); (iter) = get_irn_link((iter)))
+
+/**
+ * Convenient block getter.
+ * Works also, if the given node is a block.
+ * @param  irn The node.
+ * @return The block of the node, or the node itself, if the node is a
+ *         block.
+ */
+static inline ir_node *get_block(ir_node *irn)
+{
+       return is_Block(irn) ? irn : get_nodes_block(irn);
+}
+
+static inline const ir_node *get_block_const(const ir_node *irn)
+{
+       return is_Block(irn) ? irn : get_nodes_block(irn);
+}
 
 /**
  * Check, if a node produces or consumes a data value.
@@ -20,18 +61,18 @@
  * @param irn The node to check for.
  * @return 1, if the node is a data node, 0 if not.
  */
-static INLINE int is_data_node(const ir_node *irn)
+static inline int is_data_node(const ir_node *irn)
 {
        int i, n;
 
        /* If the node produces a data value, return immediately. */
-       if(mode_is_datab(get_irn_mode(irn)))
+       if (mode_is_data(get_irn_mode(irn)))
                return 1;
 
        /* else check, if it takes a data value, if that is so, return */
        for(i = 0, n = get_irn_arity(irn); i < n; ++i) {
                ir_node *op = get_irn_n(irn, i);
-               if(mode_is_datab(get_irn_mode(op)))
+               if (mode_is_data(get_irn_mode(op)))
                        return 1;
        }
 
@@ -40,40 +81,34 @@ static INLINE int is_data_node(const ir_node *irn)
 }
 
 /**
- * Make each constant local to its use.
- * This duplicates all constants in order to simulate a realistic
- * register pressure.
+ * Clears the link fields of all nodes of the given graph.
  * @param irg The graph.
  */
-void localize_consts(ir_graph *irg);
+void be_clear_links(ir_graph *irg);
 
 /**
- * Dump a vcg graph containing the controlflow graph, the schedule and
- * allocated registers.
- * @param irg The irg. Note that scheduling, register allocation must
- * have been performed.
+ * Returns the number of reachable nodes in an irg.
+ * @param irg The irg.
+ * @return The number of reachable nodes.
  */
-void dump_allocated_irg(arch_env_t *env, ir_graph *irg, char *suffix);
-
-
+unsigned get_num_reachable_nodes(ir_graph *irg);
 
-static INLINE FILE *ffopen(const char *base, const char *ext, const char *mode) {
-       FILE *out;
-       char buf[1024];
+/**
+ * Gets the Proj with number pn from irn.
+ */
+ir_node *be_get_Proj_for_pn(const ir_node *irn, long pn);
 
-       snprintf(buf, sizeof(buf), "%s.%s", base, ext);
-       if (! (out = fopen(buf, mode))) {
-               fprintf(stderr, "Cannot open file %s in mode %s\n", buf, mode);
-               return NULL;
-       }
-       return out;
-}
+/**
+ * Returns an array (an ARR_F) of the programs blocks in reverse postorder
+ * (note: caller has to free the memory with DEL_ARR_F after use;
+ *  of course you can use ARR_LEN on the array too.)
+ */
+ir_node **be_get_cfgpostorder(ir_graph *irg);
 
 /**
- * Dump a graph with schedule edges.
- * @param irg The graph.
- * @param suffix A suffix to its file name.
+ * convenience function to return the first successor block
+ * (it is often known that there is exactly 1 successor anyway)
  */
-void dump_ir_block_graph_sched(ir_graph *irg, const char *suffix);
+ir_node *get_first_block_succ(const ir_node *block);
 
 #endif