fixed output

[libfirm] / ir / ir / iropt_t.h

diff --git a/ir/ir/iropt_t.h b/ir/ir/iropt_t.h
index 2c4b369..f0eb307 100644 (file)
--- a/ir/ir/iropt_t.h
+++ b/ir/ir/iropt_t.h
@@ -1,27 +1,101 @@
-/* Copyright (C) 1998 - 2000 by Universitaet Karlsruhe
-** All rights reserved.
-**
-** Authors: Martin Trapp, Christian Schaefer
-**
-** Declarations for optimizations intertwined with IR construction.
-*/
+/*
+ * Project:     libFIRM
+ * File name:   ir/ir/iropt_t.h
+ * Purpose:     iropt --- optimizations intertwined with IR construction -- private header.
+ * Author:      Martin Trapp, Christian Schaefer
+ * Modified by: Goetz Lindenmaier, Michael Beck
+ * Created:
+ * CVS-ID:      $Id$
+ * Copyright:   (c) 1998-2003 Universität Karlsruhe
+ * Licence:     This file protected by GPL -  GNU GENERAL PUBLIC LICENSE.
+ */
 
-/* $Id$ */
+/**
+ * @file iropt_t.h
+ *
+ * Declarations for optimizations intertwined with IR construction.
+ *
+ * @author Martin Trapp, Christian Schaefer
+ */
 
-# ifndef _IROPT_T_H_
-# define _IROPT_T_H_
+#ifndef _IROPT_T_H_
+#define _IROPT_T_H_
 
-# include "pset.h"
-# include "iropt.h"
+#include "iropt.h"
+#include "irnode_t.h"
+#include "pset.h"
+#include "tv.h"
 
-ir_node *equivalent_node (ir_node *n);
+ir_node *equivalent_node(ir_node *n);
 
-/* For cse */
-pset *new_identities (void);
-void  del_identities (pset *value_table);
-void  add_identity (pset *value_table, ir_node *node);
+/**
+ * Calculate a hash value of a node.
+ * The hash value is calculated from the nodes predecessors.
+ * Special handling for Const and SymConst nodes (these don't have predecessors).
+ *
+ * @param node  The IR-node
+ */
+unsigned ir_node_hash(ir_node *node);
 
-ir_node *optimize_in_place_2 (ir_node *n);
+/**
+ * Creates a new value table used for storing CSE identities.
+ * The value table is used to identify common expressions.
+ *
+ */
+pset *new_identities(void);
 
+/**
+ * Deletes a identities value table.
+ *
+ * @param value_table  the identity set
+ */
+void  del_identities(pset *value_table);
 
-# endif /* _IROPT_T_H_ */
+/**
+ * Add a node to the identities value table.
+ */
+void  add_identities(pset *value_table, ir_node *node);
+
+/**
+ * Compare function for two nodes in the hash table. Gets two
+ * nodes as parameters.  Returns 0 if the nodes are a cse.
+ */
+int identities_cmp(const void *elt, const void *key);
+
+/**
+ * Return the canonical node computing the same value as n.
+ * Looks up the node in a hash table, enters it in the table
+ * if it isn't there yet.
+ */
+ir_node *identify_remember(pset *value_table, ir_node *n);
+
+/** Visit each node in the value table of a graph. */
+void visit_all_identities(ir_graph *irg, irg_walk_func visit, void *env);
+
+ir_node *optimize_node(ir_node *n);
+
+ir_node *optimize_in_place_2(ir_node *n);
+
+/**
+ * Returns the tarval of a Const node or tarval_bad for all other nodes.
+ */
+static INLINE tarval *
+value_of(ir_node *n) {
+  if ((n != NULL) && (get_irn_op(n) == op_Const))
+    return get_Const_tarval(n); /* might return tarval_bad */
+  else
+    return tarval_bad;
+}
+
+/**
+ * Sets the default operations for an ir_op_ops.
+ *
+ * @param code   the opcode for the default operation
+ * @param ops    the operations initialized
+ *
+ * @return
+ *    The operations.
+ */
+ir_op_ops *firm_set_default_operations(opcode code, ir_op_ops *ops);
+
+#endif /* _IROPT_T_H_ */