beifg: Factorise code to count interference components.
[libfirm] / ir / be / beabihelper.h
index 09f8a86..2bafe29 100644 (file)
@@ -1,20 +1,6 @@
 /*
- * 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.
+ * Copyright (C) 2012 University of Karlsruhe.
  */
 
 /**
  * @brief       Helper functions for handling ABI constraints in the code
  *              selection phase.
  * @author      Matthias Braun
- * @version     $Id$
  */
 #ifndef FIRM_BE_BEABI_HELPER_H
 #define FIRM_BE_BEABI_HELPER_H
 
 #include "firm_types.h"
 #include "be_types.h"
+#include "bearch.h"
 
 typedef struct beabi_helper_env_t beabi_helper_env_t;
+typedef struct be_stackorder_t    be_stackorder_t;
 
+/**
+ * Creates a helper object for the ABI constraint handling.
+ */
 beabi_helper_env_t *be_abihelper_prepare(ir_graph *irg);
 
+/**
+ * Terminates a helper object for the ABI constraint handling.
+ */
 void be_abihelper_finish(beabi_helper_env_t *env);
 
 /**
@@ -42,11 +35,11 @@ void be_abihelper_finish(beabi_helper_env_t *env);
  *  - Callee-Save registers (we need to restore that value at the end)
  *  - Parameters passed in registers
  *  - stack pointer, base pointer, ...
- * It is possible to specify additional irn flags (usefull to mark a value
+ * It is possible to specify additional irn flags (useful to mark a value
  * as ignore or produces_sp).
  */
 void be_prolog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
-                       arch_irn_flags_t flags);
+                       arch_register_req_type_t flags);
 
 /**
  * Creates a start node.
@@ -55,15 +48,9 @@ void be_prolog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
 ir_node *be_prolog_create_start(beabi_helper_env_t *env, dbg_info *dbgi,
                                 ir_node *block);
 
-/**
- * Creates a barrier node which lets all registers specified by prolog_add_reg
- * pass through
- */
-ir_node *be_prolog_create_barrier(beabi_helper_env_t *env, ir_node *block);
-
 /**
  * Get "value" of a register.
- * This usually creates a Proj node for the start-node or barrier-node.
+ * This usually creates a Proj node for the start-node.
  * Or returns the value set by a abi_helper_set_reg_value call
  */
 ir_node *be_prolog_get_reg_value(beabi_helper_env_t *env,
@@ -86,7 +73,7 @@ void be_prolog_set_memory(beabi_helper_env_t *env, ir_node *value);
  *  - stack pointer, base pointer
  */
 void be_epilog_add_reg(beabi_helper_env_t *env, const arch_register_t *reg,
-                       arch_irn_flags_t flags, ir_node *value);
+                       arch_register_req_type_t flags, ir_node *value);
 
 void be_epilog_set_reg_value(beabi_helper_env_t *env,
                              const arch_register_t *reg, ir_node *value);
@@ -100,18 +87,51 @@ ir_node *be_epilog_get_memory(beabi_helper_env_t *env);
 
 void be_epilog_begin(beabi_helper_env_t *env);
 
-ir_node *be_epilog_create_barrier(beabi_helper_env_t *env, ir_node *block);
-
 /**
  * Create return node and finishes epilog handling
  */
 ir_node *be_epilog_create_return(beabi_helper_env_t *env, dbg_info *dbgi,
                                  ir_node *block);
 
-
 /**
  * Adds a X->Proj->Keep for each output value of X which has no Proj yet
  */
 void be_add_missing_keeps(ir_graph *irg);
 
+/**
+ * Make sure all outputs of a node are used, add keeps otherwise
+ */
+void be_add_missing_keeps_node(ir_node *node);
+
+/**
+ * In the normal firm representation some nodes like pure calls, builtins
+ * have no memory inputs+outputs. However in the backend these sometimes have to
+ * access the stack to work and therefore suddenly need to be enqueued into the
+ * memory edge again.
+ * This API creates a possible order to enqueue them so we can be sure to create
+ * a legal dependency graph when transforming them.
+ */
+be_stackorder_t *be_collect_stacknodes(ir_graph *irg);
+
+/**
+ * return node that should produce the predecessor stack node in a block.
+ * returns NULL if there's no predecessor in the current block.
+ */
+ir_node *be_get_stack_pred(const be_stackorder_t *env, const ir_node *node);
+
+/**
+ * free memory associated with a stackorder structure
+ */
+void be_free_stackorder(be_stackorder_t *env);
+
+/**
+ * In case where a parameter is transmitted via register but someone takes its
+ * address a store to the frame which can be references is necessary.
+ * This function can be used as a preprocessing phase before transformation to
+ * do this. The assumption is that all parameter_entities which are passed
+ * through the stack are already moved to the arg_type and all remaining
+ * parameter_entities on the frame type need stores.
+ */
+void be_add_parameter_entity_stores(ir_graph *irg);
+
 #endif